xemacs-beta: man/vm.texi comparison

comparison man/vm.texi @ 10:49a24b4fd526 r19-15b6

Import from CVS: tag r19-15b6

author	cvs
date	Mon, 13 Aug 2007 08:47:52 +0200
parents	376386a54a3c
children	859a2309aef8

comparison

equal deleted inserted replaced

-:6f2bbbbbe05a
+:49a24b4fd526
 \input texinfo  @comment -*-Texinfo-*-
-@setfilename ../info/vm.info
+@setfilename vm.info
 @settitle VM User's Manual
 @iftex
 @finalout
 @end iftex
 @c @setchapternewpage odd		% For book style double sided manual.
 are preserved on all copies.
 @end titlepage
 @page
 @ifinfo
-@node Top, Introduction, (dir), (dir)
+@node Top, Introduction,, (DIR)
 This manual documents the VM mail reader, a Lisp program which runs as a
 subsystem under Emacs.  The manual is divided into the following
 chapters.
 * Undoing::		How to undo changes to message attributes.
 * Grouping Messages::	How to make VM present similar message together.
 * Reading Digests::	How to read digests under VM.
 * Summaries::		How to view and customize the summary of a folder.
 * Miscellaneous::	Various customization variables undescribed elsewhere.
-* License::             The GNU General Public License
 Indices:
 * Key Index::		Menus of command keys and their references.
 * Command Index::	Menus of commands and their references.
 * Variable Index::	Menus of variables and their references.
 @end menu
 @end ifinfo
-@node License, , , Top
+@node License, Introduction, Variable Index, Top
 @unnumbered License
 @unnumbered GNU GENERAL PUBLIC LICENSE
 @center Version 1, February 1989
 @cindex license to copy Emacs
 Ty Coon, President of Vice
 @end example
 That's all there is to it!
-@node Introduction, Starting Up, Top, Top
+@node Introduction, Starting Up, License, Top
 @unnumbered Introduction
 VM (View Mail) is an Emacs subsystem that allows UNIX mail to be read
 and disposed of within Emacs.  Commands exist to do the normal things
 expected of a mail user agent, such as generating replies, saving
 @dfn{expunging} and it is accomplished by typing @kbd{#}
 (@code{vm-expunge-folder}).  The message is still present in the on-disk
 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 the contents of the current folder.  The summary is
+containing a summary of 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
 format is user configurable, @pxref{Summaries}.@refill
 any of these methods), it attempts to load the file @file{~/.vm}.  If
 present this file should contain Lisp code, much like the @file{.emacs}
 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} (@code{vm-load-init-file}) from within VM.@refill
+@kbd{L} from within VM.@refill
 @findex vm
 @vindex vm-primary-inbox
 @kbd{M-x vm} causes VM to gather any mail present in your system mailbox
 and append it to a file known as your @dfn{primary inbox}, creating
 @vindex vm-startup-with-summary
 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
-frame summary.  A value that is neither @code{t} nor @code{nil} splits
+screen summary.  A value that is neither @code{t} nor @code{nil} splits
-the frame between the summary and the folder display.  The latter only
+the screen 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 frame should be given to the folder display when both it and the
+the screen 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
 value is 75, which works with Emacs' default minimum window size limit,
 on a 24 line terminal.  Note that the value of @code{vm-mutable-windows}
 @vindex vm-skip-read-messages
 The primary commands for selecting messages in VM are @kbd{n}
 (@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
 @code{vm-skip-read-messages} to @code{t} to do this.
 will behave as if the value is @code{nil}.  The default value of
 @code{vm-circular-folders} is @code{0}.@refill
 Other commands to select messages:
-@table @kbd
+@iftex
+@table @asis
+@end iftex
+@ifinfo
+@table @key
+@end ifinfo
 @findex vm-goto-message
 @kindex RET
 @item RET (@code{vm-goto-message})
 Go to message number @var{n}.  @var{n} is the prefix argument, if
 provided, otherwise it is prompted for in the minibuffer.
 @end table
 @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
 * Previewing::	Customizing message previews.
 * Paging::	Scrolling and paging through the current message.
 @dfn{Previewing} is VM's way of showing you a small portion of a message
 and allowing you to decide whether you want to read it.  Typing
 @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 three variables:
+be altered by changing the settings of two variables:
 @code{vm-visible-headers}, @code{vm-invisible-header-regexp} and
 @code{vm-preview-lines}.@refill
 @vindex vm-preview-lines
 The value of @code{vm-preview-lines} should be a number that tells VM
 matches the beginnings of any header that should be presented in inverse
 video when previewing.  For example, a value of @samp{"^From\\|^Subject"}
 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}.
 @findex vm-expose-hidden-headers
 Typing @kbd{t} (@code{vm-expose-hidden-headers}) makes VM toggle
 When sending messages from within VM, you will be using the standard
 Mail major mode provided with GNU Emacs.  @xref{Mail Mode,,,emacs, the
 GNU Emacs Manual}.
 However, @samp{*mail*} buffers created by VM have extra command keys:
