web commit by ThomasSchwinge

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index ca805ce3350df747a0dfa531680c662b972de84d..eac72cdc728d46c3be2b77aece19ee447d40ddb3 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -41,7 +41,7 @@ These options control the mode that ikiwiki is operating in.
 
 * --wrapper [file]
 
 
 * --wrapper [file]
 

-  Generate a [[wrapper]] binary that is hardcoded to do action specified by
+  Generate a wrapper binary that is hardcoded to do action specified by

   the other options, using the specified input files and `destination`
   directory. The filename to use for the wrapper is optional.
 
   the other options, using the specified input files and `destination`
   directory. The filename to use for the wrapper is optional.
 


@@ -70,13 +70,6 @@ These options configure the wiki.
 
   The name of the wiki, default is "wiki".
 
 
   The name of the wiki, default is "wiki".
 

-* --fixctime
-
-  Pull last changed time for all pages out of the revision control system.
-  This rarely used option provides a way to get the real creation times of
-  items in weblogs, for example when building a wiki from a new subversion
-  checkout. It is unoptimised and quite slow.
-

 * --templatedir
 
   Specify the directory that the page [[templates]] are stored in.
 * --templatedir
 
   Specify the directory that the page [[templates]] are stored in.


@@ -97,17 +90,18 @@ These options configure the wiki.
   Enable email notification of commits. This should be used when running
   ikiwiki as a [[Subversion]] [[post-commit]] hook.
 
   Enable email notification of commits. This should be used when running
   ikiwiki as a [[Subversion]] [[post-commit]] hook.
 

-* --svn, --nosvn
+* --rcs=svn, --no-rcs

 
 

-  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 a revision control system.

 
 

-  In [[CGI]] mode, with subversion enabled pages edited via the web will be
-  committed to subversion. Also, the [[RecentChanges]] link will be placed
+  If you use svn ([[Subversion]]), the `source` directory is assumed to be
+  a working copy, and is automatically updated before building the wiki.
+
+  In [[CGI]] mode, with a revision control system enabled pages edited via
+  the web will be committed. Also, the [[RecentChanges]] link will be placed

   on pages.
 
   on pages.
 

-  Subversion is enabled by default.
+  svn is enabled by default.

 
 * --svnrepo /svn/wiki
 
 
 * --svnrepo /svn/wiki
 


@@ -129,17 +123,18 @@ These options configure the wiki.
 * --rss, --norss
 
   If rss is set, ikiwiki will generate rss feeds for pages that inline
 * --rss, --norss
 
   If rss is set, ikiwiki will generate rss feeds for pages that inline

-  a blog.
+  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
 
   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


@@ -149,7 +144,7 @@ These options configure the wiki.
 
   Specifies the email address that ikiwiki should use for sending email.
 
 
   Specifies the email address that ikiwiki should use for sending email.
 

-* --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+* --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


@@ -167,14 +162,26 @@ 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.
 

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

 
 

-  Enables use of the [[HyperEstraier]] search engine for full test page
-  searches.
+* --plugin name
+
+  Enables the use of the specified plugin in the wiki. See [[plugins]] for
+  details. Note that plugin names are case sensative.

 
 * --verbose
 
 
 * --verbose
 

-  Be vebose about what it's doing.
+  Be vebose about what is being done.
+
+* --fixctime
+
+  Pull last changed time for all pages out of the revision control system.
+  This rarely used option provides a way to get the real creation times of
+  items in weblogs, for example when building a wiki from a new subversion
+  checkout. It is unoptimised and quite slow.

 
 # AUTHOR
 
 
 # AUTHOR