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 (or others), and writes it out to
  15 `destination`.
  16
  17 Note that most options can be shortened to single letters, and boolean
  18 flags such as --verbose can be negated with --no-verbose.
  19
  20 # MODE OPTIONS
  21
  22 These options control the mode that ikiwiki is operating in.
  23
  24 * --refresh
  25
  26   Refresh the wiki, updating any changed pages. This is the default
  27   behavior so you don't normally need to specify it.
  28
  29 * --rebuild
  30
  31   Force a rebuild of all pages.
  32
  33 * --cgi
  34
  35   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
  36   supports editing pages, signing in, registration, and displaying
  37   [[RecentChanges]].
  38
  39   To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
  40   to generate a wrapper. The wrapper will generally need to run suid 6755 to
  41   the user who owns the `source` and `destination` directories.
  42
  43 * --wrapper [file]
  44
  45   Generate a wrapper binary that is hardcoded to do action specified by
  46   the other options, using the specified input files and `destination`
  47   directory. The filename to use for the wrapper is optional.
  48
  49   The wrapper is designed to be safely made suid and be run by untrusted
  50   users, as a [[post-commit]] hook, or as a [[CGI]].
  51
  52   Note that the generated wrapper will ignore all command line parameters.
  53
  54 * --setup configfile
  55
  56   In setup mode, ikiwiki reads the config file, which is really a perl
  57   program that can call ikiwiki internal functions.
  58
  59   The default action when --setup is specified is to automatically generate
  60   wrappers for a wiki based on data in a config file, and rebuild the wiki.
  61
  62   [[ikiwiki.setup]] is an example of such a config file.
  63
  64 * --wrappers
  65
  66   If used with --setup --refresh, this makes it also update any configured
  67   wrappers.
  68
  69 * --aggregate
  70
  71   If the aggregate plugin is enabled, this makes ikiwiki poll configured
  72   feeds and save new posts to the srcdir.
  73
  74   Note that to rebuild previously aggregated posts, use the --rebuild option
  75   along with this one. --rebuild will also force feeds to be polled even if
  76   they were polled recently.
  77
  78 # CONFIG OPTIONS
  79
  80 These options configure the wiki. Note that plugins can add additional
  81 configuration options of their own.
  82
  83 * --wikiname
  84
  85   The name of the wiki, default is "wiki".
  86
  87 * --templatedir
  88
  89   Specify the directory that the page [[templates]] are stored in.
  90   Default is `/usr/share/ikiwiki/templates`.
  91
  92 * --underlaydir
  93
  94   Specify the directory that is used to underlay the source directory.
  95   Source files will be taken from here unless overridden by a file in the
  96   source directory. Default is `/usr/share/ikiwiki/basewiki`.
  97
  98 * --wrappermode mode
  99
 100   Specify a mode to chmod the wrapper to after creating it.
 101
 102 * --notify
 103
 104   Enable email notification of commits. This should be used when running
 105   ikiwiki as a [[post-commit]] hook.
 106
 107 * --rcs=svn, --no-rcs
 108
 109   Enable or disable use of a revision control system.
 110
 111   If you use svn, the `source` directory is assumed to be
 112   a [[Subversion]] working copy.
 113
 114   If you use git, the `source` directory is assumed to be a clone of the
 115   [[git]] repository.
 116
 117   In [[CGI]] mode, with a revision control system enabled pages edited via
 118   the web will be committed. Also, the [[RecentChanges]] link will be placed
 119   on pages.
 120
 121   svn is enabled by default.
 122
 123 * --svnrepo /svn/wiki
 124
 125   Specify the location of the svn repository for the wiki. This is required
 126   for using --notify with [[subversion]].
 127
 128 * --svnpath trunk
 129
 130   Specify the path inside your svn reporistory where the wiki is located.
 131   This defaults to trunk; change it if your wiki is at some other location
 132   inside the repository.
 133
 134 * --anonok, --noanonok
 135
 136   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
 137
 138   By default, anonymous users cannot edit the wiki.
 139
 140 * --rss, --norss
 141
 142   If rss is set, ikiwiki will generate rss feeds for pages that inline
 143   a [[blog]].
 144
 145 * --pingurl url
 146
 147   Set this to the url to an XML-RPC service to ping when an RSS feed is
 148   updated. For example, to ping Technorati, use the url
 149   http://rpc.technorati.com/rpc/ping
 150
 151   This parameter can be specified multiple times to specify more than one
 152   url to ping.
 153
 154 * --url url
 155
 156   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
 157
 158 * --cgiurl http://url/ikiwiki.cgi
 159
 160   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
 161   building the wiki for links to the cgi script to be generated.
 162
 163 * --historyurl http://url/trunk/\[[file]]?root=wiki
 164
 165   Specifies the url to link to for page history browsing. In the url,
 166   "\[[file]]" is replaced with the file to browse. It's common to use
 167   [[ViewCVS]] for this.
 168
 169 * --adminemail you@yourhost
 170
 171   Specifies the email address that ikiwiki should use for sending email.
 172
 173 * --diffurl http://url/trunk/\[[file]]?root=wiki&amp;r1=\[[r1]]&amp;r2=\[[r2]]
 174
 175   Specifies the url to link to for a diff of changes to a page. In the url,
 176   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 177   revision of the page, and "\[[r2]]" is the new revision. It's common to use
 178   [[ViewCVS]] for this.
 179
 180 * --exclude regexp
 181
 182   Specifies a rexexp of source files to exclude from processing.
 183   May be specified multiple times to add to exclude list.
 184
 185 * --adminuser name
 186
 187   Specifies a username of a user who has the powers of a wiki admin.
 188   Currently allows locking of any page, other powers may be added later.
 189   May be specified multiple times for multiple admins.
 190
 191 * --plugin name
 192
 193   Enables the use of the specified [[plugin|plugins]] in the wiki.
 194   Note that plugin names are case sensative.
 195
 196 * --disable-plugin name
 197
 198   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
 199   to do away with html sanitization.
 200
 201 * --discussion, --no-discussion
 202
 203   Enables or disables "Discussion" links from being added to the header of
 204   every page. The links are enabled by default.
 205
 206 * --timeformat format
 207
 208   Specify how to display the time or date. The format string is passed to the
 209   strftime(3) function.
 210
 211 * --verbose
 212
 213   Be vebose about what is being done.
 214
 215 * --w3mmode, --no-w3mmode
 216
 217   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 218   without a web server.
 219
 220 * --getctime
 221
 222   Pull last changed time for each new page out of the revision control
 223   system. This rarely used option provides a way to get the real creation
 224   times of items in weblogs, for example when building a wiki from a new
 225   subversion checkout. It is unoptimised and quite slow. It is best used
 226   with --rebuild, to force ikiwiki to get the ctime for all pages.
 227
 228 # AUTHOR
 229
 230 Joey Hess <joey@kitenet.net>
 231
 232 Warning: this page is automatically made into ikiwiki's man page, edit with care