X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/311182a699ca15c7a44bd7cbf9d2c950ea1f48f0..376d0dc9b76a384bc505b4ebc8c70dde4134c220:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index e411b127a..a105d7e59 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -50,6 +50,14 @@ These options control the mode that ikiwiki operates in. If used with --setup --refresh, this makes it also update any configured wrappers. +* --clean + + This makes ikiwiki clean up by removing any files it denerated in the + `destination` directory, as well as any configured wrappers, and the + `.ikiwiki` state directory. This is mostly useful if you're running + ikiwiki in a Makefile to build documentation and want a corresponding + `clean` target. + * --cgi Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and @@ -106,11 +114,11 @@ These options configure the wiki. Note that [[plugins]] can add additional configuration options of their own. All of these options and more besides can also be configured using a setup file. -* --wikiname +* --wikiname name The name of the wiki, default is "wiki". -* --templatedir +* --templatedir dir Specify the directory that the page [[templates|wikitemplates]] are stored in. Default is `/usr/share/ikiwiki/templates`, or another location as configured at @@ -122,7 +130,7 @@ also be configured using a setup file. ikiwiki. Old versions of templates do not always work with new ikiwiki versions. -* --underlaydir +* --underlaydir dir 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 @@ -249,8 +257,8 @@ also be configured using a setup file. 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". + libdir to "/home/you/.ikiwiki/", you can install a foo.pm plugin as + "/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm". * --discussion, --no-discussion @@ -293,7 +301,7 @@ also be configured using a setup file. * --prefix-directives, --no-prefix-directives Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently - defaults to --no-prefix-directives. + defaults to --prefix-directives. * --w3mmode, --no-w3mmode @@ -308,10 +316,10 @@ also be configured using a setup file. * --getctime - Pull last changed time for each new page out of the revision control + Pull creation 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 + VCS checkout. It is unoptimised and quite slow. It is best used with --rebuild, to force ikiwiki to get the ctime for all pages. * --set var=value @@ -345,6 +353,10 @@ also be configured using a setup file. This controls what C compiler is used to build wrappers. Default is 'cc'. +* CFLAGS + + This can be used to pass options to the C compiler when building wrappers. + # SEE ALSO * [[ikiwiki-mass-rebuild]](8)