9e260adc29ceeec7a06a8ce957b1bb2c506e598b
[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 [[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 is operating 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 * --cgi
34
35   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
36   supports editing pages, signing in, registration, and displaying
37   [[RecentChanges]].
38
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.
42
43 * --wrapper [file]
44
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.
48
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]].
51
52   Note that the generated wrapper will ignore all command line parameters.
53
54 * --setup configfile
55
56   In setup mode, ikiwiki reads the config file, which is really a perl
57   program that can call ikiwiki internal functions.
58
59   The default action when --setup is specified is to automatically generate
60   wrappers for a wiki based on data in a config file, and rebuild the wiki.
61
62   [[ikiwiki.setup]] is an example of such a config file.
63
64 * --wrappers
65
66   If used with --setup --refresh, this makes it also update any configured
67   wrappers.
68
69 * --aggregate
70
71   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
72   configured feeds and save new posts to the srcdir.
73
74   Note that to rebuild previously aggregated posts, use the --rebuild option
75   along with this one. --rebuild will also force feeds to be polled even if
76   they were polled recently.
77
78 * --render file
79
80   Renders a single file, outputting the resulting html. Does not save state,
81   so this cannot be used for building whole wikis, but it is useful for
82   previewing an edited file at the command line. Generally used in conjunction
83   with --setup to load in a wiki's setup:
84
85         ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
86
87 * --version
88
89   Print ikiwiki version number.
90
91 # CONFIG OPTIONS
92
93 These options configure the wiki. Note that [[plugins]] can add additional
94 configuration options of their own.
95
96 * --wikiname
97
98   The name of the wiki, default is "wiki".
99
100 * --templatedir
101
102   Specify the directory that the page [[templates]] are stored in.
103   Default is `/usr/share/ikiwiki/templates`, or another location as
104   configured at build time.
105
106 * --underlaydir
107
108   Specify the directory that is used to underlay the source directory.
109   Source files will be taken from here unless overridden by a file in the
110   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
111   location as configured at build time.
112
113 * --wrappermode mode
114
115   Specify a mode to chmod the wrapper to after creating it.
116
117 * --notify
118
119   Enable email notification of commits. This should be used when running
120   ikiwiki as a [[post-commit]] hook.
121
122 * --rcs=svn, --no-rcs
123
124   Enable or disable use of a revision control system.
125
126   If you use svn, the `source` directory is assumed to be
127   a [[Subversion]] working copy.
128
129   If you use git, the `source` directory is assumed to be a clone of the
130   [[git]] repository.
131
132   If you use tla, the `source` directory is assumed to be a tla import.
133
134   If you use mercurial, the `source` directory is assumed to be the
135   [[mercurial]] repository.
136
137   In [[CGI]] mode, with a revision control system enabled pages edited via
138   the web will be committed. Also, the [[RecentChanges]] link will be placed
139   on pages.
140
141   svn is enabled by default.
142
143 * --svnrepo /svn/wiki
144
145   Specify the location of the svn repository for the wiki. This is required
146   for using --notify with [[subversion]].
147
148 * --svnpath trunk
149
150   Specify the path inside your svn reporistory where the wiki is located.
151   This defaults to trunk; change it if your wiki is at some other location
152   inside the repository.
153
154 * --anonok, --noanonok
155
156   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
157
158   By default, anonymous users cannot edit the wiki.
159
160 * --rss, --norss
161
162   If rss is set, ikiwiki will generate RSS feeds for pages that inline
163   a [[blog]].
164
165 * --atom, --noatom
166
167   If atom is set, ikiwiki will generate Arom feeds for pages that inline
168   a [[blog]].
169
170 * --pingurl url
171
172   Set this to the url to an XML-RPC service to ping when an RSS feed is
173   updated. For example, to ping Technorati, use the url
174   http://rpc.technorati.com/rpc/ping
175
176   This parameter can be specified multiple times to specify more than one
177   url to ping.
178
179 * --url url
180
181   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
182
183 * --cgiurl http://url/ikiwiki.cgi
184
185   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
186   building the wiki for links to the cgi script to be generated.
187
188 * --historyurl url
189
190   Specifies the url to link to for page history browsing. In the url,
191   "\[[file]]" is replaced with the file to browse. It's common to use
192   [[ViewCVS]] for this.
193
194 * --adminemail you@yourhost
195
196   Specifies the email address that ikiwiki should use for sending email.
197
198 * --diffurl url
199
200   Specifies the url to link to for a diff of changes to a page. In the url,
201   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
202   revision of the page, and "\[[r2]]" is the new revision. It's common to use
203   [[ViewCVS]] for this.
204
205 * --exclude regexp
206
207   Specifies a rexexp of source files to exclude from processing.
208   May be specified multiple times to add to exclude list.
209
210 * --adminuser name
211
212   Specifies a username of a user who has the powers of a wiki admin.
213   Currently allows locking of any page, other powers may be added later.
214   May be specified multiple times for multiple admins.
215
216 * --plugin name
217
218   Enables the use of the specified [[plugin|plugins]] in the wiki. 
219   Note that plugin names are case sensative.
220
221 * --disable-plugin name
222
223   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
224   to do away with html sanitization.
225
226 * --discussion, --no-discussion
227
228   Enables or disables "Discussion" links from being added to the header of
229   every page. The links are enabled by default.
230
231 * --timeformat format
232
233   Specify how to display the time or date. The format string is passed to the
234   strftime(3) function.
235
236 * --verbose, --no-verbose
237
238   Be vebose about what is being done.
239
240 * --syslog, --no-syslog
241
242   Log to syslog.
243
244 * --w3mmode, --no-w3mmode
245
246   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
247   without a web server.
248
249 * --sslcookie
250
251   Only send cookies over an SSL connection. This should prevent them being
252   intercepted. If you enable this option then you must run at least the 
253   CGI portion of ikiwiki over SSL.
254
255 * --getctime
256
257   Pull last changed time for each new page out of the revision control
258   system. This rarely used option provides a way to get the real creation
259   times of items in weblogs, for example when building a wiki from a new
260   subversion checkout. It is unoptimised and quite slow. It is best used
261   with --rebuild, to force ikiwiki to get the ctime for all pages.
262
263 # AUTHOR
264
265 Joey Hess <joey@kitenet.net>
266
267 Warning: this page is automatically made into ikiwiki's man page, edit with care