]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/usage.mdwn
Make makerepo set the Git merge remote
[git.ikiwiki.info.git] / doc / usage.mdwn
1 # NAME
3 ikiwiki - a wiki compiler
5 # SYNOPSIS
7 ikiwiki [options] source destination
9 ikiwiki --setup configfile
11 # DESCRIPTION
13 `ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
14 `source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to
15 `destination`.
17 Note that most options can be shortened to single letters, and boolean
18 flags such as --verbose can be negated with --no-verbose.
20 # MODE OPTIONS
22 These options control the mode that ikiwiki operates in.
24 * --refresh
26   Refresh the wiki, updating any changed pages. This is the default
27   behavior so you don't normally need to specify it.
29 * --rebuild
31   Force a rebuild of all pages.
33 * --cgi
35   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
36   supports editing pages, signing in, and registration.
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.
42 * --wrapper [file]
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.
48   The wrapper is designed to be safely made suid and be run by untrusted
49   users, as a [[post-commit]] hook, or as a [[CGI]].
51   Note that the generated wrapper will ignore all command line parameters.
53 * --setup configfile
55   In setup mode, ikiwiki reads the config file, which is really a perl
56   program that can call ikiwiki internal functions.
58   [[ikiwiki.setup]] is an example of such a config file.
60   The default action when --setup is specified is to automatically generate
61   wrappers for a wiki based on data in a config file, and rebuild the wiki.
62   If you only want to build any changed pages, you can use --refresh with
63   --setup.
65 * --wrappers
67   If used with --setup --refresh, this makes it also update any configured
68   wrappers.
70 * --aggregate
72   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
73   configured feeds and save new posts to the srcdir.
75   Note that to rebuild previously aggregated posts, use the --rebuild option
76   along with this one. --rebuild will also force feeds to be polled even if
77   they were polled recently.
79 * --render file
81   Renders a single file, outputting the resulting html. Does not save state,
82   so this cannot be used for building whole wikis, but it is useful for
83   previewing an edited file at the command line. Generally used in conjunction
84   with --setup to load in a wiki's setup:
86         ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
88 * --post-commit
90   Run in post-commit mode, the same as if called by a [[post-commit]] hook.
91   This is probably only useful when using ikiwiki with a web server on one host
92   and a repository on another, to allow the repository's real post-commit
93   hook to ssh to the web server host and manually run ikiwiki to update
94   the web site.
96 * --version
98   Print ikiwiki's version number.
100 # CONFIG OPTIONS
102 These options configure the wiki. Note that [[plugins]] can add additional
103 configuration options of their own.
105 * --wikiname
107   The name of the wiki, default is "wiki".
109 * --templatedir
111   Specify the directory that the page [[templates|wikitemplates]] are stored in.
112   Default is `/usr/share/ikiwiki/templates`, or another location as configured at
113   build time. If the templatedir is changed, missing templates will still
114   be searched for in the default location as a fallback.
116 * --underlaydir
118   Specify the directory that is used to underlay the source directory.
119   Source files will be taken from here unless overridden by a file in the
120   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
121   location as configured at build time.
123 * --wrappermode mode
125   Specify a mode to chmod the wrapper to after creating it.
127 * --wrappergroup group
129   Specify what unix group the wrapper should be owned by. This can be
130   useful if the wrapper needs to be owned by a group other than the default.
131   For example, if a project has a repository with multiple committers with
132   access controlled by a group, it makes sense for the ikiwiki wrappers
133   to run setgid to that group.
135 * --rcs=svn|git|.., --no-rcs
137   Enable or disable use of a [[revision_control_system|rcs]].
139   The `source` directory will be assumed to be a working copy, or clone, or
140   whatever the revision control system you select uses.
142   In [[CGI]] mode, with a revision control system enabled, pages edited via
143   the web will be committed.
145   No revision control is enabled by default.
147 * --svnpath trunk
149   Specify the path inside your svn repository where the wiki is located.
150   This defaults to `trunk`; change it if your wiki is at some other path
151   inside the repository. If your wiki is rooted at the top of the repository,
152   set svnpath to "".
154 * --rss, --norss
156   If rss is set, ikiwiki will default to generating RSS feeds for pages
157   that inline a [[ikiwiki/blog]].
159 * --allowrss
161   If allowrss is set, and rss is not set, ikiwiki will not default to
162   generating RSS feeds, but setting `rss=yes` in the blog can override
163   this default and generate a feed.
165 * --atom, --noatom
167   If atom is set, ikiwiki will default to generating Atom feeds for pages
168   that inline a [[ikiwiki/blog]].
170 * --allowatom
172   If allowatom is set, and rss is not set, ikiwiki will not default to
173   generating Atom feeds, but setting `atom=yes` in the blog can override
174   this default and generate a feed.
176 * --pingurl URL
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
182   This parameter can be specified multiple times to specify more than one
183   URL to ping.
185 * --url URL
187   Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
189 * --cgiurl http://example.org/ikiwiki.cgi
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.
194 * --historyurl URL
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.
200 * --adminemail you@example.org
202   Specifies the email address that ikiwiki should use for sending email.
204 * --diffurl URL
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.
211 * --exclude regexp
213   Specifies a rexexp of source files to exclude from processing.
214   May be specified multiple times to add to exclude list.
216 * --adminuser name
218   Specifies a username of a user (or, if openid is enabled, an openid) 
219   who has the powers of a wiki admin. Currently allows locking of any page,
220   and banning of users; other powers may be added later. May be specified
221   multiple times for multiple admins.
223   For an openid user specify the full URL of the login, including "http://".
225 * --plugin name
227   Enables the use of the specified [[plugin|plugins]] in the wiki. 
228   Note that plugin names are case sensitive.
230 * --disable-plugin name
232   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
233   to do away with HTML sanitization.
235 * --libdir directory
237   Makes ikiwiki look in the specified directory first, before the regular
238   locations when loading library files and plugins. For example, if you set
239   libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as
240   "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm".
242 * --discussion, --no-discussion
244   Enables or disables "Discussion" links from being added to the header of
245   every page. The links are enabled by default.
247 * --numbacklinks n
249   Controls how many backlinks should be displayed at the bottom of a page.
250   Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to
251   disable this feature.
253 * --userdir subdir
255   Optionally, allows links to users of the wiki to link to pages inside a
256   subdirectory of the wiki. The default is to link to pages in the toplevel
257   directory of the wiki.
259 * --htmlext html
261   Configures the extension used for generated html files. Default is "html".
263 * --timeformat format
265   Specify how to display the time or date. The format string is passed to the
266   strftime(3) function.
268 * --verbose, --no-verbose
270   Be verbose about what is being done.
272 * --syslog, --no-syslog
274   Log to syslog(3).
276 * --usedirs, --no-usedirs
278   Toggle creating output files named page/index.html (default) instead of page.html.
280 * --prefix-directives, --no-prefix-directives
282   Toggle new '!'-prefixed syntax for preprocessor directives.  ikiwiki currently
283   defaults to --no-prefix-directives.
285 * --w3mmode, --no-w3mmode
287   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
288   without a web server.
290 * --sslcookie
292   Only send cookies over an SSL connection. This should prevent them being
293   intercepted. If you enable this option then you must run at least the 
294   CGI portion of ikiwiki over SSL.
296 * --getctime
298   Pull last changed time for each new page out of the revision control
299   system. This rarely used option provides a way to get the real creation
300   times of items in weblogs, such as when building a wiki from a new
301   Subversion checkout. It is unoptimised and quite slow. It is best used
302   with --rebuild, to force ikiwiki to get the ctime for all pages.
304 * --set var=value
305   
306   This allows setting an arbitrary configuration variable, the same as if it
307   were set via a configuration file. Since most options can be configured
308   using command-line switches, you will rarely need to use this, but it can be
309   useful for the odd option that lacks a command-line switch.
311 # ENVIRONMENT
313 * CC
315   This controls what C compiler is used to build wrappers. Default is 'cc'.
317 # SEE ALSO
319 * [[ikiwiki-mass-rebuild]](8)
320 * [[ikiwiki-update-wikilist]](1)
322 # AUTHOR
324 Joey Hess <joey@ikiwiki.info>
326 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