1ikiwiki(1) General Commands Manual ikiwiki(1)
2
6 ikiwiki - a wiki compiler
7
9 ikiwiki [options] source destination
10 ikiwiki --setup setupfile
12
14 ikiwiki is a wiki compiler. It builds static HTML pages for a wiki,
15 from source in the ikiwiki/Markdown language (or others), and writes it
16 out to destination.
17 Note that most options can be shortened to single letters, and boolean
19 flags such as --verbose can be negated with --no-verbose.
20
22 These options control the mode that ikiwiki operates in.
23 --refresh
25 Refresh the wiki, updating any changed pages. This is the
26 default behavior so you don't normally need to specify it.
27 --rebuild
29 Force a rebuild of all pages.
30 --setup setupfile
32 The default action when --setup is specified is to automatically
33 generate wrappers for a wiki based on data in a setup file, and
34 rebuild the wiki. If you only want to build any changed pages,
35 you can use --refresh with --setup.
36 --changesetup setupfile
38 Reads the setup file, adds any configuration changes specified
39 by other options, and writes the new configuration back to the
40 setup file. Also updates any configured wrappers. In this mode,
41 the wiki is not fully rebuilt, unless you also add --rebuild.
42 Example, to enable some plugins:
44 ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff
46 --plugin calendar
47 --dumpsetup setupfile
49 Causes ikiwiki to write to the specified setup file, dumping out
50 its current configuration.
51 --wrappers
53 If used with --setup --refresh, this makes it also update any
54 configured wrappers.
55 --clean
57 This makes ikiwiki clean up by removing any files it generated
58 in the destination directory, as well as any configured wrap‐
59 pers, and the .ikiwiki state directory. This is mostly useful if
60 you're running ikiwiki in a Makefile to build documentation and
61 want a corresponding clean target.
62 --cgi Enable CGI mode. In cgi mode ikiwiki runs as a cgi script, and
64 supports editing pages, signing in, and registration.
65 To use ikiwiki as a CGI program you need to use --wrapper or
67 --setup to generate a wrapper. The wrapper will generally need
68 to run suid 6755 to the user who owns the source and destination
69 directories.
70 --wrapper [file]
72 Generate a wrapper binary that is hardcoded to do action speci‐
73 fied by the other options, using the specified input files and
74 destination directory. The filename to use for the wrapper is
75 optional.
76 The wrapper is designed to be safely made suid and be run by
78 untrusted users, as a post-commit hook, or as a CGI.
79 Note that the generated wrapper will ignore all command line
81 parameters.
82 --aggregate
84 If the plugins/aggregate plugin is enabled, this makes ikiwiki
85 poll configured feeds and save new posts to the srcdir.
86 Note that to rebuild previously aggregated posts, use the
88 --rebuild option along with this one. --rebuild will also force
89 feeds to be polled even if they were polled recently.
90 --render file
92 Renders a single file, outputting the resulting html. Does not
93 save state, so this cannot be used for building whole wikis, but
94 it is useful for previewing an edited file at the command line.
95 Generally used in conjunction with --setup to load in a wiki's
96 setup:
97 ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
99 --post-commit
101 Run in post-commit mode, the same as if called by a post-commit
102 hook. This is probably only useful when using ikiwiki with a
103 web server on one host and a repository on another, to allow the
104 repository's real post-commit hook to ssh to the web server host
105 and manually run ikiwiki to update the web site.
106 --version
108 Print ikiwiki's version number.
109
111 These options configure the wiki. Note that plugins can add additional
112 configuration options of their own. All of these options and more
113 besides can also be configured using a setup file.
114 --wikiname name
116 The name of the wiki, default is "wiki".
117 --templatedir dir
119 Specify the directory that templates are stored in. Default is
120 /usr/share/ikiwiki/templates, or another location as configured
121 at build time. If the templatedir is changed, missing templates
122 will still be searched for in the default location as a fall‐
123 back. Templates can also be placed in the "templates/" subdirec‐
124 tory of the srcdir.
125 Note that if you choose to copy and modify ikiwiki's templates,
127 you will need to be careful to keep them up to date when upgrad‐
128 ing to new versions of ikiwiki. Old versions of templates do not
129 always work with new ikiwiki versions.
130 --underlaydir dir
132 Specify the directory that is used to underlay the source direc‐
133 tory. Source files will be taken from here unless overridden by
134 a file in the source directory. Default is /usr/share/iki‐
135 wiki/basewiki or another location as configured at build time.
136 --wrappermode mode
138 Specify a mode to chmod the wrapper to after creating it.
139 --wrappergroup group
141 Specify what unix group the wrapper should be owned by. This can
142 be useful if the wrapper needs to be owned by a group other than
143 the default. For example, if a project has a repository with
144 multiple committers with access controlled by a group, it makes
145 sense for the ikiwiki wrappers to run setgid to that group.
146 --rcs=svn|git|.., --no-rcs
148 Enable or disable use of a revision_control_system.
149 The source directory will be assumed to be a working copy, or
151 clone, or whatever the revision control system you select uses.
152 In CGI mode, with a revision control system enabled, pages
154 edited via the web will be committed.
155 No revision control is enabled by default.
157 --svnrepo /svn/wiki
159 Specify the location of the svn repository for the wiki.
160 --svnpath trunk
162 Specify the path inside your svn repository where the wiki is
163 located. This defaults to trunk; change it if your wiki is at
164 some other path inside the repository. If your wiki is rooted at
165 the top of the repository, set svnpath to "".
166 --rss, --norss
168 If rss is set, ikiwiki will default to generating RSS feeds for
169 pages that inline a blog.
170 --allowrss
172 If allowrss is set, and rss is not set, ikiwiki will not default
173 to generating RSS feeds, but setting rss=yes in the inline
174 directive can override this default and generate a feed.
175 --atom, --noatom
177 If atom is set, ikiwiki will default to generating Atom feeds
178 for pages that inline a blog.
179 --allowatom
181 If allowatom is set, and rss is not set, ikiwiki will not
182 default to generating Atom feeds, but setting atom=yes in the
183 inline directive can override this default and generate a feed.
184 --pingurl URL
186 Set this to the URL of an XML-RPC service to ping when an RSS
187 feed is updated. For example, to ping Technorati, use the URL
188 http://rpc.technorati.com/rpc/ping
189 This parameter can be specified multiple times to specify more
191 than one URL to ping.
192 --url URL
194 Specifies the URL to the wiki. This is a required parameter in
195 CGI mode.
196 --cgiurl http://example.org/ikiwiki.cgi
198 Specifies the URL to the ikiwiki CGI script wrapper. Required
199 when building the wiki for links to the cgi script to be gener‐
200 ated.
201 --historyurl URL
203 Specifies the URL to link to for page history browsing. In the
204 URL, "[[file]]" is replaced with the file to browse. It's common
205 to use ViewVC for this.
206 --adminemail you@example.org
208 Specifies the email address that ikiwiki should use for sending
209 email.
210 --diffurl URL
212 Specifies the URL to link to for a diff of changes to a page. In
213 the URL, "[[file]]" is replaced with the file to browse,
214 "[[r1]]" is the old revision of the page, and "[[r2]]" is the
215 new revision. It's common to use ViewVC for this.
216 --exclude regexp
218 Specifies a rexexp of source files to exclude from processing.
219 May be specified multiple times to add to exclude list.
220 --include regexp
222 Specifies a rexexp of source files, that would normally be
223 excluded, but that you wish to include in processing. May be
224 specified multiple times to add to include list.
225 --adminuser name
227 Specifies a username of a user (or, if openid is enabled, an
228 openid) who has the powers of a wiki admin. Currently allows
229 locking of any page, and banning users; other powers may be
230 added later. May be specified multiple times for multiple
231 admins.
232 For an openid user specify the full URL of the login, including
234 "http://".
235 --plugin name
237 Enables the use of the specified plugin in the wiki. Note that
238 plugin names are case sensitive.
239 --disable-plugin name
241 Disables use of a plugin. For example "--disable-plugin
242 htmlscrubber" to do away with HTML sanitization.
243 --libdir directory
245 Makes ikiwiki look in the specified directory first, before the
246 regular locations when loading library files and plugins. For
247 example, if you set libdir to "/home/you/.ikiwiki/", you can
248 install a foo.pm plugin as "/home/you/.ikiwiki/IkiWiki/Plug‐
249 in/foo.pm".
250 --discussion, --no-discussion
252 Enables or disables "Discussion" links from being added to the
253 header of every page. The links are enabled by default.
254 --numbacklinks n
256 Controls how many backlinks should be displayed at the bottom of
257 a page. Excess backlinks will be hidden in a popup. Default is
258 10. Set to 0 to disable this feature.
259 --userdir subdir
261 Optionally, allows links to users of the wiki to link to pages
262 inside a subdirectory of the wiki. The default is to link to
263 pages in the toplevel directory of the wiki.
264 --htmlext html
266 Configures the extension used for generated html files. Default
267 is "html".
268 --timeformat format
270 Specify how to display the time or date. The format string is
271 passed to the strftime(3) function.
272 --verbose, --no-verbose
274 Be verbose about what is being done.
275 --syslog, --no-syslog
277 Log to syslog(3).
278 --usedirs, --no-usedirs
280 Toggle creating output files named page/index.html (default)
281 instead of page.html.
282 --prefix-directives, --no-prefix-directives
284 Toggle new '!'-prefixed syntax for preprocessor directives.
285 ikiwiki currently defaults to --prefix-directives.
286 --w3mmode, --no-w3mmode
288 Enable w3mmode, which allows w3m to use ikiwiki as a local CGI
289 script, without a web server.
290 --sslcookie
292 Only send cookies over an SSL connection. This should prevent
293 them being intercepted. If you enable this option then you must
294 run at least the CGI portion of ikiwiki over SSL.
295 --gettime, --no-gettime
297 Extract creation and modification times for each new page from
298 the the revision control's log. This is done automatically when
299 building a wiki for the first time, so you normally do not need
300 to use this option.
301 --set var=value
303 This allows setting an arbitrary configuration variable, the
304 same as if it were set via a setup file. Since most commonly
305 used options can be configured using command-line switches, you
306 will rarely need to use this.
307 --set-yaml var=value
309 This is like --set, but it allows setting configuration vari‐
310 ables that use complex data structures, by passing in a YAML
311 document.
312
314 ikiwiki --setup my.setup
315 Completely (re)build the wiki using the specified setup file.
317 ikiwiki --setup my.setup --refresh
319 Refresh the wiki, using settings from my.setup, and avoid
320 rebuilding any pages that have not changed. This is faster.
321 ikiwiki --setup my.setup --refresh --wrappers
323 Refresh the wiki, including regnerating all wrapper programs,
324 but do not rebuild all pages. Useful if you have changed some‐
325 thing in the setup file that does not need a full wiki rebuild
326 to update all pages, but that you want to immediatly take
327 effect.
328
330 CC
331 This controls what C compiler is used to build wrappers. Default
333 is 'cc'.
334 CFLAGS This can be used to pass options to the C compiler when building
336 wrappers.
337
339 ikiwiki-mass-rebuild(8)
340 ikiwiki-update-wikilist(1)
342 ikiwiki-transition(1)
344
346 Joey Hess <joey@ikiwiki.info>
347 ikiwiki(1)