]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/usage.mdwn
web commit by http://id.inelegant.org/
[git.ikiwiki.info.git] / doc / usage.mdwn
index c4d1f5818627b9327e8c583a416a182fec079748..24a5515e0947f4b1789616e89a74fd16f16f0f1e 100644 (file)
@@ -10,15 +10,16 @@ ikiwiki --setup configfile
 
 # DESCRIPTION
 
-`ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from
-`source` in the [[MarkDown]] language, and writes it out to `destination`.
+`ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
+`source` in the [[Markdown]] language (or others), 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.
 
 # MODE OPTIONS
 
-These options control the mode that ikiwiki is operating in.
+These options control the mode that ikiwiki operates in.
 
 * --refresh
 
@@ -46,7 +47,7 @@ These options control the mode that ikiwiki is operating in.
   directory. The filename to use for the wrapper is optional.
 
   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]].
+  users, as a [[post-commit]] hook, or as a [[CGI]].
 
   Note that the generated wrapper will ignore all command line parameters.
 
@@ -55,16 +56,44 @@ These options control the mode that ikiwiki is operating in.
   In setup mode, ikiwiki reads the config file, which is really a perl
   program that can call ikiwiki internal functions.
 
+  [[ikiwiki.setup]] is an example of such a config file.
+
   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.
+  If you only want to build any changed pages, you can use --refresh with
+  --setup.
 
-  [[ikiwiki.setup]] is an example of such a config file.
+* --wrappers
+
+  If used with --setup --refresh, this makes it also update any configured
+  wrappers.
+
+* --aggregate
+
+  If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
+  configured feeds and save new posts to the srcdir.
+
+  Note that to rebuild previously aggregated posts, use the --rebuild option
+  along with this one. --rebuild will also force feeds to be polled even if
+  they were polled recently.
+
+* --render file
+
+  Renders a single file, outputting the resulting html. Does not save state,
+  so this cannot be used for building whole wikis, but it is useful for
+  previewing an edited file at the command line. Generally used in conjunction
+  with --setup to load in a wiki's setup:
+
+       ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
+
+* --version
+
+  Print ikiwiki's version number.
 
 # CONFIG OPTIONS
 
-These options configure the wiki.
+These options configure the wiki. Note that [[plugins]] can add additional
+configuration options of their own.
 
 * --wikiname
 
@@ -72,14 +101,17 @@ These options configure the wiki.
 
 * --templatedir
 
