3 ikiwiki - a wiki compiler
7 ikiwiki [options] source destination
9 ikiwiki --setup configfile
13 `ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from
14 `source` in the [[MarkDown]] language (or others), and writes it out to
17 Note that most options can be shortened to single letters, and boolean
18 flags such as --verbose can be negated with --no-verbose.
22 These options control the mode that ikiwiki is operating in.
26 Refresh the wiki, updating any changed pages. This is the default
27 behavior so you don't normally need to specify it.
31 Force a rebuild of all pages.
35 Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
36 supports editing pages, signing in, registration, and displaying
39 To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
40 to generate a wrapper. The wrapper will generally need to run suid 6755 to
41 the user who owns the `source` and `destination` directories.
45 Generate a wrapper binary that is hardcoded to do action specified by
46 the other options, using the specified input files and `destination`
47 directory. The filename to use for the wrapper is optional.
49 The wrapper is designed to be safely made suid and be run by untrusted
50 users, as a [[post-commit]] hook, or as a [[CGI]].
52 Note that the generated wrapper will ignore all command line parameters.
56 In setup mode, ikiwiki reads the config file, which is really a perl
57 program that can call ikiwiki internal functions.
59 [[ikiwiki.setup]] is an example of such a config file.
61 The default action when --setup is specified is to automatically generate
62 wrappers for a wiki based on data in a config file, and rebuild the wiki.
63 If you only want to build any changed pages, you can use --refresh with
68 If used with --setup --refresh, this makes it also update any configured
73 If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
74 configured feeds and save new posts to the srcdir.
76 Note that to rebuild previously aggregated posts, use the --rebuild option
77 along with this one. --rebuild will also force feeds to be polled even if
78 they were polled recently.
82 Renders a single file, outputting the resulting html. Does not save state,
83 so this cannot be used for building whole wikis, but it is useful for
84 previewing an edited file at the command line. Generally used in conjunction
85 with --setup to load in a wiki's setup:
87 ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
91 Print ikiwiki version number.
95 These options configure the wiki. Note that [[plugins]] can add additional
96 configuration options of their own.
100 The name of the wiki, default is "wiki".
104 Specify the directory that the page [[templates]] are stored in. Default
105 is `/usr/share/ikiwiki/templates`, or another location as configured at
106 build time. If the templatedir is changed, missing templates will still
107 be searched for in the default location as a fallback.
111 Specify the directory that is used to underlay the source directory.
112 Source files will be taken from here unless overridden by a file in the
113 source directory. Default is `/usr/share/ikiwiki/basewiki` or another
114 location as configured at build time.
118 Specify a mode to chmod the wrapper to after creating it.
122 Enable email notification of commits. This should be used when running
123 ikiwiki as a [[post-commit]] hook.
125 * --rcs=svn, --no-rcs
127 Enable or disable use of a revision control system.
129 If you use svn, the `source` directory is assumed to be
130 a [[Subversion]] working copy.
132 If you use git, the `source` directory is assumed to be a clone of the
135 If you use tla, the `source` directory is assumed to be a tla import.
137 If you use mercurial, the `source` directory is assumed to be the
138 [[mercurial]] repository.
140 In [[CGI]] mode, with a revision control system enabled pages edited via
141 the web will be committed. Also, the [[RecentChanges]] link will be placed
144 svn is enabled by default.
146 * --svnrepo /svn/wiki
148 Specify the location of the svn repository for the wiki. This is required
149 for using --notify with [[subversion]].
153 Specify the path inside your svn reporistory where the wiki is located.
154 This defaults to trunk; change it if your wiki is at some other location
155 inside the repository.
157 * --anonok, --noanonok
159 If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
161 By default, anonymous users cannot edit the wiki.
165 If rss is set, ikiwiki will generate RSS feeds for pages that inline
170 If atom is set, ikiwiki will generate Arom feeds for pages that inline
175 Set this to the url to an XML-RPC service to ping when an RSS feed is
176 updated. For example, to ping Technorati, use the url
177 http://rpc.technorati.com/rpc/ping
179 This parameter can be specified multiple times to specify more than one
184 Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
186 * --cgiurl http://url/ikiwiki.cgi
188 Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
189 building the wiki for links to the cgi script to be generated.
193 Specifies the url to link to for page history browsing. In the url,
194 "\[[file]]" is replaced with the file to browse. It's common to use
195 [[ViewCVS]] for this.
197 * --adminemail you@yourhost
199 Specifies the email address that ikiwiki should use for sending email.
203 Specifies the url to link to for a diff of changes to a page. In the url,
204 "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
205 revision of the page, and "\[[r2]]" is the new revision. It's common to use
206 [[ViewCVS]] for this.
210 Specifies a rexexp of source files to exclude from processing.
211 May be specified multiple times to add to exclude list.
215 Specifies a username of a user who has the powers of a wiki admin.
216 Currently allows locking of any page, other powers may be added later.
217 May be specified multiple times for multiple admins.
221 Enables the use of the specified [[plugin|plugins]] in the wiki.
222 Note that plugin names are case sensative.
224 * --disable-plugin name
226 Disables use of a plugin. For example "--disable-plugin htmlscrubber"
227 to do away with html sanitization.
229 * --discussion, --no-discussion
231 Enables or disables "Discussion" links from being added to the header of
232 every page. The links are enabled by default.
236 Optionally, allows links to users of the wiki to link to pages inside a
237 subdirectory of the wiki. The default is to link to pages in the toplevel
238 directory of the wiki.
240 * --timeformat format
242 Specify how to display the time or date. The format string is passed to the
243 strftime(3) function.
245 * --verbose, --no-verbose
247 Be verbose about what is being done.
249 * --syslog, --no-syslog
253 * --w3mmode, --no-w3mmode
255 Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
256 without a web server.
260 Only send cookies over an SSL connection. This should prevent them being
261 intercepted. If you enable this option then you must run at least the
262 CGI portion of ikiwiki over SSL.
266 Pull last changed time for each new page out of the revision control
267 system. This rarely used option provides a way to get the real creation
268 times of items in weblogs, for example when building a wiki from a new
269 subversion checkout. It is unoptimised and quite slow. It is best used
270 with --rebuild, to force ikiwiki to get the ctime for all pages.
274 Joey Hess <joey@kitenet.net>
276 Warning: this page is automatically made into ikiwiki's man page, edit with care
projects / ikiwiki / blob