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 # OPTIONS
  17
  18 Note that most options can be shortened to single letters, and boolean
  19 flags such as --verbose can be negated with --no-verbose.
  20
  21 * --wikiname
  22
  23   The name of the wiki, default is "wiki".
  24
  25 * --verbose
  26
  27   Be vebose about what it's doing.
  28
  29 * --rebuild
  30
  31   Force a rebuild of all pages.
  32
  33 * --fixctime
  34
  35   Pull last changed time for all pages out of the revision control system.
  36   This rarely used option provides a way to get the real creation times of
  37   items in weblogs, for example when building a wiki from a new subversion
  38   checkout. It is unoptimised and quite slow.
  39
  40 * --templatedir
  41
  42   Specify the directory that the page [[templates]] are stored in.
  43   Default is `/usr/share/ikiwiki/templates`.
  44
  45 * --wrapper [file]
  46
  47   Generate a [[wrapper]] binary that is hardcoded to do action specified by
  48   the other options, using the specified input files and `destination`
  49   directory. The filename to use for the wrapper is optional.
  50
  51   The wrapper is designed to be safely made suid and be run by untrusted
  52   users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
  53
  54   Note that the generated wrapper will ignore all command line parameters.
  55
  56 * --wrappermode mode
  57
  58   Specify a mode to chmod the wrapper to after creating it.
  59
  60 * --svn, --nosvn
  61
  62   Enable or disable use of [[subversion]]. If subversion is enabled, the `source` directory is assumed to be a working copy, and is automatically updated before building the wiki.
  63
  64   In [[CGI]] mode, with subversion enabled pages edited via the web will be committed to subversion. Also, the [[RecentChanges]] link will be placed on pages.
  65
  66   Subversion is enabled by default.
  67
  68 * --anonok, --noanonok
  69
  70   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
  71
  72   By default, anonymous users cannot edit the wiki.
  73
  74 * --rss, --norss
  75
  76   If rss is set, ikiwiki will generate rss feeds for pages that inline
  77   a blog.
  78
  79 * --cgi
  80
  81   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]].
  82
  83   To use ikiwiki as a [[CGI]] program you need to use --wrapper to generate a wrapper. The wrapper will generally need to run suid 6755 to the user who owns the `source` and `destination` directories.
  84
  85 * --url http://someurl/
  86
  87   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
  88
  89 * --cgiurl http://someurl/ikiwiki.cgi
  90
  91   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
  92
  93 * --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
  94
  95   Specifies the url to link to for page history browsing. In the url,
  96   "\[[file]]" is replaced with the file to browse. It's common to use
  97   [[ViewCVS]] for this.
  98
  99 * --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
 100
 101   Specifies the url to link to for a diff of changes to a page. In the url,
 102   "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
 103   revision of the page, and "\[[r2]]" is the new revision. It's common to use
 104   [[ViewCVS]] for this.
 105
 106 * --exclude regexp
 107
 108   Specifies a rexexp of source files to exclude from processing.
 109   May be specified multiple times to add to exclude list.
 110
 111 * --adminuser name
 112
 113   Specifies a username of a user who has the powers of a wiki admin.
 114   Currently allows locking of any page, other powers may be added later.
 115   May be specified multiple times for multiple admins.
 116
 117 * --setup configfile
 118
 119   In setup mode, ikiwiki reads the config file, which is really a perl
 120   program that can call ikiwiki internal functions. Uses of this are
 121   various; the normal one is to automatically generate wrappers for a
 122   wiki based on data in a config file.
 123
 124   Note that the wiki will be (re)built as part of the setup process to
 125   ensure that any changes take effect.
 126
 127   [[ikiwiki.setup]] is an example of such a config file.
 128
 129 # AUTHOR
 130
 131 Joey Hess <joey@kitenet.net>
 132
 133 Warning: this page is automatically made into ikiwiki's man page, edit with care