thoughts

[ikiwiki.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 2df28e1ebd9663d9eaf6c35f5f001b4082ac88be..b6af75ac81dcd104a3d7be95578de49bf9ef0045 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -30,6 +30,26 @@ These options control the mode that ikiwiki operates in.
 
   Force a rebuild of all pages.
 
 
   Force a rebuild of all pages.
 

+* --setup configfile
+
+  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 config file, and rebuild the wiki.
+  If you only want to build any changed pages, you can use --refresh with
+  --setup.
+
+* --dumpsetup configfile
+
+  Causes ikiwiki to write to the specified config file, dumping out
+  its current configuration.
+
+* --wrappers
+
+  If used with --setup --refresh, this makes it also update any configured
+  wrappers.
+

 * --cgi
 
   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
 * --cgi
 
   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and


@@ -50,23 +70,6 @@ These options control the mode that ikiwiki operates in.
 
   Note that the generated wrapper will ignore all command line parameters.
 
 
   Note that the generated wrapper will ignore all command line parameters.
 

-* --setup configfile
-
-  In setup mode, ikiwiki reads the config file, which is really a perl
-  program that can call ikiwiki internal functions.
-
-  [[ikiwiki.setup]] is an example of such a config file.
-
-  The default action when --setup is specified is to automatically generate
-  wrappers for a wiki based on data in a config file, and rebuild the wiki.
-  If you only want to build any changed pages, you can use --refresh with
-  --setup.
-
-* --wrappers
-
-  If used with --setup --refresh, this makes it also update any configured
-  wrappers.
-

 * --aggregate
 
   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
 * --aggregate
 
   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll


@@ -163,24 +166,24 @@ configuration options of their own.
 * --rss, --norss
 
   If rss is set, ikiwiki will default to generating RSS feeds for pages
 * --rss, --norss
 
   If rss is set, ikiwiki will default to generating RSS feeds for pages

-  that inline a [[ikiwiki/blog]].
+  that inline a [[blog]].

 
 * --allowrss
 
   If allowrss is set, and rss is not set, ikiwiki will not default to
 
 * --allowrss
 
   If allowrss is set, and rss is not set, ikiwiki will not default to

-  generating RSS feeds, but setting `rss=yes` in the blog can override
-  this default and generate a feed.
+  generating RSS feeds, but setting `rss=yes` in the inline directive can
+  override this default and generate a feed.

 
 * --atom, --noatom
 
   If atom is set, ikiwiki will default to generating Atom feeds for pages
 
 * --atom, --noatom
 
   If atom is set, ikiwiki will default to generating Atom feeds for pages

-  that inline a [[ikiwiki/blog]].
+  that inline a [[blog]].

 
 * --allowatom
 
   If allowatom is set, and rss is not set, ikiwiki will not default to
 
 * --allowatom
 
   If allowatom is set, and rss is not set, ikiwiki will not default to

-  generating Atom feeds, but setting `atom=yes` in the blog can override
-  this default and generate a feed.
+  generating Atom feeds, but setting `atom=yes` in the inline directive can
+  override this default and generate a feed.

 
 * --pingurl URL
 
 
 * --pingurl URL
 


@@ -327,9 +330,10 @@ configuration options of their own.
 
 * [[ikiwiki-mass-rebuild]](8)
 * [[ikiwiki-update-wikilist]](1)
 
 * [[ikiwiki-mass-rebuild]](8)
 * [[ikiwiki-update-wikilist]](1)

+* [[ikiwiki-transition]](1)

 
 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>
 
 
 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>
 

-Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://ikiwiki.info/cgi-bin/viewvc.cgi/trunk/mdwn2man?root=ikiwiki&view=markup).  Edit with care
+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