X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/54d5308cd83c67e7e9c32450c776ef0dac63549f..de5cd1e12b2fa626344a183c509a88e29439f4e1:/doc/usage.mdwn?ds=inline diff --git a/doc/usage.mdwn b/doc/usage.mdwn index c4d1f5818..011cf53a2 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -90,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 [[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. - Subversion is enabled by default. + svn is enabled by default. * --svnrepo /svn/wiki @@ -161,31 +162,37 @@ 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. -* --sanitize - - Enable [[HtmlSanitization]] of wiki content. On by default, disable with - --no-sanitize. - * --plugin name Enables the use of the specified plugin in the wiki. See [[plugins]] for details. Note that plugin names are case sensative. -* --hyperestraier +* --disable-plugin name + + Disables use of a plugin. For example "--disable-plugin htmlscrubber" + to do away with html sanitization. + +* --discussion, --no-discussion + + Enables or disables "Discussion" links from being added to the header of + every page. The links are enabled by default. + +* --timeformat format - Enables use of the [[HyperEstraier]] search engine for full test page - searches. + Specify how to display the time or date. The format string is passed to the + strftime(3) function. * --verbose Be vebose about what is being done. -* --fixctime +* --getctime - 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. + Pull last changed time for each new page 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. It is best used + with --rebuild, to force ikiwiki to get the ctime for all pages. # AUTHOR