-@table @kbd
+@iftex
+@table @asis
+@end iftex
+@ifinfo
+@table @key
+@end ifinfo
 @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.
 Any hook functions bound to mail-yank-hooks are run, after inserting
 the text and setting point and mark.  If a prefix argument is given,
 The simplest command is @kbd{m} (@code{vm-mail}) which sends a mail
 message much as @kbd{M-x mail} does but allows the added commands
 described above.
 @code{vm-mail} can be invoked outside of VM by typing @kbd{M-x vm-mail}.
-However, of the above commands, only @kbd{C-c y}
+However, of the above commands, only @key{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 can easily resend the message by typing @kbd{M-r}
+was undeliverable, you an 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
 whatever is necessary to correct the original problem and resend the
 message.@refill
 @node Replying, Forwarding Messages, Sending Messages, Sending Messages
 @section Replying
 @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
 present already.  VM supports this indirectly by providing the variable
 @code{vm-reply-subject-prefix}.  Its value should be a string to prepend
 non-@code{nil}, the reply headers will stripped of all information but
 the actual addresses.
 The reply commands are:
-@table @kbd
+@iftex
+@table @asis
+@end iftex
+@ifinfo
+@table @key
+@end ifinfo
 @findex vm-reply
 @kindex r
 @item r (@code{vm-reply})
 Replies to the author of the current message.
 @findex vm-reply-include-text
 @vindex vm-forwarding-subject-format
 Typing @kbd{z} puts you into a @samp{*mail*} buffer just like @kbd{m},
 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
 variable @code{vm-forwarding-subject-format} is non-@code{nil} it should
 specify the format of the Subject header of the forwarded message.  This
 @var{header-name} is matched by the regular expression @var{regexp}, VM
 will evaluate the corresponding @var{folder-name} and use the result as
 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 @code{nil}.@refill
+the currently visited folder if @code{vm-folder-directory} is 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
-@code{buffer-substring} to build a folder name based on the header information.
+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
 @vindex vm-auto-folder-case-fold-search
 will append to the file itself.@refill
 @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
+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}
+saving them.  This applies only to saves to folders, not for the @key{w}
 command (see below).@refill
 Other commands:
-@table @kbd
+@iftex
+@table @asis
+@end iftex
+@ifinfo
+@table @key
+@end ifinfo
 @findex vm-save-message-sans-headers
 @kindex w
 @item w (@code{vm-save-message-sans-headers})
 Saves a message or messages to a file without their headers.  This
 command responds to a prefix argument exactly as @code{vm-save-message}
 are flagged for deletion are not saved by this command.  If invoked with a
 prefix argument, confirmation will be requested for each save.
 @findex vm-pipe-message-to-command
 @kindex |
 @item | (@code{vm-pipe-message-to-command})
-Runs a shell command with some or all of the current message as input.
+Runs a shell command with the some or all of the current message as input.
-By default, the entire message is used.@*
+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.@*
 @*
 If the shell command generates any output, it is displayed in a
 In VM, messages are flagged for deletion, and then are subsequently
 @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.
-@table @kbd
+@iftex
+@table @asis
+@end iftex
+@ifinfo
+@table @key
+@end ifinfo
 @findex vm-delete-message
 @kindex d
 @item d (@code{vm-delete-message})
 Flags the current message for deletion.  A prefix argument @var{n}
 causes the current message and the next @var{n-1} messages to be flagged.
 A negative @var{n} causes the current message and the previous @var{n-1}
 messages to be undeleted.
 @findex vm-kill-subject
 @kindex k
 @item k (@code{vm-kill-subject})
