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