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