summaryrefslogtreecommitdiff
path: root/lisp/gnus/nntp.el
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2018-04-13 19:54:22 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2018-04-13 20:00:52 +0200
commitb7ac2761fc5e58dd48b8b11642d16ba2b4f04c74 (patch)
tree15c6c757ed250957cf3dbaded2797c2234a5a7b2 /lisp/gnus/nntp.el
parentffbb4e8d542df44ced5afd89221b0dfb234d8525 (diff)
downloademacs-b7ac2761fc5e58dd48b8b11642d16ba2b4f04c74.tar.gz
Clean up some defvoo doc strings
* lisp/gnus/nndiary.el: Remove "*" from doc strings from defvoo elements (bug#23392). * lisp/gnus/nndir.el: Ditto * lisp/gnus/nndoc.el: Ditto. * lisp/gnus/nnrss.el: Ditto. * lisp/gnus/nnspool.el: Ditto. * lisp/gnus/nntp.el: Ditto.
Diffstat (limited to 'lisp/gnus/nntp.el')
-rw-r--r--lisp/gnus/nntp.el66
1 files changed, 33 insertions, 33 deletions
diff --git a/lisp/gnus/nntp.el b/lisp/gnus/nntp.el
index 5291919bab5..784240f4ff9 100644
--- a/lisp/gnus/nntp.el
+++ b/lisp/gnus/nntp.el
@@ -48,7 +48,7 @@
"Port number on the physical nntp server.")
(defvoo nntp-server-opened-hook '(nntp-send-mode-reader)
- "*Hook used for sending commands to the server at startup.
+ "Hook used for sending commands to the server at startup.
The default value is `nntp-send-mode-reader', which makes an innd
server spawn an nnrpd server.")
@@ -94,7 +94,7 @@ For indirect connections:
- `nntp-open-via-telnet-and-telnet'")
(defvoo nntp-never-echoes-commands nil
- "*Non-nil means the nntp server never echoes commands.
+ "Non-nil means the nntp server never echoes commands.
It is reported that some nntps server doesn't echo commands. So, you
may want to set this to non-nil in the method for such a server setting
`nntp-open-connection-function' to `nntp-open-ssl-stream' for example.
@@ -103,102 +103,102 @@ variable overrides the nil value of this variable.")
(defvoo nntp-open-connection-functions-never-echo-commands
'(nntp-open-network-stream)
- "*List of functions that never echo commands.
+ "List of functions that never echo commands.
Add or set a function which you set to `nntp-open-connection-function'
to this list if it does not echo commands. Note that a non-nil value
of the `nntp-never-echoes-commands' variable overrides this variable.")
(defvoo nntp-pre-command nil
- "*Pre-command to use with the various nntp-open-via-* methods.
+ "Pre-command to use with the various nntp-open-via-* methods.
This is where you would put \"runsocks\" or stuff like that.")
(defvoo nntp-telnet-command "telnet"
- "*Telnet command used to connect to the nntp server.
+ "Telnet command used to connect to the nntp server.
This command is used by the methods `nntp-open-telnet-stream',
`nntp-open-via-rlogin-and-telnet' and `nntp-open-via-telnet-and-telnet'.")
(defvoo nntp-telnet-switches '("-8")
- "*Switches given to the telnet command `nntp-telnet-command'.")
+ "Switches given to the telnet command `nntp-telnet-command'.")
(defvoo nntp-end-of-line "\r\n"
- "*String to use on the end of lines when talking to the NNTP server.
+ "String to use on the end of lines when talking to the NNTP server.
This is \"\\r\\n\" by default, but should be \"\\n\" when using an indirect
connection method (nntp-open-via-*).")
(defvoo nntp-via-rlogin-command "rsh"
- "*Rlogin command used to connect to an intermediate host.
+ "Rlogin command used to connect to an intermediate host.
This command is used by the methods `nntp-open-via-rlogin-and-telnet'
and `nntp-open-via-rlogin-and-netcat'. The default is \"rsh\", but \"ssh\"
is a popular alternative.")
(defvoo nntp-via-rlogin-command-switches nil
- "*Switches given to the rlogin command `nntp-via-rlogin-command'.
+ "Switches given to the rlogin command `nntp-via-rlogin-command'.
If you use \"ssh\" for `nntp-via-rlogin-command', you may set this to
\(\"-C\") in order to compress all data connections, otherwise set this
to \(\"-t\" \"-e\" \"none\") or (\"-C\" \"-t\" \"-e\" \"none\") if the telnet
command requires a pseudo-tty allocation on an intermediate host.")
(defvoo nntp-via-telnet-command "telnet"
- "*Telnet command used to connect to an intermediate host.
+ "Telnet command used to connect to an intermediate host.
This command is used by the `nntp-open-via-telnet-and-telnet' method.")
(defvoo nntp-via-telnet-switches '("-8")
- "*Switches given to the telnet command `nntp-via-telnet-command'.")
+ "Switches given to the telnet command `nntp-via-telnet-command'.")
(defvoo nntp-netcat-command "nc"
- "*Netcat command used to connect to the nntp server.
+ "Netcat command used to connect to the nntp server.
This command is used by the `nntp-open-netcat-stream' and
`nntp-open-via-rlogin-and-netcat' methods.")
(defvoo nntp-netcat-switches nil
- "*Switches given to the netcat command `nntp-netcat-command'.")
+ "Switches given to the netcat command `nntp-netcat-command'.")
(defvoo nntp-via-user-name nil
- "*User name to log in on an intermediate host with.
+ "User name to log in on an intermediate host with.
This variable is used by the various nntp-open-via-* methods.")
(defvoo nntp-via-user-password nil
- "*Password to use to log in on an intermediate host with.
+ "Password to use to log in on an intermediate host with.
This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
(defvoo nntp-via-address nil
- "*Address of an intermediate host to connect to.
+ "Address of an intermediate host to connect to.
This variable is used by the various nntp-open-via-* methods.")
(defvoo nntp-via-envuser nil
- "*Whether both telnet client and server support the ENVIRON option.
+ "Whether both telnet client and server support the ENVIRON option.
If non-nil, there will be no prompt for a login name.")
(defvoo nntp-via-shell-prompt "bash\\|[$>] *\r?$"
- "*Regular expression to match the shell prompt on an intermediate host.
+ "Regular expression to match the shell prompt on an intermediate host.
This variable is used by the `nntp-open-via-telnet-and-telnet' method.")
(defvoo nntp-large-newsgroup 50
- "*The number of articles which indicates a large newsgroup.
+ "The number of articles which indicates a large newsgroup.
If the number of articles is greater than the value, verbose
messages will be shown to indicate the current status.")
(defvoo nntp-maximum-request 400
- "*The maximum number of the requests sent to the NNTP server at one time.
+ "The maximum number of the requests sent to the NNTP server at one time.
If Emacs hangs up while retrieving headers, set the variable to a
lower value.")
(defvoo nntp-nov-is-evil nil
- "*If non-nil, nntp will never attempt to use XOVER when talking to the server.")
+ "If non-nil, nntp will never attempt to use XOVER when talking to the server.")
(defvoo nntp-xover-commands '("XOVER" "XOVERVIEW")
- "*List of strings that are used as commands to fetch NOV lines from a server.
+ "List of strings that are used as commands to fetch NOV lines from a server.
The strings are tried in turn until a positive response is gotten. If
none of the commands are successful, nntp will just grab headers one
by one.")
(defvoo nntp-nov-gap 5
- "*Maximum allowed gap between two articles.
+ "Maximum allowed gap between two articles.
If the gap between two consecutive articles is bigger than this
variable, split the XOVER request into two requests.")
(defvoo nntp-xref-number-is-evil nil
- "*If non-nil, Gnus never trusts article numbers in the Xref header.
+ "If non-nil, Gnus never trusts article numbers in the Xref header.
Some news servers, e.g., ones running Diablo, run multiple engines
having the same articles but article numbers are not kept synchronized
between them. If you connect to such a server, set this to a non-nil
@@ -206,7 +206,7 @@ value, and Gnus never uses article numbers (that appear in the Xref
header and vary by which engine is chosen) to refer to articles.")
(defvoo nntp-prepare-server-hook nil
- "*Hook run before a server is opened.
+ "Hook run before a server is opened.
If can be used to set up a server remotely, for instance. Say you
have an account at the machine \"other.machine\". This machine has
access to an NNTP server that you can't access locally. You could
@@ -237,11 +237,11 @@ server there that you can connect to. See also
(defvoo nntp-connection-timeout nil
- "*Number of seconds to wait before an nntp connection times out.
+ "Number of seconds to wait before an nntp connection times out.
If this variable is nil, which is the default, no timers are set.")
(defvoo nntp-prepare-post-hook nil
- "*Hook run just before posting an article. It is supposed to be used
+ "Hook run just before posting an article. It is supposed to be used
to insert Cancel-Lock headers.")
(defvoo nntp-server-list-active-group 'try
@@ -1743,26 +1743,26 @@ If SEND-IF-FORCE, only send authinfo to the server if the
;; ==========================================================================
(defvoo nntp-open-telnet-envuser nil
- "*If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.")
+ "If non-nil, telnet session (client and server both) will support the ENVIRON option and not prompt for login name.")
(defvoo nntp-telnet-shell-prompt "bash\\|[$>] *\r?$"
- "*Regular expression to match the shell prompt on the remote machine.")
+ "Regular expression to match the shell prompt on the remote machine.")
(defvoo nntp-rlogin-program "rsh"
- "*Program used to log in on remote machines.
+ "Program used to log in on remote machines.
The default is \"rsh\", but \"ssh\" is a popular alternative.")
(defvoo nntp-rlogin-parameters '("telnet" "-8" "${NNTPSERVER:=news}" "nntp")
- "*Parameters to `nntp-open-rlogin'.
+ "Parameters to `nntp-open-rlogin'.
That function may be used as `nntp-open-connection-function'. In that
case, this list will be used as the parameter list given to rsh.")
(defvoo nntp-rlogin-user-name nil
- "*User name on remote system when using the rlogin connect method.")
+ "User name on remote system when using the rlogin connect method.")
(defvoo nntp-telnet-parameters
'("exec" "telnet" "-8" "${NNTPSERVER:=news}" "nntp")
- "*Parameters to `nntp-open-telnet'.
+ "Parameters to `nntp-open-telnet'.
That function may be used as `nntp-open-connection-function'. In that
case, this list will be executed as a command after logging in
via telnet.")