X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/4b36dee35a55b08d6d6f3bb3840220a4956f2540..9e7309ec820066f2fed443245d66f79658360e53:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 048072df6..0c7e7d036 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -68,8 +68,8 @@ These options control the mode that ikiwiki is operating in. * --aggregate - If the aggregate plugin is enabled, this makes ikiwiki poll configured - feeds and save new posts to the srcdir. + If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll + configured feeds and save new posts to the srcdir. Note that to rebuild previously aggregated posts, use the --rebuild option along with this one. --rebuild will also force feeds to be polled even if @@ -81,7 +81,7 @@ These options control the mode that ikiwiki is operating in. # CONFIG OPTIONS -These options configure the wiki. Note that plugins can add additional +These options configure the wiki. Note that [[plugins]] can add additional configuration options of their own. * --wikiname @@ -91,13 +91,15 @@ configuration options of their own. * --templatedir Specify the directory that the page [[templates]] are stored in. - Default is `/usr/share/ikiwiki/templates`. + Default is `/usr/share/ikiwiki/templates`, or another location as + configured at build time. * --underlaydir Specify the directory that is used to underlay the source directory. Source files will be taken from here unless overridden by a file in the - source directory. Default is `/usr/share/ikiwiki/basewiki`. + source directory. Default is `/usr/share/ikiwiki/basewiki` or another + location as configured at build time. * --wrappermode mode @@ -118,6 +120,11 @@ configuration options of their own. If you use git, the `source` directory is assumed to be a clone of the [[git]] repository. + If you use tla, the `source` directory is assumed to be a tla import. + + If you use mercurial, the `source` directory is assumed to be the + [[mercurial]] repository. + 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. @@ -212,15 +219,25 @@ configuration options of their own. Specify how to display the time or date. The format string is passed to the strftime(3) function. -* --verbose +* --verbose, --no-verbose Be vebose about what is being done. +* --syslog, --no-syslog + + Log to syslog. + * --w3mmode, --no-w3mmode Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, without a web server. +* --sslcookie + + Only send cookies over an SSL connection. This should prevent them being + intercepted. If you enable this option then you must run at least the + CGI portion of ikiwiki over SSL. + * --getctime Pull last changed time for each new page out of the revision control