X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/7bba52254569047ef1d9f5752096f155b0a2be77..90632121f935a255105eabcaefda9ee3a5a34985:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 9cf61cc6c..427a51f3b 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 @@ -245,8 +253,10 @@ also be configured using a setup file. Specifies a username of a user (or, if openid is enabled, an openid) who has the powers of a wiki admin. Currently allows locking of any page, - and [[banning|banned_users]] users; other powers may be added later. - May be specified multiple times for multiple admins. + and [[banning|banned_users]] users, as well as powers granted by + enabled plugins (such as [[moderating comments|plugins/moderatedcomments]] + and [[plugins/websetup]]. May be specified multiple times for multiple + admins. For an openid user specify the full URL of the login, including "http://". @@ -330,7 +340,7 @@ also be configured using a setup file. * --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 @@ -342,7 +352,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 +386,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