* Allow preprocessor directives to contain python-like triple-quoted

[ikiwiki.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 6ff71056f2bd018b411f246c25b590a5fd86d849..e0c7800d5928a091e37f0224cca470bf8f9be6f8 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -58,14 +58,31 @@ These options control the mode that ikiwiki is operating in.
 
   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.
 
   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 also pass the --refresh option, ikiwiki will instead just refresh
-  the wiki described in the setup file.

 
   [[ikiwiki.setup]] is an example of such a config file.
 
 
   [[ikiwiki.setup]] is an example of such a config file.
 

+* --wrappers
+
+  If used with --setup --refresh, this makes it also update any configured
+  wrappers.
+
+* --aggregate
+
+  If the aggregate plugin is enabled, this makes ikiwiki poll configured
+  feeds and save new posts to the srcdir.
+
+  Note that to rebuild previously aggregated posts, use the --rebuild option
+  along with this one. --rebuild will also force feeds to be polled even if
+  they were polled recently.
+
+* --version
+
+  Print ikiwiki version number.
+

 # CONFIG OPTIONS
 
 # CONFIG OPTIONS
 

-These options configure the wiki.
+These options configure the wiki. Note that plugins can add additional
+configuration options of their own.

 
 * --wikiname
 
 
 * --wikiname
 


@@ -147,7 +164,7 @@ These options configure the wiki.
   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
   building the wiki for links to the cgi script to be generated.
 
   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
   building the wiki for links to the cgi script to be generated.
 

-* --historyurl http://url/trunk/\[[file]]?root=wiki
+* --historyurl url

 
   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
 
   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


@@ -157,7 +174,7 @@ These options configure the wiki.
 
   Specifies the email address that ikiwiki should use for sending email.
 
 
   Specifies the email address that ikiwiki should use for sending email.
 

-* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+* --diffurl url

 
   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
 
   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


@@ -195,10 +212,19 @@ These options configure the wiki.
   Specify how to display the time or date. The format string is passed to the
   strftime(3) function.
 
   Specify how to display the time or date. The format string is passed to the
   strftime(3) function.
 

-* --verbose
+* --verbose, --no-verbose

 
   Be vebose about what is being done.
 
 
   Be vebose about what is being done.
 

+* --syslog, --no-syslog
+
+  Log to syslog.
+
+* --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
 * --getctime
 
   Pull last changed time for each new page out of the revision control