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