ikiwiki [options] source templates 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`.
+`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`.
# OPTIONS
-Note that most options can be shortened to single letters.
+Note that most options can be shortened to single letters, and boolean
+flags such as --verbose can be negated with --no-verbose.
* --wikiname
Force a rebuild of all pages.
-* --wrapper
+* --wrapper [file]
+
+ Generate a [[wrapper]] binary that is hardcoded to do action specified by
+ the other options, using the specified input files and `destination`
+ directory. The filename to use for the wrapper is optional.
+
+ 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]].
- Generate a [[wrapper]] binary that is hardcoded to do action specified by the other options, using the specified input files and `destination` directory.
+ 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.
- 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]].
+* --wrappermode mode
- 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.
+ Specify a mode to chmod the wrapper to after creating it.
* --svn, --nosvn
Specifies the url to link to for page history browsing. In the url, "[[]]" is replaced with the page to browse. It's common to use [[ViewCVS]] for this.
+* --exclude regexp
+
+ Specifies a rexexp of source files to exclude from processing.
+ May be specified multiple times to add to exclude list.
+
+* --setup configfile
+
+ In setup mode, ikiwiki reads the config file, which is really a perl
+ program that can call ikiwiki internal functions. Uses of this are
+ various; the normal one is to automatically generate wrappers for a
+ wiki based on data in a config file.
+
+ Note that the wiki will be (re)built as part of the setup process to
+ ensure that any changes take effect.
+
+ [[ikiwiki.setup]] is an example of such a config file.
+
# AUTHOR
-Joey Hess <joey@kitenet.net>
\ No newline at end of file
+Joey Hess <joey@kitenet.net>
+
+Warning: this page is automatically made into ikiwiki's man page, edit with care