X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/227b64ad72faec528984e7924eca44f29ff92402..735908e5907ce1a9df38bc8a9117b3e511e0b4dd:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index fdd54e389..a8bb92d68 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,7 +125,7 @@ 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. @@ -152,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 - inside the repository. + inside the repository. If your wiki is rooted at the top of the repository, + set svnpath to "". * --rss, --norss @@ -225,12 +234,22 @@ 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. +* --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 +263,10 @@ configuration options of their own. 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, @@ -265,6 +288,6 @@ configuration options of their own. # AUTHOR -Joey Hess +Joey Hess -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