X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/d4a1d88dbe4b3d1239c9a404fca9d2261e7f0812..53872ea80b79fbc0994d3befc99266ab0f232875:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 2f87d60d5..44d32a01d 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -32,14 +32,22 @@ These options control the mode that ikiwiki operates in. * --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 @@ -52,7 +60,7 @@ These options control the mode that ikiwiki operates in. * --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 @@ -342,7 +350,7 @@ also be configured using a setup file. * 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 @@ -376,4 +384,4 @@ also be configured using a setup file. Joey Hess -Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=mdwn2man;hb=HEAD). Edit with care +Warning: Automatically converted into a man page by mdwn2man. Edit with care