X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/773731743df52d2ef2d8ce93c095be981bb9bfc8..5951c1dc8220cbc09e6bdda09bae92aa4e3236e3:/doc/usage.mdwn?ds=sidebyside diff --git a/doc/usage.mdwn b/doc/usage.mdwn index debe04e1f..02d01f49c 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -4,15 +4,14 @@ ikiwiki - a wiki compiler # SYNOPSIS -ikiwiki [options] source templates destination +ikiwiki [options] source destination ikiwiki --setup configfile # DESCRIPTION `ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from -`source` in the [[MarkDown]] language, using the specified html `templates` -and writes it out to `destination`. +`source` in the [[MarkDown]] language, and writes it out to `destination`. # OPTIONS @@ -31,6 +30,11 @@ flags such as --verbose can be negated with --no-verbose. Force a rebuild of all pages. +* --templatedir + + Specify the directory that the page [[templates]] are stored in. + Default is `/usr/share/ikiwiki/templates`. + * --wrapper [file] Generate a [[wrapper]] binary that is hardcoded to do action specified by @@ -40,9 +44,7 @@ flags such as --verbose can be negated with --no-verbose. The wrapper is designed to be safely made suid and be run by untrusted users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]]. - Note that the generated wrapper will ignore all command line parameters - except for --params, which will make it print out the parameters it would - run ikiwiki with. + Note that the generated wrapper will ignore all command line parameters. * --wrappermode mode @@ -62,6 +64,12 @@ flags such as --verbose can be negated with --no-verbose. By default, anonymous users cannot edit the wiki. +* --rss, --norss + + If rss is set, along with every html page rendered by ikiwiki, an rss + page will also be rendered, to allow users to subscribe to a rss feed of + changes to that page. + * --cgi Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]]. @@ -94,6 +102,12 @@ flags such as --verbose can be negated with --no-verbose. Specifies a rexexp of source files to exclude from processing. May be specified multiple times to add to exclude list. +* --adminuser name + + Specifies a username of a user who has the powers of a wiki admin. + Currently allows locking of any page, other powers may be added later. + May be specified multiple times for multiple admins. + * --setup configfile In setup mode, ikiwiki reads the config file, which is really a perl