web commit by http://jeremie.koenig.myopenid.com/

[git.ikiwiki.info.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index c83f833fcc69011a88a222442d12ec262c23a76e..aba213f21f5e7dc52ff13e81246be69f074dd3d5 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -231,9 +231,10 @@ configuration options of their own.
 
 * --libdir directory
 
-  Makes ikiwiki look in the specified directory first, before the regular perl
-  library directories. For example, if you set libdir to "/home/you/.ikiwiki/",
-  you can install plugins in "/home/you/.ikiwiki/IkiWiki/Plugins/".
+  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
 
@@ -271,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
 
@@ -292,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 <joey@ikiwiki.info>