# 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
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.
If you only want to build any changed pages, you can use --refresh with
--setup.
+* --dumpsetup configfile
+
+ Causes ikiwiki to write to the specified config file, dumping out
+ its current configuration.
+
* --wrappers
If used with --setup --refresh, this makes it also update any configured
build time. If the templatedir is changed, missing templates will still
be searched for in the default location as a fallback.
+ Note that if you choose to copy and modify ikiwiki's templates, you will need
+ to be careful to keep them up to date when upgrading to new versions of
+ ikiwiki. Old versions of templates do not always work with new ikiwiki
+ versions.
+
* --underlaydir
Specify the directory that is used to underlay the source directory.
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|git|.., --no-rcs
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|rcs/svn]].
+ Specify the location of the svn repository for the wiki.
* --svnpath trunk
* --rss, --norss
- If rss is set, ikiwiki will generate RSS feeds for pages that inline
- a [[blog]].
+ If rss is set, ikiwiki will default to generating RSS feeds for pages
+ that inline a [[ikiwiki/blog]].
+
+* --allowrss
+
+ If allowrss is set, and rss is not set, ikiwiki will not default to
+ generating RSS feeds, but setting `rss=yes` in the blog can override
+ this default and generate a feed.
* --atom, --noatom
- If atom is set, ikiwiki will generate Atom feeds for pages that inline
- a [[blog]].
+ If atom is set, ikiwiki will default to generating Atom feeds for pages
+ that inline a [[ikiwiki/blog]].
+
+* --allowatom
+
+ If allowatom is set, and rss is not set, ikiwiki will not default to
+ generating Atom feeds, but setting `atom=yes` in the blog can override
+ this default and generate a feed.
* --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.
+ 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|banned_users]] 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
Enables the use of the specified [[plugin|plugins]] in the wiki.
Toggle creating output files named page/index.html (default) instead of page.html.
+* --prefix-directives, --no-prefix-directives
+
+ Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently
+ defaults to --no-prefix-directives.
+
* --w3mmode, --no-w3mmode
Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
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)
+* [[ikiwiki-transition]](1)
# AUTHOR