X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/227b64ad72faec528984e7924eca44f29ff92402..42d15a8b05e79fc18ced867172727ca96bc04a05:/doc/usage.mdwn?ds=inline

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index fdd54e389..4fb91b89b 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -86,6 +86,14 @@ These options control the mode that ikiwiki operates in.
 
 	ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
 
+* --post-commit
+
+  Run in post-commit mode, the same as if called by a [[post-commit]] hook.
+  This is probably only useful when using ikiwiki with a web server on one host
+  and a repository on another, to allow the repository's real post-commit
+  hook to ssh to the web server host and manually run ikiwiki to update
+  the web site.
+
 * --version
 
   Print ikiwiki's version number.
@@ -101,8 +109,8 @@ configuration options of their own.
 
 * --templatedir
 
-  Specify the directory that the page [[templates]] are stored in. Default
-  is `/usr/share/ikiwiki/templates`, or another location as configured at
+  Specify the directory that the page [[templates|wikitemplates]] are stored in.
+  Default is `/usr/share/ikiwiki/templates`, or another location as configured at
   build time. If the templatedir is changed, missing templates will still
   be searched for in the default location as a fallback.
 
@@ -117,25 +125,17 @@ configuration options of their own.
 
   Specify a mode to chmod the wrapper to after creating it.
 
-* --notify
+* --notify, --no-notify
 
   Enable email notification of commits. This should be used when running
   ikiwiki as a [[post-commit]] hook.
 
-* --rcs=svn, --no-rcs
-
-  Enable or disable use of a revision control system.
-
-  If you use svn, the `source` directory is assumed to be
-  a [[Subversion]] working copy.
+* --rcs=svn|git|.., --no-rcs
 
-  If you use git, the `source` directory is assumed to be a clone of the
-  [[git]] repository.
+  Enable or disable use of a [[revision_control_system|rcs]].
 
-  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
@@ -146,13 +146,14 @@ 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
 
   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
 
@@ -220,17 +221,34 @@ 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
   every page. The links are enabled by default.
 
+* --numbacklinks n
+
+  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
 
   Optionally, allows links to users of the wiki to link to pages inside a
   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
@@ -244,6 +262,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,
@@ -263,8 +285,20 @@ 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.
+
+# SEE ALSO
+
+* [[ikiwiki-mass-rebuild]](8)
+* [[ikiwiki-update-wikilist]](1)
+
 # AUTHOR
 
-Joey Hess <joey@kitenet.net>
+Joey Hess <joey@ikiwiki.info>
 
-Warning: this page is automatically made into ikiwiki's man page, edit with care
+Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://ikiwiki.info/cgi-bin/viewvc.cgi/trunk/mdwn2man?root=ikiwiki&view=markup).  Edit with care