X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/a2cfdaaec5666a08af864ebad8133e18d7cbbcb3..1082ade032f1eec471f31e68c1a68887c5e8b14a:/doc/usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 4ccd6bf44..aba213f21 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -160,7 +160,8 @@ configuration options of their own.
 
   Specify the path inside your svn repository where the wiki is located.
   This defaults to `trunk`; change it if your wiki is at some other path
-  inside the repository.
+  inside the repository. If your wiki is rooted at the top of the repository,
+  set svnpath to "".
 
 * --rss, --norss
 
@@ -228,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
@@ -235,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.
+  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
 
@@ -244,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
@@ -257,6 +270,10 @@ configuration options of their own.
 
   Log to syslog(3).
 
+* --usedirs, --no-usedirs
+
+  Toggle creating output files named page/index.html (default) instead of page.html.
+
 * --w3mmode, --no-w3mmode
 
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
@@ -276,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>