add blog post template
[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, ikiwiki will generate rss feeds for pages that inline
70   a blog.
71
72 * --cgi
73
74   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]].
75
76   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.
77
78 * --url http://someurl/
79
80   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
81
82 * --cgiurl http://someurl/ikiwiki.cgi
83
84   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
85
86 * --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
87
88   Specifies the url to link to for page history browsing. In the url,
89   "\[[file]]" is replaced with the file to browse. It's common to use
90   [[ViewCVS]] for this.
91
92 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
93
94   Specifies the url to link to for a diff of changes to a page. In the url,
95   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
96   revision of the page, and "\[[r2]]" is the new revision. It's common to use
97   [[ViewCVS]] for this.
98
99 * --exclude regexp
100
101   Specifies a rexexp of source files to exclude from processing.
102   May be specified multiple times to add to exclude list.
103
104 * --adminuser name
105
106   Specifies a username of a user who has the powers of a wiki admin.
107   Currently allows locking of any page, other powers may be added later.
108   May be specified multiple times for multiple admins.
109
110 * --setup configfile
111
112   In setup mode, ikiwiki reads the config file, which is really a perl
113   program that can call ikiwiki internal functions. Uses of this are
114   various; the normal one is to automatically generate wrappers for a
115   wiki based on data in a config file.
116   
117   Note that the wiki will be (re)built as part of the setup process to
118   ensure that any changes take effect.
119
120   [[ikiwiki.setup]] is an example of such a config file.
121
122 # AUTHOR
123
124 Joey Hess <joey@kitenet.net>
125
126 Warning: this page is automatically made into ikiwiki's man page, edit with care