X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/c35444826ca47123697a8f2512866f4f99964cc4..67411bebc121241078e5da0538371db09f2e8ad3:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index aa352736c..47716696f 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -56,10 +56,12 @@ These options control the mode that ikiwiki is operating in. In setup mode, ikiwiki reads the config file, which is really a perl program that can call ikiwiki internal functions. + [[ikiwiki.setup]] is an example of such a config file. + The default action when --setup is specified is to automatically generate wrappers for a wiki based on data in a config file, and rebuild the wiki. - - [[ikiwiki.setup]] is an example of such a config file. + If you only want to build any changed pages, you can use --refresh with + --setup. * --wrappers @@ -159,7 +161,12 @@ configuration options of their own. * --rss, --norss - If rss is set, ikiwiki will generate rss feeds for pages that inline + If rss is set, ikiwiki will generate RSS feeds for pages that inline + a [[blog]]. + +* --atom, --noatom + + If atom is set, ikiwiki will generate Arom feeds for pages that inline a [[blog]]. * --pingurl url @@ -223,6 +230,12 @@ configuration options of their own. Enables or disables "Discussion" links from being added to the header of every page. The links are enabled by default. +* --userdir subdir + + Optionally, allows links to users of the wiki to link to pages inside a + subdirectory of the wiki. The default is to link to pages in the toplevel + directory of the wiki. + * --timeformat format Specify how to display the time or date. The format string is passed to the @@ -230,7 +243,7 @@ configuration options of their own. * --verbose, --no-verbose - Be vebose about what is being done. + Be verbose about what is being done. * --syslog, --no-syslog