ikiwiki [options] source destination
-ikiwiki --setup configfile
+ikiwiki --setup setupfile
# 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
+`ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
+`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
# MODE OPTIONS
-These options control the mode that ikiwiki is operating in.
+These options control the mode that ikiwiki operates in.
* --refresh
Force a rebuild of all pages.
+* --setup setupfile
+
+ In setup mode, ikiwiki reads the config file, which is really a perl
+ program that can call ikiwiki internal functions.
+
+ The default action when --setup is specified is to automatically generate
+ wrappers for a wiki based on data in a setup file, and rebuild the wiki.
+ If you only want to build any changed pages, you can use --refresh with
+ --setup.
+
+* --dumpsetup setupfile
+
+ Causes ikiwiki to write to the specified setup file, dumping out
+ its current configuration.
+
+* --wrappers
+
+ If used with --setup --refresh, this makes it also update any configured
+ wrappers.
+
+* --clean
+
+ This makes ikiwiki clean up by removing any files it denerated in the
+ `destination` directory, as well as any configured wrappers, and the
+ `.ikiwiki` state directory. This is mostly useful if you're running
+ ikiwiki in a Makefile to build documentation and want a corresponding
+ `clean` target.
+
* --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
Note that the generated wrapper will ignore all command line parameters.
-* --setup configfile
-
- In setup mode, ikiwiki reads the config file, which is really a perl
- program that can call ikiwiki internal functions.
-
- 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.
-
- [[ikiwiki.setup]] is an example of such a config file.
-
-* --wrappers
-
- If used with --setup --refresh, this makes it also update any configured
- wrappers.
-
* --aggregate
If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
along with this one. --rebuild will also force feeds to be polled even if
they were polled recently.
+* --render file
+
+ Renders a single file, outputting the resulting html. Does not save state,
+ so this cannot be used for building whole wikis, but it is useful for
+ previewing an edited file at the command line. Generally used in conjunction
+ with --setup to load in a wiki's setup:
+
+ ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
+
+* --post-commit
+
+ Run in post-commit mode, the same as if called by a [[post-commit]] hook.
+ This is probably only useful when using ikiwiki with a web server on one host
+ and a repository on another, to allow the repository's real post-commit
+ hook to ssh to the web server host and manually run ikiwiki to update
+ the web site.
+
* --version
- Print ikiwiki version number.
+ Print ikiwiki's version number.
# CONFIG OPTIONS
These options configure the wiki. Note that [[plugins]] can add additional
-configuration options of their own.
+configuration options of their own. All of these options and more besides can
+also be configured using a setup file.
-* --wikiname
+* --wikiname name
The name of the wiki, default is "wiki".
-* --templatedir
+* --templatedir dir
+
+ 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 the directory that the page [[templates]] are stored in.
- Default is `/usr/share/ikiwiki/templates`, or another location as
- configured at build time.
+ 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
+* --underlaydir dir
Specify the directory that is used to underlay the source directory.
Source files will be taken from here unless overridden by a file in the
Specify a mode to chmod the wrapper to after creating it.
-* --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.
+ The `source` directory will be assumed to be a working copy, or clone, or
+ whatever the revision control system you select uses.
- 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.
- 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.
-
- svn is enabled by default.
+ 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]].
+ Specify the location of the svn repository for the wiki.
* --svnpath trunk
- Specify the path inside your svn reporistory where the wiki is located.
- This defaults to trunk; change it if your wiki is at some other location
- inside the repository.
+ 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. If your wiki is rooted at the top of the repository,
+ set svnpath to "".
+
+* --rss, --norss
-* --anonok, --noanonok
+ If rss is set, ikiwiki will default to generating RSS feeds for pages
+ that inline a [[blog]].
- If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
+* --allowrss
- By default, anonymous users cannot edit the wiki.
+ If allowrss is set, and rss is not set, ikiwiki will not default to
+ generating RSS feeds, but setting `rss=yes` in the inline directive can
+ override this default and generate a feed.
-* --rss, --norss
+* --atom, --noatom
- If rss is set, ikiwiki will generate rss feeds for pages that inline
- a [[blog]].
+ If atom is set, ikiwiki will default to generating Atom feeds for pages
+ that inline a [[blog]].
-* --pingurl url
+* --allowatom
- 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
+ If allowatom is set, and rss is not set, ikiwiki will not default to
+ generating Atom feeds, but setting `atom=yes` in the inline directive can
+ override this default and generate a feed.
+
+* --pingurl URL
+
+ Set this to the URL of 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 to ping.
-* --url url
+* --url URL
- Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
+ Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
-* --cgiurl http://url/ikiwiki.cgi
+* --cgiurl http://example.org/ikiwiki.cgi
- Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
+ Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
building the wiki for links to the cgi script to be generated.
-* --historyurl url
+* --historyurl URL
- Specifies the url to link to for page history browsing. In the url,
+ Specifies the URL to link to for page history browsing. In the URL,
"\[[file]]" is replaced with the file to browse. It's common to use
- [[ViewCVS]] for this.
+ [[ViewVC]] for this.
-* --adminemail you@yourhost
+* --adminemail you@example.org
Specifies the email address that ikiwiki should use for sending email.
-* --diffurl url
+* --diffurl URL
- Specifies the url to link to for a diff of changes to a page. In the url,
+ 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
revision of the page, and "\[[r2]]" is the new revision. It's common to use
- [[ViewCVS]] for this.
+ [[ViewVC]] for this.
* --exclude regexp
Specifies a rexexp of source files to exclude from processing.
May be specified multiple times to add to exclude list.
+* --include regexp
+
+ Specifies a rexexp of source files, that would normally be excluded,
+ but that you wish to include in processing.
+ May be specified multiple times to add to include list.
+
* --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.
- Note that plugin names are case sensative.
+ Note that plugin names are case sensitive.
* --disable-plugin name
Disables use of a plugin. For example "--disable-plugin htmlscrubber"
- to do away with html sanitization.
+ 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
* --verbose, --no-verbose
- Be vebose about what is being done.
+ Be verbose about what is being done.
* --syslog, --no-syslog
- Log to syslog.
+ Log to syslog(3).
+
+* --usedirs, --no-usedirs
+
+ 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 --prefix-directives.
* --w3mmode, --no-w3mmode
Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
without a web server.
+* --sslcookie
+
+ Only send cookies over an SSL connection. This should prevent them being
+ intercepted. If you enable this option then you must run at least the
+ CGI portion of ikiwiki over SSL.
+
* --getctime
- Pull last changed time for each new page out of the revision control
+ Pull creation 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
+ times of items in weblogs, such as when building a wiki from a new
+ VCS 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 setup file. Since most options commonly used options can be
+ configured using command-line switches, you will rarely need to use this.
+
+* --set-yaml var=value
+
+ This is like --set, but it allows setting configuration variables that
+ use complex data structures, by passing in a YAML document.
+
+# EXAMPLES
+
+* ikiwiki --setup my.setup
+
+ Completly (re)build the wiki using the specified setup file.
+
+* ikiwiki --setup my.setup --refresh
+
+ Refresh the wiki, using settings from my.setup, and avoid
+ rebuilding any pages that have not changed. This is faster.
+
+* ikiwiki --setup my.setup --refresh --wrappers
+
+ Refresh the wiki, including regnerating all wrapper programs,
+ but do not rebuild all pages. Useful if you have changed something
+ in the setup file that does not need a full wiki rebuild to update
+ all pages, but that you want to immediatly take effect.
+
+# ENVIRONMENT
+
+* CC
+
+ This controls what C compiler is used to build wrappers. Default is 'cc'.
+
+* CFLAGS
+
+ This can be used to pass options to the C compiler when building wrappers.
+
+# SEE ALSO
+
+* [[ikiwiki-mass-rebuild]](8)
+* [[ikiwiki-update-wikilist]](1)
+* [[ikiwiki-transition]](1)
+
# AUTHOR
-Joey Hess <joey@kitenet.net>
+Joey Hess <joey@ikiwiki.info>
-Warning: this page is automatically made into ikiwiki's man page, edit with care
+Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=mdwn2man;hb=HEAD). Edit with care