aboutsummaryrefslogtreecommitdiff
path: root/doc/usage.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2010-02-28 00:12:47 -0500
committerJoey Hess <joey@gnu.kitenet.net>2010-02-28 00:12:47 -0500
commit60d2dd318f66563c3ee3bde950d7f53426530acc (patch)
treec540152a29cc4112124a6432ef77e9d186e39257 /doc/usage.mdwn
parent70972b16874583bb642b093fb9906a0967d69ac3 (diff)
downloadikiwiki-60d2dd318f66563c3ee3bde950d7f53426530acc.tar
ikiwiki-60d2dd318f66563c3ee3bde950d7f53426530acc.tar.gz
Add new --clean option; this makes ikiwiki remove all built files in the destdir, as well as wrappers and the .ikiwiki directory.
Diffstat (limited to 'doc/usage.mdwn')
-rw-r--r--doc/usage.mdwn8
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index e4808d4c2..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