]> sipb.mit.edu Git - ikiwiki.git/blob - doc/usage.mdwn
add support for generating per-page rss feeds
[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 # OPTIONS
17
18 Note that most options can be shortened to single letters, and boolean
19 flags such as --verbose can be negated with --no-verbose.
20
21 * --wikiname
22
23   The name of the wiki, default is "wiki".
24
25 * --verbose
26
27   Be vebose about what it's doing.
28
29 * --rebuild
30
31   Force a rebuild of all pages.
32
33 * --templatedir
34
35   Specify the directory that the page [[templates]] are stored in.
36   Default is `/usr/share/ikiwiki/templates`.
37
38 * --wrapper [file]
39
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.
43
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]].
46
47   Note that the generated wrapper will ignore all command line parameters.
48
49 * --wrappermode mode
50
51   Specify a mode to chmod the wrapper to after creating it.
52
53 * --svn, --nosvn
54
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. 
56
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.
58
59   Subversion is enabled by default.
60
61 * --anonok, --noanonok
62
63   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
64
65   By default, anonymous users cannot edit the wiki.
66
67 * --rss, --norss
68
69   If rss is set, along with every html page rendered by ikiwiki, an rss
70   page will also be rendered, to allow users to subscribe to a rss feed of
71   changes to that page.
72
73 * --cgi
74
75   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]].
76
77   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.
78
79 * --url http://someurl/
80
81   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
82
83 * --cgiurl http://someurl/ikiwiki.cgi
84
85   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
86
87 * --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
88
89   Specifies the url to link to for page history browsing. In the url,
90   "\[[file]]" is replaced with the file to browse. It's common to use
91   [[ViewCVS]] for this.
92
93 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
94
95   Specifies the url to link to for a diff of changes to a page. In the url,
96   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
97   revision of the page, and "\[[r2]]" is the new revision. It's common to use
98   [[ViewCVS]] for this.
99
100 * --exclude regexp
101
102   Specifies a rexexp of source files to exclude from processing.
103   May be specified multiple times to add to exclude list.
104
105 * --adminuser name
106
107   Specifies a username of a user who has the powers of a wiki admin.
108   Currently allows locking of any page, other powers may be added later.
109   May be specified multiple times for multiple admins.
110
111 * --setup configfile
112
113   In setup mode, ikiwiki reads the config file, which is really a perl
114   program that can call ikiwiki internal functions. Uses of this are
115   various; the normal one is to automatically generate wrappers for a
116   wiki based on data in a config file.
117   
118   Note that the wiki will be (re)built as part of the setup process to
119   ensure that any changes take effect.
120
121   [[ikiwiki.setup]] is an example of such a config file.
122
123 # AUTHOR
124
125 Joey Hess <joey@kitenet.net>
126
127 Warning: this page is automatically made into ikiwiki's man page, edit with care