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 [[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 [[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, the `source` directory is assumed to be
  98   a [[Subversion]] working copy.
  99
 100   If you use git, the `source` directory is assumed to be a clone of the
 101   [[git]] repository.
 102
 103   In [[CGI]] mode, with a revision control system enabled pages edited via
 104   the web will be committed. Also, the [[RecentChanges]] link will be placed
 105   on pages.
 106
 107   svn is enabled by default.
 108
 109 * --svnrepo /svn/wiki
 110
 111   Specify the location of the svn repository for the wiki. This is required
 112   for using --notify with [[subversion]].
 113
 114 * --svnpath trunk
 115
 116   Specify the path inside your svn reporistory where the wiki is located.
 117   This defaults to trunk; change it if your wiki is at some other location
 118   inside the repository.
 119
 120 * --anonok, --noanonok
 121
 122   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
 123
 124   By default, anonymous users cannot edit the wiki.
 125
 126 * --rss, --norss
 127
 128   If rss is set, ikiwiki will generate rss feeds for pages that inline
 129   a [[blog]].
 130
 131 * --url http://url/
 132
 133   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
 134
 135 * --cgiurl http://url/ikiwiki.cgi
 136
 137   Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
 138   building the wiki for links to the cgi script to be generated.
 139
 140 * --historyurl http://url/trunk/\[[file]]?root=wiki
 141
 142   Specifies the url to link to for page history browsing. In the url,
 143   "\[[file]]" is replaced with the file to browse. It's common to use
 144   [[ViewCVS]] for this.
 145
 146 * --adminemail you@yourhost
 147
 148   Specifies the email address that ikiwiki should use for sending email.
 149
 150 * --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
 151
 152   Specifies the url to link to for a diff of changes to a page. In the url,
 153   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 154   revision of the page, and "\[[r2]]" is the new revision. It's common to use
 155   [[ViewCVS]] for this.
 156
 157 * --exclude regexp
 158
 159   Specifies a rexexp of source files to exclude from processing.
 160   May be specified multiple times to add to exclude list.
 161
 162 * --adminuser name
 163
 164   Specifies a username of a user who has the powers of a wiki admin.
 165   Currently allows locking of any page, other powers may be added later.
 166   May be specified multiple times for multiple admins.
 167
 168 * --plugin name
 169
 170   Enables the use of the specified [[plugin|plugins]] in the wiki.
 171   Note that plugin names are case sensative.
 172
 173 * --disable-plugin name
 174
 175   Disables use of a plugin. For example "--disable-plugin htmlscrubber"
 176   to do away with html sanitization.
 177
 178 * --discussion, --no-discussion
 179
 180   Enables or disables "Discussion" links from being added to the header of
 181   every page. The links are enabled by default.
 182
 183 * --timeformat format
 184
 185   Specify how to display the time or date. The format string is passed to the
 186   strftime(3) function.
 187
 188 * --verbose
 189
 190   Be vebose about what is being done.
 191
 192 * --getctime
 193
 194   Pull last changed time for each new page out of the revision control
 195   system. This rarely used option provides a way to get the real creation
 196   times of items in weblogs, for example when building a wiki from a new
 197   subversion checkout. It is unoptimised and quite slow. It is best used
 198   with --rebuild, to force ikiwiki to get the ctime for all pages.
 199
 200 # AUTHOR
 201
 202 Joey Hess <joey@kitenet.net>
 203
 204 Warning: this page is automatically made into ikiwiki's man page, edit with care