(no commit message)

[ikiwiki.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index e2fe85ff60d8b5a91901ef9ec235e5b8e09d4b69..a105d7e59b96f5bc37324d09eb5a4a84e4054d2f 100644 (file)
--- 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.
 
   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
 * --cgi
 
   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and


@@ -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
 
   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
 
 
 * --discussion, --no-discussion
 


@@ -308,10 +316,10 @@ also be configured using a setup file.
 
 * --getctime
 
 
 * --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
   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
   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'.
 
 
   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)
 # SEE ALSO
 
 * [[ikiwiki-mass-rebuild]](8)