* ikiwiki can now download and aggregate feeds with its new aggregate
[ikiwiki] / 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 aggregate plugin is enabled, this makes ikiwiki poll configured
72   feeds and save new posts to the srcdir.
73
74 # CONFIG OPTIONS
75
76 These options configure the wiki. Note that plugins can add additional
77 configuration options of their own.
78
79 * --wikiname
80
81   The name of the wiki, default is "wiki".
82
83 * --templatedir
84
85   Specify the directory that the page [[templates]] are stored in.
86   Default is `/usr/share/ikiwiki/templates`.
87
88 * --underlaydir
89
90   Specify the directory that is used to underlay the source directory.
91   Source files will be taken from here unless overridden by a file in the
92   source directory. Default is `/usr/share/ikiwiki/basewiki`.
93
94 * --wrappermode mode
95
96   Specify a mode to chmod the wrapper to after creating it.
97
98 * --notify
99
100   Enable email notification of commits. This should be used when running
101   ikiwiki as a [[post-commit]] hook.
102
103 * --rcs=svn, --no-rcs
104
105   Enable or disable use of a revision control system.
106
107   If you use svn, the `source` directory is assumed to be
108   a [[Subversion]] working copy.
109
110   If you use git, the `source` directory is assumed to be a clone of the
111   [[git]] repository.
112
113   In [[CGI]] mode, with a revision control system enabled pages edited via
114   the web will be committed. Also, the [[RecentChanges]] link will be placed
115   on pages.
116
117   svn is enabled by default.
118
119 * --svnrepo /svn/wiki
120
121   Specify the location of the svn repository for the wiki. This is required
122   for using --notify with [[subversion]].
123
124 * --svnpath trunk
125
126   Specify the path inside your svn reporistory where the wiki is located.
127   This defaults to trunk; change it if your wiki is at some other location
128   inside the repository.
129
130 * --anonok, --noanonok
131
132   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
133
134   By default, anonymous users cannot edit the wiki.
135
136 * --rss, --norss
137
138   If rss is set, ikiwiki will generate rss feeds for pages that inline
139   a [[blog]].
140
141 * --pingurl url
142
143   Set this to the url to an XML-RPC service to ping when an RSS feed is
144   updated. For example, to ping Technorati, use the url
145   http://rpc.technorati.com/rpc/ping
146
147   This parameter can be specified multiple times to specify more than one
148   url to ping.
149
150 * --url url
151
152   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
153
154 * --cgiurl http://url/ikiwiki.cgi
155
156   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
157   building the wiki for links to the cgi script to be generated.
158
159 * --historyurl http://url/trunk/\[[file]]?root=wiki
160
161   Specifies the url to link to for page history browsing. In the url,
162   "\[[file]]" is replaced with the file to browse. It's common to use
163   [[ViewCVS]] for this.
164
165 * --adminemail you@yourhost
166
167   Specifies the email address that ikiwiki should use for sending email.
168
169 * --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
170
171   Specifies the url to link to for a diff of changes to a page. In the url,
172   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
173   revision of the page, and "\[[r2]]" is the new revision. It's common to use
174   [[ViewCVS]] for this.
175
176 * --exclude regexp
177
178   Specifies a rexexp of source files to exclude from processing.
179   May be specified multiple times to add to exclude list.
180
181 * --adminuser name
182
183   Specifies a username of a user who has the powers of a wiki admin.
184   Currently allows locking of any page, other powers may be added later.
185   May be specified multiple times for multiple admins.
186
187 * --plugin name
188
189   Enables the use of the specified [[plugin|plugins]] in the wiki. 
190   Note that plugin names are case sensative.
191
192 * --disable-plugin name
193
194   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
195   to do away with html sanitization.
196
197 * --discussion, --no-discussion
198
199   Enables or disables "Discussion" links from being added to the header of
200   every page. The links are enabled by default.
201
202 * --timeformat format
203
204   Specify how to display the time or date. The format string is passed to the
205   strftime(3) function.
206
207 * --verbose
208
209   Be vebose about what is being done.
210
211 * --w3mmode, --no-w3mmode
212
213   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
214   without a web server.
215
216 * --getctime
217
218   Pull last changed time for each new page out of the revision control
219   system. This rarely used option provides a way to get the real creation
220   times of items in weblogs, for example when building a wiki from a new
221   subversion checkout. It is unoptimised and quite slow. It is best used
222   with --rebuild, to force ikiwiki to get the ctime for all pages.
223
224 # AUTHOR
225
226 Joey Hess <joey@kitenet.net>
227
228 Warning: this page is automatically made into ikiwiki's man page, edit with care