dd

diff --git a/doc/index.mdwn b/doc/index.mdwn
index 00a8badf6e6da00b1f17df4b9edf48c1de9b55f9..92d3c9357275baa250cec54898ed9630e6d004a6 100644 (file)
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -10,7 +10,7 @@ the usual design for a Wiki inside-out and backwards.
 
 To use ikiwiki to set up a wiki, you will probably want to use it with a
 revision control system, such as [[Subversion]], for keeping track of past
-versions of pages. ikiwiki can run as a Subversion post-commit hook, so
+versions of pages. ikiwiki can run as a Subversion [[post-commit]] hook, so
 that each committed change to your wiki is immediatly compiled and
 published. (It can also be run by hand, by cron, or integrated with any
 other revision control system.) 

diff --git a/doc/post-commit.mdwn b/doc/post-commit.mdwn
new file mode 100644 (file)
index 0000000..6635d3b
--- /dev/null
+++ b/doc/post-commit.mdwn
@@ -0,0 +1,11 @@
+Here's an example of how to run ikiwiki in a [[Subversion]] post-commit
+hook to automatically update a wiki as commits come in:
+
+       wiki_src=/path/to/checkout
+       wiki_dest=/path/to/web/server
+       svn up -q $wiki_src
+       ikiwiki $wiki_src $wiki_dest --wikiname=MyWiki
+
+This assumes that permissions allow anyone who commits to svn up the
+wiki_src directory and write to wiki_dest. If they don't, you'll need a
+suid wrapper to run the above as a user who can write to both.