diff options
| -rw-r--r-- | doc/emacs/ChangeLog | 16 | ||||
| -rw-r--r-- | doc/emacs/rmail.texi | 99 |
2 files changed, 72 insertions, 43 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index cbc089b5bef..522caa127ce 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,19 @@ | |||
| 1 | 2009-03-03 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * rmail.texi (Rmail Deletion): Revert previous change, which was | ||
| 4 | describing the Rmail summary versions. | ||
| 5 | (Rmail Reply): Give more details of rmail-dont-reply-to-names. | ||
| 6 | Minor re-wording for rmail-resend. | ||
| 7 | (Rmail Make Summary): Summaries apply to buffers rather than files. | ||
| 8 | <rmail-summary-by-topic>: Headers includes the subject. | ||
| 9 | <rmail-summary-by-recipients, rmail-summary-by-topic>: Give more | ||
| 10 | details, including prefix arguments. | ||
| 11 | Not counting lines might be faster. | ||
| 12 | (Rmail Summary Edit): More details on the delete commands. | ||
| 13 | Add rmail-summary-bury. | ||
| 14 | (Rmail Display): Mention rmail-displayed-headers. Fix typo. | ||
| 15 | Simplify rmail-highlighted-headers description. Update face name. | ||
| 16 | |||
| 1 | 2009-03-02 Juanma Barranquero <lekktu@gmail.com> | 17 | 2009-03-02 Juanma Barranquero <lekktu@gmail.com> |
| 2 | 18 | ||
| 3 | * mark.texi (Marking Objects): Fix typo. | 19 | * mark.texi (Marking Objects): Fix typo. |
diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index c1ea58e52bb..8205dbd7554 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi | |||
| @@ -260,10 +260,10 @@ current message and select another message. @kbd{d} | |||
| 260 | (@code{rmail-delete-forward}) moves to the following message, skipping | 260 | (@code{rmail-delete-forward}) moves to the following message, skipping |
| 261 | messages already deleted, while @kbd{C-d} (@code{rmail-delete-backward}) | 261 | messages already deleted, while @kbd{C-d} (@code{rmail-delete-backward}) |
| 262 | moves to the previous nondeleted message. If there is no nondeleted | 262 | moves to the previous nondeleted message. If there is no nondeleted |
| 263 | message to move to in the specified direction, these commands move to | 263 | message to move to in the specified direction, the message that was just |
| 264 | the last or first message. With a numeric argument, these commands | 264 | deleted remains current. @kbd{d} with a prefix argument is equivalent |
| 265 | delete the specified number of messages. @kbd{d} with a negative | 265 | to @kbd{C-d}. Note that the Rmail summary versions of these commands |
| 266 | numeric argument is equivalent to @kbd{C-d}, and vice versa. | 266 | behave slightly differently (@pxref{Rmail Summary Edit}). |
| 267 | 267 | ||
| 268 | @c mention other hooks, eg show message hook? | 268 | @c mention other hooks, eg show message hook? |
| 269 | @vindex rmail-delete-message-hook | 269 | @vindex rmail-delete-message-hook |
| @@ -698,13 +698,16 @@ sent the message you received, and the @samp{CC} field starts out with | |||
| 698 | all the other recipients of that message. | 698 | all the other recipients of that message. |
| 699 | 699 | ||
| 700 | @vindex rmail-dont-reply-to-names | 700 | @vindex rmail-dont-reply-to-names |
| 701 | You can exclude certain recipients from being placed automatically in | 701 | You can exclude certain recipients from being included automatically |
| 702 | the @samp{CC}, using the variable @code{rmail-dont-reply-to-names}. Its | 702 | in replies, using the variable @code{rmail-dont-reply-to-names}. Its |
| 703 | value should be a regular expression (as a string); any recipient that | 703 | value should be a regular expression (as a string); any recipient that |
| 704 | the regular expression matches, is excluded from the @samp{CC} field. | 704 | the regular expression matches, is excluded from the @samp{CC} field. |
| 705 | The default value matches your own name, and any name starting with | 705 | They are also excluded from the @samp{To} field, unless this would leave |
| 706 | @samp{info-}. (Those names are excluded because there is a convention | 706 | the field empty. If this variables is nil, then the first time you |
| 707 | of using them for large mailing lists to broadcast announcements.) | 707 | compose a reply it is initialized to a default value that matches your |
| 708 | own address, and any name starting with @samp{info-}. (Those names are | ||
| 709 | excluded because there is a convention of using them for large mailing | ||
| 710 | lists to broadcast announcements.) | ||
| 708 | 711 | ||
| 709 | To omit the @samp{CC} field completely for a particular reply, enter | 712 | To omit the @samp{CC} field completely for a particular reply, enter |
| 710 | the reply command with a numeric argument: @kbd{C-u r} or @kbd{1 r}. | 713 | the reply command with a numeric argument: @kbd{C-u r} or @kbd{1 r}. |
| @@ -763,8 +766,8 @@ difference is that resending sends a message that is ``from'' the | |||
| 763 | original sender, just as it reached you---with a few added header fields | 766 | original sender, just as it reached you---with a few added header fields |
| 764 | @samp{Resent-From} and @samp{Resent-To} to indicate that it came via | 767 | @samp{Resent-From} and @samp{Resent-To} to indicate that it came via |
| 765 | you. To resend a message in Rmail, use @kbd{C-u f}. (@kbd{f} runs | 768 | you. To resend a message in Rmail, use @kbd{C-u f}. (@kbd{f} runs |
| 766 | @code{rmail-forward}, which is programmed to invoke @code{rmail-resend} | 769 | @code{rmail-forward}, which invokes @code{rmail-resend} if you provide a |
| 767 | if you provide a numeric argument.) | 770 | numeric argument.) |
| 768 | 771 | ||
| 769 | @kindex m @r{(Rmail)} | 772 | @kindex m @r{(Rmail)} |
| 770 | @findex rmail-mail | 773 | @findex rmail-mail |
| @@ -817,9 +820,9 @@ time. | |||
| 817 | @node Rmail Make Summary | 820 | @node Rmail Make Summary |
| 818 | @subsection Making Summaries | 821 | @subsection Making Summaries |
| 819 | 822 | ||
| 820 | Here are the commands to create a summary for the current Rmail file. | 823 | Here are the commands to create a summary for the current Rmail |
| 821 | Once the Rmail file has a summary buffer, changes in the Rmail file | 824 | buffer. Once the Rmail buffer has a summary, changes in the Rmail |
| 822 | (such as deleting or expunging messages, and getting new mail) | 825 | buffer (such as deleting or expunging messages, and getting new mail) |
| 823 | automatically update the summary. | 826 | automatically update the summary. |
| 824 | 827 | ||
| 825 | @table @kbd | 828 | @table @kbd |
| @@ -837,15 +840,14 @@ Summarize messages that have one or more of the specified recipients | |||
| 837 | Summarize messages that have a match for the specified regexp | 840 | Summarize messages that have a match for the specified regexp |
| 838 | @var{topic} in their subjects (@code{rmail-summary-by-topic}). | 841 | @var{topic} in their subjects (@code{rmail-summary-by-topic}). |
| 839 | @item C-M-s @var{regexp} | 842 | @item C-M-s @var{regexp} |
| 840 | Summarize messages whose headers and the subject line match the | 843 | Summarize messages whose headers match the specified regular expression |
| 841 | specified regular expression @var{regexp} | 844 | @var{regexp} (@code{rmail-summary-by-regexp}). |
| 842 | (@code{rmail-summary-by-regexp}). | ||
| 843 | @end table | 845 | @end table |
| 844 | 846 | ||
| 845 | @kindex h @r{(Rmail)} | 847 | @kindex h @r{(Rmail)} |
| 846 | @findex rmail-summary | 848 | @findex rmail-summary |
| 847 | The @kbd{h} or @kbd{C-M-h} (@code{rmail-summary}) command fills the summary buffer | 849 | The @kbd{h} or @kbd{C-M-h} (@code{rmail-summary}) command fills the summary buffer |
| 848 | for the current Rmail file with a summary of all the messages in the file. | 850 | for the current Rmail buffer with a summary of all the messages in the buffer. |
| 849 | It then displays and selects the summary buffer in another window. | 851 | It then displays and selects the summary buffer in another window. |
| 850 | 852 | ||
| 851 | @kindex l @r{(Rmail)} | 853 | @kindex l @r{(Rmail)} |
| @@ -859,24 +861,28 @@ commas. | |||
| 859 | @kindex C-M-r @r{(Rmail)} | 861 | @kindex C-M-r @r{(Rmail)} |
| 860 | @findex rmail-summary-by-recipients | 862 | @findex rmail-summary-by-recipients |
| 861 | @kbd{C-M-r @var{rcpts} @key{RET}} (@code{rmail-summary-by-recipients}) | 863 | @kbd{C-M-r @var{rcpts} @key{RET}} (@code{rmail-summary-by-recipients}) |
| 862 | makes a partial summary mentioning only the messages that have one or more | 864 | makes a partial summary mentioning only the messages that have one or |
| 863 | of the recipients @var{rcpts}. @var{rcpts} should contain mailing | 865 | more recipients matching the regular expression @var{rcpts}. Commas can |
| 864 | addresses separated by commas. | 866 | be used to separate multiple regular expressions. These are matched |
| 867 | against the @samp{To}, @samp{From}, and @samp{CC} headers (with a prefix | ||
| 868 | argument, this header is not included). | ||
| 865 | 869 | ||
| 866 | @kindex C-M-t @r{(Rmail)} | 870 | @kindex C-M-t @r{(Rmail)} |
| 867 | @findex rmail-summary-by-topic | 871 | @findex rmail-summary-by-topic |
| 868 | @kbd{C-M-t @var{topic} @key{RET}} (@code{rmail-summary-by-topic}) | 872 | @kbd{C-M-t @var{topic} @key{RET}} (@code{rmail-summary-by-topic}) |
| 869 | makes a partial summary mentioning only the messages whose subjects have | 873 | makes a partial summary mentioning only the messages whose subjects have |
| 870 | a match for the regular expression @var{topic}. | 874 | a match for the regular expression @var{topic}. Commas can be used to |
| 875 | separate multiple regular expressions. With a prefix argument, the | ||
| 876 | match is against the whole message, not just the subject. | ||
| 871 | 877 | ||
| 872 | @kindex C-M-s @r{(Rmail)} | 878 | @kindex C-M-s @r{(Rmail)} |
| 873 | @findex rmail-summary-by-regexp | 879 | @findex rmail-summary-by-regexp |
| 874 | @kbd{C-M-s @var{regexp} @key{RET}} (@code{rmail-summary-by-regexp}) | 880 | @kbd{C-M-s @var{regexp} @key{RET}} (@code{rmail-summary-by-regexp}) |
| 875 | makes a partial summary which mentions only the messages whose headers | 881 | makes a partial summary that mentions only the messages whose headers |
| 876 | (including the date and the subject lines) match the regular | 882 | (including the date and the subject lines) match the regular |
| 877 | expression @var{regexp}. | 883 | expression @var{regexp}. |
| 878 | 884 | ||
| 879 | Note that there is only one summary buffer for any Rmail file; | 885 | Note that there is only one summary buffer for any Rmail buffer; |
| 880 | making any kind of summary discards any previous summary. | 886 | making any kind of summary discards any previous summary. |
| 881 | 887 | ||
| 882 | @vindex rmail-summary-window-size | 888 | @vindex rmail-summary-window-size |
| @@ -884,7 +890,8 @@ making any kind of summary discards any previous summary. | |||
| 884 | The variable @code{rmail-summary-window-size} says how many lines to | 890 | The variable @code{rmail-summary-window-size} says how many lines to |
| 885 | use for the summary window. The variable | 891 | use for the summary window. The variable |
| 886 | @code{rmail-summary-line-count-flag} controls whether the summary line | 892 | @code{rmail-summary-line-count-flag} controls whether the summary line |
| 887 | for a message should include the line count of the message. | 893 | for a message should include the line count of the message. Setting |
| 894 | this option to nil might speed up the generation of summaries. | ||
| 888 | 895 | ||
| 889 | @node Rmail Summary Edit | 896 | @node Rmail Summary Edit |
| 890 | @subsection Editing in Summaries | 897 | @subsection Editing in Summaries |
| @@ -904,10 +911,12 @@ Rmail buffer. Thus, @kbd{d} in the summary buffer deletes the current | |||
| 904 | message, @kbd{u} undeletes, and @kbd{x} expunges. (However, in the | 911 | message, @kbd{u} undeletes, and @kbd{x} expunges. (However, in the |
| 905 | summary buffer, a numeric argument to @kbd{d}, @kbd{C-d} and @kbd{u} | 912 | summary buffer, a numeric argument to @kbd{d}, @kbd{C-d} and @kbd{u} |
| 906 | serves as a repeat count. A negative argument reverses the meaning of | 913 | serves as a repeat count. A negative argument reverses the meaning of |
| 907 | @kbd{d} and @kbd{C-d}.) @kbd{o} and @kbd{C-o} output the current | 914 | @kbd{d} and @kbd{C-d}. Also, if there are no more undeleted messages in |
| 908 | message to a file; @kbd{r} starts a reply to it. You can scroll the | 915 | the relevant direction, the delete commands go to the first or last |
| 909 | current message while remaining in the summary buffer using @key{SPC} | 916 | message, rather than staying on the current message.) @kbd{o} and |
| 910 | and @key{DEL}. | 917 | @kbd{C-o} output the current message to a FILE; @kbd{r} starts a reply |
| 918 | to it. You can scroll the current message while remaining in the | ||
| 919 | summary buffer using @key{SPC} and @key{DEL}. | ||
| 911 | 920 | ||
| 912 | The Rmail commands to move between messages also work in the summary | 921 | The Rmail commands to move between messages also work in the summary |
| 913 | buffer, but with a twist: they move through the set of messages included | 922 | buffer, but with a twist: they move through the set of messages included |
| @@ -954,11 +963,15 @@ the screen. | |||
| 954 | @findex rmail-summary-wipe | 963 | @findex rmail-summary-wipe |
| 955 | @kindex q @r{(Rmail summary)} | 964 | @kindex q @r{(Rmail summary)} |
| 956 | @findex rmail-summary-quit | 965 | @findex rmail-summary-quit |
| 966 | @kindex b @r{(Rmail summary)} | ||
| 967 | @findex rmail-summary-bury | ||
| 957 | When you are finished using the summary, type @kbd{Q} | 968 | When you are finished using the summary, type @kbd{Q} |
| 958 | (@code{rmail-summary-wipe}) to delete the summary buffer's window. You | 969 | (@code{rmail-summary-wipe}) to delete the summary buffer's window. You |
| 959 | can also exit Rmail while in the summary: @kbd{q} | 970 | can also exit Rmail while in the summary: @kbd{q} |
| 960 | (@code{rmail-summary-quit}) deletes the summary window, then exits from | 971 | (@code{rmail-summary-quit}) deletes the summary window, then exits from |
| 961 | Rmail by saving the Rmail file and switching to another buffer. | 972 | Rmail by saving the Rmail file and switching to another buffer. |
| 973 | Alternatively, @kbd{b} (@code{rmail-summary-bury}) simply buries the | ||
| 974 | Rmail summary and buffer. | ||
| 962 | 975 | ||
| 963 | @node Rmail Sorting | 976 | @node Rmail Sorting |
| 964 | @section Sorting the Rmail File | 977 | @section Sorting the Rmail File |
| @@ -1035,6 +1048,11 @@ of a header field, that whole field is hidden. However, the variable | |||
| 1035 | matching that regular expression is shown even if it matches | 1048 | matching that regular expression is shown even if it matches |
| 1036 | @code{rmail-ignored-headers} too. | 1049 | @code{rmail-ignored-headers} too. |
| 1037 | 1050 | ||
| 1051 | @vindex rmail-displayed-headers | ||
| 1052 | As an alternative to the previous two variables, you can set | ||
| 1053 | @code{rmail-displayed-headers} instead. If non-@code{nil}, this should | ||
| 1054 | be a regular expression specifying which headers to display. | ||
| 1055 | |||
| 1038 | @kindex t @r{(Rmail)} | 1056 | @kindex t @r{(Rmail)} |
| 1039 | @findex rmail-toggle-header | 1057 | @findex rmail-toggle-header |
| 1040 | Rmail saves the complete original header before reformatting; to see | 1058 | Rmail saves the complete original header before reformatting; to see |
| @@ -1042,7 +1060,7 @@ it, use the @kbd{t} command (@code{rmail-toggle-header}). This | |||
| 1042 | discards the reformatted headers of the current message and displays | 1060 | discards the reformatted headers of the current message and displays |
| 1043 | it with the original header. Repeating @kbd{t} reformats the message | 1061 | it with the original header. Repeating @kbd{t} reformats the message |
| 1044 | again, which shows only the interesting headers according to the | 1062 | again, which shows only the interesting headers according to the |
| 1045 | current values of those variable. Selecting the message again also | 1063 | current values of the above variables. Selecting the message again also |
| 1046 | reformats it if necessary. | 1064 | reformats it if necessary. |
| 1047 | 1065 | ||
| 1048 | When the @kbd{t} command has a prefix argument, a positive argument | 1066 | When the @kbd{t} command has a prefix argument, a positive argument |
| @@ -1050,19 +1068,14 @@ means to show the reformatted header, and a zero or negative argument | |||
| 1050 | means to show the full header. | 1068 | means to show the full header. |
| 1051 | 1069 | ||
| 1052 | @vindex rmail-highlighted-headers | 1070 | @vindex rmail-highlighted-headers |
| 1053 | When the terminal supports multiple fonts or colors, Rmail | 1071 | Rmail highlights certain header fields that are especially |
| 1054 | highlights certain header fields that are especially interesting---by | 1072 | interesting---by default, the @samp{From} and @samp{Subject} fields. |
| 1055 | default, the @samp{From} and @samp{Subject} fields. The variable | 1073 | The variable @code{rmail-highlighted-headers} holds a regular expression |
| 1056 | @code{rmail-highlighted-headers} holds a regular expression that | 1074 | that specifies the header fields to highlight; if it matches the |
| 1057 | specifies the header fields to highlight; if it matches the beginning | 1075 | beginning of a header field, that whole field is highlighted. To turn |
| 1058 | of a header field, that whole field is highlighted. | 1076 | off this feature, set @code{rmail-highlighted-headers} to @code{nil}. |
| 1059 | 1077 | Customize the face @code{rmail-highlight} to adjust the style of the | |
| 1060 | If you specify unusual colors for your text foreground and | 1078 | highlighting. |
| 1061 | background, the colors used for highlighting may not go well with | ||
| 1062 | them. If so, specify different colors by setting the variable | ||
| 1063 | @code{rmail-highlight-face} to a suitable face. To turn off | ||
| 1064 | highlighting entirely in Rmail, set @code{rmail-highlighted-headers} | ||
| 1065 | to @code{nil}. | ||
| 1066 | 1079 | ||
| 1067 | You can highlight and activate URLs in incoming messages by adding | 1080 | You can highlight and activate URLs in incoming messages by adding |
| 1068 | the function @code{goto-address-mode} to the hook | 1081 | the function @code{goto-address-mode} to the hook |