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