Point to my updated mdwn_itex plugin.

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 2e12517ea9105ab17e6e792a78271cc59f149a77..840d105d2e5517e579f00ae67efe49f8f3bf3016 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -32,14 +32,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.
   If you only want to build any changed pages, you can use --refresh with
   --setup.
 
   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
 * --dumpsetup setupfile
 
   Causes ikiwiki to write to the specified setup file, dumping out


@@ -120,10 +128,11 @@ also be configured using a setup file.
 
 * --templatedir dir
 
 
 * --templatedir dir
 

-  Specify the directory that the page [[templates|wikitemplates]] are stored in.
+  Specify the directory that [[templates|templates]] are stored in.

   Default is `/usr/share/ikiwiki/templates`, or another location as configured at
   build time. If the templatedir is changed, missing templates will still
   Default is `/usr/share/ikiwiki/templates`, or another location as configured at
   build time. If the templatedir is changed, missing templates will still

-  be searched for in the default location as a fallback.
+  be searched for in the default location as a fallback. Templates can also be
+  placed in the "templates/" subdirectory of the srcdir.

 
   Note that if you choose to copy and modify ikiwiki's templates, you will need
   to be careful to keep them up to date when upgrading to new versions of
 
   Note that if you choose to copy and modify ikiwiki's templates, you will need
   to be careful to keep them up to date when upgrading to new versions of


@@ -329,7 +338,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