-  Specify the directory that the page [[templates]] are stored in.
-  Default is `/usr/share/ikiwiki/templates`.
+  Specify the directory that the page [[templates]] are stored in. Default
+  is `/usr/share/ikiwiki/templates`, or another location as configured at
+  build time. If the templatedir is changed, missing templates will still
+  be searched for in the default location as a fallback.
 
 * --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`.
+  source directory. Default is `/usr/share/ikiwiki/basewiki` or another
+  location as configured at build time.
 
 * --wrappermode mode
 
@@ -88,67 +120,84 @@ These options configure the wiki.
 * --notify
 
   Enable email notification of commits. This should be used when running
-  ikiwiki as a [[Subversion]] [[post-commit]] hook.
+  ikiwiki as a [[post-commit]] hook.
+
+* --rcs=svn, --no-rcs
+
+  Enable or disable use of a revision control system.
 
-* --svn, --nosvn
+  If you use svn, the `source` directory is assumed to be
+  a [[Subversion]] working copy.
 
-  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. 
+  If you use git, the `source` directory is assumed to be a clone of the
+  [[git]] repository.
 
-  In [[CGI]] mode, with subversion enabled pages edited via the web will be
-  committed to subversion. Also, the [[RecentChanges]] link will be placed
+  If you use tla, the `source` directory is assumed to be a tla import.
+
+  If you use mercurial, the `source` directory is assumed to be the
+  [[mercurial]] repository.
+
+  In [[CGI]] mode, with a revision control system enabled, pages edited via
+  the web will be committed. Also, the [[RecentChanges]] link will be placed
   on pages.
 
-  Subversion is enabled by default.
+  No revision control is enabled by default.
 
 * --svnrepo /svn/wiki
 
   Specify the location of the svn repository for the wiki. This is required
-  for using --notify with [[subversion]].
+  for using --notify with [[Subversion]].
 
 * --svnpath trunk
 
-  Specify the path inside your svn reporistory where the wiki is located.
-  This defaults to trunk; change it if your wiki is at some other location
+  Specify the path inside your svn repository where the wiki is located.
+  This defaults to `trunk`; change it if your wiki is at some other path
   inside the repository.
 
-* --anonok, --noanonok
-
-  If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki.
+* --rss, --norss
 
-  By default, anonymous users cannot edit the wiki.
+  If rss is set, ikiwiki will generate RSS feeds for pages that inline
+  a [[blog]].
 
-* --rss, --norss
+* --atom, --noatom
 
-  If rss is set, ikiwiki will generate rss feeds for pages that inline
+  If atom is set, ikiwiki will generate Atom feeds for pages that inline
   a [[blog]].
 
-* --url http://url/
+* --pingurl URL
+
+  Set this to the URL of an XML-RPC service to ping when an RSS feed is
+  updated. For example, to ping Technorati, use the URL
+  http://rpc.technorati.com/rpc/ping
+
+  This parameter can be specified multiple times to specify more than one
+  URL to ping.
+
+* --url URL
 
-  Specifies the url to the wiki. This is a required parameter in [[CGI]] mode.
+  Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
 
-* --cgiurl http://url/ikiwiki.cgi
+* --cgiurl http://example.org/ikiwiki.cgi
 
-  Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
+  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://url/trunk/\[[file]]?root=wiki
+* --historyurl URL
 
-  Specifies the url to link to for page history browsing. In the url,
+  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.
+  [[ViewVC]] for this.
 
-* --adminemail you@yourhost
+* --adminemail you@example.org
 
   Specifies the email address that ikiwiki should use for sending email.
 
-* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]]
+* --diffurl URL
 
-  Specifies the url to link to for a diff of changes to a page. In the url,
+  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.
+  [[ViewVC]] for this.
 
 * --exclude regexp
 
@@ -158,37 +207,64 @@ These options configure the wiki.
 * --adminuser name
 
   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.
+  Currently allows locking of any page; other powers may be added later.
   May be specified multiple times for multiple admins.
 
-* --sanitize
+* --plugin name
 
-  Enable [[HtmlSanitization]] of wiki content. On by default, disable with
-  --no-sanitize.
+  Enables the use of the specified [[plugin|plugins]] in the wiki. 
+  Note that plugin names are case sensitive.
 
-* --plugin name
+* --disable-plugin name
+
+  Disables use of a plugin. For example "--disable-plugin htmlscrubber"
+  to do away with HTML sanitization.
+
+* --discussion, --no-discussion
+
+  Enables or disables "Discussion" links from being added to the header of
+  every page. The links are enabled by default.
+
+* --userdir subdir
+
+  Optionally, allows links to users of the wiki to link to pages inside a
+  subdirectory of the wiki. The default is to link to pages in the toplevel
+  directory of the wiki.
+
+* --timeformat format
+
+  Specify how to display the time or date. The format string is passed to the
+  strftime(3) function.
+
+* --verbose, --no-verbose
+
+  Be verbose about what is being done.
+
+* --syslog, --no-syslog
 
-  Enables the use of the specified plugin in the wiki. See [[plugins]] for
-  details. Note that plugin names are case sensative.
+  Log to syslog(3).
 
-* --hyperestraier
+* --w3mmode, --no-w3mmode
 
-  Enables use of the [[HyperEstraier]] search engine for full test page
-  searches.
+  Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
+  without a web server.
 
-* --verbose
+* --sslcookie
 
-  Be vebose about what is being done.
+  Only send cookies over an SSL connection. This should prevent them being
+  intercepted. If you enable this option then you must run at least the 
+  CGI portion of ikiwiki over SSL.
 
-* --fixctime
+* --getctime
 
-  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.
+  Pull last changed time for each new page out of the revision control
+  system. This rarely used option provides a way to get the real creation
+  times of items in weblogs, such as when building a wiki from a new
+  Subversion checkout. It is unoptimised and quite slow. It is best used
+  with --rebuild, to force ikiwiki to get the ctime for all pages.
 
 # AUTHOR
 
-Joey Hess <joey@kitenet.net>
+Joey Hess <joey@ikiwiki.info>
 
-Warning: this page is automatically made into ikiwiki's man page, edit with care
+Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://ikiwiki.info/cgi-bin/viewvc.cgi/trunk/mdwn2man?root=ikiwiki&view=markup).  Edit with care