aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2009-03-04 04:15:38 +0000
committerGlenn Morris2009-03-04 04:15:38 +0000
commit00cfe22c8b66e78bed05a070eb17c30bc064e045 (patch)
tree508489b1373182d0589dc780d39a8d03a1678b5f
parentee15d7591b3d38fd46c02f814b4c49604ca88cb2 (diff)
downloademacs-00cfe22c8b66e78bed05a070eb17c30bc064e045.tar.gz
emacs-00cfe22c8b66e78bed05a070eb17c30bc064e045.zip
(Rmail Sorting): Add the keybindings associated with each
sort command. Fix `rmail-sort-by-labels' name. Mention sorting from summary. Mention sorts cannot be undone. (Rmail Display): Give an example of how to use goto-address-mode. (Rmail Editing): It's keybindings that are redefined, not commands. Fix some typos. (Movemail): Some minor rewording. (Remote Mailboxes): Emacs movemail supports pop by default. Fix some minor grammatical issues. The "two alternative ways" to specify a POP mailbox are really just one. Remove all reference to the variables rmail-pop-password and rmail-pop-password-required, obsolete since Emacs 22.1. Clarify the four password steps. Emacs movemail can support Kerberos.
-rw-r--r--doc/emacs/ChangeLog16
-rw-r--r--doc/emacs/rmail.texi168
2 files changed, 106 insertions, 78 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog
index ca3877d0abd..191fe22d4ad 100644
--- a/doc/emacs/ChangeLog
+++ b/doc/emacs/ChangeLog
@@ -1,3 +1,19 @@
12009-03-04 Glenn Morris <rgm@gnu.org>
2
3 * rmail.texi (Rmail Sorting): Add the keybindings associated with each
4 sort command. Fix `rmail-sort-by-labels' name. Mention sorting from
5 summary. Mention sorts cannot be undone.
6 (Rmail Display): Give an example of how to use goto-address-mode.
7 (Rmail Editing): It's keybindings that are redefined, not commands.
8 Fix some typos.
9 (Movemail): Some minor rewording.
10 (Remote Mailboxes): Emacs movemail supports pop by default.
11 Fix some minor grammatical issues. The "two alternative ways" to
12 specify a POP mailbox are really just one. Remove all reference to the
13 variables rmail-pop-password and rmail-pop-password-required, obsolete
14 since Emacs 22.1. Clarify the four password steps. Emacs movemail
15 can support Kerberos.
16
12009-03-03 Glenn Morris <rgm@gnu.org> 172009-03-03 Glenn Morris <rgm@gnu.org>
2 18
3 * rmail.texi (Rmail Deletion): Revert previous change, which was 19 * rmail.texi (Rmail Deletion): Revert previous change, which was
diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi
index fd4e9b5a565..d617e4ea0ea 100644
--- a/doc/emacs/rmail.texi
+++ b/doc/emacs/rmail.texi
@@ -1010,37 +1010,44 @@ Rmail summary and buffer.
1010 1010
1011@table @kbd 1011@table @kbd
1012@findex rmail-sort-by-date 1012@findex rmail-sort-by-date
1013@item M-x rmail-sort-by-date 1013@item C-c C-s C-d
1014Sort messages of current Rmail file by date. 1014@itemx M-x rmail-sort-by-date
1015Sort messages of current Rmail buffer by date.
1015 1016
1016@findex rmail-sort-by-subject 1017@findex rmail-sort-by-subject
1017@item M-x rmail-sort-by-subject 1018@item C-c C-s C-s
1018Sort messages of current Rmail file by subject. 1019@itemx M-x rmail-sort-by-subject
1020Sort messages of current Rmail buffer by subject.
1019 1021
1020@findex rmail-sort-by-author 1022@findex rmail-sort-by-author
1021@item M-x rmail-sort-by-author 1023@item C-c C-s C-a
1022Sort messages of current Rmail file by author's name. 1024@itemx M-x rmail-sort-by-author
1025Sort messages of current Rmail buffer by author's name.
1023 1026
1024@findex rmail-sort-by-recipient 1027@findex rmail-sort-by-recipient
1025@item M-x rmail-sort-by-recipient 1028@item C-c C-s C-r
1026Sort messages of current Rmail file by recipient's names. 1029@itemx M-x rmail-sort-by-recipient
1030Sort messages of current Rmail buffer by recipient's names.
1027 1031
1028@findex rmail-sort-by-correspondent 1032@findex rmail-sort-by-correspondent
1029@item M-x rmail-sort-by-correspondent 1033@item C-c C-s C-c
1030Sort messages of current Rmail file by the name of the other 1034@itemx M-x rmail-sort-by-correspondent
1035Sort messages of current Rmail buffer by the name of the other
1031correspondent. 1036correspondent.
1032 1037
1033@findex rmail-sort-by-lines 1038@findex rmail-sort-by-lines
1034@item M-x rmail-sort-by-lines 1039@item C-c C-s C-l
1035Sort messages of current Rmail file by size (number of lines). 1040@itemx M-x rmail-sort-by-lines
1036 1041Sort messages of current Rmail buffer by number of lines.
1037@findex rmail-sort-by-keywords 1042
1038@item M-x rmail-sort-by-keywords @key{RET} @var{labels} @key{RET} 1043@findex rmail-sort-by-labels
1039Sort messages of current Rmail file by labels. The argument 1044@item C-c C-s C-k @key{RET} @var{labels} @key{RET}
1045@itemx M-x rmail-sort-by-labels @key{RET} @var{labels} @key{RET}
1046Sort messages of current Rmail buffer by labels. The argument
1040@var{labels} should be a comma-separated list of labels. The order of 1047@var{labels} should be a comma-separated list of labels. The order of
1041these labels specifies the order of messages; messages with the first 1048these labels specifies the order of messages; messages with the first
1042label come first, messages with the second label come second, and so on. 1049label come first, messages with the second label come second, and so on.
1043Messages which have none of these labels come last. 1050Messages that have none of these labels come last.
1044@end table 1051@end table
1045 1052
1046 The Rmail sort commands perform a @emph{stable sort}: if there is no 1053 The Rmail sort commands perform a @emph{stable sort}: if there is no
@@ -1050,10 +1057,18 @@ example, if you use @code{rmail-sort-by-date} and then
1050@code{rmail-sort-by-author}, messages from the same author appear in 1057@code{rmail-sort-by-author}, messages from the same author appear in
1051order by date. 1058order by date.
1052 1059
1053 With a numeric argument, all these commands reverse the order of 1060 With a prefix argument, all these commands reverse the order of
1054comparison. This means they sort messages from newest to oldest, from 1061comparison. This means they sort messages from newest to oldest, from
1055biggest to smallest, or in reverse alphabetical order. 1062biggest to smallest, or in reverse alphabetical order.
1056 1063
1064 The same keys in the summary buffer run similar functions; for
1065example, @kbd{C-c C-s C-l} runs @code{rmail-summary-sort-by-lines}.
1066Note that these commands always sort the whole Rmail buffer, even if the
1067summary is only showing a subset of messages.
1068
1069 Note that you cannot undo a sort, so you may wish to save the Rmail
1070buffer before sorting it.
1071
1057@node Rmail Display 1072@node Rmail Display
1058@section Display of Messages 1073@section Display of Messages
1059 1074
@@ -1107,12 +1122,18 @@ off this feature, set @code{rmail-highlighted-headers} to @code{nil}.
1107Customize the face @code{rmail-highlight} to adjust the style of the 1122Customize the face @code{rmail-highlight} to adjust the style of the
1108highlighting. 1123highlighting.
1109 1124
1110 You can highlight and activate URLs in incoming messages by adding 1125 You can highlight and activate URLs in incoming messages using
1111the function @code{goto-address-mode} to the hook 1126Goto Address mode:
1112@code{rmail-show-message-hook}. Then you can browse these URLs by 1127
1113clicking on them with @kbd{Mouse-2} (or @kbd{Mouse-1} quickly) or by 1128@c FIXME goto-addr.el commentary says to use goto-address instead.
1114moving to one and typing @kbd{C-c @key{RET}}. @xref{Goto Address 1129@smallexample
1115mode, Activating URLs, Activating URLs}. 1130(add-hook 'rmail-show-message-hook (lambda () (goto-address-mode 1)))
1131@end smallexample
1132
1133@noindent
1134Then you can browse these URLs by clicking on them with @kbd{Mouse-2}
1135(or @kbd{Mouse-1} quickly) or by moving to one and typing @kbd{C-c
1136@key{RET}}. @xref{Goto Address mode, Activating URLs, Activating URLs}.
1116 1137
1117@node Rmail Coding 1138@node Rmail Coding
1118@section Rmail and Coding Systems 1139@section Rmail and Coding Systems
@@ -1149,7 +1170,7 @@ coding system, the result should be readable.
1149@node Rmail Editing 1170@node Rmail Editing
1150@section Editing Within a Message 1171@section Editing Within a Message
1151 1172
1152 Most of the usual Emacs commands are available in Rmail mode, though a 1173 Most of the usual Emacs keybindings are available in Rmail mode, though a
1153few, such as @kbd{C-M-n} and @kbd{C-M-h}, are redefined by Rmail for 1174few, such as @kbd{C-M-n} and @kbd{C-M-h}, are redefined by Rmail for
1154other purposes. However, the Rmail buffer is normally read only, and 1175other purposes. However, the Rmail buffer is normally read only, and
1155most of the letters are redefined as Rmail commands. If you want to 1176most of the letters are redefined as Rmail commands. If you want to
@@ -1167,11 +1188,10 @@ Rmail mode into Rmail Edit mode, another major mode which is nearly the
1167same as Text mode. The mode line indicates this change. 1188same as Text mode. The mode line indicates this change.
1168 1189
1169 In Rmail Edit mode, letters insert themselves as usual and the Rmail 1190 In Rmail Edit mode, letters insert themselves as usual and the Rmail
1170commands are not available. You can edit message body and header 1191commands are not available. You can edit the message body and header
1171fields. When you are finished editing the message, type @kbd{C-c C-c} 1192fields. When you are finished editing the message, type @kbd{C-c C-c}
1172to switch back to Rmail mode. Alternatively, you can return to Rmail 1193to switch back to Rmail mode. Alternatively, you can return to Rmail
1173mode but cancel all the editing that you have done, by typing @kbd{C-c 1194mode but cancel any editing that you have done, by typing @kbd{C-c C-]}.
1174C-]}.
1175 1195
1176@vindex rmail-edit-mode-hook 1196@vindex rmail-edit-mode-hook
1177 Entering Rmail Edit mode runs the hook @code{text-mode-hook}; then 1197 Entering Rmail Edit mode runs the hook @code{text-mode-hook}; then
@@ -1221,27 +1241,27 @@ which applies the code when displaying the text.
1221@section @code{movemail} program 1241@section @code{movemail} program
1222@cindex @code{movemail} program 1242@cindex @code{movemail} program
1223 1243
1224 When invoked for the first time, Rmail attempts to locate the 1244 Rmail uses the @code{movemail} program to move mail from your inbox to
1225@code{movemail} program and determine its version. There are two 1245your Rmail file (@pxref{Rmail Inbox}). When loaded for the first time,
1226versions of @code{movemail} program: the native one, shipped with GNU 1246Rmail attempts to locate the @code{movemail} program and determine its
1227Emacs (the ``emacs version'') and the one included in GNU mailutils 1247version. There are two versions of the @code{movemail} program: the
1228(the ``mailutils version,'' @pxref{movemail,,,mailutils,GNU 1248native one, shipped with GNU Emacs (the ``emacs version'') and the one
1229mailutils}). They support the same command line syntax and the same 1249included in GNU mailutils (the ``mailutils version,''
1230basic subset of options. However, the Mailutils version offers 1250@pxref{movemail,,,mailutils,GNU mailutils}). They support the same
1231additional features. 1251command line syntax and the same basic subset of options. However, the
1232 1252Mailutils version offers additional features.
1233 The Emacs version of @code{movemail} is able to retrieve mail from 1253
1254 The Emacs version of @code{movemail} is able to retrieve mail from the
1234usual UNIX mailbox formats and from remote mailboxes using the POP3 1255usual UNIX mailbox formats and from remote mailboxes using the POP3
1235protocol. 1256protocol.
1236 1257
1237 The Mailutils version is able to handle a wide set of mailbox 1258 The Mailutils version is able to handle a wide set of mailbox
1238formats, such as plain UNIX mailboxes, @code{maildir} and @code{MH} 1259formats, such as plain UNIX mailboxes, @code{maildir} and @code{MH}
1239mailboxes, etc. It is able to retrieve remote mail using POP3 or 1260mailboxes, etc. It is able to access remote mailboxes using the POP3 or
1240IMAP4 protocol, and can retrieve mail from them using a TLS encrypted 1261IMAP4 protocol, and can retrieve mail from them using a TLS encrypted
1241channel. It also accepts mailbox argument in the @acronym{URL} form. 1262channel. It also accepts mailbox arguments in @acronym{URL} form.
1242The detailed description of mailbox @acronym{URL}s can be found in 1263The detailed description of mailbox @acronym{URL}s can be found in
1243@ref{URL,,,mailutils,Mailbox URL Formats}. In short, a @acronym{URL} 1264@ref{URL,,,mailutils,Mailbox URL Formats}. In short, a @acronym{URL} is:
1244is:
1245 1265
1246@smallexample 1266@smallexample
1247@var{proto}://[@var{user}[:@var{password}]@@]@var{host-or-file-name} 1267@var{proto}://[@var{user}[:@var{password}]@@]@var{host-or-file-name}
@@ -1326,14 +1346,12 @@ in @code{exec-directory}.
1326@pindex movemail 1346@pindex movemail
1327 1347
1328 Some sites use a method called POP for accessing users' inbox data 1348 Some sites use a method called POP for accessing users' inbox data
1329instead of storing the data in inbox files. The @code{Emacs 1349instead of storing the data in inbox files. By default, the @code{Emacs
1330movemail} can work with POP if you compile it with the macro 1350movemail} can work with POP (unless the Emacs @code{configure} script
1331@code{MAIL_USE_POP} defined. (You can achieve that by specifying 1351was run with the option @samp{--without-pop}).
1332@samp{--with-pop} when you run @code{configure} during the
1333installation of Emacs.)
1334 1352
1335The Mailutils @code{movemail} by default supports POP, unless it was 1353Similarly, the Mailutils @code{movemail} by default supports POP, unless
1336configured with @samp{--disable-pop} option. 1354it was configured with the @samp{--disable-pop} option.
1337 1355
1338Both versions of @code{movemail} only work with POP3, not with older 1356Both versions of @code{movemail} only work with POP3, not with older
1339versions of POP. 1357versions of POP.
@@ -1341,7 +1359,7 @@ versions of POP.
1341@cindex @env{MAILHOST} environment variable 1359@cindex @env{MAILHOST} environment variable
1342@cindex POP mailboxes 1360@cindex POP mailboxes
1343 No matter which flavor of @code{movemail} you use, you can specify 1361 No matter which flavor of @code{movemail} you use, you can specify
1344POP inbox by using POP @dfn{URL} (@pxref{Movemail}). A POP 1362a POP inbox by using a POP @dfn{URL} (@pxref{Movemail}). A POP
1345@acronym{URL} is a ``file name'' of the form 1363@acronym{URL} is a ``file name'' of the form
1346@samp{pop://@var{username}@@@var{hostname}}, where 1364@samp{pop://@var{username}@@@var{hostname}}, where
1347@var{hostname} is the host name or IP address of the remote mail 1365@var{hostname} is the host name or IP address of the remote mail
@@ -1349,18 +1367,17 @@ server and @var{username} is the user name on that server.
1349Additionally, you may specify the password in the mailbox @acronym{URL}: 1367Additionally, you may specify the password in the mailbox @acronym{URL}:
1350@samp{pop://@var{username}:@var{password}@@@var{hostname}}. In this 1368@samp{pop://@var{username}:@var{password}@@@var{hostname}}. In this
1351case, @var{password} takes preference over the one set by 1369case, @var{password} takes preference over the one set by
1352@code{rmail-remote-password}. This is especially useful if you have 1370@code{rmail-remote-password} (see below). This is especially useful
1353several remote mailboxes with different passwords. 1371if you have several remote mailboxes with different passwords.
1354 1372
1355 For backward compatibility, Rmail also supports two alternative ways 1373 For backward compatibility, Rmail also supports an alternative way of
1356of specifying remote POP mailboxes. First, specifying an inbox name 1374specifying remote POP mailboxes. Specifying an inbox name in the form
1357in the form @samp{po:@var{username}:@var{hostname}} is equivalent to 1375@samp{po:@var{username}:@var{hostname}} is equivalent to
1358@samp{pop://@var{username}@@@var{hostname}}. Alternatively, you may 1376@samp{pop://@var{username}@@@var{hostname}}. If you omit the
1359set a ``file name'' of @samp{po:@var{username}} in the inbox list of 1377@var{:hostname} part, the @env{MAILHOST} environment variable specifies
1360an Rmail file. @code{movemail} will handle such a name by opening a 1378the machine on which to look for the POP server.
1361connection to the POP server. In this case, the @env{MAILHOST} 1379
1362environment variable specifies the machine on which to look for the 1380@c FIXME mention --with-hesiod "support Hesiod to get the POP server host"?
1363POP server.
1364 1381
1365@cindex IMAP mailboxes 1382@cindex IMAP mailboxes
1366 Another method for accessing remote mailboxes is IMAP. This method is 1383 Another method for accessing remote mailboxes is IMAP. This method is
@@ -1371,30 +1388,23 @@ mailbox in the inbox list, use the following mailbox @acronym{URL}:
1371 1388
1372@vindex rmail-remote-password 1389@vindex rmail-remote-password
1373@vindex rmail-remote-password-required 1390@vindex rmail-remote-password-required
1374@vindex rmail-pop-password
1375@vindex rmail-pop-password-required
1376 Accessing a remote mailbox may require a password. Rmail uses the 1391 Accessing a remote mailbox may require a password. Rmail uses the
1377following algorithm to retrieve it: 1392following algorithm to retrieve it:
1378 1393
1379@enumerate 1394@enumerate
1380@item 1395@item
1381If the @var{password} is present in mailbox URL (see above), it is 1396If a @var{password} is present in the mailbox URL (see above), it is
1382used. 1397used.
1383@item 1398@item
1399If the variable @code{rmail-remote-password-required} is @code{nil},
1400Rmail assumes no password is required.
1401@item
1384If the variable @code{rmail-remote-password} is non-@code{nil}, its 1402If the variable @code{rmail-remote-password} is non-@code{nil}, its
1385value is used. 1403value is used.
1386@item 1404@item
1387Otherwise, if @code{rmail-remote-password-required} is non-@code{nil}, 1405Otherwise, Rmail will ask you for the password to use.
1388then Rmail will ask you for the password to use.
1389@item
1390Otherwise, Rmail assumes no password is required.
1391@end enumerate 1406@end enumerate
1392 1407
1393 For compatibility with previous versions, the variables
1394@code{rmail-pop-password} and @code{rmail-pop-password-required} may
1395be used instead of @code{rmail-remote-password} and
1396@code{rmail-remote-password-required}.
1397
1398@vindex rmail-movemail-flags 1408@vindex rmail-movemail-flags
1399 If you need to pass additional command-line flags to @code{movemail}, 1409 If you need to pass additional command-line flags to @code{movemail},
1400set the variable @code{rmail-movemail-flags} a list of the flags you 1410set the variable @code{rmail-movemail-flags} a list of the flags you
@@ -1403,10 +1413,12 @@ preserve your inbox contents; use @code{rmail-preserve-inbox} instead.
1403 1413
1404@cindex Kerberos POP authentication 1414@cindex Kerberos POP authentication
1405 The @code{movemail} program installed at your site may support 1415 The @code{movemail} program installed at your site may support
1406Kerberos authentication. If it is 1416Kerberos authentication (the Emacs @code{movemail} does so if Emacs was
1407supported, it is used by default whenever you attempt to retrieve 1417configured with the option @code{--with-kerberos} or
1408POP mail when @code{rmail-pop-password} and 1418@code{--with-kerberos5}). If it is supported, it is used by default
1409@code{rmail-pop-password-required} are unset. 1419whenever you attempt to retrieve POP mail when
1420@code{rmail-remote-password} and @code{rmail-remote-password-required}
1421are unset.
1410 1422
1411@cindex reverse order in POP inboxes 1423@cindex reverse order in POP inboxes
1412 Some POP servers store messages in reverse order. If your server does 1424 Some POP servers store messages in reverse order. If your server does