]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/usage.mdwn
include bugs tagged patch
[ikiwiki.git] / doc / usage.mdwn
index a8bb92d68cb48d2ba2121368d4ec3f23eba4c4a2..7f556cc95c6a3a0d5911a3a084829da805212ac4 100644 (file)
@@ -229,6 +229,12 @@ 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 perl
+  library directories. For example, if you set libdir to "/home/you/.ikiwiki/",
+  you can install plugins in "/home/you/.ikiwiki/IkiWiki/Plugin/".
+
 * --discussion, --no-discussion
 
   Enables or disables "Discussion" links from being added to the header of
@@ -265,7 +271,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
 
@@ -286,6 +292,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>