diff options
Diffstat (limited to 'lisp/mail')
-rw-r--r-- | lisp/mail/binhex.el | 6 | ||||
-rw-r--r-- | lisp/mail/feedmail.el | 8 | ||||
-rw-r--r-- | lisp/mail/footnote.el | 2 | ||||
-rw-r--r-- | lisp/mail/hashcash.el | 16 | ||||
-rw-r--r-- | lisp/mail/mail-extr.el | 12 | ||||
-rw-r--r-- | lisp/mail/mail-hist.el | 6 | ||||
-rw-r--r-- | lisp/mail/mailabbrev.el | 4 | ||||
-rw-r--r-- | lisp/mail/metamail.el | 8 | ||||
-rw-r--r-- | lisp/mail/mspools.el | 10 | ||||
-rw-r--r-- | lisp/mail/rmail.el | 6 | ||||
-rw-r--r-- | lisp/mail/sendmail.el | 2 | ||||
-rw-r--r-- | lisp/mail/undigest.el | 2 | ||||
-rw-r--r-- | lisp/mail/uudecode.el | 6 |
13 files changed, 44 insertions, 44 deletions
diff --git a/lisp/mail/binhex.el b/lisp/mail/binhex.el index dd76ce90809..40ea8fa4a82 100644 --- a/lisp/mail/binhex.el +++ b/lisp/mail/binhex.el @@ -43,20 +43,20 @@ :group 'news) (defcustom binhex-decoder-program "hexbin" - "*Non-nil value should be a string that names a binhex decoder. + "Non-nil value should be a string that names a binhex decoder. The program should expect to read binhex data on its standard input and write the converted data to its standard output." :type 'string :group 'binhex) (defcustom binhex-decoder-switches '("-d") - "*List of command line flags passed to the command `binhex-decoder-program'." + "List of command line flags passed to the command `binhex-decoder-program'." :group 'binhex :type '(repeat string)) (defcustom binhex-use-external (executable-find binhex-decoder-program) - "*Use external binhex program." + "Use external binhex program." :version "22.1" :group 'binhex :type 'boolean) diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index 039f3dca4a2..4e76e5cdb64 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -1340,7 +1340,7 @@ Example 'defadvice' for mail-send: (defvar feedmail-queue-runner-is-active nil - "*Non-nil means we're inside the logic of the queue-running loop. + "Non-nil means we're inside the logic of the queue-running loop. That is, iterating over all messages in the queue to send them. In that case, the value is the name of the queued message file currently being processed. This can be used for differentiating customized code @@ -1371,11 +1371,11 @@ call to `feedmail-run-the-queue'." (defvar feedmail-mail-send-hook nil - "*See documentation for `feedmail-mail-send-hook-splitter'.") + "See documentation for `feedmail-mail-send-hook-splitter'.") (defvar feedmail-mail-send-hook-queued nil - "*See documentation for `feedmail-mail-send-hook-splitter'.") + "See documentation for `feedmail-mail-send-hook-splitter'.") (defun feedmail-confirm-addresses-hook-example () @@ -1514,7 +1514,7 @@ function, for example, to archive all of your sent messages someplace (defvar feedmail-is-a-resend nil - "*Non-nil means the message is a Resend (in the RFC-822 sense). + "Non-nil means the message is a Resend (in the RFC-822 sense). This affects the composition of certain headers. feedmail sets this variable as soon as it starts prepping the message text buffer, so any user-supplied functions can rely on it. Users shouldn't set or change this diff --git a/lisp/mail/footnote.el b/lisp/mail/footnote.el index 05949d0eccf..c0a63ef197c 100644 --- a/lisp/mail/footnote.el +++ b/lisp/mail/footnote.el @@ -129,7 +129,7 @@ has no effect on buffers already displaying footnotes." (defvar footnote-signature-separator (if (boundp 'message-signature-separator) message-signature-separator "^-- $") - "*String used to recognize .signatures.") + "String used to recognize .signatures.") ;;; Private variables diff --git a/lisp/mail/hashcash.el b/lisp/mail/hashcash.el index 279b5f7b460..fd8d2633818 100644 --- a/lisp/mail/hashcash.el +++ b/lisp/mail/hashcash.el @@ -58,14 +58,14 @@ :group 'mail) (defcustom hashcash-default-payment 20 - "*The default number of bits to pay to unknown users. + "The default number of bits to pay to unknown users. If this is zero, no payment header will be generated. See `hashcash-payment-alist'." :type 'integer :group 'hashcash) (defcustom hashcash-payment-alist '() - "*An association list mapping email addresses to payment amounts. + "An association list mapping email addresses to payment amounts. Elements may consist of (ADDR AMOUNT) or (ADDR STRING AMOUNT), where ADDR is the email address of the intended recipient and AMOUNT is the value of hashcash payment to be made to that user. STRING, if @@ -80,33 +80,33 @@ present, is the string to be hashed; if not present ADDR will be used." :group 'hashcash) (defcustom hashcash-default-accept-payment 20 - "*The default minimum number of bits to accept on incoming payments." + "The default minimum number of bits to accept on incoming payments." :type 'integer :group 'hashcash) (defcustom hashcash-accept-resources `((,user-mail-address nil)) - "*An association list mapping hashcash resources to payment amounts. + "An association list mapping hashcash resources to payment amounts. Resources named here are to be accepted in incoming payments. If the corresponding AMOUNT is NIL, the value of `hashcash-default-accept-payment' is used instead." :group 'hashcash) (defcustom hashcash-path (executable-find "hashcash") - "*The path to the hashcash binary." + "The path to the hashcash binary." :group 'hashcash) (defcustom hashcash-extra-generate-parameters nil - "*A list of parameter strings passed to `hashcash-path' when minting. + "A list of parameter strings passed to `hashcash-path' when minting. For example, you may want to set this to '(\"-Z2\") to reduce header length." :type '(repeat string) :group 'hashcash) (defcustom hashcash-double-spend-database "hashcash.db" - "*The path to the double-spending database." + "The path to the double-spending database." :group 'hashcash) (defcustom hashcash-in-news nil - "*Specifies whether or not hashcash payments should be made to newsgroups." + "Specifies whether or not hashcash payments should be made to newsgroups." :type 'boolean :group 'hashcash) diff --git a/lisp/mail/mail-extr.el b/lisp/mail/mail-extr.el index 6af9c2478fc..32f99ac1465 100644 --- a/lisp/mail/mail-extr.el +++ b/lisp/mail/mail-extr.el @@ -218,14 +218,14 @@ ;; (defcustom mail-extr-guess-middle-initial nil - "*Whether to try to guess middle initial from mail address. + "Whether to try to guess middle initial from mail address. If true, then when we see an address like \"John Smith <jqs@host.com>\" we will assume that \"John Q. Smith\" is the fellow's name." :type 'boolean :group 'mail-extr) (defcustom mail-extr-ignore-single-names nil - "*Whether to ignore a name that is just a single word. + "Whether to ignore a name that is just a single word. If true, then when we see an address like \"Idiot <dumb@stupid.com>\" we will act as though we couldn't find a full name in the address." :type 'boolean @@ -244,19 +244,19 @@ we will act as though we couldn't find a full name in the address." (defcustom mail-extr-full-name-prefixes (purecopy "\\(Prof\\|D[Rr]\\|Mrs?\\|Rev\\|Rabbi\\|SysOp\\|LCDR\\)\\.?[ \t\n]") - "*Matches prefixes to the full name that identify a person's position. + "Matches prefixes to the full name that identify a person's position. These are stripped from the full name because they do not contribute to uniquely identifying the person." :type 'regexp :group 'mail-extr) (defcustom mail-extr-@-binds-tighter-than-! nil - "*Whether the local mail transport agent looks at ! before @." + "Whether the local mail transport agent looks at ! before @." :type 'boolean :group 'mail-extr) (defcustom mail-extr-mangle-uucp nil - "*Whether to throw away information in UUCP addresses + "Whether to throw away information in UUCP addresses by translating things like \"foo!bar!baz@host\" into \"baz@bar.UUCP\"." :type 'boolean :group 'mail-extr) @@ -1454,7 +1454,7 @@ consing a string.)" )) (defcustom mail-extr-disable-voodoo "\\cj" - "*If it is a regexp, names matching it will never be modified. + "If it is a regexp, names matching it will never be modified. If it is neither nil nor a string, modifying of names will never take place. It affects how `mail-extract-address-components' works." :type '(choice (regexp :size 0) diff --git a/lisp/mail/mail-hist.el b/lisp/mail/mail-hist.el index 0e79992aebe..dd489e3c6a9 100644 --- a/lisp/mail/mail-hist.el +++ b/lisp/mail/mail-hist.el @@ -78,14 +78,14 @@ Used for knowing which history list to look in when the user asks for previous/next input.") (defcustom mail-hist-history-size (or kill-ring-max 1729) - "*The maximum number of elements in a mail field's history. + "The maximum number of elements in a mail field's history. Oldest elements are dumped first." :type 'integer :group 'mail-hist) ;;;###autoload (defcustom mail-hist-keep-history t - "*Non-nil means keep a history for headers and text of outgoing mail." + "Non-nil means keep a history for headers and text of outgoing mail." :type 'boolean :group 'mail-hist) @@ -182,7 +182,7 @@ HEADER is a string without the colon." (cdr (assoc header mail-hist-header-ring-alist))) (defcustom mail-hist-text-size-limit nil - "*Don't store any header or body with more than this many characters. + "Don't store any header or body with more than this many characters. If the value is nil, that means no limit on text size." :type '(choice (const nil) integer) :group 'mail-hist) diff --git a/lisp/mail/mailabbrev.el b/lisp/mail/mailabbrev.el index 51a4c6506be..fb8e1502f91 100644 --- a/lisp/mail/mailabbrev.el +++ b/lisp/mail/mailabbrev.el @@ -255,7 +255,7 @@ By default this is the file specified by `mail-personal-alias-file'." (message "Parsing %s... done" file)) (defvar mail-alias-separator-string ", " - "*A string inserted between addresses in multi-address mail aliases. + "A string inserted between addresses in multi-address mail aliases. This has to contain a comma, so \", \" is a reasonable value. You might also want something like \",\\n \" to get each address on its own line.") @@ -423,7 +423,7 @@ fill-column, break the line at the previous comma, and indent the next line." (defvar mail-abbrev-mode-regexp "^\\(Resent-\\)?\\(To\\|From\\|CC\\|BCC\\|Reply-to\\):" - "*Regexp to select mail-headers in which mail abbrevs should be expanded. + "Regexp to select mail-headers in which mail abbrevs should be expanded. This string will be handed to `looking-at' with point at the beginning of the current line; if it matches, abbrev mode will be turned on, otherwise it will be turned off. (You don't need to worry about continuation lines.) diff --git a/lisp/mail/metamail.el b/lisp/mail/metamail.el index ed2c4a66b7a..60dcd5210e1 100644 --- a/lisp/mail/metamail.el +++ b/lisp/mail/metamail.el @@ -42,23 +42,23 @@ :group 'processes) (defcustom metamail-program-name "metamail" - "*Metamail program name." + "Metamail program name." :type 'string :group 'metamail) (defcustom metamail-mailer-name "emacs" - "*Mailer name set to MM_MAILER environment variable." + "Mailer name set to MM_MAILER environment variable." :type 'string :group 'metamail) (defvar metamail-environment '("KEYHEADS=*" "MM_QUIET=1") - "*Environment variables passed to `metamail'. + "Environment variables passed to `metamail'. It must be a list of strings that have the format ENVVARNAME=VALUE. It is not expected to be altered globally by `set' or `setq'. Instead, change its value temporary using `let' or `let*' form.") (defcustom metamail-switches '("-x" "-d" "-z") - "*Switches for `metamail' program. + "Switches for `metamail' program. `-z' is required to remove zap file. It is not expected to be altered globally by `set' or `setq'. Instead, change its value temporary using `let' or `let*' form. diff --git a/lisp/mail/mspools.el b/lisp/mail/mspools.el index d52d9633ee7..9f9c9c68285 100644 --- a/lisp/mail/mspools.el +++ b/lisp/mail/mspools.el @@ -125,17 +125,17 @@ ) (defcustom mspools-update nil - "*Non-nil means update *spools* buffer after visiting any folder." + "Non-nil means update *spools* buffer after visiting any folder." :type 'boolean :group 'mspools) (defcustom mspools-suffix "spool" - "*Extension used for spool files (not including full stop)." + "Extension used for spool files (not including full stop)." :type 'string :group 'mspools) (defcustom mspools-using-vm (fboundp 'vm) - "*Non-nil if VM is used as mail reader, otherwise RMAIL is used." + "Non-nil if VM is used as mail reader, otherwise RMAIL is used." :type 'boolean :group 'mspools) @@ -143,7 +143,7 @@ (if (boundp 'vm-folder-directory) vm-folder-directory "~/MAIL/") - "*Directory where mail folders are kept. Ensure it has a trailing /. + "Directory where mail folders are kept. Ensure it has a trailing /. Defaults to `vm-folder-directory' if bound else to ~/MAIL/." :type 'directory :group 'mspools) @@ -151,7 +151,7 @@ Defaults to `vm-folder-directory' if bound else to ~/MAIL/." (defcustom mspools-vm-system-mail (or (getenv "MAIL") (concat rmail-spool-directory (user-login-name))) - "*Spool file for main mailbox. Only used by VM. + "Spool file for main mailbox. Only used by VM. This needs to be set to your primary mail spool - mspools will not run without it. By default this will be set to the environment variable $MAIL. Otherwise it will use `rmail-spool-directory' to guess where diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el index 3a9ba8122ab..093050229c4 100644 --- a/lisp/mail/rmail.el +++ b/lisp/mail/rmail.el @@ -712,7 +712,7 @@ to an appropriate value, and optionally also set ;; FIXME this is unused since 23.1. (defvar rmail-decode-mime-charset t - "*Non-nil means a message is decoded by MIME's charset specification. + "Non-nil means a message is decoded by MIME's charset specification. If this variable is nil, or the message has not MIME specification, the message is decoded as normal way. @@ -4211,7 +4211,7 @@ This has an effect only if a summary buffer exists." (eval-when-compile (require 'speedbar)) (defvar rmail-speedbar-match-folder-regexp "^[A-Z0-9]+\\(\\.[A-Z0-9]+\\)?$" - "*This regex is used to match folder names to be displayed in speedbar. + "This regex is used to match folder names to be displayed in speedbar. Enabling this will permit speedbar to display your folders for easy browsing, and moving of messages.") @@ -4704,7 +4704,7 @@ SENDERS is a string of regexps separated by commas. ;;;*** ;;;### (autoloads (unforward-rmail-message undigestify-rmail-message) -;;;;;; "undigest" "undigest.el" "a31a35802a2adbc51be42959c3043dbd") +;;;;;; "undigest" "undigest.el" "9f270a2571bbbbfabc27498a8d4089c7") ;;; Generated autoloads from undigest.el (autoload 'undigestify-rmail-message "undigest" "\ diff --git a/lisp/mail/sendmail.el b/lisp/mail/sendmail.el index 933eaef8119..f8958a691b2 100644 --- a/lisp/mail/sendmail.el +++ b/lisp/mail/sendmail.el @@ -989,7 +989,7 @@ This function uses `mail-envelope-from'." ;;;###autoload (defvar sendmail-coding-system nil - "*Coding system for encoding the outgoing mail. + "Coding system for encoding the outgoing mail. This has higher priority than the default `buffer-file-coding-system' and `default-sendmail-coding-system', but lower priority than the local value of `buffer-file-coding-system'. diff --git a/lisp/mail/undigest.el b/lisp/mail/undigest.el index e34a3a4d71e..916a977c546 100644 --- a/lisp/mail/undigest.el +++ b/lisp/mail/undigest.el @@ -32,7 +32,7 @@ (defcustom rmail-forward-separator-regex "^----.*\\([Ff]orwarded\\|[Oo]riginal\\).*[Mm]essage" - "*Regexp to match the string that introduces forwarded messages. + "Regexp to match the string that introduces forwarded messages. This is not a header, but a string contained in the body of the message. You may need to customize it for local needs." :type 'regexp diff --git a/lisp/mail/uudecode.el b/lisp/mail/uudecode.el index d4bf89ffaa1..f415c143473 100644 --- a/lisp/mail/uudecode.el +++ b/lisp/mail/uudecode.el @@ -38,20 +38,20 @@ :group 'news) (defcustom uudecode-decoder-program "uudecode" - "*Non-nil value should be a string that names a uu decoder. + "Non-nil value should be a string that names a uu decoder. The program should expect to read uu data on its standard input and write the converted data to its standard output." :type 'string :group 'uudecode) (defcustom uudecode-decoder-switches nil - "*List of command line flags passed to `uudecode-decoder-program'." + "List of command line flags passed to `uudecode-decoder-program'." :group 'uudecode :type '(repeat string)) (defcustom uudecode-use-external (executable-find uudecode-decoder-program) - "*Use external uudecode program." + "Use external uudecode program." :version "22.1" :group 'uudecode :type 'boolean) |