# 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
* --templatedir
- Specify the directory that the page [[templates]] are stored in. Default
- is `/usr/share/ikiwiki/templates`, or another location as configured at
+ 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.
Specify a mode to chmod the wrapper to after creating it.
-* --notify, --no-notify
+* --wrappergroup group
- Enable email notification of commits. This should be used when running
- ikiwiki as a [[post-commit]] hook.
+ 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.
-* --rcs=svn, --no-rcs
+* --rcs=svn|git|.., --no-rcs
- Enable or disable use of a revision control system.
+ Enable or disable use of a [[revision_control_system|rcs]].
- 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.
-
- 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
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]].
-
* --svnpath trunk
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.
+ inside the repository. If your wiki is rooted at the top of the repository,
+ set svnpath to "".
* --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
- a [[blog]].
+ a [[ikiwiki/blog]].
* --pingurl URL
* --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
Disables use of a plugin. For example "--disable-plugin htmlscrubber"
to do away with HTML sanitization.
+* --libdir directory
+
+ 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
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
Log to syslog(3).
+* --usedirs, --no-usedirs
+
+ Toggle creating output files named page/index.html (default) instead of page.html.
+
* --w3mmode, --no-w3mmode
Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
Subversion checkout. It is unoptimised and quite slow. It is best used
with --rebuild, to force ikiwiki to get the ctime for all pages.
+* --set var=value
+
+ This allows setting an arbitrary configuration variable, the same as if it
+ were set via a configuration file. Since most options can be configured
+ 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>