]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/usage.mdwn
web commit by http://madduck.myopenid.com/
[ikiwiki.git] / doc / usage.mdwn
index 7f556cc95c6a3a0d5911a3a084829da805212ac4..4fb91b89b4a826440b08ede51cc953449a543fce 100644 (file)
@@ -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.
 
-* --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
@@ -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
-  for using --notify with [[Subversion]].
+  for using --notify with [[Subversion|rcs/svn]].
 
 * --svnpath trunk
 
@@ -231,9 +223,10 @@ configuration options of their own.
 
 * --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/".
+  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
 
@@ -299,6 +292,11 @@ configuration options of their own.
   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.
 
+# SEE ALSO
+
+* [[ikiwiki-mass-rebuild]](8)
+* [[ikiwiki-update-wikilist]](1)
+
 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>