summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-03-29 18:27:00 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2007-03-29 18:27:00 +0000
commit03020563327db62bcbecadea700f5f534158cef3 (patch)
treedcfe688d75670664acef46803b82115aba16953d /doc
parent6be1832ce0de17ba83c8e9f2fecd0c045b7c863c (diff)
* Add --post-commit option, which allows for the case of a split web server
and RCS server (or a push mirror). With this the RCS server can have a real post-commit hook that sshs back to the web server, and runs ikiwiki in post-commit mode to update the wiki.
Diffstat (limited to 'doc')
-rw-r--r--doc/usage.mdwn10
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 24a5515e0..3102245b2 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -86,6 +86,14 @@ These options control the mode that ikiwiki operates in.
ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
+* --post-commit
+
+ Run in post-commit mode, the same as if called by a [[post-commit]] hook.
+ This is probably only useful when using ikiwiki with a web server on one host
+ and a repository on another, to allow the repository's real post-commit
+ hook to ssh to the web server host and manually run ikiwiki to update
+ the web site.
+
* --version
Print ikiwiki's version number.
@@ -117,7 +125,7 @@ configuration options of their own.
Specify a mode to chmod the wrapper to after creating it.
-* --notify
+* --notify, --no-notify
Enable email notification of commits. This should be used when running
ikiwiki as a [[post-commit]] hook.