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