Mercurial > emacs
annotate doc/misc/mh-e.texi @ 92778:054fe9aaf3e3
Use with-current-buffer.
(nntp-send-buffer): Just set the buffer to unibyte rather than use the
dubious mm-with-unibyte-current-buffer.
(nntp-with-open-group-function): New function extracted from
nntp-with-open-group macro.
(nntp-with-open-group): Use the function, so it's easier to debug.
Add indentation and debugging info.
(nntp-open-telnet-stream, nntp-open-via-rlogin-and-telnet): Recommend the
use of the netcat alternatives.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Wed, 12 Mar 2008 19:56:09 +0000 |
parents | 5d58981e6690 |
children | 46a2b7ab3cd6 |
rev | line source |
---|---|
84306 | 1 \input texinfo @c -*-texinfo-*- |
2 @c | |
3 @c Note: This document requires makeinfo version 4.6 or greater to build. | |
4 @c | |
5 @c %**start of header | |
84329
3d431f1997d8
(setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents:
84306
diff
changeset
|
6 @setfilename ../../info/mh-e |
84306 | 7 @settitle The MH-E Manual |
8 @c %**end of header | |
9 | |
10 @c Version of the software and manual. | |
84934
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
11 @set VERSION 8.0.3+CVS |
84306 | 12 @c Edition of the manual. It is either empty for the first edition or |
13 @c has the form ", nth Edition" (without the quotes). | |
14 @set EDITION | |
84934
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
15 @set UPDATED 2007-09-25 |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
16 @set UPDATE-MONTH September, 2007 |
84306 | 17 |
18 @c Other variables. | |
19 @set MH-BOOK-HOME http://rand-mh.sourceforge.net/book/mh | |
20 @set MH-E-HOME http://mh-e.sourceforge.net/ | |
21 | |
22 @c Copyright | |
23 @copying | |
24 This is version @value{VERSION}@value{EDITION} of @cite{The MH-E | |
25 Manual}, last updated @value{UPDATED}. | |
26 | |
87903 | 27 Copyright @copyright{} 1995, 2001, 2002, 2003, 2005, 2006, 2007, 2008 Free |
84306 | 28 Software Foundation, Inc. |
29 | |
30 @quotation | |
31 The MH-E manual is free documentation; you can redistribute it and/or | |
32 modify it under the terms of either: | |
33 | |
34 @enumerate a | |
35 @item | |
36 the GNU Free Documentation License, Version 1.2 or any later version | |
37 published by the Free Software Foundation; with no Invariant Sections, | |
38 no Front-Cover Texts, and no Back-Cover Texts. | |
39 | |
40 @item | |
41 the GNU General Public License as published by the Free Software | |
42 Foundation; either version 3, or (at your option) any later version. | |
43 @end enumerate | |
44 | |
45 The MH-E manual is distributed in the hope that it will be useful, but | |
46 WITHOUT ANY WARRANTY; without even the implied warranty of | |
47 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
48 General Public License or GNU Free Documentation License for more | |
49 details. | |
50 | |
51 The GNU General Public License and the GNU Free Documentation License | |
52 appear as appendices to this document. You may also request copies by | |
53 writing to the Free Software Foundation, Inc., 51 Franklin Street, | |
54 Fifth Floor, Boston, MA 02110-1301, USA. | |
55 @end quotation | |
56 @end copying | |
57 | |
58 @c Info Directory Entry | |
59 @dircategory Emacs | |
60 @direntry | |
61 * MH-E: (mh-e). Emacs interface to the MH mail system. | |
62 @end direntry | |
63 | |
64 @c Title Page | |
65 @setchapternewpage odd | |
66 @titlepage | |
67 @title The MH-E Manual | |
68 @subtitle Version @value{VERSION}@value{EDITION} | |
69 @subtitle @value{UPDATE-MONTH} | |
70 @author Bill Wohler | |
71 | |
72 @c Copyright Page | |
73 @page | |
74 @vskip 0pt plus 1filll | |
75 @insertcopying | |
76 @end titlepage | |
77 | |
78 @ifnottex | |
79 @html | |
80 <!-- | |
81 @end html | |
82 @node Top, Preface, (dir), (dir) | |
83 @top The MH-E Manual | |
84 @html | |
85 --> | |
86 @end html | |
87 @insertcopying | |
88 @end ifnottex | |
89 | |
90 @c Table of Contents | |
91 @contents | |
92 | |
93 @html | |
94 <!-- | |
95 @end html | |
96 | |
97 @menu | |
98 * Preface:: Preface | |
99 * Conventions:: GNU Emacs Terms and Conventions | |
100 * Getting Started:: Getting Started | |
101 * Tour Through MH-E:: Tour Through MH-E | |
102 * Using This Manual:: Using This Manual | |
103 * Incorporating Mail:: Incorporating Mail | |
104 * Reading Mail:: Reading Mail | |
105 * Folders:: Organizing Your Mail with Folders | |
106 * Sending Mail:: Sending Mail | |
107 * Editing Drafts:: Editing a Draft | |
108 * Aliases:: Aliases | |
109 * Identities:: Identities | |
110 * Speedbar:: The Speedbar | |
111 * Menu Bar:: The Menu Bar | |
112 * Tool Bar:: The Tool Bar | |
113 * Searching:: Searching Through Messages | |
114 * Threading:: Viewing Message Threads | |
115 * Limits:: Limiting Display | |
116 * Sequences:: Using Sequences | |
117 * Junk:: Dealing With Junk Mail | |
118 * Miscellaneous:: Miscellaneous Commands, Variables, and Buffers | |
119 * Scan Line Formats:: Scan Line Formats | |
120 * Procmail:: Reading Mailing Lists Effectively | |
121 * Odds and Ends:: Odds and Ends | |
122 * History:: History of MH-E | |
123 * GFDL:: GNU Free Documentation License | |
124 * GPL:: GNU Public License | |
125 * Key Index:: Key (Character) Index | |
126 * Command Index:: Command Index | |
127 * Option Index:: Option (Variable) Index | |
128 * Concept Index:: Concept Index | |
129 | |
130 @detailmenu | |
131 --- The Detailed Node Listing --- | |
132 | |
133 Tour Through MH-E | |
134 | |
135 * Sending Mail Tour:: | |
136 * Reading Mail Tour:: | |
137 * Processing Mail Tour:: | |
138 * Leaving MH-E:: | |
139 * More About MH-E:: | |
140 | |
141 Using This Manual | |
142 | |
143 * Options:: | |
144 * Ranges:: | |
145 * Folder Selection:: | |
146 | |
147 Reading Your Mail | |
148 | |
149 * Viewing:: | |
150 * Viewing Attachments:: | |
151 * HTML:: | |
152 * Digests:: | |
153 * Reading PGP:: | |
154 * Printing:: | |
155 * Files and Pipes:: | |
156 * Navigating:: | |
157 * Miscellaneous Commands and Options:: | |
158 | |
159 Sending Mail | |
160 | |
161 * Composing:: | |
162 * Replying:: | |
163 * Forwarding:: | |
164 * Redistributing:: | |
165 * Editing Again:: | |
166 | |
167 Editing a Draft | |
168 | |
169 * Editing Message:: | |
170 * Inserting Letter:: | |
171 * Inserting Messages:: | |
172 * Signature:: | |
173 * Picture:: | |
174 * Adding Attachments:: | |
175 * Sending PGP:: | |
176 * Checking Recipients:: | |
177 * Sending Message:: | |
178 * Killing Draft:: | |
179 | |
180 Odds and Ends | |
181 | |
182 * Bug Reports:: | |
183 * Mailing Lists:: | |
184 * MH FAQ and Support:: | |
185 * Getting MH-E:: | |
186 | |
187 History of MH-E | |
188 | |
189 * From Brian Reid:: | |
190 * From Jim Larus:: | |
191 * From Stephen Gildea:: | |
192 * From Bill Wohler:: | |
193 | |
194 @end detailmenu | |
195 @end menu | |
196 | |
197 @html | |
198 --> | |
199 @end html | |
200 | |
201 @node Preface, Conventions, Top, Top | |
202 @unnumbered Preface | |
203 | |
204 @cindex Emacs | |
205 @cindex Unix commands, Emacs | |
206 @cindex preface | |
207 | |
208 This manual introduces another interface to the MH mail system that is | |
209 accessible through the GNU Emacs editor, namely, @emph{MH-E}. MH-E is | |
210 easy to use. I don't assume that you know GNU Emacs or even MH at this | |
211 point, since I didn't know either of them when I discovered MH-E. | |
212 However, MH-E was the tip of the iceberg, and I discovered more and | |
213 more niceties about GNU Emacs and MH@. Now I'm fully hooked on both of | |
214 them. | |
215 | |
216 The MH-E package is distributed with GNU Emacs@footnote{Version | |
217 @value{VERSION} of MH-E will appear in GNU Emacs 22.1. It is supported | |
218 in GNU Emacs 21, as well as XEmacs 21 (except for versions | |
219 21.5.9-21.5.16). It is compatible with MH versions 6.8.4 and higher, | |
220 all versions of nmh, and GNU mailutils 1.0 and higher.}, so you | |
221 shouldn't have to do anything special to use it. This manual covers | |
222 MH-E version @value{VERSION}. To help you decide which version you | |
223 have, see @ref{Getting Started}. | |
224 | |
225 @findex help-with-tutorial | |
226 @kindex C-h t | |
227 | |
228 If you don't already use GNU Emacs but want to learn more, you can | |
229 read an online tutorial by starting GNU Emacs and typing @kbd{C-h t} | |
230 (@code{help-with-tutorial}). (To learn about this notation, see | |
231 @ref{Conventions}.) If you want to take the plunge, consult the | |
232 @iftex | |
233 @cite{GNU Emacs Manual}, | |
234 @end iftex | |
235 @ifinfo | |
236 @ref{top, , GNU Emacs Manual, emacs, GNU Emacs Manual}, | |
237 @end ifinfo | |
238 @ifhtml | |
239 @uref{http://www.gnu.org/software/emacs/manual/html_node/, | |
240 @cite{GNU Emacs Manual}}, | |
241 @end ifhtml | |
242 from the Free Software Foundation. | |
243 | |
244 If more information is needed, you can go to the Unix manual pages of | |
245 the individual MH commands. When the name is not obvious, I'll guide | |
246 you to a relevant MH manual page that describes the action more fully. | |
247 | |
248 @cindex @cite{MH & nmh: Email for Users & Programmers} | |
249 @cindex MH book | |
250 @cindex info | |
251 @kindex C-h i | |
252 | |
253 This manual is available in both Info and online formats. The Info | |
254 version is distributed with Emacs and can be accessed with the | |
255 @command{info} command (@samp{info mh-e}) or within Emacs (@kbd{C-h i | |
256 m mh-e @key{RET}}). The online version is available at | |
257 @uref{http://mh-e.sourceforge.net/manual/, SourceForge}. Another great | |
258 online resource is the book @uref{http://www.ics.uci.edu/~mh/book/, | |
259 @cite{MH & nmh: Email for Users & Programmers}} (also known as | |
260 @dfn{the MH book}). | |
261 | |
262 I hope you enjoy this manual! If you have any comments, or suggestions | |
263 for this document, please let me know. | |
264 | |
265 @cindex Bill Wohler | |
266 @cindex Wohler, Bill | |
267 | |
268 @noindent | |
269 Bill Wohler <@i{wohler at newt.com}>@* | |
270 8 February 1995@* | |
271 24 February 2006 | |
272 | |
273 @node Conventions, Getting Started, Preface, Top | |
274 @chapter GNU Emacs Terms and Conventions | |
275 | |
276 @cindex Emacs | |
277 @cindex Emacs, conventions | |
278 @cindex Emacs, terms | |
279 @cindex Unix commands, Emacs | |
280 @cindex conventions, Emacs | |
281 @cindex terms, Emacs | |
282 | |
283 If you're an experienced Emacs user, you can skip the following | |
284 conventions and definition of terms and go directly to the next | |
285 section (@pxref{Getting Started}). | |
286 | |
287 @cindex Emacs commands | |
288 @cindex MH commands | |
289 @cindex Unix commands | |
290 @cindex commands | |
291 @cindex commands, MH | |
292 @cindex commands, Unix | |
293 @cindex commands, shell | |
294 @cindex functions | |
295 @cindex shell commands | |
296 | |
297 In general, @dfn{functions} in this text refer to Emacs Lisp functions | |
298 that one would call from within Emacs Lisp programs (for example, | |
299 @code{(mh-inc-folder)}). On the other hand, @dfn{commands} are those | |
300 things that are run by the user, such as @kbd{i} or @kbd{M-x | |
301 mh-inc-folder}. Programs outside of Emacs are specifically called MH | |
302 commands, shell commands, or Unix commands. | |
303 | |
304 @cindex conventions, key names | |
305 @cindex key names | |
306 | |
307 The conventions for key names are as follows: | |
308 | |
309 @table @kbd | |
310 @item C-x | |
311 Hold down the @key{CTRL} (Control) key and press the @kbd{x} key. | |
312 @c ------------------------- | |
313 @item M-x | |
314 Hold down the @key{META} or @key{ALT} key and press the @kbd{x} key. | |
315 | |
316 Since some keyboards don't have a @key{META} key, you can generate | |
317 @kbd{M-x}, for example, by pressing @key{ESC} (Escape), | |
318 @emph{releasing it}, and then pressing the @kbd{x} key. | |
319 @c ------------------------- | |
320 @item @key{RET} | |
321 Press the @key{RETURN} or @key{ENTER} key. This is normally used to | |
322 complete a command. | |
323 @c ------------------------- | |
324 @item @key{SPC} | |
325 Press the space bar. | |
326 @c ------------------------- | |
327 @item @key{TAB} | |
328 Press the @key{TAB} key. | |
329 @c ------------------------- | |
330 @item @key{DEL} | |
331 Press the @key{DELETE} key. | |
332 @c ------------------------- | |
333 @item @key{BS} | |
334 Press the @key{BACKSPACE} key@footnote{If you are using Version 20 or | |
335 earlier of Emacs, you will need to use the @key{DEL} key.}. | |
336 @end table | |
337 | |
338 @cindex Emacs, prefix argument | |
339 @cindex prefix argument | |
340 @kindex C-u | |
341 | |
342 A @dfn{prefix argument} allows you to pass an argument to any Emacs | |
343 function. To pass an argument, type @kbd{C-u} before the Emacs command | |
344 or keystroke. Numeric arguments can be passed as well. For example, to | |
345 insert five f's, use @kbd{C-u 5 f}. There is a default of four when | |
346 using @kbd{C-u}, and you can use multiple prefix arguments to provide | |
347 arguments of powers of four. To continue our example, you could insert | |
348 four f's with @kbd{C-u f}, 16 f's with @kbd{C-u C-u f}, 64 f's with | |
349 @kbd{C-u C-u C-u f}, and so on. Numeric and valueless negative | |
350 arguments can also be inserted with the @key{META} key. Examples | |
351 include @kbd{M-5} to specify an argument of 5, or @kbd{M--} which | |
352 specifies a negative argument with no particular value. | |
353 | |
354 @sp 1 | |
355 @center @strong{NOTE} | |
356 | |
357 @quotation | |
358 The prefix @kbd{C-u} or @kbd{M-} is not necessary in MH-E's MH-Folder | |
359 mode (@pxref{Reading Mail Tour}). In this mode, simply enter the | |
360 numerical argument before entering the command. | |
361 @end quotation | |
362 @sp 1 | |
363 | |
364 @cindex @file{.emacs} | |
365 @cindex Emacs, variables | |
366 @cindex files, @file{.emacs} | |
367 @cindex variables | |
368 @findex setq | |
369 | |
370 Emacs uses @dfn{variables} to hold values. These can be changed via | |
371 calls to the function @code{setq} in @file{~/.emacs}. | |
372 | |
373 @cindex Emacs, options | |
374 @cindex options | |
375 @findex customize-group | |
376 @findex customize-option | |
377 | |
378 Variables in MH-E that are normally modified by the user are called | |
379 @dfn{options} and are modified through the customize functions (such | |
380 as @kbd{M-x customize-option} or @kbd{M-x customize-group}). | |
381 @ifnothtml | |
382 @xref{Easy Customization,,,emacs,The GNU Emacs Manual}, in @cite{The | |
383 GNU Emacs Manual}. | |
384 @end ifnothtml | |
385 @ifhtml | |
386 See section | |
387 @uref{http://www.gnu.org/software/emacs/manual/html_node/Easy-Customization.html, | |
388 Easy Customization} in @cite{The GNU Emacs Manual}. | |
389 @end ifhtml | |
390 @xref{Options}. | |
391 | |
392 @cindex Emacs, faces | |
393 @cindex faces | |
394 @cindex highlighting | |
395 @findex customize-face | |
396 | |
397 You can specify various styles for displaying text using @dfn{faces}. | |
398 MH-E provides a set of faces that you can use to personalize the look | |
399 of your MH-E buffers. Use the command @kbd{M-x customize-face} to do | |
400 this. | |
401 @ifnothtml | |
402 @xref{Face Customization,,,emacs,The GNU Emacs Manual}, in @cite{The | |
403 GNU Emacs Manual}. | |
404 @end ifnothtml | |
405 @ifhtml | |
406 See section | |
407 @uref{http://www.gnu.org/software/emacs/manual/html_node/Face-Customization.html, | |
408 Face Customization} in @cite{The GNU Emacs Manual}. | |
409 @end ifhtml | |
410 | |
411 @cindex abnormal hooks | |
412 @cindex hooks | |
413 @cindex normal hooks | |
414 @findex add-hook | |
415 @findex customize-option | |
416 | |
417 Commands often offer @dfn{hooks} which enable you to extend or modify | |
418 the way a command works. | |
419 @ifnothtml | |
420 @ref{Hooks, , Hooks, emacs, The GNU Emacs Manual}, in @cite{The GNU | |
421 Emacs Manual} | |
422 @end ifnothtml | |
423 @ifhtml | |
424 See section | |
425 @uref{http://www.gnu.org/software/emacs/manual/html_node/Hooks.html, | |
426 Hooks} in @cite{The GNU Emacs Manual} | |
427 @end ifhtml | |
428 for a description about @dfn{normal hooks} and @dfn{abnormal hooks}. | |
429 MH-E uses normal hooks in nearly all cases, so you can assume that we | |
430 are talking about normal hooks unless we explicitly mention that a | |
431 hook is abnormal. We also follow the conventions described in that | |
432 section: the name of the abnormal hooks end in @code{-hooks} and all | |
433 the rest of the MH-E hooks end in @code{-hook}. You can add hooks with | |
434 either @code{customize-option} or @code{add-hook}. | |
435 | |
436 @cindex Emacs, mark | |
437 @cindex Emacs, point | |
438 @cindex Emacs, region | |
439 @cindex mark | |
440 @cindex point | |
441 @cindex region | |
442 @kindex C-@@ | |
443 @kindex C-@key{SPC} | |
444 | |
445 There are several other terms that are used in Emacs that you should | |
446 know. The @dfn{point} is where the cursor currently is. You can save | |
447 your current place in the file by setting a @dfn{mark}. This operation | |
448 is useful in several ways. The mark can be later used when defining a | |
449 @dfn{region}, which is the text between the point and mark. Many | |
450 commands operate on regions, such as those for deleting text or | |
451 filling paragraphs. A mark can be set with @kbd{C-@@} (or | |
452 @kbd{C-@key{SPC}}). | |
453 | |
454 @cindex completion | |
455 @cindex Emacs, completion | |
456 @cindex Emacs, file completion | |
457 @cindex Emacs, folder completion | |
458 @cindex Emacs, minibuffer | |
459 @cindex file completion | |
460 @cindex folder completion | |
461 @cindex minibuffer | |
462 @kindex SPC | |
463 @kindex TAB | |
464 | |
465 The @dfn{minibuffer} is the bottom line of the Emacs window, where all | |
466 prompting and multiple-character input is directed. You can use | |
467 @dfn{completion} to enter values such as folders. Completion means | |
468 that Emacs fills in text for you when you type @key{SPC} or @key{TAB}. | |
469 A second @key{SPC} or @key{TAB} will list all possibilities at that | |
470 point. | |
471 @ifnothtml | |
472 @xref{Completion, , Completion, emacs, The GNU Emacs Manual}. | |
473 @end ifnothtml | |
474 @ifhtml | |
475 See the section | |
476 @uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html, | |
477 Completion} in @cite{The GNU Emacs Manual}. | |
478 @end ifhtml | |
479 Note that @key{SPC} cannot be used for completing filenames and | |
480 folders. | |
481 | |
482 @findex help-with-tutorial | |
483 @kindex C-h t | |
484 @kindex M-x | |
485 | |
486 The minibuffer is also where you enter Emacs function names after | |
487 typing @kbd{M-x}. For example, in the preface, I mentioned that you | |
488 could obtain help with @kbd{C-h t} (@code{help-with-tutorial}). What | |
489 this means is that you can get a tutorial by typing either @kbd{C-h t} | |
490 or @kbd{M-x help-with-tutorial}. In the latter case, you are prompted | |
491 for @samp{help-with-tutorial} in the minibuffer after typing | |
492 @kbd{M-x}. | |
493 | |
494 @cindex ~ | |
495 | |
496 The @samp{~} notation in filenames represents your home directory. | |
497 This notation is used by many shells including @command{bash}, | |
498 @code{tcsh}, and @command{csh}. It is analogous to the environment | |
499 variable @samp{$HOME}. For example, @file{~/.emacs} can be written | |
500 @file{$HOME/.emacs} or using the absolute path as in | |
501 @file{/home/wohler/.emacs} instead. | |
502 | |
503 @cindex Emacs, interrupting | |
504 @cindex Emacs, quitting | |
505 @cindex interrupting | |
506 @cindex quitting | |
507 | |
508 @i{In case of trouble:} Emacs can be interrupted at any time with | |
509 @kbd{C-g}. For example, if you've started a command that requests that | |
510 you enter something in the minibuffer, but then you change your mind, | |
511 type @kbd{C-g} and you'll be back where you started. If you want to | |
512 exit Emacs entirely, use @kbd{C-x C-c}. | |
513 | |
514 @node Getting Started, Tour Through MH-E, Conventions, Top | |
515 @chapter Getting Started | |
516 | |
517 @cindex MH-E, versions | |
518 @cindex history | |
519 @cindex versions of MH-E | |
520 | |
521 Because there are many old versions of MH-E out there, it is important | |
522 to know which version you have. I'll be talking about @w{Version 8} | |
523 which is pretty close to @w{Version 6} and @w{Version 7}. It differs | |
524 from @w{Version 4} and @w{Version 5} and is vastly different from | |
525 @w{Version 3}. @xref{History}. | |
526 | |
527 @findex mh-version | |
528 | |
529 To determine which version of MH-E that you have, enter @kbd{M-x | |
530 mh-version @key{RET}}. Hopefully it says that you're running | |
531 @w{Version @value{VERSION}} which is the latest version as of this | |
532 printing. | |
533 | |
534 If your version is much older than this, please consider upgrading. | |
535 You can have your system administrator upgrade the system-wide | |
536 version, or you can install your own personal version. It's really | |
537 quite easy. @xref{Getting MH-E}, for instructions for getting and | |
538 installing MH-E. | |
539 | |
540 If the @code{mh-version} command displays @samp{No MH variant | |
541 detected}@footnote{In very old versions of MH-E, you may get the error | |
542 message, @samp{Cannot find the commands `inc' and `mhl' and the file | |
543 `components'} if MH-E can't find MH. In this case, you need to update | |
544 MH-E, and you may need to install MH too. However, newer versions of | |
545 MH-E are better at finding MH if it is on your system.}, then you need | |
546 to install MH or tell MH-E where to find MH. | |
547 | |
548 @cindex Debian | |
549 @cindex nmh | |
550 @cindex GNU mailutils | |
551 | |
552 If you don't have MH on your system already, you must install a | |
553 variant of MH. The Debian mh-e package does this for you automatically | |
554 (@pxref{Getting MH-E}). Most people use | |
555 @uref{http://www.nongnu.org/nmh/, nmh}, but you may be interested in | |
556 trying out @uref{http://www.gnu.org/software/mailutils/, GNU | |
557 mailutils}, which supports IMAP. Your GNU/Linux distribution probably | |
558 has packages for both of these. | |
559 | |
560 @cindex @command{install-mh} | |
561 @cindex MH commands, @command{install-mh} | |
562 @cindex MH book | |
563 | |
564 If you've never run MH before, you need to run @command{install-mh} | |
565 from the shell before you continue. This sets up your personal MH | |
566 environment@footnote{See the section | |
567 @uref{@value{MH-BOOK-HOME}/../overall/setup.html, Setting Up MH} in the | |
568 MH book.}. If you don't, you'll be greeted with the error message: | |
569 @samp{Install MH and run install-mh before running MH-E}. This is all | |
570 you need to know about MH to use MH-E, but the more you know about MH, | |
571 the more you can leverage its power. See the | |
572 @uref{@value{MH-BOOK-HOME}/../, MH book} to learn more about MH. | |
573 | |
574 @cindex @samp{Path:} MH profile component | |
575 @cindex MH profile | |
576 @cindex MH profile component | |
577 @cindex MH profile component, @samp{Path:} | |
578 | |
579 Your MH environment includes your @dfn{MH profile} which is found in | |
580 the file @file{~/.mh_profile}. This file contains a number of @dfn{MH | |
581 profile components}. For example, the @samp{Path:} MH profile | |
582 component contains the path to your mail directory, which is | |
583 @file{~/Mail} by default. | |
584 | |
585 @cindex @command{mhparam} | |
586 @cindex MH commands, @command{mhparam} | |
587 @vindex exec-path | |
588 @vindex mh-path | |
589 @vindex mh-sys-path | |
590 @vindex mh-variant | |
591 @vindex mh-variant-in-use | |
592 | |
593 There are several options MH-E uses to interact with your MH | |
594 installation. The option @code{mh-variant} specifies the variant used | |
595 by MH-E (@pxref{Options}). The default setting of this option is | |
596 @samp{Auto-detect} which means that MH-E will automatically choose the | |
597 first of nmh, MH, or GNU mailutils that it finds in the directories | |
598 listed in @code{mh-path} (which you can customize), | |
599 @code{mh-sys-path}, and @code{exec-path}. If MH-E can't find MH at | |
600 all, you may have to customize @code{mh-path} and add the directory in | |
601 which the command @command{mhparam} is located. If, on the other hand, | |
602 you have both nmh and mailutils installed (for example) and | |
603 @code{mh-variant-in-use} was initialized to nmh but you want to use | |
604 mailutils, then you can set @code{mh-variant} to @samp{mailutils}. | |
605 | |
606 @vindex mh-flists-present-flag | |
607 @vindex mh-lib | |
608 @vindex mh-lib-progs | |
609 @vindex mh-progs | |
610 | |
611 When @code{mh-variant} is changed, MH-E resets @code{mh-progs}, | |
612 @code{mh-lib}, @code{mh-lib-progs}, @code{mh-flists-present-flag}, and | |
613 @code{mh-variant-in-use} accordingly. | |
614 | |
615 @cindex @file{.emacs} | |
616 @cindex files, @file{.emacs} | |
617 | |
618 @sp 1 | |
619 @center @strong{NOTE} | |
620 | |
621 @quotation | |
622 Prior to version 8, it was often necessary to set some of these | |
623 variables in @file{~/.emacs}; now it is no longer necessary and can | |
624 actually cause problems. | |
625 @end quotation | |
626 @sp 1 | |
627 | |
628 @cindex MH profile component, @samp{Draft-Folder:} | |
629 @cindex MH profile component, @samp{Path:} | |
630 @cindex MH profile component, @samp{Previous-Sequence:} | |
631 @cindex MH profile component, @samp{Unseen-Sequence:} | |
632 @cindex @samp{Draft-Folder:} MH profile component | |
633 @cindex @samp{Path:} MH profile component | |
634 @cindex @samp{Previous-Sequence:} MH profile component | |
635 @cindex @samp{Unseen-Sequence:} MH profile component | |
636 @findex mh-find-path | |
637 @vindex mh-draft-folder | |
638 @vindex mh-find-path-hook | |
639 @vindex mh-inbox | |
640 @vindex mh-previous-seq | |
641 @vindex mh-unseen-seq | |
642 @vindex mh-user-path | |
643 | |
644 In addition to setting variables that point to MH itself, MH-E also | |
645 sets a handful of variables that point to where you keep your mail. | |
646 During initialization, the function @code{mh-find-path} sets | |
647 @code{mh-user-path} from your @samp{Path:} MH profile component (but | |
648 defaults to @samp{Mail} if one isn't present), @code{mh-draft-folder} | |
649 from @samp{Draft-Folder:}, @code{mh-unseen-seq} from | |
650 @samp{Unseen-Sequence:}, @code{mh-previous-seq} from | |
651 @samp{Previous-Sequence:}, and @code{mh-inbox} from @samp{Inbox:} | |
652 (defaults to @samp{+inbox}). The hook @code{mh-find-path-hook} is run | |
653 after these variables have been set. This hook can be used the change | |
654 the value of these variables if you need to run with different values | |
655 between MH and MH-E. | |
656 | |
657 @node Tour Through MH-E, Using This Manual, Getting Started, Top | |
658 @chapter Tour Through MH-E | |
659 | |
660 @cindex introduction | |
661 @cindex tour | |
662 @cindex tutorial | |
663 | |
664 This chapter introduces some of the terms you'll need to know and then | |
665 takes you on a tour of MH-E@footnote{The keys mentioned in these | |
666 chapters refer to the default key bindings. If you've changed the | |
667 bindings, refer to the command summaries at the beginning of each | |
668 chapter for a mapping between default key bindings and function | |
669 names.}. When you're done, you'll be able to send, read, and file | |
670 mail, which is all that a lot of people ever do. But if you're the | |
671 curious or adventurous type, read the rest of the manual to be able to | |
672 use all the features of MH-E. I suggest you read this chapter first to | |
673 get the big picture, and then you can read the manual as you wish. | |
674 | |
675 @menu | |
676 * Sending Mail Tour:: | |
677 * Reading Mail Tour:: | |
678 * Processing Mail Tour:: | |
679 * Leaving MH-E:: | |
680 * More About MH-E:: | |
681 @end menu | |
682 | |
683 @node Sending Mail Tour, Reading Mail Tour, Tour Through MH-E, Tour Through MH-E | |
684 @section Sending Mail | |
685 | |
686 @cindex MH-Letter mode | |
687 @cindex mode | |
688 @cindex modes, MH-Letter | |
689 @cindex sending mail | |
690 @findex mh-smail | |
691 @kindex M-x mh-smail | |
692 | |
693 Let's start our tour by sending ourselves a message which we can later | |
694 read and process. Enter @kbd{M-x mh-smail} to invoke the MH-E program | |
695 to send messages. Your message appears in an Emacs buffer whose | |
696 mode@footnote{A @dfn{mode} changes Emacs to make it easier to edit a | |
697 particular type of text.} is MH-Letter. | |
698 | |
699 Enter your login name in the @samp{To:} header field. Press the | |
700 @key{TAB} twice to move the cursor past the @samp{Cc:} field, since no | |
701 carbon copies are to be sent, and on to the @samp{Subject:} field. | |
702 Enter @kbd{Test} or anything else that comes to mind. | |
703 | |
704 Press @key{TAB} again to move the cursor to the body of the message. | |
705 Enter some text, using normal Emacs commands. You should now have | |
706 something like this@footnote{If you're running Emacs under the X | |
707 Window System, then you would also see a menu bar and a tool bar. I've | |
708 left out the menu bar and tool bar in all of the example screens.}: | |
709 | |
710 @cartouche | |
711 @smallexample | |
712 | |
713 | |
714 | |
715 | |
716 | |
717 | |
718 --:-- *scratch* All L1 (Lisp Interaction)------------------------- | |
719 To: wohler | |
720 cc: | |
721 Subject: Test | |
722 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1 | |
723 -------- | |
724 This is a test message to get the wheels churning...# | |
725 | |
726 | |
727 --:** @{draft@} All L5 (MH-Letter)---------------------------------- | |
728 Type C-c C-c to send message, C-C ? for help | |
729 @end smallexample | |
730 @end cartouche | |
731 @i{MH-E message composition window} | |
732 | |
733 Note the line of dashes that separates the header and the body of the | |
734 message. It is essential that these dashes (or a blank line) are | |
735 present or the body of your message will be considered to be part of | |
736 the header. | |
737 | |
738 @cindex help | |
739 @findex describe-mode | |
740 @kindex C-c ? | |
741 @kindex C-c C-c | |
742 @kindex C-h m | |
743 | |
744 There are several commands specific to MH-Letter mode@footnote{You can | |
745 get quick help for the commands used most often with @kbd{C-c ?} or | |
746 more complete help with the @kbd{C-h m} (@code{describe-mode}) | |
747 command.}, but at this time we'll only use @kbd{C-c C-c} to send your | |
748 message. Type @kbd{C-c C-c} now. That's all there is to it! | |
749 | |
750 @node Reading Mail Tour, Processing Mail Tour, Sending Mail Tour, Tour Through MH-E | |
751 @section Receiving Mail | |
752 | |
753 @cindex @command{inc} | |
754 @cindex @command{scan} | |
755 @cindex MH commands, @command{inc} | |
756 @cindex MH commands, @command{scan} | |
757 @cindex MH-Folder mode | |
758 @cindex modes, MH-Folder | |
759 @cindex reading mail | |
760 @findex mh-rmail | |
761 @kindex M-x mh-rmail | |
762 | |
763 To read the mail you've just sent yourself, enter @kbd{M-x mh-rmail}. | |
764 This incorporates the new mail and puts the output from | |
765 @command{inc}@footnote{See the section | |
766 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next | |
767 prev} in the MH book.} (called @dfn{scan lines} after the MH program | |
768 @command{scan}@footnote{See the section | |
769 @uref{@value{MH-BOOK-HOME}/faswsprs.html, Find and Specify with scan | |
770 pick Ranges Sequences} in the MH book.} which prints a one-line | |
771 summary of each message) into a buffer called @samp{+inbox} whose | |
772 major mode is MH-Folder. | |
773 | |
774 @findex mh-rmail | |
775 @kindex F r | |
776 @kindex M-x mh-rmail | |
777 | |
778 @sp 1 | |
779 @center @strong{NOTE} | |
780 | |
781 @quotation | |
782 | |
783 The @kbd{M-x mh-rmail} command will show you only new mail, not mail | |
784 you have already read. If you were to run this tour again, you would | |
785 use @kbd{F r} to pull all your messages into MH-E. | |
786 @end quotation | |
787 @sp 1 | |
788 | |
789 @kindex @key{RET} | |
790 @kindex n | |
791 @kindex p | |
792 | |
793 You should see the scan line for your message, and perhaps others. Use | |
794 @kbd{n} or @kbd{p} to move the cursor to your test message and type | |
795 @key{RET} to read your message. You should see something like: | |
796 | |
797 @cartouche | |
798 @smallexample | |
799 3 t08/24 root received fax files on Wed Aug 24 11:00:13 PDT 1 | |
800 # 4+t08/24 To:wohler Test<<This is a test message to get the wheels | |
801 | |
802 -:%% @{+inbox/select@} 4 msgs (1-4) Bot L4 (MH-Folder Show)--------- | |
803 To: wohler | |
804 Subject: Test | |
805 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1 | |
806 Date: Fri, 17 Mar 2006 10:49:11 -0800 | |
807 From: Bill Wohler <wohler@@stop.mail-abuse.org> | |
808 | |
809 This is a test message to get the wheels churning... | |
810 | |
811 | |
812 | |
813 --:-- @{show-+inbox@} 4 All L1 (MH-Show)---------------------------- | |
814 | |
815 @end smallexample | |
816 @end cartouche | |
817 @i{After incorporating new messages} | |
818 | |
819 @kindex @key{DEL} | |
820 @kindex @key{SPC} | |
821 | |
822 If you typed a long message, you can view subsequent pages with | |
823 @key{SPC} and previous pages with @key{DEL}. | |
824 | |
825 @node Processing Mail Tour, Leaving MH-E, Reading Mail Tour, Tour Through MH-E | |
826 @section Processing Mail | |
827 | |
828 @cindex processing mail | |
829 @kindex @key{RET} | |
830 @kindex r | |
831 | |
832 The first thing we want to do is reply to the message that we sent | |
833 ourselves. Ensure that the cursor is still on the same line as your | |
834 test message and type @kbd{r}. You are prompted in the minibuffer with | |
835 @samp{Reply to whom:}. Here MH-E is asking whether you'd like to reply | |
836 to the original sender only, to the sender and primary recipients, or | |
837 to the sender and all recipients. You can press @key{TAB} to see these | |
838 choices. If you simply press @key{RET}, you'll reply only to the | |
839 sender. Press @key{RET} now. | |
840 | |
841 You'll find yourself in an Emacs buffer similar to that when you were | |
842 sending the original message, like this: | |
843 | |
844 @cartouche | |
845 @smallexample | |
846 To: | |
847 cc: | |
848 Subject: Re: Test | |
849 In-reply-to: <31054.1142621351@@stop.mail-abuse.org> | |
850 References: <31054.1142621351@@stop.mail-abuse.org> | |
851 Comments: In-reply-to Bill Wohler <wohler@@stop.mail-abuse.org> | |
852 message dated "Fri, 17 Mar 2006 10:49:11 -0800." | |
853 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1 | |
854 -------- | |
855 # | |
856 | |
857 --:-- @{draft@} All L10 (MH-Letter)---------------------------------- | |
858 To: wohler | |
859 Subject: Test | |
860 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1 | |
861 Date: Fri, 17 Mar 2006 10:49:11 -0800 | |
862 From: Bill Wohler <wohler@@stop.mail-abuse.org> | |
863 | |
864 This is a test message to get the wheels churning... | |
865 | |
866 --:-- @{show-+inbox@} 4 All L1 (MH-Show)---------------------------- | |
867 Type C-c C-c to send message, C-c ? for help | |
868 @end smallexample | |
869 @end cartouche | |
870 @i{Composition window during reply} | |
871 | |
872 @findex backward-char | |
873 @findex forward-char | |
874 @findex next-line | |
875 @findex previous-line | |
876 @kindex C-b | |
877 @kindex C-c C-c | |
878 @kindex C-c C-f C-t | |
879 @kindex C-f | |
880 @kindex C-n | |
881 @kindex C-p | |
882 @kindex @key{BS} | |
883 | |
884 By default, MH will not add you to the address list of your replies, | |
885 so if you find that the @samp{To:} header field is missing, don't | |
886 worry. In this case, type @kbd{C-c C-f C-t} to create and go to the | |
887 @samp{To:} field, where you can type your login name again. You can | |
888 move around with the arrow keys or with @kbd{C-p} | |
889 (@code{previous-line}), @kbd{C-n} (@code{next-line}), @kbd{C-b} | |
890 (@code{backward-char}), and @kbd{C-f} (@code{forward-char}) and can | |
891 delete the previous character with @key{BS}. When you're finished | |
892 editing your message, send it with @kbd{C-c C-c} as before. | |
893 | |
894 @cindex @command{refile} | |
895 @cindex MH commands, @command{refile} | |
896 @cindex folders | |
897 @kindex @key{SPC} | |
898 @kindex o | |
899 | |
900 You'll often want to save messages that were sent to you in an | |
901 organized fashion. This is done with @dfn{folders}. You can use | |
902 folders to keep messages from your friends, or messages related to a | |
903 particular topic. With your cursor in the MH-Folder buffer and | |
904 positioned on the message you sent to yourself, type @kbd{o} to output | |
905 (@command{refile} in MH parlance) that message to a folder. Enter | |
906 @kbd{test} at the @samp{Destination folder:} prompt and type @kbd{y} | |
907 (or @key{SPC}) when MH-E asks to create the folder @samp{+test}. Note | |
908 that a @samp{^} (caret) appears next to the message number, which | |
909 means that the message has been marked for refiling but has not yet | |
910 been refiled. We'll talk about how the refile is actually carried out | |
911 in a moment. | |
912 | |
913 @cindex MH-Folder mode | |
914 @cindex modes, MH-Folder | |
915 @kindex d | |
916 @kindex i | |
917 @kindex @key{RET} | |
918 @kindex n | |
919 @kindex p | |
920 @kindex x | |
921 | |
922 Your previous reply is now waiting in the system mailbox. You | |
923 incorporate this mail into your MH-Folder buffer named @samp{+inbox} | |
924 with the @kbd{i} command. Do this now. After the mail is incorporated, | |
925 use @kbd{n} or @kbd{p} to move the cursor to the new message, and read | |
926 it with @key{RET}. Let's delete this message by typing @kbd{d}. Note | |
927 that a @samp{D} appears next to the message number. This means that | |
928 the message is marked for deletion but is not yet deleted. To perform | |
929 the deletion (and the refile we did previously), use the @kbd{x} | |
930 command. | |
931 | |
932 @findex mh-smail | |
933 @kindex m | |
934 @kindex M-x mh-smail | |
935 | |
936 If you want to send another message you can use @kbd{m} instead of | |
937 @kbd{M-x mh-smail}. So go ahead, send some mail to your friends! | |
938 | |
939 @cindex help | |
940 @cindex prefix characters | |
941 @findex describe-mode | |
942 @kindex ? | |
943 @kindex C-h m | |
944 @kindex F ? | |
945 | |
946 You can get a quick reminder about these commands by typing @kbd{?}. | |
947 This lists several @dfn{prefix characters}. To list the commands | |
948 available via the prefix characters, type the prefix character | |
949 followed by a @kbd{?}, for example, @kbd{F ?}. More complete help is | |
950 available with the @kbd{C-h m} (@code{describe-mode}) command. | |
951 | |
952 @node Leaving MH-E, More About MH-E, Processing Mail Tour, Tour Through MH-E | |
953 @section Leaving MH-E | |
954 | |
955 @cindex Emacs, quitting | |
956 @cindex quitting | |
957 @kindex C-x C-c | |
958 @kindex x | |
959 | |
960 You may now wish to exit @command{emacs} entirely. Use @kbd{C-x C-c} | |
961 to exit @command{emacs}. If you exited without running @kbd{x} in the | |
962 @samp{+inbox} buffer, Emacs will offer to save it for you. Type | |
963 @kbd{y} or @key{SPC} to save @samp{+inbox} changes, which means to | |
964 perform any refiles and deletes that you did there. | |
965 | |
966 @findex mh-rmail | |
967 @kindex C-x b | |
968 @kindex C-x k | |
969 @kindex M-x mh-rmail | |
970 @kindex q | |
971 | |
972 If you don't want to leave Emacs, you can type @kbd{q} to bury (hide) | |
973 the MH-E folder or delete it entirely with @kbd{C-x k}. You can then | |
974 later recall it with @kbd{C-x b} or @kbd{M-x mh-rmail}. | |
975 | |
976 @cindex @command{packf} | |
977 @cindex MH commands, @command{packf} | |
978 @cindex exporting folders | |
979 @cindex folders, exporting | |
980 @cindex mbox-style folder | |
981 | |
982 On the other hand, if you no longer want to use MH and MH-E, you can | |
983 take your mail with you. You can copy all of your mail into a single | |
984 file, mbox-style, by using the MH command @command{packf}. For | |
985 example, to create a file called @file{msgbox} with the messages in | |
986 your @samp{+inbox} folder, use @samp{packf +inbox}. The | |
987 @command{packf} command will append the messages to the file if it | |
988 already exists, so you can use @samp{folders -recurse -fast} in a | |
989 script to copy all of your messages into a single file, or using the | |
990 @samp{-file} argument, a file for each folder. | |
991 | |
992 @node More About MH-E, , Leaving MH-E, Tour Through MH-E | |
993 @section More About MH-E | |
994 | |
995 These are the basic commands to get you going, but there are plenty | |
996 more. If you think that MH-E is for you, read the rest of the manual | |
997 to find out how you can: | |
998 | |
999 @itemize @bullet | |
1000 @item | |
1001 Print your messages (@pxref{Printing}). | |
1002 @c ------------------------- | |
1003 @item | |
1004 Edit messages and include your signature (@pxref{Editing Drafts}). | |
1005 @c ------------------------- | |
1006 @item | |
1007 Forward messages (@pxref{Forwarding}). | |
1008 @c ------------------------- | |
1009 @item | |
1010 Read digests (@pxref{Digests}). | |
1011 @c ------------------------- | |
1012 @item | |
1013 Edit bounced messages (@pxref{Editing Again}). | |
1014 @c ------------------------- | |
1015 @item | |
1016 Send multimedia messages (@pxref{Adding Attachments}). | |
1017 @c ------------------------- | |
1018 @item | |
1019 Read HTML messages (@pxref{HTML}). | |
1020 @c ------------------------- | |
1021 @item | |
1022 Use aliases and identities (see @ref{Aliases}, @pxref{Identities}). | |
1023 @c ------------------------- | |
1024 @item | |
1025 Create different views of your mail (see @ref{Threading}, @pxref{Limits}). | |
1026 @c ------------------------- | |
1027 @item | |
1028 Deal with junk mail (@pxref{Junk}). | |
1029 @c ------------------------- | |
1030 @item | |
1031 Handle signed and encrypted messages (see @ref{Reading PGP}, | |
1032 @pxref{Sending PGP}). | |
1033 @c ------------------------- | |
1034 @item | |
1035 Process mail that was sent with @command{shar} or @command{uuencode} | |
1036 (@pxref{Files and Pipes}). | |
1037 @c ------------------------- | |
1038 @item | |
1039 Use sequences conveniently (@pxref{Sequences}). | |
1040 @c ------------------------- | |
1041 @item | |
1042 Use the speedbar, tool bar, and menu bar (see @ref{Speedbar}, see @ref{Tool | |
1043 Bar}, @pxref{Menu Bar}). | |
1044 @c ------------------------- | |
1045 @item | |
1046 Show header fields in different fonts (@pxref{Reading Mail}). | |
1047 @c ------------------------- | |
1048 @item | |
1049 Find previously refiled messages (@pxref{Searching}). | |
1050 @c ------------------------- | |
1051 @item | |
1052 Place messages in a file (@pxref{Files and Pipes}). | |
1053 @end itemize | |
1054 | |
1055 Remember that you can also use MH commands when you're not running | |
1056 MH-E (and when you are!). | |
1057 | |
1058 @node Using This Manual, Incorporating Mail, Tour Through MH-E, Top | |
1059 @chapter Using This Manual | |
1060 | |
1061 This chapter begins the meat of the manual which goes into more detail | |
1062 about every MH-E command and option. | |
1063 | |
1064 @cindex Emacs, info | |
1065 @cindex Emacs, online help | |
1066 @cindex info | |
1067 @cindex online help | |
1068 @findex describe-mode | |
1069 @findex mh-help | |
1070 @kindex ? | |
1071 @kindex C-c ? | |
1072 @kindex C-h C-h | |
1073 @kindex C-h C-k i | |
1074 @kindex C-h i | |
1075 @kindex C-h m | |
1076 | |
1077 There are many commands, but don't get intimidated. There are command | |
1078 summaries at the beginning of each chapter. In case you have or would | |
1079 like to rebind the keys, the command summaries also list the | |
1080 associated Emacs Lisp function. Furthermore, even if you're stranded | |
1081 on a desert island with a laptop and are without your manuals, you can | |
1082 get a summary of all these commands with GNU Emacs online help: use | |
1083 @kbd{C-h m} (@code{describe-mode}) for a brief summary of commands, | |
1084 @kbd{?} (@code{mh-help}) for an even briefer summary@footnote{This | |
1085 help appears in a buffer called @samp{*MH-E Help*} | |
1086 (@pxref{Miscellaneous}).} (@kbd{C-c ?} in MH-Letter mode), or @kbd{C-h | |
1087 i} to read this manual via Info. The online help is quite good; try | |
1088 running @kbd{C-h C-h}. This brings up a list of available help topics, | |
1089 one of which displays the documentation for a given key (like @kbd{C-h | |
1090 k C-n}). Another useful help feature is to view the manual section | |
1091 that describes a given key (such as @kbd{C-h K i}). In addition, | |
1092 review @ref{Conventions}, if any of the GNU Emacs conventions are | |
1093 strange to you. | |
1094 | |
1095 In addition to all of the commands, it is also possible to reconfigure | |
1096 MH-E to fit the needs of even the most demanding user. The following | |
1097 chapters also describe all of the options, show the defaults, and make | |
1098 recommendations for customization. | |
1099 | |
1100 However, when customizing your mail environment, first try to change | |
1101 what you want in MH, and only change MH-E if changing MH is not | |
1102 possible. That way you will get the same behavior inside and outside | |
1103 GNU Emacs. Note that MH-E does not provide hooks for customizations | |
1104 that can be done in MH; this omission is intentional. | |
1105 | |
1106 @cindex Emacs Lisp Manual | |
1107 @cindex Emacs, Emacs Lisp Manual | |
1108 @cindex Emacs, info | |
1109 @cindex Emacs, online help | |
1110 @cindex info | |
1111 @cindex online help | |
1112 | |
1113 I hope I've included enough examples here to get you well on your way. | |
1114 If you want to explore Emacs Lisp further, a programming manual does | |
1115 exist, | |
1116 @c Yes, some of the stuff in the following sections is redundant, but | |
1117 @c TeX barfs if the @ifs are inside the @footnote. | |
1118 @iftex | |
1119 @footnote{The @cite{GNU Emacs Lisp Reference Manual} may be available | |
1120 online in the Info system by typing @kbd{C-h i m Emacs Lisp | |
1121 @key{RET}}. It is also available online at @* | |
1122 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You | |
1123 can also order a printed manual, which has the desirable side-effect | |
1124 of helping to support the Free Software Foundation which made all this | |
1125 great software available. You can find an order form by running | |
1126 @kbd{C-h C-d}, or you can request an order form from @i{gnu at | |
1127 gnu.org}.} | |
1128 @end iftex | |
1129 @ifinfo | |
1130 @footnote{@xref{Top, The GNU Emacs Lisp Reference Manual, , elisp, GNU | |
1131 Emacs Lisp Reference Manual}, which may be available online in the | |
1132 Info system. It is also available online at | |
1133 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/}. You | |
1134 can also order a printed manual, which has the desirable side-effect | |
1135 of helping to support the Free Software Foundation which made all this | |
1136 great software available. You can find an order form by running | |
1137 @kbd{C-h C-d}, or you can request an order form from @i{gnu at | |
1138 gnu.org}.} | |
1139 @end ifinfo | |
1140 @ifhtml | |
1141 @footnote{The | |
1142 @uref{http://www.gnu.org/software/emacs/elisp-manual/html_node/, | |
1143 The GNU Emacs Lisp Reference Manual} may also be available online in | |
1144 the Info system by typing @kbd{C-h i m Emacs Lisp @key{RET}}. You can | |
1145 also order a printed manual, which has the desirable side-effect of | |
1146 helping to support the Free Software Foundation which made all this | |
1147 great software available. You can find an order form by running | |
1148 @kbd{C-h C-d}, or you can request an order form from @i{gnu at | |
1149 gnu.org}.} | |
1150 @end ifhtml | |
1151 and you can look at the code itself for examples. Look in the Emacs | |
1152 Lisp directory on your system (such as | |
1153 @file{/usr/local/lib/emacs/lisp/mh-e}) and find all the @file{mh-*.el} | |
1154 files there. When calling MH-E and other Emacs Lisp functions directly | |
1155 from Emacs Lisp code, you'll need to know the correct arguments. Use | |
1156 the online help for this. For example, try @kbd{C-h f | |
1157 mh-execute-commands @key{RET}}. If you write your own functions, | |
1158 please do not prefix your symbols (variables and functions) with | |
1159 @samp{mh-}. This prefix is reserved for the MH-E package. To avoid | |
1160 conflicts with existing MH-E symbols, use a prefix like @samp{my-} or | |
1161 your initials. (Unless, of course, your initials happen to be @emph{mh}!) | |
1162 | |
1163 @menu | |
1164 * Options:: | |
1165 * Ranges:: | |
1166 * Folder Selection:: | |
1167 @end menu | |
1168 | |
1169 @node Options, Ranges, Using This Manual, Using This Manual | |
1170 @section Options | |
1171 | |
1172 @cindex Emacs, customizing | |
1173 @cindex Emacs, setting options | |
1174 @cindex customizing MH-E | |
1175 @cindex setting options | |
1176 @findex customize-option | |
1177 @vindex mh-lpr-command-format, example | |
1178 | |
1179 Many string or integer options are easy to modify using @kbd{M-x | |
1180 customize-option}. For example, to modify the option that controls | |
1181 printing, you would run @kbd{M-x customize-option @key{RET} | |
1182 mh-lpr-command-format @key{RET}}. In the buffer that appears, modify | |
1183 the string to the right of the variable. For example, you may change | |
1184 the @command{lpr} command with @samp{nenscript -G -r -2 -i'%s'}. Then | |
1185 use the @samp{State} combo box and select @samp{Save for Future | |
1186 Sessions}. To read more about @code{mh-lpr-command-format}, see | |
1187 @ref{Printing}. | |
1188 | |
1189 @cindex nil | |
1190 @cindex off, option | |
1191 @cindex on, option | |
1192 @cindex option, turning on and off | |
1193 @cindex t | |
1194 @findex customize-option | |
1195 @vindex mh-bury-show-buffer-flag, example | |
1196 | |
1197 Options can also hold boolean values. In Emacs Lisp, the boolean | |
1198 values are @code{nil}, which means false, and @code{t}, which means | |
1199 true. The @code{customize-option} function makes it easy to change | |
1200 boolean values; simply click on the toggle button in the customize | |
1201 buffer to switch between @samp{on} (@code{t}) and @samp{off} | |
1202 (@code{nil}). For example, try setting @code{mh-bury-show-buffer-flag} | |
1203 to @samp{off} to keep the MH-Show buffer at the top of the buffer | |
1204 stack. Use the @samp{State} combo box and choose @samp{Set for Current | |
1205 Session} to see how the option affects the show buffer. Then choose | |
1206 the @samp{Erase Customization} menu item to reset the option to the | |
1207 default, which places the MH-Show buffer at the bottom of the buffer | |
1208 stack. | |
1209 | |
1210 @vindex mh-mhl-format-file, example | |
1211 | |
1212 The text usually says to turn on an option by setting it to a | |
1213 @emph{non-@code{nil}} value, because sometimes values other than | |
1214 @samp{on} are meaningful. An example of this is the variable | |
1215 @code{mh-mhl-format-file} (@pxref{Viewing}). Other options, such as | |
1216 hooks, involve a little more Emacs Lisp programming expertise. | |
1217 | |
1218 @cindex customization group, @samp{mh} | |
1219 @cindex @samp{mh} customization group | |
1220 @findex customize-group | |
1221 @findex mh-customize | |
1222 | |
1223 You can browse all of the MH-E options with the @code{customize-group} | |
1224 function. Try entering @kbd{M-x customize-group @key{RET} mh | |
1225 @key{RET}} to view the top-level options as well as buttons for all of | |
1226 the MH-E customization groups. Another way to view the MH-E | |
1227 customization group is to use @kbd{M-x mh-customize @key{RET}}. | |
1228 | |
1229 @node Ranges, Folder Selection, Options, Using This Manual | |
1230 @section Ranges | |
1231 | |
1232 @c Sync with mh-folder-mode docstring. | |
1233 | |
1234 @cindex message abbreviations | |
1235 @cindex message ranges | |
1236 @cindex ranges | |
1237 | |
1238 Many commands that operate on individual messages, such as | |
1239 @code{mh-forward} or @code{mh-refile-msg} take a @code{RANGE} | |
1240 argument. This argument can be used in several ways. | |
1241 | |
1242 @kindex C-u, with ranges | |
1243 | |
1244 If you provide the prefix argument @kbd{C-u} to these commands, then | |
1245 you will be prompted for the message range. This can be any valid MH | |
1246 range which can include messages, sequences (@pxref{Sequences}), and | |
1247 the abbreviations (described in the @command{mh}(1) man page): | |
1248 | |
1249 @table @samp | |
1250 @item <num1>-<num2> | |
1251 Indicates all messages in the range <num1> to <num2>, inclusive. The | |
1252 range must be nonempty. | |
1253 @c ------------------------- | |
1254 @item <num>:N | |
1255 @itemx <num>:+N | |
1256 @itemx <num>:-N | |
1257 Up to N messages beginning with (or ending with) message num. Num may | |
1258 be any of the predefined symbols: first, prev, cur, next or last. | |
1259 @c ------------------------- | |
1260 @item first:N | |
1261 @itemx prev:N | |
1262 @itemx next:N | |
1263 @itemx last:N | |
1264 The first, previous, next or last messages, if they exist. | |
1265 @c ------------------------- | |
1266 @item all | |
1267 All of the messages. | |
1268 @end table | |
1269 | |
1270 For example, a range that shows all of these things is @samp{1 2 3 | |
1271 5-10 last:5 unseen}. | |
1272 | |
1273 @vindex transient-mark-mode | |
1274 | |
1275 If the option @code{transient-mark-mode} is turned on and you set a | |
1276 region in the MH-Folder buffer, then the MH-E command will perform the | |
1277 operation on all messages in that region. | |
1278 | |
1279 @cindex @samp{mh-range} customization group | |
1280 @cindex customization group, @samp{mh-range} | |
1281 | |
1282 The @samp{mh-range} customization group contains a single option which | |
1283 affects how ranges are interpreted. | |
1284 | |
1285 @vtable @code | |
1286 @item mh-interpret-number-as-range-flag | |
1287 On means interpret a number as a range (default: @samp{on}). | |
1288 @end vtable | |
1289 | |
1290 @vindex mh-interpret-number-as-range-flag | |
1291 | |
1292 Since one of the most frequent ranges used is @samp{last:N}, MH-E will | |
1293 interpret input such as @samp{200} as @samp{last:200} if the | |
1294 @code{mh-interpret-number-as-range-flag} option is on (which is the | |
1295 default). If you need to scan just the message 200, then use the range | |
1296 @samp{200:1} or @samp{200-200}. | |
1297 | |
1298 @node Folder Selection, , Ranges, Using This Manual | |
1299 @section Folder Selection | |
1300 | |
1301 @cindex completion, folders | |
1302 @cindex folders, completion | |
1303 @cindex folders, selecting | |
1304 | |
1305 When you choose a folder in MH-E via a command such as @kbd{o} | |
1306 (@code{mh-refile-msg}), completion is used to enter the folder | |
1307 @ifnothtml | |
1308 (@pxref{Completion, , , emacs, The GNU Emacs Manual}). | |
1309 @end ifnothtml | |
1310 @ifhtml | |
1311 (see the section | |
1312 @uref{http://www.gnu.org/software/emacs/manual/html_node/Completion.html, | |
1313 Completion} in @cite{The GNU Emacs Manual}). | |
1314 @end ifhtml | |
1315 In addition, MH-E has several ways of choosing a suitable default so | |
1316 that the folder can often be selected with a single @key{RET} key. | |
1317 | |
1318 @cindex customization group, @samp{mh-folder-selection} | |
1319 @cindex @samp{mh-folder-selection} customization group | |
1320 | |
1321 The @samp{mh-folder-selection} customization group contains some | |
1322 options which are used to help with this. | |
1323 | |
1324 @vtable @code | |
1325 @item mh-default-folder-for-message-function | |
1326 Function to select a default folder for refiling or @samp{Fcc:} | |
1327 (default: @code{nil}). | |
1328 @c ------------------------- | |
1329 @item mh-default-folder-list | |
1330 List of addresses and folders (default: @code{nil}). | |
1331 @c ------------------------- | |
1332 @item mh-default-folder-must-exist-flag | |
1333 On means guessed folder name must exist to be used (default: | |
1334 @samp{on}). | |
1335 @c ------------------------- | |
1336 @item mh-default-folder-prefix | |
1337 Prefix used for folder names generated from aliases (default: @code{""}). | |
1338 @end vtable | |
1339 | |
1340 @vindex mh-default-folder-for-message-function | |
1341 | |
1342 You can set the option @code{mh-default-folder-for-message-function} | |
1343 to a function that provides a default folder for the message to be | |
1344 refiled. When this function is called, the current buffer contains the | |
1345 message being refiled and point is at the start of the message. This | |
1346 function should return the default folder as a string with a leading | |
1347 @samp{+} sign. It can also return @code{nil} so that the last folder | |
1348 name is used as the default, or an empty string to suppress the | |
1349 default entirely. | |
1350 | |
1351 Otherwise, the name of the destination folder is derived from the | |
1352 sender as follows: | |
1353 | |
1354 @enumerate | |
1355 @vindex mh-default-folder-list | |
1356 @item | |
1357 The folder name associated with the first address found in the list | |
1358 @code{mh-default-folder-list} is used. Each element in this list | |
1359 contains a @samp{Check Recipient} item. If this item is turned on, | |
1360 then the address is checked against the recipient instead of the | |
1361 sender. This is useful for mailing lists. | |
1362 @c ------------------------- | |
1363 @vindex mh-default-folder-prefix | |
1364 @item | |
1365 An alias prefixed by @code{mh-default-folder-prefix} corresponding to | |
1366 the address is used. The prefix is used to prevent clutter in your | |
1367 mail directory. @xref{Aliases}. | |
1368 @end enumerate | |
1369 | |
1370 @vindex mh-default-folder-must-exist-flag | |
1371 | |
1372 If the derived folder does not exist, and | |
1373 @code{mh-default-folder-must-exist-flag} is @code{t}, then the last | |
1374 folder name used is suggested. This is useful if you get mail from | |
1375 various people for whom you have an alias, but file them all in the | |
1376 same project folder. | |
1377 | |
1378 @node Incorporating Mail, Reading Mail, Using This Manual, Top | |
1379 @chapter Incorporating Your Mail | |
1380 | |
1381 @cindex @samp{Folder} menu | |
1382 @cindex incorporating | |
1383 @cindex menu, @samp{Folder} | |
1384 | |
1385 This chapter talks about getting mail from your system mailbox into | |
1386 your MH @samp{+inbox} folder. The following command accomplishes that | |
1387 and is found in the @samp{Folder} menu. | |
1388 | |
1389 @table @kbd | |
1390 @cindex @samp{Folder > Incorporate New Mail} menu item | |
1391 @cindex menu item, @samp{Folder > Incorporate New Mail} | |
1392 @findex mh-inc-folder | |
1393 @kindex i | |
1394 @item i | |
1395 Incorporate new mail into a folder (@code{mh-inc-folder}). | |
1396 @end table | |
1397 | |
1398 @cindex @samp{mh-inc} customization group | |
1399 @cindex customization group, @samp{mh-inc} | |
1400 | |
1401 The following options in the @samp{mh-inc} customization group are | |
1402 used. | |
1403 | |
1404 @vtable @code | |
1405 @item mh-inc-prog | |
1406 Program to incorporate mail (default: @code{"inc"}). | |
1407 @c ------------------------- | |
1408 @item mh-inc-spool-list | |
1409 Alternate spool files (default: @code{nil}). | |
1410 @end vtable | |
1411 | |
1412 The following hook is available. | |
1413 | |
1414 @vtable @code | |
1415 @findex mh-inc-folder | |
1416 @item mh-inc-folder-hook | |
1417 Hook run by @code{mh-inc-folder} after incorporating mail into a | |
1418 folder (default: @code{nil}). | |
1419 @end vtable | |
1420 | |
1421 @cindex @samp{+inbox} | |
1422 @findex mh-inc-folder | |
1423 @kindex i | |
1424 | |
1425 If at any time you receive new mail, incorporate the new mail into | |
1426 your @samp{+inbox} buffer with @kbd{i} (@code{mh-inc-folder}). Note | |
1427 that @kbd{i} will display the @samp{+inbox} buffer, even if there | |
1428 isn't any new mail. You can incorporate mail from any file into the | |
1429 current folder by specifying a prefix argument; you'll be prompted for | |
1430 the name of the file to use as well as the destination folder (for | |
1431 example, @kbd{C-u i ~/mbox @key{RET} +tmp @key{RET}}). | |
1432 | |
1433 @cindex @file{.emacs} | |
1434 @cindex Emacs, notification of new mail | |
1435 @cindex files, @file{.emacs} | |
1436 @cindex new mail | |
1437 @cindex notification of new mail | |
1438 | |
1439 Emacs can notify you when you have new mail by displaying @samp{Mail} | |
1440 in the mode line. To enable this behavior, and to have a clock in the | |
1441 mode line as well, add the following to @file{~/.emacs}: | |
1442 | |
1443 @findex display-time | |
1444 | |
1445 @smalllisp | |
1446 (display-time) | |
1447 @end smalllisp | |
1448 | |
1449 @cindex @command{inc} | |
1450 @cindex incorporating | |
1451 @cindex MH commands, @command{inc} | |
1452 @vindex mh-inc-prog | |
1453 @vindex mh-progs | |
1454 | |
1455 The name of the program that incorporates new mail is stored in | |
1456 @code{mh-inc-prog}; it is @code{"inc"} by default. This program | |
1457 generates a one-line summary for each of the new messages. Unless it | |
1458 is an absolute pathname, the file is assumed to be in the | |
1459 @code{mh-progs} directory (@pxref{Getting Started}). You may also link | |
1460 a file to @command{inc} that uses a different format (see | |
1461 @samp{mh-profile}(5), and sections | |
1462 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next | |
1463 prev} and @uref{@value{MH-BOOK-HOME}/mhstr.html, MH Format Strings} in | |
1464 the MH book). You'll then need to modify several variables | |
1465 appropriately (@pxref{Scan Line Formats}). | |
1466 | |
1467 @vindex mh-inc-spool-list | |
1468 | |
1469 You can use the @code{mh-inc-spool-list} variable to direct MH-E to | |
1470 retrieve mail from arbitrary spool files other than your system | |
1471 mailbox, file it in folders other than your @samp{+inbox}, and assign | |
1472 key bindings to incorporate this mail. | |
1473 | |
1474 @cindex @command{procmail} | |
1475 @cindex @file{.procmailrc} | |
1476 @cindex Unix commands, @command{procmail} | |
1477 @cindex files, @file{.procmailrc} | |
1478 | |
1479 Suppose you are subscribed to the @i{mh-e-devel} mailing list and you | |
1480 use @command{procmail} to filter this mail into @file{~/mail/mh-e} | |
1481 with the following recipe in @file{.procmailrc}: | |
1482 | |
1483 @smallexample | |
1484 PATH=$PATH:/usr/bin/mh | |
1485 MAILDIR=$HOME/`mhparam Path` | |
1486 :0: | |
1487 * ^From mh-e-devel-admin@@stop.mail-abuse.org | |
1488 mh-e | |
1489 @end smallexample | |
1490 | |
1491 @findex mh-inc-spool-* | |
1492 @kindex I * | |
1493 | |
1494 In order to incorporate @file{~/mail/mh-e} into @samp{+mh-e} with an | |
1495 @kbd{I m} (@code{mh-inc-spool-mh-e}) command, customize this option, | |
1496 and click on the @samp{INS} button. Enter a @samp{Spool File} of | |
1497 @samp{~/mail/mh-e}, a @samp{Folder} of @samp{mh-e}, and a @samp{Key | |
1498 Binding} of @samp{m}. | |
1499 | |
1500 @cindex @command{emacsclient} | |
1501 @cindex @command{gnuclient} | |
1502 @cindex @command{xbuffy} | |
1503 @cindex @samp{gnuserv} | |
1504 @cindex Unix commands, @command{emacsclient} | |
1505 @cindex Unix commands, @command{gnuclient} | |
1506 @cindex Unix commands, @command{xbuffy} | |
1507 | |
1508 You can use @command{xbuffy} to automate the incorporation of this | |
1509 mail using the Emacs 22 command @command{emacsclient} as follows: | |
1510 | |
1511 @smallexample | |
1512 box ~/mail/mh-e | |
1513 title mh-e | |
1514 origMode | |
1515 polltime 10 | |
1516 headertime 0 | |
1517 command emacsclient --eval '(mh-inc-spool-mh-e)' | |
1518 @end smallexample | |
1519 | |
1520 In XEmacs, the command @command{gnuclient} is used in a similar | |
1521 fashion. | |
1522 | |
1523 @findex mh-inc-folder | |
1524 @kindex i | |
1525 @vindex mh-inc-folder-hook | |
1526 | |
1527 You can set the hook @code{mh-inc-folder-hook}, which is called after | |
1528 new mail is incorporated by the @kbd{i} (@code{mh-inc-folder}) | |
1529 command. A good use of this hook is to rescan the whole folder either | |
1530 after running @kbd{M-x mh-rmail} the first time or when you've changed | |
1531 the message numbers from outside of MH-E. | |
1532 | |
1533 @findex mh-execute-commands | |
1534 @findex mh-rescan-folder, example | |
1535 @findex mh-show, example | |
1536 @vindex mh-inc-folder-hook, example | |
1537 | |
1538 @smalllisp | |
1539 @group | |
1540 (defun my-mh-inc-folder-hook () | |
1541 "Hook to rescan folder after incorporating mail." | |
1542 (if (buffer-modified-p) ; @r{if outstanding refiles and deletes,} | |
1543 (mh-execute-commands)) ; @r{carry them out} | |
1544 (mh-rescan-folder) ; @r{synchronize with +inbox} | |
1545 (mh-show)) ; @r{show the current message} | |
1546 | |
1547 (add-hook 'mh-inc-folder-hook 'my-mh-inc-folder-hook) | |
1548 | |
1549 @i{Rescan folder after incorporating new mail via mh-inc-folder-hook} | |
1550 | |
1551 @end group | |
1552 @end smalllisp | |
1553 | |
1554 @node Reading Mail, Folders, Incorporating Mail, Top | |
1555 @chapter Reading Your Mail | |
1556 | |
1557 @cindex @samp{+inbox} | |
1558 @cindex MH-Folder mode | |
1559 @cindex MH-Show mode | |
1560 @cindex modes, MH-Folder | |
1561 @cindex modes, MH-Show | |
1562 @cindex reading mail | |
1563 @findex mh-rmail | |
1564 @kindex F r | |
1565 @kindex F v | |
1566 @kindex M-x mh-rmail | |
1567 | |
1568 The MH-E entry point for reading mail is @kbd{M-x mh-rmail}. This | |
1569 command incorporates your mail and creates a buffer called | |
1570 @samp{+inbox} in MH-Folder mode. The command @kbd{M-x mh-rmail} shows | |
1571 you only new mail, not mail you have already read@footnote{If you want | |
1572 to see your old mail as well, use @kbd{F r} to pull all your messages | |
1573 into MH-E. Or, give a prefix argument to @code{mh-rmail} so it will | |
1574 prompt you for folder to visit like @kbd{F v} (for example, @kbd{C-u | |
1575 M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}. | |
1576 | |
1577 @findex display-time | |
1578 @vindex read-mail-command | |
1579 | |
1580 There are some commands that need to read mail, such as @kbd{Mouse-2} | |
1581 over the @samp{Mail} button that @code{display-time} adds to the mode | |
1582 line. You can configure Emacs to have these commands use MH-E by | |
1583 setting the option @code{read-mail-command} to @samp{mh-rmail}. | |
1584 | |
1585 @cindex @command{scan} | |
1586 @cindex @samp{Message} menu | |
1587 @cindex MH commands, @command{scan} | |
1588 @cindex menu, @samp{Message} | |
1589 @cindex scan lines | |
1590 | |
1591 The @samp{+inbox} buffer contains @dfn{scan lines}, which are one-line | |
1592 summaries of each incorporated message. You can perform most MH | |
1593 commands on these messages via one- or two-letter commands in either | |
1594 the MH-Folder or MH-Show buffers or by using the @samp{Message} menu. | |
1595 See @command{scan}(1) for a description of the contents of the scan | |
1596 lines, and see the Figure in @ref{Reading Mail Tour}, for an example. | |
1597 | |
1598 @table @kbd | |
1599 @kindex ? | |
1600 @findex mh-help | |
1601 @item ? | |
1602 Display cheat sheet for the MH-E commands (@code{mh-help}). | |
1603 @c ------------------------- | |
1604 @cindex @samp{Message > Show Message} menu item | |
1605 @cindex menu item, @samp{Message > Show Message} | |
1606 @kindex @key{RET} | |
1607 @findex mh-show | |
1608 @item @key{RET} | |
1609 Display message (@code{mh-show}). | |
1610 @c ------------------------- | |
1611 @cindex @samp{Message > Show Message with Header} menu item | |
1612 @cindex menu item, @samp{Message > Show Message with Header} | |
1613 @kindex , (comma) | |
1614 @findex mh-header-display | |
1615 @item , (comma) | |
1616 Display message with all header fields (@code{mh-header-display}). | |
1617 @c ------------------------- | |
1618 @kindex ; (semicolon) | |
1619 @findex mh-toggle-mh-decode-mime-flag | |
1620 @item ; (semicolon) | |
1621 Toggle the value of @code{mh-decode-mime-flag} | |
1622 (@code{mh-toggle-mh-decode-mime-flag}). | |
1623 @c ------------------------- | |
1624 @kindex @key{SPC} | |
1625 @findex mh-page-msg | |
1626 @item @key{SPC} | |
1627 Display next page in message (@code{mh-page-msg}). | |
1628 @c ------------------------- | |
1629 @kindex @key{BS} | |
1630 @findex mh-previous-page | |
1631 @item @key{BS} | |
1632 Display previous page in message (@code{mh-previous-page}). | |
1633 @c ------------------------- | |
1634 @cindex @samp{Message > Write Message to File...} menu item | |
1635 @cindex menu item, @samp{Message > Write Message to File...} | |
1636 @kindex > | |
1637 @findex mh-write-msg-to-file | |
1638 @item > | |
1639 Append message to end of file (@code{mh-write-msg-to-file}). | |
1640 @c ------------------------- | |
1641 @cindex @samp{Message > Pipe Message to Command...} menu item | |
1642 @cindex menu item, @samp{Message > Pipe Message to Command...} | |
1643 @kindex | | |
1644 @findex mh-pipe-msg | |
1645 @item | | |
1646 Pipe message through shell command (@code{mh-pipe-msg}). | |
1647 @c ------------------------- | |
1648 @kindex C-d | |
1649 @findex mh-delete-msg-no-motion | |
1650 @item C-d | |
1651 Delete range, don't move to next message | |
1652 (@code{mh-delete-msg-no-motion}). | |
1653 @c ------------------------- | |
1654 @cindex @samp{Message > Delete Message} menu item | |
1655 @cindex menu item, @samp{Message > Delete Message} | |
1656 @kindex d | |
1657 @findex mh-delete-msg | |
1658 @item d | |
1659 Delete range (@code{mh-delete-msg}). | |
1660 @c ------------------------- | |
1661 @kindex D ? | |
1662 @findex mh-prefix-help | |
1663 @item D ? | |
1664 Display cheat sheet for the commands of the current prefix in | |
1665 minibuffer (@code{mh-prefix-help}). | |
1666 @c ------------------------- | |
1667 @kindex D @key{SPC} | |
1668 @findex mh-page-digest | |
1669 @item D @key{SPC} | |
1670 Display next message in digest (@code{mh-page-digest}). | |
1671 @c ------------------------- | |
1672 @kindex D @key{BS} | |
1673 @findex mh-page-digest-backwards | |
1674 @item D @key{BS} | |
1675 Display previous message in digest (@code{mh-page-digest-backwards}). | |
1676 @c ------------------------- | |
1677 @cindex @samp{Message > Burst Digest Message} menu item | |
1678 @cindex menu item, @samp{Message > Burst Digest Message} | |
1679 @kindex D b | |
1680 @findex mh-burst-digest | |
1681 @item D b | |
1682 Break up digest into separate messages (@code{mh-burst-digest}). | |
1683 @c ------------------------- | |
1684 @cindex @samp{Message > Go to Message by Number...} menu item | |
1685 @cindex menu item, @samp{Message > Go to Message by Number...} | |
1686 @kindex g | |
1687 @findex mh-goto-msg | |
1688 @item g | |
1689 Go to a message (@code{mh-goto-msg}). | |
1690 @c ------------------------- | |
1691 @kindex k | |
1692 @findex mh-delete-subject-or-thread | |
1693 @item k | |
1694 Delete messages with same subject or thread | |
1695 (@code{mh-delete-subject-or-thread}). | |
1696 @c ------------------------- | |
1697 @kindex K ? | |
1698 @findex mh-prefix-help | |
1699 @item K ? | |
1700 Display cheat sheet for the commands of the current prefix in | |
1701 minibuffer (@code{mh-prefix-help}). | |
1702 @c ------------------------- | |
1703 @kindex K @key{TAB} | |
1704 @findex mh-next-button | |
1705 @item K @key{TAB} | |
1706 Go to the next button (@code{mh-next-button}). | |
1707 @c ------------------------- | |
1708 @kindex K S-@key{TAB} | |
1709 @findex mh-prev-button | |
1710 @item K S-@key{TAB} | |
1711 Go to the previous button (@code{mh-prev-button}). | |
1712 @c ------------------------- | |
1713 @kindex K a | |
1714 @findex mh-mime-save-parts | |
1715 @item K a | |
1716 Save attachments (@code{mh-mime-save-parts}). | |
1717 @c ------------------------- | |
1718 @kindex K e | |
1719 @findex mh-display-with-external-viewer | |
1720 @item K e | |
1721 View attachment externally (@code{mh-display-with-external-viewer}). | |
1722 @c ------------------------- | |
1723 @kindex K i | |
1724 @findex mh-folder-inline-mime-part | |
1725 @item K i | |
1726 Show attachment verbatim (@code{mh-folder-inline-mime-part}). | |
1727 @c ------------------------- | |
1728 @kindex K o | |
1729 @findex mh-folder-save-mime-part | |
1730 @item K o | |
1731 Save (output) attachment (@code{mh-folder-save-mime-part}). | |
1732 @c ------------------------- | |
1733 @kindex K t | |
1734 @findex mh-toggle-mime-buttons | |
1735 @item K t | |
1736 Toggle option @code{mh-display-buttons-for-inline-parts-flag} | |
1737 (@code{mh-toggle-mime-buttons}). | |
1738 @c ------------------------- | |
1739 @kindex K v | |
1740 @findex mh-folder-toggle-mime-part | |
1741 @item K v | |
1742 View attachment (@code{mh-folder-toggle-mime-part}). | |
1743 @c ------------------------- | |
1744 @cindex @samp{Message > Modify Message} menu item | |
1745 @cindex menu item, @samp{Message > Modify Message} | |
1746 @kindex M | |
1747 @findex mh-modify | |
1748 @item M | |
1749 Edit message (@code{mh-modify}). | |
1750 @c ------------------------- | |
1751 @cindex @samp{Message > Go to First Message} menu item | |
1752 @cindex menu item, @samp{Message > Go to First Message} | |
1753 @kindex M-< | |
1754 @findex mh-first-msg | |
1755 @item M-< | |
1756 Display first message (@code{mh-first-msg}). | |
1757 @c ------------------------- | |
1758 @cindex @samp{Message > Go to Last Message} menu item | |
1759 @cindex menu item, @samp{Message > Go to Last Message} | |
1760 @kindex M-> | |
1761 @findex mh-last-msg | |
1762 @item M-> | |
1763 Display last message (@code{mh-last-msg}). | |
1764 @c ------------------------- | |
1765 @kindex M-n | |
1766 @findex mh-next-unread-msg | |
1767 @item M-n | |
1768 Display next unread message (@code{mh-next-unread-msg}). | |
1769 @c ------------------------- | |
1770 @kindex M-p | |
1771 @findex mh-previous-unread-msg | |
1772 @item M-p | |
1773 Display previous unread message (@code{mh-previous-unread-msg}). | |
1774 @c ------------------------- | |
1775 @cindex @samp{Message > Next Message} menu item | |
1776 @cindex menu item, @samp{Message > Next Message} | |
1777 @kindex n | |
1778 @findex mh-next-undeleted-msg | |
1779 @item n | |
1780 Display next message (@code{mh-next-undeleted-msg}). | |
1781 @c ------------------------- | |
1782 @cindex @samp{Message > Previous Message} menu item | |
1783 @cindex menu item, @samp{Message > Previous Message} | |
1784 @kindex p | |
1785 @findex mh-previous-undeleted-msg | |
1786 @item p | |
1787 Display previous message (@code{mh-previous-undeleted-msg}). | |
1788 @c ------------------------- | |
1789 @kindex P ? | |
1790 @findex mh-prefix-help | |
1791 @item P ? | |
1792 Display cheat sheet for the commands of the current prefix in | |
1793 minibuffer (@code{mh-prefix-help}). | |
1794 @c ------------------------- | |
1795 @kindex P C | |
1796 @findex mh-ps-print-toggle-color | |
1797 @item P C | |
1798 Toggle whether color is used in printing messages | |
1799 (@code{mh-ps-print-toggle-color}). | |
1800 @c ------------------------- | |
1801 @kindex P F | |
1802 @findex mh-ps-print-toggle-faces | |
1803 @item P F | |
1804 Toggle whether printing is done with faces or not | |
1805 (@code{mh-ps-print-toggle-faces}). | |
1806 @c ------------------------- | |
1807 @kindex P f | |
1808 @findex mh-ps-print-msg-file | |
1809 @item P f | |
1810 Print range to file (@code{mh-ps-print-msg-file}). | |
1811 @c ------------------------- | |
1812 @cindex @samp{Message > Print Message} menu item | |
1813 @cindex menu item, @samp{Message > Print Message} | |
1814 @kindex P l | |
1815 @findex mh-print-msg | |
1816 @item P l | |
1817 Print range the old fashioned way | |
1818 (@code{mh-print-msg}). | |
1819 @c ------------------------- | |
1820 @kindex P p | |
1821 @findex mh-ps-print-msg | |
1822 @item P p | |
1823 Print range (@code{mh-ps-print-msg}). | |
1824 @c ------------------------- | |
1825 @kindex X ? | |
1826 @findex mh-prefix-help | |
1827 @item X ? | |
1828 Display cheat sheet for the commands of the current prefix in | |
1829 minibuffer (@code{mh-prefix-help}). | |
1830 @c ------------------------- | |
1831 @cindex @samp{Message > Unpack Uuencoded Message...} menu item | |
1832 @cindex menu item, @samp{Message > Unpack Uuencoded Message...} | |
1833 @kindex X s | |
1834 @kindex X u | |
1835 @findex mh-store-msg | |
1836 @item X s | |
1837 @itemx X u | |
1838 Unpack message created with @command{uudecode} or @command{shar} | |
1839 (@code{mh-store-msg}). | |
1840 @c ------------------------- | |
1841 @kindex Mouse-2 | |
1842 @findex mh-show-mouse | |
1843 @item Mouse-2 | |
1844 Move point to mouse event and show message (@code{mh-show-mouse}). | |
1845 @end table | |
1846 | |
1847 Within the MH-Show buffer, the following command is defined. | |
1848 | |
1849 @table @kbd | |
1850 @kindex @key{RET} | |
1851 @kindex Mouse-1 | |
1852 @kindex Mouse-2 | |
1853 @findex mh-press-button | |
1854 @item @key{RET} | |
1855 @itemx Mouse-1 | |
1856 @itemx Mouse-2 | |
1857 View contents of button (@code{mh-press-button}). | |
1858 @end table | |
1859 | |
1860 @cindex @samp{mh-show} customization group | |
1861 @cindex customization group, @samp{mh-show} | |
1862 | |
1863 The following table lists options in the @samp{mh-show} customization | |
1864 group that are used while reading mail. | |
1865 | |
1866 @vtable @code | |
1867 @item mh-bury-show-buffer-flag | |
1868 On means show buffer is buried (default: @samp{on}). | |
1869 @c ------------------------- | |
1870 @item mh-clean-message-header-flag | |
1871 On means remove extraneous header fields (default: @samp{on}). | |
1872 @c ------------------------- | |
1873 @item mh-decode-mime-flag | |
1874 On means attachments are handled (default: @samp{on} if the Gnus | |
1875 @samp{mm-decode} package is present). | |
1876 @c ------------------------- | |
1877 @item mh-display-buttons-for-alternatives-flag | |
1878 On means display buttons for all alternative attachments (default: | |
1879 @samp{off}). | |
1880 @c ------------------------- | |
1881 @item mh-display-buttons-for-inline-parts-flag | |
1882 On means display buttons for all inline attachments (default: | |
1883 @samp{off}). | |
1884 @c ------------------------- | |
1885 @item mh-do-not-confirm-flag | |
1886 On means non-reversible commands do not prompt for confirmation | |
1887 (default: @samp{off}). | |
1888 @c ------------------------- | |
1889 @item mh-fetch-x-image-url | |
1890 Control fetching of @samp{X-Image-URL:} header field image (default: | |
1891 @samp{Never Fetch}). | |
1892 @c ------------------------- | |
1893 @item mh-graphical-smileys-flag | |
1894 On means graphical smileys are displayed (default: @samp{on}). | |
1895 @c ------------------------- | |
1896 @item mh-graphical-emphasis-flag | |
1897 On means graphical emphasis is displayed (default: @samp{on}). | |
1898 @c ------------------------- | |
1899 @item mh-highlight-citation-style | |
1900 Style for highlighting citations (default: @samp{Multicolor}). | |
1901 @c ------------------------- | |
1902 @item mh-invisible-header-fields-default | |
1903 List of hidden header fields (default: a checklist too long to list | |
1904 here). | |
1905 @c ------------------------- | |
1906 @item mh-invisible-header-fields | |
1907 Additional header fields to hide (default: @code{nil}). | |
1908 @c ------------------------- | |
1909 @item mh-lpr-command-format | |
1910 Command used to print (default: @code{"lpr -J '%s'"}). | |
1911 @c ------------------------- | |
1912 @item mh-max-inline-image-height | |
1913 Maximum inline image height if @samp{Content-Disposition:} is not | |
1914 present (default: 0). | |
1915 @c ------------------------- | |
1916 @item mh-max-inline-image-width | |
1917 Maximum inline image width if @samp{Content-Disposition:} is not | |
1918 present(default: 0). | |
1919 @c ------------------------- | |
1920 @item mh-mhl-format-file | |
1921 Specifies the format file to pass to the @command{mhl} program | |
1922 (default: @samp{Use Default mhl Format (Printing Only)}). | |
1923 @c ------------------------- | |
1924 @item mh-mime-save-parts-default-directory | |
1925 Default directory to use for @kbd{K a}. | |
1926 @c ------------------------- | |
1927 @item mh-print-background-flag | |
1928 On means messages should be printed in the background (default: | |
1929 @samp{off}). | |
1930 @c ------------------------- | |
1931 @item mh-show-buffer-mode-line-buffer-id | |
1932 Format string to produce @code{mode-line-buffer-identification} for | |
1933 show buffers (default: @code{" @{show-%s@} %d"}). | |
1934 @c ------------------------- | |
1935 @item mh-show-maximum-size | |
1936 Maximum size of message (in bytes) to display automatically (default: | |
1937 0). | |
1938 @c ------------------------- | |
1939 @item mh-show-use-xface-flag | |
1940 On means display face images in MH-Show buffers (default: @samp{on}). | |
1941 @c ------------------------- | |
1942 @item mh-store-default-directory | |
1943 Default directory for @kbd{X s} (default: @samp{Current}). | |
1944 @c ------------------------- | |
1945 @item mh-summary-height | |
1946 Number of lines in MH-Folder buffer (including the mode line) | |
1947 (default: depends on size of frame). | |
1948 @end vtable | |
1949 | |
1950 The following hooks are available. | |
1951 | |
1952 @vtable @code | |
1953 @item mh-delete-msg-hook | |
1954 Hook run after marking each message for deletion (default: @code{nil}). | |
1955 @c ------------------------- | |
1956 @item mh-show-hook | |
1957 Hook run after @key{RET} shows a message (default: @code{nil}). | |
1958 @c ------------------------- | |
1959 @item mh-show-mode-hook | |
1960 Hook run upon entry to @code{mh-show-mode} (default: @code{nil}). | |
1961 @end vtable | |
1962 | |
1963 The following faces are available. | |
1964 | |
1965 @vtable @code | |
1966 @item mh-show-cc | |
1967 Face used to highlight @samp{cc:} header fields. | |
1968 @c ------------------------- | |
1969 @item mh-show-date | |
1970 Face used to highlight @samp{Date:} header fields. | |
1971 @c ------------------------- | |
1972 @item mh-show-from | |
1973 Face used to highlight @samp{From:} header fields. | |
1974 @c ------------------------- | |
1975 @item mh-show-header | |
1976 Face used to deemphasize less interesting header fields. | |
1977 @c ------------------------- | |
1978 @item mh-show-pgg-bad | |
1979 Bad PGG signature face. | |
1980 @c ------------------------- | |
1981 @item mh-show-pgg-good | |
1982 Good PGG signature face. | |
1983 @c ------------------------- | |
1984 @item mh-show-pgg-unknown | |
1985 Unknown or untrusted PGG signature face. | |
1986 @c ------------------------- | |
1987 @item mh-show-signature | |
1988 Signature face. | |
1989 @c ------------------------- | |
1990 @item mh-show-subject | |
1991 Face used to highlight @samp{Subject:} header fields. | |
1992 @c ------------------------- | |
1993 @item mh-show-to | |
1994 Face used to highlight @samp{To:} header fields. | |
1995 @c ------------------------- | |
1996 @item mh-show-xface | |
1997 X-Face image face. | |
1998 @end vtable | |
1999 | |
2000 The functions and variables introduced here are explained in more | |
2001 detail in the following sections. | |
2002 | |
2003 @menu | |
2004 * Viewing:: | |
2005 * Viewing Attachments:: | |
2006 * HTML:: | |
2007 * Digests:: | |
2008 * Reading PGP:: | |
2009 * Printing:: | |
2010 * Files and Pipes:: | |
2011 * Navigating:: | |
2012 * Miscellaneous Commands and Options:: | |
2013 @end menu | |
2014 | |
2015 @node Viewing, Viewing Attachments, Reading Mail, Reading Mail | |
2016 @section Viewing Your Mail | |
2017 | |
2018 @findex mh-header-display | |
2019 @findex mh-page-msg | |
2020 @findex mh-previous-page | |
2021 @findex mh-show | |
2022 @findex mh-show-mouse | |
2023 @kindex , (comma) | |
2024 @kindex . (period) | |
2025 @kindex @key{BS} | |
2026 @kindex @key{RET} | |
2027 @kindex @key{SPC} | |
2028 @kindex Mouse-2 | |
2029 | |
2030 The command @key{RET} (@code{mh-show}) displays the message that the | |
2031 cursor is on while @kbd{Mouse-2} (@code{mh-show-mouse}) displays the | |
2032 message that the mouse cursor is on. If the message is already | |
2033 displayed, it scrolls to the beginning of the message. Use @key{SPC} | |
2034 (@code{mh-page-msg}) and @key{BS} (@code{mh-previous-page}) to move | |
2035 forwards and backwards one page at a time through the message. You can | |
2036 give either of these commands a prefix argument that specifies the | |
2037 number of lines to scroll (such as @kbd{10 @key{SPC}}). The @key{SPC} | |
2038 command will also show the next undeleted message if it is used at the | |
2039 bottom of a message. MH-E normally hides a lot of the superfluous | |
2040 header fields that mailers add to a message, but if you wish to see | |
2041 all of them, use the command @kbd{,} (comma; | |
2042 @code{mh-header-display}). | |
2043 | |
2044 @vindex mh-show-maximum-size | |
2045 | |
2046 The option @code{mh-show-maximum-size} provides an opportunity to skip | |
2047 over large messages which may be slow to load. The default value of 0 | |
2048 means that all message are shown regardless of size. | |
2049 | |
2050 A litany of options control what displayed messages look like. | |
2051 | |
2052 @vindex mh-show-cc | |
2053 @vindex mh-show-date | |
2054 @vindex mh-show-from | |
2055 @vindex mh-show-header | |
2056 @vindex mh-show-subject | |
2057 @vindex mh-show-to | |
2058 | |
2059 First, the appearance of the header fields can be modified by | |
2060 customizing the associated face: @code{mh-show-to}, @code{mh-show-cc}, | |
2061 @code{mh-show-from}, @code{mh-show-date}, and @code{mh-show-subject}. | |
2062 The face @code{mh-show-header} is used to deemphasize the other, less | |
2063 interesting, header fields. | |
2064 | |
2065 @cindex regular expressions, @code{mh-invisible-header-fields} | |
2066 @vindex mh-clean-message-header-flag | |
2067 @vindex mh-invisible-header-fields | |
2068 @vindex mh-invisible-header-fields-default | |
2069 | |
2070 Normally messages are delivered with a handful of uninteresting header | |
2071 fields. These are hidden by turning on the option | |
2072 @code{mh-clean-message-header-flag} (which it is by default). The | |
2073 header fields listed in the option | |
2074 @code{mh-invisible-header-fields-default} are hidden, although you can | |
2075 check off any field that you would like to see. Header fields that you | |
2076 would like to hide that aren't listed can be added to the option | |
2077 @code{mh-invisible-header-fields} with a couple of caveats. Regular | |
2078 expressions are not allowed. Unique fields should have a @samp{:} | |
2079 suffix; otherwise, the element can be used to render invisible an | |
2080 entire class of fields that start with the same prefix. If you think a | |
2081 header field should be generally ignored, report a bug (@pxref{Bug | |
2082 Reports}). | |
2083 | |
2084 @cindex header field, @samp{Face:} | |
2085 @cindex header field, @samp{X-Face:} | |
2086 @cindex header field, @samp{X-Image-URL:} | |
2087 @cindex @samp{Face:} header field | |
2088 @cindex @samp{X-Face:} header field | |
2089 @cindex @samp{X-Image-URL:} header field | |
2090 @vindex mh-show-use-xface-flag | |
2091 | |
2092 MH-E can display the content of @samp{Face:}, @samp{X-Face:}, and | |
2093 @samp{X-Image-URL:} header fields. If any of these fields occur in the | |
2094 header of your message, the sender's face will appear in the | |
2095 @samp{From:} header field. If more than one of these fields appear, | |
2096 then the first field found in the order @samp{Face:}, @samp{X-Face:}, | |
2097 and @samp{X-Image-URL:} will be used. The option | |
2098 @code{mh-show-use-xface-flag} is used to turn this feature on and off. | |
2099 This feature will be turned on by default if your system supports it. | |
2100 | |
2101 The first header field used, if present, is the Gnus-specific | |
2102 @samp{Face:} field@footnote{The @samp{Face:} field appeared in GNU | |
2103 Emacs 21 and XEmacs. For more information, see | |
2104 @uref{http://quimby.gnus.org/circus/face/}.}. | |
2105 | |
2106 @cindex @command{uncompface} | |
2107 @cindex Emacs, packages, x-face | |
2108 @cindex Unix commands, @command{uncompface} | |
2109 @cindex x-face package | |
2110 @vindex mh-show-xface | |
2111 | |
2112 Next is the traditional @samp{X-Face:} header field@footnote{The | |
2113 display of this field requires the | |
2114 @uref{ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z, | |
2115 @command{uncompface} program}. Recent versions of XEmacs have internal | |
2116 support for @samp{X-Face:} images. If your version of XEmacs does not, | |
2117 then you'll need both @command{uncompface} and the | |
2118 @uref{ftp://ftp.jpl.org/pub/elisp/, @samp{x-face} package}.}. MH-E | |
2119 renders the foreground and background of the image using the | |
2120 associated attributes of the face @code{mh-show-xface}. | |
2121 | |
2122 @cindex @command{convert} | |
2123 @cindex @command{wget} | |
2124 @cindex ImageMagick | |
2125 @cindex Unix commands, @command{convert} | |
2126 @cindex Unix commands, @command{wget} | |
2127 @vindex mh-fetch-x-image-url | |
2128 | |
2129 Finally, MH-E will display images referenced by the | |
2130 @samp{X-Image-URL:} header field if neither the @samp{Face:} nor the | |
2131 @samp{X-Face:} fields are present@footnote{The display of the images | |
2132 requires the @uref{http://www.gnu.org/software/wget/wget.html, | |
2133 @command{wget} program} to fetch the image and the @command{convert} | |
2134 program from the @uref{http://www.imagemagick.org/, ImageMagick | |
2135 suite}.}. Of the three header fields this is the most efficient in | |
2136 terms of network usage since the image doesn't need to be transmitted | |
2137 with every single mail. The option @code{mh-fetch-x-image-url} | |
2138 controls the fetching of the @samp{X-Image-URL:} header field image | |
2139 with the following values: | |
2140 | |
2141 @table @samp | |
2142 @item Ask Before Fetching | |
2143 You are prompted before the image is fetched. MH-E will remember your | |
2144 reply and will either use the already fetched image the next time the | |
2145 same URL is encountered or silently skip it if you didn't fetch it the | |
2146 first time. This is a good setting. | |
2147 @c ------------------------- | |
2148 @item Never Fetch | |
2149 Images are never fetched and only displayed if they are already | |
2150 present in the cache. This is the default. | |
2151 @end table | |
2152 | |
2153 There isn't a value of @samp{Always Fetch} for privacy and DOS (denial | |
2154 of service) reasons. For example, fetching a URL can tip off a spammer | |
2155 that you've read his email (which is why you shouldn't blindly answer | |
2156 yes if you've set this option to @samp{Ask Before Fetching}). Someone | |
2157 may also flood your network and fill your disk drive by sending a | |
2158 torrent of messages, each specifying a unique URL to a very large | |
2159 file. | |
2160 | |
2161 @cindex @file{.mhe-x-image-cache} | |
2162 @cindex files, @file{.mhe-x-image-cache} | |
2163 | |
2164 The cache of images is found in the directory | |
2165 @file{.mhe-x-image-cache} within your MH directory. You can add your | |
2166 own face to the @samp{From:} field too. @xref{Picture}. | |
2167 | |
2168 @cindex @command{mhl} | |
2169 @cindex MH commands, @command{mhl} | |
2170 @vindex mh-mhl-format-file | |
2171 | |
2172 Normally MH-E takes care of displaying messages itself (rather than | |
2173 calling an MH program to do the work). If you'd rather have | |
2174 @command{mhl} display the message (within MH-E), change the option | |
2175 @code{mh-mhl-format-file} from its default value of @samp{Use Default | |
2176 mhl Format (Printing Only)}. You can set this option to @samp{Use | |
2177 Default mhl Format} to get the same output as you would get if you ran | |
2178 @command{mhl} from the shell. If you have a format file that you want | |
2179 MH-E to use, you can set this option to @samp{Specify an mhl Format | |
2180 File} and enter the name of your format file (@command{mhl}(1) or | |
2181 section @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in | |
2182 the MH book tells you how to write one). Your format file should | |
2183 specify a non-zero value for @samp{overflowoffset} to allow MH-E to | |
2184 parse the header. Note that @command{mhl} is always used for printing | |
2185 and forwarding; in this case, the value of @code{mh-mhl-format-file} | |
2186 is consulted if you have specified a format file. | |
2187 | |
2188 @cindex citations, highlighting | |
2189 @cindex highlighting citations | |
2190 @vindex mh-highlight-citation-style | |
2191 | |
2192 If the sender of the message has cited other messages in his message, | |
2193 then MH-E will highlight these citations to emphasize the sender's | |
2194 actual response. The option @code{mh-highlight-citation-style} can be | |
2195 customized to change the highlighting style. The @samp{Multicolor} | |
2196 method uses a different color for each indentation while the | |
2197 @samp{Monotone} method highlights all citations in red. To disable | |
2198 highlighting of citations entirely, choose @samp{None}. | |
2199 | |
2200 @cindex URLs, highlighting | |
2201 @cindex email addresses, highlighting | |
2202 @cindex highlighting URLs | |
2203 @cindex highlighting email addresses | |
2204 @cindex links, following | |
2205 @findex goto-address-at-point | |
2206 @kindex C-c @key{RET} | |
2207 @kindex Mouse-2 | |
2208 @vindex goto-address-highlight-p | |
2209 | |
2210 Email addresses and URLs in the message are highlighted if the option | |
2211 @code{goto-address-highlight-p} is on, which it is by default. To view | |
2212 the web page for a highlighted URL or to send a message using a | |
2213 highlighted email address, use @kbd{Mouse-2} or @kbd{C-c @key{RET}} | |
2214 (@code{goto-address-at-point}). @xref{Sending Mail}, to see how to | |
2215 configure Emacs to send the message using MH-E. | |
2216 | |
2217 @cindex boldface, showing | |
2218 @cindex emphasis | |
2219 @cindex italics, showing | |
2220 @cindex smileys | |
2221 @cindex typesetting | |
2222 @cindex underline, showing | |
2223 @vindex gnus-emphasis-alist | |
2224 @vindex mh-decode-mime-flag | |
2225 @vindex mh-graphical-emphasis-flag | |
2226 @vindex mh-graphical-smileys-flag | |
2227 | |
2228 It is a long standing custom to inject body language using a | |
2229 cornucopia of punctuation, also known as the @dfn{smileys}. MH-E can | |
2230 render these as graphical widgets if the option | |
2231 @code{mh-graphical-smileys-flag} is turned on, which it is by default. | |
2232 Smileys include patterns such as :-) and ;-). Similarly, a few | |
2233 typesetting features are indicated in ASCII text with certain | |
2234 characters. If your terminal supports it, MH-E can render these | |
2235 typesetting directives naturally if the option | |
2236 @code{mh-graphical-emphasis-flag} is turned on, which it is by | |
2237 default. For example, _underline_ will be | |
2238 @ifhtml | |
2239 @html | |
2240 <u>underlined</u>, | |
2241 @end html | |
2242 @end ifhtml | |
2243 @ifnothtml | |
2244 underlined, | |
2245 @end ifnothtml | |
2246 *bold* will appear in @b{bold}, /italics/ will appear in @i{italics}, | |
2247 and so on. See the option @code{gnus-emphasis-alist} for the whole | |
2248 list. Both of these options are disabled if the option | |
2249 @code{mh-decode-mime-flag} is turned off. @xref{Viewing Attachments}. | |
2250 | |
2251 @cindex signature separator | |
2252 @cindex vCard | |
2253 @vindex mh-show-signature | |
2254 | |
2255 MH-E normally renders signatures and vCards in italics so that the | |
2256 body of the message stands out more. MH-E depends on the presence of | |
2257 the @dfn{signature separator} (@code{"-- "}) to do this. You can also | |
2258 customize the face @code{mh-show-signature} so the appearance of the | |
2259 signature block is more to your liking. | |
2260 | |
2261 @vindex mh-show-hook | |
2262 @vindex mh-show-mode-hook | |
2263 | |
2264 Two hooks can be used to control how messages are displayed. The first | |
2265 hook, @code{mh-show-mode-hook}, is called early on in the process of | |
2266 the message display. It is usually used to perform some action on the | |
2267 message's content. The second hook, @code{mh-show-hook}, is the last | |
2268 thing called after messages are displayed. It's used to affect the | |
2269 behavior of MH-E in general or when @code{mh-show-mode-hook} is too | |
2270 early. | |
2271 | |
2272 @cindex MH-Show mode | |
2273 @cindex modes, MH-Show | |
2274 @vindex mh-show-buffer-mode-line-buffer-id | |
2275 | |
2276 For those who like to modify their mode lines, use | |
2277 @code{mh-show-buffer-mode-line-buffer-id} to modify the mode line in | |
2278 the MH-Show buffers. Place the two escape strings @samp{%s} and | |
2279 @samp{%d}, which will display the folder name and the message number, | |
2280 respectively, somewhere in the string in that order. The default value | |
2281 of @code{"@{show-%s@} %d"} yields a mode line of | |
2282 | |
2283 @smallexample | |
2284 -----@{show-+inbox@} 4 (MH-Show)--Bot-------------------------------- | |
2285 @end smallexample | |
2286 | |
2287 @node Viewing Attachments, HTML, Viewing, Reading Mail | |
2288 @section Viewing Attachments | |
2289 | |
2290 @cindex attachments | |
2291 @cindex body parts | |
2292 @cindex @command{mhshow} | |
2293 @cindex @command{show} | |
2294 @cindex MH commands, @command{mhshow} | |
2295 @cindex MH commands, @command{show} | |
2296 @cindex MIME | |
2297 @cindex multimedia mail | |
2298 | |
2299 MH has the ability to display @dfn{@sc{mime}} (Multipurpose Internet | |
2300 Mail Extensions) messages which are simply messages with additional | |
2301 @dfn{body parts} or @dfn{attachments}. You can use the MH commands | |
2302 @command{show}@footnote{See the section | |
2303 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next | |
2304 prev} in the MH book.} or @command{mhshow}@footnote{See the section | |
2305 @uref{@value{MH-BOOK-HOME}/usimim.html#ReMIMa, Reading MIME Mail} in | |
2306 the MH book.} from the shell to read @sc{mime} messages@footnote{You | |
2307 can call them directly from Emacs if you're running the X Window | |
2308 System: type @kbd{M-! xterm -e mhshow @var{message-number}}. You can | |
2309 leave out the @samp{xterm -e} if you use @command{mhlist} or | |
2310 @command{mhstore}.}. | |
2311 | |
2312 @cindex Emacs, packages, mm-decode | |
2313 @cindex mm-decode package | |
2314 @findex mh-toggle-mh-decode-mime-flag | |
2315 @kindex ; (semicolon) | |
2316 @vindex mh-decode-mime-flag | |
2317 | |
2318 MH-E can handle attachments as well if the Gnus @samp{mm-decode} | |
2319 package is present. If so, the option @code{mh-decode-mime-flag} will | |
2320 be on. Otherwise, you'll see the @sc{mime} body parts rather than text | |
2321 or attachments. There isn't much point in turning off the option | |
2322 @code{mh-decode-mime-flag}; however, you can inspect it if it appears | |
2323 that the body parts are not being interpreted correctly or toggle it | |
2324 with the command @kbd{;} (semicolon; | |
2325 @code{mh-toggle-mh-decode-mime-flag}) to view the raw message. This | |
2326 option also controls the display of quoted-printable messages and | |
2327 other graphical widgets. @xref{Viewing}. | |
2328 | |
2329 @cindex buttons | |
2330 | |
2331 Attachments in MH-E are indicated by @dfn{buttons} like this: | |
2332 | |
2333 @smallexample | |
2334 [1. image/jpeg; foo.jpg]... | |
2335 @end smallexample | |
2336 | |
2337 @findex mh-next-button | |
2338 @findex mh-press-button | |
2339 @findex mh-prev-button | |
2340 @kindex @key{RET} | |
2341 @kindex K @key{TAB} | |
2342 @kindex K S-@key{TAB} | |
2343 @kindex Mouse-1 | |
2344 @kindex Mouse-2 | |
2345 | |
2346 To view the contents of the button, use either @kbd{Mouse-1} or | |
2347 @kbd{Mouse-2} on the button or @key{RET} (@code{mh-press-button}) when | |
2348 the cursor is over the button. This command is a toggle so if you use | |
2349 it again on the same attachment, it is hidden. If Emacs does not know | |
2350 how to display the attachment, then Emacs offers to save the | |
2351 attachment in a file. To move the cursor to the next button, use the | |
2352 command @kbd{K @key{TAB}} (@code{mh-next-button}). If the end of the | |
2353 buffer is reached then the search wraps over to the start of the | |
2354 buffer. To move the cursor to the previous button, use the command | |
2355 @kbd{K S-@key{TAB}} (@code{mh-prev-button}). If the beginning of the | |
2356 buffer is reached then the search wraps over to the end of the buffer. | |
2357 | |
2358 @cindex attachments, viewing | |
2359 @cindex viewing attachments | |
2360 @findex mh-folder-toggle-mime-part | |
2361 @kindex K v | |
2362 | |
2363 Another way to view the contents of a button is to use the command | |
2364 @kbd{K v} (@code{mh-folder-toggle-mime-part}). This command displays | |
2365 (or hides) the attachment associated with the button under the cursor. | |
2366 If the cursor is not located over a button, then the cursor first | |
2367 moves to the next button, wrapping to the beginning of the message if | |
2368 necessary. This command has the advantage over the previous commands | |
2369 of working from the MH-Folder buffer. You can also provide a numeric | |
2370 prefix argument (as in @kbd{4 K v}) to view the attachment labeled | |
2371 with that number. If Emacs does not know how to display the | |
2372 attachment, then Emacs offers to save the attachment in a file. | |
2373 | |
2374 @cindex @file{/etc/mailcap} | |
2375 @cindex files, @file{/etc/mailcap} | |
2376 @findex mailcap-mime-info | |
2377 @findex mh-display-with-external-viewer | |
2378 @kindex K e | |
2379 | |
2380 If Emacs does not know how to view an attachment, you could save it | |
2381 into a file and then run some program to open it. It is easier, | |
2382 however, to launch the program directly from MH-E with the command | |
2383 @kbd{K e} (@code{mh-display-with-external-viewer}). While you'll most | |
2384 likely use this to view spreadsheets and documents, it is also useful | |
2385 to use your browser to view HTML attachments with higher fidelity than | |
2386 what Emacs can provide. This command displays the attachment | |
2387 associated with the button under the cursor. If the cursor is not | |
2388 located over a button, then the cursor first moves to the next button, | |
2389 wrapping to the beginning of the message if necessary. You can provide | |
2390 a numeric prefix argument (as in @kbd{4 K e}) to view the attachment | |
2391 labeled with that number. This command tries to provide a reasonable | |
2392 default for the viewer by calling the Emacs function | |
2393 @code{mailcap-mime-info}. This function usually reads the file | |
2394 @file{/etc/mailcap}. | |
2395 | |
2396 @cindex attachments, saving | |
2397 @cindex saving attachments | |
2398 @findex mh-folder-save-mime-part | |
2399 @kindex K o | |
2400 | |
2401 Use the command @kbd{K o} (@code{mh-folder-save-mime-part}) to save | |
2402 attachments (the mnemonic is ``output''). This command saves the | |
2403 attachment associated with the button under the cursor. If the cursor | |
2404 is not located over a button, then the cursor first moves to the next | |
2405 button, wrapping to the beginning of the message if necessary. You can | |
2406 also provide a numeric prefix argument (as in @kbd{3 K o}) to save the | |
2407 attachment labeled with that number. This command prompts you for a | |
2408 filename and suggests a specific name if it is available. | |
2409 | |
2410 @cindex @command{mhn} | |
2411 @cindex @command{mhstore} | |
2412 @cindex MH commands, @command{mhn} | |
2413 @cindex MH commands, @command{mhstore} | |
2414 @findex mh-mime-save-parts | |
2415 @kindex K a | |
2416 @vindex mh-mime-save-parts-default-directory | |
2417 | |
2418 You can save all of the attachments at once with the command @kbd{K a} | |
2419 (@code{mh-mime-save-parts}). The attachments are saved in the | |
2420 directory specified by the option | |
2421 @code{mh-mime-save-parts-default-directory} unless you use a prefix | |
2422 argument (as in @kbd{C-u K a}) in which case you are prompted for the | |
2423 directory. These directories may be superseded by MH profile | |
2424 components, since this function calls on @command{mhstore} | |
2425 (@command{mhn}) to do the work. | |
2426 | |
2427 @vindex mh-mime-save-parts-default-directory | |
2428 | |
2429 The default value for the option | |
2430 @code{mh-mime-save-parts-default-directory} is @samp{Prompt Always} so | |
2431 that you are always prompted for the directory in which to save the | |
2432 attachments. However, if you usually use the same directory within a | |
2433 session, then you can set this option to @samp{Prompt the First Time} | |
2434 to avoid the prompt each time. you can make this directory permanent | |
2435 by choosing @samp{Directory} and entering the directory's name. | |
2436 | |
2437 @cindex attachments, inline | |
2438 @cindex inline attachments | |
2439 @findex mh-toggle-mime-buttons | |
2440 @kindex K t | |
2441 @vindex mh-display-buttons-for-inline-parts-flag | |
2442 | |
2443 The sender can request that attachments should be viewed inline so | |
2444 that they do not really appear like an attachment at all to the | |
2445 reader. Most of the time, this is desirable, so by default MH-E | |
2446 suppresses the buttons for inline attachments. On the other hand, you | |
2447 may receive code or HTML which the sender has added to his message as | |
2448 inline attachments so that you can read them in MH-E. In this case, it | |
2449 is useful to see the buttons so that you know you don't have to cut | |
2450 and paste the code into a file; you can simply save the attachment. If | |
2451 you want to make the buttons visible for inline attachments, you can | |
2452 use the command @kbd{K t} (@code{mh-toggle-mime-buttons}) to toggle | |
2453 the visibility of these buttons. You can turn on these buttons | |
2454 permanently by turning on the option | |
2455 @code{mh-display-buttons-for-inline-parts-flag}. | |
2456 | |
2457 MH-E cannot display all attachments inline however. It can display | |
2458 text (including @sc{html}) and images. | |
2459 | |
2460 @cindex header field, @samp{Content-Disposition:} | |
2461 @cindex inline images | |
2462 @cindex @samp{Content-Disposition:} header field | |
2463 @vindex mh-max-inline-image-height | |
2464 @vindex mh-max-inline-image-width | |
2465 | |
2466 Some older mail programs do not insert the needed | |
2467 plumbing@footnote{This plumbing is the @samp{Content-Disposition:} | |
2468 header field.} to tell MH-E whether to display the attachments inline | |
2469 or not. If this is the case, MH-E will display these images inline if | |
2470 they are smaller than the window. However, you might want to allow | |
2471 larger images to be displayed inline. To do this, you can change the | |
2472 options @code{mh-max-inline-image-width} and | |
2473 @code{mh-max-inline-image-height} from their default value of zero to | |
2474 a large number. The size of your screen is a good choice for these | |
2475 numbers. | |
2476 | |
2477 @cindex alternatives | |
2478 @cindex attachments, alternatives | |
2479 @vindex mh-display-buttons-for-alternatives-flag | |
2480 | |
2481 Sometimes, a mail program will produce multiple alternatives of an | |
2482 attachment in increasing degree of faithfulness to the original | |
2483 content. By default, only the preferred alternative is displayed. If | |
2484 the option @code{mh-display-buttons-for-alternatives-flag} is on, then | |
2485 the preferred part is shown inline and buttons are shown for each of | |
2486 the other alternatives. | |
2487 | |
2488 @vindex mm-discouraged-alternatives | |
2489 | |
2490 Many people prefer to see the @samp{text/plain} alternative rather | |
2491 than the @samp{text/html} alternative. To do this in MH-E, customize | |
2492 the option @code{mm-discouraged-alternatives}, and add | |
2493 @samp{text/html}. The next best alternative, if any, will be shown. | |
2494 | |
2495 @kindex K i | |
2496 @findex mh-folder-inline-mime-part | |
2497 | |
2498 You can view the raw contents of an attachment with the command @kbd{K | |
2499 i} (@code{mh-folder-inline-mime-part}). This command displays (or | |
2500 hides) the contents of the attachment associated with the button under | |
2501 the cursor verbatim. If the cursor is not located over a button, then | |
2502 the cursor first moves to the next button, wrapping to the beginning | |
2503 of the message if necessary. You can also provide a numeric prefix | |
2504 argument (as in @kbd{4 K i}) to view the attachment labeled with that | |
2505 number. | |
2506 | |
2507 For additional information on buttons, see | |
2508 @ifinfo | |
2509 @ref{Article Buttons,,,gnus}, and @ref{MIME Commands,,,gnus}. | |
2510 @end ifinfo | |
2511 @ifnotinfo | |
2512 the chapters @uref{http://www.gnus.org/manual/gnus_101.html#SEC101, | |
2513 Article Buttons} and | |
2514 @uref{http://www.gnus.org/manual/gnus_108.html#SEC108, MIME Commands} | |
2515 in the @cite{The Gnus Manual}. | |
2516 @end ifnotinfo | |
2517 | |
2518 @node HTML, Digests, Viewing Attachments, Reading Mail | |
2519 @section HTML | |
2520 | |
2521 @cindex HTML | |
2522 @cindex Gnus | |
2523 | |
2524 MH-E can display messages that have been sent in HTML@footnote{This | |
2525 feature depends on a version of Gnus that is at least 5.10.}. The | |
2526 content of the message will appear in the MH-Show buffer as you would | |
2527 expect if the entire message is HTML, or there is an inline HTML body | |
2528 part. However, if there is an HTML body part that is an attachment, | |
2529 then you'll see a button like this: | |
2530 | |
2531 @smallexample | |
2532 [1. text/html; foo.html]... | |
2533 @end smallexample | |
2534 | |
2535 To see how to read the contents of this body part, see @ref{Viewing | |
2536 Attachments}. | |
2537 | |
2538 @vindex mm-text-html-renderer | |
2539 | |
2540 The browser that MH-E uses is determined by the option | |
2541 @code{mm-text-html-renderer}. The default setting is set automatically | |
2542 based upon the presence of a known browser on your system. If you wish | |
2543 to use a different browser, then set this option accordingly. See the | |
2544 documentation for the browser you use for additional information on | |
2545 how to use it. In particular, find and disable the option to render | |
2546 images as this can tip off spammers that the email address they have | |
2547 used is valid. | |
2548 | |
2549 @vindex mm-text-html-renderer | |
2550 | |
2551 If you're confused about which @code{mm-text-html-renderer} to use, | |
2552 here's a brief description of each, sorted by popularity, that | |
2553 includes the results of a quick poll of MH-E users from 2005-12-23. | |
2554 | |
2555 @table @asis | |
2556 @cindex browser, @samp{w3m} | |
2557 @cindex @samp{w3m} | |
2558 @kindex Mouse-2 | |
2559 @item @samp{w3m} 7 | |
2560 The @samp{w3m} browser requires an external program. It's quick, | |
2561 produces pretty nice output, and best of all, it's the only browser | |
2562 that highlights links. These can be clicked with @kbd{Mouse-2} to view | |
84934
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2563 the content of the link in @samp{w3m}. The @samp{w3m} browser handles |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2564 tables well and actually respects the table's width parameter (which |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2565 can cause text to wrap if the author didn't anticipate that the page |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2566 would be viewed in Emacs). |
84306 | 2567 @c ------------------------- |
2568 @cindex browser, @samp{w3m-standalone} | |
2569 @cindex @samp{w3m-standalone} | |
2570 @item @samp{w3m-standalone} 3 | |
2571 This browser, along with @samp{nil} for the external browser, are the | |
2572 only choices that work without having to download a separate lisp | |
2573 package or external program. This browser is quick, but does not show | |
2574 links. It handles simple tables but some tables get rendered much | |
2575 wider than the Emacs frame. This browser was the only one not to | |
2576 handle the escape @samp{–} (it printed a @samp{?}), but it did | |
2577 render @samp{®}. | |
2578 @c ------------------------- | |
2579 @cindex browser, @samp{links} | |
2580 @cindex @samp{links} | |
2581 @item @samp{links} 1 | |
2582 The @samp{links} browser requires an external program. It's quick, and | |
2583 produces nicer output than @samp{lynx} on single column mails in | |
2584 tables. However, it doesn't show links and it doesn't do as nice a job | |
2585 on multi-column tables as some lines wrap. At least it fits in 80 | |
2586 columns and thus seems better than @samp{w3} and | |
2587 @samp{w3m-standalone}. Converts escapes such as @samp{®} to (R). | |
2588 @c ------------------------- | |
2589 @cindex browser, @samp{lynx} | |
2590 @cindex @samp{lynx} | |
2591 @item @samp{lynx} 1 | |
2592 The @samp{lynx} browser requires an external program. It's quick and | |
2593 produces pretty decent output but it doesn't show links. It doesn't | |
2594 seem to do multi-column tables which makes output much cleaner. It | |
2595 centers the output and wraps long lines more than most. Handles | |
2596 @samp{®}. | |
2597 @c ------------------------- | |
2598 @item @samp{nil} 1 | |
2599 This choice obviously requires an external browser. Like | |
2600 @samp{w3m-standalone}, it works out of the box. With this setting, | |
2601 HTML messages have a button for the body part which you can view with | |
2602 @kbd{K v} (@code{mh-folder-toggle-mime-part}). | |
2603 @c ------------------------- | |
2604 @cindex browser, @samp{w3} | |
2605 @cindex @samp{w3} | |
2606 @item @samp{w3} 0 | |
2607 This choice does not require an external program as all of the | |
2608 rendering is done in lisp. You do need to get the package separately. | |
2609 This browser is @strong{slow}, and doesn't appear to have been updated | |
2610 since 2001 and the author hasn't responded to my emails. It displays | |
2611 unknown tags instead of hiding them, so you get to see all the | |
2612 Microsoft crap in certain messages. Tends to make multi-column tables | |
2613 wider than even a full-screen Emacs can handle. Like @samp{w3m}, you | |
2614 can follow links, but you have to find them first as they are not | |
2615 highlighted. Performs well on single-column tables and handles escapes | |
2616 such as @samp{®}. | |
2617 @c ------------------------- | |
2618 @cindex browser, @samp{html2text} | |
2619 @cindex @samp{html2text} | |
2620 @item @samp{html2text} 0 | |
2621 The @samp{html2text} browser requires an external program. I noticed | |
2622 that it can do some nasty things with simple HTML mails (like filling | |
2623 the entire message as if it were one paragraph, including signature). | |
2624 On another message, it displayed half of the HTML tags for some | |
2625 reason. | |
2626 @end table | |
2627 | |
2628 @vindex mm-text-html-renderer | |
2629 | |
2630 For a couple more sources of information about | |
2631 @code{mm-text-html-renderer}, | |
2632 @ifinfo | |
2633 @xref{Display Customization,,,emacs-mime}, and the documentation for | |
2634 the Gnus command @kbd{W h} (@pxref{Article Washing,,,gnus},). | |
2635 @end ifinfo | |
2636 @ifnotinfo | |
2637 see section @uref{http://www.gnus.org/manual/emacs-mime_6.html, | |
2638 Display Customization} in the @cite{The Emacs MIME Manual} and the | |
2639 documentation for the Gnus command @kbd{W h} (see section | |
2640 @uref{http://www.gnus.org/manual/gnus_99.html, Article Washing} in the | |
2641 @cite{The Gnus Manual}). | |
2642 @end ifnotinfo | |
2643 | |
84934
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2644 @cindex @file{.emacs} |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2645 @cindex files, @file{.emacs} |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2646 @findex browse-url-at-mouse |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2647 @kindex S-Mouse-2 |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2648 |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2649 A useful key binding that you can add to to @file{~/.emacs} is the |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2650 following which displays an HTML link or textual URL in an external |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2651 browser when clicked with @kbd{S-mouse-2}. This binding works in any |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2652 buffer, including HTML buffers. |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2653 |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2654 @smalllisp |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2655 (global-set-key [S-mouse-2] 'browse-url-at-mouse) |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2656 @end smalllisp |
659f550b9193
(HTML): Mention binding of S-mouse-2 to browse-url-at-mouse.
Bill Wohler <wohler@newt.com>
parents:
84329
diff
changeset
|
2657 |
84306 | 2658 @node Digests, Reading PGP, HTML, Reading Mail |
2659 @section Digests | |
2660 | |
2661 @cindex digests | |
2662 @findex mh-page-digest | |
2663 @findex mh-page-digest-backwards | |
2664 @kindex D @key{BS} | |
2665 @kindex D @key{SPC} | |
2666 @kindex @key{BS} | |
2667 @kindex @key{SPC} | |
2668 | |
2669 A digest is a message that contains other messages. Special MH-E | |
2670 commands let you read digests conveniently. You can use @key{SPC} and | |
2671 @key{BS} to page through the digest as if it were a normal message, | |
2672 but if you wish to skip to the next message in the digest, use | |
2673 @kbd{D @key{SPC}} (@code{mh-page-digest}). To return to a previous message, | |
2674 use @kbd{D @key{BS}} (@code{mh-page-digest-backwards}). | |
2675 | |
2676 @cindex @command{burst} | |
2677 @cindex MH commands, @command{burst} | |
2678 @cindex MH-Folder Show mode | |
2679 @cindex modes, MH-Folder Show | |
2680 @findex mh-burst-digest | |
2681 @kindex d | |
2682 @kindex D b | |
2683 @kindex t | |
2684 | |
2685 Another handy command is @kbd{D b} (@code{mh-burst-digest}). This | |
2686 command uses the MH command @command{burst}@footnote{See the section | |
2687 @uref{@value{MH-BOOK-HOME}/burdig.html, Bursting Messages} in the MH | |
2688 book.} to break out each message in the digest into its own message. | |
2689 Using this command, you can quickly delete unwanted messages, like | |
2690 this: Once the digest is split up, toggle out of MH-Folder Show mode | |
2691 with @kbd{t} (@pxref{Folders}) so that the scan lines fill the screen | |
2692 and messages aren't displayed. Then use @kbd{d} (@pxref{Reading Mail}) | |
2693 to quickly delete messages that you don't want to read (based on the | |
2694 @samp{Subject:} header field). You can also burst the digest to reply | |
2695 directly to the people who posted the messages in the digest. One | |
2696 problem you may encounter is that the @samp{From:} header fields are | |
2697 preceded with a @samp{>} so that your reply can't create the | |
2698 @samp{To:} field correctly. In this case, you must correct the | |
2699 @samp{To:} field yourself. This is described later (@pxref{Editing | |
2700 Drafts}). | |
2701 | |
2702 @node Reading PGP, Printing, Digests, Reading Mail | |
2703 @section Signed and Encrypted Messages | |
2704 | |
2705 @cindex GPG | |
2706 @cindex GnuPG | |
2707 @cindex Gnus | |
2708 @cindex OpenPGP | |
2709 @cindex PGP | |
2710 @cindex RFC 3156 | |
2711 @cindex encrypted messages | |
2712 @cindex security | |
2713 @cindex signed messages | |
2714 | |
2715 You can read encrypted or signed PGP or GPG messages with | |
2716 MH-E@footnote{This feature depends on post-5.10 versions of Gnus. | |
2717 @cite{MIME Security with OpenPGP} is documented in | |
2718 @uref{http://www.rfc-editor.org/rfc/rfc3156.txt, RFC 3156}. However, | |
2719 MH-E can also decrypt old-style PGP messages that are not in MIME | |
2720 format.}. This section assumes that you already have a good | |
2721 understanding of GPG and have set up your keys appropriately. | |
2722 | |
2723 If someone sends you a signed message, here is what you'll see: | |
2724 | |
2725 @smallexample | |
2726 @group | |
2727 [[PGP Signed Part:Bill Wohler <wohler@@stop.mail-abuse.org>]] | |
2728 This is a signed message. | |
2729 | |
2730 [[End of PGP Signed Part]] | |
2731 @end group | |
2732 @end smallexample | |
2733 | |
2734 @cindex keychain | |
2735 @cindex key server | |
2736 @cindex signed messages | |
2737 | |
2738 If the key for the given signature is not in your keychain, you'll be | |
2739 given the opportunity to fetch the key from a key server and verify | |
2740 the key. If the message is really large, the verification process can | |
2741 take a long time. You can press @kbd{C-g} at any time to | |
2742 cancel@footnote{Unfortunately in the current version, the validation | |
2743 process doesn't display a message so it appears that MH-E has hung. We | |
2744 hope that this will be fixed in the future.}. | |
2745 | |
2746 If the signature doesn't check out, you might see something like this: | |
2747 | |
2748 @smallexample | |
2749 @group | |
2750 [[PGP Signed Part:Failed]] | |
2751 This is a signed message. | |
2752 This is garbage added after the signature was made. | |
2753 | |
2754 [[End of PGP Signed Part]] | |
2755 @end group | |
2756 @end smallexample | |
2757 | |
2758 @cindex decrypting messages | |
2759 | |
2760 If someone sends you an encrypted message, MH-E will ask for your | |
2761 passphrase to decrypt the message. You should see something like this: | |
2762 | |
2763 @smallexample | |
2764 @group | |
2765 [[PGP Encrypted Part:OK]] | |
2766 | |
2767 [[PGP Signed Part:Bill Wohler <wohler@@stop.mail-abuse.org>]] | |
2768 This is the secret message. | |
2769 | |
2770 [[End of PGP Signed Part]] | |
2771 | |
2772 [[End of PGP Encrypted Part]] | |
2773 @end group | |
2774 @end smallexample | |
2775 | |
2776 If there is a problem decrypting the message, the button will say: | |
2777 | |
2778 @smallexample | |
2779 [[PGP Encrypted Part:Failed]] | |
2780 @end smallexample | |
2781 | |
2782 You can read the contents of this button using the methods described in | |
2783 @ref{Viewing Attachments}. If the message were corrupted, you'd see | |
2784 this: | |
2785 | |
2786 @smallexample | |
2787 [[PGP Encrypted Part:Failed] | |
2788 Invalid base64 data] | |
2789 @end smallexample | |
2790 | |
2791 If your passphrase were incorrect, you'd see something like this: | |
2792 | |
2793 @smallexample | |
2794 [GNUPG:] ENC_TO CD9C88BB610BD9AD 1 0 | |
2795 [GNUPG:] USERID_HINT CD9C88BB610BD9AD Bill Wohler <wohler@@stop.mail-abuse.org> | |
2796 [GNUPG:] NEED_PASSPHRASE CD9C88BB610BD9AD CD9C88BB610BD9AD 1 0 | |
2797 [GNUPG:] BAD_PASSPHRASE CD9C88BB610BD9AD | |
2798 gpg: encrypted with 1024-bit RSA key, ID 610BD9AD, created 1997-09-09 | |
2799 "Bill Wohler <wohler@@stop.mail-abuse.org>" | |
2800 gpg: public key decryption failed: bad passphrase | |
2801 [GNUPG:] BEGIN_DECRYPTION | |
2802 [GNUPG:] DECRYPTION_FAILED | |
2803 gpg: decryption failed: secret key not available | |
2804 [GNUPG:] END_DECRYPTION | |
2805 | |
2806 gpg exited abnormally: '2' | |
2807 @end smallexample | |
2808 | |
2809 @vindex mh-show-pgg-bad | |
2810 @vindex mh-show-pgg-good | |
2811 @vindex mh-show-pgg-unknown | |
2812 | |
2813 The appearance of the buttons is controlled by the faces | |
2814 @code{mh-show-pgg-good}, @code{mh-show-pgg-bad}, and | |
2815 @code{mh-show-pgg-unknown} depending on the validity of the signature. | |
2816 The latter is used whether the signature is unknown or untrusted. | |
2817 | |
2818 @cindex @samp{pgg} customization group | |
2819 @cindex PGG | |
2820 @cindex customization group, @samp{pgg} | |
2821 | |
2822 The @samp{pgg} customization group may have some settings which may | |
2823 interest you. | |
2824 @iftex | |
2825 See @cite{The PGG Manual}. | |
2826 @end iftex | |
2827 @ifinfo | |
2828 @xref{Top, , The PGG Manual, pgg, The PGG Manual}. | |
2829 @end ifinfo | |
2830 @ifhtml | |
2831 See | |
2832 @uref{http://www.dk.xemacs.org/Documentation/packages/html/pgg.html, | |
2833 @cite{The PGG Manual}}. | |
2834 @end ifhtml | |
2835 | |
2836 @node Printing, Files and Pipes, Reading PGP, Reading Mail | |
2837 @section Printing Your Mail | |
2838 | |
2839 @cindex printing | |
2840 @findex mh-ps-print-msg | |
2841 @findex mh-ps-print-msg-file | |
2842 @kindex P f | |
2843 @kindex P p | |
2844 @vindex mh-lpr-command-format | |
2845 @vindex mh-print-background-flag | |
2846 | |
2847 To print messages in MH-E, use the command @kbd{P p} | |
2848 (@code{mh-ps-print-msg}). You can print all the messages in a range | |
2849 (as in @kbd{C-u P p 1 3 5-7 last:5 frombob @key{RET}}, | |
2850 @pxref{Ranges}). You can also send the output to a file with @kbd{P f} | |
2851 (@code{mh-ps-print-msg-file}). This command will print inline text | |
2852 attachments but will not decrypt messages. However, when a message is | |
2853 displayed in an MH-Show buffer, then that buffer is used verbatim for | |
2854 printing with the caveat that only text attachments, if opened inline, | |
2855 are printed. Therefore, encrypted messages can be printed by showing | |
2856 and decrypting them first. The commands @kbd{P p} and @kbd{P f} do not | |
2857 use the options @code{mh-lpr-command-format} or | |
2858 @code{mh-print-background-flag}, described below. | |
2859 | |
2860 @findex mh-ps-print-toggle-color | |
2861 @kindex P C | |
2862 @vindex ps-print-color-p | |
2863 | |
2864 Colors are emulated on black-and-white printers with shades of gray. | |
2865 This might produce illegible output, even if your screen colors only | |
2866 use shades of gray. If this is the case, try using the command @kbd{P | |
2867 C} (@code{mh-ps-print-toggle-color}) to toggle between color, no | |
2868 color, and a black and white representation of the colors and see | |
2869 which works best. You change this setting permanently by customizing | |
2870 the option @code{ps-print-color-p}. | |
2871 | |
2872 @findex mh-ps-print-toggle-faces | |
2873 @kindex P F | |
2874 | |
2875 Another related function is the command @kbd{P F} | |
2876 (@code{mh-ps-print-toggle-faces}). This command toggles between using | |
2877 faces and not. When faces are enabled, the printed message will look | |
2878 very similar to the message in the MH-Show buffer. | |
2879 | |
2880 @cindex ps-print package | |
2881 @cindex Emacs, packages, ps-print | |
2882 | |
2883 MH-E uses the @samp{ps-print} package to do the printing, so you can | |
2884 customize the printing further by going to the @samp{ps-print} | |
2885 customization group. | |
2886 | |
2887 @cindex @command{lpr} | |
2888 @cindex @command{mhl} | |
2889 @cindex MH commands, @command{mhl} | |
2890 @cindex Unix commands, @command{lpr} | |
2891 @findex mh-print-msg | |
2892 @kindex P l | |
2893 | |
2894 An alternative to using the @samp{ps-print} package is the command | |
2895 @kbd{P l} (@code{mh-print-msg}) (the @i{l} is for @i{l}ine printer or | |
2896 @i{l}pr). You can print all the messages in a range. The message is | |
2897 formatted with @command{mhl}@footnote{See the section | |
2898 @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in the MH | |
2899 book.} and printed with the @command{lpr} command. | |
2900 | |
2901 @kindex P f | |
2902 @kindex P l | |
2903 @kindex P p | |
2904 @vindex mh-lpr-command-format | |
2905 @vindex mh-print-background-flag | |
2906 | |
2907 The command @kbd{P l} uses two options. The option | |
2908 @code{mh-lpr-command-format} contains the Unix command line which | |
2909 performs the actual printing. The string can contain one escape, | |
2910 @samp{%s}, which is replaced by the name of the folder and the message | |
2911 number and is useful for print job names. The default setting is | |
2912 @code{"lpr -J '%s'"}. I use @code{"mpage -h'%s' -b Letter -H1of -mlrtb | |
2913 -P"} which produces a nice header and adds a bit of margin so the text | |
2914 fits within my printer's margins. Normally messages are printed in the | |
2915 foreground. If this is slow on your system, you may elect to turn on | |
2916 the option @code{mh-print-background-flag} to print in the background. | |
2917 If you do this, do not delete the message until it is printed or else | |
2918 the output may be truncated. These options are not used by the | |
2919 commands @kbd{P p} or @kbd{P f}. | |
2920 | |
2921 @node Files and Pipes, Navigating, Printing, Reading Mail | |
2922 @section Files and Pipes | |
2923 | |
2924 @cindex files | |
2925 @cindex pipes | |
2926 @findex mh-refile-or-write-again | |
2927 @findex mh-write-msg-to-file | |
2928 @kindex > | |
2929 @kindex ! | |
2930 | |
2931 MH-E does offer a couple of commands that are not a part of MH@. The | |
2932 first one, @kbd{>} (@code{mh-write-msg-to-file}), writes a message to | |
2933 a file. You are prompted for the filename. If the file already exists, | |
2934 the message is appended to it. You can also write the message to the | |
2935 file without the header by specifying a prefix argument (such as | |
2936 @kbd{C-u > /tmp/foobar @key{RET}}). Subsequent writes to the same file | |
2937 can be made with the command @kbd{!} | |
2938 (@code{mh-refile-or-write-again}). | |
2939 | |
2940 @findex mh-pipe-msg | |
2941 @kindex | | |
2942 @kindex l | |
2943 | |
2944 You can also pipe the message through a Unix shell command with the | |
2945 command @kbd{|} (@code{mh-pipe-msg}). You are prompted for the Unix | |
2946 command through which you wish to run your message. If you give a | |
2947 prefix argument to this command, the message header is included in the | |
2948 text passed to the command (the contrived example @kbd{C-u | lpr} | |
2949 would be done with the @kbd{l} command instead). | |
2950 | |
2951 @cindex @command{shar} | |
2952 @cindex @command{uuencode} | |
2953 @cindex Unix commands, @command{shar} | |
2954 @cindex Unix commands, @command{uuencode} | |
2955 @findex mh-store-msg | |
2956 @kindex X s | |
2957 @vindex mh-store-default-directory | |
2958 | |
2959 If the message is a shell archive @command{shar} or has been run | |
2960 through @command{uuencode} use @kbd{X s} (@code{mh-store-msg}) to | |
2961 extract the body of the message. The default directory for extraction | |
2962 is the current directory; however, you have a chance to specify a | |
2963 different extraction directory. The next time you use this command, | |
2964 the default directory is the last directory you used. If you would | |
2965 like to change the initial default directory, customize the option | |
2966 @code{mh-store-default-directory}, change the value from | |
2967 @samp{Current} to @samp{Directory}, and then enter the name of the | |
2968 directory for storing the content of these messages. | |
2969 | |
2970 @findex mh-store-buffer | |
2971 @kindex @key{RET} | |
2972 @kindex X s | |
2973 | |
2974 By the way, @kbd{X s} calls the Emacs Lisp function | |
2975 @code{mh-store-buffer}. I mention this because you can use it directly | |
2976 if you're editing a buffer that contains a file that has been run | |
2977 through @command{uuencode} or @command{shar}. For example, you can | |
2978 extract the contents of the current buffer in your home directory by | |
2979 typing @kbd{M-x mh-store-buffer @key{RET} ~ @key{RET}}. | |
2980 | |
2981 @node Navigating, Miscellaneous Commands and Options, Files and Pipes, Reading Mail | |
2982 @section Navigating | |
2983 | |
2984 @cindex moving between messages | |
2985 @cindex navigation | |
2986 @findex mh-first-msg | |
2987 @findex mh-goto-msg | |
2988 @findex mh-last-msg | |
2989 @findex mh-next-undeleted-msg | |
2990 @findex mh-next-unread-msg | |
2991 @findex mh-previous-undeleted-msg | |
2992 @findex mh-previous-unread-msg | |
2993 @kindex g | |
2994 @kindex M-< | |
2995 @kindex M-> | |
2996 @kindex M-n | |
2997 @kindex M-p | |
2998 @kindex n | |
2999 @kindex p | |
3000 | |
3001 To move on to the next message, use the command @kbd{n} | |
3002 (@code{mh-next-undeleted-msg}); use @kbd{p} | |
3003 (@code{mh-previous-undeleted-msg}) to read the previous message. To | |
3004 move to the next unread message, use @kbd{M-n} | |
3005 (@code{mh-next-unread-msg}); use @kbd{M-p} | |
3006 (@code{mh-previous-unread-msg}) to move to the previous unread | |
3007 message. These commands can be given a prefix argument to specify how | |
3008 many messages to skip (for example, @kbd{5 n}). You can also move to a | |
3009 specific message with @kbd{g} (@code{mh-goto-msg}). You can enter the | |
3010 message number either before or after typing @kbd{g}. In the latter | |
3011 case, Emacs prompts you. Finally, you can go to the first or last | |
3012 message with @kbd{M-<} (@code{mh-first-msg}) and @kbd{M->} | |
3013 (@code{mh-last-msg}) respectively. | |
3014 | |
3015 @cindex MH-Folder mode | |
3016 @cindex modes, MH-Folder | |
3017 @findex next-line | |
3018 @findex previous-line | |
3019 @kindex C-n | |
3020 @kindex C-p | |
3021 @kindex @key{RET} | |
3022 | |
3023 You can also use the Emacs commands @kbd{C-p} (@code{previous-line}) | |
3024 and @kbd{C-n} (@code{next-line}) to move up and down the scan lines in | |
3025 the MH-Folder window. These commands can be used in conjunction with | |
3026 @key{RET} to look at deleted or refiled messages. | |
3027 | |
3028 @cindex deleting messages | |
3029 @findex mh-delete-msg | |
3030 @kindex d | |
3031 @kindex n | |
3032 @kindex p | |
3033 | |
3034 To mark a message for deletion, use the command @kbd{d} | |
3035 (@code{mh-delete-msg}). A @samp{D} is placed by the message in the | |
3036 scan window, and the next undeleted message is displayed. If the | |
3037 previous command had been @kbd{p}, then the next message displayed is | |
3038 the first undeleted message previous to the message just deleted. Use | |
3039 @kbd{n} to force subsequent @kbd{d} commands to move forward to the | |
3040 next undeleted message after deleting the message under the cursor. | |
3041 You may also specify a range (for example, @kbd{C-u d 1 3 5-7 last:5 | |
3042 frombob @key{RET}}, @pxref{Ranges}). | |
3043 | |
3044 @findex mh-delete-msg-no-motion | |
3045 @kindex C-d | |
3046 | |
3047 The command @kbd{C-d} (@code{mh-delete-msg-no-motion}) marks the | |
3048 message (or messages in range) for deletion but leaves the cursor at | |
3049 the current message in case you wish to perform other operations on | |
3050 the message. | |
3051 | |
3052 @findex mh-delete-subject | |
3053 @findex mh-delete-subject-or-thread | |
3054 @findex mh-thread-delete | |
3055 @findex mh-undo | |
3056 @kindex k | |
3057 @kindex T d | |
3058 @kindex u | |
3059 | |
3060 And to delete more messages faster, you can use @kbd{k} | |
3061 (@code{mh-delete-subject-or-thread}) to delete all the messages with | |
3062 the same subject as the current message. This command puts these | |
3063 messages in a sequence named @samp{subject}. You can undo this action | |
3064 by using @kbd{u} (@code{mh-undo}) with a prefix argument and then | |
3065 specifying the @samp{subject} sequence. However, if the buffer is | |
3066 displaying a threaded view of the folder then @kbd{k} behaves like | |
3067 @kbd{T d} (@code{mh-thread-delete}). @xref{Threading}. | |
3068 | |
3069 @findex mh-execute-commands | |
3070 @kindex x | |
3071 | |
3072 However you mark a message for deletion, the command @kbd{x} | |
3073 (@code{mh-execute-commands}) actually carries out the deletion | |
3074 (@pxref{Folders}). | |
3075 | |
3076 @vindex mh-delete-msg-hook | |
3077 | |
3078 The hook @code{mh-delete-msg-hook} is called after you mark a message | |
3079 for deletion. For example, a past maintainer of MH-E used this once | |
3080 when he kept statistics on his mail usage. | |
3081 | |
3082 @node Miscellaneous Commands and Options, , Navigating, Reading Mail | |
3083 @section Miscellaneous Commands and Options | |
3084 | |
3085 This section contains a few more miscellaneous commands and options. | |
3086 | |
3087 @cindex editing message | |
3088 @findex mh-modify | |
3089 @kindex M | |
3090 | |
3091 There are times when you need to edit a message. For example, you may | |
3092 need to fix a broken Content-Type header field. You can do this with | |
3093 the command @kbd{M} (@code{mh-modify}). It displays the raw message in | |
3094 an editable buffer. When you are done editing, save and kill the | |
3095 buffer as you would any other. | |
3096 | |
3097 @findex mh-kill-folder | |
3098 @findex mh-pack-folder | |
3099 @vindex mh-do-not-confirm-flag | |
3100 | |
3101 Commands such as @code{mh-pack-folder} prompt to confirm whether to | |
3102 process outstanding moves and deletes or not before continuing. | |
3103 Turning on the option @code{mh-do-not-confirm-flag} means that these | |
3104 actions will be performed---which is usually desired but cannot be | |
3105 retracted---without question@footnote{In previous versions of MH-E, | |
3106 this option suppressed the confirmation in @code{mh-kill-folder}. | |
3107 Since this kept most users from setting this option, | |
3108 @code{mh-kill-folder} was modified in version 6.0 to always ask for | |
3109 confirmation subject to @code{mh-kill-folder-suppress-prompt-hook}. | |
3110 @xref{Folders}.}. | |
3111 | |
3112 @cindex MH-Folder mode | |
3113 @cindex modes, MH-Folder | |
3114 @vindex mh-summary-height | |
3115 | |
3116 The option @code{mh-summary-height} controls the number of scan lines | |
3117 displayed in the MH-Folder window, including the mode line. The | |
3118 default value of this option is @samp{Automatic} which means that the | |
3119 MH-Folder buffer will maintain the same proportional size if the frame | |
3120 is resized. If you'd prefer a fixed height, then choose the | |
3121 @samp{Fixed Size} option and enter the number of lines you'd like to | |
3122 see. | |
3123 | |
3124 @vindex mh-bury-show-buffer-flag | |
3125 | |
3126 Normally the buffer for displaying messages is buried at the bottom at | |
3127 the buffer stack. You may wish to disable this feature by turning off | |
3128 the option @code{mh-bury-show-buffer-flag}. One advantage of not | |
3129 burying the show buffer is that one can delete the show buffer more | |
3130 easily in an electric buffer list because of its proximity to its | |
3131 associated MH-Folder buffer. Try running @kbd{M-x | |
3132 electric-buffer-list} to see what I mean. | |
3133 | |
3134 @cindex @file{.emacs} | |
3135 @cindex files, @file{.emacs} | |
3136 @cindex reading mail | |
3137 | |
3138 Before we leave this section, I'll include a function that I use as a | |
3139 front end to MH-E@footnote{Stephen Gildea's favorite binding is | |
3140 @kbd{(global-set-key "\C-cr" 'mh-rmail)}.}. It toggles between your | |
3141 working window configuration, which may be quite involved---windows | |
3142 filled with source, compilation output, man pages, and other | |
3143 documentation---and your MH-E window configuration. Like the rest of | |
3144 the customization described in this section, simply add the following | |
3145 code to @file{~/.emacs}. | |
3146 | |
3147 @iftex | |
3148 @filbreak | |
3149 @end iftex | |
3150 | |
3151 @findex mh-rmail, example | |
3152 | |
3153 @smalllisp | |
3154 @group | |
3155 (defvar my-mh-screen-saved nil | |
3156 "Set to non-@code{nil} when MH-E window configuration shown.") | |
3157 (defvar my-normal-screen nil "Normal window configuration.") | |
3158 (defvar my-mh-screen nil "MH-E window configuration.") | |
3159 | |
3160 (defun my-mh-rmail (&optional arg) | |
3161 "Toggle between MH-E and normal screen configurations. | |
3162 With non-@code{nil} or prefix argument, @i{inc} mailbox as well | |
3163 when going into mail." | |
3164 (interactive "P") ; @r{user callable function, P=prefix arg} | |
3165 (setq my-mh-screen-saved ; @r{save state} | |
3166 (cond | |
3167 ;; @r{Bring up MH-E screen if arg or normal window configuration.} | |
3168 ;; @r{If arg or +inbox buffer doesn't exist, run mh-rmail.} | |
3169 ((or arg (null my-mh-screen-saved)) | |
3170 (setq my-normal-screen (current-window-configuration)) | |
3171 (if (or arg (null (get-buffer "+inbox"))) | |
3172 (mh-rmail) | |
3173 (set-window-configuration my-mh-screen)) | |
3174 t) ; @r{set my-mh-screen-saved to @code{t}} | |
3175 ;; @r{Otherwise, save MH-E screen and restore normal screen.} | |
3176 (t | |
3177 (setq my-mh-screen (current-window-configuration)) | |
3178 (set-window-configuration my-normal-screen) | |
3179 nil)))) ; @r{set my-mh-screen-saved to nil} | |
3180 | |
3181 (global-set-key "\C-x\r" 'my-mh-rmail) ;@r{ call with C-x @key{RET}} | |
3182 | |
3183 @i{Starting MH-E} | |
3184 | |
3185 @end group | |
3186 @end smalllisp | |
3187 | |
3188 If you type an argument (@kbd{C-u}) or if @code{my-mh-screen-saved} is | |
3189 @code{nil} (meaning a non-MH-E window configuration), the current | |
3190 window configuration is saved, either the @samp{+inbox} buffer is | |
3191 displayed or @code{mh-rmail} is run, and the MH-E window configuration | |
3192 is shown. Otherwise, the MH-E window configuration is saved and the | |
3193 original configuration is displayed. | |
3194 | |
3195 @node Folders, Sending Mail, Reading Mail, Top | |
3196 @chapter Organizing Your Mail with Folders | |
3197 | |
3198 @cindex @samp{Folder} menu | |
3199 @cindex @samp{Message} menu | |
3200 @cindex folders | |
3201 @cindex menu, @samp{Folder} | |
3202 @cindex menu, @samp{Message} | |
3203 @cindex using folders | |
3204 | |
3205 This chapter discusses the things you can do with folders within MH-E. | |
3206 The commands in this chapter are also found in the @samp{Folder} and | |
3207 @samp{Message} menus. | |
3208 | |
3209 @table @kbd | |
3210 @kindex ? | |
3211 @findex mh-help | |
3212 @item ? | |
3213 Display cheat sheet for the MH-E commands (@code{mh-help}). | |
3214 @c ------------------------- | |
3215 @kindex ! | |
3216 @findex mh-refile-or-write-again | |
3217 @item ! | |
3218 Repeat last output command (@code{mh-refile-or-write-again}). | |
3219 @c ------------------------- | |
3220 @cindex @samp{Message > Copy Message to Folder...} menu item | |
3221 @cindex menu item, @samp{Message > Copy Message to Folder...} | |
3222 @kindex c | |
3223 @findex mh-copy-msg | |
3224 @item c | |
3225 Copy range to folder (@code{mh-copy-msg}). | |
3226 @c ------------------------- | |
3227 @kindex F ? | |
3228 @findex mh-prefix-help | |
3229 @item F ? | |
3230 Display cheat sheet for the commands of the current prefix in | |
3231 minibuffer (@code{mh-prefix-help}). | |
3232 @c ------------------------- | |
3233 @kindex F ' | |
3234 @findex mh-index-ticked-messages | |
3235 @item F ' | |
3236 Display ticked messages (@code{mh-index-ticked-messages}). | |
3237 @c ------------------------- | |
3238 @kindex F c | |
3239 @findex mh-catchup | |
3240 @item F c | |
3241 Delete range from the @samp{unseen} sequence (@code{mh-catchup}). | |
3242 @c ------------------------- | |
3243 @kindex F k | |
3244 @findex mh-kill-folder | |
3245 @item F k | |
3246 Remove folder (@code{mh-kill-folder}). | |
3247 @c ------------------------- | |
3248 @cindex @samp{Folder > List Folders} menu item | |
3249 @cindex menu item, @samp{Folder > List Folders} | |
3250 @kindex F l | |
3251 @findex mh-list-folders | |
3252 @item F l | |
3253 List all folders (@code{mh-list-folders}). | |
3254 @c ------------------------- | |
3255 @cindex @samp{Folder > View New Messages} menu item | |
3256 @cindex menu item, @samp{Folder > View New Messages} | |
3257 @kindex F n | |
3258 @findex mh-index-new-messages | |
3259 @item F n | |
3260 Display unseen messages (@code{mh-index-new-messages}). | |
3261 @c ------------------------- | |
3262 @cindex @samp{Folder > Pack Folder} menu item | |
3263 @cindex menu item, @samp{Folder > Pack Folder} | |
3264 @kindex F p | |
3265 @findex mh-pack-folder | |
3266 @item F p | |
3267 Pack folder (@code{mh-pack-folder}). | |
3268 @c ------------------------- | |
3269 @kindex F q | |
3270 @findex mh-index-sequenced-messages | |
3271 @item F q | |
3272 Display messages in any sequence (@code{mh-index-sequenced-messages}). | |
3273 @c ------------------------- | |
3274 @cindex @samp{Folder > Rescan Folder} menu item | |
3275 @cindex menu item, @samp{Folder > Rescan Folder} | |
3276 @kindex F r | |
3277 @findex mh-rescan-folder | |
3278 @item F r | |
3279 Rescan folder (@code{mh-rescan-folder}). | |
3280 @c ------------------------- | |
3281 @cindex @samp{Folder > Search...} menu item | |
3282 @cindex menu item, @samp{Folder > Search...} | |
3283 @kindex F s | |
3284 @findex mh-search | |
3285 @item F s | |
3286 Search your MH mail (@code{mh-search}). | |
3287 @c ------------------------- | |
3288 @cindex @samp{Folder > Sort Folder} menu item | |
3289 @cindex menu item, @samp{Folder > Sort Folder} | |
3290 @kindex F S | |
3291 @findex mh-sort-folder | |
3292 @item F S | |
3293 Sort folder (@code{mh-sort-folder}). | |
3294 @c ------------------------- | |
3295 @kindex F u | |
3296 @findex mh-undo-folder | |
3297 @item F u | |
3298 Undo all refiles and deletes in the current folder (@code{mh-undo-folder}). | |
3299 @c ------------------------- | |
3300 @cindex @samp{Folder > Visit a Folder...} menu item | |
3301 @cindex menu item, @samp{Folder > Visit a Folder...} | |
3302 @kindex F v | |
3303 @findex mh-visit-folder | |
3304 @item F v | |
3305 Visit folder (@code{mh-visit-folder}). | |
3306 @c ------------------------- | |
3307 @cindex @samp{Message > Refile Message} menu item | |
3308 @cindex menu item, @samp{Message > Refile Message} | |
3309 @kindex o | |
3310 @findex mh-refile-msg | |
3311 @item o | |
3312 Refile (output) range into folder (@code{mh-refile-msg}). | |
3313 @c ------------------------- | |
3314 @cindex @samp{Folder > Quit MH-E} menu item | |
3315 @cindex menu item, @samp{Folder > Quit MH-E} | |
3316 @kindex q | |
3317 @findex mh-quit | |
3318 @item q | |
3319 Quit the current MH-E folder (@code{mh-quit}). | |
3320 @c ------------------------- | |
3321 @cindex @samp{Folder > Toggle Show/Folder} menu item | |
3322 @cindex menu item, @samp{Folder > Toggle Show/Folder} | |
3323 @kindex t | |
3324 @findex mh-toggle-showing | |
3325 @item t | |
3326 Toggle between MH-Folder and MH-Folder Show modes | |
3327 (@code{mh-toggle-showing}). | |
3328 @c ------------------------- | |
3329 @cindex @samp{Message > Undo Delete/Refile} menu item | |
3330 @cindex menu item, @samp{Message > Undo Delete/Refile} | |
3331 @kindex u | |
3332 @findex mh-undo | |
3333 @item u | |
3334 Undo pending deletes or refiles in range (@code{mh-undo}). | |
3335 @c ------------------------- | |
3336 @cindex @samp{Message > Execute Delete/Refile} menu item | |
3337 @cindex menu item, @samp{Message > Execute Delete/Refile} | |
3338 @kindex x | |
3339 @findex mh-execute-commands | |
3340 @item x | |
3341 Process outstanding delete and refile requests | |
3342 (@code{mh-execute-commands}). | |
3343 @end table | |
3344 | |
3345 @cindex @samp{mh-folder} customization group | |
3346 @cindex customization group, @samp{mh-folder} | |
3347 | |
3348 The @samp{mh-folder} customization group is used to tune these | |
3349 commands. | |
3350 | |
3351 @vtable @code | |
3352 @item mh-new-messages-folders | |
3353 Folders searched for the @samp{unseen} sequence (default: | |
3354 @code{Inbox}). | |
3355 @c ------------------------- | |
3356 @item mh-ticked-messages-folders | |
3357 Folders searched for @code{mh-tick-seq} (default: @code{t}). | |
3358 @c ------------------------- | |
3359 @item mh-large-folder | |
3360 The number of messages that indicates a large folder (default: 200). | |
3361 @c ------------------------- | |
3362 @item mh-recenter-summary-flag | |
3363 On means to recenter the summary window (default: @samp{off}). | |
3364 @c ------------------------- | |
3365 @item mh-recursive-folders-flag | |
3366 On means that commands which operate on folders do so recursively | |
3367 (default: @samp{off}). | |
3368 @c ------------------------- | |
3369 @item mh-sortm-args | |
3370 Additional arguments for @command{sortm} (default: @code{nil}). | |
3371 @end vtable | |
3372 | |
3373 The following hooks are available. | |
3374 | |
3375 @vtable @code | |
3376 @item mh-after-commands-processed-hook | |
3377 Hook run by @kbd{x} after performing outstanding refile and delete | |
3378 requests (default: @code{nil}). | |
3379 @c ------------------------- | |
3380 @item mh-before-commands-processed-hook | |
3381 Hook run by @kbd{x} before performing outstanding refile and delete | |
3382 requests (default: @code{nil}). | |
3383 @c ------------------------- | |
3384 @item mh-before-quit-hook | |
3385 Hook run by q before quitting MH-E (default: @code{nil}). | |
3386 @c ------------------------- | |
3387 @item mh-folder-mode-hook | |
3388 Hook run by @code{mh-folder-mode} when visiting a new folder (default: | |
3389 @code{nil}). | |
3390 @c ------------------------- | |
3391 @item mh-kill-folder-suppress-prompt-hook | |
3392 Abnormal hook run at the beginning of @code{mh-kill-folder} (default: | |
3393 @code{'mh-search-p}). | |
3394 @c ------------------------- | |
3395 @item mh-quit-hook | |
3396 Hook run by q after quitting MH-E (default: @code{nil}). | |
3397 @c ------------------------- | |
3398 @item mh-refile-msg-hook | |
3399 Hook run by o after marking each message for refiling (default: | |
3400 @code{nil}). | |
3401 @end vtable | |
3402 | |
3403 The following faces are available for customizing the appearance of | |
3404 the MH-Folder buffer. @xref{Scan Line Formats}. | |
3405 | |
3406 @vtable @code | |
3407 @item mh-folder-address | |
3408 Recipient face. | |
3409 @c ------------------------- | |
3410 @item mh-folder-body | |
3411 Body text face. | |
3412 @c ------------------------- | |
3413 @item mh-folder-cur-msg-number | |
3414 Current message number face. | |
3415 @c ------------------------- | |
3416 @item mh-folder-date | |
3417 Date face. | |
3418 @c ------------------------- | |
3419 @item mh-folder-deleted | |
3420 Deleted message face. | |
3421 @c ------------------------- | |
3422 @item mh-folder-followup | |
3423 @samp{Re:} face. | |
3424 @c ------------------------- | |
3425 @item mh-folder-msg-number | |
3426 Message number face. | |
3427 @c ------------------------- | |
3428 @item mh-folder-refiled | |
3429 Refiled message face. | |
3430 @c ------------------------- | |
3431 @vindex mh-scan-format-nmh | |
3432 @vindex mh-scan-sent-to-me-sender-regexp | |
3433 @item mh-folder-sent-to-me-hint | |
3434 Fontification hint face in messages sent directly to us. The detection | |
3435 of messages sent to us is governed by the scan format | |
3436 @code{mh-scan-format-nmh} and regular expression | |
3437 @code{mh-scan-sent-to-me-sender-regexp}. | |
3438 @c ------------------------- | |
3439 @vindex mh-scan-format-nmh | |
3440 @vindex mh-scan-sent-to-me-sender-regexp | |
3441 @item mh-folder-scan-format | |
3442 Sender face in messages sent directly to us. The detection of messages | |
3443 sent to us is governed by the scan format @code{mh-scan-format-nmh} | |
3444 and regular expression @code{mh-scan-sent-to-me-sender-regexp}. | |
3445 @c ------------------------- | |
3446 @item mh-folder-subject | |
3447 Subject face. | |
3448 @c ------------------------- | |
3449 @item mh-folder-tick | |
3450 Ticked message face. | |
3451 @c ------------------------- | |
3452 @item mh-folder-to | |
3453 @samp{To:} face. | |
3454 @end vtable | |
3455 | |
3456 @vindex mh-folder-mode-hook | |
3457 | |
3458 The hook @code{mh-folder-mode-hook} is called when visiting a new | |
3459 folder in MH-Folder mode. This could be used to set your own key | |
3460 bindings, for example: | |
3461 | |
3462 @vindex mh-folder-mode-hook, example | |
3463 | |
3464 @smalllisp | |
3465 @group | |
3466 (defvar my-mh-init-done nil | |
3467 "Non-@code{nil} when one-time MH-E settings made.") | |
3468 | |
3469 (defun my-mh-folder-mode-hook () | |
3470 "Hook to set key bindings in MH-Folder mode." | |
3471 (if (not my-mh-init-done) ; @r{only need to bind the keys once } | |
3472 (progn | |
3473 (local-set-key "//" 'my-search-msg) | |
3474 (local-set-key "b" 'mh-burst-digest) ; @r{better use of @kbd{b}} | |
3475 (setq my-mh-init-done t)))) | |
3476 | |
3477 (add-hook 'mh-folder-mode-hook 'my-mh-folder-mode-hook) | |
3478 | |
3479 (defun my-search-msg () | |
3480 "Search for a regexp in the current message." | |
3481 (interactive) ; @r{user function} | |
3482 (save-window-excursion | |
3483 (other-window 1) ; @r{go to next window} | |
3484 (isearch-forward-regexp))) ; @r{string search; hit return} | |
3485 ; @r{ when done} | |
3486 | |
3487 @i{Create additional key bindings via mh-folder-mode-hook} | |
3488 | |
3489 @end group | |
3490 @end smalllisp | |
3491 | |
3492 @cindex @command{folder} | |
3493 @cindex @command{refile} | |
3494 @cindex MH commands, @command{folder} | |
3495 @cindex MH commands, @command{refile} | |
3496 @findex mh-refile-msg | |
3497 @kindex o | |
3498 @vindex mh-refile-msg-hook | |
3499 | |
3500 MH-E has analogies for each of the MH @command{folder} and | |
3501 @command{refile} commands@footnote{See the sections | |
3502 @uref{@value{MH-BOOK-HOME}/fol.html#Youfol, Your Current Folder: | |
3503 folder} and @uref{@value{MH-BOOK-HOME}/fol.html#Movref, Moving and | |
3504 Linking Messages: refile} in the MH book.}. To refile a message in | |
3505 another folder, use the command @kbd{o} (@code{mh-refile-msg}) | |
3506 (mnemonic: ``output''). You are prompted for the folder name | |
3507 (@pxref{Folder Selection}). Note that this command can also be used to | |
3508 create folders. If you specify a folder that does not exist, you will | |
3509 be prompted to create it. The hook @code{mh-refile-msg-hook} is called | |
3510 after a message is marked to be refiled. | |
3511 | |
3512 @findex mh-write-msg-to-file | |
3513 @kindex ! | |
3514 | |
3515 If you are refiling several messages into the same folder, you can use | |
3516 the command @kbd{!} (@code{mh-refile-or-write-again}) to repeat the | |
3517 last refile or write (for the description of @kbd{>} | |
3518 (@code{mh-write-msg-to-file}), @pxref{Files and Pipes}). You can use a | |
3519 range in either case (for example, @kbd{C-u o 1 3 5-7 last:5 frombob | |
3520 @key{RET}}, @pxref{Ranges}). | |
3521 | |
3522 @cindex expunging refiles and deletes | |
3523 @cindex undoing refiles and deletes | |
3524 @findex mh-undo | |
3525 @kindex u | |
3526 | |
3527 If you've deleted a message or refiled it, but changed your mind, you | |
3528 can cancel the action before you've executed it. Use @kbd{u} | |
3529 (@code{mh-undo}) to undo a refile on or deletion of a single message. | |
3530 You can also undo refiles and deletes for messages that are found in a | |
3531 given range (@pxref{Ranges}). | |
3532 | |
3533 @findex mh-undo-folder | |
3534 @kindex F u | |
3535 | |
3536 Alternatively, you can use @kbd{F u} (@code{mh-undo-folder}) to undo | |
3537 all refiles and deletes in the current folder. | |
3538 | |
3539 @findex mh-execute-commands | |
3540 @kindex x | |
3541 | |
3542 If you've marked messages to be deleted or refiled and you want to go | |
3543 ahead and delete or refile the messages, use @kbd{x} | |
3544 (@code{mh-execute-commands}). Many MH-E commands that may affect the | |
3545 numbering of the messages (such as @kbd{F r} or @kbd{F p}) will ask if | |
3546 you want to process refiles or deletes first and then either run | |
3547 @kbd{x} for you or undo the pending refiles and deletes. | |
3548 | |
3549 @kindex x | |
3550 @vindex mh-after-commands-processed-hook | |
3551 @vindex mh-before-commands-processed-hook | |
3552 | |
3553 The command @kbd{x} runs @code{mh-before-commands-processed-hook} | |
3554 before the commands are processed and | |
3555 @code{mh-after-commands-processed-hook} after the commands are | |
3556 processed. Variables that are useful with the former hook include | |
3557 @code{mh-delete-list} and @code{mh-refile-list} which can be used to | |
3558 see which changes will be made to the current folder, | |
3559 @code{mh-current-folder}. Variables that are useful with the latter | |
3560 hook include @code{mh-folders-changed}, which lists which folders were | |
3561 affected by deletes and refiles. This list will always include the | |
3562 current folder @code{mh-current-folder}. | |
3563 | |
3564 @findex mh-copy-msg | |
3565 @kindex c | |
3566 @kindex o | |
3567 | |
3568 If you wish to copy a message to another folder, you can use the | |
3569 command @kbd{c} (@code{mh-copy-msg}) (see the @option{-link} argument | |
3570 to @command{refile}(1)). Like the command @kbd{o}, this command | |
3571 prompts you for the name of the target folder and you can specify a | |
3572 range (@pxref{Ranges}). Note that unlike the command @kbd{o}, the copy | |
3573 takes place immediately. The original copy remains in the current | |
3574 folder. | |
3575 | |
3576 @cindex junk mail | |
3577 @cindex MH-Folder mode | |
3578 @cindex MH-Folder Show mode | |
3579 @cindex modes, MH-Folder | |
3580 @cindex modes, MH-Folder Show | |
3581 @cindex spam | |
3582 @findex mh-toggle-showing | |
3583 @kindex t | |
3584 | |
3585 The command @kbd{t} (@code{mh-toggle-showing}) switches between | |
3586 MH-Folder mode and MH-Folder Show mode@footnote{For you Emacs wizards, | |
3587 this is implemented as an Emacs minor mode.}. MH-Folder mode turns off | |
3588 the associated show buffer so that you can perform operations on the | |
3589 messages quickly without reading them. This is an excellent way to | |
3590 prune out your junk mail or to refile a group of messages to another | |
3591 folder for later examination. | |
3592 | |
3593 @cindex MH-Folder mode | |
3594 @cindex MH-Show mode | |
3595 @cindex modes, MH-Folder | |
3596 @cindex modes, MH-Show | |
3597 @cindex moving between messages | |
3598 @kindex t | |
3599 @vindex mh-recenter-summary-flag | |
3600 | |
3601 When you use @kbd{t} to toggle from MH-Folder Show mode to MH-Folder | |
3602 mode, the MH-Show buffer is hidden and the MH-Folder buffer is left | |
3603 alone. Setting @code{mh-recenter-summary-flag} to a non-@code{nil} | |
3604 value causes the toggle to display as many scan lines as possible, | |
3605 with the cursor at the middle. The effect of | |
3606 @code{mh-recenter-summary-flag} is rather useful, but it can be | |
3607 annoying on a slow network connection. | |
3608 | |
3609 @findex mh-visit-folder | |
3610 @kindex F v | |
3611 @vindex mh-large-folder | |
3612 | |
3613 When you want to read the messages that you have refiled into folders, | |
3614 use the command @kbd{F v} (@code{mh-visit-folder}) to visit the | |
3615 folder. You are prompted for the folder name. The folder buffer will | |
3616 show just unseen messages if there are any; otherwise, it will show | |
3617 all the messages in the buffer as long there are fewer than | |
3618 @code{mh-large-folder} messages. If there are more, then you are | |
3619 prompted for a range of messages to scan. You can provide a prefix | |
3620 argument in order to specify a range of messages to show when you | |
3621 visit the folder (@pxref{Ranges}). In this case, regions are not used | |
3622 to specify the range and @code{mh-large-folder} is ignored. Note that | |
3623 this command can also be used to create folders. If you specify a | |
3624 folder that does not exist, you will be prompted to create it. | |
3625 | |
3626 @findex mh-search | |
3627 @kindex F s | |
3628 | |
3629 If you forget where you've refiled your messages, you can find them | |
3630 using @kbd{F s} (@code{mh-search}). @xref{Searching}. | |
3631 | |
3632 @cindex @command{procmail} | |
3633 @cindex @samp{unseen} sequence | |
3634 @cindex sequence, @samp{unseen} | |
3635 @cindex Unix commands, @command{procmail} | |
3636 @cindex unseen messages, viewing | |
3637 @findex mh-index-new-messages | |
3638 @kindex F n | |
3639 @vindex mh-new-messages-folders | |
3640 | |
3641 If you use a program such as @command{procmail} to file your incoming | |
3642 mail automatically, you can display new, unseen, messages using the | |
3643 command @kbd{F n} (@code{mh-index-new-messages}). All messages in the | |
3644 @samp{unseen} sequence from the folders in | |
3645 @code{mh-new-messages-folders} are listed. However, this list of | |
3646 folders can be overridden with a prefix argument: with a prefix | |
3647 argument, enter a space-separated list of folders, or nothing to | |
3648 search all folders. | |
3649 | |
3650 @cindex @samp{tick} sequence | |
3651 @cindex sequence, @samp{tick} | |
3652 @cindex ticked messages, viewing | |
3653 @findex mh-index-ticked-messages | |
3654 @kindex F ' | |
3655 @vindex mh-ticked-messages-folders | |
3656 | |
3657 If you have ticked messages (@pxref{Sequences}), you can display them | |
3658 using the command @kbd{F '} (@code{mh-index-ticked-messages}). All | |
3659 messages in the @samp{tick} sequence from the folders in | |
3660 @code{mh-ticked-messages-folders} are listed. With a prefix argument, | |
3661 enter a space-separated list of folders, or nothing to search all | |
3662 folders. | |
3663 | |
3664 @findex mh-index-sequenced-messages | |
3665 @kindex F q | |
3666 @vindex mh-new-messages-folders | |
3667 | |
3668 You can display messages in any sequence with the command @kbd{F q} | |
3669 (@code{mh-index-sequenced-messages}). All messages from the folders in | |
3670 @code{mh-new-messages-folders} in the sequence you provide are listed. | |
3671 With a prefix argument, enter a space-separated list of folders at the | |
3672 prompt, or nothing to search all folders. | |
3673 | |
3674 @vindex mh-new-messages-folders | |
3675 @vindex mh-recursive-folders-flag | |
3676 @vindex mh-ticked-messages-folders | |
3677 | |
3678 Set the options @code{mh-new-messages-folders} and | |
3679 @code{mh-ticked-messages-folders} to @samp{Inbox} to search the | |
3680 @samp{+inbox} folder or @samp{All} to search all of the top level | |
3681 folders. Otherwise, list the folders that should be searched with the | |
3682 @samp{Choose Folders} menu item. See @code{mh-recursive-folders-flag}. | |
3683 | |
3684 @cindex buffers, @samp{*MH-E Folders*} | |
3685 @cindex @samp{*MH-E Folders*} | |
3686 @findex mh-kill-folder | |
3687 @findex mh-list-folders | |
3688 @findex mh-pack-folder | |
3689 @findex mh-rescan-folder | |
3690 @findex mh-sort-folder | |
3691 @kindex F k | |
3692 @kindex F l | |
3693 @kindex F p | |
3694 @kindex F r | |
3695 @kindex F S | |
3696 | |
3697 Other commands you can perform on folders include: @kbd{F l} | |
3698 (@code{mh-list-folders}), to place a listing of all the folders in | |
3699 your mail directory in a buffer called @samp{*MH-E Folders*} | |
3700 (@pxref{Miscellaneous}); @kbd{F k} (@code{mh-kill-folder}), to remove | |
3701 a folder; @kbd{F S} (@code{mh-sort-folder}), to sort the messages by | |
3702 date (see @command{sortm}(1) to see how to sort by other criteria); | |
3703 @kbd{F p} (@code{mh-pack-folder}), to pack a folder, removing gaps | |
3704 from the numbering sequence; and @kbd{F r} (@code{mh-rescan-folder}), | |
3705 to rescan the folder, which is useful to grab all messages in your | |
3706 @samp{+inbox} after processing your new mail for the first time. If | |
3707 you don't want to rescan the entire folder, the commands @kbd{F r} or | |
3708 @kbd{F p} will accept a range (@pxref{Ranges}). | |
3709 | |
3710 @kindex @key{TAB} | |
3711 @vindex mh-recursive-folders-flag | |
3712 | |
3713 By default, operations on folders work only one level at a time. Set | |
3714 @code{mh-recursive-folders-flag} to non-@code{nil} to operate on all | |
3715 folders. This mostly means that you'll be able to see all your folders | |
3716 when you press @key{TAB} when prompted for a folder name. | |
3717 | |
3718 @findex mh-search-p | |
3719 @kindex k | |
3720 @vindex mh-kill-folder-suppress-prompt-hooks | |
3721 | |
3722 The hook @code{mh-kill-folder-suppress-prompt-hooks} is an abnormal | |
3723 hook run at the beginning of the command @kbd{k}. The hook functions | |
3724 are called with no arguments and should return a non-nil value to | |
3725 suppress the normal prompt when you remove a folder. This is useful | |
3726 for folders that are easily regenerated. The default value of | |
3727 @code{mh-search-p} suppresses the prompt on folders generated by | |
3728 searching. | |
3729 | |
3730 @sp 1 | |
3731 @center @strong{NOTE} | |
3732 | |
3733 @quotation | |
3734 Use this hook with care. If there is a bug in your hook which returns | |
3735 @code{t} on @samp{+inbox} and you press @kbd{k} by accident in the | |
3736 @code{+inbox} folder, you will not be happy. | |
3737 @end quotation | |
3738 @sp 1 | |
3739 | |
3740 @cindex @command{sortm} | |
3741 @cindex @file{.mh_profile} | |
3742 @cindex files, @file{.mh_profile} | |
3743 @cindex MH commands, @command{sortm} | |
3744 @cindex MH profile component, @samp{sortm:} | |
3745 @cindex @samp{sortm:} MH profile component | |
3746 @kindex F S | |
3747 @vindex mh-sortm-args | |
3748 | |
3749 The option @code{mh-sortm-args} holds extra arguments to pass on to | |
3750 the command @command{sortm}@footnote{See the section | |
3751 @uref{@value{MH-BOOK-HOME}/sorsor.html, Sorting Messages: sortm} in the | |
3752 MH book.} when a prefix argument is used with @kbd{F S}. Normally | |
3753 default arguments to @command{sortm} are specified in the MH profile. | |
3754 This option may be used to provide an alternate view. For example, | |
3755 @samp{'(\"-nolimit\" \"-textfield\" \"subject\")} is a useful setting. | |
3756 | |
3757 @cindex exiting | |
3758 @cindex quitting | |
3759 @findex mh-quit | |
3760 @kindex q | |
3761 | |
3762 When you want to quit using MH-E and go back to editing, you can use | |
3763 the @kbd{q} (@code{mh-quit}) command. This buries the buffers of the | |
3764 current MH-E folder and restores the buffers that were present when | |
3765 you first ran @kbd{M-x mh-rmail}. It also removes any MH-E working | |
3766 buffers whose name begins with @samp{ *mh-} or @samp{*MH-E } | |
3767 (@pxref{Miscellaneous}). You can later restore your MH-E session by | |
3768 selecting the @samp{+inbox} buffer or by running @kbd{M-x mh-rmail} | |
3769 again. | |
3770 | |
3771 @findex mh-execute-commands | |
3772 @kindex q | |
3773 @vindex mh-before-quit-hook | |
3774 @vindex mh-before-quit-hook, example | |
3775 @vindex mh-quit-hook | |
3776 @vindex mh-quit-hook, example | |
3777 | |
3778 The two hooks @code{mh-before-quit-hook} and @code{mh-quit-hook} are | |
3779 called by @kbd{q}. The former one is called before the quit occurs, so | |
3780 you might use it to perform any MH-E operations; you could perform | |
3781 some query and abort the quit or call @code{mh-execute-commands}, for | |
3782 example. The latter is not run in an MH-E context, so you might use it | |
3783 to modify the window setup. If you find that @kbd{q} buries a lot of | |
3784 buffers that you would rather remove, you can use both | |
3785 @code{mh-before-quit-hook} and @code{mh-quit-hook} to accomplish that. | |
3786 | |
3787 @smalllisp | |
3788 @group | |
3789 (defvar my-mh-folder-buffer-to-delete nil | |
3790 "Folder buffer that is being quit.") | |
3791 | |
3792 (defun my-mh-before-quit-hook () | |
3793 "Save folder buffer that is to be deleted." | |
3794 (setq my-mh-folder-buffer-to-delete (current-buffer))) | |
3795 | |
3796 (defun my-mh-quit-hook () | |
3797 "Kill folder buffer rather than just bury it." | |
3798 (set-buffer my-mh-folder-buffer-to-delete) | |
3799 (if (get-buffer mh-show-buffer) | |
3800 (kill-buffer mh-show-buffer)) | |
3801 (kill-buffer (current-buffer))) | |
3802 | |
3803 @i{Kill MH-Folder buffer instead of burying it} | |
3804 @end group | |
3805 @end smalllisp | |
3806 | |
3807 @cindex folders, renaming | |
3808 @cindex renaming folders | |
3809 @findex dired | |
3810 @findex dired-do-rename | |
3811 | |
3812 You can use dired to manipulate the folders themselves. For example, I | |
3813 renamed my @samp{+out} folder to the more common @samp{+outbox} by | |
3814 running dired on my mail directory (@kbd{M-x dired RET ~/Mail RET}), | |
3815 moving my cursor to @samp{out} and using the command @kbd{R} | |
3816 (@code{dired-do-rename}). | |
3817 | |
3818 @node Sending Mail, Editing Drafts, Folders, Top | |
3819 @chapter Sending Mail | |
3820 | |
3821 @cindex sending mail | |
3822 @findex mh-smail | |
3823 @kindex M-x mh-smail | |
3824 | |
3825 You can send a mail message in several ways. You can call @kbd{M-x | |
3826 mh-smail} directly, or from the command line like this: | |
3827 | |
3828 @cindex starting from command line | |
3829 | |
3830 @smallexample | |
3831 $ @kbd{emacs -f mh-smail} | |
3832 @end smallexample | |
3833 | |
3834 @findex goto-address-at-point | |
3835 @vindex mail-user-agent | |
3836 | |
3837 There are some commands that need to send a mail message, such as | |
3838 @code{goto-address-at-point}. You can configure Emacs to have these | |
3839 commands use MH-E by setting the option @code{mail-user-agent} to | |
3840 @samp{Emacs interface to MH}. | |
3841 | |
3842 @cindex @samp{Message} menu | |
3843 @cindex menu, @samp{Message} | |
3844 | |
3845 From within MH-E's MH-Folder mode, other methods of sending mail are | |
3846 available as well. These can also be found in the @samp{Message} menu. | |
3847 | |
3848 @table @kbd | |
3849 @cindex @samp{Message > Edit Message Again} menu item | |
3850 @cindex menu item, @samp{Message > Edit Message Again} | |
3851 @kindex e | |
3852 @findex mh-edit-again | |
3853 @item e | |
3854 Edit a message to send it again (@code{mh-edit-again}). | |
3855 @c ------------------------- | |
3856 @cindex @samp{Message > Re-edit a Bounced Message} menu item | |
3857 @cindex menu item, @samp{Message > Re-edit a Bounced Message} | |
3858 @kindex E | |
3859 @findex mh-extract-rejected-mail | |
3860 @item E | |
3861 Edit a message that was returned by the mail system | |
3862 (@code{mh-extract-rejected-mail}). | |
3863 @c ------------------------- | |
3864 @cindex @samp{Message > Forward Message...} menu item | |
3865 @cindex menu item, @samp{Message > Forward Message...} | |
3866 @kindex f | |
3867 @findex mh-forward | |
3868 @item f | |
3869 Forward message (@code{mh-forward}). | |
3870 @c ------------------------- | |
3871 @cindex @samp{Message > Reply to Message...} menu item | |
3872 @cindex menu item, @samp{Message > Reply to Message...} | |
3873 @kindex r | |
3874 @findex mh-reply | |
3875 @item r | |
3876 Reply to a message (@code{mh-reply}). | |
3877 @c ------------------------- | |
3878 @cindex @samp{Message > Compose a New Message} menu item | |
3879 @cindex menu item, @samp{Message > Compose a New Message} | |
3880 @kindex s | |
3881 @findex mh-send | |
3882 @item s | |
3883 Compose a message (@code{mh-send}). | |
3884 @c ------------------------- | |
3885 @cindex @samp{Message > Redistribute Message...} menu item | |
3886 @cindex menu item, @samp{Message > Redistribute Message...} | |
3887 @kindex M-d | |
3888 @findex mh-redistribute | |
3889 @item M-d | |
3890 Redistribute a message (@code{mh-redistribute}). | |
3891 @c ------------------------- | |
3892 @findex mh-smail | |
3893 @item M-x mh-smail | |
3894 Compose a message with the MH mail system. | |
3895 @c ------------------------- | |
3896 @findex mh-smail-other-window | |
3897 @item M-x mh-smail-other-window | |
3898 Compose a message with the MH mail system in other window. | |
3899 @end table | |
3900 | |
3901 @cindex @samp{mh-sending-mail} customization group | |
3902 @cindex customization group, @samp{mh-sending-mail} | |
3903 | |
3904 In addition, several options from the @samp{mh-sending-mail} | |
3905 customization group are useful when sending mail or replying to mail. | |
3906 They are summarized in the following table. | |
3907 | |
3908 @vtable @code | |
3909 @item mh-compose-forward-as-mime-flag | |
3910 On means that messages are forwarded as attachments (default: | |
3911 @samp{on}). | |
3912 @c ------------------------- | |
3913 @item mh-compose-letter-function | |
3914 Hook run when starting a new draft (default: @code{nil}). | |
3915 @c ------------------------- | |
3916 @item mh-compose-prompt-flag | |
3917 On means prompt for header fields when composing a new draft (default: | |
3918 @samp{off}). | |
3919 @c ------------------------- | |
3920 @item mh-forward-subject-format | |
3921 Format string for forwarded message subject (default: @code{"%s: | |
3922 %s"}). | |
3923 @c ------------------------- | |
3924 @item mh-insert-x-mailer-flag | |
3925 On means append an @samp{X-Mailer:} header field to the header | |
3926 (default: @samp{on}). | |
3927 @c ------------------------- | |
3928 @item mh-redist-full-contents-flag | |
3929 On means the @command{dist} command needs entire letter for | |
3930 redistribution (default: @samp{off}). | |
3931 @c ------------------------- | |
3932 @item mh-reply-default-reply-to | |
3933 Sets the person or persons to whom a reply will be sent (default: | |
3934 @samp{Prompt}). | |
3935 @c ------------------------- | |
3936 @item mh-reply-show-message-flag | |
3937 On means the MH-Show buffer is displayed using @kbd{r} | |
3938 (@code{mh-reply}) (default: @samp{on}). | |
3939 @end vtable | |
3940 | |
3941 The following hooks are available. | |
3942 | |
3943 @vtable @code | |
3944 @item mh-forward-hook | |
3945 Hook run by @code{mh-forward} on a forwarded letter (default: | |
3946 @code{nil}). | |
3947 @c ------------------------- | |
3948 @item mh-letter-mode-hook | |
3949 Hook run by @code{mh-letter-mode} on a new letter (default: | |
3950 @code{nil}). | |
3951 @end vtable | |
3952 | |
3953 The functions and options introduced here are explained in more detail | |
3954 in the following sections. | |
3955 | |
3956 @menu | |
3957 * Composing:: | |
3958 * Replying:: | |
3959 * Forwarding:: | |
3960 * Redistributing:: | |
3961 * Editing Again:: | |
3962 @end menu | |
3963 | |
3964 @node Composing, Replying, Sending Mail, Sending Mail | |
3965 @section Composing | |
3966 | |
3967 @cindex @file{.emacs} | |
3968 @cindex MH-Folder mode | |
3969 @cindex composing mail | |
3970 @cindex draft | |
3971 @cindex files, @file{.emacs} | |
3972 @cindex modes, MH-Folder | |
3973 @cindex sending mail | |
3974 @findex mh-smail | |
3975 @findex mh-smail-other-window | |
3976 @kindex M-x mh-smail | |
3977 @kindex M-x mh-smail-other-window | |
3978 | |
3979 Outside of an MH-Folder buffer, you must call either @kbd{M-x | |
3980 mh-smail} or @kbd{M-x mh-smail-other-window} to compose a new message. | |
3981 The former command always creates a two-window layout with the current | |
3982 buffer on top and the draft on the bottom. Use the latter command if | |
3983 you would rather preserve the window layout. You may find adding the | |
3984 following key bindings to @file{~/.emacs} useful: | |
3985 | |
3986 @smalllisp | |
3987 (global-set-key "\C-xm" 'mh-smail) | |
3988 (global-set-key "\C-x4m" 'mh-smail-other-window) | |
3989 @end smalllisp | |
3990 | |
3991 @cindex draft folder | |
3992 @cindex MH-Letter mode | |
3993 @cindex modes, MH-Letter | |
3994 @findex mh-send | |
3995 @kindex m | |
3996 | |
3997 From within a MH-Folder buffer, you can simply use the command @kbd{m} | |
3998 (@code{mh-send}). However you invoke @code{mh-send}, your letter | |
3999 appears in an Emacs buffer whose mode is MH-Letter (to see what the | |
4000 buffer looks like, @pxref{Sending Mail Tour}). MH-Letter mode allows | |
4001 you to edit your message, to check the validity of the recipients, to | |
4002 insert attachments and other messages into your message, and to send | |
4003 the message. We'll go more into depth about editing a | |
4004 @dfn{draft}@footnote{I highly recommend that you use a @dfn{draft | |
4005 folder} so that you can edit several drafts in parallel. To do so, | |
4006 create a folder named @samp{+drafts} for example, and add the profile | |
4007 component @samp{Draft-Folder: drafts} (see @code{mh-profile}(5)).} (a | |
4008 message you're composing) in just a moment (@pxref{Editing Drafts}). | |
4009 | |
4010 @vindex mh-compose-prompt-flag | |
4011 | |
4012 If you prefer to be prompted for the recipient and subject fields | |
4013 before the MH-Letter buffer appears, turn on the option | |
4014 @code{mh-compose-prompt-flag}. | |
4015 | |
4016 @cindex header field, @samp{X-Mailer:} | |
4017 @cindex @samp{X-Mailer:} header field | |
4018 @vindex mh-insert-x-mailer-flag | |
4019 | |
4020 MH-E adds an @samp{X-Mailer:} header field to the header that includes | |
4021 the version of MH-E and Emacs that you are using. If you don't want to | |
4022 participate in our marketing, you can turn off the option | |
4023 @code{mh-insert-x-mailer-flag}. | |
4024 | |
4025 @cindex @command{repl} | |
4026 @cindex @file{components} | |
4027 @cindex MH commands, @command{repl} | |
4028 @cindex MH-Letter mode | |
4029 @cindex Mail mode | |
4030 @cindex files, @file{components} | |
4031 @cindex modes, MH-Letter | |
4032 @cindex modes, Mail | |
4033 @vindex mail-mode-hook | |
4034 @vindex mh-letter-mode-hook | |
4035 @vindex text-mode-hook | |
4036 | |
4037 Two hooks are provided to run commands on your freshly created draft. | |
4038 The first hook, @code{mh-letter-mode-hook}, allows you to do some | |
4039 processing before editing a letter@footnote{Actually, because | |
4040 MH-Letter mode inherits from Mail mode, the hooks | |
4041 @code{text-mode-hook} and @code{mail-mode-hook} are run (in that | |
4042 order) before @code{mh-letter-mode-hook}.}. For example, you may wish | |
4043 to modify the header after @command{repl} has done its work, or you | |
4044 may have a complicated @file{components} file and need to tell MH-E | |
4045 where the cursor should go. Here's an example of how you would use | |
4046 this hook. | |
4047 | |
4048 @findex mh-insert-signature, example | |
4049 | |
4050 @smalllisp | |
4051 @group | |
4052 (defvar letter-mode-init-done-flag nil | |
4053 "Non-nil means one-time MH-E settings have been made.") | |
4054 | |
4055 (defun my-mh-letter-mode-hook () | |
4056 "Prepare letter for editing." | |
4057 (when (not letter-mode-init-done) ; @r{only need to bind the keys once} | |
4058 (local-set-key "\C-ctb" 'add-enriched-text) | |
4059 (local-set-key "\C-cti" 'add-enriched-text) | |
4060 (local-set-key "\C-ctf" 'add-enriched-text) | |
4061 (local-set-key "\C-cts" 'add-enriched-text) | |
4062 (local-set-key "\C-ctB" 'add-enriched-text) | |
4063 (local-set-key "\C-ctu" 'add-enriched-text) | |
4064 (local-set-key "\C-ctc" 'add-enriched-text) | |
4065 (setq letter-mode-init-done t)) | |
4066 (save-excursion | |
4067 (goto-char (point-max)) ; @r{go to end of message to} | |
4068 (mh-insert-signature))) ; @r{insert signature} | |
4069 | |
4070 @i{Prepare draft for editing via mh-letter-mode-hook} | |
4071 | |
4072 @end group | |
4073 @end smalllisp | |
4074 | |
4075 The function, @code{add-enriched-text} is defined in the example in | |
4076 @ref{Adding Attachments}. | |
4077 | |
4078 @vindex mh-compose-letter-function | |
4079 @vindex mh-letter-mode-hook | |
4080 | |
4081 The second hook, a function really, is | |
4082 @code{mh-compose-letter-function}. Like @code{mh-letter-mode-hook}, it | |
4083 is called just before editing a new message; however, it is the last | |
4084 function called before you edit your message. The consequence of this | |
4085 is that you can write a function to write and send the message for | |
4086 you. This function is passed three arguments: the contents of the | |
4087 @samp{To:}, @samp{Subject:}, and @samp{Cc:} header fields. | |
4088 | |
4089 @node Replying, Forwarding, Composing, Sending Mail | |
4090 @section Replying to Mail | |
4091 | |
4092 @cindex @command{mhl} | |
4093 @cindex @file{mhl.reply} | |
4094 @cindex MH commands, @command{mhl} | |
4095 @cindex files, @file{mhl.reply} | |
4096 @cindex replying | |
4097 @findex mh-reply | |
4098 @kindex r | |
4099 | |
4100 To compose a reply to a message, use the @kbd{r} (@code{mh-reply}) | |
4101 command. | |
4102 | |
4103 When you reply to a message, you are first prompted with @samp{Reply | |
4104 to whom?}. You have several choices here. | |
4105 | |
4106 @quotation | |
4107 @multitable @columnfractions .20 .80 | |
4108 @c @headitem Response @tab Reply Goes To | |
4109 @c XXX @headitem not yet supported by SourceForge's texi2pdf. | |
4110 @item @b{Response} @tab @b{Reply Goes To} | |
4111 @c ------------------------- | |
4112 @item @kbd{from} | |
4113 @tab | |
4114 The person who sent the message. This is the default, so @key{RET} is | |
4115 sufficient. | |
4116 @c ------------------------- | |
4117 @item @kbd{to} | |
4118 @tab | |
4119 Replies to the sender, plus all recipients in the @samp{To:} header field. | |
4120 @c ------------------------- | |
4121 @item @kbd{cc}@*@kbd{all} | |
4122 @tab | |
4123 Forms a reply to the addresses in the @samp{Mail-Followup-To:} header | |
4124 field if one exists; otherwise forms a reply to the sender, plus all | |
4125 recipients. | |
4126 @end multitable | |
4127 @end quotation | |
4128 | |
4129 @cindex @command{repl} | |
4130 @cindex MH commands, @command{repl} | |
4131 @vindex mh-reply-default-reply-to | |
4132 | |
4133 Depending on your answer, @command{repl}@footnote{See the section | |
4134 @uref{@value{MH-BOOK-HOME}/reprep.html, Replying to Messages: repl} in | |
4135 the MH book.} is given a different argument to form your reply. | |
4136 Specifically, a choice of @kbd{from} or none at all runs @samp{repl | |
4137 -nocc all}, and a choice of @kbd{to} runs @samp{repl -cc to}. Finally, | |
4138 either @kbd{cc} or @kbd{all} runs @samp{repl -cc all -nocc me}. If you | |
4139 find that most of the time you specify one of these choices when you | |
4140 reply to a message, you can change the option | |
4141 @code{mh-reply-default-reply-to} from its default value of | |
4142 @samp{Prompt} to one of the choices listed above. You can always edit | |
4143 the recipients in the draft. | |
4144 | |
4145 @cindex @samp{repl:} MH profile component | |
4146 @cindex MH profile component, @samp{repl:} | |
4147 @cindex MH-Letter mode | |
4148 @cindex MH-Show mode | |
4149 @cindex draft | |
4150 @cindex modes, MH-Letter | |
4151 @cindex modes, MH-Show | |
4152 | |
4153 Two windows are then created. One window contains the message to which | |
4154 you are replying in an MH-Show buffer. Your draft, in MH-Letter mode | |
4155 (@pxref{Editing Drafts}), is in the other window. If the reply draft | |
4156 was not one that you expected, check the things that affect the | |
4157 behavior of @command{repl} which include the @samp{repl:} profile | |
4158 component and the @file{replcomps} and @file{replgroupcomps} files. | |
4159 | |
4160 If you supply a prefix argument (as in @kbd{C-u r}), the message you | |
4161 are replying to is inserted in your reply after having first been run | |
4162 through @command{mhl} with the format file @file{mhl.reply}. See | |
4163 @command{mhl}(1) or the section | |
4164 @uref{@value{MH-BOOK-HOME}/shomes.html#Usisho, Using mhl} in the MH | |
4165 book to see how you can modify the default @file{mhl.reply} file. | |
4166 | |
4167 @vindex mh-yank-behavior | |
4168 | |
4169 Alternatively, you can customize the option @code{mh-yank-behavior} | |
4170 and choose one of its @samp{Automatically} variants to do the same | |
4171 thing. @xref{Inserting Letter}. If you do so, the prefix argument has | |
4172 no effect. | |
4173 | |
4174 Another way to include the message automatically in your draft is to | |
4175 use @samp{repl: -filter repl.filter} in your MH profile. | |
4176 | |
4177 @vindex mh-reply-show-message-flag | |
4178 | |
4179 If you include the message automatically, you can hide the MH-Show | |
4180 buffer by turning off the option @code{mh-reply-show-message-flag}. | |
4181 | |
4182 If you wish to customize the header or other parts of the reply draft, | |
4183 please see @command{repl}(1) and @code{mh-format}(5). | |
4184 | |
4185 @node Forwarding, Redistributing, Replying, Sending Mail | |
4186 @section Forwarding Mail | |
4187 | |
4188 @cindex @command{forw} | |
4189 @cindex draft | |
4190 @cindex forwarding | |
4191 @cindex MH commands, @command{forw} | |
4192 @findex mh-forward | |
4193 @kindex f | |
4194 @vindex mh-forward-hook | |
4195 | |
4196 To forward a message, use the @kbd{f} (@code{mh-forward}) command. You | |
4197 are prompted for the @samp{To:} and @samp{cc:} recipients. You are | |
4198 given a draft to edit that looks like it would if you had run the MH | |
4199 command @command{forw}@footnote{See the section | |
4200 @uref{@value{MH-BOOK-HOME}/forfor.html, Forwarding Messages: forw} in | |
4201 the MH book.}. You can then add some text (@pxref{Editing Drafts}). | |
4202 You can forward several messages by using a range (@pxref{Ranges}). | |
4203 All of the messages in the range are inserted into your draft. The | |
4204 hook @code{mh-forward-hook} is called on the draft. | |
4205 | |
4206 @cindex @file{.mh_profile} | |
4207 @cindex files, @file{.mh_profile} | |
4208 @cindex MH profile component, @samp{forw:} | |
4209 @cindex @samp{forw:} MH profile component | |
4210 @vindex mh-compose-forward-as-mime-flag | |
4211 | |
4212 By default, the option @code{mh-compose-forward-as-mime-flag} is on | |
4213 which means that the forwarded messages are included as attachments. | |
4214 If you would prefer to forward your messages verbatim (as text, | |
4215 inline), then turn off this option. Forwarding messages verbatim works | |
4216 well for short, textual messages, but your recipient won't be able to | |
4217 view any non-textual attachments that were in the forwarded message. | |
4218 Be aware that if you have @samp{forw: -mime} in your MH profile, then | |
4219 forwarded messages will always be included as attachments regardless | |
4220 of the settings of @code{mh-compose-forward-as-mime-flag}. | |
4221 | |
4222 @vindex mh-forward-subject-format | |
4223 | |
4224 The format of the @samp{Subject:} header field for forwarded messages | |
4225 is controlled by the option @code{mh-forward-subject-format}. This | |
4226 option is a string which includes two escapes (@samp{%s}). The first | |
4227 @samp{%s} is replaced with the sender of the original message, and the | |
4228 second one is replaced with the original @samp{Subject:}. The default | |
4229 value of @code{"%s: %s"} takes a message with the header: | |
4230 | |
4231 @smallexample | |
4232 @group | |
4233 To: Bill Wohler <wohler@@stop.mail-abuse.org> | |
4234 Subject: Re: 49er football | |
4235 From: Greg DesBrisay <gd@@stop.mail-abuse.org> | |
4236 @end group | |
4237 @end smallexample | |
4238 | |
4239 and creates a subject header field of: | |
4240 | |
4241 @smallexample | |
4242 Subject: Greg DesBrisay: Re: 49er football | |
4243 @end smallexample | |
4244 | |
4245 @node Redistributing, Editing Again, Forwarding, Sending Mail | |
4246 @section Redistributing Your Mail | |
4247 | |
4248 @cindex @command{dist} | |
4249 @cindex MH commands, @command{dist} | |
4250 @cindex redistributing | |
4251 @findex mh-redistribute | |
4252 @kindex M-d | |
4253 | |
4254 The command @kbd{M-d} (@code{mh-redistribute}) is similar in function | |
4255 to forwarding mail, but it does not allow you to edit the message, nor | |
4256 does it add your name to the @samp{From:} header field. It appears to | |
4257 the recipient as if the message had come from the original sender. | |
4258 When you run this command, you are prompted for the recipients. | |
4259 | |
4260 @findex mh-edit-again | |
4261 @kindex e | |
4262 | |
4263 For more information on redistributing messages, see | |
4264 @command{dist}(1). Also investigate the command @kbd{e} | |
4265 (@code{mh-edit-again}) for another way to redistribute messages | |
4266 (@pxref{Editing Again}). | |
4267 | |
4268 @cindex @command{send} | |
4269 @cindex MH commands, @command{send} | |
4270 @vindex mh-redist-full-contents-flag | |
4271 | |
4272 The option @code{mh-redist-full-contents-flag} must be turned on if | |
4273 @command{dist}@footnote{See the section | |
4274 @uref{@value{MH-BOOK-HOME}/disdis.html, Distributing Messages with | |
4275 dist} in the MH book.} requires the whole letter for redistribution, | |
4276 which is the case if @command{send}@footnote{See the section | |
4277 @uref{@value{MH-BOOK-HOME}/sensen.html, Sending Some Mail: comp send} | |
4278 in the MH book.} is compiled with the @sc{berk} option (which many | |
4279 people abhor). If you find that MH will not allow you to redistribute | |
4280 a message that has been redistributed before, turn off this option. | |
4281 | |
4282 @node Editing Again, , Redistributing, Sending Mail | |
4283 @section Editing Old Drafts and Bounced Messages | |
4284 | |
4285 @cindex @file{draft} | |
4286 @cindex files, @file{draft} | |
4287 @cindex re-editing drafts | |
4288 @findex mh-edit-again | |
4289 @kindex F v drafts | |
4290 @kindex e | |
4291 @kindex n | |
4292 | |
4293 If you don't complete a draft for one reason or another, and if the | |
4294 draft buffer is no longer available, you can pick your draft up again | |
4295 with @kbd{e} (@code{mh-edit-again}). If you don't use a draft | |
4296 folder, your last @file{draft} file will be used. If you use draft | |
4297 folders, you'll need to visit the draft folder with @kbd{F v drafts | |
4298 @key{RET}}, use @kbd{n} to move to the appropriate message, and then | |
4299 use @kbd{e} to prepare the message for editing. | |
4300 | |
4301 @kindex e | |
4302 | |
4303 The @kbd{e} command can also be used to take messages that were sent | |
4304 to you and to send them to more people. | |
4305 | |
4306 @cindex Mailer-Daemon | |
4307 @findex mh-extract-rejected-mail | |
4308 @kindex C-c C-c | |
4309 @kindex E | |
4310 | |
4311 Don't use @kbd{e} to re-edit a message from a @i{Mailer-Daemon} who | |
4312 complained that your mail wasn't posted for some reason or another. In | |
4313 this case, use @kbd{E} (@code{mh-extract-rejected-mail}) to prepare | |
4314 the message for editing by removing the @i{Mailer-Daemon} envelope and | |
4315 unneeded header fields. Fix whatever addressing problem you had, and | |
4316 send the message again with @kbd{C-c C-c}. | |
4317 | |
4318 @node Editing Drafts, Aliases, Sending Mail, Top | |
4319 @chapter Editing a Draft | |
4320 | |
4321 @cindex @samp{Letter} menu | |
4322 @cindex MH-Letter mode | |
4323 @cindex draft | |
4324 @cindex editing draft | |
4325 @cindex menu, @samp{Letter} | |
4326 @cindex modes, MH-Letter | |
4327 | |
4328 When you edit a message that you want to send (called a @dfn{draft} in | |
4329 this case), the mode used is MH-Letter. This mode provides several | |
4330 commands in addition to the normal Emacs editing commands to help you | |
4331 edit your draft. These can also be found in the @samp{Letter} menu. | |
4332 | |
4333 @table @kbd | |
4334 @kindex @key{SPC} | |
4335 @findex mh-letter-complete-or-space | |
4336 @item @key{SPC} | |
4337 Perform completion or insert space (@code{mh-letter-complete-or-space}). | |
4338 @c ------------------------- | |
4339 @kindex M-@key{TAB} | |
4340 @findex mh-letter-complete | |
4341 @item M-@key{TAB} | |
4342 Perform completion on header field or word preceding point | |
4343 (@code{mh-letter-complete}). | |
4344 @c ------------------------- | |
4345 @kindex , (comma) | |
4346 @findex mh-letter-confirm-address | |
4347 @item , (comma) | |
4348 Flash alias expansion (@code{mh-letter-confirm-address}). | |
4349 @c ------------------------- | |
4350 @kindex @key{TAB} | |
4351 @findex mh-letter-next-header-field-or-indent | |
4352 @item @key{TAB} | |
4353 Cycle to next field (@code{mh-letter-next-header-field-or-indent}). | |
4354 @c ------------------------- | |
4355 @kindex S-@key{TAB} | |
4356 @findex mh-letter-previous-header-field | |
4357 @item S-@key{TAB} | |
4358 Cycle to the previous header field | |
4359 (@code{mh-letter-previous-header-field}). | |
4360 @c ------------------------- | |
4361 @kindex C-c ? | |
4362 @findex mh-help | |
4363 @item C-c ? | |
4364 Display cheat sheet for the MH-E commands (@code{mh-help}). | |
4365 @c ------------------------- | |
4366 @cindex @samp{Letter > Send This Draft} menu item | |
4367 @cindex menu item, @samp{Letter > Send This Draft} | |
4368 @kindex C-c C-c | |
4369 @findex mh-send-letter | |
4370 @item C-c C-c | |
4371 Save draft and send message (@code{mh-send-letter}). | |
4372 @c ------------------------- | |
4373 @kindex C-c C-d | |
4374 @findex mh-insert-identity | |
4375 @item C-c C-d | |
4376 Insert fields specified by the given identity | |
4377 (@code{mh-insert-identity}). @xref{Identities}. | |
4378 @c ------------------------- | |
4379 @cindex @samp{Letter > Pull in All Compositions (MH)} menu item | |
4380 @cindex menu item, @samp{Letter > Pull in All Compositions (MH)} | |
4381 @kindex C-c C-e | |
4382 @findex mh-mh-to-mime | |
4383 @item C-c C-e | |
4384 Compose @sc{mime} message from MH-style directives | |
4385 (@code{mh-mh-to-mime}). | |
4386 @c ------------------------- | |
4387 @kindex C-c C-f C-a | |
4388 @kindex C-c C-f a | |
4389 @findex mh-to-field | |
4390 @item C-c C-f C-a | |
4391 @itemx C-c C-f a | |
4392 Move to @samp{Mail-Reply-To:} header field (@code{mh-to-field}). | |
4393 @c ------------------------- | |
4394 @kindex C-c C-f C-b | |
4395 @kindex C-c C-f b | |
4396 @item C-c C-f C-b | |
4397 @itemx C-c C-f b | |
4398 Move to @samp{Bcc:} header field (@code{mh-to-field}). | |
4399 @c ------------------------- | |
4400 @kindex C-c C-f C-c | |
4401 @kindex C-c C-f c | |
4402 @item C-c C-f C-c | |
4403 @itemx C-c C-f c | |
4404 Move to @samp{Cc:} header field (@code{mh-to-field}). | |
4405 @c ------------------------- | |
4406 @kindex C-c C-f C-d | |
4407 @kindex C-c C-f d | |
4408 @item C-c C-f C-d | |
4409 @itemx C-c C-f d | |
4410 Move to @samp{Dcc:} header field (@code{mh-to-field}). | |
4411 @c ------------------------- | |
4412 @kindex C-c C-f C-f | |
4413 @kindex C-c C-f f | |
4414 @findex mh-to-fcc | |
4415 @item C-c C-f C-f | |
4416 @itemx C-c C-f f | |
4417 Move to @samp{Fcc:} header field (@code{mh-to-fcc}). | |
4418 @c ------------------------- | |
4419 @kindex C-c C-f C-l | |
4420 @kindex C-c C-f l | |
4421 @item C-c C-f C-l | |
4422 @itemx C-c C-f l | |
4423 Move to @samp{Mail-Followup-To:} header field (@code{mh-to-field}). | |
4424 @c ------------------------- | |
4425 @kindex C-c C-f C-m | |
4426 @kindex C-c C-f m | |
4427 @item C-c C-f C-m | |
4428 @itemx C-c C-f m | |
4429 Move to @samp{From:} header field (@code{mh-to-field}). | |
4430 @c ------------------------- | |
4431 @kindex C-c C-f C-r | |
4432 @kindex C-c C-f r | |
4433 @item C-c C-f C-r | |
4434 @itemx C-c C-f r | |
4435 Move to @samp{Reply-To:} header field (@code{mh-to-field}). | |
4436 @c ------------------------- | |
4437 @kindex C-c C-f C-s | |
4438 @kindex C-c C-f s | |
4439 @item C-c C-f C-s | |
4440 @itemx C-c C-f s | |
4441 Move to @samp{Subject:} header field (@code{mh-to-field}). | |
4442 @c ------------------------- | |
4443 @kindex C-c C-f C-t | |
4444 @kindex C-c C-f t | |
4445 @item C-c C-f C-t | |
4446 @itemx C-c C-f t | |
4447 Move to @samp{To:} header field (@code{mh-to-field}). | |
4448 @c ------------------------- | |
4449 @cindex @samp{Letter > Insert a Message...} menu item | |
4450 @cindex menu item, @samp{Letter > Insert a Message...} | |
4451 @kindex C-c C-i | |
4452 @findex mh-insert-letter | |
4453 @item C-c C-i | |
4454 Insert a message (@code{mh-insert-letter}). | |
4455 @c ------------------------- | |
4456 @kindex C-c C-m C-e | |
4457 @findex mh-mml-secure-message-encrypt | |
4458 @item C-c C-m C-e | |
4459 Add tag to encrypt the message (@code{mh-mml-secure-message-encrypt}). | |
4460 @c ------------------------- | |
4461 @cindex @samp{Letter > Compose Forward...} menu item | |
4462 @cindex menu item, @samp{Letter > Compose Forward...} | |
4463 @kindex C-c C-m C-f | |
4464 @kindex C-c C-m f | |
4465 @findex mh-compose-forward | |
4466 @item C-c C-m C-f | |
4467 @itemx C-c C-m f | |
4468 Add tag to forward a message (@code{mh-compose-forward}). | |
4469 @c ------------------------- | |
4470 @cindex @samp{Letter > Compose Get File (MH)...} menu item | |
4471 @cindex menu item, @samp{Letter > Compose Get File (MH)...} | |
4472 @kindex C-c C-m C-g | |
4473 @kindex C-c C-m g | |
4474 @findex mh-mh-compose-anon-ftp | |
4475 @item C-c C-m C-g | |
4476 @itemx C-c C-m g | |
4477 Add tag to include anonymous ftp reference to a file | |
4478 (@code{mh-mh-compose-anon-ftp}). | |
4479 @c ------------------------- | |
4480 @cindex @samp{Letter > Compose Insertion...} menu item | |
4481 @cindex menu item, @samp{Letter > Compose Insertion...} | |
4482 @kindex C-c C-m C-i | |
4483 @kindex C-c C-m i | |
4484 @findex mh-compose-insertion | |
4485 @item C-c C-m C-i | |
4486 @itemx C-c C-m i | |
4487 Add tag to include a file such as an image or sound | |
4488 (@code{mh-compose-insertion}). | |
4489 @c ------------------------- | |
4490 @cindex @samp{Letter > Pull in All Compositions (MML)} menu item | |
4491 @cindex menu item, @samp{Letter > Pull in All Compositions (MML)} | |
4492 @kindex C-c C-m C-m | |
4493 @kindex C-c C-m m | |
4494 @findex mh-mml-to-mime | |
4495 @item C-c C-m C-m | |
4496 @itemx C-c C-m m | |
4497 Compose @sc{mime} message from MML tags (@code{mh-mml-to-mime}). | |
4498 @c ------------------------- | |
4499 @kindex C-c C-m C-n | |
4500 @kindex C-c C-m n | |
4501 @findex mh-mml-unsecure-message | |
4502 @item C-c C-m C-n | |
4503 @itemx C-c C-m n | |
4504 Remove any secure message tags (@code{mh-mml-unsecure-message}). | |
4505 @c ------------------------- | |
4506 @kindex C-c C-m C-s | |
4507 @findex mh-mml-secure-message-sign | |
4508 @item C-c C-m C-s | |
4509 Add tag to sign the message (@code{mh-mml-secure-message-sign}). | |
4510 @c ------------------------- | |
4511 @cindex @samp{Letter > Compose Compressed tar (MH)...} menu item | |
4512 @cindex menu item, @samp{Letter > Compose Compressed tar (MH)...} | |
4513 @kindex C-c C-m C-t | |
4514 @kindex C-c C-m t | |
4515 @findex mh-mh-compose-external-compressed-tar | |
4516 @item C-c C-m C-t | |
4517 @itemx C-c C-m t | |
4518 Add tag to include anonymous ftp reference to a compressed tar file | |
4519 (@code{mh-mh-compose-external-compressed-tar}). | |
4520 @c ------------------------- | |
4521 @cindex @samp{Letter > Revert to Non-MIME Edit (MH)} menu item | |
4522 @cindex menu item, @samp{Letter > Revert to Non-MIME Edit (MH)} | |
4523 @kindex C-c C-m C-u | |
4524 @kindex C-c C-m u | |
4525 @findex mh-mh-to-mime-undo | |
4526 @item C-c C-m C-u | |
4527 @itemx C-c C-m u | |
4528 Undo effects of @kbd{C-c C-e} (@code{mh-mh-to-mime-undo}). | |
4529 @c ------------------------- | |
4530 @kindex C-c C-m C-x | |
4531 @kindex C-c C-m x | |
4532 @findex mh-mh-compose-external-type | |
4533 @item C-c C-m C-x | |
4534 @itemx C-c C-m x | |
4535 Add tag to refer to a remote file | |
4536 (@code{mh-mh-compose-external-type}). | |
4537 @c ------------------------- | |
4538 @kindex C-c C-m e e | |
4539 @findex mh-mml-secure-message-encrypt | |
4540 @item C-c C-m e e | |
4541 Add tag to encrypt the message (@code{mh-mml-secure-message-encrypt}). | |
4542 @c ------------------------- | |
4543 @kindex C-c C-m e s | |
4544 @findex mh-mml-secure-message-signencrypt | |
4545 @item C-c C-m e s | |
4546 Add tag to encrypt and sign the message@* | |
4547 (@code{mh-mml-secure-message-signencrypt}). | |
4548 @c ------------------------- | |
4549 @kindex C-c C-m s e | |
4550 @findex mh-mml-secure-message-signencrypt | |
4551 @item C-c C-m s e | |
4552 Add tag to encrypt and sign the message@* | |
4553 (@code{mh-mml-secure-message-signencrypt}). | |
4554 @c ------------------------- | |
4555 @kindex C-c C-m s s | |
4556 @findex mh-mml-secure-message-sign | |
4557 @item C-c C-m s s | |
4558 Add tag to sign the message (@code{mh-mml-secure-message-sign}). | |
4559 @c ------------------------- | |
4560 @cindex @samp{Letter > Split Current Line} menu item | |
4561 @cindex menu item, @samp{Letter > Split Current Line} | |
4562 @kindex C-c C-o | |
4563 @findex mh-open-line | |
4564 @item C-c C-o | |
4565 Insert a newline and leave point before it (@code{mh-open-line}). | |
4566 @c ------------------------- | |
4567 @cindex @samp{Letter > Kill This Draft} menu item | |
4568 @cindex menu item, @samp{Letter > Kill This Draft} | |
4569 @kindex C-c C-q | |
4570 @findex mh-fully-kill-draft | |
4571 @item C-c C-q | |
4572 Quit editing and delete draft message (@code{mh-fully-kill-draft}). | |
4573 @c ------------------------- | |
4574 @cindex @samp{Letter > Insert Signature} menu item | |
4575 @cindex menu item, @samp{Letter > Insert Signature} | |
4576 @kindex C-c C-s | |
4577 @findex mh-insert-signature | |
4578 @item C-c C-s | |
4579 Insert signature in message (@code{mh-insert-signature}). | |
4580 @c ------------------------- | |
4581 @kindex C-c C-t | |
4582 @findex mh-letter-toggle-header-field-display | |
4583 @item C-c C-t | |
4584 Toggle display of header field at point | |
4585 (@code{mh-letter-toggle-header-field-display}). | |
4586 @c ------------------------- | |
4587 @cindex @samp{Letter > Check Recipient} menu item | |
4588 @cindex menu item, @samp{Letter > Check Recipient} | |
4589 @kindex C-c C-w | |
4590 @findex mh-check-whom | |
4591 @item C-c C-w | |
4592 Verify recipients, showing expansion of any aliases | |
4593 (@code{mh-check-whom}). | |
4594 @c ------------------------- | |
4595 @cindex @samp{Letter > Yank Current Message} menu item | |
4596 @cindex menu item, @samp{Letter > Yank Current Message} | |
4597 @kindex C-c C-y | |
4598 @findex mh-yank-cur-msg | |
4599 @item C-c C-y | |
4600 Insert the current message into the draft buffer | |
4601 (@code{mh-yank-cur-msg}). | |
4602 @c ------------------------- | |
4603 @kindex C-c M-d | |
4604 @findex mh-insert-auto-fields | |
4605 @item C-c M-d | |
4606 Insert custom fields if recipient is found in | |
4607 @code{mh-auto-fields-list} (@code{mh-insert-auto-fields}). | |
4608 @xref{Identities}. | |
4609 @end table | |
4610 | |
4611 @cindex @samp{mh-letter} customization group | |
4612 @cindex customization group, @samp{mh-letter} | |
4613 | |
4614 Several options from the @samp{mh-letter} customization group are used | |
4615 while editing a draft. | |
4616 | |
4617 @vtable @code | |
4618 @item mh-compose-insertion | |
4619 Type of @sc{mime} message tags in messages (default: @samp{MML} if | |
4620 available; otherwise @samp{MH}). | |
4621 @c ------------------------- | |
4622 @item mh-compose-skipped-header-fields | |
4623 List of header fields to skip over when navigating in draft (default: | |
4624 @code{'("From"} @code{"Organization"} @code{"References"} | |
4625 @code{"In-Reply-To"} @code{"X-Face"} @code{"Face"} | |
4626 @code{"X-Image-URL"} @code{"X-Mailer")}. | |
4627 @c ------------------------- | |
4628 @item mh-compose-space-does-completion-flag | |
4629 On means @key{SPC} does completion in message header (default: | |
4630 @samp{off}). | |
4631 @c ------------------------- | |
4632 @item mh-delete-yanked-msg-window-flag | |
4633 On means delete any window displaying the message (default: @samp{off}). | |
4634 @c ------------------------- | |
4635 @item mh-extract-from-attribution-verb | |
4636 Verb to use for attribution when a message is yanked by @kbd{C-c C-y} | |
4637 (default: @code{"wrote:"}). | |
4638 @c ------------------------- | |
4639 @item mh-ins-buf-prefix | |
4640 String to put before each line of a yanked or inserted message | |
4641 (default: @code{"> "}). | |
4642 @c ------------------------- | |
4643 @item mh-letter-complete-function | |
4644 Function to call when completing outside of address or folder fields | |
4645 (default: @code{ispell-complete-word}). | |
4646 @c ------------------------- | |
4647 @item mh-letter-fill-column | |
4648 Fill column to use in MH-Letter mode (default: 72). | |
4649 @c ------------------------- | |
4650 @item mh-mml-method-default | |
4651 Default method to use in security tags (default: @samp{PGP (MIME)} if | |
4652 support for it is available; otherwise @samp{None}). | |
4653 @c ------------------------- | |
4654 @item mh-signature-file-name | |
4655 Source of user's signature (default: @code{"~/.signature"}). | |
4656 @c ------------------------- | |
4657 @item mh-signature-separator-flag | |
4658 On means a signature separator should be inserted (default: | |
4659 @samp{on}). | |
4660 @c ------------------------- | |
4661 @item mh-x-face-file | |
4662 File containing X-Face or Face header field to insert in outgoing mail. | |
4663 (default: @code{"~/.face"}). | |
4664 @c ------------------------- | |
4665 @item mh-yank-behavior | |
4666 Controls which part of a message is yanked by @kbd{C-c C-y} (default: | |
4667 @samp{Body With Attribution}). | |
4668 @end vtable | |
4669 | |
4670 The following hooks are available. | |
4671 | |
4672 @vtable @code | |
4673 @item mail-citation-hook | |
4674 Hook for modifying a citation just inserted in the mail buffer | |
4675 (default: @code{nil}). | |
4676 @c ------------------------- | |
4677 @item mh-before-send-letter-hook | |
4678 Hook run at the beginning of the @kbd{C-c C-c} command (default: | |
4679 @samp{nil}). | |
4680 @c ------------------------- | |
4681 @item mh-mh-to-mime-hook | |
4682 Hook run on the formatted letter by @kbd{C-c C-e} (default: | |
4683 @samp{nil}). | |
4684 @c ------------------------- | |
4685 @item mh-insert-signature-hook | |
4686 Hook run by @kbd{C-c C-s} after signature has been inserted (default: | |
4687 @code{nil}). | |
4688 @end vtable | |
4689 | |
4690 The following face is available. | |
4691 | |
4692 @vtable @code | |
4693 @item mh-letter-header-field | |
4694 Editable header field value face in draft buffers. | |
4695 @end vtable | |
4696 | |
4697 The commands and options introduced here are explained in more | |
4698 detail in the following sections. | |
4699 | |
4700 @menu | |
4701 * Editing Message:: | |
4702 * Inserting Letter:: | |
4703 * Inserting Messages:: | |
4704 * Signature:: | |
4705 * Picture:: | |
4706 * Adding Attachments:: | |
4707 * Sending PGP:: | |
4708 * Checking Recipients:: | |
4709 * Sending Message:: | |
4710 * Killing Draft:: | |
4711 @end menu | |
4712 | |
4713 @node Editing Message, Inserting Letter, Editing Drafts, Editing Drafts | |
4714 @section Editing the Message | |
4715 | |
4716 @cindex @samp{Bcc:} header field | |
4717 @cindex @samp{Cc:} header field | |
4718 @cindex @samp{Dcc:} header field | |
4719 @cindex @samp{From:} header field | |
4720 @cindex @samp{Mail-Followup-To:} header field | |
4721 @cindex @samp{Mail-Reply-To:} header field | |
4722 @cindex @samp{Reply-To:} header field | |
4723 @cindex @samp{Subject:} header field | |
4724 @cindex @samp{To:} header field | |
4725 @cindex editing header | |
4726 @cindex header field, @samp{Bcc:} | |
4727 @cindex header field, @samp{Cc:} | |
4728 @cindex header field, @samp{Dcc:} | |
4729 @cindex header field, @samp{From:} | |
4730 @cindex header field, @samp{Mail-Followup-To:} | |
4731 @cindex header field, @samp{Mail-Reply-To:} | |
4732 @cindex header field, @samp{Reply-To:} | |
4733 @cindex header field, @samp{Subject:} | |
4734 @cindex header field, @samp{To:} | |
4735 @findex mh-to-field | |
4736 @kindex C-c C-f C-t | |
4737 @kindex C-c C-f t | |
4738 | |
4739 Because the header is part of the message, you can edit the header | |
4740 fields as you wish. However, several convenience commands exist to | |
4741 help you create and edit them. For example, the command @kbd{C-c C-f | |
4742 C-t} (@code{mh-to-field}; alternatively, @kbd{C-c C-f t}) moves the | |
4743 cursor to the @samp{To:} header field, creating it if necessary. The | |
4744 commands for moving to the @samp{Cc:}, @samp{Subject:}, @samp{From:}, | |
4745 @samp{Reply-To:}, @samp{Mail-Reply-To:}, @samp{Mail-Followup-To}, | |
4746 @samp{Bcc:}, and @samp{Dcc:} header fields are similar. | |
4747 | |
4748 @findex mh-to-fcc | |
4749 @kindex C-c C-f C-f | |
4750 @kindex C-c C-f f | |
4751 | |
4752 One command behaves differently from the others, namely, @kbd{C-c C-f | |
4753 C-f} (@code{mh-to-fcc}; alternatively, @kbd{C-c C-f f}). This command | |
4754 will prompt you for the folder name in which to file a copy of the | |
4755 draft. @xref{Folder Selection}. | |
4756 | |
4757 @findex indent-relative | |
4758 @findex mh-letter-next-header-field-or-indent | |
4759 @findex mh-letter-previous-header-field | |
4760 @kindex @key{TAB} | |
4761 @kindex S-@key{TAB} | |
4762 @vindex mh-compose-skipped-header-fields | |
4763 @vindex mh-letter-header-field | |
4764 | |
4765 Within the header of the message, the command@* @key{TAB} | |
4766 (@code{mh-letter-next-header-field-or-indent}) moves between fields | |
4767 that are highlighted with the face @code{mh-letter-header-field}, | |
4768 skipping those fields listed in | |
4769 @code{mh-compose-skipped-header-fields}. After the last field, this | |
4770 command then moves point to the message body before cycling back to | |
4771 the first field. If point is already past the first line of the | |
4772 message body, then this command indents by calling | |
4773 @code{indent-relative} with the given prefix argument. The command | |
4774 @kbd{S-@key{TAB}} (@code{mh-letter-previous-header-field}) moves | |
4775 backwards between the fields and cycles to the body of the message | |
4776 after the first field. Unlike the command @key{TAB}, it will always | |
4777 take point to the last field from anywhere in the body. | |
4778 | |
4779 @cindex alias completion | |
4780 @cindex completion | |
4781 @cindex spell check | |
4782 @findex ispell-complete-word | |
4783 @findex mh-letter-complete | |
4784 @findex mh-letter-complete-or-space | |
4785 @findex mh-letter-confirm-address | |
4786 @kindex , (comma) | |
4787 @kindex @key{SPC} | |
4788 @kindex M-@key{TAB} | |
4789 @vindex mh-alias-flash-on-comma | |
4790 @vindex mh-compose-space-does-completion-flag | |
4791 @vindex mh-letter-complete-function | |
4792 | |
4793 If the field contains addresses (for example, @samp{To:} or | |
4794 @samp{Cc:}) or folders (for example, @samp{Fcc:}) then the command | |
4795 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) will provide alias | |
4796 completion (@pxref{Aliases}). In the body of the message, | |
4797 @kbd{M-@key{TAB}} runs @code{mh-letter-complete-function} instead, | |
4798 which is set to @samp{'ispell-complete-word} by default. The command | |
4799 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) takes a prefix argument | |
4800 that is passed to the @code{mh-letter-complete-function}. In addition, | |
4801 turn on the option @code{mh-compose-space-does-completion-flag} to use | |
4802 the command @key{SPC} (@code{mh-letter-complete-or-space}) to perform | |
4803 completion in the header as well; use a prefix argument to specify | |
4804 more than one space. Addresses are separated by a comma; when you | |
4805 press the comma, the command @code{mh-letter-confirm-address} flashes | |
4806 the alias expansion in the minibuffer if | |
4807 @code{mh-alias-flash-on-comma} is turned on. | |
4808 | |
4809 @c XXX Document the replacement for the inaccessible 'long argument. | |
4810 | |
4811 @findex mh-letter-toggle-header-field-display | |
4812 @kindex C-c C-t | |
4813 | |
4814 Use the command @kbd{C-c C-t} | |
4815 @code{mh-letter-toggle-header-field-display} to display truncated | |
4816 header fields. This command is a toggle so entering it again will hide | |
4817 the field. This command takes a prefix argument: if negative then the | |
4818 field is hidden, if positive then the field is displayed (for example, | |
4819 @kbd{C-u C-c C-t}). | |
4820 | |
4821 Be sure to leave a row of dashes or a blank line between the header | |
4822 and the body of the message. | |
4823 | |
4824 @vindex mh-letter-fill-column | |
4825 | |
4826 The body of the message is edited as you would edit any Emacs buffer | |
4827 although there are a few commands and options to assist you. You can | |
4828 change the fill column in MH-Letter mode with the option | |
4829 @code{mh-letter-fill-column}. By default, this option is 72 to allow | |
4830 others to quote your message without line wrapping. | |
4831 | |
4832 @cindex filling paragraphs | |
4833 @cindex paragraphs, filling | |
4834 @findex fill-paragraph | |
4835 @kindex M-q | |
4836 @vindex mh-ins-buf-prefix | |
4837 | |
4838 You'll often include messages that were sent from user agents that | |
4839 haven't yet realized that paragraphs consist of more than a single | |
4840 line. This makes for long lines that wrap in an ugly fashion. You'll | |
4841 find that @kbd{M-q} (@code{fill-paragraph}) works well even on these | |
4842 quoted messages, even if they are nested, just as long as all of the | |
4843 quotes match the value of @code{mh-ins-buf-prefix} (@pxref{Inserting | |
4844 Letter}). For example, let's assume you have the following in your | |
4845 draft: | |
4846 | |
4847 @smallexample | |
4848 @group | |
4849 > Hopefully this gives you an idea of what I'm currently doing. I'm \ | |
4850 not sure yet whether I'm completely satisfied with my setup, but \ | |
4851 it's worked okay for me so far. | |
4852 @end group | |
4853 @end smallexample | |
4854 | |
4855 Running @kbd{M-q} on this paragraph produces: | |
4856 | |
4857 @smallexample | |
4858 @group | |
4859 > Hopefully this gives you an idea of what I'm currently doing. I'm not | |
4860 > sure yet whether I'm completely satisfied with my setup, but it's | |
4861 > worked okay for me so far. | |
4862 @end group | |
4863 @end smallexample | |
4864 | |
4865 @findex mh-open-line | |
4866 @findex open-line | |
4867 @kindex C-c C-o | |
4868 @kindex C-o | |
4869 | |
4870 The command @kbd{C-c C-o} (@code{mh-open-line}) is similar to the | |
4871 command @kbd{C-o} (@code{open-line}) in that it inserts a newline | |
4872 after point. It differs in that it also inserts the right number of | |
4873 quoting characters and spaces so that the next line begins in the same | |
4874 column as it was. This is useful when breaking up paragraphs in | |
4875 replies. For example, if this command was used when point was after | |
4876 the first period in the paragraph above, the result would be this: | |
4877 | |
4878 @smallexample | |
4879 @group | |
4880 > Hopefully this gives you an idea of what I'm currently doing. | |
4881 | |
4882 > I'm not | |
4883 > sure yet whether I'm completely satisfied with my setup, but it's | |
4884 > worked okay for me so far. | |
4885 @end group | |
4886 @end smallexample | |
4887 | |
4888 @node Inserting Letter, Inserting Messages, Editing Message, Editing Drafts | |
4889 @section Inserting Letter to Which You're Replying | |
4890 | |
4891 @cindex inserting messages | |
4892 @cindex replying to messages | |
4893 @cindex yanking messages | |
4894 @findex mh-yank-cur-msg | |
4895 @kindex C-c C-y | |
4896 @vindex mh-ins-buf-prefix | |
4897 | |
4898 It is often useful to insert a snippet of text from a letter that | |
4899 someone mailed to provide some context for your reply. The command | |
4900 @kbd{C-c C-y} (@code{mh-yank-cur-msg}) does this by adding an | |
4901 attribution, yanking a portion of text from the message to which | |
4902 you're replying, and inserting @code{mh-ins-buf-prefix} (@samp{> }) | |
4903 before each line. | |
4904 | |
4905 @smallexample | |
4906 @group | |
4907 Michael W Thelen <thelenm@@stop.mail-abuse.org> wrote: | |
4908 | |
4909 > Hopefully this gives you an idea of what I'm currently doing. I'm not | |
4910 > sure yet whether I'm completely satisfied with my setup, but it's | |
4911 > worked okay for me so far. | |
4912 @end group | |
4913 @end smallexample | |
4914 | |
4915 @vindex mh-extract-from-attribution-verb | |
4916 | |
4917 The attribution consists of the sender's name and email address | |
4918 followed by the content of the option | |
4919 @code{mh-extract-from-attribution-verb}. This option can be set to | |
4920 @samp{wrote:}, @samp{a écrit:}, and @samp{schrieb:}. You can also use | |
4921 the @samp{Custom String} menu item to enter your own verb. | |
4922 | |
4923 @vindex mail-citation-hook | |
4924 @vindex mh-ins-buf-prefix | |
4925 @vindex mh-yank-behavior | |
4926 | |
4927 The prefix @code{"> "} is the default setting for the option | |
4928 @code{mh-ins-buf-prefix}. I suggest that you not modify this option | |
4929 since it is used by many mailers and news readers: messages are far | |
4930 easier to read if several included messages have all been indented by | |
4931 the same string. This prefix is not inserted if you use one of the | |
4932 supercite flavors of @code{mh-yank-behavior} or you have added a | |
4933 @code{mail-citation-hook} as described below. | |
4934 | |
4935 @vindex mh-delete-yanked-msg-window-flag | |
4936 | |
4937 You can also turn on the @code{mh-delete-yanked-msg-window-flag} | |
4938 option to delete the window containing the original message after | |
4939 yanking it to make more room on your screen for your reply. | |
4940 | |
4941 @cindex Emacs, packages, supercite | |
4942 @cindex supercite package | |
4943 @kindex r | |
4944 @vindex mail-citation-hook | |
4945 @vindex mh-yank-behavior | |
4946 | |
4947 You can control how the message to which you are replying is yanked | |
4948 into your reply using @code{mh-yank-behavior}. To include the entire | |
4949 message, including the entire header, use @samp{Body and | |
4950 Header}@footnote{If you'd rather have the header cleaned up, use | |
4951 @kbd{C-u r} instead of @kbd{r} when replying | |
4952 (@pxref{Replying}).}@footnote{In the past you would use this setting | |
4953 and set @code{mail-citation-hook} to @samp{supercite}, but this usage | |
4954 is now deprecated in favor of the @samp{Invoke supercite} setting.}. | |
4955 Use @samp{Body} to yank just the body without the header. To yank only | |
4956 the portion of the message following the point, set this option to | |
4957 @samp{Below Point}. | |
4958 | |
4959 Choose @samp{Invoke supercite}@footnote{@emph{Supercite} is a | |
4960 full-bodied, full-featured, citation package that comes standard with | |
4961 Emacs.} to pass the entire message and header through supercite. | |
4962 | |
4963 @vindex mh-extract-from-attribution-verb | |
4964 | |
4965 If the @samp{Body With Attribution} setting is used, then the message | |
4966 minus the header is yanked and a simple attribution line is added at | |
4967 the top using the value of the option | |
4968 @code{mh-extract-from-attribution-verb}. This is the default. | |
4969 | |
4970 @kindex C-c C-y | |
4971 @vindex mh-delete-yanked-msg-window-flag | |
4972 | |
4973 If the @samp{Invoke supercite} or @samp{Body With Attribution} | |
4974 settings are used, the @samp{-noformat} argument is passed to the | |
4975 @command{repl} program to override a @samp{-filter} or @samp{-format} | |
4976 argument. These settings also have @samp{Automatically} variants that | |
4977 perform the action automatically when you reply so that you don't need | |
4978 to use @kbd{C-c C-y} at all. Note that this automatic action is only | |
4979 performed if the show buffer matches the message being replied to. | |
4980 People who use the automatic variants tend to turn on the option | |
4981 @code{mh-delete-yanked-msg-window-flag} as well so that the show | |
4982 window is never displayed. | |
4983 | |
4984 @vindex mh-yank-behavior | |
4985 | |
4986 If the show buffer has a region, the option @code{mh-yank-behavior} is | |
4987 ignored unless its value is one of @samp{Attribution} variants in | |
4988 which case the attribution is added to the yanked region. | |
4989 | |
4990 @findex trivial-cite | |
4991 @vindex mail-citation-hook | |
4992 @vindex mh-ins-buf-prefix | |
4993 @vindex mh-yank-behavior | |
4994 | |
4995 If this isn't enough, you can gain full control over the appearance of | |
4996 the included text by setting @code{mail-citation-hook} to a function | |
4997 that modifies it. This hook is ignored if the option | |
4998 @code{mh-yank-behavior} is set to one of the supercite flavors. | |
4999 Otherwise, this option controls how much of the message is passed to | |
5000 the hook. The function can find the citation between point and mark | |
5001 and it should leave point and mark around the modified citation text | |
5002 for the next hook function. The standard prefix | |
5003 @code{mh-ins-buf-prefix} is not added if this hook is set. | |
5004 | |
5005 @cindex Emacs, packages, trivial-cite | |
5006 @cindex trivial-cite package | |
5007 @vindex mh-yank-behavior | |
5008 | |
5009 For example, if you use the hook function | |
5010 @uref{http://shasta.cs.uiuc.edu/~lrclause/tc.html, | |
5011 @code{trivial-cite}} (which is NOT part of Emacs), set | |
5012 @code{mh-yank-behavior} to @samp{Body and Header}. | |
5013 | |
5014 @node Inserting Messages, Signature, Inserting Letter, Editing Drafts | |
5015 @section Inserting Messages | |
5016 | |
5017 @cindex inserting messages | |
5018 @findex mh-insert-letter | |
5019 @findex mh-yank-behavior | |
5020 @kindex C-c C-i | |
5021 @vindex mh-ins-buf-prefix | |
5022 @vindex mh-invisible-header-fields-compiled | |
5023 @vindex mh-yank-behavior | |
5024 | |
5025 Messages can be inserted with @kbd{C-c C-i} (@code{mh-insert-letter}). | |
5026 This command prompts you for the folder and message number, which | |
5027 defaults to the current message in that folder. It then inserts the | |
5028 messages, indented by @code{mh-ins-buf-prefix} (@samp{> }) unless | |
5029 @code{mh-yank-behavior} is set to one of the supercite flavors in | |
5030 which case supercite is used to format the message. Certain | |
5031 undesirable header fields (see | |
5032 @code{mh-invisible-header-fields-compiled}) are removed before | |
5033 insertion. | |
5034 | |
5035 If given a prefix argument (like @kbd{C-u C-c C-i}), the header is | |
5036 left intact, the message is not indented, and @samp{> } is not | |
5037 inserted before each line. This command leaves the mark before the | |
5038 letter and point after it. | |
5039 | |
5040 @node Signature, Picture, Inserting Messages, Editing Drafts | |
5041 @section Inserting Your Signature | |
5042 | |
5043 @cindex signature | |
5044 @findex mh-insert-signature | |
5045 @kindex C-c C-s | |
5046 | |
5047 You can insert your signature at the current cursor location with the | |
5048 command @kbd{C-c C-s} (@code{mh-insert-signature}). | |
5049 | |
5050 @cindex files, @file{.signature} | |
5051 @cindex @file{.signature} | |
5052 @cindex vCard | |
5053 @vindex mh-signature-file-name | |
5054 | |
5055 By default, the text of your signature is taken from the file | |
5056 @file{~/.signature}. You can read from other sources by changing the | |
5057 option @code{mh-signature-file-name}. This file may contain a | |
5058 @dfn{vCard} in which case an attachment is added with the vCard. | |
5059 | |
5060 @findex mh-signature-separator-p | |
5061 @vindex mh-signature-file-name | |
5062 @vindex mh-signature-separator | |
5063 @vindex mh-signature-separator-regexp | |
5064 | |
5065 The option @code{mh-signature-file-name} may also be a symbol, in | |
5066 which case that function is called. You may not want a signature | |
5067 separator to be added for you; instead you may want to insert one | |
5068 yourself. Options that you may find useful to do this include | |
5069 @code{mh-signature-separator} (when inserting a signature separator) | |
5070 and @code{mh-signature-separator-regexp} (for finding said separator). | |
5071 The function @code{mh-signature-separator-p}, which reports @code{t} | |
5072 if the buffer contains a separator, may be useful as well. | |
5073 | |
5074 @cindex signature separator | |
5075 @vindex mh-signature-separator-flag | |
5076 | |
5077 A signature separator (@code{"-- "}) will be added if the signature | |
5078 block does not contain one and @code{mh-signature-separator-flag} is | |
5079 on. It is not recommended that you change this option since various | |
5080 mail user agents, including MH-E, use the separator to present the | |
5081 signature differently, and to suppress the signature when replying or | |
5082 yanking a letter into a draft. | |
5083 | |
5084 @vindex mh-insert-signature-hook | |
5085 @vindex mh-signature-file-name | |
5086 | |
5087 The hook @code{mh-insert-signature-hook} is run after the signature is | |
5088 inserted. Hook functions may access the actual name of the file or the | |
5089 function used to insert the signature with | |
5090 @code{mh-signature-file-name}. | |
5091 | |
5092 The signature can also be inserted using Identities. | |
5093 @xref{Identities}. | |
5094 | |
5095 @node Picture, Adding Attachments, Signature, Editing Drafts | |
5096 @section Inserting Your Picture | |
5097 | |
5098 @cindex @file{.face} | |
5099 @cindex files, @file{.face} | |
5100 @vindex mh-x-face-file | |
5101 | |
5102 You can insert your picture in the header of your mail message so that | |
5103 recipients see your face in the @samp{From:} header field if their | |
5104 mail user agent is sophisticated enough. In MH-E, this is done by | |
5105 placing your image in the file named by the option | |
5106 @code{mh-x-face-file} which is @file{~/.face} by default. | |
5107 | |
5108 @cindex @samp{Face:} header field | |
5109 @cindex @samp{X-Face:} header field | |
5110 @cindex @samp{X-Image-URL:} header field | |
5111 @cindex header field, @samp{Face:} | |
5112 @cindex header field, @samp{X-Face:} | |
5113 @cindex header field, @samp{X-Image-URL:} | |
5114 | |
5115 If the file starts with either of the strings @samp{X-Face:}, | |
5116 @samp{Face:} or @samp{X-Image-URL:} then the contents are added to the | |
5117 message header verbatim. Otherwise it is assumed that the file | |
5118 contains the value of the @samp{X-Face:} header field. | |
5119 | |
5120 @cindex @command{compface} | |
5121 @cindex Unix commands, @command{compface} | |
5122 | |
5123 The @samp{X-Face:} header field, which is a low-resolution, black and | |
5124 white image, can be generated using the | |
5125 @uref{ftp://ftp.cs.indiana.edu/pub/faces/compface/compface.tar.Z, | |
5126 @command{compface}} command. The @uref{http://www.dairiki.org/xface/, | |
5127 @cite{Online X-Face Converter}} is a useful resource for quick | |
5128 conversion of images into @samp{X-Face:} header fields. | |
5129 | |
5130 Use the @uref{http://quimby.gnus.org/circus/face/make-face, | |
5131 @command{make-face}} script to convert a JPEG image to the higher | |
5132 resolution, color, @samp{Face:} header field. | |
5133 | |
5134 The URL of any image can be used for the @samp{X-Image-URL:} field and | |
5135 no processing of the image is required. | |
5136 | |
5137 @vindex mh-x-face-file | |
5138 | |
5139 To prevent the setting of any of these header fields, either set | |
5140 @code{mh-x-face-file} to @code{nil}, or simply ensure that the file | |
5141 defined by this option doesn't exist. | |
5142 | |
5143 @xref{Viewing}, to see how these header fields are displayed in MH-E. | |
5144 | |
5145 @node Adding Attachments, Sending PGP, Picture, Editing Drafts | |
5146 @section Adding Attachments | |
5147 | |
5148 @cindex @command{mhbuild} | |
5149 @cindex @command{mhn} | |
5150 @cindex MH commands, @command{mhbuild} | |
5151 @cindex MH commands, @command{mhn} | |
5152 @cindex MIME | |
5153 @cindex multimedia mail | |
5154 | |
5155 MH-E has the capability to create multimedia messages. It uses the | |
5156 @sc{mime} (Multipurpose Internet Mail Extensions) | |
5157 protocol@footnote{@sc{mime} is defined in | |
5158 @uref{http://www.rfc-editor.org/rfc/rfc2045.txt, RFC 2045}.} The | |
5159 @sc{mime} protocol allows you to incorporate images, sound, video, | |
5160 binary files, and even commands that fetch a file with @samp{ftp} when | |
5161 your recipient reads the message! | |
5162 | |
5163 @kindex C-c C-m | |
5164 | |
5165 If you were to create a multimedia message with plain MH commands, you | |
5166 would insert @command{mhbuild} or @command{mhn} directives (henceforth | |
5167 called @dfn{MH-style directives} into your draft and use the | |
5168 @command{mhbuild} command in nmh or @command{mhn} command in MH and | |
5169 GNU mailutils to expand them. MH-E works in much the same way, | |
5170 although it provides a handful of commands prefixed with @kbd{C-c C-m} | |
5171 to insert the directives so you don't need to remember the syntax of | |
5172 them. Remember: you can always add MH-style directives by | |
5173 hand@footnote{See the section | |
5174 @uref{@value{MH-BOOK-HOME}/usimim.html#SeMIMa, Sending MIME Mail} in | |
5175 the MH book.}. | |
5176 | |
5177 @cindex MIME Meta Language (MML) | |
5178 @cindex MML | |
5179 @vindex mh-compose-insertion | |
5180 | |
5181 In addition to MH-style directives, MH-E also supports MML (@sc{mime} | |
5182 Meta Language) tags@footnote{ | |
5183 @ifinfo | |
5184 @c Although the third argument should default to the | |
5185 @c first, makeinfo goes to the wrong Info file without it being | |
5186 @c different--it seems to be getting our own Composing node. | |
5187 @xref{Composing,,Composing with MML,emacs-mime}. | |
5188 @end ifinfo | |
5189 @ifnotinfo | |
5190 See the section Composing in | |
5191 @uref{http://www.gnus.org/manual/emacs-mime.html, @cite{The Emacs MIME | |
5192 Manual}}. | |
5193 @end ifnotinfo | |
5194 }. The option @code{mh-compose-insertion} can be used to choose | |
5195 between them. By default, this option is set to @samp{MML} if it is | |
5196 supported since it provides a lot more functionality. This option can | |
5197 also be set to @samp{MH} if MH-style directives are preferred. | |
5198 | |
5199 @cindex media types | |
5200 @cindex MIME, media types | |
5201 | |
5202 The MH-E @sc{mime} commands require a @dfn{media type} for each body | |
5203 part or attachment. For example, a PDF document is of type | |
5204 @samp{application/pdf} and an HTML document is of type | |
5205 @samp{text/html}. Some commands fill in the media type for you, | |
5206 whereas others require you to enter one. | |
5207 | |
5208 @cindex @command{file} | |
5209 @cindex @file{/etc/mime.types} | |
5210 @cindex files, @file{/etc/mime.types} | |
5211 @cindex Unix commands, @command{file} | |
5212 @findex mailcap-mime-types | |
5213 | |
5214 In the cases where MH-E can do so, it will determine the media type | |
5215 automatically. It uses the @command{file} command to do this. Failing | |
5216 that, the Emacs function @code{mailcap-mime-types} is used to provide | |
5217 a list from which to choose. This function usually reads the file | |
5218 @file{/etc/mime.types}. | |
5219 | |
5220 Whether the media type is chosen automatically, or you choose it from | |
5221 a list, use the type that seems to match best the file that you are | |
5222 including. In the case of binaries, the media type | |
5223 @samp{application/x-executable} can be useful. If you can't find an | |
5224 appropriate media type, use @samp{text/plain} for text messages and | |
5225 @samp{application/octet-stream} for everything else. | |
5226 | |
5227 @cindex content description | |
5228 @cindex MIME, content description | |
5229 | |
5230 You are also sometimes asked for a @dfn{content description}. This is | |
5231 simply an optional brief phrase, in your own words, that describes the | |
5232 object. If you don't care to enter a content description, just press | |
5233 return and none will be included; however, a reader may skip over | |
5234 multimedia fields unless the content description is compelling. | |
5235 | |
5236 You can also create your own @sc{mime} body parts. In the following | |
5237 example, I describe how you can create and edit a @samp{text/enriched} | |
5238 body part to liven up your plain text messages with boldface, | |
5239 underlining, and italics. I include an Emacs function which inserts | |
5240 enriched text tags. | |
5241 | |
5242 @smalllisp | |
5243 @group | |
5244 (defvar enriched-text-types '(("b" . "bold") ("i" . "italic") | |
5245 ("u" . "underline") | |
5246 ("s" . "smaller") ("B" . "bigger") | |
5247 ("f" . "fixed") | |
5248 ("c" . "center")) | |
5249 "Alist of (final-character . tag) choices for add-enriched-text. | |
5250 Additional types can be found in RFC 1563.") | |
5251 | |
5252 (defun add-enriched-text (begin end) | |
5253 "Add enriched text tags around region. | |
5254 The tag used comes from the list enriched-text-types and is | |
5255 specified by the last keystroke of the command. When called from Lisp, | |
5256 arguments are BEGIN and END@." | |
5257 (interactive "r") | |
5258 ;; @r{Set type to the tag indicated by the last keystroke.} | |
5259 (let ((type (cdr (assoc (char-to-string (logior last-input-char ?@w{`})) | |
5260 enriched-text-types)))) | |
5261 (save-restriction ; @r{restores state from narrow-to-region} | |
5262 (narrow-to-region begin end) ; @r{narrow view to region} | |
5263 (goto-char (point-min)) ; @r{move to beginning of text} | |
5264 (insert "<" type ">") ; @r{insert beginning tag} | |
5265 (goto-char (point-max)) ; @r{move to end of text} | |
5266 (insert "</" type ">")))) ; @r{insert terminating tag} | |
5267 @i{Emacs function for entering enriched text} | |
5268 | |
5269 @end group | |
5270 @end smalllisp | |
5271 | |
5272 To use the function @code{add-enriched-text}, first add it to | |
5273 @file{~/.emacs} and create key bindings for it (@pxref{Composing}). | |
5274 | |
5275 Then, in your plain text message, set the mark with @kbd{C-@@} or | |
5276 @kbd{C-@key{SPC}}, type in the text to be highlighted, and type @kbd{C-c t | |
5277 b}. This adds @samp{<bold>} where you set the mark and adds | |
5278 @samp{</bold>} at the location of your cursor, giving you something | |
5279 like: @samp{You should be <bold>very</bold>}. | |
5280 | |
5281 Before sending this message, use @kbd{C-c C-m C-m} | |
5282 (@code{mh-mml-to-mime})@footnote{Use @kbd{C-c C-e} | |
5283 (@code{mh-mh-to-mime}) if you're using MH-style directives.} to add | |
5284 MIME header fields. Then replace @samp{text/plain} with | |
5285 @samp{text/enriched} in the @samp{Content-Type:} header field. | |
5286 | |
5287 You may also be interested in investigating @code{sgml-mode}. | |
5288 | |
5289 @subheading Including Files | |
5290 | |
5291 @cindex attachments, inserting | |
5292 @cindex images | |
5293 @cindex MIME, images | |
5294 @cindex MIME, sound | |
5295 @cindex MIME, video | |
5296 @cindex sound | |
5297 @cindex video | |
5298 @findex mh-compose-insertion | |
5299 @kindex C-c C-m C-i | |
5300 @kindex C-c C-m i | |
5301 @vindex mh-compose-insertion | |
5302 | |
5303 Binaries, images, sound, and video can be inserted in your message | |
5304 with the command @kbd{C-c C-m C-i} (@code{mh-compose-insertion}). You | |
5305 are prompted for the filename containing the object, the media type if | |
5306 it cannot be determined automatically, and a content description. If | |
5307 you're using MH-style directives, you will also be prompted for | |
5308 additional attributes. | |
5309 | |
5310 @subheading Forwarding Multimedia Messages | |
5311 | |
5312 @findex mh-compose-forward | |
5313 @kindex C-c C-m C-f | |
5314 @kindex C-c C-m f | |
5315 | |
5316 Mail may be forwarded with @sc{mime} using the command @kbd{C-c C-m | |
5317 C-f} (@code{mh-compose-forward}). You are prompted for a content | |
5318 description, the name of the folder in which the messages to forward | |
5319 are located, and a range of messages, which defaults to the current | |
5320 message in that folder. @xref{Ranges}. | |
5321 | |
5322 @subheading Including an FTP Reference | |
5323 | |
5324 @cindex @command{ftp} | |
5325 @cindex MIME, @command{ftp} | |
5326 @cindex Unix commands, @command{ftp} | |
5327 @findex mh-mh-compose-anon-ftp | |
5328 @kindex C-c C-m C-g | |
5329 @kindex C-c C-m g | |
5330 | |
5331 You can have your message initiate an @command{ftp} transfer when the | |
5332 recipient reads the message. To do this, use the command @kbd{C-c C-m | |
5333 C-g} (@code{mh-mh-compose-anon-ftp}). You are prompted for the remote | |
5334 host and filename, the media type, and the content description. | |
5335 | |
5336 @subheading Including tar Files | |
5337 | |
5338 @cindex @command{ftp} | |
5339 @cindex @command{tar} | |
5340 @cindex MIME, @command{ftp} | |
5341 @cindex MIME, @command{tar} | |
5342 @cindex Unix commands, @command{ftp} | |
5343 @cindex Unix commands, @command{tar} | |
5344 @findex mh-mh-compose-anon-ftp | |
5345 @findex mh-mh-compose-external-compressed-tar | |
5346 @kindex C-c C-m C-g | |
5347 @kindex C-c C-m C-t | |
5348 @kindex C-c C-m t | |
5349 | |
5350 If the remote file is a compressed tar file, you can use @kbd{C-c C-m | |
5351 C-t} (@code{mh-mh-compose-external-compressed-tar}). Then, in addition | |
5352 to retrieving the file via anonymous @emph{ftp} as per the command | |
5353 @kbd{C-c C-m C-g} (@code{mh-mh-compose-anon-ftp}), the file will also | |
5354 be uncompressed and untarred. You are prompted for the remote host and | |
5355 filename and the content description. | |
5356 | |
5357 @subheading Including Other External Files | |
5358 | |
5359 @findex mh-mh-compose-external-type | |
5360 @kindex C-c C-m C-x | |
5361 @kindex C-c C-m x | |
5362 | |
5363 The command @kbd{C-c C-m C-x} (@code{mh-mh-compose-external-type}) is | |
5364 a general utility for referencing external files. In fact, all of the | |
5365 other commands that insert tags to access external files call this | |
5366 command. You are prompted for the access type, remote host and | |
5367 filename, and content type. If you provide a prefix argument, you are | |
5368 also prompted for a content description, attributes, parameters, and a | |
5369 comment. | |
5370 | |
5371 @subheading Previewing Multimedia Messages | |
5372 | |
5373 When you are finished editing a @sc{mime} message, it might look like this: | |
5374 | |
5375 @cartouche | |
5376 @smallexample | |
5377 3 t08/24 root received fax files on Wed Aug 24 11:00: | |
5378 4+t08/24 To:wohler Test<<This is a test message to get the | |
5379 | |
5380 | |
5381 | |
5382 | |
5383 | |
5384 --:%% @{+inbox@} 4 msgs (1-4) Bot L4 (MH-Folder Show)--------------- | |
5385 To: wohler | |
5386 cc: | |
5387 Subject: Test of MIME | |
5388 -------- | |
5389 Here is the SETI@@Home logo: | |
5390 | |
5391 <#part type="image/x-xpm" filename="~/lib/images/setiathome.xpm" | |
5392 disposition=inline description="SETI@@home logo"> | |
5393 <#/part> | |
5394 --:** @{draft@} All L8 (MH-Letter)---------------------------------- | |
5395 | |
5396 @end smallexample | |
5397 @end cartouche | |
5398 @i{MH-E @sc{mime} draft} | |
5399 | |
5400 @findex mh-mml-to-mime | |
5401 @kindex C-c C-m C-m | |
5402 @kindex C-c C-m m | |
5403 | |
5404 Typically, you send a message with attachments just like any other | |
5405 message (@pxref{Sending Message}). | |
5406 | |
5407 @findex mh-mml-to-mime | |
5408 @kindex C-c C-m C-m | |
5409 | |
5410 However, you may take a sneak preview of the @sc{mime} encoding if you | |
5411 wish by running the command @kbd{C-c C-m C-m} (@code{mh-mml-to-mime}). | |
5412 The following screen shows the @sc{mime} encoding specified by the | |
5413 tags. You can see why mail user agents are usually built to hide these | |
5414 details from the user. | |
5415 | |
5416 @cartouche | |
5417 @smallexample | |
5418 To: wohler | |
5419 cc: | |
5420 Subject: Test of MIME | |
5421 X-Mailer: MH-E 8.0; nmh 1.1; GNU Emacs 22.1 | |
5422 MIME-Version: 1.0 | |
5423 Content-Type: multipart/mixed; boundary="=-=-=" | |
5424 -------- | |
5425 --=-=-= | |
5426 | |
5427 Here is the SETI@@Home logo: | |
5428 | |
5429 | |
5430 --=-=-= | |
5431 Content-Type: image/x-xpm | |
5432 Content-Disposition: inline; filename=setiathome.xpm | |
5433 Content-Transfer-Encoding: base64 | |
5434 Content-Description: SETI@@home logo | |
5435 | |
5436 LyogWFBNICovCnN0YXRpYyBjaGFyICogc2V0aWF0aG9tZV94cG1bXSA9IHsKIjQ1IDQ1IDc2N | |
5437 --:-- @{draft@} Top L1 (MH-Letter)---------------------------------- | |
5438 | |
5439 @end smallexample | |
5440 @end cartouche | |
5441 @i{MH-E @sc{mime} draft ready to send} | |
5442 | |
5443 @cindex undo effects of mh-mml-to-mime | |
5444 | |
5445 This action can be undone by running @kbd{C-_} (@code{undo}). | |
5446 | |
5447 @cindex @command{mhbuild} | |
5448 @cindex @command{mhn} | |
5449 @cindex MH commands, @command{mhbuild} | |
5450 @cindex MH commands, @command{mhn} | |
5451 @cindex undo effects of mh-mh-to-mime | |
5452 @findex mh-mh-to-mime | |
5453 @findex mh-mh-to-mime-undo | |
5454 @kindex C-c C-e | |
5455 @kindex C-c C-m C-m | |
5456 @kindex C-c C-m C-u | |
5457 @kindex C-c C-m u | |
5458 | |
5459 If you're using MH-style directives, use @kbd{C-c C-e} | |
5460 (@code{mh-mh-to-mime}) instead of @kbd{C-c C-m C-m}. This runs the | |
5461 command @command{mhbuild} (@command{mhn}) on the message which expands | |
5462 the tags@footnote{See the section | |
5463 @uref{@value{MH-BOOK-HOME}/usimim.html#SeMIMa, Sending MIME Mail} in | |
5464 the MH book.}. This action can be undone by running @kbd{C-c C-m C-u} | |
5465 (@code{mh-mh-to-mime-undo}), which works by reverting to a backup | |
5466 file. You are prompted to confirm this action, but you can avoid the | |
5467 confirmation by adding an argument (for example, @kbd{C-u C-c C-m | |
5468 C-u}). | |
5469 | |
5470 @kindex C-c C-e | |
5471 @vindex mh-mh-to-mime-args | |
5472 | |
5473 If you wish to pass additional arguments to @command{mhbuild} | |
5474 (@command{mhn}) to affect how it builds your message, use the option | |
5475 @code{mh-mh-to-mime-args}. For example, you can build a consistency | |
5476 check into the message by setting @code{mh-mh-to-mime-args} to | |
5477 @samp{-check}. The recipient of your message can then run | |
5478 @samp{mhbuild -check} on the message---@command{mhbuild} | |
5479 (@command{mhn}) will complain if the message has been corrupted on the | |
5480 way. The command @kbd{C-c C-e} only consults this option when given a | |
5481 prefix argument (as in @kbd{C-u C-c C-e}). | |
5482 | |
5483 @kindex C-c C-e | |
5484 @vindex mh-mh-to-mime-hook | |
5485 | |
5486 The hook @code{mh-mh-to-mime-hook} is called after the message has | |
5487 been formatted by @kbd{C-c C-e}. | |
5488 | |
5489 @node Sending PGP, Checking Recipients, Adding Attachments, Editing Drafts | |
5490 @section Signing and Encrypting Messages | |
5491 | |
5492 @cindex signing messages | |
5493 @cindex encrypting messages | |
5494 @cindex RFC 3156 | |
5495 | |
5496 MH-E can sign and encrypt messages as defined in | |
5497 @uref{http://www.rfc-editor.org/rfc/rfc3156.txt, RFC 3156}. If you | |
5498 should choose to sign or encrypt your message, use one of the | |
5499 following commands to do so any time before sending your message. | |
5500 | |
5501 @findex mh-mml-secure-message-encrypt | |
5502 @findex mh-mml-secure-message-sign | |
5503 @findex mh-mml-secure-message-signencrypt | |
5504 @kindex C-c C-m C-e | |
5505 @kindex C-c C-m C-s | |
5506 @kindex C-c C-m e e | |
5507 @kindex C-c C-m e s | |
5508 @kindex C-c C-m s e | |
5509 @kindex C-c C-m s s | |
5510 | |
5511 The command @kbd{C-c C-m C-s} (@code{mh-mml-secure-message-sign}) | |
5512 inserts the following tag: | |
5513 | |
5514 @smallexample | |
5515 <#secure method=pgpmime mode=sign> | |
5516 @end smallexample | |
5517 | |
5518 This is used to sign your message digitally. Likewise, the command | |
5519 @kbd{C-c C-m C-e} (@code{mh-mml-secure-message-encrypt}) inserts the | |
5520 following tag: | |
5521 | |
5522 @smallexample | |
5523 <#secure method=pgpmime mode=encrypt> | |
5524 @end smallexample | |
5525 | |
5526 This is used to encrypt your message. Finally, the command @kbd{C-c | |
5527 C-m s e} (@code{mh-mml-secure-message-signencrypt}) inserts the | |
5528 following tag: | |
5529 | |
5530 @smallexample | |
5531 <#secure method=pgpmime mode=signencrypt> | |
5532 @end smallexample | |
5533 | |
5534 @findex mh-mml-unsecure-message | |
5535 @kindex C-c C-m C-n | |
5536 @kindex C-c C-m n | |
5537 @vindex mh-mml-method-default | |
5538 | |
5539 This is used to sign and encrypt your message. In each of these cases, | |
5540 a proper multipart message is created for you when you send the | |
5541 message. Use the command @kbd{C-c C-m C-n} | |
5542 (@code{mh-mml-unsecure-message}) to remove these tags. Use a prefix | |
5543 argument (as in @kbd{C-u C-c C-m s e}) to be prompted for one of the | |
5544 possible security methods (see @code{mh-mml-method-default}). | |
5545 | |
5546 @vindex mh-mml-method-default | |
5547 | |
5548 The option @code{mh-mml-method-default} is used to select between a | |
5549 variety of mail security mechanisms. The default is @samp{PGP (MIME)} | |
5550 if it is supported; otherwise, the default is @samp{None}. Other | |
5551 mechanisms include vanilla @samp{PGP} and @samp{S/MIME}. | |
5552 | |
5553 @cindex @samp{pgg} customization group | |
5554 @cindex PGG | |
5555 @cindex customization group, @samp{pgg} | |
5556 | |
5557 The @samp{pgg} customization group may have some settings which may | |
5558 interest you. | |
5559 @iftex | |
5560 See @cite{The PGG Manual}. | |
5561 @end iftex | |
5562 @ifinfo | |
5563 @xref{Top, , The PGG Manual, pgg, The PGG Manual}. | |
5564 @end ifinfo | |
5565 @ifhtml | |
5566 See | |
5567 @uref{http://www.dk.xemacs.org/Documentation/packages/html/pgg.html, | |
5568 @cite{The PGG Manual}}. | |
5569 @end ifhtml | |
5570 | |
5571 @cindex header field, @samp{Fcc:} | |
5572 @cindex @samp{Fcc:} header field | |
5573 @vindex pgg-encrypt-for-me | |
5574 | |
5575 In particular, I turn on the option @code{pgg-encrypt-for-me} so that | |
5576 all messages I encrypt are encrypted with my public key as well. If | |
5577 you keep a copy of all of your outgoing mail with a @samp{Fcc:} header | |
5578 field, this setting is vital so that you can read the mail you write! | |
5579 | |
5580 @node Checking Recipients, Sending Message, Sending PGP, Editing Drafts | |
5581 @section Checking Recipients | |
5582 | |
5583 @cindex @samp{*MH-E Recipients*} | |
5584 @cindex @command{whom} | |
5585 @cindex MH commands, @command{whom} | |
5586 @cindex buffers, @samp{*MH-E Recipients*} | |
5587 @cindex checking recipients | |
5588 @cindex recipients, checking | |
5589 @findex mh-check-whom | |
5590 @kindex C-c C-w | |
5591 | |
5592 The command @kbd{C-c C-w} (@code{mh-check-whom}) expands aliases so | |
5593 you can check the actual address(es) in the alias. A new buffer named | |
5594 @samp{*MH-E Recipients*} is created with the output of @command{whom} | |
5595 (@pxref{Miscellaneous})@footnote{See the section | |
5596 @uref{@value{MH-BOOK-HOME}/senove.html#WhaPro, What now? -- and the | |
5597 whatnow Program} in the MH book.}. | |
5598 | |
5599 @node Sending Message, Killing Draft, Checking Recipients, Editing Drafts | |
5600 @section Sending a Message | |
5601 | |
5602 @cindex buffers, @samp{*MH-E Mail Delivery*} | |
5603 @cindex @samp{*MH-E Mail Delivery*} | |
5604 @cindex sending mail | |
5605 @findex mh-send-letter | |
5606 @kindex C-c C-c | |
5607 | |
5608 When you are all through editing a message, you send it with the | |
5609 command @kbd{C-c C-c} (@code{mh-send-letter}). You can give a prefix | |
5610 argument (as in @kbd{C-u C-c C-c}) to monitor the first stage of the | |
5611 delivery; this output can be found in a buffer called @samp{*MH-E Mail | |
5612 Delivery*} (@pxref{Miscellaneous}). | |
5613 | |
5614 @cindex sending mail | |
5615 @cindex spell check | |
5616 @findex ispell-message | |
5617 @kindex C-c C-c | |
5618 @vindex mh-before-send-letter-hook | |
5619 | |
5620 The hook @code{mh-before-send-letter-hook} is run at the beginning of | |
5621 the command @kbd{C-c C-c}. For example, if you want to check your | |
5622 spelling in your message before sending, add the function | |
5623 @code{ispell-message}. | |
5624 | |
5625 @cindex @command{send} | |
5626 @cindex MH commands, @command{send} | |
5627 @vindex mh-send-prog | |
5628 | |
5629 In case the MH @command{send} program@footnote{See the section | |
5630 @uref{@value{MH-BOOK-HOME}/sensen.html, Sending Some Mail: comp send} | |
5631 in the MH book.} is installed under a different name, use | |
5632 @code{mh-send-prog} to tell MH-E the name. | |
5633 | |
5634 @node Killing Draft, , Sending Message, Editing Drafts | |
5635 @section Killing the Draft | |
5636 | |
5637 @cindex killing draft | |
5638 @findex kill-buffer | |
5639 @findex mh-fully-kill-draft | |
5640 @kindex C-c C-q | |
5641 @kindex C-x k | |
5642 | |
5643 If for some reason you are not happy with the draft, you can use the | |
5644 command @kbd{C-c C-q} (@code{mh-fully-kill-draft}) to kill the draft | |
5645 buffer and delete the draft message. Use the command @kbd{C-x k} | |
5646 (@code{kill-buffer}) if you don't want to delete the draft message. | |
5647 | |
5648 @node Aliases, Identities, Editing Drafts, Top | |
5649 @chapter Aliases | |
5650 | |
5651 @cindex aliases | |
5652 | |
5653 MH aliases are used in the same way in MH-E as they are in MH. Any | |
5654 alias listed as a recipient will be expanded when the message is sent. | |
5655 This chapter discusses other things you can do with aliases in MH-E. | |
5656 | |
5657 @cindex MH-Letter mode | |
5658 @cindex modes, MH-Letter | |
5659 | |
5660 The following commands are available in MH-Letter mode with the | |
5661 exception of @code{mh-alias-reload} which can be called from anywhere. | |
5662 | |
5663 @table @kbd | |
5664 @kindex @key{SPC} | |
5665 @findex mh-letter-complete-or-space | |
5666 @item @key{SPC} | |
5667 Perform completion or insert space (@code{mh-letter-complete-or-space}). | |
5668 @c ------------------------- | |
5669 @kindex M-@key{TAB} | |
5670 @findex mh-letter-complete | |
5671 @item M-@key{TAB} | |
5672 Perform completion on header field or word preceding point | |
5673 (@code{mh-letter-complete}). | |
5674 @c ------------------------- | |
5675 @findex mh-alias-apropos | |
5676 @item mh-alias-apropos | |
5677 Show all aliases or addresses that match a regular expression. | |
5678 @c ------------------------- | |
5679 @findex mh-alias-grab-from-field | |
5680 @item mh-alias-grab-from-field | |
5681 Add alias for the sender of the current message | |
5682 @c ------------------------- | |
5683 @findex mh-alias-reload | |
5684 @item mh-alias-reload | |
5685 Reload MH aliases. | |
5686 @end table | |
5687 | |
5688 @cindex @samp{mh-alias} customization group | |
5689 @cindex customization group, @samp{mh-alias} | |
5690 | |
5691 The @samp{mh-alias} customization group contains options associated | |
5692 with aliases. | |
5693 | |
5694 @vtable @code | |
5695 @item mh-alias-completion-ignore-case-flag | |
5696 On means don't consider case significant in MH alias completion | |
5697 (default: @samp{on}). | |
5698 @c ------------------------- | |
5699 @item mh-alias-expand-aliases-flag | |
5700 On means to expand aliases entered in the minibuffer (default: | |
5701 @samp{off}). | |
5702 @c ------------------------- | |
5703 @item mh-alias-flash-on-comma | |
5704 Specify whether to flash address or warn on translation (default: @samp{Flash | |
5705 but Don't Warn If No Alias}). | |
5706 @c ------------------------- | |
5707 @item mh-alias-insert-file | |
5708 Filename used to store a new MH-E alias (default: @samp{Use Aliasfile | |
5709 Profile Component}). | |
5710 @c ------------------------- | |
5711 @item mh-alias-insertion-location | |
5712 Specifies where new aliases are entered in alias files (default: | |
5713 @samp{Alphabetical}). | |
5714 @c ------------------------- | |
5715 @item mh-alias-local-users | |
5716 If @samp{on}, local users are added to alias completion (default: | |
5717 @samp{on}). | |
5718 @c ------------------------- | |
5719 @item mh-alias-local-users-prefix | |
5720 String prefixed to the real names of users from the password file | |
5721 (default: @code{"local."}. | |
5722 @c ------------------------- | |
5723 @item mh-alias-passwd-gecos-comma-separator-flag | |
5724 On means the GECOS field in the password file uses a comma separator | |
5725 (default: @samp{on}). | |
5726 @end vtable | |
5727 | |
5728 The following hook is available. | |
5729 | |
5730 @vtable @code | |
5731 @item mh-alias-reloaded-hook | |
5732 Hook run by @code{mh-alias-reload} after loading aliases (default: | |
5733 @code{nil}). | |
5734 @end vtable | |
5735 | |
5736 @subheading Adding Addresses to Draft | |
5737 | |
5738 You can use aliases when you are adding recipients to a message. | |
5739 | |
5740 @findex minibuffer-complete | |
5741 @kindex @key{TAB} | |
5742 @vindex mh-alias-expand-aliases-flag | |
5743 @vindex mh-compose-prompt-flag | |
5744 | |
5745 In order to use minibuffer prompting for recipients and the subject | |
5746 line in the minibuffer, turn on the option | |
5747 @code{mh-compose-prompt-flag} (@pxref{Composing}), and use the | |
5748 @key{TAB} (@code{minibuffer-complete}) command to complete aliases | |
5749 (and optionally local logins) when prompted for the recipients. Turn | |
5750 on the option @code{mh-alias-expand-aliases-flag} if you want these | |
5751 aliases to be expanded to their respective addresses in the draft. | |
5752 | |
5753 @findex mh-letter-complete | |
5754 @findex mh-letter-complete-or-space | |
5755 @kindex @key{SPC} | |
5756 @kindex M-@key{TAB} | |
5757 | |
5758 Otherwise, you can complete aliases in the header of the draft with | |
5759 @kbd{M-@key{TAB}} (@code{mh-letter-complete}) or @key{SPC} | |
5760 (@code{mh-letter-complete-or-space}). | |
5761 | |
5762 @vindex mh-alias-completion-ignore-case-flag | |
5763 | |
5764 As MH ignores case in the aliases, so too does MH-E. However, you may | |
5765 turn off the option @code{mh-alias-completion-ignore-case-flag} to | |
5766 make case significant which can be used to segregate completion of | |
5767 your aliases. You might use uppercase for mailing lists and lowercase | |
5768 for people. For example, you might have: | |
5769 | |
5770 @smallexample | |
5771 mark.baushke: Mark Baushke <mdb@@stop.mail-abuse.org> | |
5772 MH-E: MH-E Mailing List <mh-e-devel@@stop.mail-abuse.org> | |
5773 @end smallexample | |
5774 | |
5775 When this option is turned off, if you were to type @kbd{M} in the | |
5776 @samp{To:} field and then @kbd{M-@key{TAB}}, then you'd get the list; | |
5777 if you started with @kbd{m} and then entered @kbd{M-@key{TAB}}, then | |
5778 you'd get Mark's address. Note that this option affects completion | |
5779 only. If you were to enter @kbd{Mark.Baushke}, it would still be | |
5780 identified with your @samp{mark.baushke} alias. | |
5781 | |
5782 @findex mh-alias-minibuffer-confirm-address | |
5783 @findex mh-letter-confirm-address | |
5784 @vindex mh-alias-flash-on-comma | |
5785 @vindex mh-compose-prompt-flag | |
5786 | |
5787 To verify that the alias you've entered is valid, the alias will be | |
5788 displayed in the minibuffer when you type a comma | |
5789 (@code{mh-letter-confirm-address} or | |
5790 @code{mh-alias-minibuffer-confirm-address} if the option | |
5791 @code{mh-compose-prompt-flag} is turned on). @xref{Composing}. This | |
5792 behavior can be controlled with the option | |
5793 @code{mh-alias-flash-on-comma} which provides three choices: | |
5794 @samp{Flash but Don't Warn If No Alias}, @samp{Flash and Warn If No | |
5795 Alias}, and @samp{Don't Flash Nor Warn If No Alias}. | |
5796 | |
5797 For another way to verify the alias expansion, see @ref{Checking | |
5798 Recipients}. | |
5799 | |
5800 @subheading Loading Aliases | |
5801 | |
5802 @cindex @command{ali} | |
5803 @cindex @file{/etc/nmh/MailAliases} | |
5804 @cindex @samp{Aliasfile:} MH profile component | |
5805 @cindex MH commands, @command{ali} | |
5806 @cindex MH profile component, @samp{Aliasfile:} | |
5807 @cindex files, @file{/etc/nmh/MailAliases} | |
5808 | |
5809 MH-E loads aliases for completion and folder name hints from various | |
5810 places. It uses the MH command @command{ali}@footnote{See the section | |
5811 @uref{@value{MH-BOOK-HOME}/mh.html, MH Aliases} in the MH book.} to | |
5812 read aliases from the files listed in the profile component | |
5813 @samp{Aliasfile:} as well as system-wide aliases (for example, | |
5814 @file{/etc/nmh/MailAliases}). | |
5815 | |
5816 @cindex @file{/etc/passwd} | |
5817 @cindex files, @file{/etc/passwd} | |
5818 | |
5819 In addition, aliases are created from @file{/etc/passwd} entries with | |
5820 a user ID larger than a magical number, typically 200. This can be a | |
5821 handy tool on a machine where you and co-workers exchange messages. | |
5822 These aliases have the form @samp{local.@var{first.last}} if a real | |
5823 name is present in the password file. Otherwise, the alias will have | |
5824 the form @samp{local.@var{login}}. | |
5825 | |
5826 @vindex mh-alias-local-users-prefix | |
5827 | |
5828 The prefix @samp{local.} can be modified via the option | |
5829 @code{mh-alias-local-users-prefix}. This option can also be set to | |
5830 @samp{Use Login}. | |
5831 | |
5832 For example, consider the following password file entry: | |
5833 | |
5834 @smallexample | |
5835 psg:x:1000:1000:Peter S Galbraith,,,:/home/psg:/bin/tcsh | |
5836 @end smallexample | |
5837 | |
5838 @vindex mh-alias-local-users-prefix | |
5839 | |
5840 The following settings of option @code{mh-alias-local-users-prefix} | |
5841 will produce the associated aliases: | |
5842 | |
5843 @table @code | |
5844 @item "local." | |
5845 local.peter.galbraith | |
5846 @c ------------------------- | |
5847 @item "" | |
5848 peter.galbraith | |
5849 @c ------------------------- | |
5850 @item Use Login | |
5851 psg | |
5852 @end table | |
5853 | |
5854 @vindex mh-alias-passwd-gecos-comma-separator-flag | |
5855 | |
5856 In the example above, commas are used to separate different values | |
5857 within the so-called GECOS field. This is a fairly common usage. | |
5858 However, in the rare case that the GECOS field in your password file | |
5859 is not separated by commas and whose contents may contain commas, you | |
5860 can turn the option @code{mh-alias-passwd-gecos-comma-separator-flag} | |
5861 off. | |
5862 | |
5863 @cindex NIS, obtaining local aliases from | |
5864 @cindex @samp{ypcat passwd} | |
5865 @vindex mh-alias-local-users | |
5866 | |
5867 If you're on a system with thousands of users you don't know, and the | |
5868 loading of local aliases slows MH-E down noticeably, then the local | |
5869 alias feature can be disabled by turning off the option | |
5870 @code{mh-alias-local-users}. This option also takes a string which is | |
5871 executed to generate the password file. For example, use @samp{ypcat | |
5872 passwd} to obtain the NIS password file. | |
5873 | |
5874 @findex mh-alias-reload | |
5875 @kindex M-x mh-alias-reload | |
5876 @vindex mh-alias-reloaded-hook | |
5877 | |
5878 Since aliases are updated frequently, MH-E reloads aliases | |
5879 automatically whenever an alias lookup occurs if an alias source has | |
5880 changed. However, you can reload your aliases manually by calling the | |
5881 command @kbd{M-x mh-alias-reload} directly. This command runs | |
5882 @code{mh-alias-reloaded-hook} after the aliases have been loaded. | |
5883 | |
5884 @subheading Adding Aliases | |
5885 | |
5886 In the past, you have manually added aliases to your alias file(s) | |
5887 listed in your @samp{Aliasfile:} profile component. MH-E provides | |
5888 other methods for maintaining your alias file(s). | |
5889 | |
5890 @findex mh-alias-add-alias | |
5891 @kindex M-x mh-alias-add-alias | |
5892 | |
5893 You can use the @kbd{M-x mh-alias-add-alias} command which will prompt | |
5894 you for the alias and address that you would like to add. If the alias | |
5895 exists already, you will have the choice of inserting the new alias | |
5896 before or after the old alias. In the former case, this alias will be | |
5897 used when sending mail to this alias. In the latter case, the alias | |
5898 serves as an additional folder name hint when filing messages | |
5899 (@pxref{Folder Selection}). | |
5900 | |
5901 Earlier, the alias prefix @samp{local} was presented. You can use | |
5902 other prefixes to organize your aliases or disambiguate entries. You | |
5903 might use prefixes for locales, jobs, or activities. For example, I | |
5904 have: | |
5905 | |
5906 @smallexample | |
5907 @group | |
5908 ; Work | |
5909 attensity.don.mitchell: Don Mitchell <dmitchell@@stop.mail-abuse.com> | |
5910 isharp.don.mitchell: Don Mitchell <donaldsmitchell@@stop.mail-abuse.com> | |
5911 ... | |
5912 ; Sport | |
5913 diving.ken.mayer: Ken Mayer <kmayer@@stop.mail-abuse.com> | |
5914 sailing.mike.maloney: Mike Maloney <mmaloney@@stop.mail-abuse.com> | |
5915 ... | |
5916 ; Personal | |
5917 ariane.kolkmann: Ariane Kolkmann <ArianeKolkmann@@stop.mail-abuse.com> | |
5918 ... | |
5919 @end group | |
5920 @end smallexample | |
5921 | |
5922 Using prefixes instead of postfixes helps you explore aliases during | |
5923 completion. If you forget the name of an old dive buddy, you can enter | |
5924 @samp{div} and then @key{SPC} to get a listing of all your dive buddies. | |
5925 | |
5926 @kindex M-x mh-alias-add-address-under-point | |
5927 @kindex M-x mh-alias-grab-from-field | |
5928 | |
5929 An alias for the sender of the current message is added automatically | |
5930 by clicking on the @samp{Grab From alias} tool bar button or by running | |
5931 the @kbd{M-x mh-alias-grab-from-field} command. Aliases for other | |
5932 recipients of the current message are added by placing your cursor | |
5933 over the desired recipient and giving the @kbd{M-x | |
5934 mh-alias-add-address-under-point} command. | |
5935 | |
5936 @vindex mh-alias-insert-file | |
5937 @vindex mh-alias-insertion-location | |
5938 | |
5939 The options @code{mh-alias-insert-file} and | |
5940 @code{mh-alias-insertion-location} controls how and where these aliases | |
5941 are inserted. | |
5942 | |
5943 @vindex mh-alias-insert-file | |
5944 | |
5945 The default setting of option @code{mh-alias-insert-file} is @samp{Use | |
5946 Aliasfile Profile Component}. This option can also hold the name of a | |
5947 file or a list a file names. If this option is set to a list of file | |
5948 names, or the @samp{Aliasfile:} profile component contains more than | |
5949 one file name, MH-E will prompt for one of them. | |
5950 | |
5951 @vindex mh-alias-insertion-location | |
5952 | |
5953 The option @code{mh-alias-insertion-location} is set to | |
5954 @samp{Alphabetical} by default. If you organize your alias file in | |
5955 other ways, then the settings @samp{Top} and @samp{Bottom} might be | |
5956 more appropriate. | |
5957 | |
5958 @subheading Querying Aliases | |
5959 | |
5960 @cindex regular expressions, @code{mh-alias-apropos} | |
5961 @findex mh-alias-apropos | |
5962 @kindex M-x mh-alias-apropos | |
5963 | |
5964 If you can't quite remember an alias, you can use @kbd{M-x | |
5965 mh-alias-apropos} to show all aliases or addresses that match a | |
5966 regular expression | |
5967 @ifnothtml | |
5968 (@pxref{Regexps, , Syntax of Regular Expressions, emacs, The | |
5969 GNU Emacs Manual}). | |
5970 @end ifnothtml | |
5971 @ifhtml | |
5972 (see the section | |
5973 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html, | |
5974 Syntax of Regular Expressions} in | |
5975 @cite{The GNU Emacs Manual}). | |
5976 @end ifhtml | |
5977 | |
5978 @node Identities, Speedbar, Aliases, Top | |
5979 @chapter Identities | |
5980 | |
5981 @cindex identities | |
5982 @cindex multiple personalities | |
5983 | |
5984 MH-E supports the concept of multiple personalities or identities. | |
5985 This means that you can easily have a different header and signature | |
5986 at home and at work. | |
5987 | |
5988 @cindex @samp{Identity} menu | |
5989 @cindex menu, @samp{Identity} | |
5990 | |
5991 A couple of commands are used to insert identities in MH-Letter mode | |
5992 which are also found in the @samp{Identity} menu. | |
5993 | |
5994 @table @kbd | |
5995 @kindex C-c C-d | |
5996 @findex mh-insert-identity | |
5997 @item C-c C-d | |
5998 Insert fields specified by given identity (@code{mh-insert-identity}). | |
5999 @c ------------------------- | |
6000 @cindex @samp{Identity > Insert Auto Fields} menu item | |
6001 @cindex menu item, @samp{Identity > Insert Auto Fields} | |
6002 @kindex C-c M-d | |
6003 @findex mh-insert-auto-fields | |
6004 @item C-c M-d | |
6005 Insert custom fields if recipient found in @code{mh-auto-fields-list} | |
6006 (@code{mh-insert-auto-fields}). | |
6007 @end table | |
6008 | |
6009 @cindex @samp{mh-identity} customization group | |
6010 @cindex customization group, @samp{mh-identity} | |
6011 | |
6012 The @samp{mh-identity} customization group contains the following | |
6013 options. | |
6014 | |
6015 @vtable @code | |
6016 @item mh-auto-fields-list | |
6017 List of recipients for which header lines are automatically inserted | |
6018 (default: @code{nil}). | |
6019 @c ------------------------- | |
6020 @item mh-auto-fields-prompt-flag | |
6021 On means to prompt before sending if fields inserted (default: | |
6022 @samp{on}) | |
6023 @c ------------------------- | |
6024 @item mh-identity-default | |
6025 Default identity to use when @code{mh-letter-mode} is called (default: | |
6026 @samp{None}). | |
6027 @c ------------------------- | |
6028 @item mh-identity-handlers | |
6029 Handler functions for fields in @code{mh-identity-list}. | |
6030 @c ------------------------- | |
6031 @item mh-identity-list | |
6032 List of identities (default: @code{nil}). | |
6033 @end vtable | |
6034 | |
6035 Some of the common header fields that people change depending on the | |
6036 context are the @samp{From:} and @samp{Organization:} fields, as well | |
6037 as the signature. | |
6038 | |
6039 @vindex mh-identity-list | |
6040 | |
6041 This is done by customizing the option @code{mh-identity-list}. In the | |
6042 customization buffer for this option, click on the @samp{INS} button | |
6043 and enter a label such as @samp{Home} or @samp{Work}. Then click on | |
6044 the @samp{INS} button with the label @samp{Add at least one item | |
6045 below}. The @samp{Value Menu} has the following menu items: | |
6046 | |
6047 @table @samp | |
6048 @cindex header field, @samp{From:} | |
6049 @cindex @samp{From:} header field | |
6050 @item From Field | |
6051 Specify an alternate @samp{From:} header field. You must include a | |
6052 valid email address. A standard format is @samp{First Last | |
6053 <login@@host.domain>}. If you use an initial with a period, then you | |
6054 must quote your name as in @samp{"First I. Last" | |
6055 <login@@host.domain>}. | |
6056 @c ------------------------- | |
6057 @cindex header field, @samp{Organization:} | |
6058 @cindex @samp{Organization:} header field | |
6059 @item Organization Field | |
6060 People usually list the name of the company where they work here. | |
6061 @c ------------------------- | |
6062 @item Other Field | |
6063 Set any arbitrary header field and value here. Unless the header field | |
6064 is a standard one, precede the name of your field's label with | |
6065 @samp{X-}, as in @samp{X-Fruit-of-the-Day:}. | |
6066 @c ------------------------- | |
6067 @item Attribution Verb | |
6068 This value overrides the setting of | |
6069 @code{mh-extract-from-attribution-verb}. @xref{Inserting Letter}. | |
6070 @c ------------------------- | |
6071 @cindex signature | |
6072 @vindex mh-signature-file-name | |
6073 @item Signature | |
6074 Set your signature with this item. You can specify the contents of | |
6075 @code{mh-signature-file-name}, a file, or a function. | |
6076 @xref{Signature}. | |
6077 @c ------------------------- | |
6078 @item GPG Key ID | |
6079 Specify a different key to sign or encrypt messages. | |
6080 @end table | |
6081 | |
6082 @cindex Identity menu | |
6083 @cindex menu, Identity | |
6084 @findex mh-insert-identity | |
6085 @kindex C-c C-d | |
6086 | |
6087 You can select the identities you have added via the menu called | |
6088 @samp{Identity} in the MH-Letter buffer. You can also use @kbd{C-c | |
6089 C-d} (@code{mh-insert-identity}). To clear the fields and signature | |
6090 added by the identity, select the @samp{None} identity. | |
6091 | |
6092 @cindex menu item, @samp{Identity > Customize Identities} | |
6093 @cindex menu item, @samp{Identity > Save as Default} | |
6094 @cindex menu item, @samp{Identity > Set Default for Session} | |
6095 @cindex @samp{Identity > Customize Identities} menu item | |
6096 @cindex @samp{Identity > Save as Default} menu item | |
6097 @cindex @samp{Identity > Set Default for Session} menu item | |
6098 @vindex mh-identity-default | |
6099 | |
6100 The @samp{Identity} menu contains two other items to save you from | |
6101 having to set the identity on every message. The menu item @samp{Set | |
6102 Default for Session} can be used to set the default identity to the | |
6103 current identity until you exit Emacs. The menu item @samp{Save as | |
6104 Default} sets the option @code{mh-identity-default} to the current | |
6105 identity setting. You can also customize the option | |
6106 @code{mh-identity-default} in the usual fashion. If you find that you | |
6107 need to add another identity, the menu item @samp{Customize | |
6108 Identities} is available for your convenience. | |
6109 | |
6110 @cindex regular expressions, @code{mh-auto-fields-list} | |
6111 @vindex mh-auto-fields-list | |
6112 | |
6113 The option @code{mh-auto-fields-list} can also be used to set the | |
6114 identity depending on the recipient to provide even more control. To | |
6115 customize @code{mh-auto-fields-list}, click on the @samp{INS} button | |
6116 and enter a regular expression for the recipient's address | |
6117 @ifnothtml | |
6118 (@pxref{Regexps, , Syntax of Regular Expressions, emacs, The | |
6119 GNU Emacs Manual}). | |
6120 @end ifnothtml | |
6121 @ifhtml | |
6122 (see the section | |
6123 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html, | |
6124 Syntax of Regular Expressions} in | |
6125 @cite{The GNU Emacs Manual}). | |
6126 @end ifhtml | |
6127 Click on the @samp{INS} button with the @samp{Add at least one item | |
6128 below} label. The @samp{Value Menu} contains the following menu items: | |
6129 | |
6130 @table @samp | |
6131 @item Identity | |
6132 Select an identity from those configured in @code{mh-identity-list}. | |
6133 All of the information for that identity will be added if the | |
6134 recipient matches. | |
6135 @c ------------------------- | |
6136 @cindex @samp{Fcc:} header field | |
6137 @cindex header field, @samp{Fcc:} | |
6138 @item Fcc Field | |
6139 Insert an @samp{Fcc:} header field with the folder you provide. When | |
6140 you send the message, MH will put a copy of your message in this | |
6141 folder. | |
6142 @c ------------------------- | |
6143 @cindex @samp{Mail-Followup-To:} header field | |
6144 @cindex header field, @samp{Mail-Followup-To:} | |
6145 @item Mail-Followup-To Field | |
6146 Insert an @samp{Mail-Followup-To:} header field with the recipients | |
6147 you provide. If the recipient's mail user agent supports this header | |
6148 field@footnote{@samp{Mail-Followup-To:} is supported by nmh.}, then | |
6149 their replies will go to the addresses listed. This is useful if their | |
6150 replies go both to the list and to you and you don't have a mechanism | |
6151 to suppress duplicates. If you reply to someone not on the list, you | |
6152 must either remove the @samp{Mail-Followup-To:} field, or ensure the | |
6153 recipient is also listed there so that he receives replies to your | |
6154 reply. | |
6155 @c ------------------------- | |
6156 @item Other Field | |
6157 Other header fields may be added using this menu item. | |
6158 @end table | |
6159 | |
6160 @findex mh-insert-auto-fields | |
6161 @kindex C-c M-d | |
6162 @vindex mh-auto-fields-prompt-flag | |
6163 | |
6164 These fields can only be added after the recipient is known. Because | |
6165 you can continue to add recipients as you edit the draft, MH-E waits | |
6166 until the message is sent to perform the auto-insertions. This seems | |
6167 strange at first, but you'll get used to it. There are two ways to | |
6168 help you feel that the desired fields are added. The first is the | |
6169 action when the message is sent: if any fields are added | |
6170 automatically, you are given a chance to see and to confirm these | |
6171 fields before the message is actually sent. You can do away with this | |
6172 confirmation by turning off the option | |
6173 @code{mh-auto-fields-prompt-flag}. The second method is manual: once | |
6174 the header contains one or more recipients, you may run the command | |
6175 @kbd{C-c M-d} (@code{mh-insert-auto-fields}) or choose the | |
6176 @samp{Identity -> Insert Auto Fields} menu item to insert these fields | |
6177 manually. However, if you use this command, the automatic insertion | |
6178 when the message is sent is disabled. | |
6179 | |
6180 @vindex mh-auto-fields-list | |
6181 @vindex mh-identity-list | |
6182 | |
6183 You should avoid using the same header field in | |
6184 @code{mh-auto-fields-list} and @code{mh-identity-list} definitions | |
6185 that may apply to the same message as the result is undefined. | |
6186 | |
6187 @vindex mh-identity-handlers | |
6188 @vindex mh-identity-list | |
6189 | |
6190 The option @code{mh-identity-handlers} is used to change the way that | |
6191 fields, signatures, and attributions in @code{mh-identity-list} are | |
6192 added. To customize @code{mh-identity-handlers}, replace the name of | |
6193 an existing handler function associated with the field you want to | |
6194 change with the name of a function you have written. You can also | |
6195 click on an @samp{INS} button and insert a field of your choice and | |
6196 the name of the function you have written to handle it. | |
6197 | |
6198 @vindex mh-identity-list | |
6199 | |
6200 The @samp{Field} field can be any field that you've used in your | |
6201 @code{mh-identity-list}. The special fields @samp{:attribution-verb}, | |
6202 @samp{:signature}, or @samp{:pgg-default-user-id} are used for the | |
6203 @code{mh-identity-list} choices @samp{Attribution Verb}, | |
6204 @samp{Signature}, and @samp{GPG Key ID} respectively. | |
6205 | |
6206 The handler associated with the @samp{:default} field is used when no | |
6207 other field matches. | |
6208 | |
6209 The handler functions are passed two or three arguments: the field | |
6210 itself (for example, @samp{From}), or one of the special fields (for | |
6211 example, @samp{:signature}), and the action @samp{'remove} or | |
6212 @samp{'add}. If the action is @samp{'add}, an additional argument | |
6213 containing the value for the field is given. | |
6214 | |
6215 @node Speedbar, Menu Bar, Identities, Top | |
6216 @chapter The Speedbar | |
6217 | |
6218 @cindex folder navigation | |
6219 @cindex speedbar | |
6220 @findex mh-visit-folder | |
6221 @kindex F v | |
6222 @kindex M-x speedbar | |
6223 @kindex Mouse-2 | |
6224 | |
6225 You can also use the speedbar | |
6226 @ifnothtml | |
6227 (@pxref{Speedbar, , Speedbar Frames, emacs, The GNU Emacs Manual},) | |
6228 @end ifnothtml | |
6229 @ifhtml | |
6230 (see the section | |
6231 @uref{http://www.gnu.org/software/emacs/manual/html_node/Speedbar.html, | |
6232 Speedbar Frames} in @cite{The GNU Emacs Manual}) | |
6233 @end ifhtml | |
6234 to view your folders. To bring up the speedbar, run @kbd{M-x speedbar | |
6235 @key{RET}}. You will see a new frame appear with all of your MH | |
6236 folders. Folders with unseen messages appear in boldface. Click on a | |
6237 folder name with @kbd{Mouse-2} to visit that folder in a similar | |
6238 fashion to the command @kbd{F v} (@code{mh-visit-folder}) | |
6239 (@pxref{Folders}). Click on the @samp{+} icon to expand and view the | |
6240 sub-folders of that folder. | |
6241 | |
6242 The speedbar can be manipulated with the keyboard as well. Use the | |
6243 Emacs navigational keys (like the arrow keys, or @kbd{C-n}) to move | |
6244 the cursor over the desired folder and then use the shortcuts for the | |
6245 menu items listed in the table below. | |
6246 | |
6247 @table @samp | |
6248 @findex mh-speed-view | |
6249 @item Visit Folder (@key{RET}) | |
6250 Visits the selected folder just as if you had used @kbd{F v} | |
6251 (@code{mh-speed-view}). | |
6252 @c ------------------------- | |
6253 @findex mh-speed-expand-folder | |
6254 @item Expand Nested Folders (@kbd{+}) | |
6255 Expands the selected folder in the speedbar, exposing the children | |
6256 folders inside it (@code{mh-speed-expand-folder}). | |
6257 @c ------------------------- | |
6258 @findex mh-speed-contract-folder | |
6259 @item Contract Nested Folders (@kbd{-}) | |
6260 Contracts or collapses the selected folder in the speedbar, hiding the | |
6261 children folders inside it (@code{mh-speed-contract-folder}). | |
6262 @c ------------------------- | |
6263 @findex mh-speed-refresh | |
6264 @item Refresh Speedbar (@kbd{r}) | |
6265 Regenerates the list of folders in the speedbar. Run this command if | |
6266 you've added or deleted a folder, or want to update the unseen message | |
6267 count before the next automatic update (@code{mh-speed-refresh}). | |
6268 @end table | |
6269 | |
6270 @findex delete-frame | |
6271 @kindex C-x 5 0 | |
6272 @kindex Mouse-3 | |
6273 | |
6274 You can click on @kbd{Mouse-3} to bring up a context menu that | |
6275 contains these items. Dismiss the speedbar with @kbd{C-x 5 0} | |
6276 (@code{delete-frame}). | |
6277 | |
6278 @cindex @command{flists} | |
6279 @cindex MH commands, @command{flists} | |
6280 @cindex @samp{mh-speedbar} customization group | |
6281 @cindex customization group, @samp{mh-speedbar} | |
6282 | |
6283 The MH-E speedbar uses the MH command @command{flists}@footnote{See | |
6284 the section @uref{@value{MH-BOOK-HOME}/morseq.html#flist, Searching for | |
6285 Sequences with flist} in the MH book.} to generate the list of | |
6286 folders. The @samp{mh-speedbar} customization group contains the | |
6287 following option which controls how often the speedbar calls | |
6288 @command{flists}. | |
6289 | |
6290 @vtable @code | |
6291 @item mh-speed-update-interval | |
6292 Time between speedbar updates in seconds (default: 60). Set to 0 to | |
6293 disable automatic update. | |
6294 @end vtable | |
6295 | |
6296 You can modify the appearance of the folders in the speedbar by | |
6297 customizing the following faces. | |
6298 | |
6299 @vtable @code | |
6300 @item mh-speedbar-folder | |
6301 Basic folder face. | |
6302 @c ------------------------- | |
6303 @item mh-speedbar-folder-with-unseen-messages | |
6304 Folder face when folder contains unread messages. | |
6305 @c ------------------------- | |
6306 @item mh-speedbar-selected-folder | |
6307 Selected folder face. | |
6308 @c ------------------------- | |
6309 @item mh-speedbar-selected-folder-with-unseen-messages | |
6310 Selected folder face when folder contains unread messages. | |
6311 @end vtable | |
6312 | |
6313 @node Menu Bar, Tool Bar, Speedbar, Top | |
6314 @chapter The Menu Bar | |
6315 | |
6316 @cindex @samp{Folder} menu | |
6317 @cindex @samp{Identity} menu | |
6318 @cindex @samp{Letter} menu | |
6319 @cindex @samp{Message} menu | |
6320 @cindex @samp{Search} menu | |
6321 @cindex @samp{Sequence} menu | |
6322 @cindex Folder menu | |
6323 @cindex Identity menu | |
6324 @cindex Letter menu | |
6325 @cindex MH-Folder mode | |
6326 @cindex MH-Letter mode | |
6327 @cindex MH-Search mode | |
6328 @cindex Message menu | |
6329 @cindex Search menu | |
6330 @cindex Sequence menu | |
6331 @cindex menu bar | |
6332 @cindex menu, Folder | |
6333 @cindex menu, Identity | |
6334 @cindex menu, Letter | |
6335 @cindex menu, Message | |
6336 @cindex menu, Search | |
6337 @cindex menu, Sequence | |
6338 @cindex menu, @samp{Folder} | |
6339 @cindex menu, @samp{Identity} | |
6340 @cindex menu, @samp{Letter} | |
6341 @cindex menu, @samp{Message} | |
6342 @cindex menu, @samp{Search} | |
6343 @cindex menu, @samp{Sequence} | |
6344 @cindex modes, MH-Folder | |
6345 @cindex modes, MH-Letter | |
6346 @cindex modes, MH-Search | |
6347 | |
6348 For those of you who prefer to mouse and menu instead of using the | |
6349 meta-coke-bottle-bucky keys, MH-E provides menu items for most of its | |
6350 functions. The MH-Folder buffer adds the @samp{Folder}, | |
6351 @samp{Message}, and @samp{Sequence} menus. The MH-Letter buffer adds | |
6352 the @samp{Identity} and @samp{Letter} menus. The MH-Search buffer adds | |
6353 the @samp{Search} menu. There's no need to list the actual items here, | |
6354 as you can more easily see them for yourself, and the functions are | |
6355 already described elsewhere in this manual. | |
6356 | |
6357 For a description of the menu bar, please | |
6358 @ifnothtml | |
6359 @xref{Menu Bar, , The Menu Bar, emacs, The GNU Emacs Manual}. | |
6360 @end ifnothtml | |
6361 @ifhtml | |
6362 see the section | |
6363 @uref{http://www.gnu.org/software/emacs/manual/html_node/Menu-Bar.html, | |
6364 The Menu Bar} in @cite{The GNU Emacs Manual}. | |
6365 @end ifhtml | |
6366 | |
6367 The Emacs manual describes how to get online help for a particular | |
6368 menu item. You can also look up a menu item in the index of this | |
6369 manual in two ways: all of the menu items are listed alphabetically, | |
6370 and you can also browse all of the items under the index entry | |
6371 @samp{menu item}. | |
6372 | |
6373 @node Tool Bar, Searching, Menu Bar, Top | |
6374 @chapter The Tool Bar | |
6375 | |
6376 @cindex tool bar | |
6377 | |
6378 Emacs also provides a graphical tool bar. For a description of the | |
6379 tool bar, please | |
6380 @ifnothtml | |
6381 @xref{Tool Bars, , Tool Bars, emacs, The GNU Emacs Manual}. | |
6382 @end ifnothtml | |
6383 @ifhtml | |
6384 see the section | |
6385 @uref{http://www.gnu.org/software/emacs/manual/html_node/Tool-Bars.html, | |
6386 Tool Bars} in @cite{The GNU Emacs Manual}. | |
6387 @end ifhtml | |
6388 | |
6389 @cindex @samp{mh-tool-bar} customization group | |
6390 @cindex customization group, @samp{mh-tool-bar} | |
6391 | |
6392 MH-E adds several icons to this tool bar; you can modify the MH-E | |
6393 aspects of the tool bar via the @samp{mh-tool-bar} customization group. | |
6394 | |
6395 @vtable @code | |
6396 @item mh-tool-bar-folder-buttons | |
6397 List of buttons to include in MH-Folder tool bar (default: a checklist | |
6398 too long to list here). | |
6399 @c ------------------------- | |
6400 @item mh-tool-bar-letter-buttons | |
6401 List of buttons to include in MH-Letter tool bar (default: a checklist | |
6402 too long to list here). | |
6403 @c ------------------------- | |
6404 @item mh-tool-bar-search-function | |
6405 Function called by the tool bar search button (default: | |
6406 @code{mh-search}). | |
6407 @c ------------------------- | |
6408 @item mh-xemacs-tool-bar-position | |
6409 Tool bar location (default: @samp{Same As Default Tool Bar}). | |
6410 @c ------------------------- | |
6411 @item mh-xemacs-use-tool-bar-flag | |
6412 If @samp{on}, use tool bar (default: @samp{on}, if supported). | |
6413 @end vtable | |
6414 | |
6415 In GNU Emacs, icons for some of MH-E's functions are added to the tool | |
6416 bar. In XEmacs, you have the opportunity to create a separate tool bar for | |
6417 the MH-E icons. | |
6418 | |
6419 @vindex mh-tool-bar-folder-buttons | |
6420 @vindex mh-tool-bar-letter-buttons | |
6421 | |
6422 In either case, you can select which of these functions you'd like to | |
6423 see by customizing the options @code{mh-tool-bar-folder-buttons} and | |
6424 @code{mh-tool-bar-letter-buttons}. As you probably guessed, the former | |
6425 customizes the tool bar in MH-Folder mode and the latter in MH-Letter | |
6426 mode. Both of these options present you with a list of functions; | |
6427 check the functions whose icons you want to see and clear the check | |
6428 boxes for those you don't. | |
6429 | |
6430 @findex mh-search | |
6431 @vindex mh-tool-bar-search-function | |
6432 | |
6433 The function associated with the searching icon can be set via the | |
6434 option @code{mh-tool-bar-search-function}. By default, this is set to | |
6435 @code{mh-search}. @xref{Searching}. You can also choose @samp{Other | |
6436 Function} from the @samp{Value Menu} and enter a function of your own | |
6437 choosing. | |
6438 | |
6439 @vindex mh-xemacs-use-tool-bar-flag | |
6440 | |
6441 XEmacs provides a couple of extra options. The first, | |
6442 @code{mh-xemacs-use-tool-bar-flag}, controls whether to show the MH-E | |
6443 icons at all. By default, this option is turned on if the window | |
6444 system supports tool bars. If your system doesn't support tool bars, | |
6445 then you won't be able to turn on this option. | |
6446 | |
6447 @vindex mh-xemacs-tool-bar-position | |
6448 | |
6449 The second extra option is @code{mh-xemacs-tool-bar-position} which | |
6450 controls the placement of the tool bar along the four edges of the | |
6451 frame. You can choose from one of @samp{Same As Default Tool Bar}, | |
6452 @samp{Top}, @samp{Bottom}, @samp{Left}, or @samp{Right}. If this | |
6453 variable is set to anything other than @samp{Same As Default Tool Bar} | |
6454 and the default tool bar is in a different location, then two tool | |
6455 bars will be displayed: the MH-E tool bar and the default tool bar. | |
6456 | |
6457 @node Searching, Threading, Tool Bar, Top | |
6458 @chapter Searching Through Messages | |
6459 | |
6460 @cindex @samp{Search} menu | |
6461 @cindex menu, @samp{Search} | |
6462 @cindex searching | |
6463 @findex mh-search | |
6464 @kindex F s | |
6465 | |
6466 Earlier, the command @kbd{F s} (@code{mh-search}) was introduced which | |
6467 helps you find messages that lie buried in your folders | |
6468 (@pxref{Folders}). This chapter covers this command in more detail. | |
6469 Several commands are used to compose the search criteria and to start | |
6470 searching. A couple of them can be found in the @samp{Search} menu. | |
6471 | |
6472 @table @kbd | |
6473 @kindex C-c ? | |
6474 @findex mh-help | |
6475 @item C-c ? | |
6476 Display cheat sheet for the MH-E commands (@code{mh-help}). | |
6477 @c ------------------------- | |
6478 @cindex @samp{Search > Perform Search} menu item | |
6479 @cindex menu item, @samp{Search > Perform Search} | |
6480 @kindex C-c C-c | |
6481 @findex mh-index-do-search | |
6482 @item C-c C-c | |
6483 Find messages using @code{mh-search-program} | |
6484 (@code{mh-index-do-search}). | |
6485 @c ------------------------- | |
6486 @cindex @samp{Search > Search with pick} menu item | |
6487 @cindex menu item, @samp{Search > Search with pick} | |
6488 @kindex C-c C-p | |
6489 @findex mh-pick-do-search | |
6490 @item C-c C-p | |
6491 Find messages using @command{pick} (@code{mh-pick-do-search}). | |
6492 @c ------------------------- | |
6493 @kindex C-c ? | |
6494 @findex mh-help | |
6495 @item C-c ? | |
6496 Display cheat sheet for the MH-E commands (@code{mh-help}). | |
6497 @c ------------------------- | |
6498 @kindex C-c C-f C-a | |
6499 @kindex C-c C-f a | |
6500 @findex mh-to-field | |
6501 @item C-c C-f a | |
6502 @itemx C-c C-f C-a | |
6503 Move to @samp{Mail-Reply-To:} header field (@code{mh-to-field}). | |
6504 @c ------------------------- | |
6505 @kindex C-c C-f C-b | |
6506 @kindex C-c C-f b | |
6507 @item C-c C-f b | |
6508 @itemx C-c C-f C-b | |
6509 Move to @samp{Bcc:} header field (@code{mh-to-field}). | |
6510 @c ------------------------- | |
6511 @kindex C-c C-f C-c | |
6512 @kindex C-c C-f c | |
6513 @item C-c C-f c | |
6514 @itemx C-c C-f C-c | |
6515 Move to @samp{Cc:} header field (@code{mh-to-field}). | |
6516 @c ------------------------- | |
6517 @kindex C-c C-f C-d | |
6518 @kindex C-c C-f d | |
6519 @item C-c C-f d | |
6520 @itemx C-c C-f C-d | |
6521 Move to @samp{Dcc:} header field (@code{mh-to-field}). | |
6522 @c ------------------------- | |
6523 @kindex C-c C-f C-f | |
6524 @kindex C-c C-f f | |
6525 @item C-c C-f f | |
6526 @itemx C-c C-f C-f | |
6527 Move to @samp{Fcc:} header field (@code{mh-to-field}). | |
6528 @c ------------------------- | |
6529 @kindex C-c C-f C-l | |
6530 @kindex C-c C-f l | |
6531 @item C-c C-f l | |
6532 @itemx C-c C-f C-l | |
6533 Move to @samp{Mail-Followup-To:} header field (@code{mh-to-field}). | |
6534 @c ------------------------- | |
6535 @kindex C-c C-f C-m | |
6536 @kindex C-c C-f m | |
6537 @item C-c C-f m | |
6538 @itemx C-c C-f C-m | |
6539 Move to @samp{From:} header field (@code{mh-to-field}). | |
6540 @c ------------------------- | |
6541 @kindex C-c C-f C-r | |
6542 @kindex C-c C-f r | |
6543 @item C-c C-f r | |
6544 @itemx C-c C-f C-r | |
6545 Move to @samp{Reply-To:} header field (@code{mh-to-field}). | |
6546 @c ------------------------- | |
6547 @kindex C-c C-f C-s | |
6548 @kindex C-c C-f s | |
6549 @item C-c C-f s | |
6550 @itemx C-c C-f C-s | |
6551 Move to @samp{Subject:} header field (@code{mh-to-field}). | |
6552 @c ------------------------- | |
6553 @kindex C-c C-f C-t | |
6554 @kindex C-c C-f t | |
6555 @item C-c C-f t | |
6556 @itemx C-c C-f C-t | |
6557 Move to @samp{To:} header field (@code{mh-to-field}). | |
6558 @end table | |
6559 | |
6560 Another few commands are available in the MH-Folder buffer resulting | |
6561 from a search. | |
6562 | |
6563 @table @kbd | |
6564 @kindex @key{TAB} | |
6565 @findex mh-index-next-folder | |
6566 @item @key{TAB} | |
6567 Jump to the next folder marker (@code{mh-index-next-folder}). | |
6568 @c ------------------------- | |
6569 @kindex S-@key{TAB} | |
6570 @findex mh-index-previous-folder | |
6571 @item S-@key{TAB} | |
6572 Jump to the previous folder marker (@code{mh-index-previous-folder}). | |
6573 @c ------------------------- | |
6574 @kindex v | |
6575 @findex mh-index-visit-folder | |
6576 @item v | |
6577 Visit original folder from where the message at point was found | |
6578 (@code{mh-index-visit-folder}). | |
6579 @end table | |
6580 | |
6581 @cindex @samp{mh-search} customization group | |
6582 @cindex customization group, @samp{mh-search} | |
6583 | |
6584 There is one option from the @samp{mh-search} customization group used | |
6585 in searching. | |
6586 | |
6587 @vtable @code | |
6588 @item mh-search-program | |
6589 Search program that MH-E shall use (default: @samp{Auto-detect}). | |
6590 @end vtable | |
6591 | |
6592 The following hook is available. | |
6593 | |
6594 @vtable @code | |
6595 @item mh-search-mode-hook | |
6596 Hook run upon entry to @code{mh-search-mode} (default: @code{nil}). | |
6597 @end vtable | |
6598 | |
6599 The following face is available. | |
6600 | |
6601 @vtable @code | |
6602 @item mh-search-folder | |
6603 Folder heading face in MH-Folder buffers created by searches. | |
6604 @end vtable | |
6605 | |
6606 @findex mh-search-folder | |
6607 @kindex F s | |
6608 | |
6609 The command @kbd{F s} (@code{mh-search-folder}) helps you find | |
6610 messages in your entire corpus of mail. You can search for messages to | |
6611 or from a particular person or about a particular subject. In fact, | |
6612 you can also search for messages containing selected strings in any | |
6613 arbitrary header field or any string found within the messages. | |
6614 | |
6615 @cindex @command{pick} | |
6616 @cindex MH commands, @command{pick} | |
6617 | |
6618 Out of the box, MH-E uses @command{pick} to find messages. With a | |
6619 little extra effort, you can set an indexing program which rewards you | |
6620 with extremely quick results. The drawback is that sometimes the index | |
6621 does not contain the words you're looking for. You can still use | |
6622 @command{pick} in these situations. | |
6623 | |
6624 You are prompted for the folder to search. This can be @samp{all} to | |
6625 search all folders. Note that the search works recursively on the | |
6626 listed folder. | |
6627 | |
6628 @cindex MH-Search mode | |
6629 @cindex modes, MH-Search | |
6630 | |
6631 Next, an MH-Search buffer appears where you can enter search criteria. | |
6632 | |
6633 @cartouche | |
6634 @smallexample | |
6635 From: | |
6636 To: | |
6637 Cc: | |
6638 Date: | |
6639 Subject: | |
6640 -------- | |
6641 # | |
6642 | |
6643 | |
6644 | |
6645 | |
6646 | |
6647 | |
6648 | |
6649 | |
6650 --:** search-pattern All L7 (MH-Search)--------------------------- | |
6651 Type C-c C-c to search messages, C-c C-p to use pick, C-c ? for help | |
6652 @end smallexample | |
6653 @end cartouche | |
6654 @i{Search window} | |
6655 | |
6656 @cindex @command{pick} | |
6657 @cindex MH commands, @command{pick} | |
6658 | |
6659 Edit this template by entering your search criteria in an appropriate | |
6660 header field that is already there, or create a new field yourself. If | |
6661 the string you're looking for could be anywhere in a message, then | |
6662 place the string underneath the row of dashes. | |
6663 | |
6664 As an example, let's say that we want to find messages from Ginnean | |
6665 about horseback riding in the Kosciusko National Park (Australia) | |
6666 during January, 1994. Normally we would start with a broad search and | |
6667 narrow it down if necessary to produce a manageable amount of data, | |
6668 but we'll cut to the chase and create a fairly restrictive set of | |
6669 criteria as follows: | |
6670 | |
6671 @smallexample | |
6672 @group | |
6673 From: ginnean | |
6674 To: | |
6675 Cc: | |
6676 Date: Jan 1994 | |
6677 Subject: | |
6678 -------- | |
6679 horse | |
6680 kosciusko | |
6681 @end group | |
6682 @end smallexample | |
6683 | |
6684 @findex mh-to-field | |
6685 @kindex C-c C-f C-t | |
6686 | |
6687 As with MH-Letter mode, MH-Search provides commands like @kbd{C-c C-f | |
6688 C-t} (@code{mh-to-field}) to help you fill in the blanks. | |
6689 @xref{Editing Message}. | |
6690 | |
6691 @kindex F s | |
6692 @vindex mh-search-mode-hook | |
6693 | |
6694 If you find that you do the same thing over and over when editing the | |
6695 search template, you may wish to bind some shortcuts to keys. This can | |
6696 be done with the variable @code{mh-search-mode-hook}, which is called | |
6697 when @kbd{F s} is run on a new pattern. | |
6698 | |
6699 @findex mh-index-do-search | |
6700 @findex mh-pick-do-search | |
6701 @kindex C-c C-c | |
6702 @kindex C-c C-p | |
6703 | |
6704 To perform the search, type @kbd{C-c C-c} (@code{mh-index-do-search}). | |
6705 Sometimes you're searching for text that is either not indexed, or | |
6706 hasn't been indexed yet. In this case you can override the default | |
6707 method with the pick method by running the command @kbd{C-c C-p} | |
6708 (@code{mh-pick-do-search}). | |
6709 | |
6710 @cindex folders, @samp{+mhe-index} | |
6711 @cindex @samp{+mhe-index} | |
6712 @findex mh-index-next-folder | |
6713 @findex mh-index-previous-folder | |
6714 @kindex @key{TAB} | |
6715 @kindex S-@key{TAB} | |
6716 @vindex mh-search-folder | |
6717 | |
6718 The messages that are found are put in a temporary sub-folder of | |
6719 @samp{+mhe-index} and are displayed in an MH-Folder buffer. This | |
6720 buffer is special because it displays messages from multiple folders; | |
6721 each set of messages from a given folder has a heading with the folder | |
6722 name. The appearance of the heading can be modified by customizing the | |
6723 face @code{mh-search-folder}. You can jump back and forth between the | |
6724 headings using the commands @kbd{@key{TAB}} | |
6725 (@code{mh-index-next-folder}) and @kbd{S-@key{TAB}} | |
6726 (@code{mh-index-previous-folder}). | |
6727 | |
6728 @findex mh-index-visit-folder | |
6729 @findex mh-rescan-folder | |
6730 @kindex F r | |
6731 @kindex v | |
6732 | |
6733 In addition, the command @kbd{v} (@code{mh-index-visit-folder}) can be | |
6734 used to visit the folder of the message at point. Initially, only the | |
6735 messages that matched the search criteria are displayed in the folder. | |
6736 While the temporary buffer has its own set of message numbers, the | |
6737 actual messages numbers are shown in the visited folder. Thus, the | |
6738 command @kbd{v} is useful to find the actual message number of an | |
6739 interesting message, or to view surrounding messages with the command | |
6740 @kbd{F r} @code{mh-rescan-folder}. @xref{Folders}. | |
6741 | |
6742 @findex mh-kill-folder | |
6743 @kindex F k | |
6744 | |
6745 Because this folder is temporary, you'll probably get in the habit of | |
6746 killing it when you're done with @kbd{F k} (@code{mh-kill-folder}). | |
6747 @xref{Folders}. | |
6748 | |
6749 @kindex F s | |
6750 | |
6751 You can regenerate the results by running @kbd{F s} with a prefix | |
6752 argument. | |
6753 | |
6754 @cindex @command{procmail} | |
6755 @cindex Unix commands, @command{procmail} | |
6756 @cindex @samp{X-MHE-Checksum:} header field | |
6757 @cindex header field, @samp{X-MHE-Checksum:} | |
6758 | |
6759 Note: This command uses an @samp{X-MHE-Checksum:} header field to | |
6760 cache the MD5 checksum of a message. This means that if an incoming | |
6761 message already contains an @samp{X-MHE-Checksum:} field, that message | |
6762 might not be found by this command. The following @command{procmail} | |
6763 recipe avoids this problem by renaming the existing header field: | |
6764 | |
6765 @smallexample | |
6766 @group | |
6767 :0 wf | |
6768 | formail -R "X-MHE-Checksum" "X-Old-MHE-Checksum" | |
6769 @end group | |
6770 @end smallexample | |
6771 | |
6772 @xref{Limits}, for an alternative interface to searching. | |
6773 | |
6774 @section Configuring Indexed Searches | |
6775 | |
6776 @cindex @command{grep} | |
6777 @cindex @command{mairix} | |
6778 @cindex @command{namazu} | |
6779 @cindex @command{pick} | |
6780 @cindex @command{swish++} | |
6781 @cindex @command{swish-e} | |
6782 @cindex Unix commands, @command{grep} | |
6783 @cindex Unix commands, @command{mairix} | |
6784 @cindex Unix commands, @command{namazu} | |
6785 @cindex Unix commands, @command{pick} | |
6786 @cindex Unix commands, @command{swish++} | |
6787 @cindex Unix commands, @command{swish-e} | |
6788 @findex mh-search | |
6789 @kindex F s | |
6790 @vindex mh-search-program | |
6791 | |
6792 The command @kbd{F s} (@code{mh-search}) runs the command defined by | |
6793 the option @code{mh-search-program}. The default value is | |
6794 @samp{Auto-detect} which means that MH-E will automatically choose one | |
6795 of @command{swish++}, @command{swish-e}, @command{mairix}, | |
6796 @command{namazu}, @command{pick} and @command{grep} in that order. If, | |
6797 for example, you have both @command{swish++} and @command{mairix} | |
6798 installed and you want to use @command{mairix}, then you can set this | |
6799 option to @samp{mairix}. | |
6800 | |
6801 The following sub-sections describe how to set up the various indexing | |
6802 programs to use with MH-E. | |
6803 | |
6804 @subsection swish++ | |
6805 | |
6806 @cindex @command{swish++} | |
6807 @cindex Unix commands, @command{swish++} | |
6808 | |
6809 In the examples below, replace @file{/home/user/Mail} with the path to | |
6810 your MH directory. | |
6811 | |
6812 First create the directory @file{/home/user/Mail/.swish++}. Then | |
6813 create the file @file{/home/user/Mail/.swish++/swish++.conf} with the | |
6814 following contents: | |
6815 | |
6816 @smallexample | |
6817 @group | |
6818 IncludeMeta Bcc Cc Comments Content-Description From Keywords | |
6819 IncludeMeta Newsgroups Resent-To Subject To | |
6820 IncludeMeta Message-Id References In-Reply-To | |
6821 IncludeFile Mail * | |
6822 IndexFile /home/user/Mail/.swish++/swish++.index | |
6823 @end group | |
6824 @end smallexample | |
6825 | |
6826 Use the following command line to generate the swish index. Run this | |
6827 daily from cron: | |
6828 | |
6829 @smallexample | |
6830 @group | |
6831 find /home/user/Mail -path /home/user/Mail/mhe-index -prune \ | |
6832 -o -path /home/user/Mail/.swish++ -prune \ | |
6833 -o -name "[0-9]*" -print \ | |
6834 | index -c /home/user/Mail/.swish++/swish++.conf - | |
6835 @end group | |
6836 @end smallexample | |
6837 | |
6838 This command does not index the folders that hold the results of your | |
6839 searches in @samp{+mhe-index} since they tend to be ephemeral and the | |
6840 original messages are indexed anyway. | |
6841 | |
6842 @cindex @command{index} | |
6843 @cindex Unix commands, @command{index} | |
6844 @cindex @command{index++} | |
6845 @cindex Unix commands, @command{index++} | |
6846 | |
6847 On some systems (Debian GNU/Linux, for example), use @command{index++} | |
6848 instead of @command{index}. | |
6849 | |
6850 @subsection swish | |
6851 | |
6852 @cindex @command{swish-e} | |
6853 @cindex Unix commands, @command{swish-e} | |
6854 | |
6855 In the examples below, replace @file{/home/user/Mail} with the path to | |
6856 your MH directory. | |
6857 | |
6858 First create the directory @file{/home/user/Mail/.swish}. Then create | |
6859 the file @file{/home/user/Mail/.swish/config} with the following | |
6860 contents: | |
6861 | |
6862 @smallexample | |
6863 @group | |
6864 DefaultContents TXT* | |
6865 IndexDir /home/user/Mail | |
6866 IndexFile /home/user/Mail/.swish/index | |
6867 IndexName "Mail Index" | |
6868 IndexDescription "Mail Index" | |
6869 IndexPointer "http://nowhere" | |
6870 IndexAdmin "nobody" | |
6871 #MetaNames automatic | |
6872 IndexReport 3 | |
6873 FollowSymLinks no | |
6874 UseStemming no | |
6875 IgnoreTotalWordCountWhenRanking yes | |
6876 WordCharacters abcdefghijklmnopqrstuvwxyz0123456789- | |
6877 BeginCharacters abcdefghijklmnopqrstuvwxyz | |
6878 EndCharacters abcdefghijklmnopqrstuvwxyz0123456789 | |
6879 IgnoreLimit 50 1000 | |
6880 IndexComments 0 | |
6881 FileRules filename contains \D | |
6882 FileRules pathname contains /home/user/Mail/.swish | |
6883 FileRules pathname contains /home/user/Mail/mhe-index | |
6884 FileRules filename is index | |
6885 @end group | |
6886 @end smallexample | |
6887 | |
6888 This configuration does not index the folders that hold the results of | |
6889 your searches in @samp{+mhe-index} since they tend to be ephemeral and | |
6890 the original messages are indexed anyway. | |
6891 | |
6892 If there are any directories you would like to ignore, append lines | |
6893 like the following to @file{config}: | |
6894 | |
6895 @smallexample | |
6896 FileRules pathname contains /home/user/Mail/scripts | |
6897 @end smallexample | |
6898 | |
6899 @cindex @command{swish-e} | |
6900 @cindex Unix commands, @command{swish-e} | |
6901 | |
6902 Use the following command line to generate the swish index. Run this | |
6903 daily from cron: | |
6904 | |
6905 @smallexample | |
6906 swish-e -c /home/user/Mail/.swish/config | |
6907 @end smallexample | |
6908 | |
6909 @subsection mairix | |
6910 | |
6911 @cindex @command{mairix} | |
6912 @cindex Unix commands, @command{mairix} | |
6913 | |
6914 In the examples below, replace @file{/home/user/Mail} with the path to | |
6915 your MH directory. | |
6916 | |
6917 First create the directory @file{/home/user/Mail/.mairix}. Then create | |
6918 the file @file{/home/user/Mail/.mairix/config} with the following | |
6919 contents: | |
6920 | |
6921 @smallexample | |
6922 @group | |
6923 base=/home/user/Mail | |
6924 | |
6925 # List of folders that should be indexed. 3 dots at the end means there | |
6926 # are subfolders within the folder | |
6927 mh=archive...:inbox:drafts:news:sent:trash | |
6928 | |
6929 vfolder_format=raw | |
6930 database=/home/user/Mail/mairix/database | |
6931 @end group | |
6932 @end smallexample | |
6933 | |
6934 Use the following command line to generate the mairix index. Run this daily | |
6935 from cron: | |
6936 | |
6937 @smallexample | |
6938 mairix -f /home/user/Mail/.mairix/config | |
6939 @end smallexample | |
6940 | |
6941 @subsection namazu | |
6942 | |
6943 @cindex @command{namazu} | |
6944 @cindex Unix commands, @command{namazu} | |
6945 | |
6946 In the examples below, replace @file{/home/user/Mail} with the path to | |
6947 your MH directory. | |
6948 | |
6949 First create the directory @file{/home/user/Mail/.namazu}. Then create | |
6950 the file @file{/home/user/Mail/.namazu/mknmzrc} with the following | |
6951 contents: | |
6952 | |
6953 @smallexample | |
6954 @group | |
6955 package conf; # Don't remove this line! | |
6956 $ADDRESS = 'user@@localhost'; | |
6957 $ALLOW_FILE = "[0-9]*"; | |
6958 $EXCLUDE_PATH = "^/home/user/Mail/(mhe-index|spam)"; | |
6959 @end group | |
6960 @end smallexample | |
6961 | |
6962 This configuration does not index the folders that hold the results of | |
6963 your searches in @samp{+mhe-index} since they tend to be ephemeral and | |
6964 the original messages are indexed anyway. | |
6965 | |
6966 Use the following command line to generate the namazu index. Run this | |
6967 daily from cron: | |
6968 | |
6969 @smallexample | |
6970 mknmz -f /home/user/Mail/.namazu/mknmzrc -O /home/user/Mail/.namazu \ | |
6971 /home/user/Mail | |
6972 @end smallexample | |
6973 | |
6974 @subsection pick | |
6975 | |
6976 @cindex @command{pick} | |
6977 @cindex MH commands, @command{pick} | |
6978 | |
6979 This search method does not require any setup. | |
6980 | |
6981 Read @command{pick}(1) or the section | |
6982 @uref{@value{MH-BOOK-HOME}/finpic.html, Finding Messages with pick} in | |
6983 the MH book to find out more about how to enter the criteria. | |
6984 | |
6985 @subsection grep | |
6986 | |
6987 @cindex @command{grep} | |
6988 @cindex Unix commands, @command{grep} | |
6989 | |
6990 This search method does not require any setup. | |
6991 | |
6992 Unlike the other search methods, this method does not use the | |
6993 MH-Search buffer. Instead, you simply enter a regular expression in | |
6994 the minibuffer. For help in constructing regular expressions, see your | |
6995 man page for @command{grep}. | |
6996 | |
6997 @node Threading, Limits, Searching, Top | |
6998 @chapter Viewing Message Threads | |
6999 | |
7000 @cindex threading | |
7001 | |
7002 MH-E groups messages by @dfn{threads} which are messages that are part | |
7003 of the same discussion and usually all have the same @samp{Subject:} | |
7004 header field. Other ways to organize messages in a folder include | |
7005 limiting (@pxref{Limits}) or using full-text indexed searches | |
7006 (@pxref{Searching}). | |
7007 | |
7008 @cindex root, in threads | |
7009 @cindex siblings, in threads | |
7010 @cindex ancestor, in threads | |
7011 | |
7012 A thread begins with a single message called a @dfn{root}. All replies | |
7013 to the same message are @dfn{siblings} of each other. Any message that | |
7014 has replies to it is an @dfn{ancestor} of those replies. | |
7015 | |
7016 There are several commands that you can use to navigate and operate on | |
7017 threads. | |
7018 | |
7019 @table @kbd | |
7020 @kindex T ? | |
7021 @findex mh-prefix-help | |
7022 @item T ? | |
7023 Display cheat sheet for the commands of the current prefix in | |
7024 minibuffer (@code{mh-prefix-help}). | |
7025 @c ------------------------- | |
7026 @kindex T o | |
7027 @findex mh-thread-refile | |
7028 @item T o | |
7029 Refile (output) thread into folder (@code{mh-thread-refile}). | |
7030 @c ------------------------- | |
7031 @kindex T d | |
7032 @findex mh-thread-delete | |
7033 @item T d | |
7034 Delete thread (@code{mh-thread-delete}). | |
7035 @c ------------------------- | |
7036 @kindex T t | |
7037 @findex mh-toggle-threads | |
7038 @item T t | |
7039 Toggle threaded view of folder (@code{mh-toggle-threads}). | |
7040 @c ------------------------- | |
7041 @kindex T n | |
7042 @findex mh-thread-next-sibling | |
7043 @item T n | |
7044 Display next sibling (@code{mh-thread-next-sibling}). | |
7045 @c ------------------------- | |
7046 @kindex T p | |
7047 @findex mh-thread-previous-sibling | |
7048 @item T p | |
7049 Display previous sibling (@code{mh-thread-previous-sibling}). | |
7050 @c ------------------------- | |
7051 @kindex T u | |
7052 @findex mh-thread-ancestor | |
7053 @item T u | |
7054 Display ancestor of current message (@code{mh-thread-ancestor}). | |
7055 @end table | |
7056 | |
7057 @cindex @samp{mh-thread} customization group | |
7058 @cindex customization group, @samp{mh-thread} | |
7059 | |
7060 The @samp{mh-thread} customization group contains one option. | |
7061 | |
7062 @vtable @code | |
7063 @item mh-show-threads-flag | |
7064 On means new folders start in threaded mode (default: @samp{off}). | |
7065 @end vtable | |
7066 | |
7067 @findex mh-toggle-threads | |
7068 @kindex T t | |
7069 @vindex mh-large-folder | |
7070 @vindex mh-show-threads-flag | |
7071 | |
7072 Threading large number of messages can be time consuming so the option | |
7073 @code{mh-show-threads-flag} is turned off by default. If you turn on | |
7074 this option, then threading will be done only if the number of | |
7075 messages being threaded is less than @code{mh-large-folder}. In any | |
7076 event, threading can be turned on (and off) with the command @kbd{T t} | |
7077 (@code{mh-toggle-threads}). | |
7078 | |
7079 @findex mh-thread-ancestor | |
7080 @findex mh-thread-next-sibling | |
7081 @findex mh-thread-previous-sibling | |
7082 @kindex T n | |
7083 @kindex T p | |
7084 @kindex T u | |
7085 | |
7086 There are a few commands to help you navigate threads. If you do not | |
7087 care for the way a particular thread has turned, you can move up the | |
7088 chain of messages with the command @kbd{T u} | |
7089 (@code{mh-thread-ancestor}. At any point you can use @kbd{T n} | |
7090 (@code{mh-thread-next-sibling} or @kbd{T p} | |
7091 (@code{mh-thread-previous-sibling}) to jump to the next or previous | |
7092 sibling, skipping the sub-threads. The command @kbd{T u} can also take | |
7093 a prefix argument to jump to the message that started everything. | |
7094 | |
7095 @findex mh-delete-subject-or-thread | |
7096 @findex mh-thread-delete | |
7097 @findex mh-thread-refile | |
7098 @kindex k | |
7099 @kindex T d | |
7100 @kindex T o | |
7101 | |
7102 There are threaded equivalents for the commands that delete and refile | |
7103 messages. For example, @kbd{T o} (@code{mh-thread-refile}) refiles the | |
7104 current message and all its children. Similarly, the command @kbd{T d} | |
7105 (@code{mh-thread-delete}) deletes the current message and all its | |
7106 children. These commands do not refile or delete sibling messages. | |
7107 @xref{Navigating}, for a description of the similar command @kbd{k} | |
7108 (@code{mh-delete-subject-or-thread}). | |
7109 | |
7110 @vindex mh-large-folder | |
7111 | |
7112 If you find that threading is too slow, it may be that you have | |
7113 @code{mh-large-folder} set too high. Also, threading is one of the few | |
7114 features of MH-E that really benefits from compiling. If you haven't | |
7115 compiled MH-E, I encourage you to do so@footnote{If you're not sure if | |
7116 MH-E has been byte-compiled, you could try running @samp{locate | |
7117 mh-thread.elc} or otherwise find MH-E on your system and ensure that | |
7118 @file{mh-thread.elc} exists. If you have multiple versions and you | |
7119 find that one is compiled but the other is not, then go into your | |
7120 @samp{*scratch*} buffer in Emacs, enter @kbd{load-path C-j}, and | |
7121 ensure that the byte-compiled version appears first in the | |
7122 @code{load-path}. If you find that MH-E is not compiled and you | |
7123 installed MH-E yourself, please refer to the installation directions | |
7124 in the file @file{README} in the distribution.}. | |
7125 | |
7126 @node Limits, Sequences, Threading, Top | |
7127 @chapter Limiting Display | |
7128 | |
7129 @cindex limits | |
7130 @cindex filters | |
7131 | |
7132 Another way to organize messages in a folder besides threading | |
7133 (@pxref{Threading}) or using full-text indexed searches | |
7134 (@pxref{Searching}) is by limiting the folder display to messages that | |
7135 are similar to the current message. | |
7136 | |
7137 @table @kbd | |
7138 @kindex / ? | |
7139 @findex mh-prefix-help | |
7140 @item / ? | |
7141 Display cheat sheet for the commands of the current prefix in | |
7142 minibuffer (@code{mh-prefix-help}). | |
7143 @c ------------------------- | |
7144 @cindex @samp{Sequence > Narrow to Tick Sequence} menu item | |
7145 @cindex menu item, @samp{Sequence > Narrow to Tick Sequence} | |
7146 @kindex / ' | |
7147 @findex mh-narrow-to-tick | |
7148 @item / ' | |
7149 Limit to messages in the @samp{tick} sequence | |
7150 (@code{mh-narrow-to-tick}). | |
7151 @c ------------------------- | |
7152 @kindex / c | |
7153 @findex mh-narrow-to-cc | |
7154 @item / c | |
7155 Limit to messages with the same @samp{Cc:} field | |
7156 (@code{mh-narrow-to-cc}). | |
7157 @c ------------------------- | |
7158 @kindex / m | |
7159 @findex mh-narrow-to-from | |
7160 @item / m | |
7161 Limit to messages with the same @samp{From:} field | |
7162 (@code{mh-narrow-to-from}). | |
7163 @c ------------------------- | |
7164 @kindex / g | |
7165 @findex mh-narrow-to-range | |
7166 @item / g | |
7167 Limit to range (@code{mh-narrow-to-range}). | |
7168 @c ------------------------- | |
7169 @cindex @samp{Sequence > Narrow to Subject Sequence} menu item | |
7170 @cindex menu item, @samp{Sequence > Narrow to Subject Sequence} | |
7171 @kindex / s | |
7172 @findex mh-narrow-to-subject | |
7173 @item / s | |
7174 Limit to messages with the same @samp{Subject:} field | |
7175 (@code{mh-narrow-to-subject}). | |
7176 @c ------------------------- | |
7177 @kindex / t | |
7178 @findex mh-narrow-to-to | |
7179 @item / t | |
7180 Limit to messages with the same @samp{To:} field | |
7181 (@code{mh-narrow-to-to}). | |
7182 @c ------------------------- | |
7183 @cindex @samp{Sequence > Widen from Sequence} menu item | |
7184 @cindex menu item, @samp{Sequence > Widen from Sequence} | |
7185 @kindex / w | |
7186 @findex mh-widen | |
7187 @item / w | |
7188 Remove last restriction (@code{mh-widen}). | |
7189 @end table | |
7190 | |
7191 All of the limiting commands above refine the display in some way. | |
7192 | |
7193 @cindex @command{pick} | |
7194 @cindex MH commands, @command{pick} | |
7195 @findex mh-narrow-to-cc | |
7196 @findex mh-narrow-to-from | |
7197 @findex mh-narrow-to-subject | |
7198 @findex mh-narrow-to-to | |
7199 @kindex / c | |
7200 @kindex / m | |
7201 @kindex / s | |
7202 @kindex / t | |
7203 | |
7204 The commands @kbd{/ c} (@code{mh-narrow-to-cc}), @kbd{/ m} | |
7205 (@code{mh-narrow-to-from}), @kbd{/ s} (@code{mh-narrow-to-subject}), | |
7206 and @kbd{/ t} (@code{mh-narrow-to-to}) restrict the display to | |
7207 messages matching the content of the respective field in the current | |
7208 message. However, you can give any of these a prefix argument to edit | |
7209 the @command{pick} expression used to narrow the view@footnote{See | |
7210 @command{pick}(1) or the section | |
7211 @uref{@value{MH-BOOK-HOME}/finpic.html, Finding Messages with pick} in | |
7212 the MH book.}. | |
7213 | |
7214 @cindex @samp{tick} sequence | |
7215 @cindex sequence, @samp{tick} | |
7216 @cindex ticked messages, viewing | |
7217 @findex mh-narrow-to-range | |
7218 @findex mh-narrow-to-tick | |
7219 @kindex / ' | |
7220 @kindex / g | |
7221 | |
7222 You can also limit the display to messages in the @samp{tick} sequence | |
7223 with the command @kbd{/ '} (@code{mh-narrow-to-tick}). | |
7224 @xref{Sequences}, for information on putting message into the | |
7225 @samp{tick} sequence. Use the @kbd{/ g} (@code{mh-narrow-to-range}) | |
7226 command to limit the display to messages in a range (@pxref{Ranges}). | |
7227 | |
7228 @findex mh-widen | |
7229 @kindex / w | |
7230 | |
7231 Each limit can be undone in turn with the @kbd{/ w} (@code{mh-widen}) | |
7232 command. Give this command a prefix argument to remove all limits. | |
7233 | |
7234 @node Sequences, Junk, Limits, Top | |
7235 @chapter Using Sequences | |
7236 | |
7237 @cindex @samp{Sequence} menu | |
7238 @cindex menu, @samp{Sequence} | |
7239 @cindex sequences | |
7240 | |
7241 For the whole scoop on MH sequences, refer to | |
7242 @samp{mh-sequence}(5)@footnote{See the section | |
7243 @uref{@value{MH-BOOK-HOME}/morseq.html, More About Sequences} in the MH | |
7244 book.}. As you've read, several of the MH-E commands can operate on a | |
7245 sequence, which is a shorthand for a range or group of messages. For | |
7246 example, you might want to forward several messages to a friend or | |
7247 colleague. Here's how to manipulate sequences. These commands are also | |
7248 available in the @samp{Sequence} menu. | |
7249 | |
7250 @table @kbd | |
7251 @cindex @samp{Sequence > Toggle Tick Mark} menu item | |
7252 @cindex menu item, @samp{Sequence > Toggle Tick Mark} | |
7253 @kindex ' | |
7254 @findex mh-toggle-tick | |
7255 @item ' | |
7256 Toggle tick mark of range (@code{mh-toggle-tick}). | |
7257 @c ------------------------- | |
7258 @kindex S ? | |
7259 @findex mh-prefix-help | |
7260 @item S ? | |
7261 Display cheat sheet for the commands of the current prefix in | |
7262 minibuffer (@code{mh-prefix-help}). | |
7263 @c ------------------------- | |
7264 @cindex @samp{Sequence > Narrow to Tick Sequence} menu item | |
7265 @cindex menu item, @samp{Sequence > Narrow to Tick Sequence} | |
7266 @kindex S ' | |
7267 @findex mh-narrow-to-tick | |
7268 @item S ' | |
7269 Limit to ticked messages (@code{mh-narrow-to-tick}). | |
7270 @c ------------------------- | |
7271 @cindex @samp{Sequence > Delete Message from Sequence...} menu item | |
7272 @cindex menu item, @samp{Sequence > Delete Message from Sequence...} | |
7273 @kindex S d | |
7274 @findex mh-delete-msg-from-seq | |
7275 @item S d | |
7276 Delete range from sequence (@code{mh-delete-msg-from-seq}). | |
7277 @c ------------------------- | |
7278 @cindex @samp{Sequence > Delete Sequence...} menu item | |
7279 @cindex menu item, @samp{Sequence > Delete Sequence...} | |
7280 @kindex S k | |
7281 @findex mh-delete-seq | |
7282 @item S k | |
7283 Delete sequence (@code{mh-delete-seq}). | |
7284 @c ------------------------- | |
7285 @cindex @samp{Sequence > List Sequences in Folder...} menu item | |
7286 @cindex menu item, @samp{Sequence > List Sequences in Folder...} | |
7287 @kindex S l | |
7288 @findex mh-list-sequences | |
7289 @item S l | |
7290 List all sequences in folder (@code{mh-list-sequences}). | |
7291 @c ------------------------- | |
7292 @cindex @samp{Sequence > Narrow to Sequence...} menu item | |
7293 @cindex menu item, @samp{Sequence > Narrow to Sequence...} | |
7294 @kindex S n | |
7295 @findex mh-narrow-to-seq | |
7296 @item S n | |
7297 Restrict display to messages in sequence (@code{mh-narrow-to-seq}). | |
7298 @c ------------------------- | |
7299 @cindex @samp{Sequence > Add Message to Sequence...} menu item | |
7300 @cindex menu item, @samp{Sequence > Add Message to Sequence...} | |
7301 @kindex S p | |
7302 @findex mh-put-msg-in-seq | |
7303 @item S p | |
7304 Add range to sequence (@code{mh-put-msg-in-seq}). | |
7305 @c ------------------------- | |
7306 @cindex @samp{Sequence > List Sequences for Message} menu item | |
7307 @cindex menu item, @samp{Sequence > List Sequences for Message} | |
7308 @kindex S s | |
7309 @findex mh-msg-is-in-seq | |
7310 @item S s | |
7311 Display the sequences in which the current message appears | |
7312 (@code{mh-msg-is-in-seq}). | |
7313 @c ------------------------- | |
7314 @cindex @samp{Sequence > Widen from Sequence} menu item | |
7315 @cindex menu item, @samp{Sequence > Widen from Sequence} | |
7316 @kindex S w | |
7317 @findex mh-widen | |
7318 @item S w | |
7319 Remove last restriction (@code{mh-widen}). | |
7320 @c ------------------------- | |
7321 @findex mh-update-sequences | |
7322 @item M-x mh-update-sequences | |
7323 Flush MH-E's state out to MH@. | |
7324 @end table | |
7325 | |
7326 @cindex @samp{mh-sequences} customization group | |
7327 @cindex customization group, @samp{mh-sequences} | |
7328 | |
7329 The @samp{mh-sequences} customization group contains the options | |
7330 associated with sequences. | |
7331 | |
7332 @vtable @code | |
7333 @item mh-refile-preserves-sequences-flag | |
7334 On means that sequences are preserved when messages are refiled | |
7335 (default: @samp{on}). | |
7336 @c ------------------------- | |
7337 @item mh-tick-seq | |
7338 The name of the MH sequence for ticked messages (default: @samp{'tick}). | |
7339 @c ------------------------- | |
7340 @item mh-update-sequences-after-mh-show-flag | |
7341 On means flush MH sequences to disk after message is shown (default: | |
7342 @samp{on}). | |
7343 @end vtable | |
7344 | |
7345 The following hook is available. | |
7346 | |
7347 @vtable @code | |
7348 @item mh-unseen-updated-hook | |
7349 Hook run after the unseen sequence has been updated (default: @code{nil}). | |
7350 @end vtable | |
7351 | |
7352 @cindex @command{pick} | |
7353 @cindex MH commands, @command{pick} | |
7354 @findex mh-put-msg-in-seq | |
7355 @kindex S p | |
7356 | |
7357 To place a message in a sequence, use @kbd{S p} | |
7358 (@code{mh-put-msg-in-seq}). Give @kbd{S p} a range and you can add all | |
7359 the messages in a sequence to another sequence (for example, @kbd{C-u | |
7360 S p SourceSequence @key{RET} DestSequence @key{RET}}, @pxref{Ranges}). | |
7361 | |
7362 @cindex @samp{tick} sequence | |
7363 @cindex sequence, @samp{tick} | |
7364 @cindex ticking messages | |
7365 @findex mh-index-ticked-messages | |
7366 @findex mh-toggle-tick | |
7367 @kindex ' | |
7368 @kindex F ' | |
7369 @kindex S p | |
7370 | |
7371 One specific use of the @kbd{S p} command is @kbd{'} | |
7372 (@code{mh-toggle-tick}) which adds messages to the @samp{tick} | |
7373 sequence. This sequence can be viewed later with the @kbd{F '} | |
7374 (@code{mh-index-ticked-messages}) command (@pxref{Folders}). | |
7375 | |
7376 @vindex mh-tick-seq | |
7377 | |
7378 You can customize the option @code{mh-tick-seq} if you already use the | |
7379 @samp{tick} sequence for your own use. You can also disable all of the | |
7380 ticking functions by choosing the @samp{Disable Ticking} item but | |
7381 there isn't much advantage to that. | |
7382 | |
7383 @cindex MH-Folder mode | |
7384 @cindex modes, MH-Folder | |
7385 @findex mh-narrow-to-seq | |
7386 @findex mh-narrow-to-tick | |
7387 @findex mh-widen | |
7388 @kindex S ' | |
7389 @kindex S n | |
7390 @kindex S w | |
7391 | |
7392 Once you've placed some messages in a sequence, you may wish to narrow | |
7393 the field of view to just those messages in the sequence you've | |
7394 created. To do this, use @kbd{S n} (@code{mh-narrow-to-seq}). You are | |
7395 prompted for the name of the sequence. What this does is show only | |
7396 those messages that are in the selected sequence in the MH-Folder | |
7397 buffer. In addition, it limits further MH-E searches to just those | |
7398 messages. To narrow the view to the messages in the @samp{tick} | |
7399 sequence, use @kbd{S '} (@code{mh-narrow-to-tick}). When you want to | |
7400 widen the view to all your messages again, use @kbd{S w} | |
7401 (@code{mh-widen}). | |
7402 | |
7403 @cindex buffers, @samp{*MH-E Sequences*} | |
7404 @cindex @samp{*MH-E Sequences*} | |
7405 @findex mh-list-sequences | |
7406 @findex mh-msg-is-in-seq | |
7407 @kindex S l | |
7408 @kindex S s | |
7409 | |
7410 You can see which sequences in which a message appears with the | |
7411 command @kbd{S s} (@code{mh-msg-is-in-seq}). Use a prefix argument to | |
7412 display the sequences in which another message appears (as in @kbd{C-u | |
7413 42 S s @key{RET}}). Or, you can list all sequences in a selected | |
7414 folder (default is current folder) with @kbd{S l} | |
7415 (@code{mh-list-sequences}). The list appears in a buffer named | |
7416 @samp{*MH-E Sequences*} (@pxref{Miscellaneous}). | |
7417 | |
7418 @cindex MH profile component, @samp{Previous-Sequence:} | |
7419 @cindex @samp{cur} sequence | |
7420 @cindex @samp{Previous-Sequence:} MH profile component | |
7421 @cindex sequence, @samp{cur} | |
7422 @cindex sequence, @samp{Previous-Sequence} | |
7423 @vindex mh-refile-preserves-sequences-flag | |
7424 | |
7425 If a message is in any sequence (except | |
7426 @samp{Previous-Sequence:}@footnote{See @samp{mh-profile}(5)).} and | |
7427 @samp{cur}) when it is refiled, then it will still be in those | |
7428 sequences in the destination folder. If this behavior is not desired, | |
7429 then turn off the option @code{mh-refile-preserves-sequences-flag}. | |
7430 | |
7431 @findex mh-delete-msg-from-seq | |
7432 @findex mh-delete-seq | |
7433 @kindex d | |
7434 @kindex S d | |
7435 @kindex S k | |
7436 | |
7437 If you want to remove a message (or range, @pxref{Ranges}) from a | |
7438 sequence, use @kbd{S d} (@code{mh-delete-msg-from-seq}). If you want | |
7439 to delete an entire sequence, use @kbd{S k} (@code{mh-delete-seq}). In | |
7440 the latter case you are prompted for the sequence to delete. Note that | |
7441 this deletes only the sequence, not the messages in the sequence. If | |
7442 you want to delete the messages, use @kbd{C-u d} (@pxref{Reading | |
7443 Mail}). | |
7444 | |
7445 @cindex @samp{Unseen-Sequence:} MH profile component | |
7446 @cindex @samp{cur} sequence | |
7447 @cindex @samp{tick} sequence | |
7448 @cindex MH profile component, @samp{Unseen-Sequence:} | |
7449 @cindex sequence, @samp{Unseen-Sequence} | |
7450 @cindex sequence, @samp{cur} | |
7451 @cindex sequence, @samp{tick} | |
7452 @findex mh-update-sequences | |
7453 @kindex M-x mh-update-sequences | |
7454 @kindex q | |
7455 @kindex x | |
7456 @vindex mh-tick-seq | |
7457 @vindex mh-update-sequences-after-mh-show-flag | |
7458 | |
7459 Three sequences are maintained internally by MH-E and pushed out to MH | |
7460 when a message is shown. They include the sequence specified by your | |
7461 @samp{Unseen-Sequence:} profile component, @samp{cur}, and the | |
7462 sequence listed by the option @code{mh-tick-seq} which is @samp{tick} | |
7463 by default. If you do not like this behavior, turn off the option | |
7464 @code{mh-update-sequences-after-mh-show-flag}. You can then update the | |
7465 state manually with the @kbd{x}, @kbd{q}, or @kbd{M-x | |
7466 mh-update-sequences} commands. | |
7467 | |
7468 @vindex mh-seen-list | |
7469 @vindex mh-unseen-updated-hook | |
7470 | |
7471 The hook @code{mh-unseen-updated-hook} is run after the unseen | |
7472 sequence has been updated. The variable @code{mh-seen-list} can be | |
7473 used by this hook to obtain the list of messages which were removed | |
7474 from the unseen sequence. | |
7475 | |
7476 @cindex @command{mark} | |
7477 @cindex MH commands, @command{mark} | |
7478 @kindex S n | |
7479 @kindex S w | |
7480 | |
7481 With the exceptions of @kbd{S n} and @kbd{S w}, the underlying MH | |
7482 command dealing with sequences is @command{mark}@footnote{See the | |
7483 section @uref{@value{MH-BOOK-HOME}/mmbwm.html, Make Message Bookmarks | |
7484 with mark} in the MH book.}. | |
7485 | |
7486 @node Junk, Miscellaneous, Sequences, Top | |
7487 @chapter Dealing With Junk Mail | |
7488 | |
7489 @cindex Marshall Rose | |
7490 @cindex junk mail | |
7491 @cindex spam | |
7492 | |
7493 Marshall Rose once wrote a paper on MH entitled, @cite{How to process | |
7494 200 messages a day and still get some real work done}. This chapter | |
7495 could be entitled, @cite{How to process 1000 spams a day and still get | |
7496 some real work done}. | |
7497 | |
7498 @cindex blacklisting | |
7499 @cindex ham | |
7500 @cindex viruses | |
7501 @cindex whitelisting | |
7502 @cindex worms | |
7503 | |
7504 We use the terms @dfn{junk mail} and @dfn{spam} interchangeably for | |
7505 any unwanted message which includes spam, @dfn{viruses}, and | |
7506 @dfn{worms}. The opposite of spam is @dfn{ham}. The act of classifying | |
7507 a sender as one who sends junk mail is called @dfn{blacklisting}; the | |
7508 opposite is called @dfn{whitelisting}. | |
7509 | |
7510 @table @kbd | |
7511 @kindex J ? | |
7512 @findex mh-prefix-help | |
7513 @item J ? | |
7514 Display cheat sheet for the commands of the current prefix in | |
7515 minibuffer (@code{mh-prefix-help}). | |
7516 @c ------------------------- | |
7517 @kindex J b | |
7518 @findex mh-junk-blacklist | |
7519 @item J b | |
7520 Blacklist range as spam (@code{mh-junk-blacklist}). | |
7521 @c ------------------------- | |
7522 @kindex J w | |
7523 @findex mh-junk-whitelist | |
7524 @item J w | |
7525 Whitelist range as ham (@code{mh-junk-whitelist}). | |
7526 @c ------------------------- | |
7527 @item @code{mh-spamassassin-identify-spammers} | |
7528 Identify spammers who are repeat offenders. | |
7529 @end table | |
7530 | |
7531 @cindex @samp{mh-junk} customization group | |
7532 @cindex customization group, @samp{mh-junk} | |
7533 | |
7534 The following table lists the options from the @samp{mh-junk} | |
7535 customization group. | |
7536 | |
7537 @vtable @code | |
7538 @item mh-junk-background | |
7539 If on, spam programs are run in background (default: @samp{off}). | |
7540 @c ------------------------- | |
7541 @item mh-junk-disposition | |
7542 Disposition of junk mail (default: @samp{Delete Spam}). | |
7543 @c ------------------------- | |
7544 @item mh-junk-program | |
7545 Spam program that MH-E should use (default: @samp{Auto-detect}). | |
7546 @end vtable | |
7547 | |
7548 @cindex SpamProbe | |
7549 @cindex Spamassassin | |
7550 @cindex bogofilter | |
7551 @cindex spam filters, SpamProbe | |
7552 @cindex spam filters, Spamassassin | |
7553 @cindex spam filters, bogofilter | |
7554 | |
7555 MH-E depends on @uref{http://spamassassin.apache.org/, SpamAssassin}, | |
7556 @uref{http://bogofilter.sourceforge.net/, bogofilter}, or | |
7557 @uref{http://spamprobe.sourceforge.net/, SpamProbe} to throw the dreck | |
7558 away. This chapter describes briefly how to configure these programs | |
7559 to work well with MH-E and how to use MH-E's interface that provides | |
7560 continuing education for these programs. | |
7561 | |
7562 @vindex mh-junk-program | |
7563 | |
7564 The default setting of the option @code{mh-junk-program} is | |
7565 @samp{Auto-detect} which means that MH-E will automatically choose one | |
7566 of SpamAssassin, bogofilter, or SpamProbe in that order. If, for | |
7567 example, you have both SpamAssassin and bogofilter installed and you | |
7568 want to use bogofilter, then you can set this option to | |
7569 @samp{Bogofilter}. | |
7570 | |
7571 @findex mh-junk-blacklist | |
7572 @kindex J b | |
7573 @vindex mh-junk-disposition | |
7574 | |
7575 The command @kbd{J b} (@code{mh-junk-blacklist}) trains the spam | |
7576 program in use with the content of the range (@pxref{Ranges}) and then | |
7577 handles the message(s) as specified by the option | |
7578 @code{mh-junk-disposition}. By default, this option is set to | |
7579 @samp{Delete Spam} but you can also specify the name of the folder | |
7580 which is useful for building a corpus of spam for training purposes. | |
7581 | |
7582 @findex mh-junk-whitelist | |
7583 @kindex J w | |
7584 | |
7585 In contrast, the command @kbd{J w} (@code{mh-junk-whitelist}) | |
7586 reclassifies a range of messages (@pxref{Ranges}) as ham if it were | |
7587 incorrectly classified as spam. It then refiles the message into the | |
7588 @file{+inbox} folder. | |
7589 | |
7590 @cindex @samp{*MH-E Log*} | |
7591 @cindex buffers, @samp{*MH-E Log*} | |
7592 @findex call-process | |
7593 @vindex mh-junk-background | |
7594 | |
7595 By default, the programs are run in the foreground, but this can be | |
7596 slow when junking large numbers of messages. If you have enough memory | |
7597 or don't junk that many messages at the same time, you might try | |
7598 turning on the option @code{mh-junk-background}. @footnote{Note that | |
7599 the option @code{mh-junk-background} is used as the @code{display} | |
7600 argument in the call to @code{call-process}. Therefore, turning on | |
7601 this option means setting its value to @samp{0}. You can also set its | |
7602 value to @samp{t} to direct the programs' output to the @samp{*MH-E | |
7603 Log*} buffer; this may be useful for debugging.} | |
7604 | |
7605 The following sections discuss the various counter-spam measures that | |
7606 MH-E can work with. | |
7607 | |
7608 @cindex @file{.procmailrc} | |
7609 @cindex files, @file{.procmailrc} | |
7610 | |
7611 @subheading SpamAssassin | |
7612 | |
7613 @cindex Spamassassin | |
7614 @cindex spam filters, Spamassassin | |
7615 | |
7616 SpamAssassin is one of the more popular spam filtering programs. Get | |
7617 it from your local distribution or from the | |
7618 @uref{http://spamassassin.apache.org/, SpamAssassin web site}. | |
7619 | |
7620 To use SpamAssassin, add the following recipes to @file{~/.procmailrc}: | |
7621 | |
7622 @cindex @command{spamc} | |
7623 @cindex @samp{X-Spam-Level:} header field | |
7624 @cindex @samp{X-Spam-Status:} header field | |
7625 @cindex header field, @samp{X-Spam-Level:} | |
7626 @cindex header field, @samp{X-Spam-Status:} | |
7627 | |
7628 @smallexample | |
7629 PATH=$PATH:/usr/bin/mh | |
7630 MAILDIR=$HOME/`mhparam Path` | |
7631 | |
7632 # Fight spam with SpamAssassin. | |
7633 :0fw | |
7634 | spamc | |
7635 | |
7636 # Anything with a spam level of 10 or more is junked immediately. | |
7637 :0: | |
7638 * ^X-Spam-Level: .......... | |
7639 /dev/null | |
7640 | |
7641 :0: | |
7642 * ^X-Spam-Status: Yes | |
7643 spam/. | |
7644 @end smallexample | |
7645 | |
7646 If you don't use @command{spamc}, use @samp{spamassassin -P -a}. | |
7647 | |
7648 Note that one of the recipes above throws away messages with a score | |
7649 greater than or equal to 10. Here's how you can determine a value that | |
7650 works best for you. | |
7651 | |
7652 First, run @samp{spamassassin -t} on every mail message in your | |
7653 archive and use @command{gnumeric} to verify that the average plus the | |
7654 standard deviation of good mail is under 5, the SpamAssassin default | |
7655 for ``spam''. | |
7656 | |
7657 Using @command{gnumeric}, sort the messages by score and view the | |
7658 messages with the highest score. Determine the score which encompasses | |
7659 all of your interesting messages and add a couple of points to be | |
7660 conservative. Add that many dots to the @samp{X-Spam-Level:} header | |
7661 field above to send messages with that score down the drain. | |
7662 | |
7663 In the example above, messages with a score of 5-9 are set aside in | |
7664 the @samp{+spam} folder for later review. The major weakness of | |
7665 rules-based filters is a plethora of false positives so it is | |
7666 worthwhile to check. | |
7667 | |
7668 @findex mh-junk-blacklist | |
7669 @findex mh-junk-whitelist | |
7670 @kindex J b | |
7671 @kindex J w | |
7672 | |
7673 If SpamAssassin classifies a message incorrectly, or is unsure, you can | |
7674 use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and | |
7675 @kbd{J w} (@code{mh-junk-whitelist}). | |
7676 | |
7677 @cindex @command{sa-learn} | |
7678 @cindex @file{.spamassassin/user_prefs} | |
7679 @cindex files, @file{.spamassassin/user_prefs} | |
7680 | |
7681 The command @kbd{J b} (@code{mh-junk-blacklist}) adds a | |
7682 @samp{blacklist_from} entry to @file{~/spamassassin/user_prefs}, | |
7683 deletes the message, and sends the message to the Razor, so that | |
7684 others might not see this spam. If the @command{sa-learn} command is | |
7685 available, the message is also recategorized as spam. | |
7686 | |
7687 The command@kbd{J w} (@code{mh-junk-whitelist}) adds a | |
7688 @samp{whitelist_from} rule to @samp{~/.spamassassin/user_prefs}. If | |
7689 the @command{sa-learn} command is available, the message is also | |
7690 recategorized as ham. | |
7691 | |
7692 Over time, you'll observe that the same host or domain occurs | |
7693 repeatedly in the @samp{blacklist_from} entries, so you might think | |
7694 that you could avoid future spam by blacklisting all mail from a | |
7695 particular domain. The utility function | |
7696 @code{mh-spamassassin-identify-spammers} helps you do precisely that. | |
7697 This function displays a frequency count of the hosts and domains in | |
7698 the @samp{blacklist_from} entries from the last blank line in | |
7699 @file{~/.spamassassin/user_prefs} to the end of the file. This | |
7700 information can be used so that you can replace multiple | |
7701 @samp{blacklist_from} entries with a single wildcard entry such as: | |
7702 | |
7703 @smallexample | |
7704 blacklist_from *@@*amazingoffersdirect2u.com | |
7705 @end smallexample | |
7706 | |
7707 In versions of SpamAssassin (2.50 and on) that support a Bayesian | |
7708 classifier, @kbd{J b} @code{(mh-junk-blacklist}) uses the program | |
7709 @command{sa-learn} to recategorize the message as spam. Neither MH-E, | |
7710 nor SpamAssassin, rebuilds the database after adding words, so you | |
7711 will need to run @samp{sa-learn --rebuild} periodically. This can be | |
7712 done by adding the following to your @file{crontab}: | |
7713 | |
7714 @smallexample | |
7715 0 * * * * sa-learn --rebuild > /dev/null 2>&1 | |
7716 @end smallexample | |
7717 | |
7718 @subheading Bogofilter | |
7719 | |
7720 @cindex bogofilter | |
7721 @cindex spam filters, bogofilter | |
7722 | |
7723 Bogofilter is a Bayesian spam filtering program. Get it from your | |
7724 local distribution or from the | |
7725 @uref{http://bogofilter.sourceforge.net/, bogofilter web site}. | |
7726 | |
7727 Bogofilter is taught by running: | |
7728 | |
7729 @smallexample | |
7730 bogofilter -n < good-message | |
7731 @end smallexample | |
7732 | |
7733 on every good message, and | |
7734 | |
7735 @smallexample | |
7736 bogofilter -s < spam-message | |
7737 @end smallexample | |
7738 | |
7739 @cindex full training | |
7740 | |
7741 on every spam message. This is called a @dfn{full training}; three | |
7742 other training methods are described in the FAQ that is distributed | |
7743 with bogofilter. Note that most Bayesian filters need 1000 to 5000 of | |
7744 each type of message to start doing a good job. | |
7745 | |
7746 To use bogofilter, add the following recipes to @file{~/.procmailrc}: | |
7747 | |
7748 @cindex @samp{X-Bogosity:} header field | |
7749 @cindex header field, @samp{X-Bogosity:} | |
7750 | |
7751 @smallexample | |
7752 PATH=$PATH:/usr/bin/mh | |
7753 MAILDIR=$HOME/`mhparam Path` | |
7754 | |
7755 # Fight spam with Bogofilter. | |
7756 :0fw | |
7757 | bogofilter -3 -e -p | |
7758 | |
7759 :0: | |
7760 * ^X-Bogosity: Yes, tests=bogofilter | |
7761 spam/. | |
7762 | |
7763 :0: | |
7764 * ^X-Bogosity: Unsure, tests=bogofilter | |
7765 spam/unsure/. | |
7766 @end smallexample | |
7767 | |
7768 @findex mh-junk-blacklist | |
7769 @findex mh-junk-whitelist | |
7770 @kindex J b | |
7771 @kindex J w | |
7772 | |
7773 If bogofilter classifies a message incorrectly, or is unsure, you can | |
7774 use the MH-E commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J | |
7775 w} (@code{mh-junk-whitelist}) to update bogofilter's training. | |
7776 | |
7777 The @cite{Bogofilter FAQ} suggests that you run the following | |
7778 occasionally to shrink the database: | |
7779 | |
7780 @smallexample | |
7781 bogoutil -d wordlist.db | bogoutil -l wordlist.db.new | |
7782 mv wordlist.db wordlist.db.prv | |
7783 mv wordlist.db.new wordlist.db | |
7784 @end smallexample | |
7785 | |
7786 The @cite{Bogofilter tuning HOWTO} describes how you can fine-tune | |
7787 bogofilter. | |
7788 | |
7789 @subheading SpamProbe | |
7790 | |
7791 @cindex SpamProbe | |
7792 @cindex spam filters, SpamProbe | |
7793 | |
7794 SpamProbe is a Bayesian spam filtering program. Get it from your local | |
7795 distribution or from the @uref{http://spamprobe.sourceforge.net, | |
7796 SpamProbe web site}. | |
7797 | |
7798 To use SpamProbe, add the following recipes to @file{~/.procmailrc}: | |
7799 | |
7800 @cindex @command{formail} | |
7801 @cindex @samp{X-SpamProbe:} header field | |
7802 @cindex header field, @samp{X-SpamProbe:} | |
7803 | |
7804 @smallexample | |
7805 PATH=$PATH:/usr/bin/mh | |
7806 MAILDIR=$HOME/`mhparam Path` | |
7807 | |
7808 # Fight spam with SpamProbe. | |
7809 :0 | |
7810 SCORE=| spamprobe receive | |
7811 | |
7812 :0 wf | |
7813 | formail -I "X-SpamProbe: $SCORE" | |
7814 | |
7815 :0: | |
7816 *^X-SpamProbe: SPAM | |
7817 spam/. | |
7818 @end smallexample | |
7819 | |
7820 @findex mh-junk-blacklist | |
7821 @findex mh-junk-whitelist | |
7822 @kindex J b | |
7823 @kindex J w | |
7824 | |
7825 If SpamProbe classifies a message incorrectly, you can use the MH-E | |
7826 commands @kbd{J b} (@code{mh-junk-blacklist}) and @kbd{J w} | |
7827 (@code{mh-junk-whitelist}) to update SpamProbe's training. | |
7828 | |
7829 @subheading Other Things You Can Do | |
7830 | |
7831 There are a couple of things that you can add to @file{~/.procmailrc} | |
7832 in order to filter out a lot of spam and viruses. The first is to | |
7833 eliminate any message with a Windows executable (which is most likely | |
7834 a virus). The second is to eliminate mail in character sets that you | |
7835 can't read. | |
7836 | |
7837 @cindex @samp{Content-Transfer-Encoding:} header field | |
7838 @cindex @samp{Content-Type:} header field | |
7839 @cindex @samp{Subject:} header field | |
7840 @cindex header field, @samp{Content-Transfer-Encoding:} | |
7841 @cindex header field, @samp{Content-Type:} | |
7842 @cindex header field, @samp{Subject:} | |
7843 | |
7844 @smallexample | |
7845 PATH=$PATH:/usr/bin/mh | |
7846 MAILDIR=$HOME/`mhparam Path` | |
7847 | |
7848 # | |
7849 # Filter messages with win32 executables/virii. | |
7850 # | |
7851 # These attachments are base64 and have a TVqQAAMAAAAEAAAA//8AALg | |
7852 # pattern. The string "this program cannot be run in MS-DOS mode" | |
7853 # encoded in base64 is 4fug4AtAnNIbg and helps to avoid false | |
7854 # positives (Roland Smith via Pete from the bogofilter mailing list). | |
7855 # | |
7856 :0 B: | |
7857 * ^Content-Transfer-Encoding:.*base64 | |
7858 * ^TVqQAAMAAAAEAAAA//8AALg | |
7859 * 4fug4AtAnNIbg | |
7860 spam/exe/. | |
7861 | |
7862 # | |
7863 # Filter mail in unreadable character sets (from the Bogofilter FAQ). | |
7864 # | |
7865 UNREADABLE='[^?"]*big5|iso-2022-jp|ISO-2022-KR|euc-kr|gb2312|ks_c_5601-1987' | |
7866 | |
7867 :0: | |
7868 * 1^0 $ ^Subject:.*=\?($UNREADABLE) | |
7869 * 1^0 $ ^Content-Type:.*charset="?($UNREADABLE) | |
7870 spam/unreadable/. | |
7871 | |
7872 :0: | |
7873 * ^Content-Type:.*multipart | |
7874 * B ?? $ ^Content-Type:.*^?.*charset="?($UNREADABLE) | |
7875 spam/unreadable/. | |
7876 @end smallexample | |
7877 | |
7878 @node Miscellaneous, Scan Line Formats, Junk, Top | |
7879 @chapter Miscellaneous Commands, Variables, and Buffers | |
7880 | |
7881 This chapter covers the following command and the various MH-E | |
7882 buffers, | |
7883 | |
7884 @ftable @code | |
7885 @item mh-version | |
7886 Display version information about MH-E and the MH mail handling | |
7887 system. | |
7888 @end ftable | |
7889 | |
7890 @cindex buffers, @samp{*MH-E Info*} | |
7891 @cindex MH-E version | |
7892 @cindex @samp{*MH-E Info*} | |
7893 @cindex version | |
7894 @kindex M-x mh-version | |
7895 | |
7896 One command worth noting is @kbd{M-x mh-version}. You can compare the | |
7897 version this command prints to the latest release (@pxref{Getting | |
7898 MH-E}). The output of @kbd{M-x mh-version}, found in a buffer named | |
7899 @samp{*MH-E Info*}, should usually be included with any bug report you | |
7900 submit (@pxref{Bug Reports}). | |
7901 | |
7902 @subheading MH-E Buffers | |
7903 | |
7904 Besides the MH-Folder, MH-Show, and MH-Letter buffers, MH-E creates | |
7905 several other buffers. They are: | |
7906 | |
7907 @table @samp | |
7908 @cindex @samp{*MH-E Folders*} | |
7909 @cindex buffers, @samp{*MH-E Folders*} | |
7910 @findex mh-list-folders | |
7911 @item *MH-E Folders* | |
7912 @kindex F l | |
7913 This buffer contains the output of @kbd{F l} (@code{mh-list-folders}). | |
7914 @xref{Folders}. | |
7915 @c ------------------------- | |
7916 @cindex @samp{*MH-E Help*} | |
7917 @cindex buffers, @samp{*MH-E Help*} | |
7918 @findex mh-help | |
7919 @item *MH-E Help* | |
7920 @kindex ? | |
7921 @kindex C-c ? | |
7922 This buffer contains the output of @kbd{?} (@code{mh-help}) and | |
7923 @kbd{C-c ?} in MH-Letter mode. @xref{Using This Manual}. | |
7924 @c ------------------------- | |
7925 @cindex @samp{*MH-E Info*} | |
7926 @cindex buffers, @samp{*MH-E Info*} | |
7927 @item *MH-E Info* | |
7928 This buffer contains the output of @kbd{M-x mh-version @key{RET}}. | |
7929 @c ------------------------- | |
7930 @cindex @samp{*MH-E Log*} | |
7931 @cindex buffers, @samp{*MH-E Log*} | |
7932 @item *MH-E Log* | |
7933 This buffer contains the last 100 lines of the output of the various | |
7934 MH commands. | |
7935 @c ------------------------- | |
7936 @cindex @samp{*MH-E Mail Delivery*} | |
7937 @cindex buffers, @samp{*MH-E Mail Delivery*} | |
7938 @item *MH-E Mail Delivery* | |
7939 This buffer contains the transcript of a mail delivery. @xref{Sending | |
7940 Message}. | |
7941 @c ------------------------- | |
7942 @cindex @samp{*MH-E Recipients*} | |
7943 @cindex buffers, @samp{*MH-E Recipients*} | |
7944 @findex mh-check-whom | |
7945 @item *MH-E Recipients* | |
7946 @kindex C-c C-w | |
7947 This buffer contains the output of @kbd{C-c C-w} | |
7948 (@code{mh-check-whom}) and is killed when draft is sent. | |
7949 @xref{Checking Recipients}. | |
7950 @c ------------------------- | |
7951 @cindex @samp{*MH-E Sequences*} | |
7952 @cindex buffers, @samp{*MH-E Sequences*} | |
7953 @item *MH-E Sequences* | |
7954 This buffer contains the output of @kbd{S l} | |
7955 (@code{mh-list-sequences}). @xref{Sequences}. | |
7956 @c ------------------------- | |
7957 @cindex @samp{*mh-temp*} | |
7958 @cindex buffers, @samp{*mh-temp*} | |
7959 @item *mh-temp* | |
7960 This is a scratch, ephemeral, buffer used by MH-E functions. Note that | |
7961 it is hidden because the first character in the name is a space. | |
7962 You'll generally not have any need for this buffer. | |
7963 @end table | |
7964 | |
7965 @node Scan Line Formats, Procmail, Miscellaneous, Top | |
7966 @appendix Scan Line Formats | |
7967 | |
7968 @cindex scan line formats | |
7969 | |
7970 This appendix discusses how MH-E creates, parses, and manipulates scan | |
7971 lines. If you have your own MH scan or inc format files, you | |
7972 @strong{can} teach MH-E how to handle them, but it isn't easy as | |
7973 you'll see. | |
7974 | |
7975 @cindex @samp{mh-scan-line-formats} customization group | |
7976 @cindex customization group, @samp{mh-scan-line-formats} | |
7977 | |
7978 This table lists the options in the @samp{mh-scan-line-formats} | |
7979 customization group. | |
7980 | |
7981 @vtable @code | |
7982 @item mh-adaptive-cmd-note-flag | |
7983 On means that the message number width is determined dynamically | |
7984 (default: @samp{on}). | |
7985 @c ------------------------- | |
7986 @item mh-scan-format-file | |
7987 Specifies the format file to pass to the scan program (default: | |
7988 @samp{Use MH-E scan Format}). | |
7989 @c ------------------------- | |
7990 @item mh-scan-prog | |
7991 Program used to scan messages (default: @code{"scan"}). | |
7992 @end vtable | |
7993 | |
7994 @vindex mh-adaptive-cmd-note-flag | |
7995 | |
7996 There are a couple of caveats when creating your own scan format file. | |
7997 First, MH-E will not work if your scan lines do not include message | |
7998 numbers. It will work poorly if you don't dedicate a column for | |
7999 showing the current message and notations. You won't be able to use | |
8000 the option @code{mh-adaptive-cmd-note-flag} or the threading features | |
8001 (@pxref{Threading}). | |
8002 | |
8003 @cindex message numbers | |
8004 @findex mh-set-cmd-note | |
8005 @vindex mh-adaptive-cmd-note-flag | |
8006 @vindex mh-scan-format-file | |
8007 | |
8008 If you've created your own format to handle long message numbers, | |
8009 you'll be pleased to know you no longer need it since MH-E adapts its | |
8010 internal format based upon the largest message number if | |
8011 @code{mh-adaptive-cmd-note-flag} is on (the default). If you prefer | |
8012 fixed-width message numbers, turn off @code{mh-adaptive-cmd-note-flag} | |
8013 and call @code{mh-set-cmd-note} with the width specified by your | |
8014 format file (see @code{mh-scan-format-file}). For example, the default | |
8015 width is 4, so you would use @samp{(mh-set-cmd-note 4)}. | |
8016 | |
8017 @vindex mh-adaptive-cmd-note-flag | |
8018 @vindex mh-scan-format-file | |
8019 @vindex mh-scan-format-mh | |
8020 @vindex mh-scan-format-nmh | |
8021 | |
8022 The default setting for @code{mh-scan-format-file} is @samp{Use MH-E | |
8023 scan Format}. This means that the format string will be taken from the | |
8024 either @code{mh-scan-format-mh} or @code{mh-scan-format-nmh} depending | |
8025 on whether MH or nmh (or GNU mailutils) is in use. This setting also | |
8026 enables you to turn on the option @code{mh-adaptive-cmd-note-flag}. | |
8027 You can also set this option to @samp{Use Default scan Format} to get | |
8028 the same output as you would get if you ran @command{scan} from the | |
8029 shell. If you have a format file that you want MH-E to use but not MH, | |
8030 you can set this option to @samp{Specify a scan Format File} and enter | |
8031 the name of your format file. | |
8032 | |
8033 @vindex mh-scan-format-file | |
8034 @vindex mh-scan-format-mh | |
8035 @vindex mh-scan-format-nmh | |
8036 | |
8037 The scan format that MH-E uses when @code{mh-scan-format-file} is set | |
8038 to its default of @samp{Use MH-E scan Format} is held in the variables | |
8039 @code{mh-scan-format-nmh} and @code{mh-scan-format-mh} depending on | |
8040 whether you are using nmh (or GNU mailutils) or not. Typically, you | |
8041 create your own format files rather than modifying these variables. | |
8042 The value of @code{mh-scan-format-nmh} is: | |
8043 | |
8044 @smallexample | |
8045 (concat | |
8046 "%4(msg)" | |
8047 "%<(cur)+%| %>" | |
8048 "%<@{replied@}-" | |
8049 "%?(nonnull(comp@{to@}))%<(mymbox@{to@})t%>" | |
8050 "%?(nonnull(comp@{cc@}))%<(mymbox@{cc@})c%>" | |
8051 "%?(nonnull(comp@{bcc@}))%<(mymbox@{bcc@})b%>" | |
8052 "%?(nonnull(comp@{newsgroups@}))n%>" | |
8053 "%<(zero) %>" | |
8054 "%02(mon@{date@})/%02(mday@{date@})%<@{date@} %|*%>" | |
8055 "%<(mymbox@{from@})%<@{to@}To:%14(decode(friendly@{to@}))%>%>" | |
8056 "%<(zero)%17(decode(friendly@{from@}))%> " | |
8057 "%(decode@{subject@})%<@{body@}<<%@{body@}%>") | |
8058 @end smallexample | |
8059 | |
8060 @cindex decoding RFC 2047 | |
8061 @cindex RFC 2047, decoding | |
8062 @vindex mh-scan-format-mh | |
8063 | |
8064 The setting for @code{mh-scan-format-mh} is similar, except that MH | |
8065 doesn't have the function @code{decode} (which is used to decode RFC | |
8066 2047 encodings). | |
8067 | |
8068 @cindex notations, scan line | |
8069 @cindex scan line notations | |
8070 | |
8071 These strings are passed to the @command{scan} program via the | |
8072 @option{-format} argument. The formats are identical to the defaults | |
8073 except that additional hints for fontification have been added to the | |
8074 existing notations in the fifth column (remember that in Emacs, the | |
8075 columns start at 0). The values of the fifth column, in priority | |
8076 order, are: @samp{-} if the message has been replied to, @samp{t} if | |
8077 an address in the @samp{To:} field matches one of the mailboxes of the | |
8078 current user, @samp{c} if the @samp{Cc:} field matches, @samp{b} if | |
8079 the @samp{Bcc:} field matches, and @samp{n} if a non-empty | |
8080 @samp{Newsgroups:} field is present. | |
8081 | |
8082 @cindex @command{scan} | |
8083 @cindex MH commands, @command{scan} | |
8084 @vindex mh-progs | |
8085 @vindex mh-scan-prog | |
8086 | |
8087 The name of the program that generates a listing of one line per | |
8088 message is held in @code{mh-scan-prog} (default: @code{"scan"}). | |
8089 Unless this variable contains an absolute pathname, it is assumed to | |
8090 be in the @code{mh-progs} directory (@pxref{Getting Started}). You may | |
8091 link another program to @command{scan} (see @samp{mh-profile}(5)) to | |
8092 produce a different type of listing@footnote{See the section | |
8093 @uref{@value{MH-BOOK-HOME}/faswsprs.html, Find and Specify with scan | |
8094 pick Ranges Sequences} in the MH book.}. | |
8095 | |
8096 @cindex regular expressions, scan line formats | |
8097 @findex mh-set-cmd-note | |
8098 @findex setq | |
8099 | |
8100 If you change the format of the scan lines you'll need to tell MH-E | |
8101 how to parse the new format. As you will see, quite a lot of variables | |
8102 are involved to do that. Use @kbd{M-x apropos @key{RET} | |
8103 mh-scan.*regexp @key{RET}} to obtain a list of these variables. You | |
8104 will also have to call @code{mh-set-cmd-note} if your notations are | |
8105 not in column 4 (columns in Emacs start with 0). Note that unlike most | |
8106 of the user options described in this manual, these are variables and | |
8107 must be set with @code{setq} instead of in a customization buffer. For | |
8108 help with regular expressions, see | |
8109 @ifnothtml | |
8110 @ref{Regexps, , Syntax of Regular Expressions, emacs, The | |
8111 GNU Emacs Manual}. | |
8112 @end ifnothtml | |
8113 @ifhtml | |
8114 section | |
8115 @uref{http://www.gnu.org/software/emacs/manual/html_node/Regexps.html, | |
8116 Syntax of Regular Expressions} in @cite{The GNU Emacs Manual}. | |
8117 @end ifhtml | |
8118 | |
8119 The first variable has to do with pruning out garbage. | |
8120 | |
8121 @vtable @code | |
8122 @cindex @command{inc} | |
8123 @cindex MH commands, @command{inc} | |
8124 @cindex @command{scan} | |
8125 @cindex MH commands, @command{scan} | |
8126 @item mh-scan-valid-regexp | |
8127 This regular expression describes a valid scan line. This is used to | |
8128 eliminate error messages that are occasionally produced by | |
8129 @command{inc}@footnote{See the section | |
8130 @uref{@value{MH-BOOK-HOME}/reapre.html, Reading Mail: inc show next | |
8131 prev} in the MH book.} or @command{scan} (default: @code{"^ *[0-9]"}). | |
8132 @end vtable | |
8133 | |
8134 Next, many variables control how the scan lines are parsed. | |
8135 | |
8136 @vtable @code | |
8137 @vindex mh-folder-body | |
8138 @vindex mh-folder-font-lock-keywords | |
8139 @item mh-scan-body-regexp | |
8140 This regular expression matches the message body fragment. Note that | |
8141 the default setting of @code{mh-folder-font-lock-keywords} expects | |
8142 this expression to contain at least one parenthesized expression which | |
8143 matches the body text as in the default of | |
8144 @code{"\\(<<\\([^\n]+\\)?\\)"}. If this regular expression is not | |
8145 correct, the body fragment will not be highlighted with the face | |
8146 @code{mh-folder-body}. | |
8147 @c ------------------------- | |
8148 @vindex mh-folder-cur-msg-number | |
8149 @vindex mh-folder-font-lock-keywords | |
8150 @vindex mh-note-cur | |
8151 @item mh-scan-cur-msg-number-regexp | |
8152 This regular expression matches the current message. It must match | |
8153 from the beginning of the line. Note that the default setting of | |
8154 @code{mh-folder-font-lock-keywords} expects this expression to contain | |
8155 at least one parenthesized expression which matches the message number | |
8156 as in the default of @w{@code{"^\\( *[0-9]+\\+\\).*"}}. This | |
8157 expression includes the leading space and current message marker | |
8158 @samp{+} within the parenthesis since it looks better to highlight | |
8159 these items as well. The highlighting is done with the face | |
8160 @code{mh-folder-cur-msg-number}. This regular expression should be | |
8161 correct as it is needed by non-fontification functions. See also | |
8162 @code{mh-note-cur}. | |
8163 @c ------------------------- | |
8164 @vindex mh-folder-date | |
8165 @vindex mh-folder-font-lock-keywords | |
8166 @vindex mh-scan-sent-to-me-sender-regexp | |
8167 @item mh-scan-date-regexp | |
8168 This regular expression matches a valid date. It must @strong{not} be | |
8169 anchored to the beginning or the end of the line. Note that the | |
8170 default setting of @code{mh-folder-font-lock-keywords} expects this | |
8171 expression to contain only one parenthesized expression which matches | |
8172 the date field as in the default of | |
8173 @code{"\\([0-9][0-9]/[0-9][0-9]\\)"}. If this regular expression is | |
8174 not correct, the date will not be highlighted with the face | |
8175 @code{mh-folder-date}. | |
8176 @c ------------------------- | |
8177 @vindex mh-folder-deleted | |
8178 @vindex mh-folder-font-lock-keywords | |
8179 @vindex mh-note-deleted | |
8180 @item mh-scan-deleted-msg-regexp | |
8181 This regular expression matches deleted messages. It must match from | |
8182 the beginning of the line. Note that the default setting of | |
8183 @code{mh-folder-font-lock-keywords} expects this expression to contain | |
8184 at least one parenthesized expression which matches the message number | |
8185 as in the default of @code{"^\\( *[0-9]+\\)D"}. This expression | |
8186 includes the leading space within the parenthesis since it looks | |
8187 better to highlight it as well. The highlighting is done with the face | |
8188 @code{mh-folder-deleted}. This regular expression should be correct as | |
8189 it is needed by non-fontification functions. See also | |
8190 @code{mh-note-deleted}. | |
8191 @c ------------------------- | |
8192 @vindex mh-folder-font-lock-keywords | |
8193 @vindex mh-folder-msg-number | |
8194 @item mh-scan-good-msg-regexp | |
8195 This regular expression matches ``good'' messages. It must match from | |
8196 the beginning of the line. Note that the default setting of | |
8197 @code{mh-folder-font-lock-keywords} expects this expression to contain | |
8198 at least one parenthesized expression which matches the message number | |
8199 as in the default of @w{@code{"^\\( *[0-9]+\\)[^D^0-9]"}}. This | |
8200 expression includes the leading space within the parenthesis since it | |
8201 looks better to highlight it as well. The highlighting is done with | |
8202 the face @code{mh-folder-msg-number}. This regular expression should | |
8203 be correct as it is needed by non-fontification functions. | |
8204 @c ------------------------- | |
8205 @vindex mh-scan-format-file | |
8206 @item mh-scan-msg-format-regexp | |
8207 This regular expression finds the message number width in a scan | |
8208 format. Note that the message number must be placed in a parenthesized | |
8209 expression as in the default of @code{"%\\([0-9]*\\)(msg)"}. This | |
8210 variable is only consulted if @code{mh-scan-format-file} is set to | |
8211 @samp{Use MH-E scan Format}. | |
8212 @c ------------------------- | |
8213 @vindex mh-scan-format-file | |
8214 @item mh-scan-msg-format-string | |
8215 This is a format string for the width of the message number in a scan | |
8216 format. Use @samp{0%d} for zero-filled message numbers. This variable | |
8217 is only consulted if @code{mh-scan-format-file} is set to @samp{Use | |
8218 MH-E scan Format} (default: @code{"%d"}). | |
8219 @c ------------------------- | |
8220 @item mh-scan-msg-number-regexp | |
8221 This regular expression extracts the message number. It must match | |
8222 from the beginning of the line. Note that the message number must be | |
8223 placed in a parenthesized expression as in the default of @w{@code{"^ | |
8224 *\\([0-9]+\\)"}}. | |
8225 @c ------------------------- | |
8226 @item mh-scan-msg-overflow-regexp | |
8227 This regular expression matches overflowed message numbers (default: | |
8228 @code{"^[?0-9][0-9]"}). | |
8229 @c ------------------------- | |
8230 @item mh-scan-msg-search-regexp | |
8231 This regular expression matches a particular message. It is a format | |
8232 string; use @samp{%d} to represent the location of the message number | |
8233 within the expression as in the default of @code{"^[^0-9]*%d[^0-9]"}. | |
8234 @c ------------------------- | |
8235 @vindex mh-folder-address | |
8236 @vindex mh-folder-font-lock-keywords | |
8237 @vindex mh-folder-to | |
8238 @item mh-scan-rcpt-regexp | |
8239 This regular expression specifies the recipient in messages you sent. | |
8240 Note that the default setting of @code{mh-folder-font-lock-keywords} | |
8241 expects this expression to contain two parenthesized expressions. The | |
8242 first is expected to match the @samp{To:} that the default scan format | |
8243 file generates. The second is expected to match the recipient's name | |
8244 as in the default of @code{"\\(To:\\)\\(..............\\)"}. If this | |
8245 regular expression is not correct, the @samp{To:} string will not be | |
8246 highlighted with the face @code{mh-folder-to} and the recipient will not be | |
8247 highlighted with the face @code{mh-folder-address}. | |
8248 @c ------------------------- | |
8249 @vindex mh-folder-font-lock-keywords | |
8250 @vindex mh-folder-refiled | |
8251 @vindex mh-note-refiled | |
8252 @item mh-scan-refiled-msg-regexp | |
8253 This regular expression matches refiled messages. It must match from | |
8254 the beginning of the line. Note that the default setting of | |
8255 @code{mh-folder-font-lock-keywords} expects this expression to contain | |
8256 at least one parenthesized expression which matches the message number | |
8257 as in the default of @w{@code{"^\\( *[0-9]+\\)\\^"}}. This expression | |
8258 includes the leading space within the parenthesis since it looks | |
8259 better to highlight it as well. The highlighting is done with the face | |
8260 @code{mh-folder-refiled}. This regular expression should be correct as | |
8261 it is needed by non-fontification functions. See also | |
8262 @code{mh-note-refiled}. | |
8263 @c ------------------------- | |
8264 @vindex mh-folder-font-lock-keywords | |
8265 @vindex mh-folder-sent-to-me-sender | |
8266 @vindex mh-mh-folder-sent-to-me-hint | |
8267 @vindex mh-scan-format-nmh | |
8268 @item mh-scan-sent-to-me-sender-regexp | |
8269 This regular expression matches messages sent to us. Note that the | |
8270 default setting of @code{mh-folder-font-lock-keywords} expects this | |
8271 expression to contain at least two parenthesized expressions. The | |
8272 first should match the fontification hint (see | |
8273 @code{mh-scan-format-nmh}) and the second should match the user name | |
8274 as in the default of | |
8275 @w{@code{"^ *[0-9]+.\\([bct]\\).....[ ]*\\(..................\\)"}}. | |
8276 If this regular expression is not correct, the notation hints will not | |
8277 be highlighted with the face @code{mh-mh-folder-sent-to-me-hint} and | |
8278 the sender will not be highlighted with the face | |
8279 @code{mh-folder-sent-to-me-sender}. | |
8280 @c ------------------------- | |
8281 @vindex mh-folder-followup | |
8282 @vindex mh-folder-font-lock-keywords | |
8283 @vindex mh-folder-subject | |
8284 @item mh-scan-subject-regexp | |
8285 This regular expression matches the subject. It must match from the | |
8286 beginning of the line. Note that the default setting of | |
8287 @samp{mh-folder-font-lock-keywords} expects this expression to contain | |
8288 at least three parenthesized expressions. The first is expected to | |
8289 match the @samp{Re:} string, if any, and is highlighted with the face | |
8290 @code{mh-folder-followup}. The second matches an optional bracketed | |
8291 number after @samp{Re:}, such as in @samp{Re[2]:} (and is thus a | |
8292 sub-expression of the first expression). The third is expected to | |
8293 match the subject line itself which is highlighted with the face | |
8294 @code{mh-folder-subject}. For example, the default is | |
8295 @w{@code{"^ *[0-9]+........[ ]*...................}}@* | |
8296 @w{@code{\\([Rr][Ee]\\(\\[[0-9]+\\]\\)?:\\s-*\\)*\\([^<\n]*\\)"}}. | |
8297 This regular expression should be correct as it is needed by | |
8298 non-fontification functions. Note that this example is broken up on | |
8299 two lines for readability, but is actually a single string. | |
8300 @end vtable | |
8301 | |
8302 Finally, there are a slew of variables that control how MH-E annotates | |
8303 the scan lines. | |
8304 | |
8305 @vtable @code | |
8306 @findex mh-set-cmd-note | |
8307 @vindex mh-adaptive-cmd-note-flag | |
8308 @item mh-cmd-note | |
8309 Column for notations (default: 4). This variable should be set with | |
8310 the function @code{mh-set-cmd-note}. This variable may be updated | |
8311 dynamically if @code{mh-adaptive-cmd-note-flag} is on. The following | |
8312 variables contain the notational characters. Note that columns in | |
8313 Emacs start with 0. | |
8314 @c ------------------------- | |
8315 @item mh-note-copied | |
8316 Messages that have been copied are marked by this character (default: | |
8317 @code{?C}). | |
8318 @c ------------------------- | |
8319 @vindex mh-scan-cur-msg-number-regexp | |
8320 @item mh-note-cur | |
8321 The current message (in MH, not in MH-E) is marked by this character | |
8322 (default: @code{?+}). See also @code{mh-scan-cur-msg-number-regexp}. | |
8323 @c ------------------------- | |
8324 @vindex mh-scan-deleted-msg-regexp | |
8325 @item mh-note-deleted | |
8326 Messages that have been deleted are marked by this character (default: | |
8327 @code{?D}). See also @code{mh-scan-deleted-msg-regexp}. | |
8328 @c ------------------------- | |
8329 @item mh-note-dist | |
8330 Messages that have been redistributed are marked by this character | |
8331 (default: @code{?R}). | |
8332 @c ------------------------- | |
8333 @item mh-note-forw | |
8334 Messages that have been forwarded are marked by this character | |
8335 (default: @code{?F}). | |
8336 @c ------------------------- | |
8337 @item mh-note-printed | |
8338 Messages that have been printed are marked by this character (default: | |
8339 @code{?P}). | |
8340 @c ------------------------- | |
8341 @vindex mh-scan-refiled-msg-regexp | |
8342 @item mh-note-refiled | |
8343 Messages that have been refiled are marked by this character (default: | |
8344 @code{?^}). See also @code{mh-scan-refiled-msg-regexp}. | |
8345 @c ------------------------- | |
8346 @item mh-note-repl | |
8347 Messages that have been replied to are marked by this character | |
8348 (default: @code{?-}). | |
8349 @c ------------------------- | |
8350 @item mh-note-seq | |
8351 Messages in a user-defined sequence are marked by this character | |
8352 (default: @code{?%}). Messages in the @samp{search} sequence are | |
8353 marked by this character as well. | |
8354 @end vtable | |
8355 | |
8356 For example, let's say I have the following in @file{scan.format} | |
8357 which displays the sender, the subject, and the message number. This | |
8358 format places a @samp{+} after the message number for the current | |
8359 message according to MH; it also uses that column for notations. | |
8360 | |
8361 @smallexample | |
8362 %20(decode(friendly@{from@})) %50(decode@{subject@}) %4(msg)%<(cur)+%| %> | |
8363 @end smallexample | |
8364 | |
8365 @vindex mh-adaptive-cmd-note-flag | |
8366 @vindex mh-scan-format-file | |
8367 @vindex mh-scan-format-file, example | |
8368 | |
8369 The first thing you have to do is tell MH-E to use this file. | |
8370 Customize @code{mh-scan-format-file} and set its value to @samp{Use | |
8371 Default scan Format}. If you didn't get already turn off | |
8372 @code{mh-adaptive-cmd-note-flag}, you'll need to do that first. | |
8373 | |
8374 Next, tell MH-E what a valid scan line looks like so that you can at | |
8375 least display the output of scan in your MH-Folder buffer. | |
8376 | |
8377 @vindex mh-scan-valid-regexp, example | |
8378 | |
8379 @smalllisp | |
8380 (setq mh-scan-valid-regexp "[0-9]+[+D^ ]$") | |
8381 @end smalllisp | |
8382 | |
8383 Now, in order to get rid of the @samp{Cursor not pointing to message} | |
8384 message, you need to tell MH-E how to access the message number. You | |
8385 should also see why MH-E requires that you include a message number in | |
8386 the first place. | |
8387 | |
8388 @vindex mh-scan-msg-number-regexp, example | |
8389 @vindex mh-scan-msg-search-regexp, example | |
8390 | |
8391 @smalllisp | |
8392 (setq mh-scan-msg-number-regexp "^.* \\([0-9]+\\)[+D^ ]$") | |
8393 (setq mh-scan-msg-search-regexp " %d[+D^ ]$") | |
8394 @end smalllisp | |
8395 | |
8396 In order to get the next and previous commands working, add this. | |
8397 | |
8398 @vindex mh-scan-good-msg-regexp, example | |
8399 | |
8400 @smalllisp | |
8401 (setq mh-scan-good-msg-regexp "^.* \\([0-9]+\\)[+D^ ]$") | |
8402 @end smalllisp | |
8403 | |
8404 Note that the current message isn't marked with a @samp{+} when moving | |
8405 between the next and previous messages. Here is the code required to | |
8406 get this working. | |
8407 | |
8408 @vindex set-mh-cmd-note, example | |
8409 @vindex mh-scan-cur-msg-number-regexp, example | |
8410 | |
8411 @smalllisp | |
8412 (set-mh-cmd-note 76) | |
8413 (setq mh-scan-cur-msg-number-regexp "^.* \\([0-9]+\\)\\+$") | |
8414 @end smalllisp | |
8415 | |
8416 Finally, add the following to delete and refile messages. | |
8417 | |
8418 @vindex mh-scan-deleted-msg-regexp, example | |
8419 @vindex mh-scan-refiled-msg-regexp, example | |
8420 | |
8421 @smalllisp | |
8422 (setq mh-scan-deleted-msg-regexp "^.* \\([0-9]+\\)D$") | |
8423 (setq mh-scan-refiled-msg-regexp "^.* \\([0-9]+\\)\\^$") | |
8424 @end smalllisp | |
8425 | |
8426 This is just a bare minimum; it's best to adjust all of the regular | |
8427 expressions to ensure that MH-E and highlighting perform well. | |
8428 | |
8429 @node Procmail, Odds and Ends, Scan Line Formats, Top | |
8430 @appendix Reading Mailing Lists Effectively | |
8431 | |
8432 @cindex @command{procmail} | |
8433 @cindex @command{slocal} | |
8434 @cindex Gnus | |
8435 @cindex MH commands, @command{slocal} | |
8436 @cindex Unix commands, @command{procmail} | |
8437 @cindex mailing lists, reading | |
8438 | |
8439 This appendix explains how to use @uref{http://www.procmail.org/, | |
8440 procmail} to file mail from mailing lists into folders which can then | |
8441 be read easily with MH-E@footnote{The MH equivalent, @command{slocal}, | |
8442 can be used as well, but procmail is more flexible and more packages | |
8443 exist for procmail than for slocal.}. Some mailing lists have such | |
8444 high traffic that Gnus must be used and I discuss how to use Gnus | |
8445 side-by-side with MH-E. | |
8446 | |
8447 @cindex @file{.procmailrc} | |
8448 @cindex files, @file{.procmailrc} | |
8449 | |
8450 First, I'll describe how to put mail from your mailing lists directly | |
8451 into an MH folder using @command{procmail}. First, add the following | |
8452 to @file{~/.procmailrc}. While the logging variables aren't strictly | |
8453 necessary, they are extremely useful. | |
8454 | |
8455 @smallexample | |
8456 [1] # Update PATH so procmail can find myrcvstore, rcvstore and mhparam. | |
8457 [2] PATH=$PATH:/usr/lib/mh:/usr/bin/mh:$HOME/bin | |
8458 [3] | |
8459 [4] # Point LOGFILE at the actual log file. | |
8460 [5] LOGFILE=$HOME/.procmail.log | |
8461 [6] | |
8462 [7] # This setting provides just the right amount of information. | |
8463 [8] LOGABSTRACT=all | |
8464 [9] | |
8465 [10] # Uncomment the following line to see how your patterns match. | |
8466 [11] #VERBOSE=yes | |
8467 [12] | |
8468 [13] # Place mail sent to any MH-E mailing list in +mh-e. | |
8469 [14] :0 w: mh-e$LOCKEXT | |
8470 [15] * ^TO.*mh-e-.*@.*sourceforge.net | |
8471 [16] | myrcvstore -create +mh-e | |
8472 @end smallexample | |
8473 | |
8474 @cindex @command{rcvstore} | |
8475 @cindex MH commands, @command{rcvstore} | |
8476 | |
8477 Line 14 creates a lock file in your mail directory based upon the name | |
8478 of the folder. This is done because @command{rcvstore} does not | |
8479 perform locking. While this lock file will prevent @command{procmail} | |
8480 from writing to a folder concurrently, there is a slight chance that | |
8481 you might lose a message if you're performing operations on a folder | |
8482 at the same time @command{rcvstore} is placing a message there. You | |
8483 have been warned. Now that that disclaimer is out of the way, note | |
8484 that I've been using this set-up for over a decade and haven't lost | |
8485 anything to my knowledge@footnote{See | |
8486 @uref{https://savannah.nongnu.org/bugs/?func=detailbug&bug_id=4361&group_id=2166, | |
8487 Savannah issue #4361} to see if @command{rcvstore} locking is still an | |
8488 issue.}. | |
8489 | |
8490 @cindex @samp{Unseen-Sequence:} MH profile component | |
8491 @cindex MH profile component, @samp{Unseen-Sequence:} | |
8492 | |
8493 Line 16 uses the following script, @code{myrcvstore}, to massage the | |
8494 message as described in the comment and file the message in the given | |
8495 folder@footnote{The @samp{-create} argument wasn't always the default | |
8496 to @command{rcvstore}.}. | |
8497 | |
8498 @smallexample | |
8499 #! /bin/sh | |
8500 | |
8501 # Accepts a message on standard input and passes it through rcvstore | |
8502 # after first passing it through any filters. All arguments are passed | |
8503 # on to rcvstore. | |
8504 | |
8505 # Force the "From user date" to become part of header. One reason this | |
8506 # is done is because the presence of the From field confuses dist so | |
8507 # that dist adds a new header, rather than using the existing header. | |
8508 # Note that this should not be done for any message that goes into a | |
8509 # Gnus incoming file (Gnus will thrown an error) nor should it be | |
8510 # applied to any message that goes to the system mailbox because the | |
8511 # entire mailbox will be incorporated as a single message. | |
8512 formail -c -z -R 'From ' X-Envelope-From: | | |
8513 rcvstore $@@ | |
8514 @end smallexample | |
8515 | |
8516 If your version of @command{rcvstore} doesn't add messages to the | |
8517 @samp{unseen} sequence by default, add the following line to your MH | |
8518 profile: | |
8519 | |
8520 @smallexample | |
8521 Unseen-Sequence: unseen | |
8522 @end smallexample | |
8523 | |
8524 Now view your new messages with the speedbar (@pxref{Speedbar}) or with | |
8525 @kbd{F n} (@code{mh-index-new-messages}). @xref{Folders}. | |
8526 | |
8527 If you're on a mailing list that is so voluminous that it is | |
8528 impossible to read every message, it usually better to read the | |
8529 mailing list like a newsgroup in a news reader. Emacs has a built-in | |
8530 newsreader called Gnus. The remainder of this appendix talks about how | |
8531 to use Gnus with an MH message store. The version of Gnus that was | |
8532 used to prepare this manual was 5.10. Versions 5.8 through 5.10 should | |
8533 work but versions prior to 5.8 use different options. | |
8534 | |
8535 This table contains a list of Gnus options that you will have to | |
8536 modify. Note that for them to become accessible, you'll have to load | |
8537 @file{nnml.el} first. This can be done with @kbd{M-x load-library | |
8538 @key{RET} nnml @key{RET}}. | |
8539 | |
8540 @vtable @code | |
8541 @item gnus-secondary-select-methods | |
8542 Select the @samp{nnml} value. This select method uses directories for | |
8543 folders and individual files for messages, just like MH. You do not | |
8544 have to set an address. | |
8545 @c ------------------------- | |
8546 @item mail-sources | |
8547 Select the @samp{Several files in a directory} value, check the | |
8548 @samp{Path} box and enter @file{~/Mail} to tell Gnus where to find | |
8549 your mail. | |
8550 @c ------------------------- | |
8551 @vindex mail-user-agent | |
8552 @item message-mail-user-agent | |
8553 In order to send mail within Gnus using MH-E, set this option to | |
8554 @samp{mail-user-agent} and set the @code{mail-user-agent} option to | |
8555 @samp{Emacs interface to MH}. | |
8556 @c ------------------------- | |
8557 @item nnmail-keep-last-article | |
8558 Since Gnus keeps track of which messages you have read, it would be | |
8559 bad if Gnus expired the last message, for example, message 100, and | |
8560 @command{rcvstore} gave the next new message number 1. Gnus would then | |
8561 ignore it since it thinks that you've read messages 1-100. Turning on | |
8562 this option ensures that the last message is never removed thereby | |
8563 eliminating this problem. | |
8564 @end vtable | |
8565 | |
8566 Next add the following to @file{~/.procmailrc}. If you don't subscribe | |
8567 to the GnuCash mailing list, substitute one to which you are | |
8568 subscribed. | |
8569 | |
8570 @smallexample | |
8571 PATH=$PATH:/usr/bin/mh | |
8572 MAILDIR=$HOME/`mhparam Path` | |
8573 # Place mail sent to the GnuCash mailing list in gnucash.spool, where | |
8574 # Gnus will pick it up. | |
8575 :0: | |
8576 * ^TO.*gnucash.*@.*gnucash.org | |
8577 gnucash.spool | |
8578 @end smallexample | |
8579 | |
8580 Wait for some messages to appear in @file{gnucash.spool} and run Gnus | |
8581 with @kbd{M-x gnus @key{RET}}. To view the folder created in the | |
8582 example above, you would tell Gnus about it the first time only with | |
8583 @kbd{G m gnucash @key{RET} nnml @key{RET}}. In MH-E, this folder is | |
8584 known as @samp{+gnucash}. | |
8585 | |
8586 @node Odds and Ends, History, Procmail, Top | |
8587 @appendix Odds and Ends | |
8588 | |
8589 This appendix covers a few topics that don't fit elsewhere. Here I | |
8590 tell you how to report bugs and how to get on the MH-E mailing lists. | |
8591 I also point out some additional sources of information. | |
8592 | |
8593 @menu | |
8594 * Bug Reports:: | |
8595 * Mailing Lists:: | |
8596 * MH FAQ and Support:: | |
8597 * Getting MH-E:: | |
8598 @end menu | |
8599 | |
8600 @node Bug Reports, Mailing Lists, Odds and Ends, Odds and Ends | |
8601 @appendixsec Bug Reports | |
8602 | |
8603 @cindex bugs | |
8604 @cindex SourceForge | |
8605 @kindex M-x mh-version | |
8606 | |
8607 Bug reports should be filed at | |
8608 @uref{https://sourceforge.net/tracker/?group_id=13357&atid=113357, | |
8609 SourceForge}. You need to be a SourceForge user to submit bug reports, | |
8610 but this is easy enough to do that it shouldn't be a restriction for | |
8611 you. Please include the output of @kbd{M-x mh-version} | |
8612 (@pxref{Miscellaneous}) in any bug report you send unless you're 110% | |
8613 positive we won't ask for it. | |
8614 | |
8615 @node Mailing Lists, MH FAQ and Support, Bug Reports, Odds and Ends | |
8616 @appendixsec MH-E Mailing Lists | |
8617 | |
8618 @cindex SourceForge | |
8619 @cindex mailing lists | |
8620 | |
8621 There are several mailing lists for MH-E. They are @i{mh-e-users at | |
8622 lists.sourceforge.net}, @i{mh-e-announce at lists.sourceforge.net}, | |
8623 and @i{mh-e-devel at lists.sourceforge.net}. You can subscribe or view | |
8624 the archives at @uref{https://sourceforge.net/mail/?group_id=13357, | |
8625 SourceForge}. Do not report bugs on these lists; please submit them | |
8626 via SourceForge (@pxref{Bug Reports}). | |
8627 | |
8628 @node MH FAQ and Support, Getting MH-E, Mailing Lists, Odds and Ends | |
8629 @appendixsec MH FAQ and Support | |
8630 | |
8631 @cindex FAQ | |
8632 @cindex MH FAQ | |
8633 | |
8634 The article @uref{http://www.newt.com/faq/mh.html, @cite{MH Frequently | |
8635 Asked Questions (FAQ) with Answers}} appears monthly in the newsgroup | |
8636 @samp{comp.mail.mh}. While very little is there that deals with MH-E | |
8637 specifically, there is an incredible wealth of material about MH | |
8638 itself which you will find useful. | |
8639 | |
8640 @cindex support | |
8641 | |
8642 You can find FAQs on MH-E at the | |
8643 @uref{https://sourceforge.net/tracker/?group_id=13357&atid=213357, | |
8644 Support Requests} page on SourceForge. If you don't find the answer to | |
8645 your question, file a support request and your question will become a | |
8646 new FAQ! | |
8647 | |
8648 @node Getting MH-E, , MH FAQ and Support, Odds and Ends | |
8649 @appendixsec Getting MH-E | |
8650 | |
8651 @cindex MH-E, obtaining | |
8652 @cindex getting MH-E | |
8653 @cindex obtaining MH-E | |
8654 | |
8655 Because MH-E is undergoing a phase of sustained growth, the version of | |
8656 MH-E in your Emacs is likely to be out of date although it is most | |
8657 likely to be more up to date than the copy that comes with the MH | |
8658 distribution in @file{miscellany/mh-e}. | |
8659 | |
8660 @cindex change log | |
8661 @cindex release notes | |
8662 | |
8663 New MH-E releases are always available for downloading at | |
8664 @uref{https://sourceforge.net/project/showfiles.php?group_id=13357, | |
8665 SourceForge} before they appear in an Emacs release. You can read the | |
8666 release notes on that page to determine if the given release of MH-E | |
8667 is already installed in your version of Emacs. You can also read the | |
8668 change log to see if you are interested in what the given release of | |
8669 MH-E has to offer (although we have no doubt that you will be | |
8670 extremely interested in all new releases). | |
8671 | |
8672 @cindex Debian | |
8673 | |
8674 If you use Debian, you can install the Debian | |
8675 @uref{http://packages.debian.org/unstable/mail/mh-e, mh-e package} | |
8676 instead. | |
8677 | |
8678 @cindex files, @samp{MH-E-NEWS} | |
8679 @cindex files, @samp{README} | |
8680 @cindex news | |
8681 @cindex @samp{MH-E-NEWS} | |
8682 @cindex @samp{README} | |
8683 @kindex M-x mh-version | |
8684 | |
8685 After you download and extract the MH-E tarball, read the | |
8686 @file{README} file and @file{MH-E-NEWS}. These correspond to the | |
8687 release notes and change log mentioned above. The file @file{README} | |
8688 contains instructions on installing MH-E. If you're already running | |
8689 Emacs, please quit that session and start again to load in the new | |
8690 MH-E. Check that you're running the new version with the command | |
8691 @kbd{M-x mh-version}. | |
8692 | |
8693 @cindex contributed software | |
8694 @cindex manual | |
8695 @cindex documentation | |
8696 | |
8697 In addition to the mh-e package, the | |
8698 @uref{https://sourceforge.net/project/showfiles.php?group_id=13357, | |
8699 SourceForge} site also contains doc and contrib packages. The former | |
8700 is the latest release of this manual, and the latter contains a few | |
8701 contributed packages you might find useful. | |
8702 | |
8703 @node History, GFDL, Odds and Ends, Top | |
8704 @appendix History of MH-E | |
8705 | |
8706 @cindex Bill Wohler | |
8707 @cindex Brian Reid | |
8708 @cindex Gildea, Stephen | |
8709 @cindex Jim Larus | |
8710 @cindex Larus, Jim | |
8711 @cindex MH-E, versions | |
8712 @cindex Reid, Brian | |
8713 @cindex SourceForge | |
8714 @cindex Stephen Gildea | |
8715 @cindex Wohler, Bill | |
8716 @cindex history of MH-E | |
8717 @cindex versions of MH-E | |
8718 | |
8719 MH-E was originally written by Brian Reid in 1983 and has changed | |
8720 hands several times since then. Jim Larus wanted to do something | |
8721 similar for GNU Emacs, and ended up completely rewriting it that same | |
8722 year. In 1989, Stephen Gildea picked it up and added many | |
8723 improvements. Bill Wohler then took over in 2000 and moved its | |
8724 development to @uref{http://sourceforge.net/, SourceForge} where it | |
8725 lives today. | |
8726 | |
8727 @menu | |
8728 * From Brian Reid:: | |
8729 * From Jim Larus:: | |
8730 * From Stephen Gildea:: | |
8731 * From Bill Wohler:: | |
8732 @end menu | |
8733 | |
8734 @node From Brian Reid, From Jim Larus, History, History | |
8735 @appendixsec From Brian Reid | |
8736 | |
8737 @cindex Brian Reid | |
8738 @cindex Reid, Brian | |
8739 | |
8740 One day in 1983 I got the flu and had to stay home from work for three | |
8741 days with nothing to do. I used that time to write MHE@. The | |
8742 fundamental idea behind MHE was that it was a ``puppeteer'' driving | |
8743 the MH programs underneath it. MH had a model that the editor was | |
8744 supposed to run as a sub-process of the mailer, which seemed to me at | |
8745 the time to be the tail wagging the dog. So I turned it around and | |
8746 made the editor drive the MH programs. I made sure that the UCI people | |
8747 (who were maintaining MH at the time) took in my changes and made them | |
8748 stick. | |
8749 | |
8750 Today, I still use my own version of MHE because I don't at all like | |
8751 the way that GNU MH-E works and I've never gotten to be good enough at | |
8752 hacking Emacs Lisp to make GNU MH-E do what I want. The Gosling-emacs | |
8753 version of MHE and the GNU Emacs version of MH-E have almost nothing | |
8754 in common except similar names. They work differently, have different | |
8755 conceptual models, and have different key bindings@footnote{After | |
8756 reading this article, I questioned Brian about his version of MHE, and | |
8757 received some great ideas for improving MH-E such as a dired-like | |
8758 method of selecting folders; and removing the prompting when sending | |
8759 mail, filling in the blanks in the draft buffer instead. I passed them | |
8760 on to Stephen Gildea, the current maintainer, and he was excited about | |
8761 the ideas as well. Perhaps one day, MH-E will again resemble MHE | |
8762 (draft form editing was introduced in version 7.4).}. | |
8763 | |
8764 Brian Reid, June 1994 | |
8765 | |
8766 @node From Jim Larus, From Stephen Gildea, From Brian Reid, History | |
8767 @appendixsec From Jim Larus | |
8768 | |
8769 @cindex Jim Larus | |
8770 @cindex Larus, Jim | |
8771 | |
8772 Brian Reid, while at CMU or shortly after going to Stanford wrote a | |
8773 mail reading program called MHE for Gosling Emacs. It had much the | |
8774 same structure as MH-E (i.e., invoked MH programs), though it was | |
8775 simpler and the commands were slightly different. Unfortunately, I no | |
8776 longer have a copy so the differences are lost in the mists of time. | |
8777 | |
8778 In '82-83, I was working at BBN and wrote a lot of mlisp code in | |
8779 Gosling Emacs to make it look more like Tennex Emacs. One of the | |
8780 packages that I picked up and improved was Reid's mail system. In '83, | |
8781 I went back to Berkeley. About that time, Stallman's first version of | |
8782 GNU Emacs came out and people started to move to it from Gosling Emacs | |
8783 (as I recall, the transition took a year or two). I decided to port | |
8784 Reid's MHE and used the mlisp to Emacs Lisp translator that came with | |
8785 GNU Emacs. It did a lousy job and the resulting code didn't work, so I | |
8786 bit the bullet and rewrote the code by hand (it was a lot smaller and | |
8787 simpler then, so it took only a day or two). | |
8788 | |
8789 Soon after that, MH-E became part of the standard Emacs distribution | |
8790 and suggestions kept dribbling in for improvements. MH-E soon reached | |
8791 sufficient functionality to keep me happy, but I kept on improving it | |
8792 because I was a graduate student with plenty of time on my hands and | |
8793 it was more fun than my dissertation. In retrospect, the one thing | |
8794 that I regret is not writing any documentation, which seriously | |
8795 limited the use and appeal of the package. | |
8796 | |
8797 @cindex @command{xmh}, in MH-E history | |
8798 | |
8799 In '89, I came to Wisconsin as a professor and decided not to work on | |
8800 MH-E. It was stable, except for minor bugs, and had enough | |
8801 functionality, so I let it be for a few years. Stephen Gildea of BBN | |
8802 began to pester me about the bugs, but I ignored them. In 1990, he | |
8803 went off to the X Consortium, said good bye, and said that he would | |
8804 now be using @command{xmh}. A few months later, he came back and said | |
8805 that he couldn't stand @command{xmh} and could I put a few more bug fixes | |
8806 into MH-E. At that point, I had no interest in fixing MH-E, so I gave | |
8807 the responsibility of maintenance to him and he has done a fine job | |
8808 since then. | |
8809 | |
8810 Jim Larus, June 1994 | |
8811 | |
8812 @node From Stephen Gildea, From Bill Wohler, From Jim Larus, History | |
8813 @appendixsec From Stephen Gildea | |
8814 | |
8815 @cindex Gildea, Stephen | |
8816 @cindex Stephen Gildea | |
8817 | |
8818 In 1987 I went to work for Bolt Beranek and Newman, as Jim had before | |
8819 me. In my previous job, I had been using RMAIL, but as my folders tend | |
8820 to run large, I was frustrated with the speed of RMAIL@. However, I | |
8821 stuck with it because I wanted the GNU Emacs interface. I am very | |
8822 familiar and comfortable with the Emacs interface (with just a few | |
8823 modifications of my own) and dislike having to use applications with | |
8824 embedded editors; they never live up to Emacs. | |
8825 | |
8826 MH is the mail reader of choice at BBN, so I converted to it. Since I | |
8827 didn't want to give up using an Emacs interface, I started using MH-E. | |
8828 As is my wont, I started hacking on it almost immediately. I first | |
8829 used version 3.4m. One of the first features I added was to treat the | |
8830 folder buffer as a file-visiting buffer: you could lock it, save it, | |
8831 and be warned of unsaved changes when killing it. I also worked to | |
8832 bring its functionality a little closer to RMAIL@. Jim Larus was very | |
8833 cooperative about merging in my changes, and my efforts first appeared | |
8834 in version 3.6, distributed with Emacs 18.52 in 1988. Next I decided | |
8835 MH-E was too slow and optimized it a lot. Version, 3.7, distributed | |
8836 with Emacs 18.56 in 1990, was noticeably faster. | |
8837 | |
8838 When I moved to the X Consortium I became the first person there to | |
8839 not use xmh. (There is now one other engineer there using MH-E.) About | |
8840 this point I took over maintenance of MH-E from Jim and was finally | |
8841 able to add some features Jim hadn't accepted, such as the backward | |
8842 searching undo. My first release was 3.8 (Emacs 18.58) in 1992. | |
8843 | |
8844 Now, in 1994, we see a flurry of releases, with both 4.0 and 5.0. | |
8845 Version 4.0 added many new features, including background folder | |
8846 collection and support for composing @sc{mime} messages. (Reading | |
8847 @sc{mime} messages remains to be done, alas.) While writing this book, | |
8848 Bill Wohler gave MH-E its closest examination ever, uncovering bugs | |
8849 and inconsistencies that required a new major version to fix, and so | |
8850 version 5 was released. | |
8851 | |
8852 Stephen Gildea, June 1994 | |
8853 | |
8854 @node From Bill Wohler, , From Stephen Gildea, History | |
8855 @appendixsec From Bill Wohler | |
8856 | |
8857 @cindex Wohler, Bill | |
8858 @cindex Bill Wohler | |
8859 | |
8860 The preface originally included the following text which I use to | |
8861 begin my story: | |
8862 | |
8863 @quotation | |
8864 But it's important to note a brief history of MH-E. | |
8865 | |
8866 @w{Version 3} was prevalent through the @w{Emacs 18} and early | |
8867 @w{Emacs 19} years. Then @w{Version 4} came out (@w{Emacs 19.23}), | |
8868 which introduced several new and changed commands. Next, @w{Version | |
8869 5.0} was released, which fixed some bugs and incompatibilities, and | |
8870 was incorporated into @w{Emacs 19.29}. | |
8871 @end quotation | |
8872 | |
8873 After a long break, Stephen handed the reins over to me in 2000. I | |
8874 moved the project to a new site called SourceForge and organized a | |
8875 great team of developers. Our first release in late 2001 was version | |
8876 6. It appeared around the time of Emacs 21.2 and had menus and tool | |
8877 bar buttons. | |
8878 | |
8879 Then, indexed searches, improved MIME handling, a speedbar, multiple | |
8880 identities, alias completion, an index view of unseen messages, spam | |
8881 software support, Face and X-Image-URL header field support, Fcc | |
8882 completion, arbitrary range handling, and draft form editing were | |
8883 introduced in the version 7 series around the time of Emacs 21.4 | |
8884 (2004). Still, Emacs itself contained version 5 of MH-E released back | |
8885 in 1994. | |
8886 | |
8887 Version 8 development was mostly driven by the rewrite of the manual. | |
8888 It also brought mailutils support, S/MIME support, picon support, and | |
8889 an improved interface for hiding header fields. The CVS repository was | |
8890 migrated from SourceForge to Savannah (only for those files that were | |
8891 already part of Emacs) and the software was completely reorganized to | |
8892 push back two decades of entropy. Version 8 will appear in Emacs 22.1, | |
8893 expected to be released in 2006. | |
8894 | |
8895 Bill Wohler, February 2006 | |
8896 | |
8897 @node GFDL, GPL, History, Top | |
8898 @appendix GNU FREE DOCUMENTATION LICENSE | |
8899 @center Version 1.2, November 2002 | |
8900 | |
8901 @display | |
8902 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. | |
8903 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA | |
8904 | |
8905 Everyone is permitted to copy and distribute verbatim copies | |
8906 of this license document, but changing it is not allowed. | |
8907 @end display | |
8908 @sp 1 | |
8909 @enumerate 0 | |
8910 @item | |
8911 PREAMBLE | |
8912 | |
8913 The purpose of this License is to make a manual, textbook, or other | |
8914 functional and useful document ``free'' in the sense of freedom: to | |
8915 assure everyone the effective freedom to copy and redistribute it, | |
8916 with or without modifying it, either commercially or noncommercially. | |
8917 Secondarily, this License preserves for the author and publisher a way | |
8918 to get credit for their work, while not being considered responsible | |
8919 for modifications made by others. | |
8920 | |
8921 This License is a kind of ``copyleft'', which means that derivative | |
8922 works of the document must themselves be free in the same sense. It | |
8923 complements the GNU General Public License, which is a copyleft | |
8924 license designed for free software. | |
8925 | |
8926 We have designed this License in order to use it for manuals for free | |
8927 software, because free software needs free documentation: a free | |
8928 program should come with manuals providing the same freedoms that the | |
8929 software does. But this License is not limited to software manuals; | |
8930 it can be used for any textual work, regardless of subject matter or | |
8931 whether it is published as a printed book. We recommend this License | |
8932 principally for works whose purpose is instruction or reference. | |
8933 | |
8934 @sp 1 | |
8935 @item | |
8936 APPLICABILITY AND DEFINITIONS | |
8937 | |
8938 This License applies to any manual or other work, in any medium, that | |
8939 contains a notice placed by the copyright holder saying it can be | |
8940 distributed under the terms of this License. Such a notice grants a | |
8941 world-wide, royalty-free license, unlimited in duration, to use that | |
8942 work under the conditions stated herein. The ``Document'', below, | |
8943 refers to any such manual or work. Any member of the public is a | |
8944 licensee, and is addressed as ``you''. You accept the license if you | |
8945 copy, modify or distribute the work in a way requiring permission | |
8946 under copyright law. | |
8947 | |
8948 A ``Modified Version'' of the Document means any work containing the | |
8949 Document or a portion of it, either copied verbatim, or with | |
8950 modifications and/or translated into another language. | |
8951 | |
8952 A ``Secondary Section'' is a named appendix or a front-matter section of | |
8953 the Document that deals exclusively with the relationship of the | |
8954 publishers or authors of the Document to the Document's overall subject | |
8955 (or to related matters) and contains nothing that could fall directly | |
8956 within that overall subject. (Thus, if the Document is in part a | |
8957 textbook of mathematics, a Secondary Section may not explain any | |
8958 mathematics.) The relationship could be a matter of historical | |
8959 connection with the subject or with related matters, or of legal, | |
8960 commercial, philosophical, ethical or political position regarding | |
8961 them. | |
8962 | |
8963 The ``Invariant Sections'' are certain Secondary Sections whose titles | |
8964 are designated, as being those of Invariant Sections, in the notice | |
8965 that says that the Document is released under this License. If a | |
8966 section does not fit the above definition of Secondary then it is not | |
8967 allowed to be designated as Invariant. The Document may contain zero | |
8968 Invariant Sections. If the Document does not identify any Invariant | |
8969 Sections then there are none. | |
8970 | |
8971 The ``Cover Texts'' are certain short passages of text that are listed, | |
8972 as Front-Cover Texts or Back-Cover Texts, in the notice that says that | |
8973 the Document is released under this License. A Front-Cover Text may | |
8974 be at most 5 words, and a Back-Cover Text may be at most 25 words. | |
8975 | |
8976 A ``Transparent'' copy of the Document means a machine-readable copy, | |
8977 represented in a format whose specification is available to the | |
8978 general public, that is suitable for revising the document | |
8979 straightforwardly with generic text editors or (for images composed of | |
8980 pixels) generic paint programs or (for drawings) some widely available | |
8981 drawing editor, and that is suitable for input to text formatters or | |
8982 for automatic translation to a variety of formats suitable for input | |
8983 to text formatters. A copy made in an otherwise Transparent file | |
8984 format whose markup, or absence of markup, has been arranged to thwart | |
8985 or discourage subsequent modification by readers is not Transparent. | |
8986 An image format is not Transparent if used for any substantial amount | |
8987 of text. A copy that is not ``Transparent'' is called ``Opaque.'' | |
8988 | |
8989 | |
8990 Examples of suitable formats for Transparent copies include plain | |
8991 ASCII without markup, Texinfo input format, LaTeX input format, SGML | |
8992 or XML using a publicly available DTD, and standard-conforming simple | |
8993 HTML, PostScript or PDF designed for human modification. Examples of | |
8994 transparent image formats include PNG, XCF and JPG. Opaque formats | |
8995 include proprietary formats that can be read and edited only by | |
8996 proprietary word processors, SGML or XML for which the DTD and/or | |
8997 processing tools are not generally available, and the | |
8998 machine-generated HTML, PostScript or PDF produced by some word | |
8999 processors for output purposes only. | |
9000 | |
9001 The ``Title Page'' means, for a printed book, the title page itself, | |
9002 plus such following pages as are needed to hold, legibly, the material | |
9003 this License requires to appear in the title page. For works in | |
9004 formats which do not have any title page as such, ``Title Page'' means | |
9005 the text near the most prominent appearance of the work's title, | |
9006 preceding the beginning of the body of the text. | |
9007 | |
9008 A section ``Entitled XYZ'' means a named subunit of the Document whose | |
9009 title either is precisely XYZ or contains XYZ in parentheses following | |
9010 text that translates XYZ in another language. (Here XYZ stands for a | |
9011 specific section name mentioned below, such as ``Acknowledgements'', | |
9012 ``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' | |
9013 of such a section when you modify the Document means that it remains a | |
9014 section ``Entitled XYZ'' according to this definition. | |
9015 | |
9016 The Document may include Warranty Disclaimers next to the notice which | |
9017 states that this License applies to the Document. These Warranty | |
9018 Disclaimers are considered to be included by reference in this | |
9019 License, but only as regards disclaiming warranties: any other | |
9020 implication that these Warranty Disclaimers may have is void and has | |
9021 no effect on the meaning of this License. | |
9022 @sp 1 | |
9023 @item | |
9024 VERBATIM COPYING | |
9025 | |
9026 You may copy and distribute the Document in any medium, either | |
9027 commercially or noncommercially, provided that this License, the | |
9028 copyright notices, and the license notice saying this License applies | |
9029 to the Document are reproduced in all copies, and that you add no other | |
9030 conditions whatsoever to those of this License. You may not use | |
9031 technical measures to obstruct or control the reading or further | |
9032 copying of the copies you make or distribute. However, you may accept | |
9033 compensation in exchange for copies. If you distribute a large enough | |
9034 number of copies you must also follow the conditions in section 3. | |
9035 | |
9036 You may also lend copies, under the same conditions stated above, and | |
9037 you may publicly display copies. | |
9038 @sp 1 | |
9039 @item | |
9040 COPYING IN QUANTITY | |
9041 | |
9042 If you publish printed copies (or copies in media that commonly have | |
9043 printed covers) of the Document, numbering more than 100, and the | |
9044 Document's license notice requires Cover Texts, you must enclose the | |
9045 copies in covers that carry, clearly and legibly, all these Cover | |
9046 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on | |
9047 the back cover. Both covers must also clearly and legibly identify | |
9048 you as the publisher of these copies. The front cover must present | |
9049 the full title with all words of the title equally prominent and | |
9050 visible. You may add other material on the covers in addition. | |
9051 Copying with changes limited to the covers, as long as they preserve | |
9052 the title of the Document and satisfy these conditions, can be treated | |
9053 as verbatim copying in other respects. | |
9054 | |
9055 If the required texts for either cover are too voluminous to fit | |
9056 legibly, you should put the first ones listed (as many as fit | |
9057 reasonably) on the actual cover, and continue the rest onto adjacent | |
9058 pages. | |
9059 | |
9060 If you publish or distribute Opaque copies of the Document numbering | |
9061 more than 100, you must either include a machine-readable Transparent | |
9062 copy along with each Opaque copy, or state in or with each Opaque copy | |
9063 a computer-network location from which the general network-using | |
9064 public has access to download using public-standard network protocols | |
9065 a complete Transparent copy of the Document, free of added material. | |
9066 If you use the latter option, you must take reasonably prudent steps, | |
9067 when you begin distribution of Opaque copies in quantity, to ensure | |
9068 that this Transparent copy will remain thus accessible at the stated | |
9069 location until at least one year after the last time you distribute an | |
9070 Opaque copy (directly or through your agents or retailers) of that | |
9071 edition to the public. | |
9072 | |
9073 It is requested, but not required, that you contact the authors of the | |
9074 Document well before redistributing any large number of copies, to give | |
9075 them a chance to provide you with an updated version of the Document. | |
9076 @sp 1 | |
9077 @item | |
9078 MODIFICATIONS | |
9079 | |
9080 You may copy and distribute a Modified Version of the Document under | |
9081 the conditions of sections 2 and 3 above, provided that you release | |
9082 the Modified Version under precisely this License, with the Modified | |
9083 Version filling the role of the Document, thus licensing distribution | |
9084 and modification of the Modified Version to whoever possesses a copy | |
9085 of it. In addition, you must do these things in the Modified Version: | |
9086 | |
9087 A. Use in the Title Page (and on the covers, if any) a title distinct | |
9088 from that of the Document, and from those of previous versions | |
9089 (which should, if there were any, be listed in the History section | |
9090 of the Document). You may use the same title as a previous version | |
9091 if the original publisher of that version gives permission.@* | |
9092 B. List on the Title Page, as authors, one or more persons or entities | |
9093 responsible for authorship of the modifications in the Modified | |
9094 Version, together with at least five of the principal authors of the | |
9095 Document (all of its principal authors, if it has fewer than five), | |
9096 unless they release you from this requirement.@* | |
9097 C. State on the Title page the name of the publisher of the | |
9098 Modified Version, as the publisher.@* | |
9099 D. Preserve all the copyright notices of the Document.@* | |
9100 E. Add an appropriate copyright notice for your modifications | |
9101 adjacent to the other copyright notices.@* | |
9102 F. Include, immediately after the copyright notices, a license notice | |
9103 giving the public permission to use the Modified Version under the | |
9104 terms of this License, in the form shown in the Addendum below.@* | |
9105 G. Preserve in that license notice the full lists of Invariant Sections | |
9106 and required Cover Texts given in the Document's license notice.@* | |
9107 H. Include an unaltered copy of this License.@* | |
9108 I. Preserve the section Entitled ``History'', Preserve its Title, and add | |
9109 to it an item stating at least the title, year, new authors, and | |
9110 publisher of the Modified Version as given on the Title Page. If | |
9111 there is no section Entitled ``History'' in the Document, create one | |
9112 stating the title, year, authors, and publisher of the Document as | |
9113 given on its Title Page, then add an item describing the Modified | |
9114 Version as stated in the previous sentence.@* | |
9115 J. Preserve the network location, if any, given in the Document for | |
9116 public access to a Transparent copy of the Document, and likewise | |
9117 the network locations given in the Document for previous versions | |
9118 it was based on. These may be placed in the ``History'' section. | |
9119 You may omit a network location for a work that was published at | |
9120 least four years before the Document itself, or if the original | |
9121 publisher of the version it refers to gives permission.@* | |
9122 K. For any section Entitled ``Acknowledgements'' or ``Dedications'', | |
9123 Preserve the Title of the section, and preserve in the section all | |
9124 the substance and tone of each of the contributor acknowledgements | |
9125 and/or dedications given therein.@* | |
9126 L. Preserve all the Invariant Sections of the Document, | |
9127 unaltered in their text and in their titles. Section numbers | |
9128 or the equivalent are not considered part of the section titles.@* | |
9129 M. Delete any section Entitled ``Endorsements.'' Such a section | |
9130 may not be included in the Modified Version.@* | |
9131 N. Do not retitle any existing section to be Entitled ``Endorsements'' | |
9132 or to conflict in title with any Invariant Section.@* | |
9133 O. Preserve any Warranty Disclaimers.@* | |
9134 @sp 1 | |
9135 If the Modified Version includes new front-matter sections or | |
9136 appendices that qualify as Secondary Sections and contain no material | |
9137 copied from the Document, you may at your option designate some or all | |
9138 of these sections as invariant. To do this, add their titles to the | |
9139 list of Invariant Sections in the Modified Version's license notice. | |
9140 These titles must be distinct from any other section titles. | |
9141 | |
9142 You may add a section Entitled ``Endorsements'', provided it contains | |
9143 nothing but endorsements of your Modified Version by various | |
9144 parties--for example, statements of peer review or that the text has | |
9145 been approved by an organization as the authoritative definition of a | |
9146 standard. | |
9147 | |
9148 You may add a passage of up to five words as a Front-Cover Text, and a | |
9149 passage of up to 25 words as a Back-Cover Text, to the end of the list | |
9150 of Cover Texts in the Modified Version. Only one passage of | |
9151 Front-Cover Text and one of Back-Cover Text may be added by (or | |
9152 through arrangements made by) any one entity. If the Document already | |
9153 includes a cover text for the same cover, previously added by you or | |
9154 by arrangement made by the same entity you are acting on behalf of, | |
9155 you may not add another; but you may replace the old one, on explicit | |
9156 permission from the previous publisher that added the old one. | |
9157 | |
9158 The author(s) and publisher(s) of the Document do not by this License | |
9159 give permission to use their names for publicity for or to assert or | |
9160 imply endorsement of any Modified Version. | |
9161 @sp 1 | |
9162 @item | |
9163 COMBINING DOCUMENTS | |
9164 | |
9165 You may combine the Document with other documents released under this | |
9166 License, under the terms defined in section 4 above for modified | |
9167 versions, provided that you include in the combination all of the | |
9168 Invariant Sections of all of the original documents, unmodified, and | |
9169 list them all as Invariant Sections of your combined work in its | |
9170 license notice, and that you preserve all their Warranty Disclaimers. | |
9171 | |
9172 The combined work need only contain one copy of this License, and | |
9173 multiple identical Invariant Sections may be replaced with a single | |
9174 copy. If there are multiple Invariant Sections with the same name but | |
9175 different contents, make the title of each such section unique by | |
9176 adding at the end of it, in parentheses, the name of the original | |
9177 author or publisher of that section if known, or else a unique number. | |
9178 Make the same adjustment to the section titles in the list of | |
9179 Invariant Sections in the license notice of the combined work. | |
9180 | |
9181 In the combination, you must combine any sections Entitled ``History'' | |
9182 in the various original documents, forming one section Entitled | |
9183 ``History''; likewise combine any sections Entitled ``Acknowledgements'', | |
9184 and any sections Entitled ``Dedications.'' You must delete all sections | |
9185 Entitled ``Endorsements.'' | |
9186 @sp 1 | |
9187 @item | |
9188 COLLECTIONS OF DOCUMENTS | |
9189 | |
9190 You may make a collection consisting of the Document and other documents | |
9191 released under this License, and replace the individual copies of this | |
9192 License in the various documents with a single copy that is included in | |
9193 the collection, provided that you follow the rules of this License for | |
9194 verbatim copying of each of the documents in all other respects. | |
9195 | |
9196 You may extract a single document from such a collection, and distribute | |
9197 it individually under this License, provided you insert a copy of this | |
9198 License into the extracted document, and follow this License in all | |
9199 other respects regarding verbatim copying of that document. | |
9200 @sp 1 | |
9201 @item | |
9202 AGGREGATION WITH INDEPENDENT WORKS | |
9203 | |
9204 A compilation of the Document or its derivatives with other separate | |
9205 and independent documents or works, in or on a volume of a storage or | |
9206 distribution medium, is called an ``aggregate'' if the copyright | |
9207 resulting from the compilation is not used to limit the legal rights | |
9208 of the compilation's users beyond what the individual works permit. | |
9209 When the Document is included in an aggregate, this License does not | |
9210 apply to the other works in the aggregate which are not themselves | |
9211 derivative works of the Document. | |
9212 | |
9213 If the Cover Text requirement of section 3 is applicable to these | |
9214 copies of the Document, then if the Document is less than one half of | |
9215 the entire aggregate, the Document's Cover Texts may be placed on | |
9216 covers that bracket the Document within the aggregate, or the | |
9217 electronic equivalent of covers if the Document is in electronic form. | |
9218 Otherwise they must appear on printed covers that bracket the whole | |
9219 aggregate. | |
9220 @sp 1 | |
9221 @item | |
9222 TRANSLATION | |
9223 | |
9224 Translation is considered a kind of modification, so you may | |
9225 distribute translations of the Document under the terms of section 4. | |
9226 Replacing Invariant Sections with translations requires special | |
9227 permission from their copyright holders, but you may include | |
9228 translations of some or all Invariant Sections in addition to the | |
9229 original versions of these Invariant Sections. You may include a | |
9230 translation of this License, and all the license notices in the | |
9231 Document, and any Warranty Disclaimers, provided that you also include | |
9232 the original English version of this License and the original versions | |
9233 of those notices and disclaimers. In case of a disagreement between | |
9234 the translation and the original version of this License or a notice | |
9235 or disclaimer, the original version will prevail. | |
9236 | |
9237 If a section in the Document is Entitled ``Acknowledgements'', | |
9238 ``Dedications'', or ``History'', the requirement (section 4) to Preserve | |
9239 its Title (section 1) will typically require changing the actual | |
9240 title. | |
9241 @sp 1 | |
9242 @item | |
9243 TERMINATION | |
9244 | |
9245 You may not copy, modify, sublicense, or distribute the Document except | |
9246 as expressly provided for under this License. Any other attempt to | |
9247 copy, modify, sublicense or distribute the Document is void, and will | |
9248 automatically terminate your rights under this License. However, | |
9249 parties who have received copies, or rights, from you under this | |
9250 License will not have their licenses terminated so long as such | |
9251 parties remain in full compliance. | |
9252 @sp 1 | |
9253 @item | |
9254 FUTURE REVISIONS OF THIS LICENSE | |
9255 | |
9256 The Free Software Foundation may publish new, revised versions | |
9257 of the GNU Free Documentation License from time to time. Such new | |
9258 versions will be similar in spirit to the present version, but may | |
9259 differ in detail to address new problems or concerns. See | |
9260 http://www.gnu.org/copyleft/. | |
9261 | |
9262 Each version of the License is given a distinguishing version number. | |
9263 If the Document specifies that a particular numbered version of this | |
9264 License ``or any later version'' applies to it, you have the option of | |
9265 following the terms and conditions either of that specified version or | |
9266 of any later version that has been published (not as a draft) by the | |
9267 Free Software Foundation. If the Document does not specify a version | |
9268 number of this License, you may choose any version ever published (not | |
9269 as a draft) by the Free Software Foundation. | |
9270 | |
9271 @end enumerate | |
9272 | |
9273 @unnumberedsec ADDENDUM: How to use this License for your documents | |
9274 | |
9275 To use this License in a document you have written, include a copy of | |
9276 the License in the document and put the following copyright and | |
9277 license notices just after the title page: | |
9278 | |
9279 @smallexample | |
9280 @group | |
9281 Copyright (C) @var{year} @var{your name}. | |
9282 Permission is granted to copy, distribute and/or modify this document | |
9283 under the terms of the GNU Free Documentation License, Version 1.2 | |
9284 or any later version published by the Free Software Foundation; | |
9285 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. | |
9286 A copy of the license is included in the section entitled ``GNU | |
9287 Free Documentation License''. | |
9288 @end group | |
9289 @end smallexample | |
9290 | |
9291 If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, | |
9292 replace the ``with...Texts.'' line with this: | |
9293 | |
9294 @smallexample | |
9295 @group | |
9296 with the Invariant Sections being @var{list their titles}, with the | |
9297 Front-Cover Texts being @var{list}, and with the Back-Cover Texts being | |
9298 @var{list}. | |
9299 @end group | |
9300 @end smallexample | |
9301 | |
9302 If you have Invariant Sections without Cover Texts, or some other | |
9303 combination of the three, merge those two alternatives to suit the | |
9304 situation. | |
9305 | |
9306 If your document contains nontrivial examples of program code, we | |
9307 recommend releasing these examples in parallel under your choice of | |
9308 free software license, such as the GNU General Public License, | |
9309 to permit their use in free software. | |
9310 | |
9311 @node GPL, Key Index, GFDL, Top | |
9312 @appendix GNU GENERAL PUBLIC LICENSE | |
9313 @center Version 2, June 1991 | |
9314 | |
9315 @display | |
9316 Copyright @copyright{} 1989, 1991 Free Software Foundation, Inc. | |
9317 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA | |
9318 | |
9319 Everyone is permitted to copy and distribute verbatim copies | |
9320 of this license document, but changing it is not allowed. | |
9321 @end display | |
9322 | |
9323 @unnumberedsec Preamble | |
9324 | |
9325 The licenses for most software are designed to take away your | |
9326 freedom to share and change it. By contrast, the GNU General Public | |
9327 License is intended to guarantee your freedom to share and change free | |
9328 software---to make sure the software is free for all its users. This | |
9329 General Public License applies to most of the Free Software | |
9330 Foundation's software and to any other program whose authors commit to | |
9331 using it. (Some other Free Software Foundation software is covered by | |
9332 the GNU Lesser General Public License instead.) You can apply it to | |
9333 your programs, too. | |
9334 | |
9335 When we speak of free software, we are referring to freedom, not | |
9336 price. Our General Public Licenses are designed to make sure that you | |
9337 have the freedom to distribute copies of free software (and charge for | |
9338 this service if you wish), that you receive source code or can get it | |
9339 if you want it, that you can change the software or use pieces of it | |
9340 in new free programs; and that you know you can do these things. | |
9341 | |
9342 To protect your rights, we need to make restrictions that forbid | |
9343 anyone to deny you these rights or to ask you to surrender the rights. | |
9344 These restrictions translate to certain responsibilities for you if you | |
9345 distribute copies of the software, or if you modify it. | |
9346 | |
9347 For example, if you distribute copies of such a program, whether | |
9348 gratis or for a fee, you must give the recipients all the rights that | |
9349 you have. You must make sure that they, too, receive or can get the | |
9350 source code. And you must show them these terms so they know their | |
9351 rights. | |
9352 | |
9353 We protect your rights with two steps: (1) copyright the software, and | |
9354 (2) offer you this license which gives you legal permission to copy, | |
9355 distribute and/or modify the software. | |
9356 | |
9357 Also, for each author's protection and ours, we want to make certain | |
9358 that everyone understands that there is no warranty for this free | |
9359 software. If the software is modified by someone else and passed on, we | |
9360 want its recipients to know that what they have is not the original, so | |
9361 that any problems introduced by others will not reflect on the original | |
9362 authors' reputations. | |
9363 | |
9364 Finally, any free program is threatened constantly by software | |
9365 patents. We wish to avoid the danger that redistributors of a free | |
9366 program will individually obtain patent licenses, in effect making the | |
9367 program proprietary. To prevent this, we have made it clear that any | |
9368 patent must be licensed for everyone's free use or not licensed at all. | |
9369 | |
9370 The precise terms and conditions for copying, distribution and | |
9371 modification follow. | |
9372 | |
9373 @iftex | |
9374 @unnumberedsec TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION | |
9375 @end iftex | |
9376 @ifinfo | |
9377 @center TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION | |
9378 @end ifinfo | |
9379 | |
9380 @enumerate 0 | |
9381 @item | |
9382 This License applies to any program or other work which contains | |
9383 a notice placed by the copyright holder saying it may be distributed | |
9384 under the terms of this General Public License. The ``Program,'' below, | |
9385 refers to any such program or work, and a ``work based on the Program'' | |
9386 means either the Program or any derivative work under copyright law: | |
9387 that is to say, a work containing the Program or a portion of it, | |
9388 either verbatim or with modifications and/or translated into another | |
9389 language. (Hereinafter, translation is included without limitation in | |
9390 the term ``modification.'') Each licensee is addressed as ``you.'' | |
9391 | |
9392 Activities other than copying, distribution and modification are not | |
9393 covered by this License; they are outside its scope. The act of | |
9394 running the Program is not restricted, and the output from the Program | |
9395 is covered only if its contents constitute a work based on the | |
9396 Program (independent of having been made by running the Program). | |
9397 Whether that is true depends on what the Program does. | |
9398 | |
9399 @item | |
9400 You may copy and distribute verbatim copies of the Program's | |
9401 source code as you receive it, in any medium, provided that you | |
9402 conspicuously and appropriately publish on each copy an appropriate | |
9403 copyright notice and disclaimer of warranty; keep intact all the | |
9404 notices that refer to this License and to the absence of any warranty; | |
9405 and give any other recipients of the Program a copy of this License | |
9406 along with the Program. | |
9407 | |
9408 You may charge a fee for the physical act of transferring a copy, and | |
9409 you may at your option offer warranty protection in exchange for a fee. | |
9410 | |
9411 @item | |
9412 You may modify your copy or copies of the Program or any portion | |
9413 of it, thus forming a work based on the Program, and copy and | |
9414 distribute such modifications or work under the terms of Section 1 | |
9415 above, provided that you also meet all of these conditions: | |
9416 | |
9417 @enumerate a | |
9418 @item | |
9419 You must cause the modified files to carry prominent notices | |
9420 stating that you changed the files and the date of any change. | |
9421 | |
9422 @item | |
9423 You must cause any work that you distribute or publish, that in | |
9424 whole or in part contains or is derived from the Program or any | |
9425 part thereof, to be licensed as a whole at no charge to all third | |
9426 parties under the terms of this License. | |
9427 | |
9428 @item | |
9429 If the modified program normally reads commands interactively | |
9430 when run, you must cause it, when started running for such | |
9431 interactive use in the most ordinary way, to print or display an | |
9432 announcement including an appropriate copyright notice and a | |
9433 notice that there is no warranty (or else, saying that you provide | |
9434 a warranty) and that users may redistribute the program under | |
9435 these conditions, and telling the user how to view a copy of this | |
9436 License. (Exception: if the Program itself is interactive but | |
9437 does not normally print such an announcement, your work based on | |
9438 the Program is not required to print an announcement.) | |
9439 @end enumerate | |
9440 | |
9441 These requirements apply to the modified work as a whole. If | |
9442 identifiable sections of that work are not derived from the Program, | |
9443 and can be reasonably considered independent and separate works in | |
9444 themselves, then this License, and its terms, do not apply to those | |
9445 sections when you distribute them as separate works. But when you | |
9446 distribute the same sections as part of a whole which is a work based | |
9447 on the Program, the distribution of the whole must be on the terms of | |
9448 this License, whose permissions for other licensees extend to the | |
9449 entire whole, and thus to each and every part regardless of who wrote it. | |
9450 | |
9451 Thus, it is not the intent of this section to claim rights or contest | |
9452 your rights to work written entirely by you; rather, the intent is to | |
9453 exercise the right to control the distribution of derivative or | |
9454 collective works based on the Program. | |
9455 | |
9456 In addition, mere aggregation of another work not based on the Program | |
9457 with the Program (or with a work based on the Program) on a volume of | |
9458 a storage or distribution medium does not bring the other work under | |
9459 the scope of this License. | |
9460 | |
9461 @item | |
9462 You may copy and distribute the Program (or a work based on it, | |
9463 under Section 2) in object code or executable form under the terms of | |
9464 Sections 1 and 2 above provided that you also do one of the following: | |
9465 | |
9466 @enumerate a | |
9467 @item | |
9468 Accompany it with the complete corresponding machine-readable | |
9469 source code, which must be distributed under the terms of Sections | |
9470 1 and 2 above on a medium customarily used for software interchange; or, | |
9471 | |
9472 @item | |
9473 Accompany it with a written offer, valid for at least three | |
9474 years, to give any third party, for a charge no more than your | |
9475 cost of physically performing source distribution, a complete | |
9476 machine-readable copy of the corresponding source code, to be | |
9477 distributed under the terms of Sections 1 and 2 above on a medium | |
9478 customarily used for software interchange; or, | |
9479 | |
9480 @item | |
9481 Accompany it with the information you received as to the offer | |
9482 to distribute corresponding source code. (This alternative is | |
9483 allowed only for noncommercial distribution and only if you | |
9484 received the program in object code or executable form with such | |
9485 an offer, in accord with Subsection b above.) | |
9486 @end enumerate | |
9487 | |
9488 The source code for a work means the preferred form of the work for | |
9489 making modifications to it. For an executable work, complete source | |
9490 code means all the source code for all modules it contains, plus any | |
9491 associated interface definition files, plus the scripts used to | |
9492 control compilation and installation of the executable. However, as a | |
9493 special exception, the source code distributed need not include | |
9494 anything that is normally distributed (in either source or binary | |
9495 form) with the major components (compiler, kernel, and so on) of the | |
9496 operating system on which the executable runs, unless that component | |
9497 itself accompanies the executable. | |
9498 | |
9499 If distribution of executable or object code is made by offering | |
9500 access to copy from a designated place, then offering equivalent | |
9501 access to copy the source code from the same place counts as | |
9502 distribution of the source code, even though third parties are not | |
9503 compelled to copy the source along with the object code. | |
9504 | |
9505 @item | |
9506 You may not copy, modify, sublicense, or distribute the Program | |
9507 except as expressly provided under this License. Any attempt | |
9508 otherwise to copy, modify, sublicense or distribute the Program is | |
9509 void, and will automatically terminate your rights under this License. | |
9510 However, parties who have received copies, or rights, from you under | |
9511 this License will not have their licenses terminated so long as such | |
9512 parties remain in full compliance. | |
9513 | |
9514 @item | |
9515 You are not required to accept this License, since you have not | |
9516 signed it. However, nothing else grants you permission to modify or | |
9517 distribute the Program or its derivative works. These actions are | |
9518 prohibited by law if you do not accept this License. Therefore, by | |
9519 modifying or distributing the Program (or any work based on the | |
9520 Program), you indicate your acceptance of this License to do so, and | |
9521 all its terms and conditions for copying, distributing or modifying | |
9522 the Program or works based on it. | |
9523 | |
9524 @item | |
9525 Each time you redistribute the Program (or any work based on the | |
9526 Program), the recipient automatically receives a license from the | |
9527 original licensor to copy, distribute or modify the Program subject to | |
9528 these terms and conditions. You may not impose any further | |
9529 restrictions on the recipients' exercise of the rights granted herein. | |
9530 You are not responsible for enforcing compliance by third parties to | |
9531 this License. | |
9532 | |
9533 @item | |
9534 If, as a consequence of a court judgment or allegation of patent | |
9535 infringement or for any other reason (not limited to patent issues), | |
9536 conditions are imposed on you (whether by court order, agreement or | |
9537 otherwise) that contradict the conditions of this License, they do not | |
9538 excuse you from the conditions of this License. If you cannot | |
9539 distribute so as to satisfy simultaneously your obligations under this | |
9540 License and any other pertinent obligations, then as a consequence you | |
9541 may not distribute the Program at all. For example, if a patent | |
9542 license would not permit royalty-free redistribution of the Program by | |
9543 all those who receive copies directly or indirectly through you, then | |
9544 the only way you could satisfy both it and this License would be to | |
9545 refrain entirely from distribution of the Program. | |
9546 | |
9547 If any portion of this section is held invalid or unenforceable under | |
9548 any particular circumstance, the balance of the section is intended to | |
9549 apply and the section as a whole is intended to apply in other | |
9550 circumstances. | |
9551 | |
9552 It is not the purpose of this section to induce you to infringe any | |
9553 patents or other property right claims or to contest validity of any | |
9554 such claims; this section has the sole purpose of protecting the | |
9555 integrity of the free software distribution system, which is | |
9556 implemented by public license practices. Many people have made | |
9557 generous contributions to the wide range of software distributed | |
9558 through that system in reliance on consistent application of that | |
9559 system; it is up to the author/donor to decide if he or she is willing | |
9560 to distribute software through any other system and a licensee cannot | |
9561 impose that choice. | |
9562 | |
9563 This section is intended to make thoroughly clear what is believed to | |
9564 be a consequence of the rest of this License. | |
9565 | |
9566 @item | |
9567 If the distribution and/or use of the Program is restricted in | |
9568 certain countries either by patents or by copyrighted interfaces, the | |
9569 original copyright holder who places the Program under this License | |
9570 may add an explicit geographical distribution limitation excluding | |
9571 those countries, so that distribution is permitted only in or among | |
9572 countries not thus excluded. In such case, this License incorporates | |
9573 the limitation as if written in the body of this License. | |
9574 | |
9575 @item | |
9576 The Free Software Foundation may publish revised and/or new versions | |
9577 of the General Public License from time to time. Such new versions will | |
9578 be similar in spirit to the present version, but may differ in detail to | |
9579 address new problems or concerns. | |
9580 | |
9581 Each version is given a distinguishing version number. If the Program | |
9582 specifies a version number of this License which applies to it and ``any | |
9583 later version,'' you have the option of following the terms and conditions | |
9584 either of that version or of any later version published by the Free | |
9585 Software Foundation. If the Program does not specify a version number of | |
9586 this License, you may choose any version ever published by the Free Software | |
9587 Foundation. | |
9588 | |
9589 @item | |
9590 If you wish to incorporate parts of the Program into other free | |
9591 programs whose distribution conditions are different, write to the author | |
9592 to ask for permission. For software which is copyrighted by the Free | |
9593 Software Foundation, write to the Free Software Foundation; we sometimes | |
9594 make exceptions for this. Our decision will be guided by the two goals | |
9595 of preserving the free status of all derivatives of our free software and | |
9596 of promoting the sharing and reuse of software generally. | |
9597 | |
9598 @iftex | |
9599 @heading NO WARRANTY | |
9600 @end iftex | |
9601 @ifinfo | |
9602 @center NO WARRANTY | |
9603 @end ifinfo | |
9604 | |
9605 @item | |
9606 BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY | |
9607 FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW@. EXCEPT WHEN | |
9608 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES | |
9609 PROVIDE THE PROGRAM ``AS IS'' WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED | |
9610 OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF | |
9611 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE@. THE ENTIRE RISK AS | |
9612 TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU@. SHOULD THE | |
9613 PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, | |
9614 REPAIR OR CORRECTION. | |
9615 | |
9616 @item | |
9617 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING | |
9618 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR | |
9619 REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, | |
9620 INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING | |
9621 OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED | |
9622 TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY | |
9623 YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER | |
9624 PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE | |
9625 POSSIBILITY OF SUCH DAMAGES. | |
9626 @end enumerate | |
9627 | |
9628 @iftex | |
9629 @heading END OF TERMS AND CONDITIONS | |
9630 @end iftex | |
9631 @ifinfo | |
9632 @center END OF TERMS AND CONDITIONS | |
9633 @end ifinfo | |
9634 | |
9635 @page | |
9636 @unnumberedsec How to Apply These Terms to Your New Programs | |
9637 | |
9638 If you develop a new program, and you want it to be of the greatest | |
9639 possible use to the public, the best way to achieve this is to make it | |
9640 free software which everyone can redistribute and change under these terms. | |
9641 | |
9642 To do so, attach the following notices to the program. It is safest | |
9643 to attach them to the start of each source file to most effectively | |
9644 convey the exclusion of warranty; and each file should have at least | |
9645 the ``copyright'' line and a pointer to where the full notice is found. | |
9646 | |
9647 @smallexample | |
9648 @var{one line to give the program's name and an idea of what it does.} | |
9649 Copyright (C) @var{yyyy} @var{name of author} | |
9650 | |
9651 This program is free software; you can redistribute it and/or | |
9652 modify it under the terms of the GNU General Public License | |
9653 as published by the Free Software Foundation; either version 3 | |
9654 of the License, or (at your option) any later version. | |
9655 | |
9656 This program is distributed in the hope that it will be useful, | |
9657 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
9658 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE@. See the | |
9659 GNU General Public License for more details. | |
9660 | |
9661 You should have received a copy of the GNU General Public License along | |
9662 with this program; if not, write to the Free Software Foundation, Inc., | |
9663 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | |
9664 @end smallexample | |
9665 | |
9666 Also add information on how to contact you by electronic and paper mail. | |
9667 | |
9668 If the program is interactive, make it output a short notice like this | |
9669 when it starts in an interactive mode: | |
9670 | |
9671 @smallexample | |
9672 Gnomovision version 69, Copyright (C) @var{yyyy} @var{name of author} | |
9673 Gnomovision comes with ABSOLUTELY NO WARRANTY; for details | |
9674 type `show w'. This is free software, and you are welcome | |
9675 to redistribute it under certain conditions; type `show c' | |
9676 for details. | |
9677 @end smallexample | |
9678 | |
9679 The hypothetical commands @samp{show w} and @samp{show c} should show | |
9680 the appropriate parts of the General Public License. Of course, the | |
9681 commands you use may be called something other than @samp{show w} and | |
9682 @samp{show c}; they could even be mouse-clicks or menu items---whatever | |
9683 suits your program. | |
9684 | |
9685 You should also get your employer (if you work as a programmer) or your | |
9686 school, if any, to sign a ``copyright disclaimer'' for the program, if | |
9687 necessary. Here is a sample; alter the names: | |
9688 | |
9689 @smallexample | |
9690 @group | |
9691 Yoyodyne, Inc., hereby disclaims all copyright | |
9692 interest in the program `Gnomovision' | |
9693 (which makes passes at compilers) written | |
9694 by James Hacker. | |
9695 | |
9696 @var{signature of Ty Coon}, 1 April 1989 | |
9697 Ty Coon, President of Vice | |
9698 @end group | |
9699 @end smallexample | |
9700 | |
9701 This General Public License does not permit incorporating your program into | |
9702 proprietary programs. If your program is a subroutine library, you may | |
9703 consider it more useful to permit linking proprietary applications with the | |
9704 library. If this is what you want to do, use the GNU Lesser General | |
9705 Public License instead of this License. | |
9706 | |
9707 @node Key Index, Command Index, GPL, Top | |
9708 @unnumbered Key (Character) Index | |
9709 @printindex ky | |
9710 | |
9711 @node Command Index, Option Index, Key Index, Top | |
9712 @unnumbered Command Index | |
9713 @printindex fn | |
9714 | |
9715 @node Option Index, Concept Index, Command Index, Top | |
9716 @unnumbered Option (Variable) Index | |
9717 @printindex vr | |
9718 | |
9719 @node Concept Index, , Option Index, Top | |
9720 @unnumbered Concept Index | |
9721 @printindex cp | |
9722 | |
9723 @bye | |
9724 | |
9725 @c Ispell Helpers | |
9726 @c | |
9727 @c The following are words that ispell should ignore that would not | |
9728 @c normally be in a dictionary (global or personal). Be careful not to | |
9729 @c include words here that could potentially be typos of other words | |
9730 @c (such as url, elisp, or MHE). | |
9731 @c | |
9732 @c LocalWords: CTRL ESC SPC f's | |
9733 @c LocalWords: addr Aliasfile alist | |
9734 @c LocalWords: Baushke Bcc BBN Beranek bogofilter bogofilter's | |
9735 @c LocalWords: cmd CMU contrib cron | |
9736 @c LocalWords: DesBrisay Dcc devel dir dired docstring filll forw | |
9737 @c LocalWords: GECOS Gildea Gildea's Ginnean GnuCash goto gnuserv htm | |
9738 @c LocalWords: ImageMagick inbox ispell keychain | |
9739 @c LocalWords: Larus licensor LocalWords lookup lpr | |
9740 @c LocalWords: makeinfo mairix mbox mh mhbuild mhl mhpath mlisp | |
9741 @c LocalWords: MML msg multipart | |
9742 @c LocalWords: Namazu NIS nenscript nnml num | |
9743 @c LocalWords: packmbox passphrase pathname prev procmail prog repl | |
9744 @c LocalWords: slocal sortm SpamAssassin spammers SpamProbe SpamProbe's | |
9745 @c LocalWords: sublicense supercite speedbar | |
9746 @c LocalWords: Tennex texi texinfo Thelen thelenm | |
9747 @c LocalWords: UCI undeleted whatnow wohler xmh ypcat | |
9748 @c | |
9749 @c See http://www.oreilly.com/oreilly/author/stylesheet.html. | |
9750 @c See http://en.wikipedia.org/. | |
9751 @c | |
9752 @c Note the lowercase mh which is needed to avoid hits in the | |
9753 @c functions and variables. Occasionally, check for accidental | |
9754 @c inclusion of mh in text by uncommenting the following and executing | |
9755 @c it with C-x C-e. You want to see "Search failed" | |
9756 @c (let ((case-fold-search nil)) | |
9757 @c (goto-char (point-min)) | |
9758 @c (search-forward-regexp "^mh\\( \\|$\\)")) | |
9759 @c | |
9760 @c An extremely useful setting for texinfo-mode-hook is: | |
9761 @c (add-to-list | |
9762 @c 'ispell-skip-region-alist | |
9763 @c (list | |
9764 @c (concat "\\(@\\(small\\)?\\(example\\|lisp\\)" | |
9765 @c "\\(@\\([irw]\\|code\\|var\\){[^}]+}\\|" | |
9766 @c "@[@{}.]\\|" | |
9767 @c "[^@]\\|" | |
9768 @c "@\\(end \\)?group\\|" | |
9769 @c "@\\(end \\)?cartouche\\)+" | |
9770 @c "@end \\(small\\)?\\(example\\|lisp\\)\\|" | |
9771 @c "@\\(code\\|command\\|file\\|kbd\\|sc\\){[^}]+}\\|" | |
9772 @c "^@end [a-z]+$\\|" | |
9773 @c "^@\\([fv]\\|print\\)index .*$\\|" | |
9774 @c "@uref{[^,]+,\\|" | |
9775 @c "@[a-z]+\\|" | |
9776 @c "/[a-z.]+[/}]\\)"))))) | |
9777 @c | |
9778 @c Cross References | |
9779 @c | |
9780 @c See existing cross-references to the Emacs manual and the Emacs | |
9781 @c Lisp manual (search for ``GNU Emacs Manual'' and ``GNU | |
9782 @c Emacs Lisp Reference Manual'' respectively). | |
9783 | |
9784 @c @ftable Sorting | |
9785 @c | |
9786 @c As per index (sort of): Punctuation, keyboard characters (such as | |
9787 @c RET and BS) upper and lowercase mixed (lower comes before | |
9788 @c uppercase), control characters go with uppercase C, meta characters | |
9789 @c go with uppercase M. | |
9790 @c In some cases, the sort isn't strictly ASCII. | |
9791 @c For example, SPC (mh-page-msg) reads better before BS | |
9792 @c (mh-previous-page) and . (mh-show) is better before , | |
9793 @c (mh-header-display). | |
9794 | |
9795 @c @vtable Sorting | |
9796 @c | |
9797 @c Alphabetical, pull hooks into their own table. | |
9798 | |
9799 @c Local Variables: | |
9800 @c sentence-end-double-space: nil | |
9801 @c End: | |
9802 | |
9803 @ignore | |
9804 arch-tag: b778477d-1a10-4a99-84de-f877a2ea6bef | |
9805 @end ignore |