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