X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/506bcbac0420a46997ad531961d543e62c011513..64d550b14a38f826c662306d89ebd9f587335658:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index aba213f21..836dda127 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -11,7 +11,7 @@ ikiwiki --setup configfile # DESCRIPTION `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 +`source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to `destination`. Note that most options can be shortened to single letters, and boolean @@ -125,25 +125,25 @@ configuration options of their own. Specify a mode to chmod the wrapper to after creating it. +* --wrappergroup group + + Specify what unix group the wrapper should be owned by. This can be + useful if the wrapper needs to be owned by a group other than the default. + For example, if a project has a repository with multiple committers with + access controlled by a group, it makes sense for the ikiwiki wrappers + to run setgid to that group. + * --notify, --no-notify Enable email notification of commits. This should be used when running ikiwiki as a [[post-commit]] hook. -* --rcs=svn, --no-rcs - - Enable or disable use of a revision control system. - - If you use svn, the `source` directory is assumed to be - a [[Subversion]] working copy. - - If you use git, the `source` directory is assumed to be a clone of the - [[git]] repository. +* --rcs=svn|git|.., --no-rcs - If you use tla, the `source` directory is assumed to be a tla import. + Enable or disable use of a [[revision_control_system|rcs]]. - If you use mercurial, the `source` directory is assumed to be the - [[mercurial]] repository. + The `source` directory will be assumed to be a working copy, or clone, or + whatever the revision control system you select uses. In [[CGI]] mode, with a revision control system enabled, pages edited via the web will be committed. Also, the [[RecentChanges]] link will be placed @@ -154,7 +154,7 @@ configuration options of their own. * --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|rcs/svn]]. * --svnpath trunk @@ -166,12 +166,12 @@ configuration options of their own. * --rss, --norss If rss is set, ikiwiki will generate RSS feeds for pages that inline - a [[blog]]. + a [[ikiwiki/blog]]. * --atom, --noatom If atom is set, ikiwiki will generate Atom feeds for pages that inline - a [[blog]]. + a [[ikiwiki/blog]]. * --pingurl URL @@ -300,6 +300,17 @@ configuration options of their own. using command-line switches, you will rarely need to use this, but it can be useful for the odd option that lacks a command-line switch. +# ENVIRONMENT + +* CC + + This controls what C compiler is used to build wrappers. Default is 'cc'. + +# SEE ALSO + +* [[ikiwiki-mass-rebuild]](8) +* [[ikiwiki-update-wikilist]](1) + # AUTHOR Joey Hess