web commit by http://ethan.betacantrips.com/: update for 1.42; reformat

[ikiwiki.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 9e260adc29ceeec7a06a8ce957b1bb2c506e598b..485198d61f617f40483553f8c4ceef422e93a672 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -56,10 +56,12 @@ These options control the mode that ikiwiki is operating in.
   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.
-
-  [[ikiwiki.setup]] is an example of such a config file.
+  If you only want to build any changed pages, you can use --refresh with
+  --setup.
 
 * --wrappers
 
@@ -99,9 +101,10 @@ configuration options of their own.
 
 * --templatedir
 
-  Specify the directory that the page [[templates]] are stored in.
-  Default is `/usr/share/ikiwiki/templates`, or another location as
-  configured at build time.
+  Specify the directory that the page [[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
+  be searched for in the default location as a fallback.
 
 * --underlaydir
 
@@ -138,7 +141,7 @@ configuration options of their own.
   the web will be committed. Also, the [[RecentChanges]] link will be placed
   on pages.
 
-  svn is enabled by default.
+  No revision control is enabled by default.
 
 * --svnrepo /svn/wiki
 
@@ -151,12 +154,6 @@ configuration options of their own.
   This defaults to trunk; change it if your wiki is at some other location
   inside the repository.
 
-* --anonok, --noanonok
-
-  If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
-
-  By default, anonymous users cannot edit the wiki.
-
 * --rss, --norss
 
   If rss is set, ikiwiki will generate RSS feeds for pages that inline
@@ -189,7 +186,7 @@ configuration options of their own.
 
   Specifies the url to link to for page history browsing. In the url,
   "\[[file]]" is replaced with the file to browse. It's common to use
-  [[ViewCVS]] for this.
+  [[ViewVC]] for this.
 
 * --adminemail you@yourhost
 
@@ -200,7 +197,7 @@ configuration options of their own.
   Specifies the url to link to for a diff of changes to a page. In the url,
   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
   revision of the page, and "\[[r2]]" is the new revision. It's common to use
-  [[ViewCVS]] for this.
+  [[ViewVC]] for this.
 
 * --exclude regexp
 
@@ -228,6 +225,12 @@ configuration options of their own.
   Enables or disables "Discussion" links from being added to the header of
   every page. The links are enabled by default.
 
+* --userdir subdir
+
+  Optionally, allows links to users of the wiki to link to pages inside a
+  subdirectory of the wiki. The default is to link to pages in the toplevel
+  directory of the wiki.
+
 * --timeformat format
 
   Specify how to display the time or date. The format string is passed to the
@@ -235,7 +238,7 @@ configuration options of their own.
 
 * --verbose, --no-verbose
 
-  Be vebose about what is being done.
+  Be verbose about what is being done.
 
 * --syslog, --no-syslog