apply monotone patch

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index a8bb92d68cb48d2ba2121368d4ec3f23eba4c4a2..17be020440f45f91fe4064ae440b125af04c9552 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -130,20 +130,12 @@ configuration options of their own.
   Enable email notification of commits. This should be used when running
   ikiwiki as a [[post-commit]] hook.
 
   Enable email notification of commits. This should be used when running
   ikiwiki as a [[post-commit]] hook.
 

-* --rcs=svn, --no-rcs
+* --rcs=svn|git|.., --no-rcs

 
 

-  Enable or disable use of a revision control system.
+  Enable or disable use of a [[revision_control_system|rcs]].

 
 

-  If you use svn, the `source` directory is assumed to be
-  a [[Subversion]] working copy.
-
-  If you use git, the `source` directory is assumed to be a clone of the
-  [[git]] repository.
-
-  If you use tla, the `source` directory is assumed to be a tla import.
-
-  If you use mercurial, the `source` directory is assumed to be the
-  [[mercurial]] repository.
+  The `source` directory will be assumed to be a working copy, or clone, or
+  whatever the revision control system you select uses.

 
   In [[CGI]] mode, with a revision control system enabled, pages edited via
   the web will be committed. Also, the [[RecentChanges]] link will be placed
 
   In [[CGI]] mode, with a revision control system enabled, pages edited via
   the web will be committed. Also, the [[RecentChanges]] link will be placed


@@ -154,7 +146,7 @@ configuration options of their own.
 * --svnrepo /svn/wiki
 
   Specify the location of the svn repository for the wiki. This is required
 * --svnrepo /svn/wiki
 
   Specify the location of the svn repository for the wiki. This is required

-  for using --notify with [[Subversion]].
+  for using --notify with [[Subversion|rcs/svn]].

 
 * --svnpath trunk
 
 
 * --svnpath trunk
 


@@ -229,6 +221,13 @@ 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
+  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
 * --discussion, --no-discussion
 
   Enables or disables "Discussion" links from being added to the header of


@@ -265,7 +264,7 @@ configuration options of their own.
 
 * --usedirs, --no-usedirs
 
 
 * --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
 
 
 * --w3mmode, --no-w3mmode
 


@@ -286,6 +285,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.
 
   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>
 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>