X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/0d517edd66c968b2664ebc4b422fb0ddfdcb9b66..4c2f8d33536d3be55155874fc8015108aab75a23:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 4936039b6..eac72cdc7 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -41,7 +41,7 @@ These options control the mode that ikiwiki is operating in. * --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. @@ -70,13 +70,6 @@ These options configure the 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. @@ -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. -* --svn, --nosvn +* --rcs=svn, --no-rcs + + Enable or disable use of a revision control system. - 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. + 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 subversion enabled pages edited via the web will be - committed to subversion. Also, the [[RecentChanges]] link will be placed + 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. - Subversion is enabled by default. + svn is enabled by default. * --svnrepo /svn/wiki @@ -129,7 +123,7 @@ These options configure the wiki. * --rss, --norss If rss is set, ikiwiki will generate rss feeds for pages that inline - a blog. + a [[blog]]. * --url http://url/ @@ -137,7 +131,8 @@ These options configure the wiki. * --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://url/trunk/\[[file]]?root=wiki @@ -172,14 +167,21 @@ These options configure the wiki. Enable [[HtmlSanitization]] of wiki content. On by default, disable with --no-sanitize. -* --hyperestraier +* --plugin name - Enables use of the [[HyperEstraier]] search engine for full test page - searches. + Enables the use of the specified plugin in the wiki. See [[plugins]] for + details. Note that plugin names are case sensative. * --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