doc update, add --exclude ikiwiki.cgi to examples

diff --git a/IkiWiki/Plugin/rsync.pm b/IkiWiki/Plugin/rsync.pm
index a62347a44d1fdfe708f7af03ceaafe4b5bc5b3b9..f14989ff835ac929675666ee91cd3a5d68f8261b 100644 (file)
--- a/IkiWiki/Plugin/rsync.pm
+++ b/IkiWiki/Plugin/rsync.pm
@@ -18,7 +18,7 @@ sub getsetup () {
                },
                rsync_command => {
                        type => "string",
-                       example => "rsync -qa --delete . user\@host:/path/to/docroot/",
+                       example => "rsync -qa --delete . user\@host:/path/to/docroot/ --exclude ikiwiki.cgi",
                        description => "command to run to sync updated pages",
                        safe => 0,
                        rebuild => 0,

diff --git a/doc/plugins/contrib/rsync.mdwn b/doc/plugins/contrib/rsync.mdwn
deleted file mode 100644 (file)
index 71cd639..0000000
--- a/doc/plugins/contrib/rsync.mdwn
+++ /dev/null
@@ -1,21 +0,0 @@
-[[!template id=plugin name=rsync core=0 author="[[schmonz]]"]]
-
-[[!template id=gitbranch branch=schmonz author="[[schmonz]]"]]
-
-This plugin allows ikiwiki to push generated pages to another host
-by running a command such as `rsync`.
-
-### Usage
-7. Enable automated SSH key exchange between ikiwiki and the remote
-   host. [keychain](http://www.gentoo.org/proj/en/keychain/) makes
-   it easy to use a passphrase-protected key for this purpose. It's
-   also a good idea to specify the exact command line to be permitted
-   in the remote host's `$HOME/.ssh/authorized_keys`.
-7. Set `rsync_command` in your setup file. If you're using a
-   passphrase-protected key, then set `rsync_command` to a shell
-   script which reads `keychain`'s current state before calling
-   `rsync`.
-
-### Implementation details
-* The plugin relies on a new "postrefresh" hook called at the very end of
-  `IkiWiki/Render.pm:refresh()`.

diff --git a/doc/plugins/rsync.mdwn b/doc/plugins/rsync.mdwn
new file mode 100644 (file)
index 0000000..0ab3872
--- /dev/null
+++ b/doc/plugins/rsync.mdwn
@@ -0,0 +1,17 @@
+[[!template id=plugin name=rsync author="[[schmonz]]"]]
+
+This plugin allows ikiwiki to push generated pages to another host
+by running a command such as `rsync`.
+
+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
+
+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.

diff --git a/doc/plugins/contrib/rsync/discussion.mdwn b/doc/plugins/rsync/discussion.mdwn
similarity index 100%
rename from doc/plugins/contrib/rsync/discussion.mdwn
rename to doc/plugins/rsync/discussion.mdwn