]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/usage.mdwn
web commit by NicolasLimare: patch for the meta plugin : [[meta lang="ja"]]
[ikiwiki.git] / doc / usage.mdwn
index 0107b36ce195255a6dc44a88de6629cb93a47002..121005ca019d2f8f8ae4d71eeb033ae141d01c65 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
@@ -236,8 +242,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 +252,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
@@ -281,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>