]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/usage.mdwn
* Add a run_hooks function for the common task of running all hooks of a
[ikiwiki.git] / doc / usage.mdwn
index 6ff71056f2bd018b411f246c25b590a5fd86d849..691880a96a701b3cb4b71c140735f5db79b5f5e5 100644 (file)
@@ -24,7 +24,8 @@ These options control the mode that ikiwiki is operating in.
 * --refresh
 
   Refresh the wiki, updating any changed pages. This is the default
-  behavior so you don't normally need to specify it.
+  behavior so you don't normally need to specify it. If used with -setup also
+  updates any configured wrappers.
 
 * --rebuild
 
@@ -65,7 +66,8 @@ These options control the mode that ikiwiki is operating in.
 
 # CONFIG OPTIONS
 
-These options configure the wiki.
+These options configure the wiki. Note that plugins can add additional
+configuration options of their own.
 
 * --wikiname
 
@@ -157,7 +159,7 @@ These options configure the wiki.
 
   Specifies the email address that ikiwiki should use for sending email.
 
-* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
 
   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
@@ -199,6 +201,11 @@ These options configure the wiki.
 
   Be vebose about what is being done.
 
+* --w3mmode, --no-w3mmode
+
+  Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
+  without a web server.
+
 * --getctime
 
   Pull last changed time for each new page out of the revision control