* --setup setupfile
- 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 setup file, and rebuild the wiki.
If you only want to build any changed pages, you can use --refresh with
--setup.
+* --changesetup setupfile
+
+ Reads the setup file, adds any configuration changes specified by other
+ options, and writes the new configuration back to the setup file. Also
+ updates any configured wrappers. In this mode, the wiki is not fully
+ rebuilt, unless you also add --rebuild.
+
+ Example, to enable some plugins:
+
+ ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin calendar
+
* --dumpsetup setupfile
Causes ikiwiki to write to the specified setup file, dumping out
* --clean
- This makes ikiwiki clean up by removing any files it denerated in the
+ This makes ikiwiki clean up by removing any files it generated in the
`destination` directory, as well as any configured wrappers, and the
`.ikiwiki` state directory. This is mostly useful if you're running
ikiwiki in a Makefile to build documentation and want a corresponding
* --set var=value
This allows setting an arbitrary configuration variable, the same as if it
- were set via a setup file. Since most options commonly used options can be
+ were set via a setup file. Since most commonly used options can be
configured using command-line switches, you will rarely need to use this.
* --set-yaml var=value
* ikiwiki --setup my.setup
- Completly (re)build the wiki using the specified setup file.
+ Completely (re)build the wiki using the specified setup file.
* ikiwiki --setup my.setup --refresh