X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/3a1e6dcb242f4905217028fedea0d96de8960062..d75e4ee12c73d5644df0ca0c368a3bcc2c9d05e2:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 121005ca0..76e293ddc 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -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 @@ -231,9 +231,10 @@ configuration options of their own. * --libdir directory - Makes ikiwiki look in the specified directory first, before the regular perl - library directories. For example, if you set libdir to "/home/you/.ikiwiki/", - you can install plugins in "/home/you/.ikiwiki/IkiWiki/Plugin/". + Makes ikiwiki look in the specified directory first, before the regular + locations when loading library files and plugins. For example, if you set + libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as + "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm". * --discussion, --no-discussion @@ -271,7 +272,7 @@ configuration options of their own. * --usedirs, --no-usedirs - Create output files named page/index.html instead of page.html. + Toggle creating output files named page/index.html (default) instead of page.html. * --w3mmode, --no-w3mmode @@ -299,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