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 * --version
  79
  80   Print ikiwiki version number.
  81
  82 # CONFIG OPTIONS
  83
  84 These options configure the wiki. Note that plugins can add additional
  85 configuration options of their own.
  86
  87 * --wikiname
  88
  89   The name of the wiki, default is "wiki".
  90
  91 * --templatedir
  92
  93   Specify the directory that the page [[templates]] are stored in.
  94   Default is `/usr/share/ikiwiki/templates`, or another location as
  95   configured at build time.
  96
  97 * --underlaydir
  98
  99   Specify the directory that is used to underlay the source directory.
 100   Source files will be taken from here unless overridden by a file in the
 101   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
 102   location as configured at build time.
 103
 104 * --wrappermode mode
 105
 106   Specify a mode to chmod the wrapper to after creating it.
 107
 108 * --notify
 109
 110   Enable email notification of commits. This should be used when running
 111   ikiwiki as a [[post-commit]] hook.
 112
 113 * --rcs=svn, --no-rcs
 114
 115   Enable or disable use of a revision control system.
 116
 117   If you use svn, the `source` directory is assumed to be
 118   a [[Subversion]] working copy.
 119
 120   If you use git, the `source` directory is assumed to be a clone of the
 121   [[git]] repository.
 122
 123   In [[CGI]] mode, with a revision control system enabled pages edited via
 124   the web will be committed. Also, the [[RecentChanges]] link will be placed
 125   on pages.
 126
 127   svn is enabled by default.
 128
 129 * --svnrepo /svn/wiki
 130
 131   Specify the location of the svn repository for the wiki. This is required
 132   for using --notify with [[subversion]].
 133
 134 * --svnpath trunk
 135
 136   Specify the path inside your svn reporistory where the wiki is located.
 137   This defaults to trunk; change it if your wiki is at some other location
 138   inside the repository.
 139
 140 * --anonok, --noanonok
 141
 142   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
 143
 144   By default, anonymous users cannot edit the wiki.
 145
 146 * --rss, --norss
 147
 148   If rss is set, ikiwiki will generate rss feeds for pages that inline
 149   a [[blog]].
 150
 151 * --pingurl url
 152
 153   Set this to the url to an XML-RPC service to ping when an RSS feed is
 154   updated. For example, to ping Technorati, use the url
 155   http://rpc.technorati.com/rpc/ping
 156
 157   This parameter can be specified multiple times to specify more than one
 158   url to ping.
 159
 160 * --url url
 161
 162   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
 163
 164 * --cgiurl http://url/ikiwiki.cgi
 165
 166   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
 167   building the wiki for links to the cgi script to be generated.
 168
 169 * --historyurl url
 170
 171   Specifies the url to link to for page history browsing. In the url,
 172   "\[[file]]" is replaced with the file to browse. It's common to use
 173   [[ViewCVS]] for this.
 174
 175 * --adminemail you@yourhost
 176
 177   Specifies the email address that ikiwiki should use for sending email.
 178
 179 * --diffurl url
 180
 181   Specifies the url to link to for a diff of changes to a page. In the url,
 182   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 183   revision of the page, and "\[[r2]]" is the new revision. It's common to use
 184   [[ViewCVS]] for this.
 185
 186 * --exclude regexp
 187
 188   Specifies a rexexp of source files to exclude from processing.
 189   May be specified multiple times to add to exclude list.
 190
 191 * --adminuser name
 192
 193   Specifies a username of a user who has the powers of a wiki admin.
 194   Currently allows locking of any page, other powers may be added later.
 195   May be specified multiple times for multiple admins.
 196
 197 * --plugin name
 198
 199   Enables the use of the specified [[plugin|plugins]] in the wiki.
 200   Note that plugin names are case sensative.
 201
 202 * --disable-plugin name
 203
 204   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
 205   to do away with html sanitization.
 206
 207 * --discussion, --no-discussion
 208
 209   Enables or disables "Discussion" links from being added to the header of
 210   every page. The links are enabled by default.
 211
 212 * --timeformat format
 213
 214   Specify how to display the time or date. The format string is passed to the
 215   strftime(3) function.
 216
 217 * --verbose, --no-verbose
 218
 219   Be vebose about what is being done.
 220
 221 * --syslog, --no-syslog
 222
 223   Log to syslog.
 224
 225 * --w3mmode, --no-w3mmode
 226
 227   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 228   without a web server.
 229
 230 * --getctime
 231
 232   Pull last changed time for each new page out of the revision control
 233   system. This rarely used option provides a way to get the real creation
 234   times of items in weblogs, for example when building a wiki from a new
 235   subversion checkout. It is unoptimised and quite slow. It is best used
 236   with --rebuild, to force ikiwiki to get the ctime for all pages.
 237
 238 # AUTHOR
 239
 240 Joey Hess <joey@kitenet.net>
 241
 242 Warning: this page is automatically made into ikiwiki's man page, edit with care