]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/usage.mdwn
added --hyperestraier switch, which turns on search support
[ikiwiki.git] / doc / usage.mdwn
index 0377014fd431d0344999775715569049b49a5173..228d4e5951b630a9eacd07f43512aed9fe527b8b 100644 (file)
@@ -4,33 +4,41 @@ ikiwiki - a wiki compiler
 
 # SYNOPSIS
 
-ikiwiki [options] source templates destination
+ikiwiki [options] source destination
 
 ikiwiki --setup configfile
 
 # DESCRIPTION
 
 `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`.
-
-# OPTIONS
+`source` in the [[MarkDown]] language, and writes it out to `destination`.
 
 Note that most options can be shortened to single letters, and boolean
 flags such as --verbose can be negated with --no-verbose.
 
-* --wikiname
+# MODE OPTIONS
 
-  The name of the wiki, default is "wiki".
+These options control the mode that ikiwiki is operating in.
 
-* --verbose
+* --refresh
 
-  Be vebose about what it's doing.
+  Refresh the wiki, updating any changes pages. This is the default
+  behavior so you don't normally need to specify it.
 
 * --rebuild
 
   Force a rebuild of all pages.
 
+* --cgi
+
+  Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
+  supports editing pages, signing in, registration, and displaying
+  [[RecentChanges]].
+
+  To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup
+  to generate a wrapper. The wrapper will generally need to run suid 6755 to
+  the user who owns the `source` and `destination` directories.
+
 * --wrapper [file]
 
   Generate a [[wrapper]] binary that is hardcoded to do action specified by
@@ -40,9 +48,45 @@ flags such as --verbose can be negated with --no-verbose.
   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]].
 
-  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.
+  Note that the generated wrapper will ignore all command line parameters.
+
+* --setup configfile
+
+  In setup mode, ikiwiki reads the config file, which is really a perl
+  program that can call ikiwiki internal functions.
+
+  The default action when --setup is specified is to automatically generate
+  wrappers for a wiki based on data in a config file, and rebuild the wiki.
+  If you also pass the --refresh option, ikiwiki will instead just refresh
+  the wiki described in the setup file.
+
+  [[ikiwiki.setup]] is an example of such a config file.
+
+# CONFIG OPTIONS
+
+These options configure the wiki.
+
+* --wikiname
+
+  The name of the wiki, default is "wiki".
+
+* --fixctime
+
+  Pull last changed time for all pages out of the revision control system.
+  This rarely used option provides a way to get the real creation times of
+  items in weblogs, for example when building a wiki from a new subversion
+  checkout. It is unoptimised and quite slow.
+
+* --templatedir
+
+  Specify the directory that the page [[templates]] are stored in.
+  Default is `/usr/share/ikiwiki/templates`.
+
+* --underlaydir
+
+  Specify the directory that is used to underlay the source directory.
+  Source files will be taken from here unless overridden by a file in the
+  source directory. Default is `/usr/share/ikiwiki/basewiki`.
 
 * --wrappermode mode
 
@@ -62,11 +106,10 @@ flags such as --verbose can be negated with --no-verbose.
 
   By default, anonymous users cannot edit the wiki.
 
-* --cgi
+* --rss, --norss
 
-  Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]].
-
-  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.
+  If rss is set, ikiwiki will generate rss feeds for pages that inline
+  a blog.
 
 * --url http://someurl/
 
@@ -76,27 +119,41 @@ flags such as --verbose can be negated with --no-verbose.
 
   Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
 
-* --historyurl http://svn.someurl/trunk/[[]]?root=wiki
+* --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki
+
+  Specifies the url to link to for page history browsing. In the url,
+  "\[[file]]" is replaced with the file to browse. It's common to use
+  [[ViewCVS]] for this.
 
-  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.
+* --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+
+  Specifies the url to link to for a diff of changes to a page. In the url,
+  "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old
+  revision of the page, and "\[[r2]]" is the new revision. It's common to use
+  [[ViewCVS]] for this.
 
 * --exclude regexp
 
   Specifies a rexexp of source files to exclude from processing.
   May be specified multiple times to add to exclude list.
 
-* --setup configfile
+* --adminuser name
 
-  In setup mode, ikiwiki reads the config file, which is really a perl
-  program that can call ikiwiki internal functions. Uses of this are
-  various; the normal one is to automatically generate wrappers for a
-  wiki based on data in a config file.
-  
-  Note that the wiki will be (re)built as part of the setup process to
-  ensure that any changes take effect.
+  Specifies a username of a user who has the powers of a wiki admin.
+  Currently allows locking of any page, other powers may be added later.
+  May be specified multiple times for multiple admins.
 
-  [[ikiwiki.setup]] is an example of such a config file.
+* --hyperestraier
+
+  Enables use of the [[HyperEstraier]] search engine for full test page
+  searches.
+
+* --verbose
+
+  Be vebose about what it's doing.
 
 # AUTHOR
 
 Joey Hess <joey@kitenet.net>
+
+Warning: this page is automatically made into ikiwiki's man page, edit with care