X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a35dd1d806f9bca82c0c04a4ff6c69956e3371a0..6d98c5290f2542552979e374d8e3dcbef51f31a6:/doc/usage.mdwn?ds=sidebyside

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 4c08c5b39..b6af75ac8 100644
--- 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.
 
+* --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
@@ -50,23 +70,6 @@ These options control the mode that ikiwiki operates in.
 
   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
@@ -113,6 +116,11 @@ configuration options of their own.
   build time. If the templatedir is changed, missing templates will still
   be searched for in the default location as a fallback.
 
+  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
+  ikiwiki. Old versions of templates do not always work with new ikiwiki
+  versions.
+
 * --underlaydir
 
   Specify the directory that is used to underlay the source directory.
@@ -144,6 +152,10 @@ configuration options of their own.
 
   No revision control is enabled by default.
 
+* --svnrepo /svn/wiki
+
+  Specify the location of the svn repository for the wiki.
+
 * --svnpath trunk
 
   Specify the path inside your svn repository where the wiki is located.
@@ -154,24 +166,24 @@ configuration options of their own.
 * --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
-  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
-  that inline a [[ikiwiki/blog]].
+  that inline a [[blog]].
 
 * --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
 
@@ -217,8 +229,8 @@ configuration options of their own.
 
   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 of users; other powers may be added later. May be specified
-  multiple times for multiple admins.
+  and [[banning|banned_users]] users; other powers may be added later.
+  May be specified multiple times for multiple admins.
 
   For an openid user specify the full URL of the login, including "http://".
 
@@ -318,9 +330,10 @@ configuration options of their own.
 
 * [[ikiwiki-mass-rebuild]](8)
 * [[ikiwiki-update-wikilist]](1)
+* [[ikiwiki-transition]](1)
 
 # 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