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