doc/usage.mdwn

   1 # NAME
   2
   3 ikiwiki - a wiki compiler
   4
   5 # SYNOPSIS
   6
   7 ikiwiki [options] source destination
   8
   9 ikiwiki --setup setupfile
  10
  11 # DESCRIPTION
  12
  13 `ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
  14 `source` in the [[ikiwiki/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.
  27
  28 * --rebuild
  29
  30   Force a rebuild of all pages.
  31
  32 * --setup setupfile
  33
  34   The default action when --setup is specified is to automatically generate
  35   wrappers for a wiki based on data in a setup file, and rebuild the wiki.
  36   If you only want to build any changed pages, you can use --refresh with
  37   --setup.
  38
  39 * --changesetup setupfile
  40
  41   Reads the setup file, adds any configuration changes specified by other
  42   options, and writes the new configuration back to the setup file. Also
  43   updates any configured wrappers. In this mode, the wiki is not fully
  44   rebuilt, unless you also add --rebuild.
  45
  46   Example, to enable some plugins:
  47
  48         ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin calendar
  49
  50 * --dumpsetup setupfile
  51
  52   Causes ikiwiki to write to the specified setup file, dumping out
  53   its current configuration.
  54
  55 * --wrappers
  56
  57   If used with --setup --refresh, this makes it also update any configured
  58   wrappers.
  59
  60 * --clean
  61
  62   This makes ikiwiki clean up by removing any files it generated in the
  63   `destination` directory, as well as any configured wrappers, and the
  64   `.ikiwiki` state directory. This is mostly useful if you're running
  65   ikiwiki in a Makefile to build documentation and want a corresponding
  66   `clean` target.
  67
  68 * --cgi
  69
  70   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
  71   supports editing pages, signing in, and registration.
  72
  73   To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
  74   to generate a wrapper. The wrapper will generally need to run suid 6755 to
  75   the user who owns the `source` and `destination` directories.
  76
  77 * --wrapper [file]
  78
  79   Generate a wrapper binary that is hardcoded to do action specified by
  80   the other options, using the specified input files and `destination`
  81   directory. The filename to use for the wrapper is optional.
  82
  83   The wrapper is designed to be safely made suid and be run by untrusted
  84   users, as a [[post-commit]] hook, or as a [[CGI]].
  85
  86   Note that the generated wrapper will ignore all command line parameters.
  87
  88 * --aggregate
  89
  90   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
  91   configured feeds and save new posts to the srcdir.
  92
  93   Note that to rebuild previously aggregated posts, use the --rebuild option
  94   along with this one. --rebuild will also force feeds to be polled even if
  95   they were polled recently.
  96
  97 * --render file
  98
  99   Renders a single file, outputting the resulting html. Does not save state,
 100   so this cannot be used for building whole wikis, but it is useful for
 101   previewing an edited file at the command line. Generally used in conjunction
 102   with --setup to load in a wiki's setup:
 103
 104         ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
 105
 106 * --post-commit
 107
 108   Run in post-commit mode, the same as if called by a [[post-commit]] hook.
 109   This is probably only useful when using ikiwiki with a web server on one host
 110   and a repository on another, to allow the repository's real post-commit
 111   hook to ssh to the web server host and manually run ikiwiki to update
 112   the web site.
 113
 114 * --version
 115
 116   Print ikiwiki's version number.
 117
 118 # CONFIG OPTIONS
 119
 120 These options configure the wiki. Note that [[plugins]] can add additional
 121 configuration options of their own. All of these options and more besides can
 122 also be configured using a setup file.
 123
 124 * --wikiname name
 125
 126   The name of the wiki, default is "wiki".
 127
 128 * --templatedir dir
 129
 130   Specify the directory that [[templates|templates]] are stored in.
 131   Default is `/usr/share/ikiwiki/templates`, or another location as configured at
 132   build time. If the templatedir is changed, missing templates will still
 133   be searched for in the default location as a fallback. Templates can also be
 134   placed in the "templates/" subdirectory of the srcdir.
 135
 136   Note that if you choose to copy and modify ikiwiki's templates, you will need
 137   to be careful to keep them up to date when upgrading to new versions of
 138   ikiwiki. Old versions of templates do not always work with new ikiwiki
 139   versions.
 140
 141 * --underlaydir dir
 142
 143   Specify the directory that is used to underlay the source directory.
 144   Source files will be taken from here unless overridden by a file in the
 145   source directory. Default is `/usr/share/ikiwiki/basewiki` or another
 146   location as configured at build time.
 147
 148 * --wrappermode mode
 149
 150   Specify a mode to chmod the wrapper to after creating it.
 151
 152 * --wrappergroup group
 153
 154   Specify what unix group the wrapper should be owned by. This can be
 155   useful if the wrapper needs to be owned by a group other than the default.
 156   For example, if a project has a repository with multiple committers with
 157   access controlled by a group, it makes sense for the ikiwiki wrappers
 158   to run setgid to that group.
 159
 160 * --rcs=svn|git|.., --no-rcs
 161
 162   Enable or disable use of a [[revision_control_system|rcs]].
 163
 164   The `source` directory will be assumed to be a working copy, or clone, or
 165   whatever the revision control system you select uses.
 166
 167   In [[CGI]] mode, with a revision control system enabled, pages edited via
 168   the web will be committed.
 169
 170   No revision control is enabled by default.
 171
 172 * --svnrepo /svn/wiki
 173
 174   Specify the location of the svn repository for the wiki.
 175
 176 * --svnpath trunk
 177
 178   Specify the path inside your svn repository where the wiki is located.
 179   This defaults to `trunk`; change it if your wiki is at some other path
 180   inside the repository. If your wiki is rooted at the top of the repository,
 181   set svnpath to "".
 182
 183 * --rss, --norss
 184
 185   If rss is set, ikiwiki will default to generating RSS feeds for pages
 186   that inline a [[blog]].
 187
 188 * --allowrss
 189
 190   If allowrss is set, and rss is not set, ikiwiki will not default to
 191   generating RSS feeds, but setting `rss=yes` in the inline directive can
 192   override this default and generate a feed.
 193
 194 * --atom, --noatom
 195
 196   If atom is set, ikiwiki will default to generating Atom feeds for pages
 197   that inline a [[blog]].
 198
 199 * --allowatom
 200
 201   If allowatom is set, and rss is not set, ikiwiki will not default to
 202   generating Atom feeds, but setting `atom=yes` in the inline directive can
 203   override this default and generate a feed.
 204
 205 * --pingurl URL
 206
 207   Set this to the URL of an XML-RPC service to ping when an RSS feed is
 208   updated. For example, to ping Technorati, use the URL
 209   http://rpc.technorati.com/rpc/ping
 210
 211   This parameter can be specified multiple times to specify more than one
 212   URL to ping.
 213
 214 * --url URL
 215
 216   Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
 217
 218 * --cgiurl http://example.org/ikiwiki.cgi
 219
 220   Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
 221   building the wiki for links to the cgi script to be generated.
 222
 223 * --historyurl URL
 224
 225   Specifies the URL to link to for page history browsing. In the URL,
 226   "\[[file]]" is replaced with the file to browse. It's common to use
 227   [[ViewVC]] for this.
 228
 229 * --adminemail you@example.org
 230
 231   Specifies the email address that ikiwiki should use for sending email.
 232
 233 * --diffurl URL
 234
 235   Specifies the URL to link to for a diff of changes to a page. In the URL,
 236   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 237   revision of the page, and "\[[r2]]" is the new revision. It's common to use
 238   [[ViewVC]] for this.
 239
 240 * --exclude regexp
 241
 242   Specifies a rexexp of source files to exclude from processing.
 243   May be specified multiple times to add to exclude list.
 244
 245 * --include regexp
 246
 247   Specifies a rexexp of source files, that would normally be excluded,
 248   but that you wish to include in processing.
 249   May be specified multiple times to add to include list.
 250
 251 * --adminuser name
 252
 253   Specifies a username of a user (or, if openid is enabled, an openid)
 254   who has the powers of a wiki admin. Currently allows locking of any page,
 255   and [[banning|banned_users]] users, as well as powers granted by
 256   enabled plugins (such as [[moderating comments|plugins/moderatedcomments]]
 257   and [[plugins/websetup]]. May be specified multiple times for multiple
 258   admins.
 259
 260   For an openid user specify the full URL of the login, including "http://".
 261
 262 * --plugin name
 263
 264   Enables the use of the specified [[plugin|plugins]] in the wiki.
 265   Note that plugin names are case sensitive.
 266
 267 * --disable-plugin name
 268
 269   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
 270   to do away with HTML sanitization.
 271
 272 * --libdir directory
 273
 274   Makes ikiwiki look in the specified directory first, before the regular
 275   locations when loading library files and plugins. For example, if you set
 276   libdir to "/home/you/.ikiwiki/", you can install a foo.pm plugin as
 277   "/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".
 278
 279 * --discussion, --no-discussion
 280
 281   Enables or disables "Discussion" links from being added to the header of
 282   every page. The links are enabled by default.
 283
 284 * --numbacklinks n
 285
 286   Controls how many backlinks should be displayed at the bottom of a page.
 287   Excess backlinks will be hidden in a popup. Default is 10. Set to 0 to
 288   disable this feature.
 289
 290 * --userdir subdir
 291
 292   Optionally, allows links to users of the wiki to link to pages inside a
 293   subdirectory of the wiki. The default is to link to pages in the toplevel
 294   directory of the wiki.
 295
 296 * --htmlext html
 297
 298   Configures the extension used for generated html files. Default is "html".
 299
 300 * --timeformat format
 301
 302   Specify how to display the time or date. The format string is passed to the
 303   strftime(3) function.
 304
 305 * --verbose, --no-verbose
 306
 307   Be verbose about what is being done.
 308
 309 * --syslog, --no-syslog
 310
 311   Log to syslog(3).
 312
 313 * --usedirs, --no-usedirs
 314
 315   Toggle creating output files named page/index.html (default) instead of page.html.
 316
 317 * --prefix-directives, --no-prefix-directives
 318
 319   Toggle new '!'-prefixed syntax for preprocessor directives.  ikiwiki currently
 320   defaults to --prefix-directives.
 321
 322 * --w3mmode, --no-w3mmode
 323
 324   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 325   without a web server.
 326
 327 * --sslcookie
 328
 329   Only send cookies over an SSL connection. This should prevent them being
 330   intercepted. If you enable this option then you must run at least the
 331   CGI portion of ikiwiki over SSL.
 332
 333 * --gettime, --no-gettime
 334
 335   Extract creation and modification times for each new page from the
 336   the revision control's log. This is done automatically when building a
 337   wiki for the first time, so you normally do not need to use this option.
 338
 339 * --set var=value
 340
 341   This allows setting an arbitrary configuration variable, the same as if it
 342   were set via a setup file. Since most commonly used options can be
 343   configured using command-line switches, you will rarely need to use this.
 344
 345 * --set-yaml var=value
 346
 347   This is like --set, but it allows setting configuration variables that
 348   use complex data structures, by passing in a YAML document.
 349
 350 # EXAMPLES
 351
 352 * ikiwiki --setup my.setup
 353
 354   Completely (re)build the wiki using the specified setup file.
 355
 356 * ikiwiki --setup my.setup --refresh
 357
 358   Refresh the wiki, using settings from my.setup, and avoid
 359   rebuilding any pages that have not changed. This is faster.
 360
 361 * ikiwiki --setup my.setup --refresh --wrappers
 362
 363   Refresh the wiki, including regnerating all wrapper programs,
 364   but do not rebuild all pages. Useful if you have changed something
 365   in the setup file that does not need a full wiki rebuild to update
 366   all pages, but that you want to immediatly take effect.
 367
 368 # ENVIRONMENT
 369
 370 * CC
 371
 372   This controls what C compiler is used to build wrappers. Default is 'cc'.
 373
 374 * CFLAGS
 375
 376   This can be used to pass options to the C compiler when building wrappers.
 377
 378 # SEE ALSO
 379
 380 * [[ikiwiki-mass-rebuild]](8)
 381 * [[ikiwiki-update-wikilist]](1)
 382 * [[ikiwiki-transition]](1)
 383
 384 # AUTHOR
 385
 386 Joey Hess <joey@ikiwiki.info>
 387
 388 Warning: Automatically converted into a man page by mdwn2man. Edit with care