]> sipb.mit.edu Git - ikiwiki.git/blob - doc/usage.mdwn
9a8b97ceb15fcc2ead6e190e499f5e0cea006cde
[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 changes 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 * --svn, --nosvn
96
97   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. 
98
99   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.
100
101   Subversion is enabled by default.
102
103 * --anonok, --noanonok
104
105   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
106
107   By default, anonymous users cannot edit the wiki.
108
109 * --rss, --norss
110
111   If rss is set, ikiwiki will generate rss feeds for pages that inline
112   a blog.
113
114 * --url http://someurl/
115
116   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
117
118 * --cgiurl http://someurl/ikiwiki.cgi
119
120   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
121
122 * --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
123
124   Specifies the url to link to for page history browsing. In the url,
125   "\[[file]]" is replaced with the file to browse. It's common to use
126   [[ViewCVS]] for this.
127
128 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
129
130   Specifies the url to link to for a diff of changes to a page. In the url,
131   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
132   revision of the page, and "\[[r2]]" is the new revision. It's common to use
133   [[ViewCVS]] for this.
134
135 * --exclude regexp
136
137   Specifies a rexexp of source files to exclude from processing.
138   May be specified multiple times to add to exclude list.
139
140 * --adminuser name
141
142   Specifies a username of a user who has the powers of a wiki admin.
143   Currently allows locking of any page, other powers may be added later.
144   May be specified multiple times for multiple admins.
145
146 * --verbose
147
148   Be vebose about what it's doing.
149
150 # AUTHOR
151
152 Joey Hess <joey@kitenet.net>
153
154 Warning: this page is automatically made into ikiwiki's man page, edit with care