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`.
16 Note that most options can be shortened to single letters, and boolean
17 flags such as --verbose can be negated with --no-verbose.
21 These options control the mode that ikiwiki is operating in.
25 Refresh the wiki, updating any changed pages. This is the default
26 behavior so you don't normally need to specify it.
30 Force a rebuild of all pages.
34 Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
35 supports editing pages, signing in, registration, and displaying
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.
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 [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
51 Note that the generated wrapper will ignore all command line parameters.
55 In setup mode, ikiwiki reads the config file, which is really a perl
56 program that can call ikiwiki internal functions.
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.
63 [[ikiwiki.setup]] is an example of such a config file.
67 These options configure the wiki.
71 The name of the wiki, default is "wiki".
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.
82 Specify the directory that the page [[templates]] are stored in.
83 Default is `/usr/share/ikiwiki/templates`.
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`.
93 Specify a mode to chmod the wrapper to after creating it.
97 Enable or disable use of [[subversion]]. If subversion is enabled, the
98 `source` directory is assumed to be a working copy, and is automatically
99 updated before building the wiki.
101 In [[CGI]] mode, with subversion enabled pages edited via the web will be
102 committed to subversion. Also, the [[RecentChanges]] link will be placed
105 Subversion is enabled by default.
107 * --anonok, --noanonok
109 If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
111 By default, anonymous users cannot edit the wiki.
115 If rss is set, ikiwiki will generate rss feeds for pages that inline
118 * --url http://someurl/
120 Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
122 * --cgiurl http://someurl/ikiwiki.cgi
124 Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
126 * --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
128 Specifies the url to link to for page history browsing. In the url,
129 "\[[file]]" is replaced with the file to browse. It's common to use
130 [[ViewCVS]] for this.
132 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
134 Specifies the url to link to for a diff of changes to a page. In the url,
135 "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
136 revision of the page, and "\[[r2]]" is the new revision. It's common to use
137 [[ViewCVS]] for this.
141 Specifies a rexexp of source files to exclude from processing.
142 May be specified multiple times to add to exclude list.
146 Specifies a username of a user who has the powers of a wiki admin.
147 Currently allows locking of any page, other powers may be added later.
148 May be specified multiple times for multiple admins.
152 Enables use of the [[HyperEstraier]] search engine for full test page
157 Be vebose about what it's doing.
161 Joey Hess <joey@kitenet.net>
163 Warning: this page is automatically made into ikiwiki's man page, edit with care