From bc2e6acfb9185cb72108f6cbc92e062d723996b6 Mon Sep 17 00:00:00 2001 From: Chris Hanson Date: Tue, 11 Jul 2000 22:06:07 +0000 Subject: [PATCH] Add Summaries section. --- v7/doc/imail/imail.texinfo | 184 ++++++++++++++++++++++++++++++++++++- 1 file changed, 183 insertions(+), 1 deletion(-) diff --git a/v7/doc/imail/imail.texinfo b/v7/doc/imail/imail.texinfo index 353aa5c0a..0eb4716c7 100644 --- a/v7/doc/imail/imail.texinfo +++ b/v7/doc/imail/imail.texinfo @@ -2,7 +2,7 @@ @iftex @finalout @end iftex -@comment $Id: imail.texinfo,v 1.6 2000/07/11 21:04:28 cph Exp $ +@comment $Id: imail.texinfo,v 1.7 2000/07/11 22:06:07 cph Exp $ @comment %**start of header (This is for running Texinfo on a region.) @setfilename imail.info @settitle IMAIL User's Manual @@ -943,6 +943,120 @@ already composing, or to alter a message you have sent. @node Summaries, Other Commands, Sending Replies, Commands @section Summaries +A @dfn{summary} is a buffer containing one line per message to give you +an overview of the mail in an @acronym{IMAIL} folder. Each line shows +the message number, the sender, the flags, and the subject. Almost all +@acronym{IMAIL} commands are valid in the summary buffer also; these +apply to the message described by the current line of the summary. +Moving point in the summary buffer selects messages as you move to their +summary lines. + +A summary buffer applies to a single @acronym{IMAIL} folder only; if you +are editing multiple @acronym{IMAIL} folders, each one can have its own +summary buffer. The summary buffer name is made by appending +@samp{-summary} to the @acronym{IMAIL} buffer's name. Normally only one +summary buffer is displayed at a time. + +@menu +* Making Summaries:: +* Editing in Summaries:: +@end menu + +@node Making Summaries, Editing in Summaries, Summaries, Summaries +@subsection Making Summaries + +Here are the commands to create a summary for the current +@acronym{IMAIL} folder. Once the @acronym{IMAIL} folder has a summary +buffer, changes in the @acronym{IMAIL} folder (such as deleting or +expunging messages, and getting new mail) automatically update the +summary. + +@table @kbd +@item h +@itemx C-M-h +Summarize all messages (@code{imail-summary}). +@item l @var{flags} @key{RET} +@itemx C-M-l @var{flags} @key{RET} +Summarize messages that have one or more of the specified flags +(@code{imail-summary-by-flags}). +@item C-M-r @var{rcpts} @key{RET} +Summarize messages that have one or more of the specified recipients +(@code{imail-summary-by-recipients}). +@item C-M-t @var{topic} @key{RET} +Summarize messages that have a match for the specified regexp +@var{topic} in their subjects (@code{imail-summary-by-topic}). +@end table + +@kindex h +@findex imail-summary +The @kbd{h} or @kbd{C-M-h} (@code{imail-summary}) command fills the +summary buffer for the current @acronym{IMAIL} folder with a summary of +all the messages in the folder. It then displays and selects the +summary buffer in another window. + +@kindex l +@kindex C-M-l +@findex imail-summary-by-flags +@kbd{C-M-l @var{flags} @key{RET}} (@code{imail-summary-by-flags}) makes +a partial summary mentioning only the messages that have one or more of +the flags @var{flags}. @var{flags} should contain flag names separated +by commas. + +@kindex C-M-r +@findex imail-summary-by-recipients +@kbd{C-M-r @var{rcpts} @key{RET}} (@code{imail-summary-by-recipients}) +makes a partial summary mentioning only the messages that have one or +more of the recipients @var{rcpts}. @var{rcpts} should contain mailing +addresses separated by commas. + +@kindex C-M-t +@findex imail-summary-by-topic +@kbd{C-M-t @var{topic} @key{RET}} (@code{imail-summary-by-topic}) makes +a partial summary mentioning only the messages whose subjects have a +match for the regular expression @var{topic}. + +Note that there is only one summary buffer for any @acronym{IMAIL} +folder; making one kind of summary discards any previously made summary. + +@node Editing in Summaries, , Making Summaries, Summaries +@subsection Editing in Summaries + +You can use the @acronym{IMAIL} summary buffer to do almost anything you +can do in the @acronym{IMAIL} buffer itself. In fact, once you have a +summary buffer, there's no need to switch back to the @acronym{IMAIL} +buffer. + +You can select and display various messages in the @acronym{IMAIL} +buffer, from the summary buffer, just by moving point in the summary +buffer to different lines. It doesn't matter what Emacs command you use +to move point; whichever line point is on at the end of the command, +that message is selected in the @acronym{IMAIL} buffer. + +Almost all @acronym{IMAIL} commands work in the summary buffer as well +as in the @acronym{IMAIL} buffer. Thus, @kbd{d} in the summary buffer +deletes the current message, @kbd{u} undeletes, and @kbd{x} expunges. +@kbd{o} and @kbd{C-o} output the current message to a folder; @kbd{r} +starts a reply to it. You can scroll the current message while +remaining in the summary buffer using @key{SPC} and @key{DEL}. + +@kindex SPC +@findex imail-summary-select-message +The @acronym{IMAIL} commands to move between messages also work in the +summary buffer, but with a twist: they move through the set of messages +included in the summary. They also ensure the @acronym{IMAIL} buffer +appears on the screen (unlike cursor motion commands, which update the +contents of the @acronym{IMAIL} buffer but don't display it in a window +unless it already appears). You can always display the message indicated +by point using the @key{SPC} command (@code{imail-summary-select-message}). + +@kindex q +@findex imail-summary-quit +When you are finished using the summary, type @kbd{C-x k @key{RET}} to +delete the summary buffer's window. You can also exit @acronym{IMAIL} +while in the summary: @kbd{q} (@code{imail-summary-quit}) deletes the +summary window, then exits from @acronym{IMAIL} by saving the Imail +folder and switching to another buffer. + @node Other Commands, Differences between IMAIL and Rmail, Summaries, Commands @section Other Commands @@ -962,6 +1076,74 @@ already composing, or to alter a message you have sent. @node Variables, GNU Free Documentation License, Commands, Top @chapter Variables +@menu +* Appearance Options:: +* Primary Folder:: +* Mail-Sending Options:: +* Summary Options:: +* Other Variables:: +@end menu + +@node Appearance Options, Primary Folder, Variables, Variables +@section Appearance Options + +@example +(@code{imail-auto-wrap}) +(@code{imail-global-mail-notification}) +(@code{imail-ignored-headers}) +(@code{imail-inline-mime-text-subtypes}) +(@code{imail-kept-headers}) +(@code{imail-known-mime-charsets}) +(@code{imail-message-filter}) +(@code{imail-mime-show-alternatives}) +(@code{imail-use-original-mime-boundaries}) +@end example + +@node Primary Folder, Mail-Sending Options, Appearance Options, Variables +@section Primary Folder + +@example +(@code{imail-default-imap-mailbox}) +(@code{imail-default-imap-server}) +(@code{imail-default-user-id}) +(@code{imail-primary-folder}) +@end example + +@node Mail-Sending Options, Summary Options, Primary Folder, Variables +@section Mail-Sending Options + +@example +(@code{imail-default-dont-reply-to-names}) +(@code{imail-dont-reply-to-names}) +(@code{imail-forward-all-headers}) +(@code{imail-forward-using-mime}) +(@code{imail-reply-with-re}) +@end example + +@node Summary Options, Other Variables, Mail-Sending Options, Variables +@section Summary Options + +@example +(@code{imail-summary-highlight-message}) +(@code{imail-summary-mode-hook}) +(@code{imail-summary-pop-up-message}) +(@code{imail-summary-show-date}) +(@code{imail-summary-subject-width}) +@end example + +@node Other Variables, , Summary Options, Variables +@section Other Variables + +@example +(@code{imail-body-cache-limit}) +(@code{imail-delete-after-output}) +(@code{imail-expunge-confirmation}) +(@code{imail-mime-attachment-directory}) +(@code{imail-mode-hook}) +(@code{imail-pass-phrase-retention-time}) +(@code{imail-update-interval}) +@end example + @node GNU Free Documentation License, Key Index, Variables, Top @unnumbered GNU Free Documentation License -- 2.25.1