web commit by joey
[ikiwiki.git] / doc / usage.mdwn
1 # NAME
2
3 ikiwiki - a wiki compiler
4
5 # SYNOPSIS
6
7 ikiwiki [options] source templates 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, using the specified html `templates`
15 and writes it out to `destination`.
16
17 # OPTIONS
18
19 Note that most options can be shortened to single letters, and boolean
20 flags such as --verbose can be negated with --no-verbose.
21
22 * --wikiname
23
24   The name of the wiki, default is "wiki".
25
26 * --verbose
27
28   Be vebose about what it's doing.
29
30 * --rebuild
31
32   Force a rebuild of all pages.
33
34 * --wrapper [file]
35
36   Generate a [[wrapper]] binary that is hardcoded to do action specified by
37   the other options, using the specified input files and `destination`
38   directory. The filename to use for the wrapper is optional.
39
40   The wrapper is designed to be safely made suid and be run by untrusted
41   users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
42
43   Note that the generated wrapper will ignore all command line parameters
44   except for --params, which will make it print out the parameters it would
45   run ikiwiki with.
46
47 * --wrappermode mode
48
49   Specify a mode to chmod the wrapper to after creating it.
50
51 * --svn, --nosvn
52
53   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. 
54
55   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.
56
57   Subversion is enabled by default.
58
59 * --anonok, --noanonok
60
61   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
62
63   By default, anonymous users cannot edit the wiki.
64
65 * --cgi
66
67   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]].
68
69   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.
70
71 * --url http://someurl/
72
73   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
74
75 * --cgiurl http://someurl/ikiwiki.cgi
76
77   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
78
79 * --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
80
81   Specifies the url to link to for page history browsing. In the url,
82   "\[[file]]" is replaced with the file to browse. It's common to use
83   [[ViewCVS]] for this.
84
85 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
86
87   Specifies the url to link to for a diff of changes to a page. In the url,
88   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
89   revision of the page, and "\[[r2]]" is the new revision. It's common to use
90   [[ViewCVS]] for this.
91
92 * --exclude regexp
93
94   Specifies a rexexp of source files to exclude from processing.
95   May be specified multiple times to add to exclude list.
96
97 * --setup configfile
98
99   In setup mode, ikiwiki reads the config file, which is really a perl
100   program that can call ikiwiki internal functions. Uses of this are
101   various; the normal one is to automatically generate wrappers for a
102   wiki based on data in a config file.
103   
104   Note that the wiki will be (re)built as part of the setup process to
105   ensure that any changes take effect.
106
107   [[ikiwiki.setup]] is an example of such a config file.
108
109 # AUTHOR
110
111 Joey Hess <joey@kitenet.net>
112
113 Warning: this page is automatically made into ikiwiki's man page, edit with care