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 [[MarkDown]] language, and writes it out to `destination`.
  15
  16 Note that most options can be shortened to single letters, and boolean
  17 flags such as --verbose can be negated with --no-verbose.
  18
  19 # MODE OPTIONS
  20
  21 These options control the mode that ikiwiki is operating in.
  22
  23 * --refresh
  24
  25   Refresh the wiki, updating any changed pages. This is the default
  26   behavior so you don't normally need to specify it.
  27
  28 * --rebuild
  29
  30   Force a rebuild of all pages.
  31
  32 * --cgi
  33
  34   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
  35   supports editing pages, signing in, registration, and displaying
  36   [[RecentChanges]].
  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 [[Subversion]] [[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   The default action when --setup is specified is to automatically generate
  59   wrappers for a wiki based on data in a config file, and rebuild the wiki.
  60   If you also pass the --refresh option, ikiwiki will instead just refresh
  61   the wiki described in the setup file.
  62
  63   [[ikiwiki.setup]] is an example of such a config file.
  64
  65 # CONFIG OPTIONS
  66
  67 These options configure the wiki.
  68
  69 * --wikiname
  70
  71   The name of the wiki, default is "wiki".
  72
  73 * --templatedir
  74
  75   Specify the directory that the page [[templates]] are stored in.
  76   Default is `/usr/share/ikiwiki/templates`.
  77
  78 * --underlaydir
  79
  80   Specify the directory that is used to underlay the source directory.
  81   Source files will be taken from here unless overridden by a file in the
  82   source directory. Default is `/usr/share/ikiwiki/basewiki`.
  83
  84 * --wrappermode mode
  85
  86   Specify a mode to chmod the wrapper to after creating it.
  87
  88 * --notify
  89
  90   Enable email notification of commits. This should be used when running
  91   ikiwiki as a [[Subversion]] [[post-commit]] hook.
  92
  93 * --rcs=svn, --no-rcs
  94
  95   Enable or disable use of a revision control system.
  96
  97   If you use svn ([[Subversion]]), the `source` directory is assumed to be
  98   a working copy, and is automatically updated before building the wiki.
  99
 100   In [[CGI]] mode, with a revision control system enabled pages edited via
 101   the web will be committed. Also, the [[RecentChanges]] link will be placed
 102   on pages.
 103
 104   svn is enabled by default.
 105
 106 * --svnrepo /svn/wiki
 107
 108   Specify the location of the svn repository for the wiki. This is required
 109   for using --notify with [[subversion]].
 110
 111 * --svnpath trunk
 112
 113   Specify the path inside your svn reporistory where the wiki is located.
 114   This defaults to trunk; change it if your wiki is at some other location
 115   inside the repository.
 116
 117 * --anonok, --noanonok
 118
 119   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
 120
 121   By default, anonymous users cannot edit the wiki.
 122
 123 * --rss, --norss
 124
 125   If rss is set, ikiwiki will generate rss feeds for pages that inline
 126   a [[blog]].
 127
 128 * --url http://url/
 129
 130   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
 131
 132 * --cgiurl http://url/ikiwiki.cgi
 133
 134   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
 135   building the wiki for links to the cgi script to be generated.
 136
 137 * --historyurl http://url/trunk/\[[file]]?root=wiki
 138
 139   Specifies the url to link to for page history browsing. In the url,
 140   "\[[file]]" is replaced with the file to browse. It's common to use
 141   [[ViewCVS]] for this.
 142
 143 * --adminemail you@yourhost
 144
 145   Specifies the email address that ikiwiki should use for sending email.
 146
 147 * --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
 148
 149   Specifies the url to link to for a diff of changes to a page. In the url,
 150   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 151   revision of the page, and "\[[r2]]" is the new revision. It's common to use
 152   [[ViewCVS]] for this.
 153
 154 * --exclude regexp
 155
 156   Specifies a rexexp of source files to exclude from processing.
 157   May be specified multiple times to add to exclude list.
 158
 159 * --adminuser name
 160
 161   Specifies a username of a user who has the powers of a wiki admin.
 162   Currently allows locking of any page, other powers may be added later.
 163   May be specified multiple times for multiple admins.
 164
 165 * --plugin name
 166
 167   Enables the use of the specified plugin in the wiki. See [[plugins]] for
 168   details. Note that plugin names are case sensative.
 169
 170 * --disable-plugin name
 171
 172   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
 173   to do away with html sanitization.
 174
 175 * --discussion, --no-discussion
 176
 177   Enables or disables "Discussion" links from being added to the header of
 178   every page. The links are enabled by default.
 179
 180 * --timeformat format
 181
 182   Specify how to display the time or date. The format string is passed to the
 183   strftime(3) function.
 184
 185 * --verbose
 186
 187   Be vebose about what is being done.
 188
 189 * --getctime
 190
 191   Pull last changed time for each new page out of the revision control
 192   system. This rarely used option provides a way to get the real creation
 193   times of items in weblogs, for example when building a wiki from a new
 194   subversion checkout. It is unoptimised and quite slow. It is best used
 195   with --rebuild, to force ikiwiki to get the ctime for all pages.
 196
 197 # AUTHOR
 198
 199 Joey Hess <joey@kitenet.net>
 200
 201 Warning: this page is automatically made into ikiwiki's man page, edit with care