merge helponformatting fix to basewiki

[ikiwiki.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index e0c7800d5928a091e37f0224cca470bf8f9be6f8..0c7e7d036cb266c30374cb81a0c481b63b13a631 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -68,8 +68,8 @@ These options control the mode that ikiwiki is operating in.
 
 * --aggregate
 
 
 * --aggregate
 

-  If the aggregate plugin is enabled, this makes ikiwiki poll configured
-  feeds and save new posts to the srcdir.
+  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
 
   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


@@ -81,7 +81,7 @@ These options control the mode that ikiwiki is operating in.
 
 # CONFIG OPTIONS
 
 
 # CONFIG OPTIONS
 

-These options configure the wiki. Note that plugins can add additional
+These options configure the wiki. Note that [[plugins]] can add additional

 configuration options of their own.
 
 * --wikiname
 configuration options of their own.
 
 * --wikiname


@@ -91,13 +91,15 @@ configuration options of their own.
 * --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
 


@@ -118,6 +120,11 @@ configuration options of their own.
   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.


@@ -225,6 +232,12 @@ configuration options of their own.
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
   without a web server.
 
   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