no time to do maser for now, but some pointers and thanks

[git.ikiwiki.info.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 9cf61cc6cd667fc1cbf4ce328f16df1dad9c13b6..4bfe2312c9263f5c32a94de70a6e5d83270483bc 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -6,7 +6,7 @@ ikiwiki - a wiki compiler
 
 ikiwiki [options] source destination
 
 
 ikiwiki [options] source destination
 

-ikiwiki --setup setupfile
+ikiwiki --setup setupfile [options]

 
 # DESCRIPTION
 
 
 # DESCRIPTION
 


@@ -14,8 +14,9 @@ ikiwiki --setup setupfile
 `source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to
 `destination`.
 
 `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
 
 
 # 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
 * --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
 
 
 * --rebuild
 


@@ -32,14 +34,22 @@ These options control the mode that ikiwiki operates in.
 
 * --setup setupfile
 
 
 * --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.
+  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.
 
   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
 * --dumpsetup setupfile
 
   Causes ikiwiki to write to the specified setup file, dumping out


@@ -52,7 +62,7 @@ These options control the mode that ikiwiki operates in.
 
 * --clean
 
 
 * --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
   `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 +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,
 
   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://".
 
 
   For an openid user specify the full URL of the login, including "http://".
 


@@ -330,7 +342,7 @@ also be configured using a setup file.
 * --set var=value
   
   This allows setting an arbitrary configuration variable, the same as if it
 * --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
   configured using command-line switches, you will rarely need to use this.
 
 * --set-yaml var=value


@@ -342,7 +354,7 @@ also be configured using a setup file.
 
 * ikiwiki --setup my.setup
 
 
 * 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
 
 
 * ikiwiki --setup my.setup --refresh
 


@@ -351,10 +363,20 @@ also be configured using a setup file.
 
 * ikiwiki --setup my.setup --refresh --wrappers
 
 
 * 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
   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
 
 
 # ENVIRONMENT
 


@@ -376,4 +398,4 @@ also be configured using a setup file.
 
 Joey Hess <joey@ikiwiki.info>
 
 
 Joey Hess <joey@ikiwiki.info>
 

-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