]> sipb.mit.edu Git - ikiwiki.git/blob - doc/usage.mdwn
Fix typos.
[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 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 * --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 * --post-commit
90
91   Run in post-commit mode, the same as if called by a [[post-commit]] hook.
92   This is probably only useful when using ikiwiki with a web server on one host
93   and a repository on another, to allow the repository's real post-commit
94   hook to ssh to the web server host and manually run ikiwiki to update
95   the web site.
96
97 * --version
98
99   Print ikiwiki's version number.
100
101 # CONFIG OPTIONS
102
103 These options configure the wiki. Note that [[plugins]] can add additional
104 configuration options of their own.
105
106 * --wikiname
107
108   The name of the wiki, default is "wiki".
109
110 * --templatedir
111
112   Specify the directory that the page [[templates|wikitemplates]] are stored in.
113   Default is `/usr/share/ikiwiki/templates`, or another location as configured at
114   build time. If the templatedir is changed, missing templates will still
115   be searched for in the default location as a fallback.
116
117 * --underlaydir
118
119   Specify the directory that is used to underlay the source directory.
120   Source files will be taken from here unless overridden by a file in the
121   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
122   location as configured at build time.
123
124 * --wrappermode mode
125
126   Specify a mode to chmod the wrapper to after creating it.
127
128 * --notify, --no-notify
129
130   Enable email notification of commits. This should be used when running
131   ikiwiki as a [[post-commit]] hook.
132
133 * --rcs=svn, --no-rcs
134
135   Enable or disable use of a revision control system.
136
137   If you use svn, the `source` directory is assumed to be
138   a [[Subversion]] working copy.
139
140   If you use git, the `source` directory is assumed to be a clone of the
141   [[git]] repository.
142
143   If you use tla, the `source` directory is assumed to be a tla import.
144
145   If you use mercurial, the `source` directory is assumed to be the
146   [[mercurial]] repository.
147
148   In [[CGI]] mode, with a revision control system enabled, pages edited via
149   the web will be committed. Also, the [[RecentChanges]] link will be placed
150   on pages.
151
152   No revision control is enabled by default.
153
154 * --svnrepo /svn/wiki
155
156   Specify the location of the svn repository for the wiki. This is required
157   for using --notify with [[Subversion]].
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.
164
165 * --rss, --norss
166
167   If rss is set, ikiwiki will generate RSS feeds for pages that inline
168   a [[blog]].
169
170 * --atom, --noatom
171
172   If atom is set, ikiwiki will generate Atom feeds for pages that inline
173   a [[blog]].
174
175 * --pingurl URL
176
177   Set this to the URL of an XML-RPC service to ping when an RSS feed is
178   updated. For example, to ping Technorati, use the URL
179   http://rpc.technorati.com/rpc/ping
180
181   This parameter can be specified multiple times to specify more than one
182   URL to ping.
183
184 * --url URL
185
186   Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
187
188 * --cgiurl http://example.org/ikiwiki.cgi
189
190   Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
191   building the wiki for links to the cgi script to be generated.
192
193 * --historyurl URL
194
195   Specifies the URL to link to for page history browsing. In the URL,
196   "\[[file]]" is replaced with the file to browse. It's common to use
197   [[ViewVC]] for this.
198
199 * --adminemail you@example.org
200
201   Specifies the email address that ikiwiki should use for sending email.
202
203 * --diffurl URL
204
205   Specifies the URL to link to for a diff of changes to a page. In the URL,
206   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
207   revision of the page, and "\[[r2]]" is the new revision. It's common to use
208   [[ViewVC]] for this.
209
210 * --exclude regexp
211
212   Specifies a rexexp of source files to exclude from processing.
213   May be specified multiple times to add to exclude list.
214
215 * --adminuser name
216
217   Specifies a username of a user who has the powers of a wiki admin.
218   Currently allows locking of any page; other powers may be added later.
219   May be specified multiple times for multiple admins.
220
221 * --plugin name
222
223   Enables the use of the specified [[plugin|plugins]] in the wiki. 
224   Note that plugin names are case sensitive.
225
226 * --disable-plugin name
227
228   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
229   to do away with HTML sanitization.
230
231 * --discussion, --no-discussion
232
233   Enables or disables "Discussion" links from being added to the header of
234   every page. The links are enabled by default.
235
236 * --numbacklinks n
237
238   Controls how many backlinks should be displayed maximum. Excess backlinks
239   will be hidden in a popup. Default is 10.
240
241 * --userdir subdir
242
243   Optionally, allows links to users of the wiki to link to pages inside a
244   subdirectory of the wiki. The default is to link to pages in the toplevel
245   directory of the wiki.
246
247 * --timeformat format
248
249   Specify how to display the time or date. The format string is passed to the
250   strftime(3) function.
251
252 * --verbose, --no-verbose
253
254   Be verbose about what is being done.
255
256 * --syslog, --no-syslog
257
258   Log to syslog(3).
259
260 * --usedirs, --no-usedirs
261
262   Create output files named page/index.html instead of page.html.
263
264 * --w3mmode, --no-w3mmode
265
266   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
267   without a web server.
268
269 * --sslcookie
270
271   Only send cookies over an SSL connection. This should prevent them being
272   intercepted. If you enable this option then you must run at least the 
273   CGI portion of ikiwiki over SSL.
274
275 * --getctime
276
277   Pull last changed time for each new page out of the revision control
278   system. This rarely used option provides a way to get the real creation
279   times of items in weblogs, such as when building a wiki from a new
280   Subversion checkout. It is unoptimised and quite slow. It is best used
281   with --rebuild, to force ikiwiki to get the ctime for all pages.
282
283 # AUTHOR
284
285 Joey Hess <joey@ikiwiki.info>
286
287 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