X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/fd2b2f386f30cf2ba578da8a8174dd60ae024adc..5aeaafac7ad106e0d6a90625def01154e3abc992:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 840d105d2..4bfe2312c 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -6,7 +6,7 @@ ikiwiki - a wiki compiler ikiwiki [options] source destination -ikiwiki --setup setupfile +ikiwiki --setup setupfile [options] # DESCRIPTION @@ -14,8 +14,9 @@ ikiwiki --setup setupfile `source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to `destination`. -Note that most options can be shortened to single letters, and boolean -flags such as --verbose can be negated with --no-verbose. +Note that most options can be shortened to single letters, boolean +flags such as --verbose can be negated with --no-verbose, and +options such as --verbose can also be spelled like -verbose. # MODE OPTIONS @@ -24,7 +25,8 @@ These options control the mode that ikiwiki operates in. * --refresh Refresh the wiki, updating any changed pages. This is the default - behavior so you don't normally need to specify it. + behavior if no other mode action is specified (but note that --setup is + a mode action, and has different default behavior). * --rebuild @@ -32,8 +34,8 @@ These options control the mode that ikiwiki operates in. * --setup setupfile - 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. + Load options from the given setup file. If no other mode action is specified, + generate wrappers and rebuild the wiki, as if --rebuild --wrappers were used. If you only want to build any changed pages, you can use --refresh with --setup. @@ -60,7 +62,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 @@ -253,8 +255,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://". @@ -350,7 +354,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 @@ -359,10 +363,20 @@ also be configured using a setup file. * ikiwiki --setup my.setup --refresh --wrappers - Refresh the wiki, including regnerating all wrapper programs, + Refresh the wiki, including regenerating all wrapper programs, but do not rebuild all pages. Useful if you have changed something in the setup file that does not need a full wiki rebuild to update - all pages, but that you want to immediatly take effect. + all pages, but that you want to immediately take effect. + +* ikiwiki --rebuild srcdir destdir + + Use srcdir as source and build HTML in destdir, without using a + setup file. + +* ikiwiki srcdir destdir + + Use srcdir as source to update changed pages' HTML in destdir, + without using a setup file. # ENVIRONMENT @@ -384,4 +398,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