doc/usage.mdwn

   1 # NAME
   2
   3 ikiwiki - a wiki compiler
   4
   5 # SYNOPSIS
   6
   7 ikiwiki [options] source templates destination
   8
   9 # DESCRIPTION
  10
  11 `ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from `source` in the [[MarkDown]] language, using the specified html `templates` and writes it out to `destination`.
  12
  13 # OPTIONS
  14
  15 Note that most options can be shortened to single letters.
  16
  17 * --wikiname
  18
  19   The name of the wiki, default is "wiki".
  20
  21 * --verbose
  22
  23   Be vebose about what it's doing.
  24
  25 * --rebuild
  26
  27   Force a rebuild of all pages.
  28
  29 * --wrapper
  30
  31   Generate a [[wrapper]] binary that is hardcoded to do action specified by the other options, using the specified input files and `destination` directory.
  32
  33   The wrapper is designed to be safely made suid and be run by untrusted users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
  34
  35   Note that the generated wrapper will ignore all command line parameters except for --params, which will make it print out the parameters it would run ikiwiki with.
  36
  37 * --svn, --nosvn
  38
  39   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.
  40
  41   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.
  42
  43   Subversion is enabled by default.
  44
  45 * --anonok, --noanonok
  46
  47   If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
  48
  49   By default, anonymous users cannot edit the wiki.
  50
  51 * --cgi
  52
  53   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]].
  54
  55   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.
  56
  57 * --url http://someurl/
  58
  59   Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
  60
  61 * --cgiurl http://someurl/ikiwiki.cgi
  62
  63   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
  64
  65 * --historyurl http://svn.someurl/trunk/[[]]?root=wiki
  66
  67   Specifies the url to link to for page history browsing. In the url, "[[]]" is replaced with the page to browse. It's common to use [[ViewCVS]] for this.
  68
  69 # AUTHOR
  70
  71 Joey Hess <joey@kitenet.net>