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