3 ikiwiki - a wiki compiler
7 ikiwiki [options] source destination
9 ikiwiki --setup configfile
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`.
18 Note that most options can be shortened to single letters, and boolean
19 flags such as --verbose can be negated with --no-verbose.
23 The name of the wiki, default is "wiki".
27 Be vebose about what it's doing.
31 Force a rebuild of all pages.
35 Specify the directory that the page [[templates]] are stored in.
36 Default is `/usr/share/ikiwiki/templates`.
40 Generate a [[wrapper]] binary that is hardcoded to do action specified by
41 the other options, using the specified input files and `destination`
42 directory. The filename to use for the wrapper is optional.
44 The wrapper is designed to be safely made suid and be run by untrusted
45 users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
47 Note that the generated wrapper will ignore all command line parameters.
51 Specify a mode to chmod the wrapper to after creating it.
55 Enable or disable use of [[subversion]]. If subversion is enabled, the `source` directory is assumed to be a working copy, and is automatically updated before building the wiki.
57 In [[CGI]] mode, with subversion enabled pages edited via the web will be committed to subversion. Also, the [[RecentChanges]] link will be placed on pages.
59 Subversion is enabled by default.
61 * --anonok, --noanonok
63 If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
65 By default, anonymous users cannot edit the wiki.
69 Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]].
71 To use ikiwiki as a [[CGI]] program you need to use --wrapper to generate a wrapper. The wrapper will generally need to run suid 6755 to the user who owns the `source` and `destination` directories.
73 * --url http://someurl/
75 Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
77 * --cgiurl http://someurl/ikiwiki.cgi
79 Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
81 * --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
83 Specifies the url to link to for page history browsing. In the url,
84 "\[[file]]" is replaced with the file to browse. It's common to use
87 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
89 Specifies the url to link to for a diff of changes to a page. In the url,
90 "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
91 revision of the page, and "\[[r2]]" is the new revision. It's common to use
96 Specifies a rexexp of source files to exclude from processing.
97 May be specified multiple times to add to exclude list.
101 Specifies a username of a user who has the powers of a wiki admin.
102 Currently allows locking of any page, other powers may be added later.
103 May be specified multiple times for multiple admins.
107 In setup mode, ikiwiki reads the config file, which is really a perl
108 program that can call ikiwiki internal functions. Uses of this are
109 various; the normal one is to automatically generate wrappers for a
110 wiki based on data in a config file.
112 Note that the wiki will be (re)built as part of the setup process to
113 ensure that any changes take effect.
115 [[ikiwiki.setup]] is an example of such a config file.
119 Joey Hess <joey@kitenet.net>
121 Warning: this page is automatically made into ikiwiki's man page, edit with care