;;; Variant Support
(defcustom-mh mh-path nil
- "*Additional list of directories to search for MH.
+ "Additional list of directories to search for MH.
See `mh-variant'."
:group 'mh-e
:type '(repeat (directory))
(mh-variants) " or "))))))
(defcustom-mh mh-variant 'autodetect
- "*Specifies the variant used by MH-E.
+ "Specifies the variant used by MH-E.
The default setting of this option is \"Auto-detect\" which means
that MH-E will automatically choose the first of nmh, MH, or GNU
;;; Aliases (:group 'mh-alias)
(defcustom-mh mh-alias-completion-ignore-case-flag t
- "*Non-nil means don't consider case significant in MH alias completion.
+ "Non-nil means don't consider case significant in MH alias completion.
As MH ignores case in the aliases, so too does MH-E. However, you
may turn off this option to make case significant which can be
:package-version '(MH-E . "7.1"))
(defcustom-mh mh-alias-expand-aliases-flag nil
- "*Non-nil means to expand aliases entered in the minibuffer.
+ "Non-nil means to expand aliases entered in the minibuffer.
In other words, aliases entered in the minibuffer will be
expanded to the full address in the message draft. By default,
:package-version '(MH-E . "7.1"))
(defcustom-mh mh-alias-flash-on-comma t
- "*Specify whether to flash address or warn on translation.
+ "Specify whether to flash address or warn on translation.
This option controls the behavior when a [comma] is pressed while
entering aliases or addresses. The default setting flashes the
:package-version '(MH-E . "7.1"))
(defcustom-mh mh-alias-insert-file nil
- "*Filename used to store a new MH-E alias.
+ "Filename used to store a new MH-E alias.
The default setting of this option is \"Use Aliasfile Profile
Component\". This option can also hold the name of a file or a
:package-version '(MH-E . "7.1"))
(defcustom-mh mh-alias-local-users t
- "*Non-nil means local users are added to alias completion.
+ "Non-nil means local users are added to alias completion.
Aliases are created from \"/etc/passwd\" entries with a user ID
larger than a magical number, typically 200. This can be a handy
:package-version '(MH-E . "7.1"))
(defcustom-mh mh-alias-local-users-prefix "local."
- "*String prefixed to the real names of users from the password file.
+ "String prefixed to the real names of users from the password file.
This option can also be set to \"Use Login\".
For example, consider the following password file entry:
:package-version '(MH-E . "7.4"))
(defcustom-mh mh-alias-passwd-gecos-comma-separator-flag t
- "*Non-nil means the gecos field in the password file uses a comma separator.
+ "Non-nil means the gecos field in the password file uses a comma separator.
In the example in `mh-alias-local-users-prefix', commas are used
to separate different values within the so-called gecos field.
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-recenter-summary-flag nil
- "*Non-nil means to recenter the summary window.
+ "Non-nil means to recenter the summary window.
If this option is turned on, recenter the summary window when the
show window is toggled off."
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-recursive-folders-flag nil
- "*Non-nil means that commands which operate on folders do so recursively."
+ "Non-nil means that commands which operate on folders do so recursively."
:type 'boolean
:group 'mh-folder
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-sortm-args nil
- "*Additional arguments for \"sortm\"\\<mh-folder-mode-map>.
+ "Additional arguments for \"sortm\"\\<mh-folder-mode-map>.
This option is consulted when a prefix argument is used with
\\[mh-sort-folder]. Normally default arguments to \"sortm\" are
:package-version '(MH-E . "8.0"))
(defcustom-mh mh-default-folder-list nil
- "*List of addresses and folders.
+ "List of addresses and folders.
The folder name associated with the first address found in this
list is used as the default for `mh-refile-msg' and similar
:package-version '(MH-E . "7.2"))
(defcustom-mh mh-default-folder-must-exist-flag t
- "*Non-nil means guessed folder name must exist to be used.
+ "Non-nil means guessed folder name must exist to be used.
If the derived folder does not exist, and this option is on, then
the last folder name used is suggested. This is useful if you get
:package-version '(MH-E . "7.2"))
(defcustom-mh mh-default-folder-prefix ""
- "*Prefix used for folder names generated from aliases.
+ "Prefix used for folder names generated from aliases.
The prefix is used to prevent clutter in your mail directory.
See `mh-prompt-for-refile-folder' and `mh-folder-from-address'
nil)))
(defcustom-mh mh-identity-list nil
- "*List of identities.
+ "List of identities.
To customize this option, click on the \"INS\" button and enter a label
such as \"Home\" or \"Work\". Then click on the \"INS\" button with the
:package-version '(MH-E . "7.3"))
(defcustom-mh mh-auto-fields-prompt-flag t
- "*Non-nil means to prompt before sending if fields inserted.
+ "Non-nil means to prompt before sending if fields inserted.
See `mh-auto-fields-list'."
:type 'boolean
:group 'mh-identity
;;; Incorporating Your Mail (:group 'mh-inc)
(defcustom-mh mh-inc-prog "inc"
- "*Program to incorporate new mail into a folder.
+ "Program to incorporate new mail into a folder.
This program generates a one-line summary for each of the new
messages. Unless it is an absolute pathname, the file is assumed
nil)))
(defcustom-mh mh-inc-spool-list nil
- "*Alternate spool files.
+ "Alternate spool files.
You can use the `mh-inc-spool-list' variable to direct MH-E to
retrieve mail from arbitrary spool files other than your system
:package-version '(MH-E . "7.4"))
(defcustom-mh mh-compose-space-does-completion-flag nil
- "*Non-nil means \\<mh-letter-mode-map>\\[mh-letter-complete-or-space] does completion in message header."
+ "Non-nil means \\<mh-letter-mode-map>\\[mh-letter-complete-or-space] does completion in message header."
:type 'boolean
:group 'mh-letter
:package-version '(MH-E . "7.4"))
(defcustom-mh mh-delete-yanked-msg-window-flag nil
- "*Non-nil means delete any window displaying the message.
+ "Non-nil means delete any window displaying the message.
This deletes the window containing the original message after
yanking it with \\<mh-letter-mode-map>\\[mh-yank-cur-msg] to make
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-extract-from-attribution-verb "wrote:"
- "*Verb to use for attribution when a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
+ "Verb to use for attribution when a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
The attribution consists of the sender's name and email address
followed by the content of this option. This option can be set to
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-ins-buf-prefix "> "
- "*String to put before each line of a yanked or inserted message.
+ "String to put before each line of a yanked or inserted message.
The prefix \"> \" is the default setting of this option. I
suggest that you not modify this option since it is used by many
:package-version '(MH-E . "6.0"))
(defcustom-mh mh-letter-complete-function 'ispell-complete-word
- "*Function to call when completing outside of address or folder fields.
+ "Function to call when completing outside of address or folder fields.
In the body of the message,
\\<mh-letter-mode-map>\\[mh-letter-complete] runs this function,
:package-version '(MH-E . "7.1"))
(defcustom-mh mh-letter-fill-column 72
- "*Fill column to use in MH Letter mode.
+ "Fill column to use in MH Letter mode.
By default, this option is 72 to allow others to quote your
message without line wrapping."
:package-version '(MH-E . "8.0"))
(defcustom-mh mh-signature-file-name "~/.signature"
- "*Source of user's signature.
+ "Source of user's signature.
By default, the text of your signature is taken from the file
\"~/.signature\". You can read from other sources by changing this
:package-version '(MH-E . "6.0"))
(defcustom-mh mh-signature-separator-flag t
- "*Non-nil means a signature separator should be inserted.
+ "Non-nil means a signature separator should be inserted.
It is not recommended that you change this option since various
mail user agents, including MH-E, use the separator to present
:package-version '(MH-E . "8.0"))
(defcustom-mh mh-x-face-file "~/.face"
- "*File containing face header field to insert in outgoing mail.
+ "File containing face header field to insert in outgoing mail.
If the file starts with either of the strings \"X-Face:\", \"Face:\"
or \"X-Image-URL:\" then the contents are added to the message header
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-yank-behavior 'attribution
- "*Controls which part of a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
+ "Controls which part of a message is yanked by \\<mh-letter-mode-map>\\[mh-yank-cur-msg].
To include the entire message, including the entire header, use
\"Body and Header\". Use \"Body\" to yank just the body without
;;; Ranges (:group 'mh-ranges)
(defcustom-mh mh-interpret-number-as-range-flag t
- "*Non-nil means interpret a number as a range.
+ "Non-nil means interpret a number as a range.
Since one of the most frequent ranges used is \"last:N\", MH-E
will interpret input such as \"200\" as \"last:200\" if this
(set-default symbol value))))
(defcustom-mh mh-adaptive-cmd-note-flag t
- "*Non-nil means that the message number width is determined dynamically.
+ "Non-nil means that the message number width is determined dynamically.
If you've created your own format to handle long message numbers,
you'll be pleased to know you no longer need it since MH-E adapts its
(set-default symbol value)))
(defcustom-mh mh-scan-prog "scan"
- "*Program used to scan messages.
+ "Program used to scan messages.
The name of the program that generates a listing of one line per
message is held in this option. Unless this variable contains an
;;; Sending Mail (:group 'mh-sending-mail)
(defcustom-mh mh-compose-forward-as-mime-flag t
- "*Non-nil means that messages are forwarded as attachments.
+ "Non-nil means that messages are forwarded as attachments.
By default, this option is on which means that the forwarded
messages are included as attachments. If you would prefer to
:package-version '(MH-E . "6.0"))
(defcustom-mh mh-compose-prompt-flag nil
- "*Non-nil means prompt for header fields when composing a new draft."
+ "Non-nil means prompt for header fields when composing a new draft."
:type 'boolean
:group 'mh-sending-mail
:package-version '(MH-E . "7.4"))
(defcustom-mh mh-forward-subject-format "%s: %s"
- "*Format string for forwarded message subject.
+ "Format string for forwarded message subject.
This option is a string which includes two escapes (\"%s\"). The
first \"%s\" is replaced with the sender of the original message,
:package-version '(MH-E . "6.0"))
(defcustom-mh mh-insert-x-mailer-flag t
- "*Non-nil means append an \"X-Mailer:\" header field to the header.
+ "Non-nil means append an \"X-Mailer:\" header field to the header.
This header field includes the version of MH-E and Emacs that you
are using. If you don't want to participate in our marketing, you
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-redist-full-contents-flag nil
- "*Non-nil means the \"dist\" command needs entire letter for redistribution.
+ "Non-nil means the \"dist\" command needs entire letter for redistribution.
This option must be turned on if \"dist\" requires the whole
letter for redistribution, which is the case if \"send\" is
:package-version '(MH-E . "8.0"))
(defcustom-mh mh-reply-default-reply-to nil
- "*Sets the person or persons to whom a reply will be sent.
+ "Sets the person or persons to whom a reply will be sent.
This option is set to \"Prompt\" by default so that you are
prompted for the recipient of a reply. If you find that most of
:package-version '(MH-E . "6.0"))
(defcustom-mh mh-reply-show-message-flag t
- "*Non-nil means the MH-Show buffer is displayed when replying.
+ "Non-nil means the MH-Show buffer is displayed when replying.
If you include the message automatically, you can hide the
MH-Show buffer by turning off this option.
;; specified by setting `mh-unpropagated-sequences' appropriately." XXX
(defcustom-mh mh-refile-preserves-sequences-flag t
- "*Non-nil means that sequences are preserved when messages are refiled.
+ "Non-nil means that sequences are preserved when messages are refiled.
If a message is in any sequence (except \"Previous-Sequence:\"
and \"cur\") when it is refiled, then it will still be in those
:package-version '(MH-E . "7.3"))
(defcustom-mh mh-update-sequences-after-mh-show-flag t
- "*Non-nil means flush MH sequences to disk after message is shown\\<mh-folder-mode-map>.
+ "Non-nil means flush MH sequences to disk after message is shown\\<mh-folder-mode-map>.
Three sequences are maintained internally by MH-E and pushed out
to MH when a message is shown. They include the sequence
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-whitelist-preserves-sequences-flag t
- "*Non-nil means that sequences are preserved when messages are whitelisted.
+ "Non-nil means that sequences are preserved when messages are whitelisted.
If a message is in any sequence (except \"Previous-Sequence:\"
and \"cur\") when it is whitelisted, then it will still be in
;;; Reading Your Mail (:group 'mh-show)
(defcustom-mh mh-bury-show-buffer-flag t
- "*Non-nil means show buffer is buried.
+ "Non-nil means show buffer is buried.
One advantage of not burying the show buffer is that one can
delete the show buffer more easily in an electric buffer list
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-clean-message-header-flag t
- "*Non-nil means remove extraneous header fields.
+ "Non-nil means remove extraneous header fields.
See also `mh-invisible-header-fields-default' and
`mh-invisible-header-fields'."
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-decode-mime-flag (not (not (locate-library "mm-decode")))
- "*Non-nil means attachments are handled\\<mh-folder-mode-map>.
+ "Non-nil means attachments are handled\\<mh-folder-mode-map>.
MH-E can handle attachments as well if the Gnus `mm-decode'
library is present. If so, this option will be on. Otherwise,
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-display-buttons-for-alternatives-flag nil
- "*Non-nil means display buttons for all alternative attachments.
+ "Non-nil means display buttons for all alternative attachments.
Sometimes, a mail program will produce multiple alternatives of
the attachment in increasing degree of faithfulness to the
:package-version '(MH-E . "7.4"))
(defcustom-mh mh-display-buttons-for-inline-parts-flag nil
- "*Non-nil means display buttons for all inline attachments\\<mh-folder-mode-map>.
+ "Non-nil means display buttons for all inline attachments\\<mh-folder-mode-map>.
The sender can request that attachments should be viewed inline so
that they do not really appear like an attachment at all to the
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-do-not-confirm-flag nil
- "*Non-nil means non-reversible commands do not prompt for confirmation.
+ "Non-nil means non-reversible commands do not prompt for confirmation.
Commands such as `mh-pack-folder' prompt to confirm whether to
process outstanding moves and deletes or not before continuing.
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-fetch-x-image-url nil
- "*Control fetching of \"X-Image-URL:\" header field image.
+ "Control fetching of \"X-Image-URL:\" header field image.
Ths option controls the fetching of the \"X-Image-URL:\" header
field image with the following values:
:package-version '(MH-E . "7.3"))
(defcustom-mh mh-graphical-smileys-flag t
- "*Non-nil means graphical smileys are displayed.
+ "Non-nil means graphical smileys are displayed.
It is a long standing custom to inject body language using a
cornucopia of punctuation, also known as the \"smileys\". MH-E
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-graphical-emphasis-flag t
- "*Non-nil means graphical emphasis is displayed.
+ "Non-nil means graphical emphasis is displayed.
A few typesetting features are indicated in ASCII text with
certain characters. If your terminal supports it, MH-E can render
cannot be run until both variables have been initialized.")
(defcustom-mh mh-invisible-header-fields nil
- "*Additional header fields to hide.
+ "Additional header fields to hide.
Header fields that you would like to hide that aren't listed in
`mh-invisible-header-fields-default' can be added to this option
:package-version '(MH-E . "7.1"))
(defcustom-mh mh-invisible-header-fields-default nil
- "*List of hidden header fields.
+ "List of hidden header fields.
The header fields listed in this option are hidden, although you
can check off any field that you would like to see.
(mh-invisible-headers)
(defcustom-mh mh-lpr-command-format "lpr -J '%s'"
- "*Command used to print\\<mh-folder-mode-map>.
+ "Command used to print\\<mh-folder-mode-map>.
This option contains the Unix command line which performs the
actual printing for the \\[mh-print-msg] command. The string can
:package-version '(MH-E . "6.0"))
(defcustom-mh mh-max-inline-image-height nil
- "*Maximum inline image height if \"Content-Disposition:\" is not present.
+ "Maximum inline image height if \"Content-Disposition:\" is not present.
Some older mail programs do not insert this needed plumbing to
tell MH-E whether to display the attachments inline or not. If
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-max-inline-image-width nil
- "*Maximum inline image width if \"Content-Disposition:\" is not present.
+ "Maximum inline image width if \"Content-Disposition:\" is not present.
Some older mail programs do not insert this needed plumbing to
tell MH-E whether to display the attachments inline or not. If
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-mhl-format-file nil
- "*Specifies the format file to pass to the \"mhl\" program.
+ "Specifies the format file to pass to the \"mhl\" program.
Normally MH-E takes care of displaying messages itself (rather than
calling an MH program to do the work). If you'd rather have \"mhl\"
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-print-background-flag nil
- "*Non-nil means messages should be printed in the background\\<mh-folder-mode-map>.
+ "Non-nil means messages should be printed in the background\\<mh-folder-mode-map>.
Normally messages are printed in the foreground. If this is slow on
your system, you may elect to turn off this option to print in the
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-show-maximum-size 0
- "*Maximum size of message (in bytes) to display automatically.
+ "Maximum size of message (in bytes) to display automatically.
This option provides an opportunity to skip over large messages
which may be slow to load. The default value of 0 means that all
:package-version '(MH-E . "8.0"))
(defcustom-mh mh-show-use-xface-flag (>= emacs-major-version 21)
- "*Non-nil means display face images in MH-show buffers.
+ "Non-nil means display face images in MH-show buffers.
MH-E can display the content of \"Face:\", \"X-Face:\", and
\"X-Image-URL:\" header fields. If any of these fields occur in the
:package-version '(MH-E . "7.0"))
(defcustom-mh mh-store-default-directory nil
- "*Default directory for \\<mh-folder-mode-map>\\[mh-store-msg].
+ "Default directory for \\<mh-folder-mode-map>\\[mh-store-msg].
If you would like to change the initial default directory,
customize this option, change the value from \"Current\" to
:package-version '(MH-E . "6.0"))
(defcustom-mh mh-summary-height nil
- "*Number of lines in MH-Folder buffer (including the mode line).
+ "Number of lines in MH-Folder buffer (including the mode line).
The default value of this option is \"Automatic\" which means
that the MH-Folder buffer will maintain the same proportional
;;; Threading (:group 'mh-thread)
(defcustom-mh mh-show-threads-flag nil
- "*Non-nil means new folders start in threaded mode.
+ "Non-nil means new folders start in threaded mode.
Threading large number of messages can be time consuming so this
option is turned off by default. If you turn this option on, then
;; dynamically in mh-tool-bar.el.
(defcustom-mh mh-tool-bar-search-function 'mh-search
- "*Function called by the tool bar search button.
+ "Function called by the tool bar search button.
By default, this is set to `mh-search'. You can also choose
\"Other Function\" from the \"Value Menu\" and enter a function
;; XEmacs has a couple of extra customizations...
(mh-do-in-xemacs
(defcustom-mh mh-xemacs-use-tool-bar-flag mh-xemacs-has-tool-bar-flag
- "*If non-nil, use tool bar.
+ "If non-nil, use tool bar.
This option controls whether to show the MH-E icons at all. By
default, this option is turned on if the window system supports
:package-version '(MH-E . "7.3"))
(defcustom-mh mh-xemacs-tool-bar-position nil
- "*Tool bar location.
+ "Tool bar location.
This option controls the placement of the tool bar along the four
edges of the frame. You can choose from one of \"Same As Default