X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/c5975243a5a660f99bcbb4d378a73e987def220b..5f687c72b61550ef1fc20f438e5d66ce56e4f152:/doc/usage.mdwn?ds=sidebyside diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 0107b36ce..aba213f21 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -229,6 +229,13 @@ configuration options of their own. Disables use of a plugin. For example "--disable-plugin htmlscrubber" to do away with HTML sanitization. +* --libdir directory + + Makes ikiwiki look in the specified directory first, before the regular + locations when loading library files and plugins. For example, if you set + libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as + "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm". + * --discussion, --no-discussion Enables or disables "Discussion" links from being added to the header of @@ -236,8 +243,9 @@ configuration options of their own. * --numbacklinks n - Controls how many backlinks should be displayed maximum. Excess backlinks - will be hidden in a popup. Default is 10. Set to 0 to disable this feature. + Controls how many backlinks should be displayed at the bottom of a page. + Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to + disable this feature. * --userdir subdir @@ -245,6 +253,10 @@ configuration options of their own. subdirectory of the wiki. The default is to link to pages in the toplevel directory of the wiki. +* --htmlext html + + Configures the extension used for generated html files. Default is "html". + * --timeformat format Specify how to display the time or date. The format string is passed to the @@ -260,7 +272,7 @@ configuration options of their own. * --usedirs, --no-usedirs - Create output files named page/index.html instead of page.html. + Toggle creating output files named page/index.html (default) instead of page.html. * --w3mmode, --no-w3mmode @@ -281,6 +293,13 @@ configuration options of their own. Subversion checkout. It is unoptimised and quite slow. It is best used with --rebuild, to force ikiwiki to get the ctime for all pages. +* --set var=value + + This allows setting an arbitrary configuration variable, the same as if it + were set via a configuration file. Since most options can be configured + using command-line switches, you will rarely need to use this, but it can be + useful for the odd option that lacks a command-line switch. + # AUTHOR Joey Hess