web commit by http://ethan.betacantrips.com/: ugh, this is better

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index f80b02ff173ed55a53a71ead2f925b8bc62e6cd5..9b3a911643d54b2377bd3804e2b21d7f163d296c 100644 (file)
--- 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
 
   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
 
 
 * --rss, --norss
 


@@ -228,6 +229,12 @@ configuration options of their own.
   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
   to do away with HTML sanitization.
 
   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
 * --discussion, --no-discussion
 
   Enables or disables "Discussion" links from being added to the header of


@@ -235,8 +242,9 @@ configuration options of their own.
 
 * --numbacklinks n
 
 
 * --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
 
 
 * --userdir subdir
 


@@ -244,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.
 
   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
 * --timeformat format
 
   Specify how to display the time or date. The format string is passed to the