X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/5b818c9f2ac9c9a2d953f29194913036ab26c225..34e8c78c1c9bf65564c1a3086584158e5c3cc415:/doc/plugins/rsync.mdwn

diff --git a/doc/plugins/rsync.mdwn b/doc/plugins/rsync.mdwn
index 0ab3872d9..e48886168 100644
--- a/doc/plugins/rsync.mdwn
+++ b/doc/plugins/rsync.mdwn
@@ -1,4 +1,5 @@
 [[!template id=plugin name=rsync author="[[schmonz]]"]]
+[[!tag type/special-purpose]]
 
 This plugin allows ikiwiki to push generated pages to another host
 by running a command such as `rsync`.
@@ -7,11 +8,12 @@ The command to run is specified by setting `rsync_command` in your setup
 file. The command will be run in your destdir, so something like this
 is a typical command:
 
-	rsync -qa --delete . user\@host:/path/to/docroot/ --exclude ikiwiki.cgi
+	rsync_command => 'rsync -qa --delete . user@host:/path/to/docroot/',
 
 If using rsync over ssh, you will need to enable noninteractive ssh login
 to the remote host. It's also a good idea to specify the exact command line
 to be permitted in the remote host's `$HOME/.ssh/authorized_keys`.
 
-Be sure to exclude the `ikiwiki.cgi` wrapper from being sent to the remote
-host.
+A typical ikiwiki configuration when using this plugin is to disable cgi
+support, so ikiwiki builds a completely static site that can be served from
+the remote host.