Mercurial > hg > xemacs-beta
diff man/vm.texi @ 20:859a2309aef8 r19-15b93
Import from CVS: tag r19-15b93
author | cvs |
---|---|
date | Mon, 13 Aug 2007 08:50:05 +0200 |
parents | 49a24b4fd526 |
children | 131b0175ea99 |
line wrap: on
line diff
--- a/man/vm.texi Mon Aug 13 08:49:44 2007 +0200 +++ b/man/vm.texi Mon Aug 13 08:50:05 2007 +0200 @@ -433,9 +433,9 @@ version of the folder until the folder is saved.@refill Typing @kbd{h} (@code{vm-summarize}) causes VM to pop up a window -containing a summary of contents of the current folder. The summary is +containing a summary of the contents of the current folder. The summary is presented one line per message, by message number, listing each message's -author, date sent, line and byte count, and subject. Also various +author, date sent, line and byte count, and subject. Also, various letters appear beside the message number to indicate that a message is new, unread, flagged for deletion, etc. An arrow @samp{->} appears to the left of the line summarizing the current message. The summary @@ -487,7 +487,7 @@ file. Since VM has in excess of forty configuration variables, use of the @file{~/.vm} can considerably reduce clutter in the @file{.emacs} file. You can force the reloading of this file on demand by typing -@kbd{L} from within VM.@refill +@kbd{L} (@code{vm-load-init-file}) from within VM.@refill @findex vm @vindex vm-primary-inbox @@ -545,15 +545,15 @@ The variable @code{vm-startup-with-summary} controls whether VM automatically displays a summary of the folder's contents at startup. A value of @code{nil} gives no summary; a value of @code{t} gives a full -screen summary. A value that is neither @code{t} nor @code{nil} splits -the screen between the summary and the folder display. The latter only +frame summary. A value that is neither @code{t} nor @code{nil} splits +the frame between the summary and the folder display. The latter only works if the variable @code{pop-up-windows}'s value is non-@code{nil}, and the value of @code{vm-mutable-windows} is non-@code{nil}. The default value of @code{vm-startup-with-summary} is @code{nil}.@refill @vindex vm-mail-window-percentage The variable @code{vm-mail-window-percentage} tells VM what percentage of -the screen should be given to the folder display when both it and the +the frame should be given to the folder display when both it and the folder summary are being displayed. Note that Emacs enforces a minimum window size limit, so a very high or very low value for this variable may squeeze out one of the displays entirely. This variable's default @@ -583,7 +583,7 @@ (@code{vm-next-message}) and @kbd{p} (@code{vm-previous-message}). These commands move forward and backward through the current folder. When they go beyond the end or beginning of the folder they wrap to the -beginning and end respectively. By default these commands skip messages +beginning and end respectively. By default, these commands skip messages flagged for deletion. This behavior can be disabled by setting the value of the variable @code{vm-skip-deleted-messages} to @code{nil}. These commands can also be made to skip messages that have been read; set @@ -616,12 +616,7 @@ Other commands to select messages: -@iftex -@table @asis -@end iftex -@ifinfo -@table @key -@end ifinfo +@table @kbd @findex vm-goto-message @kindex RET @item RET (@code{vm-goto-message}) @@ -668,7 +663,7 @@ @node Reading Messages, Sending Messages, Selecting Messages, Top @chapter Reading Messages -Once a message has been selected, VM will present it to you. By default +Once a message has been selected, VM will present it to you. By default, presentation is done in two stages: @dfn{previewing} and @dfn{paging}. @menu @@ -684,9 +679,9 @@ @key{SPC} exposes the body of the message, and from there you can repeatedly type @key{SPC} to page through the message. -By default the sender, recipient, subject and date headers are shown +By default, the sender, recipient, subject and date headers are shown when previewing; the rest of the message is hidden. This behavior may -be altered by changing the settings of two variables: +be altered by changing the settings of three variables: @code{vm-visible-headers}, @code{vm-invisible-header-regexp} and @code{vm-preview-lines}.@refill @@ -731,7 +726,7 @@ causes the From and Subject headers to be highlighted.@refill @vindex vm-preview-read-messages -By default VM previews all messages, even if they have already been read. +By default, VM previews all messages, even if they have already been read. To have VM preview only those messages that have not been read, set the value of @code{vm-preview-read-messages} to @code{nil}. @@ -770,17 +765,12 @@ GNU Emacs Manual}. However, @samp{*mail*} buffers created by VM have extra command keys: -@iftex -@table @asis -@end iftex -@ifinfo -@table @key -@end ifinfo +@table @kbd @findex vm-yank-message @kindex C-c C-y @item C-c C-y (@code{vm-yank-message}) Copies a message from the current folder into the @samp{*mail*} buffer. -The message number is read from the minibuffer. By default each line of +The message number is read from the minibuffer. By default, each line of the copy is prepended with the value of the variable @code{vm-included-text-prefix}. All message headers are yanked along with the text. Point is left before the inserted text, the mark after. @@ -808,12 +798,12 @@ described above. @code{vm-mail} can be invoked outside of VM by typing @kbd{M-x vm-mail}. -However, of the above commands, only @key{C-c y} +However, of the above commands, only @kbd{C-c y} (@code{vm-yank-message-other-folder}) will work; all the other commands require a parent folder.@refill If you send a message and it is returned by the mail system because it -was undeliverable, you an easily resend the message by typing @kbd{M-r} +was undeliverable, you can easily resend the message by typing @kbd{M-r} (@code{vm-resend-bounced-message}). VM will extract the old message and its pertinent headers from the returned message, and place you in a @samp{*mail*} buffer. You can then change the recipient addresses or do @@ -830,7 +820,7 @@ @vindex vm-reply-subject-prefix VM has special commands that make it easy to reply to a message. When a -reply command is invoked VM fills in the subject and recipient headers +reply command is invoked, VM fills in the subject and recipient headers for you, since it is apparent to whom the message should be sent and what the subject should be. There is an old convention of prepending the string @samp{"Re: "} to the subject of replies if the string isn't @@ -877,12 +867,7 @@ The reply commands are: -@iftex -@table @asis -@end iftex -@ifinfo -@table @key -@end ifinfo +@table @kbd @findex vm-reply @kindex r @item r (@code{vm-reply}) @@ -932,7 +917,7 @@ except the current message appears as the body of the message in the @samp{*mail*} buffer. The forwarded message is surrounded by RFC 934 compliant message delimiters. If the variable -@code{vm-rfc934-forwarding} is non-@code{nil} "^-" to "- -" character +@code{vm-rfc934-forwarding} is non-@code{nil}, "^-" to "- -" character stuffing is done to the forwarded message (this is the default). This behavior is required if the recipient of the forwarded message wants to use a RFC 934 standard bursting agent to access the message. If the @@ -1009,13 +994,13 @@ the default when prompting for a folder to save the message in. If the resulting folder name is a relative pathname it resolves to the directory named by @code{vm-folder-directory}, or the @code{default-directory} of -the currently visited folder if @code{vm-folder-directory} is nil.@refill +the currently visited folder if @code{vm-folder-directory} is @code{nil}.@refill When @var{folder-name} is evaluated, the current buffer will contain only the contents of the header named by @var{header-name}. It is safe to modify this buffer. You can use the match data from any @samp{\( @dots{} \)} grouping constructs in @var{regexp} along with the function -buffer-substring to build a folder name based on the header information. +@code{buffer-substring} to build a folder name based on the header information. If the result of evaluating @var{folder-name} is a list, then the list will be treated as another auto-folder-alist and will be descended recursively.@refill @@ -1047,18 +1032,13 @@ @vindex vm-delete-after-saving After a message is saved to a folder, the usual thing to do next is to delete it. If the variable @code{vm-delete-after-saving} is -non-@code{nil} VM will flag messages for deletion automatically after -saving them. This applies only to saves to folders, not for the @key{w} +non-@code{nil}, VM will flag messages for deletion automatically after +saving them. This applies only to saves to folders, not for the @kbd{w} command (see below).@refill Other commands: -@iftex -@table @asis -@end iftex -@ifinfo -@table @key -@end ifinfo +@table @kbd @findex vm-save-message-sans-headers @kindex w @item w (@code{vm-save-message-sans-headers}) @@ -1075,8 +1055,8 @@ @findex vm-pipe-message-to-command @kindex | @item | (@code{vm-pipe-message-to-command}) -Runs a shell command with the some or all of the current message as input. -By default the entire message is used.@* +Runs a shell command with some or all of the current message as input. +By default, the entire message is used.@* @* If invoked with one @t{C-u} the text portion of the message is used.@* If invoked with two @t{C-u}'s the header portion of the message is used.@* @@ -1092,12 +1072,7 @@ @dfn{expunged} or removed from the folder. The messages are not removed from the on-disk copy of the folder until the folder is saved. -@iftex -@table @asis -@end iftex -@ifinfo -@table @key -@end ifinfo +@table @kbd @findex vm-delete-message @kindex d @item d (@code{vm-delete-message}) @@ -1115,7 +1090,7 @@ @findex vm-kill-subject @kindex k @item k (@code{vm-kill-subject}) -Flags all message with the same subject as the current message (ignoring +Flags all messages with the same subject as the current message (ignoring ``Re:'') for deletion. @findex vm-expunge-folder @kindex # @@ -1166,17 +1141,17 @@ messages in the summary window.@refill To remove a mark from the current message, use @kbd{C-c SPC} -(@code{vm-unmark-message}. Prefix arguments work as with +(@code{vm-unmark-message}). Prefix arguments work as with @code{vm-mark-message}.@refill -Use @kbd{C-c C-a} to mark all message in the current folder; @kbd{C-c a} +Use @kbd{C-c C-a} to mark all messages in the current folder; @kbd{C-c a} removes marks from all messages. To apply a VM command to all marked message you must prefix it with the key sequence @kbd{C-c RET} (@code{vm-next-command-uses-marks}). The next VM command will apply to all marked messages, provided the command can be applied to such messages in a meaningful and useful way. -The current commands that can be applied to marked message are: +The current commands that can be applied to marked messages are: @code{vm-delete-message}, @code{vm-discard-cached-data}, @code{vm-followup}, @code{vm-followup-include-text}, @code{vm-reply}, @code{vm-reply-include-text}, @code{vm-save-message}, @@ -1207,7 +1182,7 @@ @kindex G In order to make numerous related messages easier to cope with, VM provides the command @kbd{G} (@code{vm-group-messages}), which groups -all message in a folder according to some criterion. @dfn{Grouping} +all messages in a folder according to some criterion. @dfn{Grouping} causes messages that are related in some way to be presented consecutively. The actual order of the folder is not altered; the messages are simply numbered and presented differently. Grouping @@ -1235,8 +1210,8 @@ If the variable @code{vm-group-by} has a non-@code{nil} value it specifies the default grouping that will be used for all folders. So if you like having your mail presented to you grouped by subject, then put -@code{(setq vm-group-by "subject")} in your @file{.emacs} file to get this -behavior.@refill +@code{(setq vm-group-by "subject")} in your @file{.vm} or @file{.emacs} +file to get this behavior.@refill @node Reading Digests, Summaries, Grouping Messages, Top @chapter Reading Digests @@ -1250,7 +1225,7 @@ @findex vm-burst-digest @kindex * The command @kbd{*} (@code{vm-burst-digest}) bursts a digest into its -individual messages and appends them to current folder. These +individual messages and appends them to the current folder. These messages are then assimilated into the current folder using the default grouping. @xref{Grouping Messages}. The original digest message is not altered, and the messages extracted from it are not part of the on-disk copy @@ -1274,10 +1249,11 @@ arrow @samp{->} appears to the left of the line summarizing the current message. The variable @code{vm-auto-center-summary} controls whether VM will keep the summary arrow vertically centered within the summary -window. A value of @code{t} causes VM to always keep arrow centered. A -value of @code{nil} means VM will never bother centering the arrow. A -value that is not @code{nil} and not @code{t} causes VM to center the -arrow only if the summary window is not the only existing window.@refill +window. A value of @code{t} causes VM to always keep the arrow +centered. A value of @code{nil} (the default) means VM will never +bother centering the arrow. A value that is not @code{nil} and not +@code{t} causes VM to center the arrow only if the summary window is not +the only existing window.@refill @vindex vm-summary-format The variable @code{vm-summary-format} controls the format of each @@ -1355,20 +1331,15 @@ Here are some VM customization variables that don't really fit into the other chapters. -@iftex -@table @asis -@end iftex -@ifinfo @table @code -@end ifinfo @vindex vm-confirm-quit @item vm-confirm-quit -A value of t causes VM to always ask for confirmation before ending -a VM visit of a folder. A nil value means VM will ask only when messages -will be lost unwittingly by quitting, i.e. not removed by intentional -delete and expunge. A value that is not nil and not t causes VM to ask -only when there are unsaved changes to message attributes or message -will be lost. +A value of @code{t} causes VM to always ask for confirmation before +ending a VM visit of a folder. A @code{nil} value means VM will ask +only when messages will be lost unwittingly by quitting, i.e. not +removed by intentional delete and expunge. A value that is neither +@code{nil} nor @code{t} causes VM to ask only when there are unsaved +changes to message attributes or message will be lost. @vindex vm-berkeley-mail-compatibility @item vm-berkeley-mail-compatibility A non-@code{nil} value means to read and write BSD @i{Mail(1)} style Status: @@ -1392,7 +1363,7 @@ @vindex vm-mutable-windows @item vm-mutable-windows This variable's value controls VM's window usage. A value of @code{t} gives VM -free run of the Emacs display; it will commandeer the entire screen for +free run of the Emacs display; it will commandeer the entire frame for its purposes. A value of @code{nil} restricts VM's window usage to the window from which it was invoked. VM will not create, delete, or use any other windows, nor will it resize its own window. A value that is neither @code{t}