]> sipb.mit.edu Git - ikiwiki.git/blob - doc/usage.mdwn
e25989a49033f807bc4e069d5976dcbe81c0e0c9
[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 configfile
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 configfile
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 config 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 configfile
44
45   Causes ikiwiki to write to the specified config 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.
107
108 * --wikiname
109
110   The name of the wiki, default is "wiki".
111
112 * --templatedir
113
114   Specify the directory that the page [[templates|wikitemplates]] are stored in.
115   Default is `/usr/share/ikiwiki/templates`, or another location as configured at
116   build time. If the templatedir is changed, missing templates will still
117   be searched for in the default location as a fallback.
118
119   Note that if you choose to copy and modify ikiwiki's templates, you will need
120   to be careful to keep them up to date when upgrading to new versions of
121   ikiwiki. Old versions of templates do not always work with new ikiwiki
122   versions.
123
124 * --underlaydir
125
126   Specify the directory that is used to underlay the source directory.
127   Source files will be taken from here unless overridden by a file in the
128   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
129   location as configured at build time.
130
131 * --wrappermode mode
132
133   Specify a mode to chmod the wrapper to after creating it.
134
135 * --wrappergroup group
136
137   Specify what unix group the wrapper should be owned by. This can be
138   useful if the wrapper needs to be owned by a group other than the default.
139   For example, if a project has a repository with multiple committers with
140   access controlled by a group, it makes sense for the ikiwiki wrappers
141   to run setgid to that group.
142
143 * --rcs=svn|git|.., --no-rcs
144
145   Enable or disable use of a [[revision_control_system|rcs]].
146
147   The `source` directory will be assumed to be a working copy, or clone, or
148   whatever the revision control system you select uses.
149
150   In [[CGI]] mode, with a revision control system enabled, pages edited via
151   the web will be committed.
152
153   No revision control is enabled by default.
154
155 * --svnrepo /svn/wiki
156
157   Specify the location of the svn repository for the wiki.
158
159 * --svnpath trunk
160
161   Specify the path inside your svn repository where the wiki is located.
162   This defaults to `trunk`; change it if your wiki is at some other path
163   inside the repository. If your wiki is rooted at the top of the repository,
164   set svnpath to "".
165
166 * --rss, --norss
167
168   If rss is set, ikiwiki will default to generating RSS feeds for pages
169   that inline a [[ikiwiki/blog]].
170
171 * --allowrss
172
173   If allowrss is set, and rss is not set, ikiwiki will not default to
174   generating RSS feeds, but setting `rss=yes` in the blog can override
175   this default and generate a feed.
176
177 * --atom, --noatom
178
179   If atom is set, ikiwiki will default to generating Atom feeds for pages
180   that inline a [[ikiwiki/blog]].
181
182 * --allowatom
183
184   If allowatom is set, and rss is not set, ikiwiki will not default to
185   generating Atom feeds, but setting `atom=yes` in the blog can override
186   this default and generate a feed.
187
188 * --pingurl URL
189
190   Set this to the URL of an XML-RPC service to ping when an RSS feed is
191   updated. For example, to ping Technorati, use the URL
192   http://rpc.technorati.com/rpc/ping
193
194   This parameter can be specified multiple times to specify more than one
195   URL to ping.
196
197 * --url URL
198
199   Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
200
201 * --cgiurl http://example.org/ikiwiki.cgi
202
203   Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
204   building the wiki for links to the cgi script to be generated.
205
206 * --historyurl URL
207
208   Specifies the URL to link to for page history browsing. In the URL,
209   "\[[file]]" is replaced with the file to browse. It's common to use
210   [[ViewVC]] for this.
211
212 * --adminemail you@example.org
213
214   Specifies the email address that ikiwiki should use for sending email.
215
216 * --diffurl URL
217
218   Specifies the URL to link to for a diff of changes to a page. In the URL,
219   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
220   revision of the page, and "\[[r2]]" is the new revision. It's common to use
221   [[ViewVC]] for this.
222
223 * --exclude regexp
224
225   Specifies a rexexp of source files to exclude from processing.
226   May be specified multiple times to add to exclude list.
227
228 * --adminuser name
229
230   Specifies a username of a user (or, if openid is enabled, an openid) 
231   who has the powers of a wiki admin. Currently allows locking of any page,
232   and [[banning|banned_users]] users; other powers may be added later.
233   May be specified multiple times for multiple admins.
234
235   For an openid user specify the full URL of the login, including "http://".
236
237 * --plugin name
238
239   Enables the use of the specified [[plugin|plugins]] in the wiki. 
240   Note that plugin names are case sensitive.
241
242 * --disable-plugin name
243
244   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
245   to do away with HTML sanitization.
246
247 * --libdir directory
248
249   Makes ikiwiki look in the specified directory first, before the regular
250   locations when loading library files and plugins. For example, if you set
251   libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as
252   "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm".
253
254 * --discussion, --no-discussion
255
256   Enables or disables "Discussion" links from being added to the header of
257   every page. The links are enabled by default.
258
259 * --numbacklinks n
260
261   Controls how many backlinks should be displayed at the bottom of a page.
262   Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to
263   disable this feature.
264
265 * --userdir subdir
266
267   Optionally, allows links to users of the wiki to link to pages inside a
268   subdirectory of the wiki. The default is to link to pages in the toplevel
269   directory of the wiki.
270
271 * --htmlext html
272
273   Configures the extension used for generated html files. Default is "html".
274
275 * --timeformat format
276
277   Specify how to display the time or date. The format string is passed to the
278   strftime(3) function.
279
280 * --verbose, --no-verbose
281
282   Be verbose about what is being done.
283
284 * --syslog, --no-syslog
285
286   Log to syslog(3).
287
288 * --usedirs, --no-usedirs
289
290   Toggle creating output files named page/index.html (default) instead of page.html.
291
292 * --prefix-directives, --no-prefix-directives
293
294   Toggle new '!'-prefixed syntax for preprocessor directives.  ikiwiki currently
295   defaults to --no-prefix-directives.
296
297 * --w3mmode, --no-w3mmode
298
299   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
300   without a web server.
301
302 * --sslcookie
303
304   Only send cookies over an SSL connection. This should prevent them being
305   intercepted. If you enable this option then you must run at least the 
306   CGI portion of ikiwiki over SSL.
307
308 * --getctime
309
310   Pull last changed time for each new page out of the revision control
311   system. This rarely used option provides a way to get the real creation
312   times of items in weblogs, such as when building a wiki from a new
313   Subversion checkout. It is unoptimised and quite slow. It is best used
314   with --rebuild, to force ikiwiki to get the ctime for all pages.
315
316 * --set var=value
317   
318   This allows setting an arbitrary configuration variable, the same as if it
319   were set via a configuration file. Since most options can be configured
320   using command-line switches, you will rarely need to use this, but it can be
321   useful for the odd option that lacks a command-line switch.
322
323 # ENVIRONMENT
324
325 * CC
326
327   This controls what C compiler is used to build wrappers. Default is 'cc'.
328
329 # SEE ALSO
330
331 * [[ikiwiki-mass-rebuild]](8)
332 * [[ikiwiki-update-wikilist]](1)
333 * [[ikiwiki-transition]](1)
334
335 # AUTHOR
336
337 Joey Hess <joey@ikiwiki.info>
338
339 Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://ikiwiki.info/cgi-bin/viewvc.cgi/trunk/mdwn2man?root=ikiwiki&view=markup).  Edit with care