-Flags all messages with the same subject as the current message (ignoring
+Flags all message with the same subject as the current message (ignoring
 ``Re:'') for deletion.
 @findex vm-expunge-folder
 @kindex #
 @item # (@code{vm-expunge-folder})
 Does the actual removal of messages flagged for deletion in the current
 prefix argument means mark the previous @var{n-1}.  An asterisk
 (@samp{*}) will appear to the right of the message numbers of all marked
 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 messages in the current folder; @kbd{C-c a}
+Use @kbd{C-c C-a} to mark all message 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 messages are:
+The current commands that can be applied to marked message 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},
 @code{vm-save-message-sans-headers}, @code{vm-send-digest},
 @code{vm-undelete-message}, and @code{vm-unread-message}.@refill
 @findex vm-group-messages
 @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 messages in a folder according to some criterion.  @dfn{Grouping}
+all message 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
 should not be confused with sorting; grouping only moves messages that
 occur later in the folder backward to ``clump'' with other related
 @vindex vm-group-by
 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{.vm} or @file{.emacs}
+@code{(setq vm-group-by "subject")} in your @file{.emacs} file to get this
-file to get this behavior.@refill
+behavior.@refill
 @node Reading Digests, Summaries, Grouping Messages, Top
 @chapter Reading Digests
 A @dfn{digest} is one or more mail messages encapsulated in a single message.
 messages under VM.
 @findex vm-burst-digest
 @kindex *
 The command @kbd{*} (@code{vm-burst-digest}) bursts a digest into its
-individual messages and appends them to the current folder.  These
+individual messages and appends them to 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
 of the folder until a save is done.@refill
 contents of the current folder.  The information in the summary is
 automatically updated as changes are made to the current folder.  An
 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 the arrow
+window.  A value of @code{t} causes VM to always keep arrow centered.  A
-centered.  A value of @code{nil} (the default) means VM will never
+value of @code{nil} means VM will never bother centering the arrow.  A
-bother centering the arrow.  A value that is not @code{nil} and not
+value that is not @code{nil} and not @code{t} causes VM to center the
-@code{t} causes VM to center the arrow only if the summary window is not
+arrow only if the summary window is not the only existing window.@refill
-the only existing window.@refill
 @vindex vm-summary-format
 The variable @code{vm-summary-format} controls the format of each
 message's summary.  Its value should be a string.  This string should
 contain printf-like ``%'' conversion specifiers which substitute
 @chapter Miscellaneous
 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 @code{t} causes VM to always ask for confirmation before
+A value of t causes VM to always ask for confirmation before ending
-ending a VM visit of a folder.  A @code{nil} value means VM will ask
+a VM visit of a folder.  A nil value means VM will ask only when messages
-only when messages will be lost unwittingly by quitting, i.e. not
+will be lost unwittingly by quitting, i.e. not removed by intentional
-removed by intentional delete and expunge.  A value that is neither
+delete and expunge.  A value that is not nil and not t causes VM to ask
-@code{nil} nor @code{t} causes VM to ask only when there are unsaved
+only when there are unsaved changes to message attributes or message
-changes to message attributes or message will be lost.
+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:
 headers.  This makes sense if you plan to use VM to read mail archives
 created by @i{Mail}.
 A non-@code{nil} value for this variable causes VM to remove empty (zero
 length) folder files after saving them.
 @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 frame for
+free run of the Emacs display; it will commandeer the entire screen 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}
 nor @code{nil} allows VM to use other windows, but it will not create new ones,
 or resize or delete the current ones.@refill
 @node Command Index, Variable Index, Key Index, Top
 @unnumbered Command Index
 @printindex fn
-@node Variable Index, , Command Index, Top
+@node Variable Index, Introduction, Command Index, Top
 @unnumbered Variable Index
 @printindex vr
 @summarycontents
 @contents

Mercurial > hg > xemacs-beta

comparison man/vm.texi @ 10:49a24b4fd526 r19-15b6