diff options
| -rw-r--r-- | doc/usage.mdwn | 82 |
1 files changed, 46 insertions, 36 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn index f2f0fba9a..f477fe562 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -13,39 +13,31 @@ ikiwiki --setup configfile `ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from `source` in the [[MarkDown]] language, and writes it out to `destination`. -# OPTIONS - Note that most options can be shortened to single letters, and boolean flags such as --verbose can be negated with --no-verbose. -* --wikiname - - The name of the wiki, default is "wiki". - -* --verbose - - Be vebose about what it's doing. - -* --rebuild +# MODE OPTIONS - Force a rebuild of all pages. +These options control the mode that ikiwiki is operating in. * --refresh Refresh the wiki, updating any changes pages. This is the default behavior so you don't normally need to specify it. -* --fixctime +* --rebuild - Pull last changed time for all pages out of the revision control system. - This rarely used option provides a way to get the real creation times of - items in weblogs, for example when building a wiki from a new subversion - checkout. It is unoptimised and quite slow. + Force a rebuild of all pages. -* --templatedir +* --cgi - Specify the directory that the page [[templates]] are stored in. - Default is `/usr/share/ikiwiki/templates`. + Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and + supports editing pages, signing in, registration, and displaying + [[RecentChanges]]. + + To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup + to generate a wrapper. The wrapper will generally need to run suid 6755 to + the user who owns the `source` and `destination` directories. * --wrapper [file] @@ -58,6 +50,38 @@ flags such as --verbose can be negated with --no-verbose. Note that the generated wrapper will ignore all command line parameters. +* --setup configfile + + In setup mode, ikiwiki reads the config file, which is really a perl + program that can call ikiwiki internal functions. + + The default action when --setup is specified is to automatically generate + wrappers for a wiki based on data in a config file, and rebuild the wiki. + If you also pass the --refresh option, ikiwiki will instead just refresh + the wiki described in the setup file. + + [[ikiwiki.setup]] is an example of such a config file. + +# CONFIG OPTIONS + +These options configure the wiki. + +* --wikiname + + The name of the wiki, default is "wiki". + +* --fixctime + + Pull last changed time for all pages out of the revision control system. + This rarely used option provides a way to get the real creation times of + items in weblogs, for example when building a wiki from a new subversion + checkout. It is unoptimised and quite slow. + +* --templatedir + + Specify the directory that the page [[templates]] are stored in. + Default is `/usr/share/ikiwiki/templates`. + * --wrappermode mode Specify a mode to chmod the wrapper to after creating it. @@ -81,12 +105,6 @@ flags such as --verbose can be negated with --no-verbose. If rss is set, ikiwiki will generate rss feeds for pages that inline a blog. -* --cgi - - Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]]. - - To use ikiwiki as a [[CGI]] program you need to use --wrapper to generate a wrapper. The wrapper will generally need to run suid 6755 to the user who owns the `source` and `destination` directories. - * --url http://someurl/ Specifies the url to the wiki. This is a required parameter in [[CGI]] mode. @@ -119,17 +137,9 @@ flags such as --verbose can be negated with --no-verbose. 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 - program that can call ikiwiki internal functions. - - The default action when --setup is specified is to automatically generate - wrappers for a wiki based on data in a config file, and rebuild the wiki. - If you also pass the --refresh option, ikiwiki will instead just refresh - the wiki described in the setup file. +* --verbose - [[ikiwiki.setup]] is an example of such a config file. + Be vebose about what it's doing. # AUTHOR |