# DESCRIPTION
`ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from
-`source` in the [[MarkDown]] language, and writes it out to `destination`.
+`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
flags such as --verbose can be negated with --no-verbose.
* --refresh
Refresh the wiki, updating any changed pages. This is the default
- behavior so you don't normally need to specify it.
+ behavior so you don't normally need to specify it. If used with -setup also
+ updates any configured wrappers.
* --rebuild
directory. The filename to use for the wrapper is optional.
The wrapper is designed to be safely made suid and be run by untrusted
- users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
+ users, as a [[post-commit]] hook, or as a [[CGI]].
Note that the generated wrapper will ignore all command line parameters.
* --notify
Enable email notification of commits. This should be used when running
- ikiwiki as a [[Subversion]] [[post-commit]] hook.
+ ikiwiki as a [[post-commit]] hook.
* --rcs=svn, --no-rcs
Enable or disable use of a revision control system.
- If you use svn ([[Subversion]]), the `source` directory is assumed to be
- a working copy, and is automatically updated before building the wiki.
+ If you use svn, the `source` directory is assumed to be
+ a [[Subversion]] working copy.
+
+ If you use git, the `source` directory is assumed to be a clone of the
+ [[git]] 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
If rss is set, ikiwiki will generate rss feeds for pages that inline
a [[blog]].
-* --url http://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
+ http://rpc.technorati.com/rpc/ping
+
+ This parameter can be specified multiple times to specify more than one
+ url to ping.
+
+* --url url
Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
Specifies the email address that ikiwiki should use for sending email.
-* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
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
* --plugin name
- Enables the use of the specified plugin in the wiki. See [[plugins]] for
- details. Note that plugin names are case sensative.
+ Enables the use of the specified [[plugin|plugins]] in the wiki.
+ Note that plugin names are case sensative.
* --disable-plugin name
Enables or disables "Discussion" links from being added to the header of
every page. The links are enabled by default.
+* --timeformat format
+
+ Specify how to display the time or date. The format string is passed to the
+ strftime(3) function.
+
* --verbose
Be vebose about what is being done.
+* --w3mmode, --no-w3mmode
+
+ Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
+ without a web server.
+
* --getctime
Pull last changed time for each new page out of the revision control