back to base
[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, and writes it out to `destination`.
15
16 Note that most options can be shortened to single letters, and boolean
17 flags such as --verbose can be negated with --no-verbose.
18
19 # MODE OPTIONS
20
21 These options control the mode that ikiwiki is operating in.
22
23 * --refresh
24
25   Refresh the wiki, updating any changed pages. This is the default
26   behavior so you don't normally need to specify it.
27
28 * --rebuild
29
30   Force a rebuild of all pages.
31
32 * --cgi
33
34   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
35   supports editing pages, signing in, registration, and displaying
36   [[RecentChanges]].
37
38   To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
39   to generate a wrapper. The wrapper will generally need to run suid 6755 to
40   the user who owns the `source` and `destination` directories.
41
42 * --wrapper [file]
43
44   Generate a [[wrapper]] binary that is hardcoded to do action specified by
45   the other options, using the specified input files and `destination`
46   directory. The filename to use for the wrapper is optional.
47
48   The wrapper is designed to be safely made suid and be run by untrusted
49   users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
50
51   Note that the generated wrapper will ignore all command line parameters.
52
53 * --setup configfile
54
55   In setup mode, ikiwiki reads the config file, which is really a perl
56   program that can call ikiwiki internal functions.
57
58   The default action when --setup is specified is to automatically generate
59   wrappers for a wiki based on data in a config file, and rebuild the wiki.
60   If you also pass the --refresh option, ikiwiki will instead just refresh
61   the wiki described in the setup file.
62
63   [[ikiwiki.setup]] is an example of such a config file.
64
65 # CONFIG OPTIONS
66
67 These options configure the wiki.
68
69 * --wikiname
70
71   The name of the wiki, default is "wiki".
72
73 * --fixctime
74
75   Pull last changed time for all pages out of the revision control system.
76   This rarely used option provides a way to get the real creation times of
77   items in weblogs, for example when building a wiki from a new subversion
78   checkout. It is unoptimised and quite slow.
79
80 * --templatedir
81
82   Specify the directory that the page [[templates]] are stored in.
83   Default is `/usr/share/ikiwiki/templates`.
84
85 * --underlaydir
86
87   Specify the directory that is used to underlay the source directory.
88   Source files will be taken from here unless overridden by a file in the
89   source directory. Default is `/usr/share/ikiwiki/basewiki`.
90
91 * --wrappermode mode
92
93   Specify a mode to chmod the wrapper to after creating it.
94
95 * --notify
96
97   Enable email notification of commits. This should be used when running
98   ikiwiki as a [[Subversion]] [[post-commit]] hook.
99
100 * --svn, --nosvn
101
102   Enable or disable use of [[subversion]]. If subversion is enabled, the
103   `source` directory is assumed to be a working copy, and is automatically
104   updated before building the wiki. 
105
106   In [[CGI]] mode, with subversion enabled pages edited via the web will be
107   committed to subversion. Also, the [[RecentChanges]] link will be placed
108   on pages.
109
110   Subversion is enabled by default.
111
112 * --svnrepo /svn/wiki
113
114   Specify the location of the svn repository for the wiki. This is required
115   for using --notify with [[subversion]].
116
117 * --svnpath trunk
118
119   Specify the path inside your svn reporistory where the wiki is located.
120   This defaults to trunk; change it if your wiki is at some other location
121   inside the repository.
122
123 * --anonok, --noanonok
124
125   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
126
127   By default, anonymous users cannot edit the wiki.
128
129 * --rss, --norss
130
131   If rss is set, ikiwiki will generate rss feeds for pages that inline
132   a blog.
133
134 * --url http://url/
135
136   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
137
138 * --cgiurl http://url/ikiwiki.cgi
139
140   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
141
142 * --historyurl http://url/trunk/\[[file]]?root=wiki
143
144   Specifies the url to link to for page history browsing. In the url,
145   "\[[file]]" is replaced with the file to browse. It's common to use
146   [[ViewCVS]] for this.
147
148 * --adminemail you@yourhost
149
150   Specifies the email address that ikiwiki should use for sending email.
151
152 * --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
153
154   Specifies the url to link to for a diff of changes to a page. In the url,
155   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
156   revision of the page, and "\[[r2]]" is the new revision. It's common to use
157   [[ViewCVS]] for this.
158
159 * --exclude regexp
160
161   Specifies a rexexp of source files to exclude from processing.
162   May be specified multiple times to add to exclude list.
163
164 * --adminuser name
165
166   Specifies a username of a user who has the powers of a wiki admin.
167   Currently allows locking of any page, other powers may be added later.
168   May be specified multiple times for multiple admins.
169
170 * --sanitize
171
172   Enable [[HtmlSanitization]] of wiki content. On by default, disable with
173   --no-sanitize.
174
175 * --hyperestraier
176
177   Enables use of the [[HyperEstraier]] search engine for full test page
178   searches.
179
180 * --verbose
181
182   Be vebose about what it's doing.
183
184 # AUTHOR
185
186 Joey Hess <joey@kitenet.net>
187
188 Warning: this page is automatically made into ikiwiki's man page, edit with care