web commit by ScottHenson

[git.ikiwiki.info.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 6ff71056f2bd018b411f246c25b590a5fd86d849..9e260adc29ceeec7a06a8ce957b1bb2c506e598b 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -58,14 +58,40 @@ 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 [[plugins/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.
+
+* --render file
+
+  Renders a single file, outputting the resulting html. Does not save state,
+  so this cannot be used for building whole wikis, but it is useful for
+  previewing an edited file at the command line. Generally used in conjunction
+  with --setup to load in a wiki's setup:
+
+       ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
+
+* --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
 


@@ -74,13 +100,15 @@ These options configure the wiki.
 * --templatedir
 
   Specify the directory that the page [[templates]] are stored in.
 * --templatedir
 
   Specify the directory that the page [[templates]] are stored in.

-  Default is `/usr/share/ikiwiki/templates`.
+  Default is `/usr/share/ikiwiki/templates`, or another location as
+  configured at build time.

 
 * --underlaydir
 
   Specify the directory that is used to underlay the source directory.
   Source files will be taken from here unless overridden by a file in the
 
 * --underlaydir
 
   Specify the directory that is used to underlay the source directory.
   Source files will be taken from here unless overridden by a file in the

-  source directory. Default is `/usr/share/ikiwiki/basewiki`.
+  source directory. Default is `/usr/share/ikiwiki/basewiki` or another
+  location as configured at build time.

 
 * --wrappermode mode
 
 
 * --wrappermode mode
 


@@ -101,6 +129,11 @@ These options configure the wiki.
   If you use git, the `source` directory is assumed to be a clone of the
   [[git]] repository.
 
   If you use git, the `source` directory is assumed to be a clone of the
   [[git]] repository.
 

+  If you use tla, the `source` directory is assumed to be a tla import.
+
+  If you use mercurial, the `source` directory is assumed to be the
+  [[mercurial]] repository.
+

   In [[CGI]] mode, with a revision control system enabled pages edited via
   the web will be committed. Also, the [[RecentChanges]] link will be placed
   on pages.
   In [[CGI]] mode, with a revision control system enabled pages edited via
   the web will be committed. Also, the [[RecentChanges]] link will be placed
   on pages.


@@ -126,7 +159,12 @@ These options configure the wiki.
 
 * --rss, --norss
 
 
 * --rss, --norss
 

-  If rss is set, ikiwiki will generate rss feeds for pages that inline
+  If rss is set, ikiwiki will generate RSS feeds for pages that inline
+  a [[blog]].
+
+* --atom, --noatom
+
+  If atom is set, ikiwiki will generate Arom feeds for pages that inline

   a [[blog]].
 
 * --pingurl url
   a [[blog]].
 
 * --pingurl url


@@ -147,7 +185,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 +195,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 +233,25 @@ 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.
+
+* --sslcookie
+
+  Only send cookies over an SSL connection. This should prevent them being
+  intercepted. If you enable this option then you must run at least the 
+  CGI portion of ikiwiki over SSL.
+

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