mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-24 07:20:37 +00:00
Code Issues Releases Activity

* doc/emacs/rmail.texi: Prefer @command to @code for movemail.

Browse Source
This commit is contained in:
Glenn Morris 2017-04-08 19:24:13 -07:00
parent 48536f67e0
commit e9fc0ce7be
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
doc/emacs/rmail.texi
View File

@ -329,7 +329,7 @@ adding or removing this attribute. @xref{Rmail Attributes}.
When you receive mail locally, the operating system places incoming When you receive mail locally, the operating system places incoming
mail for you in a file that we call your @dfn{inbox}. When you start mail for you in a file that we call your @dfn{inbox}. When you start
up Rmail, it runs a C program called @code{movemail} to copy the new up Rmail, it runs a C program called @command{movemail} to copy the new
messages from your local inbox into your primary Rmail file, which messages from your local inbox into your primary Rmail file, which
also contains other messages saved from previous Rmail sessions. It also contains other messages saved from previous Rmail sessions. It
is in this file that you actually read the mail with Rmail. This is in this file that you actually read the mail with Rmail. This
@ -397,7 +397,7 @@ check your mail via POP while traveling, so that your mail will remain
on the server and you can save it later on your workstation. on the server and you can save it later on your workstation.
In some cases, Rmail copies the new mail from the inbox file In some cases, Rmail copies the new mail from the inbox file
indirectly. First it runs the @code{movemail} program to move the mail indirectly. First it runs the @command{movemail} program to move the mail
from the inbox to an intermediate file called from the inbox to an intermediate file called
@file{.newmail-@var{inboxname}}, in the same directory as the Rmail @file{.newmail-@var{inboxname}}, in the same directory as the Rmail
file. Then Rmail merges the new mail from that file, saves the Rmail file. Then Rmail merges the new mail from that file, saves the Rmail
@ -1373,13 +1373,13 @@ rot13-other-window}. This displays the current buffer in another window
which applies the code when displaying the text. which applies the code when displaying the text.
@node Movemail @node Movemail
@section @code{movemail} program @section @command{movemail} program
@cindex @code{movemail} program @cindex @command{movemail} program
Rmail uses the @code{movemail} program to move mail from your inbox to Rmail uses the @command{movemail} program to move mail from your inbox to
your Rmail file (@pxref{Rmail Inbox}). When loaded for the first time, your Rmail file (@pxref{Rmail Inbox}). When loaded for the first time,
Rmail attempts to locate the @code{movemail} program and determine its Rmail attempts to locate the @command{movemail} program and determine its
version. There are two versions of the @code{movemail} program: the version. There are two versions of the @command{movemail} program: the
GNU Mailutils version (@pxref{movemail,,,mailutils,GNU mailutils}), GNU Mailutils version (@pxref{movemail,,,mailutils,GNU mailutils}),
and an Emacs-specific version that is built and installed unless Emacs and an Emacs-specific version that is built and installed unless Emacs
was configured using the @option{--with-mailutils} option. was configured using the @option{--with-mailutils} option.
@ -1451,7 +1451,7 @@ denotes the name of @code{maildir} mailbox, e.g.,
@item file @item file
Any local mailbox format. Its actual format is detected automatically Any local mailbox format. Its actual format is detected automatically
by @code{movemail}. by @command{movemail}.
@item pop @item pop
A remote mailbox to be accessed via POP3 protocol. @var{user} A remote mailbox to be accessed via POP3 protocol. @var{user}
@ -1478,9 +1478,9 @@ This is equivalent to specifying the @samp{file} protocol:
@vindex rmail-movemail-program @vindex rmail-movemail-program
@vindex rmail-movemail-search-path @vindex rmail-movemail-search-path
The variable @code{rmail-movemail-program} controls which version of The variable @code{rmail-movemail-program} controls which version of
@code{movemail} to use. If that is a string, it specifies the @command{movemail} to use. If that is a string, it specifies the
absolute file name of the @code{movemail} executable. If it is absolute file name of the @command{movemail} executable. If it is
@code{nil}, Rmail searches for @code{movemail} in the directories @code{nil}, Rmail searches for @command{movemail} in the directories
listed in @code{rmail-movemail-search-path}, then in @code{exec-path} listed in @code{rmail-movemail-search-path}, then in @code{exec-path}
(@pxref{Shell}), then in @code{exec-directory}. (@pxref{Shell}), then in @code{exec-directory}.
@ -1520,7 +1520,7 @@ the machine on which to look for the POP server.
@cindex IMAP mailboxes @cindex IMAP mailboxes
Another method for accessing remote mailboxes is IMAP@. This method is Another method for accessing remote mailboxes is IMAP@. This method is
supported only by the Mailutils @code{movemail}. To specify an IMAP supported only by the Mailutils @command{movemail}. To specify an IMAP
mailbox in the inbox list, use the following mailbox @acronym{URL}: mailbox in the inbox list, use the following mailbox @acronym{URL}:
@samp{imap://@var{username}[:@var{password}]@@@var{hostname}:@var{port}}. The @samp{imap://@var{username}[:@var{password}]@@@var{hostname}:@var{port}}. The
@var{password} part is optional, as described above. @var{password} part is optional, as described above.
@ -1545,13 +1545,13 @@ Otherwise, Rmail will ask you for the password to use.
@end enumerate @end enumerate
@vindex rmail-movemail-flags @vindex rmail-movemail-flags
If you need to pass additional command-line flags to @code{movemail}, If you need to pass additional command-line flags to @command{movemail},
set the variable @code{rmail-movemail-flags} a list of the flags you set the variable @code{rmail-movemail-flags} a list of the flags you
wish to use. Do not use this variable to pass the @samp{-p} flag to wish to use. Do not use this variable to pass the @samp{-p} flag to
preserve your inbox contents; use @code{rmail-preserve-inbox} instead. preserve your inbox contents; use @code{rmail-preserve-inbox} instead.
@cindex Kerberos POP authentication @cindex Kerberos POP authentication
The @code{movemail} program installed at your site may support The @command{movemail} program installed at your site may support
Kerberos authentication. If it is supported, it is used by default Kerberos authentication. If it is supported, it is used by default
whenever you attempt to retrieve POP mail when whenever you attempt to retrieve POP mail when
@code{rmail-remote-password} and @code{rmail-remote-password-required} @code{rmail-remote-password} and @code{rmail-remote-password-required}
@ -1560,21 +1560,21 @@ are unset.
@cindex reverse order in POP inboxes @cindex reverse order in POP inboxes
Some POP servers store messages in reverse order. If your server does Some POP servers store messages in reverse order. If your server does
this, and you would rather read your mail in the order in which it was this, and you would rather read your mail in the order in which it was
received, you can tell @code{movemail} to reverse the order of received, you can tell @command{movemail} to reverse the order of
downloaded messages by adding the @samp{-r} flag to downloaded messages by adding the @samp{-r} flag to
@code{rmail-movemail-flags}. @code{rmail-movemail-flags}.
@cindex TLS encryption (Rmail) @cindex TLS encryption (Rmail)
Mailutils @code{movemail} supports TLS encryption. If you wish to Mailutils @command{movemail} supports TLS encryption. If you wish to
use it, add the @samp{--tls} flag to @code{rmail-movemail-flags}. use it, add the @samp{--tls} flag to @code{rmail-movemail-flags}.
@node Other Mailbox Formats @node Other Mailbox Formats
@section Retrieving Mail from Local Mailboxes in Various Formats @section Retrieving Mail from Local Mailboxes in Various Formats
If your incoming mail is stored on a local machine in a format other If your incoming mail is stored on a local machine in a format other
than Unix mailbox, you will need the Mailutils @code{movemail} to than Unix mailbox, you will need the Mailutils @command{movemail} to
retrieve it. @xref{Movemail}, for the detailed description of retrieve it. @xref{Movemail}, for the detailed description of
@code{movemail} versions. For example, to access mail from a inbox in @command{movemail} versions. For example, to access mail from a inbox in
@code{maildir} format located in @file{/var/spool/mail/in}, you would @code{maildir} format located in @file{/var/spool/mail/in}, you would
include the following in the Rmail inbox list: include the following in the Rmail inbox list: