* --refresh
Refresh the wiki, updating any changed pages. This is the default
- behavior so you don't normally need to specify it. If used with -setup also
- updates any configured wrappers.
+ behavior so you don't normally need to specify it.
* --rebuild
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 also pass the --refresh option, ikiwiki will instead just refresh
- the wiki described in the setup file.
+ If you only want to build any changed pages, you can use --refresh with
+ --setup.
- [[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
+ configured feeds and save new posts to the srcdir.
+
+ Note that to rebuild previously aggregated posts, use the --rebuild option
+ 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
+
+* --version
+
+ Print ikiwiki version number.
# CONFIG OPTIONS
-These options configure the wiki.
+These options configure the wiki. Note that [[plugins]] can add additional
+configuration options of their own.
* --wikiname
* --templatedir
- Specify the directory that the page [[templates]] are stored in.
- Default is `/usr/share/ikiwiki/templates`.
+ Specify the directory that the page [[templates]] 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.
* --underlaydir
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
- source directory. Default is `/usr/share/ikiwiki/basewiki`.
+ source directory. Default is `/usr/share/ikiwiki/basewiki` or another
+ location as configured at build time.
* --wrappermode mode
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.
+
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
This defaults to trunk; change it if your wiki is at some other location
inside the repository.
-* --anonok, --noanonok
-
- If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
+* --rss, --norss
- By default, anonymous users cannot edit the wiki.
+ If rss is set, ikiwiki will generate RSS feeds for pages that inline
+ a [[blog]].
-* --rss, --norss
+* --atom, --noatom
- If rss is set, ikiwiki will generate rss feeds for pages that inline
+ If atom is set, ikiwiki will generate Arom feeds for pages that inline
a [[blog]].
* --pingurl url
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
+* --historyurl 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
Specifies the email address that ikiwiki should use for sending email.
-* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+* --diffurl 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
Enables or disables "Discussion" links from being added to the header of
every page. The links are enabled by default.
+* --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.
+
* --timeformat format
Specify how to display the time or date. The format string is passed to the
strftime(3) function.
-* --verbose
+* --verbose, --no-verbose
+
+ Be verbose about what is being done.
- Be vebose about what is being done.
+* --syslog, --no-syslog
+
+ Log to syslog.
* --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