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