Rename todo item.

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index fdd54e38981155d7759e7233d6dda768cf0b039a..f80b02ff173ed55a53a71ead2f925b8bc62e6cd5 100644 (file)
--- 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
 
 
        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.
 * --version
 
   Print ikiwiki's version number.


@@ -101,8 +109,8 @@ configuration options of their own.
 
 * --templatedir
 
 
 * --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.
 
   build time. If the templatedir is changed, missing templates will still
   be searched for in the default location as a fallback.
 


@@ -117,7 +125,7 @@ configuration options of their own.
 
   Specify a mode to chmod the wrapper to after creating it.
 
 
   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.
 
   Enable email notification of commits. This should be used when running
   ikiwiki as a [[post-commit]] hook.


@@ -225,6 +233,11 @@ configuration options of their own.
   Enables or disables "Discussion" links from being added to the header of
   every page. The links are enabled by default.
 
   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 maximum. Excess backlinks
+  will be hidden in a popup. Default is 10.
+

 * --userdir subdir
 
   Optionally, allows links to users of the wiki to link to pages inside a
 * --userdir subdir
 
   Optionally, allows links to users of the wiki to link to pages inside a


@@ -244,6 +257,10 @@ configuration options of their own.
 
   Log to syslog(3).
 
 
   Log to syslog(3).
 

+* --usedirs, --no-usedirs
+
+  Create output files named page/index.html instead of page.html.
+

 * --w3mmode, --no-w3mmode
 
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 * --w3mmode, --no-w3mmode
 
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,


@@ -265,6 +282,6 @@ configuration options of their own.
 
 # AUTHOR
 
 
 # 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