X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/926c04e844f231622cfe7d74701a878581125188..b17ee42a2775b78329b3d26041f07243ca41841a:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 4fb91b89b..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,6 +125,14 @@ 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 @@ -158,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 @@ -292,6 +300,12 @@ 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)