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. If used with -setup also
28 updates any configured wrappers.
32 Force a rebuild of all pages.
36 Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
37 supports editing pages, signing in, registration, and displaying
40 To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
41 to generate a wrapper. The wrapper will generally need to run suid 6755 to
42 the user who owns the `source` and `destination` directories.
46 Generate a wrapper binary that is hardcoded to do action specified by
47 the other options, using the specified input files and `destination`
48 directory. The filename to use for the wrapper is optional.
50 The wrapper is designed to be safely made suid and be run by untrusted
51 users, as a [[post-commit]] hook, or as a [[CGI]].
53 Note that the generated wrapper will ignore all command line parameters.
57 In setup mode, ikiwiki reads the config file, which is really a perl
58 program that can call ikiwiki internal functions.
60 The default action when --setup is specified is to automatically generate
61 wrappers for a wiki based on data in a config file, and rebuild the wiki.
62 If you also pass the --refresh option, ikiwiki will instead just refresh
63 the wiki described in the setup file.
65 [[ikiwiki.setup]] is an example of such a config file.
69 These options configure the wiki.
73 The name of the wiki, default is "wiki".
77 Specify the directory that the page [[templates]] are stored in.
78 Default is `/usr/share/ikiwiki/templates`.
82 Specify the directory that is used to underlay the source directory.
83 Source files will be taken from here unless overridden by a file in the
84 source directory. Default is `/usr/share/ikiwiki/basewiki`.
88 Specify a mode to chmod the wrapper to after creating it.
92 Enable email notification of commits. This should be used when running
93 ikiwiki as a [[post-commit]] hook.
97 Enable or disable use of a revision control system.
99 If you use svn, the `source` directory is assumed to be
100 a [[Subversion]] working copy.
102 If you use git, the `source` directory is assumed to be a clone of the
105 In [[CGI]] mode, with a revision control system enabled pages edited via
106 the web will be committed. Also, the [[RecentChanges]] link will be placed
109 svn is enabled by default.
111 * --svnrepo /svn/wiki
113 Specify the location of the svn repository for the wiki. This is required
114 for using --notify with [[subversion]].
118 Specify the path inside your svn reporistory where the wiki is located.
119 This defaults to trunk; change it if your wiki is at some other location
120 inside the repository.
122 * --anonok, --noanonok
124 If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
126 By default, anonymous users cannot edit the wiki.
130 If rss is set, ikiwiki will generate rss feeds for pages that inline
135 Set this to the url to an XML-RPC service to ping when an RSS feed is
136 updated. For example, to ping Technorati, use the url
137 http://rpc.technorati.com/rpc/ping
139 This parameter can be specified multiple times to specify more than one
144 Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
146 * --cgiurl http://url/ikiwiki.cgi
148 Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
149 building the wiki for links to the cgi script to be generated.
151 * --historyurl http://url/trunk/\[[file]]?root=wiki
153 Specifies the url to link to for page history browsing. In the url,
154 "\[[file]]" is replaced with the file to browse. It's common to use
155 [[ViewCVS]] for this.
157 * --adminemail you@yourhost
159 Specifies the email address that ikiwiki should use for sending email.
161 * --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
163 Specifies the url to link to for a diff of changes to a page. In the url,
164 "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
165 revision of the page, and "\[[r2]]" is the new revision. It's common to use
166 [[ViewCVS]] for this.
170 Specifies a rexexp of source files to exclude from processing.
171 May be specified multiple times to add to exclude list.
175 Specifies a username of a user who has the powers of a wiki admin.
176 Currently allows locking of any page, other powers may be added later.
177 May be specified multiple times for multiple admins.
181 Enables the use of the specified [[plugin|plugins]] in the wiki.
182 Note that plugin names are case sensative.
184 * --disable-plugin name
186 Disables use of a plugin. For example "--disable-plugin htmlscrubber"
187 to do away with html sanitization.
189 * --discussion, --no-discussion
191 Enables or disables "Discussion" links from being added to the header of
192 every page. The links are enabled by default.
194 * --timeformat format
196 Specify how to display the time or date. The format string is passed to the
197 strftime(3) function.
201 Be vebose about what is being done.
205 Pull last changed time for each new page out of the revision control
206 system. This rarely used option provides a way to get the real creation
207 times of items in weblogs, for example when building a wiki from a new
208 subversion checkout. It is unoptimised and quite slow. It is best used
209 with --rebuild, to force ikiwiki to get the ctime for all pages.
213 Joey Hess <joey@kitenet.net>
215 Warning: this page is automatically made into ikiwiki's man page, edit with care