]> git.eshelyaron.com Git - emacs.git/commitdiff
Document nnimap-shell-program
authorLars Ingebrigtsen <larsi@gnus.org>
Thu, 26 Jan 2017 18:44:01 +0000 (19:44 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Thu, 26 Jan 2017 18:46:27 +0000 (19:46 +0100)
* lisp/gnus/nnimap.el (nnimap-shell-program): Document
nnimap-shell-program (bug#20651).

lisp/gnus/nnimap.el

index 700e86a0c57bb2b9e0468e88b21d6bf8ec13fdab..5d38924b57625e42b0e94a3976b8164a28bacfab 100644 (file)
@@ -67,7 +67,11 @@ back on `network'.")
                                 (if (listp imap-shell-program)
                                     (car imap-shell-program)
                                   imap-shell-program)
-                              "ssh %s imapd"))
+                              "ssh %s imapd")
+  "What command to execute to connect to an IMAP server.
+This will only be used if the connection type is `shell'.  See
+the `make-network-process' documentation for an explanation of
+the format.)
 
 (defvoo nnimap-inbox nil
   "The mail box where incoming mail arrives and should be split out of.