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