aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc
diff options
context:
space:
mode:
authorRobert Pluim2025-07-28 14:11:50 +0200
committerRobert Pluim2025-07-28 14:11:50 +0200
commit57a9798c22a6d8a75883dfcc1c4430be428d20bb (patch)
tree7ff79c1c66d5cc8bf703c06764ccba5a3361a16b /doc/misc
parenta44e9139c2ff5c07de4cd0f6caa923673c5e1f8b (diff)
downloademacs-57a9798c22a6d8a75883dfcc1c4430be428d20bb.tar.gz
emacs-57a9798c22a6d8a75883dfcc1c4430be428d20bb.zip
Prefer "tls" to "ssl" in documentation
* doc/misc/gnus.texi (NNTP): Refer to 'nntp-open-tls-stream'. (Direct Functions, Customizing the IMAP Connection): Add commentary about desirability of STARTTLS. Correct documentation about use of GnuTLS. Use 'tls in example. * lisp/gnus/nnimap.el (nnimap-server-port): Mention 'tls in preference to 'ssl. * lisp/gnus/nntp.el (nntp-open-connection-function) (nntp-never-echoes-commands): Document 'nntp-open-tls-stream' as preferred to 'nntp-open-ssl-stream'.
Diffstat (limited to 'doc/misc')
-rw-r--r--doc/misc/gnus.texi55
1 files changed, 24 insertions, 31 deletions
diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index 13b4a339987..662f2f21301 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -14089,7 +14089,7 @@ indirect ones (three pre-made).
14089Non-@code{nil} means the nntp server never echoes commands. It is 14089Non-@code{nil} means the nntp server never echoes commands. It is
14090reported that some nntps server doesn't echo commands. So, you may want 14090reported that some nntps server doesn't echo commands. So, you may want
14091to set this to non-@code{nil} in the method for such a server setting 14091to set this to non-@code{nil} in the method for such a server setting
14092@code{nntp-open-connection-function} to @code{nntp-open-ssl-stream} for 14092@code{nntp-open-connection-function} to @code{nntp-open-tls-stream} for
14093example. The default value is @code{nil}. Note that the 14093example. The default value is @code{nil}. Note that the
14094@code{nntp-open-connection-functions-never-echo-commands} variable 14094@code{nntp-open-connection-functions-never-echo-commands} variable
14095overrides the @code{nil} value of this variable. 14095overrides the @code{nil} value of this variable.
@@ -14145,18 +14145,26 @@ functions is also affected by commonly understood variables
14145@findex nntp-open-network-stream 14145@findex nntp-open-network-stream
14146@item nntp-open-network-stream 14146@item nntp-open-network-stream
14147This is the default, and simply connects to some port or other on the 14147This is the default, and simply connects to some port or other on the
14148remote system. If both Emacs and the server supports it, the 14148remote system. If both Emacs and the server supports it, the connection
14149connection will be upgraded to an encrypted @acronym{STARTTLS} 14149will be upgraded to an encrypted @acronym{STARTTLS} connection
14150connection automatically. 14150automatically. If you want to avoid the possibility of a malicious
14151 14151intermediary blocking the use of @acronym{STARTTLS}, use
14152@item network-only 14152@code{nntp-open-tls-stream} instead.
14153The same as the above, but don't do automatic @acronym{STARTTLS} upgrades. 14153
14154@item nntp-open-plain-stream
14155@itemx network-only
14156The same as the above, but don't do automatic @acronym{STARTTLS}
14157upgrades. Only use this if you want anyone to be able to read your
14158traffic.
14154 14159
14155@findex nntp-open-tls-stream 14160@findex nntp-open-tls-stream
14156@item nntp-open-tls-stream 14161@item nntp-open-tls-stream
14157Opens a connection to a server over a @dfn{secure} channel. To use 14162Opens a connection to a server over a @dfn{secure} channel. To use
14158this you must have @uref{https://www.gnu.org/software/gnutls/, GnuTLS} 14163this, your Emacs must have been compiled with GnuTLS support
14159installed. You then define a server as follows: 14164@uref{https://www.gnu.org/software/gnutls/, GnuTLS}. You can check this
14165using the @code{gnutls-available-p} command.
14166
14167You then define a server as follows:
14160 14168
14161@lisp 14169@lisp
14162;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}} 14170;; @r{"nntps" is port 563 and is predefined in our @file{/etc/services}}
@@ -14168,26 +14176,10 @@ installed. You then define a server as follows:
14168 (nntp-address "snews.bar.com")) 14176 (nntp-address "snews.bar.com"))
14169@end lisp 14177@end lisp
14170 14178
14171@c FIXME openssl s_client should be deprecated in favor of gnutls.
14172@findex nntp-open-ssl-stream 14179@findex nntp-open-ssl-stream
14173@item nntp-open-ssl-stream 14180@item nntp-open-ssl-stream
14174Opens a connection to a server over a @dfn{secure} channel. To use 14181This is the old name for @code{nntp-open-tls-stream}, and is
14175this you must have @uref{https://www.openssl.org/, OpenSSL} 14182completely equivalent.
14176@ignore
14177@c Defunct URL, ancient package, so don't mention it.
14178or @uref{ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL, SSLeay}
14179@end ignore
14180installed. You then define a server as follows:
14181
14182@lisp
14183;; @r{"snews" is port 563 and is predefined in our @file{/etc/services}}
14184;; @r{however, @samp{openssl s_client -port} doesn't like named ports.}
14185;;
14186(nntp "snews.bar.com"
14187 (nntp-open-connection-function nntp-open-ssl-stream)
14188 (nntp-port-number 563)
14189 (nntp-address "snews.bar.com"))
14190@end lisp
14191 14183
14192@findex nntp-open-netcat-stream 14184@findex nntp-open-netcat-stream
14193@item nntp-open-netcat-stream 14185@item nntp-open-netcat-stream
@@ -14529,7 +14521,7 @@ Here's an example method that's more complex:
14529 (nnimap-inbox "INBOX") 14521 (nnimap-inbox "INBOX")
14530 (nnimap-split-methods default) 14522 (nnimap-split-methods default)
14531 (nnimap-expunge t) 14523 (nnimap-expunge t)
14532 (nnimap-stream ssl)) 14524 (nnimap-stream tls))
14533@end example 14525@end example
14534 14526
14535@table @code 14527@table @code
@@ -14555,11 +14547,12 @@ How @code{nnimap} should connect to the server. Possible values are:
14555 14547
14556@table @code 14548@table @code
14557@item undecided 14549@item undecided
14558This is the default, and this first tries the @code{ssl} setting, and 14550This is the default, and this first tries the @code{tls} setting, and
14559then tries the @code{network} setting. 14551then tries the @code{network} setting.
14560 14552
14561@item ssl 14553@item tls
14562This uses standard @acronym{TLS}/@acronym{SSL} connections. 14554This uses standard @acronym{TLS}/@acronym{SSL} connections. @code{ssl}
14555is an equivalent but deprecated way to specify this.
14563 14556
14564@item network 14557@item network
14565Non-encrypted and unsafe straight socket connection, but will upgrade 14558Non-encrypted and unsafe straight socket connection, but will upgrade