X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/be55f6fd7cf1a251c3977f857a44ee2769e39d8b..392e68cd7cb32838ae2f74c90bb98d9b40e04954:/doc/usage.mdwn?ds=sidebyside diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 9e260adc2..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 @@ -228,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 @@ -235,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