]> sipb.mit.edu Git - ikiwiki.git/blob - doc/usage.mdwn
Merge branch 'master' of ssh://git.ikiwiki.info/srv/git/ikiwiki.info
[ikiwiki.git] / doc / usage.mdwn
1 # NAME
2
3 ikiwiki - a wiki compiler
4
5 # SYNOPSIS
6
7 ikiwiki [options] source destination
8
9 ikiwiki --setup setupfile
10
11 # DESCRIPTION
12
13 `ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
14 `source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to
15 `destination`.
16
17 Note that most options can be shortened to single letters, and boolean
18 flags such as --verbose can be negated with --no-verbose.
19
20 # MODE OPTIONS
21
22 These options control the mode that ikiwiki operates in.
23
24 * --refresh
25
26   Refresh the wiki, updating any changed pages. This is the default
27   behavior so you don't normally need to specify it.
28
29 * --rebuild
30
31   Force a rebuild of all pages.
32
33 * --setup setupfile
34
35   In setup mode, ikiwiki reads the config file, which is really a perl
36   program that can call ikiwiki internal functions.
37
38   The default action when --setup is specified is to automatically generate
39   wrappers for a wiki based on data in a setup file, and rebuild the wiki.
40   If you only want to build any changed pages, you can use --refresh with
41   --setup.
42
43 * --dumpsetup setupfile
44
45   Causes ikiwiki to write to the specified setup file, dumping out
46   its current configuration.
47
48 * --wrappers
49
50   If used with --setup --refresh, this makes it also update any configured
51   wrappers.
52
53 * --cgi
54
55   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
56   supports editing pages, signing in, and registration.
57
58   To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
59   to generate a wrapper. The wrapper will generally need to run suid 6755 to
60   the user who owns the `source` and `destination` directories.
61
62 * --wrapper [file]
63
64   Generate a wrapper binary that is hardcoded to do action specified by
65   the other options, using the specified input files and `destination`
66   directory. The filename to use for the wrapper is optional.
67
68   The wrapper is designed to be safely made suid and be run by untrusted
69   users, as a [[post-commit]] hook, or as a [[CGI]].
70
71   Note that the generated wrapper will ignore all command line parameters.
72
73 * --aggregate
74
75   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
76   configured feeds and save new posts to the srcdir.
77
78   Note that to rebuild previously aggregated posts, use the --rebuild option
79   along with this one. --rebuild will also force feeds to be polled even if
80   they were polled recently.
81
82 * --render file
83
84   Renders a single file, outputting the resulting html. Does not save state,
85   so this cannot be used for building whole wikis, but it is useful for
86   previewing an edited file at the command line. Generally used in conjunction
87   with --setup to load in a wiki's setup:
88
89         ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
90
91 * --post-commit
92
93   Run in post-commit mode, the same as if called by a [[post-commit]] hook.
94   This is probably only useful when using ikiwiki with a web server on one host
95   and a repository on another, to allow the repository's real post-commit
96   hook to ssh to the web server host and manually run ikiwiki to update
97   the web site.
98
99 * --version
100
101   Print ikiwiki's version number.
102
103 # CONFIG OPTIONS
104
105 These options configure the wiki. Note that [[plugins]] can add additional
106 configuration options of their own. All of these options and more besides can
107 also be configured using a setup file.
108
109 * --wikiname
110
111   The name of the wiki, default is "wiki".
112
113 * --templatedir
114
115   Specify the directory that the page [[templates|wikitemplates]] are stored in.
116   Default is `/usr/share/ikiwiki/templates`, or another location as configured at
117   build time. If the templatedir is changed, missing templates will still
118   be searched for in the default location as a fallback.
119
120   Note that if you choose to copy and modify ikiwiki's templates, you will need
121   to be careful to keep them up to date when upgrading to new versions of
122   ikiwiki. Old versions of templates do not always work with new ikiwiki
123   versions.
124
125 * --underlaydir
126
127   Specify the directory that is used to underlay the source directory.
128   Source files will be taken from here unless overridden by a file in the
129   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
130   location as configured at build time.
131
132 * --wrappermode mode
133
134   Specify a mode to chmod the wrapper to after creating it.
135
136 * --wrappergroup group
137
138   Specify what unix group the wrapper should be owned by. This can be
139   useful if the wrapper needs to be owned by a group other than the default.
140   For example, if a project has a repository with multiple committers with
141   access controlled by a group, it makes sense for the ikiwiki wrappers
142   to run setgid to that group.
143
144 * --rcs=svn|git|.., --no-rcs
145
146   Enable or disable use of a [[revision_control_system|rcs]].
147
148   The `source` directory will be assumed to be a working copy, or clone, or
149   whatever the revision control system you select uses.
150
151   In [[CGI]] mode, with a revision control system enabled, pages edited via
152   the web will be committed.
153
154   No revision control is enabled by default.
155
156 * --svnrepo /svn/wiki
157
158   Specify the location of the svn repository for the wiki.
159
160 * --svnpath trunk
161
162   Specify the path inside your svn repository where the wiki is located.
163   This defaults to `trunk`; change it if your wiki is at some other path
164   inside the repository. If your wiki is rooted at the top of the repository,
165   set svnpath to "".
166
167 * --rss, --norss
168
169   If rss is set, ikiwiki will default to generating RSS feeds for pages
170   that inline a [[blog]].
171
172 * --allowrss
173
174   If allowrss is set, and rss is not set, ikiwiki will not default to
175   generating RSS feeds, but setting `rss=yes` in the inline directive can
176   override this default and generate a feed.
177
178 * --atom, --noatom
179
180   If atom is set, ikiwiki will default to generating Atom feeds for pages
181   that inline a [[blog]].
182
183 * --allowatom
184
185   If allowatom is set, and rss is not set, ikiwiki will not default to
186   generating Atom feeds, but setting `atom=yes` in the inline directive can
187   override this default and generate a feed.
188
189 * --pingurl URL
190
191   Set this to the URL of an XML-RPC service to ping when an RSS feed is
192   updated. For example, to ping Technorati, use the URL
193   http://rpc.technorati.com/rpc/ping
194
195   This parameter can be specified multiple times to specify more than one
196   URL to ping.
197
198 * --url URL
199
200   Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
201
202 * --cgiurl http://example.org/ikiwiki.cgi
203
204   Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
205   building the wiki for links to the cgi script to be generated.
206
207 * --historyurl URL
208
209   Specifies the URL to link to for page history browsing. In the URL,
210   "\[[file]]" is replaced with the file to browse. It's common to use
211   [[ViewVC]] for this.
212
213 * --adminemail you@example.org
214
215   Specifies the email address that ikiwiki should use for sending email.
216
217 * --diffurl URL
218
219   Specifies the URL to link to for a diff of changes to a page. In the URL,
220   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
221   revision of the page, and "\[[r2]]" is the new revision. It's common to use
222   [[ViewVC]] for this.
223
224 * --exclude regexp
225
226   Specifies a rexexp of source files to exclude from processing.
227   May be specified multiple times to add to exclude list.
228
229 * --adminuser name
230
231   Specifies a username of a user (or, if openid is enabled, an openid) 
232   who has the powers of a wiki admin. Currently allows locking of any page,
233   and [[banning|banned_users]] users; other powers may be added later.
234   May be specified multiple times for multiple admins.
235
236   For an openid user specify the full URL of the login, including "http://".
237
238 * --plugin name
239
240   Enables the use of the specified [[plugin|plugins]] in the wiki. 
241   Note that plugin names are case sensitive.
242
243 * --disable-plugin name
244
245   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
246   to do away with HTML sanitization.
247
248 * --libdir directory
249
250   Makes ikiwiki look in the specified directory first, before the regular
251   locations when loading library files and plugins. For example, if you set
252   libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as
253   "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm".
254
255 * --discussion, --no-discussion
256
257   Enables or disables "Discussion" links from being added to the header of
258   every page. The links are enabled by default.
259
260 * --numbacklinks n
261
262   Controls how many backlinks should be displayed at the bottom of a page.
263   Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to
264   disable this feature.
265
266 * --userdir subdir
267
268   Optionally, allows links to users of the wiki to link to pages inside a
269   subdirectory of the wiki. The default is to link to pages in the toplevel
270   directory of the wiki.
271
272 * --htmlext html
273
274   Configures the extension used for generated html files. Default is "html".
275
276 * --timeformat format
277
278   Specify how to display the time or date. The format string is passed to the
279   strftime(3) function.
280
281 * --verbose, --no-verbose
282
283   Be verbose about what is being done.
284
285 * --syslog, --no-syslog
286
287   Log to syslog(3).
288
289 * --usedirs, --no-usedirs
290
291   Toggle creating output files named page/index.html (default) instead of page.html.
292
293 * --prefix-directives, --no-prefix-directives
294
295   Toggle new '!'-prefixed syntax for preprocessor directives.  ikiwiki currently
296   defaults to --no-prefix-directives.
297
298 * --w3mmode, --no-w3mmode
299
300   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
301   without a web server.
302
303 * --sslcookie
304
305   Only send cookies over an SSL connection. This should prevent them being
306   intercepted. If you enable this option then you must run at least the 
307   CGI portion of ikiwiki over SSL.
308
309 * --getctime
310
311   Pull last changed time for each new page out of the revision control
312   system. This rarely used option provides a way to get the real creation
313   times of items in weblogs, such as when building a wiki from a new
314   Subversion checkout. It is unoptimised and quite slow. It is best used
315   with --rebuild, to force ikiwiki to get the ctime for all pages.
316
317 * --set var=value
318   
319   This allows setting an arbitrary configuration variable, the same as if it
320   were set via a setup file. Since most options can be configured
321   using command-line switches, you will rarely need to use this, but it can be
322   useful for the odd option that lacks a command-line switch.
323
324 # EXAMPLES
325
326 * ikiwiki --setup my.setup
327
328   Completly (re)build the wiki using the specified setup file.
329
330 * ikiwiki --setup my.setup --refresh
331
332   Refresh the wiki, using settings from my.setup, and avoid
333   rebuilding any pages that have not changed. This is faster.
334
335 * ikiwiki --setup my.setup --refresh --wrappers
336
337   Refresh the wiki, including regnerating all wrapper programs,
338   but do not rebuild all pages. Useful if you have changed something
339   in the setup file that does not need a full wiki rebuild to update
340   all pages, but that you want to immediatly take effect.
341
342 # ENVIRONMENT
343
344 * CC
345
346   This controls what C compiler is used to build wrappers. Default is 'cc'.
347
348 # SEE ALSO
349
350 * [[ikiwiki-mass-rebuild]](8)
351 * [[ikiwiki-update-wikilist]](1)
352 * [[ikiwiki-transition]](1)
353
354 # AUTHOR
355
356 Joey Hess <joey@ikiwiki.info>
357
358 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