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 operates 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   [[ikiwiki.setup]] is an example of such a config file.
  60
  61   The default action when --setup is specified is to automatically generate
  62   wrappers for a wiki based on data in a config file, and rebuild the wiki.
  63   If you only want to build any changed pages, you can use --refresh with
  64   --setup.
  65
  66 * --wrappers
  67
  68   If used with --setup --refresh, this makes it also update any configured
  69   wrappers.
  70
  71 * --aggregate
  72
  73   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
  74   configured feeds and save new posts to the srcdir.
  75
  76   Note that to rebuild previously aggregated posts, use the --rebuild option
  77   along with this one. --rebuild will also force feeds to be polled even if
  78   they were polled recently.
  79
  80 * --render file
  81
  82   Renders a single file, outputting the resulting html. Does not save state,
  83   so this cannot be used for building whole wikis, but it is useful for
  84   previewing an edited file at the command line. Generally used in conjunction
  85   with --setup to load in a wiki's setup:
  86
  87         ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
  88
  89 * --version
  90
  91   Print ikiwiki's version number.
  92
  93 # CONFIG OPTIONS
  94
  95 These options configure the wiki. Note that [[plugins]] can add additional
  96 configuration options of their own.
  97
  98 * --wikiname
  99
 100   The name of the wiki, default is "wiki".
 101
 102 * --templatedir
 103
 104   Specify the directory that the page [[templates]] are stored in. Default
 105   is `/usr/share/ikiwiki/templates`, or another location as configured at
 106   build time. If the templatedir is changed, missing templates will still
 107   be searched for in the default location as a fallback.
 108
 109 * --underlaydir
 110
 111   Specify the directory that is used to underlay the source directory.
 112   Source files will be taken from here unless overridden by a file in the
 113   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
 114   location as configured at build time.
 115
 116 * --wrappermode mode
 117
 118   Specify a mode to chmod the wrapper to after creating it.
 119
 120 * --notify
 121
 122   Enable email notification of commits. This should be used when running
 123   ikiwiki as a [[post-commit]] hook.
 124
 125 * --rcs=svn, --no-rcs
 126
 127   Enable or disable use of a revision control system.
 128
 129   If you use svn, the `source` directory is assumed to be
 130   a [[Subversion]] working copy.
 131
 132   If you use git, the `source` directory is assumed to be a clone of the
 133   [[git]] repository.
 134
 135   If you use tla, the `source` directory is assumed to be a tla import.
 136
 137   If you use mercurial, the `source` directory is assumed to be the
 138   [[mercurial]] repository.
 139
 140   In [[CGI]] mode, with a revision control system enabled, pages edited via
 141   the web will be committed. Also, the [[RecentChanges]] link will be placed
 142   on pages.
 143
 144   No revision control is enabled by default.
 145
 146 * --svnrepo /svn/wiki
 147
 148   Specify the location of the svn repository for the wiki. This is required
 149   for using --notify with [[Subversion]].
 150
 151 * --svnpath trunk
 152
 153   Specify the path inside your svn repository where the wiki is located.
 154   This defaults to `trunk`; change it if your wiki is at some other path
 155   inside the repository.
 156
 157 * --rss, --norss
 158
 159   If rss is set, ikiwiki will generate RSS feeds for pages that inline
 160   a [[blog]].
 161
 162 * --atom, --noatom
 163
 164   If atom is set, ikiwiki will generate Atom feeds for pages that inline
 165   a [[blog]].
 166
 167 * --pingurl URL
 168
 169   Set this to the URL of an XML-RPC service to ping when an RSS feed is
 170   updated. For example, to ping Technorati, use the URL
 171   http://rpc.technorati.com/rpc/ping
 172
 173   This parameter can be specified multiple times to specify more than one
 174   URL to ping.
 175
 176 * --url URL
 177
 178   Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
 179
 180 * --cgiurl http://example.org/ikiwiki.cgi
 181
 182   Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
 183   building the wiki for links to the cgi script to be generated.
 184
 185 * --historyurl URL
 186
 187   Specifies the URL to link to for page history browsing. In the URL,
 188   "\[[file]]" is replaced with the file to browse. It's common to use
 189   [[ViewVC]] for this.
 190
 191 * --adminemail you@example.org
 192
 193   Specifies the email address that ikiwiki should use for sending email.
 194
 195 * --diffurl URL
 196
 197   Specifies the URL to link to for a diff of changes to a page. In the URL,
 198   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 199   revision of the page, and "\[[r2]]" is the new revision. It's common to use
 200   [[ViewVC]] for this.
 201
 202 * --exclude regexp
 203
 204   Specifies a rexexp of source files to exclude from processing.
 205   May be specified multiple times to add to exclude list.
 206
 207 * --adminuser name
 208
 209   Specifies a username of a user who has the powers of a wiki admin.
 210   Currently allows locking of any page; other powers may be added later.
 211   May be specified multiple times for multiple admins.
 212
 213 * --plugin name
 214
 215   Enables the use of the specified [[plugin|plugins]] in the wiki.
 216   Note that plugin names are case sensitive.
 217
 218 * --disable-plugin name
 219
 220   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
 221   to do away with HTML sanitization.
 222
 223 * --discussion, --no-discussion
 224
 225   Enables or disables "Discussion" links from being added to the header of
 226   every page. The links are enabled by default.
 227
 228 * --userdir subdir
 229
 230   Optionally, allows links to users of the wiki to link to pages inside a
 231   subdirectory of the wiki. The default is to link to pages in the toplevel
 232   directory of the wiki.
 233
 234 * --timeformat format
 235
 236   Specify how to display the time or date. The format string is passed to the
 237   strftime(3) function.
 238
 239 * --verbose, --no-verbose
 240
 241   Be verbose about what is being done.
 242
 243 * --syslog, --no-syslog
 244
 245   Log to syslog(3).
 246
 247 * --w3mmode, --no-w3mmode
 248
 249   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 250   without a web server.
 251
 252 * --sslcookie
 253
 254   Only send cookies over an SSL connection. This should prevent them being
 255   intercepted. If you enable this option then you must run at least the
 256   CGI portion of ikiwiki over SSL.
 257
 258 * --getctime
 259
 260   Pull last changed time for each new page out of the revision control
 261   system. This rarely used option provides a way to get the real creation
 262   times of items in weblogs, such as when building a wiki from a new
 263   Subversion checkout. It is unoptimised and quite slow. It is best used
 264   with --rebuild, to force ikiwiki to get the ctime for all pages.
 265
 266 # AUTHOR
 267
 268 Joey Hess <joey@kitenet.net>
 269
 270 Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://ikiwiki.kitenet.net/cgi-bin/viewvc.cgi/trunk/mdwn2man?root=ikiwiki&view=markup).  Edit with care