web commit by joey

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 228d4e5951b630a9eacd07f43512aed9fe527b8b..4936039b69125b0def6c5fd1117165f5e58fe8ad 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
 

-  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
   behavior so you don't normally need to specify it.
 
 * --rebuild


@@ -92,14 +92,34 @@ 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
 
 * --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.
 
 
   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.


@@ -111,21 +131,25 @@ These options configure the wiki.
   If rss is set, ikiwiki will generate rss feeds for pages that inline
   a blog.
 
   If rss is set, ikiwiki will generate rss feeds for pages that inline
   a blog.
 

-* --url http://someurl/
+* --url http://url/

 
   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
 
 
   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
 

-* --cgiurl http://someurl/ikiwiki.cgi
+* --cgiurl http://url/ikiwiki.cgi

 
   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
 
 
   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
 

-* --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
+* --historyurl http://url/trunk/\[[file]]?root=wiki

 
   Specifies the url to link to for page history browsing. In the url,
   "\[[file]]" is replaced with the file to browse. It's common to use
   [[ViewCVS]] for this.
 
 
   Specifies the url to link to for page history browsing. In the url,
   "\[[file]]" is replaced with the file to browse. It's common to use
   [[ViewCVS]] for this.
 

-* --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+* --adminemail you@yourhost
+
+  Specifies the email address that ikiwiki should use for sending email.
+
+* --diffurl http://url/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,
   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 
   Specifies the url to link to for a diff of changes to a page. In the url,
   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old


@@ -143,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