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