web commit by joey

[git.ikiwiki.info.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index f477fe562988fb8d17237f2249a9131d8fcd14d9..ca805ce3350df747a0dfa531680c662b972de84d 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -22,7 +22,7 @@ These options control the mode that ikiwiki is operating in.
 
 * --refresh
 
-  Refresh the wiki, updating any changes pages. This is the default
+  Refresh the wiki, updating any changed pages. This is the default
   behavior so you don't normally need to specify it.
 
 * --rebuild
@@ -82,18 +82,44 @@ These options configure the wiki.
   Specify the directory that the page [[templates]] are stored in.
   Default is `/usr/share/ikiwiki/templates`.
 
+* --underlaydir
+
+  Specify the directory that is used to underlay the source directory.
+  Source files will be taken from here unless overridden by a file in the
+  source directory. Default is `/usr/share/ikiwiki/basewiki`.
+
 * --wrappermode mode
 
   Specify a mode to chmod the wrapper to after creating it.
 
+* --notify
+
+  Enable email notification of commits. This should be used when running
+  ikiwiki as a [[Subversion]] [[post-commit]] hook.
+
 * --svn, --nosvn
 
-  Enable or disable use of [[subversion]]. If subversion is enabled, the `source` directory is assumed to be a working copy, and is automatically updated before building the wiki. 
+  Enable or disable use of [[subversion]]. If subversion is enabled, the
+  `source` directory is assumed to be a working copy, and is automatically
+  updated before building the wiki. 
 
-  In [[CGI]] mode, with subversion enabled pages edited via the web will be committed to subversion. Also, the [[RecentChanges]] link will be placed on pages.
+  In [[CGI]] mode, with subversion enabled pages edited via the web will be
+  committed to subversion. Also, the [[RecentChanges]] link will be placed
+  on pages.
 
   Subversion is enabled by default.
 
+* --svnrepo /svn/wiki
+
+  Specify the location of the svn repository for the wiki. This is required
+  for using --notify with [[subversion]].
+
+* --svnpath trunk
+
+  Specify the path inside your svn reporistory where the wiki is located.
+  This defaults to trunk; change it if your wiki is at some other location
+  inside the repository.
+
 * --anonok, --noanonok
 
   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
@@ -119,6 +145,10 @@ These options configure the wiki.
   "\[[file]]" is replaced with the file to browse. It's common to use
   [[ViewCVS]] for this.
 
+* --adminemail you@yourhost
+
+  Specifies the email address that ikiwiki should use for sending email.
+
 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
 
   Specifies the url to link to for a diff of changes to a page. In the url,
@@ -137,6 +167,11 @@ These options configure the wiki.
   Currently allows locking of any page, other powers may be added later.
   May be specified multiple times for multiple admins.
 
+* --hyperestraier
+
+  Enables use of the [[HyperEstraier]] search engine for full test page
+  searches.
+
 * --verbose
 
   Be vebose about what it's doing.