add a tip about dealing with ikiwiki's binary state files

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 04a5e1556aa5de6f5cfe3b83fc6383c9bc269a04..4c08c5b39cd554c8e5ce84bd1da916b0a224d8f5 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -1,4 +1,4 @@
-# SAMSUN
+# NAME

 
 ikiwiki - a wiki compiler
 
 
 ikiwiki - a wiki compiler
 


@@ -11,7 +11,7 @@ ikiwiki --setup configfile
 # DESCRIPTION
 
 `ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
 # DESCRIPTION
 
 `ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from

-`source` in the [[Markdown]] language (or others), and writes it out to
+`source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to

 `destination`.
 
 Note that most options can be shortened to single letters, and boolean
 `destination`.
 
 Note that most options can be shortened to single letters, and boolean


@@ -33,8 +33,7 @@ These options control the mode that ikiwiki operates in.
 * --cgi
 
   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
 * --cgi
 
   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and

-  supports editing pages, signing in, registration, and displaying
-  [[RecentChanges]].
+  supports editing pages, signing in, and registration.

 
   To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
   to generate a wrapper. The wrapper will generally need to run suid 6755 to
 
   To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
   to generate a wrapper. The wrapper will generally need to run suid 6755 to


@@ -133,11 +132,6 @@ configuration options of their own.
   access controlled by a group, it makes sense for the ikiwiki wrappers
   to run setgid to that group.
 
   access controlled by a group, it makes sense for the ikiwiki wrappers
   to run setgid to that group.
 

-* --notify, --no-notify
-
-  Enable email notification of commits. This should be used when running
-  ikiwiki as a [[post-commit]] hook.
-

 * --rcs=svn|git|.., --no-rcs
 
   Enable or disable use of a [[revision_control_system|rcs]].
 * --rcs=svn|git|.., --no-rcs
 
   Enable or disable use of a [[revision_control_system|rcs]].


@@ -146,16 +140,10 @@ configuration options of their own.
   whatever the revision control system you select uses.
 
   In [[CGI]] mode, with a revision control system enabled, pages edited via
   whatever the revision control system you select uses.
 
   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.
+  the web will be committed.

 
   No revision control is enabled by default.
 
 
   No revision control is enabled by default.
 

-* --svnrepo /svn/wiki
-
-  Specify the location of the svn repository for the wiki. This is required
-  for using --notify with [[Subversion|rcs/svn]].
-

 * --svnpath trunk
 
   Specify the path inside your svn repository where the wiki is located.
 * --svnpath trunk
 
   Specify the path inside your svn repository where the wiki is located.


@@ -165,13 +153,25 @@ configuration options of their own.
 
 * --rss, --norss
 
 
 * --rss, --norss
 

-  If rss is set, ikiwiki will generate RSS feeds for pages that inline
-  a [[blog]].
+  If rss is set, ikiwiki will default to generating RSS feeds for pages
+  that inline a [[ikiwiki/blog]].
+
+* --allowrss
+
+  If allowrss is set, and rss is not set, ikiwiki will not default to
+  generating RSS feeds, but setting `rss=yes` in the blog can override
+  this default and generate a feed.

 
 * --atom, --noatom
 
 
 * --atom, --noatom
 

-  If atom is set, ikiwiki will generate Atom feeds for pages that inline
-  a [[blog]].
+  If atom is set, ikiwiki will default to generating Atom feeds for pages
+  that inline a [[ikiwiki/blog]].
+
+* --allowatom
+
+  If allowatom is set, and rss is not set, ikiwiki will not default to
+  generating Atom feeds, but setting `atom=yes` in the blog can override
+  this default and generate a feed.

 
 * --pingurl URL
 
 
 * --pingurl URL
 


@@ -215,9 +215,12 @@ configuration options of their own.
 
 * --adminuser name
 
 
 * --adminuser name
 

-  Specifies a username of a user who has the powers of a wiki admin.
-  Currently allows locking of any page; other powers may be added later.
-  May be specified multiple times for multiple admins.
+  Specifies a username of a user (or, if openid is enabled, an openid) 
+  who has the powers of a wiki admin. Currently allows locking of any page,
+  and banning of users; other powers may be added later. May be specified
+  multiple times for multiple admins.
+
+  For an openid user specify the full URL of the login, including "http://".

 
 * --plugin name
 
 
 * --plugin name
 


@@ -274,6 +277,11 @@ configuration options of their own.
 
   Toggle creating output files named page/index.html (default) instead of page.html.
 
 
   Toggle creating output files named page/index.html (default) instead of page.html.
 

+* --prefix-directives, --no-prefix-directives
+
+  Toggle new '!'-prefixed syntax for preprocessor directives.  ikiwiki currently
+  defaults to --no-prefix-directives.
+

 * --w3mmode, --no-w3mmode
 
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 * --w3mmode, --no-w3mmode
 
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,


@@ -300,6 +308,12 @@ configuration options of their own.
   using command-line switches, you will rarely need to use this, but it can be
   useful for the odd option that lacks a command-line switch.
 
   using command-line switches, you will rarely need to use this, but it can be
   useful for the odd option that lacks a command-line switch.
 

+# ENVIRONMENT
+
+* CC
+
+  This controls what C compiler is used to build wrappers. Default is 'cc'.
+

 # SEE ALSO
 
 * [[ikiwiki-mass-rebuild]](8)
 # SEE ALSO
 
 * [[ikiwiki-mass-rebuild]](8)