David Taylor's fixes for the UIDL code.

svn path=/trunk/; revision=2943

1 files changed, 15 insertions, 5 deletions

diff --git a/fetchmail.man b/fetchmail.man
index 55296cc7..730b89a1 100644
--- a/fetchmail.man
+++ b/fetchmail.man
@@ -238,11 +238,11 @@ the calkling user will be notified by email if this happens.
 .B \--plugin <command>
 (Keyword: plugin)
 The plugin option allows you to use an external program to establish the
-TCP connection.  This is useful if you want to use socks or need some
-special firewalling setup.  The program will be looked up in $PATH and
-it will be passed two arguments: the name of the server and the name of
-the port.  Fetchmail will write to the plugin's stdin and read from
-the plugin's stdout.
+TCP connection.  This is useful if you want to use socks, SSL, ssh, or
+need some special firewalling setup.  The program will be looked up in
+$PATH and can optionally be passed the hostname and port as arguments
+using "%h" and "%p" respectively.  Fetchmail will write to the plugin's
+stdin and read from the plugin's stdout.
 .TP
 .B \--plugout <command>
 (Keyword: plugout)
@@ -1712,6 +1712,16 @@ poll mailhost.net via localhost port 1234 with proto pop3:
 		mailhost.net sleep 20 </dev/null >/dev/null";
 .fi
 
+.PP
+Here's an another example configuration using ssh and the plugin option.
+The queries are made directly on the stdin and stdout of imapd via ssh.
+Note that in this setup, IMAP authentication can be skipped.
+
+.nf
+poll mailhost.net with proto imap and preauth ssh:
+        plugin "ssh %h /usr/sbin/imapd";
+.fi
+
 .SH THE USE AND ABUSE OF MULTIDROP MAILBOXES
 Use the multiple-local-recipients feature with caution -- it can bite.
 Also note that all multidrop features are ineffective in ETRN mode.