web commit by joey

[ikiwiki.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 89c30d56e147ca4ab848ddb2d8c0d3de55541704..34e6bd1d441786178ba553ebecc606d01345ff75 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -92,6 +92,11 @@ These options configure the wiki.
 
   Specify a mode to chmod the wrapper to after creating it.
 
 
   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
 * --svn, --nosvn
 
   Enable or disable use of [[subversion]]. If subversion is enabled, the


@@ -104,6 +109,17 @@ These options configure the wiki.
 
   Subversion is enabled by default.
 
 
   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.
 * --anonok, --noanonok
 
   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.


@@ -129,6 +145,10 @@ These options configure the wiki.
   "\[[file]]" is replaced with the file to browse. It's common to use
   [[ViewCVS]] for this.
 
   "\[[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,
 * --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,


@@ -147,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.
 
   Currently allows locking of any page, other powers may be added later.
   May be specified multiple times for multiple admins.
 

+* --sanitize
+
+  Enable [[HtmlSanitization]] of wiki content. On by default, disable with
+  --no-sanitize.
+

 * --hyperestraier
 
   Enables use of the [[HyperEstraier]] search engine for full test page
 * --hyperestraier
 
   Enables use of the [[HyperEstraier]] search engine for full test page