web commit by http://getopenid.com/ptecza: Bug report

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index efbc765ac0933dc8fd04fcc22b857a0bb942c085..29ec09670d225408aa1e1cc0af19c9da7abd70f5 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.
 
   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.
   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
 
 
 * --wrappers
 


@@ -75,6 +77,15 @@ These options control the mode that ikiwiki is operating in.
   along with this one. --rebuild will also force feeds to be polled even if
   they were polled recently.
 
   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.
 * --version
 
   Print ikiwiki version number.


@@ -90,9 +101,10 @@ configuration options of their own.
 
 * --templatedir
 
 
 * --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
 
 
 * --underlaydir
 


@@ -120,6 +132,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.


@@ -145,7 +162,12 @@ configuration options of their own.
 
 * --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


@@ -209,6 +231,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.
 
   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
 * --timeformat format
 
   Specify how to display the time or date. The format string is passed to the


@@ -216,7 +244,7 @@ configuration options of their own.
 
 * --verbose, --no-verbose
 
 
 * --verbose, --no-verbose
 

-  Be vebose about what is being done.
+  Be verbose about what is being done.

 
 * --syslog, --no-syslog
 
 
 * --syslog, --no-syslog
 


@@ -227,6 +255,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