improve

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

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index aa352736c44285acf70740d8df3d972c4ac07a27..a8bb92d68cb48d2ba2121368d4ec3f23eba4c4a2 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -10,8 +10,8 @@ ikiwiki --setup configfile
 
 # DESCRIPTION
 
 
 # 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
+`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

 `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


@@ -19,7 +19,7 @@ flags such as --verbose can be negated with --no-verbose.
 
 # MODE OPTIONS
 
 
 # MODE OPTIONS
 

-These options control the mode that ikiwiki is operating in.
+These options control the mode that ikiwiki operates in.

 
 * --refresh
 
 
 * --refresh
 


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


@@ -84,9 +86,17 @@ These options control the mode that ikiwiki is operating in.
 
        ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
 
 
        ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
 

+* --post-commit
+
+  Run in post-commit mode, the same as if called by a [[post-commit]] hook.
+  This is probably only useful when using ikiwiki with a web server on one host
+  and a repository on another, to allow the repository's real post-commit
+  hook to ssh to the web server host and manually run ikiwiki to update
+  the web site.
+

 * --version
 
 * --version
 

-  Print ikiwiki version number.
+  Print ikiwiki's version number.

 
 # CONFIG OPTIONS
 
 
 # CONFIG OPTIONS
 


@@ -99,9 +109,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|wikitemplates]] 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
 


@@ -114,7 +125,7 @@ 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.
 

-* --notify
+* --notify, --no-notify

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


@@ -134,68 +145,68 @@ configuration options of their own.
   If you use mercurial, the `source` directory is assumed to be the
   [[mercurial]] repository.
 
   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
+  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. Also, the [[RecentChanges]] link will be placed
   on pages.
 

-  svn 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
 
 * --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]].

 
 * --svnpath trunk
 
 
 * --svnpath trunk
 

-  Specify the path inside your svn reporistory where the wiki is located.
-  This defaults to trunk; change it if your wiki is at some other location
-  inside the repository.
-
-* --anonok, --noanonok
+  Specify the path inside your svn repository where the wiki is located.
+  This defaults to `trunk`; change it if your wiki is at some other path
+  inside the repository. If your wiki is rooted at the top of the repository,
+  set svnpath to "".

 
 

-  If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
+* --rss, --norss

 
 

-  By default, anonymous users cannot edit the wiki.
+  If rss is set, ikiwiki will generate RSS feeds for pages that inline
+  a [[blog]].

 
 

-* --rss, --norss
+* --atom, --noatom

 
 

-  If rss is set, ikiwiki will generate rss feeds for pages that inline
+  If atom is set, ikiwiki will generate Atom feeds for pages that inline

   a [[blog]].
 
   a [[blog]].
 

-* --pingurl url
+* --pingurl URL

 
 

-  Set this to the url to an XML-RPC service to ping when an RSS feed is
-  updated. For example, to ping Technorati, use the url
+  Set this to the URL of an XML-RPC service to ping when an RSS feed is
+  updated. For example, to ping Technorati, use the URL

   http://rpc.technorati.com/rpc/ping
 
   This parameter can be specified multiple times to specify more than one
   http://rpc.technorati.com/rpc/ping
 
   This parameter can be specified multiple times to specify more than one

-  url to ping.
+  URL to ping.

 
 

-* --url url
+* --url URL

 
 

-  Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
+  Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.

 
 

-* --cgiurl http://url/ikiwiki.cgi
+* --cgiurl http://example.org/ikiwiki.cgi

 
 

-  Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
+  Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when

   building the wiki for links to the cgi script to be generated.
 
   building the wiki for links to the cgi script to be generated.
 

-* --historyurl url
+* --historyurl URL

 
 

-  Specifies the url to link to for page history browsing. In the 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
   "\[[file]]" is replaced with the file to browse. It's common to use

-  [[ViewCVS]] for this.
+  [[ViewVC]] for this.

 
 

-* --adminemail you@yourhost
+* --adminemail you@example.org

 
   Specifies the email address that ikiwiki should use for sending email.
 
 
   Specifies the email address that ikiwiki should use for sending email.
 

-* --diffurl url
+* --diffurl URL

 
 

-  Specifies the url to link to for a diff of changes to a page. In the 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
   revision of the page, and "\[[r2]]" is the new revision. It's common to use
   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
   revision of the page, and "\[[r2]]" is the new revision. It's common to use

-  [[ViewCVS]] for this.
+  [[ViewVC]] for this.

 
 * --exclude regexp
 
 
 * --exclude regexp
 


@@ -205,24 +216,40 @@ configuration options of their own.
 * --adminuser name
 
   Specifies a username of a user who has the powers of a wiki admin.
 * --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.
+  Currently allows locking of any page; other powers may be added later.

   May be specified multiple times for multiple admins.
 
 * --plugin name
 
   Enables the use of the specified [[plugin|plugins]] in the wiki. 
   May be specified multiple times for multiple admins.
 
 * --plugin name
 
   Enables the use of the specified [[plugin|plugins]] in the wiki. 

-  Note that plugin names are case sensative.
+  Note that plugin names are case sensitive.

 
 * --disable-plugin name
 
   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
 
 * --disable-plugin name
 
   Disables use of a plugin. For example "--disable-plugin htmlscrubber"

-  to do away with html sanitization.
+  to do away with HTML sanitization.

 
 * --discussion, --no-discussion
 
   Enables or disables "Discussion" links from being added to the header of
   every page. The links are enabled by default.
 
 
 * --discussion, --no-discussion
 
   Enables or disables "Discussion" links from being added to the header of
   every page. The links are enabled by default.
 

+* --numbacklinks n
+
+  Controls how many backlinks should be displayed at the bottom of a page.
+  Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to
+  disable this feature.
+
+* --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.
+
+* --htmlext html
+
+  Configures the extension used for generated html files. Default is "html".
+

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


@@ -230,11 +257,15 @@ 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
 

-  Log to syslog.
+  Log to syslog(3).
+
+* --usedirs, --no-usedirs
+
+  Create output files named page/index.html instead of page.html.

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


@@ -251,12 +282,12 @@ configuration options of their own.
 
   Pull last changed time for each new page out of the revision control
   system. This rarely used option provides a way to get the real creation
 
   Pull last changed time for each new page out of the revision control
   system. This rarely used option provides a way to get the real creation

-  times of items in weblogs, for example when building a wiki from a new
-  subversion checkout. It is unoptimised and quite slow. It is best used
+  times of items in weblogs, such as when building a wiki from a new
+  Subversion checkout. It is unoptimised and quite slow. It is best used

   with --rebuild, to force ikiwiki to get the ctime for all pages.
 
 # AUTHOR
 
   with --rebuild, to force ikiwiki to get the ctime for all pages.
 
 # AUTHOR
 

-Joey Hess <joey@kitenet.net>
+Joey Hess <joey@ikiwiki.info>

 
 

-Warning: this page is automatically made into ikiwiki's man page, edit with care
+Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://ikiwiki.info/cgi-bin/viewvc.cgi/trunk/mdwn2man?root=ikiwiki&view=markup).  Edit with care