# 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
* --cgi
Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
- supports editing pages, signing in, registration, and displaying
- [[RecentChanges]].
+ supports editing pages, signing in, and registration.
To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
to generate a wrapper. The wrapper will generally need to run suid 6755 to
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
- on pages.
+ the web will be committed.
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.
* --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
* --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
* --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
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>