(imap-process-connection-type): Improve docstring. Suggested by

Derek Atkins <warlord@MIT.EDU>.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 3b64d54..ac6699d 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -2,6 +2,8 @@
 
        * imap.el (imap-kerberos4-open): Ignore output from ATHENA imtest.
        Tiny patch from Derek Atkins <warlord@MIT.EDU>.
+       (imap-process-connection-type): Improve docstring.  Suggested by
+       Derek Atkins <warlord@MIT.EDU>.
 
 2003-10-31  Teodor Zlatanov  <tzz@beld.net>
 

diff --git a/lisp/imap.el b/lisp/imap.el
index d9653ec..fdd9f97 100644 (file)
--- a/lisp/imap.el
+++ b/lisp/imap.el
@@ -220,7 +220,13 @@ until a successful connection is made."
   :type '(repeat string))
 
 (defcustom imap-process-connection-type nil
-  "*Value for `process-connection-type' to use for Kerberos4 and GSSAPI."
+  "*Value for `process-connection-type' to use for Kerberos4, GSSAPI and SSL.
+The `process-connection-type' variable control type of device
+used to communicate with subprocesses.  Values are nil to use a
+pipe, or t or `pty' to use a pty.  The value has no effect if the
+system has no ptys or if all ptys are busy: then a pipe is used
+in any case.  The value takes effect when a IMAP server is
+opened, changing it after that has no effect.."
   :group 'imap
   :type 'boolean)