test 5

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 121005ca019d2f8f8ae4d71eeb033ae141d01c65..136e969c2752d145b29491d80668141d858a566a 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -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


@@ -125,25 +125,25 @@ configuration options of their own.
 
   Specify a mode to chmod the wrapper to after creating it.
 
 
   Specify a mode to chmod the wrapper to after creating it.
 

+* --wrappergroup group
+
+  Specify what unix group the wrapper should be owned by. This can be
+  useful if the wrapper needs to be owned by a group other than the default.
+  For example, if a project has a repository with multiple committers with
+  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.
 
 * --notify, --no-notify
 
   Enable email notification of commits. This should be used when running
   ikiwiki as a [[post-commit]] hook.
 

-* --rcs=svn, --no-rcs
-
-  Enable or disable use of a revision control system.
+* --rcs=svn|git|.., --no-rcs

 
 

-  If you use svn, the `source` directory is assumed to be
-  a [[Subversion]] working copy.
+  Enable or disable use of a [[revision_control_system|rcs]].

 
 

-  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.
+  The `source` directory will be assumed to be a working copy, or clone, or
+  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
 
   In [[CGI]] mode, with a revision control system enabled, pages edited via
   the web will be committed. Also, the [[RecentChanges]] link will be placed


@@ -154,7 +154,7 @@ configuration options of their own.
 * --svnrepo /svn/wiki
 
   Specify the location of the svn repository for the wiki. This is required
 * --svnrepo /svn/wiki
 
   Specify the location of the svn repository for the wiki. This is required

-  for using --notify with [[Subversion]].
+  for using --notify with [[Subversion|rcs/svn]].

 
 * --svnpath trunk
 
 
 * --svnpath trunk
 


@@ -166,12 +166,12 @@ configuration options of their own.
 * --rss, --norss
 
   If rss is set, ikiwiki will generate RSS feeds for pages that inline
 * --rss, --norss
 
   If rss is set, ikiwiki will generate RSS feeds for pages that inline

-  a [[blog]].
+  a [[ikiwiki/blog]].

 
 * --atom, --noatom
 
   If atom is set, ikiwiki will generate Atom feeds for pages that inline
 
 * --atom, --noatom
 
   If atom is set, ikiwiki will generate Atom feeds for pages that inline

-  a [[blog]].
+  a [[ikiwiki/blog]].

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


@@ -231,9 +234,10 @@ configuration options of their own.
 
 * --libdir directory
 
 
 * --libdir directory
 

-  Makes ikiwiki look in the specified directory first, before the regular perl
-  library directories. For example, if you set libdir to "/home/you/.ikiwiki/",
-  you can install plugins in "/home/you/.ikiwiki/IkiWiki/Plugin/".
+  Makes ikiwiki look in the specified directory first, before the regular
+  locations when loading library files and plugins. For example, if you set
+  libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as
+  "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm".

 
 * --discussion, --no-discussion
 
 
 * --discussion, --no-discussion
 


@@ -271,7 +275,7 @@ configuration options of their own.
 
 * --usedirs, --no-usedirs
 
 
 * --usedirs, --no-usedirs
 

-  Create output files named page/index.html instead of page.html.
+  Toggle creating output files named page/index.html (default) instead of page.html.

 
 * --w3mmode, --no-w3mmode
 
 
 * --w3mmode, --no-w3mmode
 


@@ -299,6 +303,17 @@ 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)
+* [[ikiwiki-update-wikilist]](1)
+

 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>
 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>