* --wrapper [file]
- Generate a [[wrapper]] binary that is hardcoded to do action specified by
+ Generate a wrapper binary that is hardcoded to do action specified by
the other options, using the specified input files and `destination`
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.
The name of the wiki, default is "wiki".
-* --fixctime
-
- Pull last changed time for all pages 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.
-
* --templatedir
Specify the directory that the page [[templates]] are stored in.
* --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
-* --svn, --nosvn
+ Enable or disable use of a revision control system.
- Enable or disable use of [[subversion]]. If subversion is enabled, 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.
- In [[CGI]] mode, with subversion enabled pages edited via the web will be
- committed to subversion. Also, the [[RecentChanges]] link will be placed
+ 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
on pages.
- Subversion is enabled by default.
+ svn is enabled by default.
* --svnrepo /svn/wiki
* --rss, --norss
If rss is set, ikiwiki will generate rss feeds for pages that inline
- a blog.
+ a [[blog]].
* --url http://url/
* --cgiurl http://url/ikiwiki.cgi
- Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
+ Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
+ building the wiki for links to the cgi script to be generated.
* --historyurl http://url/trunk/\[[file]]?root=wiki
Currently allows locking of any page, other powers may be added later.
May be specified multiple times for multiple admins.
-* --sanitize
+* --plugin name
+
+ Enables the use of the specified [[plugin|plugins]] in the wiki.
+ Note that plugin names are case sensative.
- Enable [[HtmlSanitization]] of wiki content. On by default, disable with
- --no-sanitize.
+* --disable-plugin name
-* --hyperestraier
+ Disables use of a plugin. For example "--disable-plugin htmlscrubber"
+ to do away with html sanitization.
- Enables use of the [[HyperEstraier]] search engine for full test page
- searches.
+* --discussion, --no-discussion
+
+ 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 it's doing.
+ Be vebose about what is being done.
+
+* --getctime
+
+ 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
+ with --rebuild, to force ikiwiki to get the ctime for all pages.
# AUTHOR