diff options
| author | Chong Yidong | 2010-12-30 20:39:41 +0800 |
|---|---|---|
| committer | Chong Yidong | 2010-12-30 20:39:41 +0800 |
| commit | 89dc29d9c8e7957d047e9e9abe95334d70982814 (patch) | |
| tree | 3860c6494a25e20e60d6364f1a02a8fa785cbbc9 | |
| parent | 0bf6f91957c33fbea0024495d996f5267e45bc6c (diff) | |
| download | emacs-89dc29d9c8e7957d047e9e9abe95334d70982814.tar.gz emacs-89dc29d9c8e7957d047e9e9abe95334d70982814.zip | |
* rmail.texi (Rmail Display): Edit for grammar and conciseness.
| -rw-r--r-- | doc/emacs/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/emacs/rmail.texi | 133 |
2 files changed, 67 insertions, 70 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index 6141623a05e..dcd7eba7d10 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2010-12-30 Chong Yidong <cyd@stupidchicken.com> | ||
| 2 | |||
| 3 | * rmail.texi (Rmail Display): Edit for grammar and conciseness. | ||
| 4 | |||
| 1 | 2010-12-27 Kenichi Handa <handa@m17n.org> | 5 | 2010-12-27 Kenichi Handa <handa@m17n.org> |
| 2 | 6 | ||
| 3 | * rmail.texi (Rmail Display): Describe new features of Rmail in Info. | 7 | * rmail.texi (Rmail Display): Describe new features of Rmail in Info. |
diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index 323539c8909..9952043fb4d 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi | |||
| @@ -1101,108 +1101,101 @@ buffer before sorting it. | |||
| 1101 | @node Rmail Display | 1101 | @node Rmail Display |
| 1102 | @section Display of Messages | 1102 | @section Display of Messages |
| 1103 | 1103 | ||
| 1104 | Rmail reformats the header of each message before displaying it for | 1104 | This section describes how Rmail displays mail headers, |
| 1105 | the first time. Reformatting hides uninteresting header fields to | 1105 | @acronym{MIME} sections and attachments, and URLs. |
| 1106 | reduce clutter. You can use the @kbd{t} command to show the entire | ||
| 1107 | header or to repeat the header reformatting operation. | ||
| 1108 | 1106 | ||
| 1109 | @table @kbd | 1107 | @table @kbd |
| 1110 | @item t | 1108 | @item t |
| 1111 | Toggle display of complete header (@code{rmail-toggle-header}). | 1109 | Toggle display of complete header (@code{rmail-toggle-header}). |
| 1112 | @end table | 1110 | @end table |
| 1113 | 1111 | ||
| 1114 | @vindex rmail-ignored-headers | ||
| 1115 | @vindex rmail-nonignored-headers | ||
| 1116 | Reformatting the header involves deleting most header fields, on the | ||
| 1117 | grounds that they are not interesting. The variable | ||
| 1118 | @code{rmail-ignored-headers} holds a regular expression that specifies | ||
| 1119 | which header fields to hide in this way---if it matches the beginning | ||
| 1120 | of a header field, that whole field is hidden. However, the variable | ||
| 1121 | @code{rmail-nonignored-headers} provides a further override: a header | ||
| 1122 | matching that regular expression is shown even if it matches | ||
| 1123 | @code{rmail-ignored-headers} too. | ||
| 1124 | |||
| 1125 | @vindex rmail-displayed-headers | ||
| 1126 | As an alternative to the previous two variables, you can set | ||
| 1127 | @code{rmail-displayed-headers} instead. If non-@code{nil}, this should | ||
| 1128 | be a regular expression specifying which headers to display. | ||
| 1129 | |||
| 1130 | @kindex t @r{(Rmail)} | 1112 | @kindex t @r{(Rmail)} |
| 1131 | @findex rmail-toggle-header | 1113 | @findex rmail-toggle-header |
| 1132 | To see the complete, original header, use the @kbd{t} command | 1114 | Before displaying each message for the first time, Rmail reformats |
| 1133 | (@code{rmail-toggle-header}). This discards the reformatted headers of | 1115 | its header, hiding uninteresting header fields to reduce clutter. The |
| 1134 | the current message and displays it with the original header. Repeating | 1116 | @kbd{t} (@code{rmail-toggle-header}) command toggles this, switching |
| 1135 | @kbd{t} reformats the message again, which shows only the interesting | 1117 | between showing the reformatted header fields and showing the |
| 1136 | headers according to the current values of the above variables. | 1118 | complete, original header. With a positive prefix argument, the |
| 1137 | Selecting the message again also reformats it if necessary. | 1119 | command shows the reformatted header; with a zero or negative prefix |
| 1120 | argument, it shows the full header. Selecting the message again also | ||
| 1121 | reformats it if necessary. | ||
| 1138 | 1122 | ||
| 1139 | When the @kbd{t} command has a prefix argument, a positive argument | 1123 | @vindex rmail-ignored-headers |
| 1140 | means to show the reformatted header, and a zero or negative argument | 1124 | @vindex rmail-displayed-headers |
| 1141 | means to show the full header. | 1125 | @vindex rmail-nonignored-headers |
| 1126 | The variable @code{rmail-ignored-headers} holds a regular expression | ||
| 1127 | specifying the header fields to hide; any matching header line will be | ||
| 1128 | hidden. The variable @code{rmail-nonignored-headers} overrides this: | ||
| 1129 | any header field matching that regular expression is shown even if it | ||
| 1130 | matches @code{rmail-ignored-headers} too. The variable | ||
| 1131 | @code{rmail-displayed-headers} is an alternative to these two | ||
| 1132 | variables; if non-@code{nil}, this should be a regular expression | ||
| 1133 | specifying which headers to display (the default is @code{nil}). | ||
| 1142 | 1134 | ||
| 1143 | @vindex rmail-highlighted-headers | 1135 | @vindex rmail-highlighted-headers |
| 1144 | Rmail highlights certain header fields that are especially | 1136 | Rmail highlights certain header fields that are especially |
| 1145 | interesting---by default, the @samp{From} and @samp{Subject} fields. | 1137 | interesting---by default, the @samp{From} and @samp{Subject} fields. |
| 1146 | The variable @code{rmail-highlighted-headers} holds a regular expression | 1138 | This highlighting uses the @code{rmail-highlight} face. The variable |
| 1147 | that specifies the header fields to highlight; if it matches the | 1139 | @code{rmail-highlighted-headers} holds a regular expression specifying |
| 1148 | beginning of a header field, that whole field is highlighted. To turn | 1140 | the header fields to highlight; if it matches the beginning of a |
| 1149 | off this feature, set @code{rmail-highlighted-headers} to @code{nil}. | 1141 | header field, that whole field is highlighted. To disable this |
| 1150 | Customize the face @code{rmail-highlight} to adjust the style of the | 1142 | feature, set @code{rmail-highlighted-headers} to @code{nil}. |
| 1151 | highlighting. | ||
| 1152 | |||
| 1153 | You can highlight and activate URLs in incoming messages using | ||
| 1154 | Goto Address mode: | ||
| 1155 | |||
| 1156 | @c FIXME goto-addr.el commentary says to use goto-address instead. | ||
| 1157 | @smallexample | ||
| 1158 | (add-hook 'rmail-show-message-hook (lambda () (goto-address-mode 1))) | ||
| 1159 | @end smallexample | ||
| 1160 | |||
| 1161 | @noindent | ||
| 1162 | Then you can browse these URLs by clicking on them with @kbd{Mouse-2} | ||
| 1163 | (or @kbd{Mouse-1} quickly) or by moving to one and typing @kbd{C-c | ||
| 1164 | @key{RET}}. @xref{Goto Address mode, Activating URLs, Activating URLs}. | ||
| 1165 | 1143 | ||
| 1166 | @cindex MIME messages (Rmail) | 1144 | @cindex MIME messages (Rmail) |
| 1167 | @vindex rmail-enable-mime | 1145 | @vindex rmail-enable-mime |
| 1168 | Rmail, by default, decodes a MIME message and display the body | 1146 | By default, Rmail automatically decodes @acronym{MIME} (Multipurpose |
| 1169 | part(s) in a humar readable way. If the message contains multiple | 1147 | Internet Mail Extensions) messages. If the message contains multiple |
| 1170 | parts (entities), each part has an additional single tagline that | 1148 | parts (@acronym{MIME} entities), each part is represented by a tagline |
| 1171 | contains the information about depth, index, and type of the part. It | 1149 | in the Rmail buffer. The tagline summarizes the part's depth, index, |
| 1172 | may also contain buttons to handle the part (for saving or | 1150 | and type, and may also contain a button for handling it, e.g. saving |
| 1173 | image-showing). | 1151 | it to a file or displaying it as an image in the Rmail buffer. |
| 1174 | |||
| 1175 | If you customize @code{rmail-enable-mime} to @code{nil} (the default | ||
| 1176 | is @code{t}), Rmail does not show MIME decoded message until a user | ||
| 1177 | explicitly requires it. | ||
| 1178 | 1152 | ||
| 1179 | @table @kbd | 1153 | @table @kbd |
| 1180 | @findex rmail-mime-toggle-hidden | 1154 | @findex rmail-mime-toggle-hidden |
| 1181 | @item @key{RET} | 1155 | @item @key{RET} |
| 1182 | Hide or show the body of a MIME entity at point. | 1156 | Hide or show the @acronym{MIME} part at point |
| 1157 | (@code{rmail-mime-toggle-hidden}). | ||
| 1183 | 1158 | ||
| 1184 | @findex rmail-mime-next-item | 1159 | @findex rmail-mime-next-item |
| 1185 | @item @key{TAB} | 1160 | @item @key{TAB} |
| 1186 | Move point to the next displayed item of MIME entity (part). | 1161 | Move point to the next @acronym{MIME} part |
| 1162 | (@code{rmail-mime-next-item}). | ||
| 1187 | 1163 | ||
| 1188 | @findex rmail-mime-previous-item | 1164 | @findex rmail-mime-previous-item |
| 1189 | @item @key{BackTab} | 1165 | @item @key{BackTab} |
| 1190 | Move point to the previous displayed item of MIME entity (part). | 1166 | Move point to the previous @acronym{MIME} part |
| 1167 | (@code{rmail-mime-previous-item}). | ||
| 1191 | 1168 | ||
| 1192 | @findex rmail-mime | 1169 | @findex rmail-mime |
| 1193 | @item v | 1170 | @item v |
| 1194 | @kindex v @r{(Rmail)} | 1171 | @kindex v @r{(Rmail)} |
| 1195 | The @kbd{v} (@code{rmail-mime}) command toggles the display of a | 1172 | Toggle between @acronym{MIME} display and raw message |
| 1196 | MIME message between the raw mode and the default mode. In the raw | 1173 | (@code{rmail-mime}). |
| 1197 | mode, the undecoded MIME data is displayed. With a prefix argument, | ||
| 1198 | it toggles the display of only an entity at point. | ||
| 1199 | |||
| 1200 | But, if the variable @code{rmail-enable-mime} is @code{nil}, the | ||
| 1201 | command creates a temporary buffer displaying the current MIME | ||
| 1202 | message. By default, it displays plain text and multipart messages, | ||
| 1203 | and offers buttons to save attachments. | ||
| 1204 | @end table | 1174 | @end table |
| 1205 | 1175 | ||
| 1176 | The @kbd{v} (@code{rmail-mime}) command toggles between the default | ||
| 1177 | @acronym{MIME} display described above, and a ``raw'' display showing | ||
| 1178 | the undecoded @acronym{MIME} data. With a prefix argument, this | ||
| 1179 | command toggles the display of only an entity at point. | ||
| 1180 | |||
| 1181 | To prevent Rmail from handling MIME decoded messages, change the | ||
| 1182 | variable @code{rmail-enable-mime} to @code{nil}. When this is the | ||
| 1183 | case, the @kbd{v} (@code{rmail-mime}) command instead creates a | ||
| 1184 | temporary buffer to display the current @acronym{MIME} message. | ||
| 1185 | |||
| 1186 | You can highlight and activate URLs in the Rmail buffer using Goto | ||
| 1187 | Address mode: | ||
| 1188 | |||
| 1189 | @c FIXME goto-addr.el commentary says to use goto-address instead. | ||
| 1190 | @smallexample | ||
| 1191 | (add-hook 'rmail-show-message-hook (lambda () (goto-address-mode 1))) | ||
| 1192 | @end smallexample | ||
| 1193 | |||
| 1194 | @noindent | ||
| 1195 | Then you can browse these URLs by clicking on them with @kbd{Mouse-2} | ||
| 1196 | (or @kbd{Mouse-1} quickly) or by moving to one and typing @kbd{C-c | ||
| 1197 | @key{RET}}. @xref{Goto Address mode, Activating URLs, Activating URLs}. | ||
| 1198 | |||
| 1206 | @node Rmail Coding | 1199 | @node Rmail Coding |
| 1207 | @section Rmail and Coding Systems | 1200 | @section Rmail and Coding Systems |
| 1208 | 1201 | ||