]> sipb.mit.edu Git - ikiwiki.git/blob - doc/usage.mdwn
web commit by http://joey.kitenet.net/
[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|git|.., --no-rcs
134
135   Enable or disable use of a [[revision_control_system|rcs]].
136
137   The `source` directory will be assumed to be a working copy, or clone, or
138   whatever the revision control system you select uses.
139
140   In [[CGI]] mode, with a revision control system enabled, pages edited via
141   the web will be committed. Also, the [[RecentChanges]] link will be placed
142   on pages.
143
144   No revision control is enabled by default.
145
146 * --svnrepo /svn/wiki
147
148   Specify the location of the svn repository for the wiki. This is required
149   for using --notify with [[Subversion|rcs/svn]].
150
151 * --svnpath trunk
152
153   Specify the path inside your svn repository where the wiki is located.
154   This defaults to `trunk`; change it if your wiki is at some other path
155   inside the repository. If your wiki is rooted at the top of the repository,
156   set svnpath to "".
157
158 * --rss, --norss
159
160   If rss is set, ikiwiki will generate RSS feeds for pages that inline
161   a [[blog]].
162
163 * --atom, --noatom
164
165   If atom is set, ikiwiki will generate Atom feeds for pages that inline
166   a [[blog]].
167
168 * --pingurl URL
169
170   Set this to the URL of an XML-RPC service to ping when an RSS feed is
171   updated. For example, to ping Technorati, use the URL
172   http://rpc.technorati.com/rpc/ping
173
174   This parameter can be specified multiple times to specify more than one
175   URL to ping.
176
177 * --url URL
178
179   Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
180
181 * --cgiurl http://example.org/ikiwiki.cgi
182
183   Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
184   building the wiki for links to the cgi script to be generated.
185
186 * --historyurl URL
187
188   Specifies the URL to link to for page history browsing. In the URL,
189   "\[[file]]" is replaced with the file to browse. It's common to use
190   [[ViewVC]] for this.
191
192 * --adminemail you@example.org
193
194   Specifies the email address that ikiwiki should use for sending email.
195
196 * --diffurl URL
197
198   Specifies the URL to link to for a diff of changes to a page. In the URL,
199   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
200   revision of the page, and "\[[r2]]" is the new revision. It's common to use
201   [[ViewVC]] for this.
202
203 * --exclude regexp
204
205   Specifies a rexexp of source files to exclude from processing.
206   May be specified multiple times to add to exclude list.
207
208 * --adminuser name
209
210   Specifies a username of a user who has the powers of a wiki admin.
211   Currently allows locking of any page; other powers may be added later.
212   May be specified multiple times for multiple admins.
213
214 * --plugin name
215
216   Enables the use of the specified [[plugin|plugins]] in the wiki. 
217   Note that plugin names are case sensitive.
218
219 * --disable-plugin name
220
221   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
222   to do away with HTML sanitization.
223
224 * --libdir directory
225
226   Makes ikiwiki look in the specified directory first, before the regular
227   locations when loading library files and plugins. For example, if you set
228   libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as
229   "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm".
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 at the bottom of a page.
239   Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to
240   disable this feature.
241
242 * --userdir subdir
243
244   Optionally, allows links to users of the wiki to link to pages inside a
245   subdirectory of the wiki. The default is to link to pages in the toplevel
246   directory of the wiki.
247
248 * --htmlext html
249
250   Configures the extension used for generated html files. Default is "html".
251
252 * --timeformat format
253
254   Specify how to display the time or date. The format string is passed to the
255   strftime(3) function.
256
257 * --verbose, --no-verbose
258
259   Be verbose about what is being done.
260
261 * --syslog, --no-syslog
262
263   Log to syslog(3).
264
265 * --usedirs, --no-usedirs
266
267   Toggle creating output files named page/index.html (default) instead of page.html.
268
269 * --w3mmode, --no-w3mmode
270
271   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
272   without a web server.
273
274 * --sslcookie
275
276   Only send cookies over an SSL connection. This should prevent them being
277   intercepted. If you enable this option then you must run at least the 
278   CGI portion of ikiwiki over SSL.
279
280 * --getctime
281
282   Pull last changed time for each new page out of the revision control
283   system. This rarely used option provides a way to get the real creation
284   times of items in weblogs, such as when building a wiki from a new
285   Subversion checkout. It is unoptimised and quite slow. It is best used
286   with --rebuild, to force ikiwiki to get the ctime for all pages.
287
288 * --set var=value
289   
290   This allows setting an arbitrary configuration variable, the same as if it
291   were set via a configuration file. Since most options can be configured
292   using command-line switches, you will rarely need to use this, but it can be
293   useful for the odd option that lacks a command-line switch.
294
295 # SEE ALSO
296
297 * [[ikiwiki-mass-rebuild]](8)
298 * [[ikiwiki-update-wikilist]](1)
299
300 # AUTHOR
301
302 Joey Hess <joey@ikiwiki.info>
303
304 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