diff options
| author | Glenn Morris | 2009-03-01 01:00:47 +0000 |
|---|---|---|
| committer | Glenn Morris | 2009-03-01 01:00:47 +0000 |
| commit | 9d5de6f80be4c4a7a04cb272262073bfb30f05f2 (patch) | |
| tree | ead598572cd4b46ec8e4f9f7b867e9639fb3cee4 | |
| parent | 017166cefcfb4024981f38c46d6154ef92709aad (diff) | |
| download | emacs-9d5de6f80be4c4a7a04cb272262073bfb30f05f2.tar.gz emacs-9d5de6f80be4c4a7a04cb272262073bfb30f05f2.zip | |
(Rmail): Fix some typos.
(Rmail Motion): - M-s searches from the end of messages.
(Rmail Deletion): Minor clarification. Fix numeric argument
description.
(Rmail Inbox): Fix default inbox description. Mention `mbox' by name.
newmail and RMAILOSE files need not be in home-directory.
(Rmail Files): Mention I/O menus are unselectable if no files match.
Mention `MAIL' env-var.
| -rw-r--r-- | doc/emacs/ChangeLog | 11 | ||||
| -rw-r--r-- | doc/emacs/rmail.texi | 90 |
2 files changed, 61 insertions, 40 deletions
diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index af93590df55..50568fcdb04 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog | |||
| @@ -1,3 +1,14 @@ | |||
| 1 | 2009-03-01 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * rmail.texi (Rmail): Fix some typos. | ||
| 4 | (Rmail Motion): - M-s searches from the end of messages. | ||
| 5 | (Rmail Deletion): Minor clarification. Fix numeric argument | ||
| 6 | description. | ||
| 7 | (Rmail Inbox): Fix default inbox description. Mention `mbox' by name. | ||
| 8 | newmail and RMAILOSE files need not be in home-directory. | ||
| 9 | (Rmail Files): Mention I/O menus are unselectable if no files match. | ||
| 10 | Mention `MAIL' env-var. | ||
| 11 | |||
| 1 | 2009-02-24 Jason Rumney <jasonr@gnu.org> | 12 | 2009-02-24 Jason Rumney <jasonr@gnu.org> |
| 2 | 13 | ||
| 3 | * mule.texi (Fontsets): Mention fontset-default, font specs and | 14 | * mule.texi (Fontsets): Mention fontset-default, font specs and |
diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index 0b64a1713b7..70b135469be 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi | |||
| @@ -12,7 +12,7 @@ | |||
| 12 | 12 | ||
| 13 | Rmail is an Emacs subsystem for reading and disposing of mail that | 13 | Rmail is an Emacs subsystem for reading and disposing of mail that |
| 14 | you receive. Rmail stores mail messages in files called Rmail files. | 14 | you receive. Rmail stores mail messages in files called Rmail files. |
| 15 | Reading the message in an Rmail file is done in a special major mode, | 15 | Reading the messages in an Rmail file is done in a special major mode, |
| 16 | Rmail mode, which redefines most letters to run commands for managing mail. | 16 | Rmail mode, which redefines most letters to run commands for managing mail. |
| 17 | @menu | 17 | @menu |
| 18 | * Basic: Rmail Basics. Basic concepts of Rmail, and simple use. | 18 | * Basic: Rmail Basics. Basic concepts of Rmail, and simple use. |
| @@ -21,7 +21,7 @@ Rmail mode, which redefines most letters to run commands for managing mail. | |||
| 21 | * Deletion: Rmail Deletion. Deleting and expunging messages. | 21 | * Deletion: Rmail Deletion. Deleting and expunging messages. |
| 22 | * Inbox: Rmail Inbox. How mail gets into the Rmail file. | 22 | * Inbox: Rmail Inbox. How mail gets into the Rmail file. |
| 23 | * Files: Rmail Files. Using multiple Rmail files. | 23 | * Files: Rmail Files. Using multiple Rmail files. |
| 24 | * Output: Rmail Output. Copying message out to files. | 24 | * Output: Rmail Output. Copying messages out to files. |
| 25 | * Labels: Rmail Labels. Classifying messages by labeling them. | 25 | * Labels: Rmail Labels. Classifying messages by labeling them. |
| 26 | * Attrs: Rmail Attributes. Certain standard labels, called attributes. | 26 | * Attrs: Rmail Attributes. Certain standard labels, called attributes. |
| 27 | * Reply: Rmail Reply. Sending replies to messages you are viewing. | 27 | * Reply: Rmail Reply. Sending replies to messages you are viewing. |
| @@ -35,7 +35,7 @@ Rmail mode, which redefines most letters to run commands for managing mail. | |||
| 35 | * Movemail:: More details of fetching new mail. | 35 | * Movemail:: More details of fetching new mail. |
| 36 | * Remote Mailboxes:: Retrieving Mail from Remote Mailboxes. | 36 | * Remote Mailboxes:: Retrieving Mail from Remote Mailboxes. |
| 37 | * Other Mailbox Formats:: Retrieving Mail from Local Mailboxes in | 37 | * Other Mailbox Formats:: Retrieving Mail from Local Mailboxes in |
| 38 | Various Formats | 38 | Various Formats. |
| 39 | @end menu | 39 | @end menu |
| 40 | 40 | ||
| 41 | @node Rmail Basics | 41 | @node Rmail Basics |
| @@ -125,6 +125,8 @@ for one thing, it does not set the mark; for another, it resets the buffer | |||
| 125 | boundaries to the current message if you have changed them. Similarly, | 125 | boundaries to the current message if you have changed them. Similarly, |
| 126 | the command @kbd{/} (@code{rmail-end-of-message}) scrolls forward to the end | 126 | the command @kbd{/} (@code{rmail-end-of-message}) scrolls forward to the end |
| 127 | of the selected message. | 127 | of the selected message. |
| 128 | @c The comment about buffer boundaries is still true in mbox Rmail, if | ||
| 129 | @c less likely to be relevant. | ||
| 128 | 130 | ||
| 129 | @node Rmail Motion | 131 | @node Rmail Motion |
| 130 | @section Moving Among Messages | 132 | @section Moving Among Messages |
| @@ -202,7 +204,8 @@ that message. If @var{regexp} is empty, @kbd{M-s} reuses the regexp | |||
| 202 | used the previous time. | 204 | used the previous time. |
| 203 | 205 | ||
| 204 | To search backward in the file for another message, give @kbd{M-s} a | 206 | To search backward in the file for another message, give @kbd{M-s} a |
| 205 | negative argument. In Rmail you can do this with @kbd{- M-s}. | 207 | negative argument. In Rmail you can do this with @kbd{- M-s}. This |
| 208 | begins searching from the end of the previous message. | ||
| 206 | 209 | ||
| 207 | It is also possible to search for a message based on labels. | 210 | It is also possible to search for a message based on labels. |
| 208 | @xref{Rmail Labels}. | 211 | @xref{Rmail Labels}. |
| @@ -242,8 +245,8 @@ Delete the current message, and move to the next nondeleted message | |||
| 242 | Delete the current message, and move to the previous nondeleted | 245 | Delete the current message, and move to the previous nondeleted |
| 243 | message (@code{rmail-delete-backward}). | 246 | message (@code{rmail-delete-backward}). |
| 244 | @item u | 247 | @item u |
| 245 | Undelete the current message, or move back to a deleted message and | 248 | Undelete the current message, or move back to the previous deleted |
| 246 | undelete it (@code{rmail-undelete-previous-message}). | 249 | message and undelete it (@code{rmail-undelete-previous-message}). |
| 247 | @item x | 250 | @item x |
| 248 | Expunge the Rmail file (@code{rmail-expunge}). | 251 | Expunge the Rmail file (@code{rmail-expunge}). |
| 249 | @end table | 252 | @end table |
| @@ -257,10 +260,12 @@ current message and select another message. @kbd{d} | |||
| 257 | (@code{rmail-delete-forward}) moves to the following message, skipping | 260 | (@code{rmail-delete-forward}) moves to the following message, skipping |
| 258 | messages already deleted, while @kbd{C-d} (@code{rmail-delete-backward}) | 261 | messages already deleted, while @kbd{C-d} (@code{rmail-delete-backward}) |
| 259 | moves to the previous nondeleted message. If there is no nondeleted | 262 | moves to the previous nondeleted message. If there is no nondeleted |
| 260 | message to move to in the specified direction, the message that was just | 263 | message to move to in the specified direction, these commands move to |
| 261 | deleted remains current. @kbd{d} with a numeric argument is | 264 | the last or first message. With a numeric argument, these commands |
| 262 | equivalent to @kbd{C-d}. | 265 | delete the specified number of messages. @kbd{d} with a negative |
| 266 | numeric argument is equivalent to @kbd{C-d}, and vice versa. | ||
| 263 | 267 | ||
| 268 | @c mention other hooks, eg show message hook? | ||
| 264 | @vindex rmail-delete-message-hook | 269 | @vindex rmail-delete-message-hook |
| 265 | Whenever Rmail deletes a message, it runs the hook | 270 | Whenever Rmail deletes a message, it runs the hook |
| 266 | @code{rmail-delete-message-hook}. When the hook functions are invoked, | 271 | @code{rmail-delete-message-hook}. When the hook functions are invoked, |
| @@ -313,15 +318,16 @@ any time in Rmail by typing @kbd{g}. | |||
| 313 | @cindex @env{MAIL} environment variable | 318 | @cindex @env{MAIL} environment variable |
| 314 | The variable @code{rmail-primary-inbox-list} contains a list of the | 319 | The variable @code{rmail-primary-inbox-list} contains a list of the |
| 315 | files which are inboxes for your primary Rmail file. If you don't set | 320 | files which are inboxes for your primary Rmail file. If you don't set |
| 316 | this variable explicitly, it is initialized from the @env{MAIL} | 321 | this variable explicitly, Rmail uses the @env{MAIL} environment |
| 317 | environment variable, or, as a last resort, set to @code{nil}, which | 322 | variable, or, as a last resort, a default inbox based on |
| 318 | means to use the default inbox. The default inbox file depends on | 323 | @code{rmail-spool-directory}. The default inbox file depends on your |
| 319 | your operating system; often it is @file{/var/mail/@var{username}}, | 324 | operating system; often it is @file{/var/mail/@var{username}}, |
| 320 | @file{/usr/spool/mail/@var{username}}, or | 325 | @file{/var/spool/mail/@var{username}}, or |
| 321 | @file{/usr/mail/@var{username}}. | 326 | @file{/usr/spool/mail/@var{username}}. |
| 322 | 327 | ||
| 323 | You can specify the inbox file(s) for any Rmail file with the | 328 | You can specify the inbox file(s) for any Rmail file for the current |
| 324 | command @code{set-rmail-inbox-list}; see @ref{Rmail Files}. | 329 | session with the command @code{set-rmail-inbox-list}; see @ref{Rmail |
| 330 | Files}. | ||
| 325 | 331 | ||
| 326 | There are two reasons for having separate Rmail files and inboxes. | 332 | There are two reasons for having separate Rmail files and inboxes. |
| 327 | 333 | ||
| @@ -341,11 +347,12 @@ all into a separate Rmail file avoids the need for interlocking in all | |||
| 341 | the rest of Rmail, since only Rmail operates on the Rmail file. | 347 | the rest of Rmail, since only Rmail operates on the Rmail file. |
| 342 | @end enumerate | 348 | @end enumerate |
| 343 | 349 | ||
| 344 | Rmail was originally written to use Babyl as its internal format. | 350 | Rmail was originally written to use the Babyl format as its internal |
| 345 | Since then, we have recognized that the usual inbox format on Unix and | 351 | format. Since then, we have recognized that the usual inbox format |
| 346 | GNU systems is adequate for the job, and so since Emacs 23 Rmail uses | 352 | (@samp{mbox}) on Unix and GNU systems is adequate for the job, and so |
| 347 | that as its internal format. The Rmail file is still separate from the | 353 | since Emacs 23 Rmail uses that as its internal format. The Rmail file |
| 348 | inbox file, even though their format is the same. | 354 | is still separate from the inbox file, even though their format is the |
| 355 | same. | ||
| 349 | 356 | ||
| 350 | @vindex rmail-preserve-inbox | 357 | @vindex rmail-preserve-inbox |
| 351 | When getting new mail, Rmail first copies the new mail from the | 358 | When getting new mail, Rmail first copies the new mail from the |
| @@ -361,20 +368,20 @@ on the server and you can save it later on your workstation. | |||
| 361 | In some cases, Rmail copies the new mail from the inbox file | 368 | In some cases, Rmail copies the new mail from the inbox file |
| 362 | indirectly. First it runs the @code{movemail} program to move the mail | 369 | indirectly. First it runs the @code{movemail} program to move the mail |
| 363 | from the inbox to an intermediate file called | 370 | from the inbox to an intermediate file called |
| 364 | @file{~/.newmail-@var{inboxname}}. Then Rmail merges the new mail from | 371 | @file{.newmail-@var{inboxname}}, in the same directory as the Rmail |
| 365 | that file, saves the Rmail file, and only then deletes the intermediate | 372 | file. Then Rmail merges the new mail from that file, saves the Rmail |
| 366 | file. If there is a crash at the wrong time, this file continues to | 373 | file, and only then deletes the intermediate file. If there is a crash |
| 367 | exist, and Rmail will use it again the next time it gets new mail from | 374 | at the wrong time, this file continues to exist, and Rmail will use it |
| 368 | that inbox. | 375 | again the next time it gets new mail from that inbox. |
| 369 | 376 | ||
| 370 | If Rmail is unable to convert the data in | 377 | If Rmail is unable to convert the data in |
| 371 | @file{~/.newmail-@var{inboxname}} into mbox format, it renames the file | 378 | @file{.newmail-@var{inboxname}} into mbox format, it renames the file to |
| 372 | to @file{~/RMAILOSE.@var{n}} (@var{n} is an integer chosen to make the | 379 | @file{RMAILOSE.@var{n}} (@var{n} is an integer chosen to make the name |
| 373 | name unique) so that Rmail will not have trouble with the data again. | 380 | unique) so that Rmail will not have trouble with the data again. You |
| 374 | You should look at the file, find whatever message confuses Rmail | 381 | should look at the file, find whatever message confuses Rmail (probably |
| 375 | (probably one that includes the control-underscore character, octal code | 382 | one that includes the control-underscore character, octal code 037), and |
| 376 | 037), and delete it. Then you can use @kbd{1 g} to get new mail from | 383 | delete it. Then you can use @kbd{1 g} to get new mail from the |
| 377 | the corrected file. | 384 | corrected file. |
| 378 | 385 | ||
| 379 | @node Rmail Files | 386 | @node Rmail Files |
| 380 | @section Multiple Rmail Files | 387 | @section Multiple Rmail Files |
| @@ -423,9 +430,10 @@ choose the Input Rmail File item; then choose the Rmail file you want. | |||
| 423 | The variables @code{rmail-secondary-file-directory} and | 430 | The variables @code{rmail-secondary-file-directory} and |
| 424 | @code{rmail-secondary-file-regexp} specify which files to offer in the | 431 | @code{rmail-secondary-file-regexp} specify which files to offer in the |
| 425 | menu: the first variable says which directory to find them in; the | 432 | menu: the first variable says which directory to find them in; the |
| 426 | second says which files in that directory to offer (all those that | 433 | second says which files in that directory to offer (all those that match |
| 427 | match the regular expression). These variables also apply to choosing | 434 | the regular expression). If no files match, you cannot select this menu |
| 428 | a file for output (@pxref{Rmail Output}). | 435 | item. These variables also apply to choosing a file for output |
| 436 | (@pxref{Rmail Output}). | ||
| 429 | 437 | ||
| 430 | @ignore | 438 | @ignore |
| 431 | @findex set-rmail-inbox-list | 439 | @findex set-rmail-inbox-list |
| @@ -440,8 +448,9 @@ the Rmail file remembers it permanently until you specify a different list. | |||
| 440 | @vindex rmail-inbox-list | 448 | @vindex rmail-inbox-list |
| 441 | The inbox files to use are specified by the variable | 449 | The inbox files to use are specified by the variable |
| 442 | @code{rmail-inbox-list}, which is buffer-local in Rmail mode. As a | 450 | @code{rmail-inbox-list}, which is buffer-local in Rmail mode. As a |
| 443 | special exception, if you have specified no inbox files for your | 451 | special exception, if you have specified no inbox files for your primary |
| 444 | primary Rmail file, it uses your standard system inbox. | 452 | Rmail file, it uses the @env{MAIL} environment variable, or your |
| 453 | standard system inbox. | ||
| 445 | 454 | ||
| 446 | @kindex g @r{(Rmail)} | 455 | @kindex g @r{(Rmail)} |
| 447 | @findex rmail-get-new-mail | 456 | @findex rmail-get-new-mail |
| @@ -510,7 +519,8 @@ that file, like the @kbd{o} command. The variables | |||
| 510 | @code{rmail-secondary-file-regexp} specify which files to offer in the | 519 | @code{rmail-secondary-file-regexp} specify which files to offer in the |
| 511 | menu: the first variable says which directory to find them in; the | 520 | menu: the first variable says which directory to find them in; the |
| 512 | second says which files in that directory to offer (all those that | 521 | second says which files in that directory to offer (all those that |
| 513 | match the regular expression). | 522 | match the regular expression). If no files match, you cannot select |
| 523 | this menu item. | ||
| 514 | 524 | ||
| 515 | @vindex rmail-delete-after-output | 525 | @vindex rmail-delete-after-output |
| 516 | Copying a message with @kbd{o} or @kbd{C-o} gives the original copy | 526 | Copying a message with @kbd{o} or @kbd{C-o} gives the original copy |