Mercurial > emacs
changeset 67760:9c3504ae6060
Follow MH-E Developers Guide conventions. Use `' quotes for Help
hyperlinks such as symbols, Info nodes, or URLs. Use \" quotes for
everything else. Otherwise, you can accidently get links to
nonsense symbols.
| author | Bill Wohler <wohler@newt.com> |
|---|---|
| date | Fri, 23 Dec 2005 08:40:31 +0000 |
| parents | b7b75914a27d |
| children | 5b8799d65159 |
| files | lisp/mh-e/ChangeLog lisp/mh-e/mh-acros.el lisp/mh-e/mh-alias.el lisp/mh-e/mh-comp.el lisp/mh-e/mh-customize.el lisp/mh-e/mh-e.el lisp/mh-e/mh-funcs.el lisp/mh-e/mh-identity.el lisp/mh-e/mh-inc.el lisp/mh-e/mh-index.el lisp/mh-e/mh-init.el lisp/mh-e/mh-junk.el lisp/mh-e/mh-mime.el lisp/mh-e/mh-pick.el lisp/mh-e/mh-seq.el lisp/mh-e/mh-utils.el |
| diffstat | 16 files changed, 205 insertions(+), 198 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/mh-e/ChangeLog Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/ChangeLog Fri Dec 23 08:40:31 2005 +0000 @@ -1,3 +1,10 @@ +2005-12-23 Bill Wohler <wohler@newt.com> + + Follow MH-E Developers Guide conventions. Use `' quotes for Help + hyperlinks such as symbols, Info nodes, or URLs. Use \" quotes for + everything else. Otherwise, you can accidently get links to + nonsense symbols. + 2005-12-22 Bill Wohler <wohler@newt.com> Follow Emacs coding conventions. Use default setting of
--- a/lisp/mh-e/mh-acros.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-acros.el Fri Dec 23 08:40:31 2005 +0000 @@ -32,7 +32,7 @@ ;; ;; (eval-when-compile (require 'mh-acros)) ;; -;; It is so named with a silent `m' so that it is compiled first. Otherwise, +;; It is so named with a silent "m" so that it is compiled first. Otherwise, ;; "make recompile" in Emacs 21.4 fails. ;;; Change Log: @@ -47,10 +47,10 @@ ;; routines in their macro expansions. Use mh-require-cl to provide the cl ;; routines in the best way possible. (defmacro mh-require-cl () - "Macro to load `cl' if needed. -Some versions of `cl' produce code for the expansion of -\(setf (gethash ...) ...) that uses functions in `cl' at run -time. This macro recognizes that and loads `cl' where + "Macro to load \"cl\" if needed. +Some versions of \"cl\" produce code for the expansion of +\(setf (gethash ...) ...) that uses functions in \"cl\" at run +time. This macro recognizes that and loads \"cl\" where appropriate." (if (eq (car (macroexpand '(setf (gethash foo bar) baz))) 'cl-puthash) `(require 'cl) @@ -95,9 +95,9 @@ (boundp 'mark-active) mark-active)))) (defmacro mh-defstruct (name-spec &rest fields) - "Replacement for `defstruct' from the `cl' package. -The `defstruct' in the `cl' library produces compiler warnings, -and generates code that uses functions present in `cl' at + "Replacement for `defstruct' from the \"cl\" package. +The `defstruct' in the \"cl\" library produces compiler warnings, +and generates code that uses functions present in \"cl\" at run-time. This is a partial replacement, that avoids these issues.
--- a/lisp/mh-e/mh-alias.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-alias.el Fri Dec 23 08:40:31 2005 +0000 @@ -70,7 +70,7 @@ "*A list of system files which are a source of aliases. If these files are modified, they are automatically reread. This list need include only system aliases and the passwd file, since personal -alias files listed in your `Aliasfile:' MH profile component are +alias files listed in your \"Aliasfile:\" MH profile component are automatically included. You can update the alias list manually using \\[mh-alias-reload].") @@ -146,7 +146,7 @@ (defun mh-alias-local-users () "Return an alist of local users from /etc/passwd. -Exclude all aliases already in `mh-alias-alist' from `ali'" +Exclude all aliases already in `mh-alias-alist' from \"ali\"" (let (passwd-alist) (save-excursion (set-buffer (get-buffer-create mh-temp-buffer)) @@ -188,7 +188,7 @@ Since aliases are updated frequently, MH-E reloads aliases automatically whenever an alias lookup occurs if an alias source has -changed. Sources include files listed in your `Aliasfile:' profile +changed. Sources include files listed in your \"Aliasfile:\" profile component and your password file if option `mh-alias-local-users' is turned on. However, you can reload your aliases manually by calling this command directly. @@ -422,7 +422,7 @@ (defun mh-alias-insert-file (&optional alias) "Return filename which should be used to add ALIAS. The value of the option `mh-alias-insert-file' is used if non-nil\; -otherwise the value of the `Aliasfile:' profile component is used. +otherwise the value of the \"Aliasfile:\" profile component is used. If the alias already exists, try to return the name of the file that contains it." (cond @@ -449,7 +449,7 @@ (cond ((not autolist) (error "No writable alias file. -Set `mh-alias-insert-file' or the Aliasfile profile component")) +Set `mh-alias-insert-file' or the \"Aliasfile:\" profile component")) ((not (elt autolist 1)) ; Only one entry, use it (car autolist)) ((or (not alias)
--- a/lisp/mh-e/mh-comp.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-comp.el Fri Dec 23 08:40:31 2005 +0000 @@ -162,8 +162,8 @@ (defvar mh-new-draft-cleaned-headers "^Date:\\|^Received:\\|^Message-Id:\\|^From:\\|^Sender:\\|^Errors-To:\\|^Delivery-Date:\\|^Return-Path:" - "Regexp of header lines to remove before offering a message as a new draft. -Used by the \\<mh-folder-mode-map>`\\[mh-edit-again]' and `\\[mh-extract-rejected-mail]' commands.") + "Regexp of header lines to remove before offering a message as a new draft\\<mh-folder-mode-map>. +Used by the \\[mh-edit-again] and \\[mh-extract-rejected-mail] commands.") (defvar mh-to-field-choices '(("t" . "To:") ("s" . "Subject:") ("c" . "Cc:") ("b" . "Bcc:") ("f" . "Fcc:") ("r" . "From:")
--- a/lisp/mh-e/mh-customize.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-customize.el Fri Dec 23 08:40:31 2005 +0000 @@ -271,14 +271,14 @@ (defcustom mh-variant 'autodetect "*Specifies the variant used by MH-E. -The default setting of this option is `Auto-detect' which means +The default setting of this option is \"Auto-detect\" which means that MH-E will automatically choose the first of nmh, MH, or GNU mailutils that it finds in the directories listed in `mh-path' (which you can customize), `mh-sys-path', and `exec-path'. If, for example, you have both nmh and mailutils installed and `mh-variant-in-use' was initialized to nmh but you want to use mailutils, then you can set this option to -`mailutils'. +\"mailutils\". When this variable is changed, MH-E resets `mh-progs', `mh-lib', `mh-lib-progs', `mh-flists-present-flag', and `mh-variant-in-use' @@ -329,10 +329,10 @@ (defcustom mh-alias-insert-file nil "*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 +The default setting of this option is \"Use Aliasfile Profile +Component\". This option can also hold the name of a file or a list a file names. If this option is set to a list of file names, -or the `Aliasfile:' profile component contains more than one file +or the \"Aliasfile:\" profile component contains more than one file name, MH-E will prompt for one of them when MH-E adds an alias." :type '(choice (const :tag "Use Aliasfile Profile Component" nil) (file :tag "Alias File") @@ -342,9 +342,9 @@ (defcustom mh-alias-insertion-location 'sorted "Specifies where new aliases are entered in alias files. -This option is set to `Alphabetical' by default. If you organize -your alias file in other ways, then adding aliases to the `Top' -or `Bottom' of your alias file might be more appropriate." +This option is set to \"Alphabetical\" by default. If you organize +your alias file in other ways, then adding aliases to the \"Top\" +or \"Bottom\" of your alias file might be more appropriate." :type '(choice (const :tag "Alphabetical" sorted) (const :tag "Top" top) (const :tag "Bottom" bottom)) @@ -353,12 +353,12 @@ (defcustom mh-alias-local-users t "*If on, local users are added to alias completion. -Aliases are created from `/etc/passwd' entries with a user ID +Aliases are created from \"/etc/passwd\" entries with a user ID larger than a magical number, typically 200. This can be a handy tool on a machine where you and co-workers exchange messages. -These aliases have the form `local.first.last' if a real name is +These aliases have the form \"local.first.last\" if a real name is present in the password file. Otherwise, the alias will have the -form `local.login'. +form \"local.login\". If you're on a system with thousands of users you don't know, and the loading of local aliases slows MH-E down noticeably, then @@ -372,7 +372,7 @@ (defcustom mh-alias-local-users-prefix "local." "*String prefixed to the real names of users from the password file. -This option can also be set to `Use Login'. +This option can also be set to \"Use Login\". For example, consider the following password file entry: @@ -474,11 +474,11 @@ ;;; Folder Selection (:group 'mh-folder-selection) (defcustom mh-default-folder-for-message-function nil - "Function to select a default folder for refiling or `Fcc'. + "Function to select a default folder for refiling or \"Fcc\". The current buffer is set to the message being refiled with point at the start of the message. This function should return the -default folder as a string with a leading `+' sign. It can also +default folder as a string with a leading \"+\" sign. It can also return nil so that the last folder name is used as the default, or an empty string to suppress the default entirely." :type 'function @@ -489,7 +489,7 @@ The folder name associated with the first address found in this list is used as the default for `mh-refile-msg' and similar -functions. Each element in this list contains a `Check Recipient' +functions. Each element in this list contains a \"Check Recipient\" item. If this item is turned on, then the address is checked against the recipient instead of the sender. This is useful for mailing lists. @@ -530,35 +530,35 @@ (defcustom mh-identity-list nil "*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 -label `Add at least one item below'. Then choose one of the items in -the `Value Menu'. - -You can specify an alternate `From:' header field using the `From -Field' menu item. You must include a valid email address. A standard -format is `First Last <login@@host.domain>'. If you use an initial -with a period, then you must quote your name as in `\"First I. Last\" +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 +label \"Add at least one item below\". Then choose one of the items in +the \"Value Menu\". + +You can specify an alternate \"From:\" header field using the \"From +Field\" menu item. You must include a valid email address. A standard +format is \"First Last <login@@host.domain>\". If you use an initial +with a period, then you must quote your name as in '\"First I. Last\" <login@@host.domain>'. People usually list the name of the company -where they work using the `Organization Field' menu item. Set any -arbitrary header field and value in the `Other Field' menu item. +where they work using the \"Organization Field\" menu item. Set any +arbitrary header field and value in the \"Other Field\" menu item. Unless the header field is a standard one, precede the name of your -field's label with `X-', as in `X-Fruit-of-the-Day:'. The value of -`Attribution Verb' overrides the setting of +field's label with \"X-\", as in \"X-Fruit-of-the-Day:\". The value of +\"Attribution Verb\" overrides the setting of `mh-extract-from-attribution-verb'. Set your signature with the -`Signature' menu item. You can specify the contents of +\"Signature\" menu item. You can specify the contents of `mh-signature-file-name', a file, or a function. Specify a different -key to sign or encrypt messages with the `GPG Key ID' menu item. +key to sign or encrypt messages with the \"GPG Key ID\" menu item. You can select the identities you have added via the menu called -`Identity' in the MH-Letter buffer. You can also use +\"Identity\" in the MH-Letter buffer. You can also use \\[mh-insert-identity]. To clear the fields and signature added by the -identity, select the `None' identity. - -The `Identity' menu contains two other items to save you from having -to set the identity on every message. The menu item `Set Default for -Session' can be used to set the default identity to the current -identity until you exit Emacs. The menu item `Save as Default' sets +identity, select the \"None\" identity. + +The \"Identity\" menu contains two other items to save you from having +to set the identity on every message. The menu item \"Set Default for +Session\" can be used to set the default identity to the current +identity until you exit Emacs. The menu item \"Save as Default\" sets the option `mh-identity-default' to the current identity setting. You can also customize the `mh-identity-default' option in the usual fashion." @@ -597,31 +597,31 @@ "List of recipients for which header lines are automatically inserted. This option can be used to set the identity depending on the -recipient. To customize this option, click on the `INS' button and +recipient. To customize this option, click on the \"INS\" button and enter a regular expression for the recipient's address. Click on the -`INS' button with the `Add at least one item below' label. Then choose -one of the items in the `Value Menu'. - -The `Identity' menu item is used to select an identity from those +\"INS\" button with the \"Add at least one item below\" label. Then choose +one of the items in the \"Value Menu\". + +The \"Identity\" menu item is used to select an identity from those configured in `mh-identity-list'. All of the information for that -identity will be added if the recipient matches. The `Fcc Field' menu -item is used to select a folder that is used in the `Fcc:' header. +identity will be added if the recipient matches. The \"Fcc Field\" menu +item is used to select a folder that is used in the \"Fcc:\" header. When you send the message, MH will put a copy of your message in this -folder. The `Mail-Followup-To Field' menu item is used to insert an -`Mail-Followup-To:' header field with the recipients you provide. If +folder. The \"Mail-Followup-To Field\" menu item is used to insert an +\"Mail-Followup-To:\" header field with the recipients you provide. If the recipient's mail user agent supports this header field (as nmh does), then their replies will go to the addresses listed. This is useful if their replies go both to the list and to you and you don't have a mechanism to suppress duplicates. If you reply to someone not -on the list, you must either remove the `Mail-Followup-To:' field, or +on the list, you must either remove the \"Mail-Followup-To:\" field, or ensure the recipient is also listed there so that he receives replies -to your reply. Other header fields may be added using the `Other -Field' menu item. +to your reply. Other header fields may be added using the \"Other +Field\" menu item. These fields can only be added after the recipient is known. Once the header contains one or more recipients, run the -\\[mh-insert-auto-fields] command or choose the `Identity -> Insert -Auto Fields' menu item to insert these fields manually. However, you +\\[mh-insert-auto-fields] command or choose the \"Identity -> Insert +Auto Fields\" menu item to insert these fields manually. However, you can just send the message and the fields will be added automatically. You are given a chance to see these fields and to confirm them before the message is actually sent. You can do away with this confirmation @@ -682,22 +682,22 @@ `mh-identity-handlers', replace the name of an existing handler function associated with the field you want to change with the name of a function you have written. You can also click on an -`INS' button and insert a field of your choice and the name of +\"INS\" button and insert a field of your choice and the name of the function you have written to handle it. -The `Field' field can be any field that you've used in your -`mh-identity-list'. The special fields `:attribution-verb', -`:signature', or `:pgg-default-user-id' are used for the -`mh-identity-list' choices `Attribution Verb', `Signature', and -`GPG Key ID' respectively. - -The handler associated with the `:default' field is used when no +The \"Field\" field can be any field that you've used in your +`mh-identity-list'. The special fields \":attribution-verb\", +\":signature\", or \":pgg-default-user-id\" are used for the +`mh-identity-list' choices \"Attribution Verb\", \"Signature\", and +\"GPG Key ID\" respectively. + +The handler associated with the \":default\" field is used when no other field matches. The handler functions are passed two or three arguments: the -FIELD itself (for example, `From'), or one of the special -fields (for example, `:signature'), and the ACTION `'remove' or -`'add'. If the action is `'add', an additional argument +FIELD itself (for example, \"From\"), or one of the special +fields (for example, \":signature\"), and the ACTION 'remove or +'add. If the action is 'add, an additional argument containing the VALUE for the field is given." :type '(repeat (cons (string :tag "Field") function)) :group 'mh-identity) @@ -712,7 +712,7 @@ This program generates a one-line summary for each of the new messages. Unless it is an absolute pathname, the file is assumed to be in the `mh-progs' directory. You may also link a file to -`inc' that uses a different format. You'll then need to modify +\"inc\" that uses a different format. You'll then need to modify several scan line format variables appropriately." :type 'string :group 'mh-inc) @@ -722,25 +722,25 @@ You can use the `mh-inc-spool-list' variable to direct MH-E to retrieve mail from arbitrary spool files other than your system -mailbox, file it in folders other than your `+inbox', and assign +mailbox, file it in folders other than your \"+inbox\", and assign key bindings to incorporate this mail. -Suppose you are subscribed to the `mh-e-devel' mailing list and -you use `procmail' to filter this mail into `~/mail/mh-e' with -the following recipe in `.procmailrc': +Suppose you are subscribed to the \"mh-e-devel\" mailing list and +you use \"procmail\" to filter this mail into \"~/mail/mh-e\" with +the following recipe in \".procmailrc\": MAILDIR=$HOME/mail :0: * ^From mh-e-devel-admin@stop.mail-abuse.org mh-e -In order to incorporate `~/mail/mh-e' into `+mh-e' with an `I m' -\(`mh-inc-spool-mh-e'\) command, customize this option, and click -on the `INS' button. Enter a `Spool File' of `~/mail/mh-e', a -`Folder' of `mh-e', and a `Key Binding' of `m'. - -You can use `xbuffy' to automate the incorporation of this mail -using the `gnudoit' command in the `gnuserv' package as follows: +In order to incorporate \"~/mail/mh-e\" into \"+mh-e\" with an +\"I m\" (mh-inc-spool-mh-e) command, customize this option, and click +on the \"INS\" button. Enter a \"Spool File\" of \"~/mail/mh-e\", a +\"Folder\" of \"mh-e\", and a \"Key Binding\" of \"m\". + +You can use \"xbuffy\" to automate the incorporation of this mail +using the \"gnudoit\" command in the \"gnuserv\" package as follows: box ~/mail/mh-e title mh-e @@ -761,11 +761,11 @@ (defcustom mh-index-program nil "Indexing program that MH-E shall use. -The default setting of this option is `Auto-detect' which means +The default setting of this option is \"Auto-detect\" which means that MH-E will automatically choose one of swish++, swish-e, mairix, namazu, pick and grep in that order. If, for example, you have both swish++ and mairix installed and you want to use -mairix, then you can set this option to `mairix'. +mairix, then you can set this option to \"mairix\". More information about setting up an indexing program to use with MH-E can be found in the documentation of `mh-index-search'." @@ -1269,7 +1269,7 @@ :group 'mh-sequences) (defcustom mh-update-sequences-after-mh-show-flag t - "*Non-nil means flush MH sequences to disk after message is shown. + "*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 @@ -1277,8 +1277,8 @@ and the sequence listed by the option `mh-tick-seq' which is \"tick\" by default. If you do not like this behavior, turn off this option. You can then update the state manually with the -`\\[mh-execute-commands]', `\\[mh-quit]', or -`\\[mh-update-sequences]' commands." +\\[mh-execute-commands], \\[mh-quit], or \\[mh-update-sequences] +commands." :type 'boolean :group 'mh-sequences) @@ -1681,7 +1681,7 @@ Header fields that you would like to hide that aren't listed in `mh-invisible-header-fields-default' can be added to this option with a couple of caveats. Regular expressions are not allowed. -Unique fields should have a `:' suffix; otherwise, the element +Unique fields should have a \":\" suffix; otherwise, the element can be used to render invisible an entire class of fields that start with the same prefix. If you think a header field should be generally ignored, report a bug (see URL @@ -1862,8 +1862,8 @@ "*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 -`Directory', and then enter the name of the directory for storing +customize this option, change the value from \"Current\" to +\"Directory\", and then enter the name of the directory for storing the content of these messages." :type '(choice (const :tag "Current" nil) directory) @@ -2027,16 +2027,16 @@ FUNCTION is the name of the function that will be executed when the button is clicked. - MODES is a list of symbols. List elements must be from `folder', - `letter' and `sequence'. If `folder' is present then the button is + MODES is a list of symbols. List elements must be from \"folder\", + \"letter\" and \"sequence\". If \"folder\" is present then the button is available in the folder and show buffer. If the name of FUNCTION is of the form \"mh-foo\", where foo is some arbitrary string, then we check if the function `mh-show-foo' exists. If it exists then that function is used in the show buffer. Otherwise the original function - `mh-foo' is used in the show buffer as well. Presence of `sequence' + `mh-foo' is used in the show buffer as well. Presence of \"sequence\" is handled similar to the above. The only difference is that the button is shown only when the folder is narrowed to a sequence. If - `letter' is present in MODES, then the button is available during + \"letter\" is present in MODES, then the button is available during draft editing and runs FUNCTION when clicked. ICON is the icon that is drawn in the button. @@ -2048,7 +2048,7 @@ Optional item ENABLE-EXPR is an arbitrary lisp expression. If it evaluates to nil, then the button is deactivated, otherwise it is - active. If is in't present then the button is always active." + active. If it isn't present then the button is always active." ;; The following variable names have been carefully chosen to make code ;; generation easier. Modifying the names should be done carefully. (let (folder-buttons folder-docs folder-button-setter sequence-button-setter
--- a/lisp/mh-e/mh-e.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-e.el Fri Dec 23 08:40:31 2005 +0000 @@ -139,10 +139,10 @@ additional hints for fontification have been added to the fifth column (remember that in Emacs, the first column is 0). -The values of the fifth column, in priority order, are: `-' if +The values of the fifth column, in priority order, are: \"-\" if the message has been replied to, t if an address on the To: line -matches one of the mailboxes of the current user, `c' if the Cc: -line matches, `b' if the Bcc: line matches, and `n' if a +matches one of the mailboxes of the current user, \"c\" if the Cc: +line matches, \"b\" if the Bcc: line matches, and \"n\" if a non-empty Newsgroups: header is present.") (defvar mh-scan-format-nmh @@ -165,10 +165,10 @@ hints for fontification have been added to the fifth column (remember that in Emacs, the first column is 0). -The values of the fifth column, in priority order, are: `-' if +The values of the fifth column, in priority order, are: \"-\" if the message has been replied to, t if an address on the To: field -matches one of the mailboxes of the current user, `c' if the Cc: -field matches, `b' if the Bcc: field matches, and `n' if a +matches one of the mailboxes of the current user, \"c\" if the Cc: +field matches, \"b\" if the Bcc: field matches, and \"n\" if a non-empty Newsgroups: field is present.") (defvar mh-note-deleted ?D @@ -266,7 +266,7 @@ Note that the default setting of `mh-folder-font-lock-keywords' expects this expression to contain two parenthesized expressions. -The first is expected to match the `To:' that the default scan +The first is expected to match the \"To:\" that the default scan format file generates. The second is expected to match the recipient's name as in the default of \"\\\\(To:\\\\)\\\\(..............\\\\)\". If this regular @@ -289,9 +289,9 @@ It must match from the beginning of the line. Note that the default setting of `mh-folder-font-lock-keywords' expects this expression to contain at least three parenthesized expressions. -The first is expected to match the `Re:' string, if any. The -second matches an optional bracketed number after `Re:', such as -in `Re[2]:' (and is thus a sub-expression of the first +The first is expected to match the \"Re:\" string, if any. The +second matches an optional bracketed number after \"Re:\", such as +in \"Re[2]:\" (and is thus a sub-expression of the first expression) and the third is expected to match the subject line itself as in the default of (broken on multiple lines for readability): @@ -356,26 +356,26 @@ (defvar mh-scan-cmd-note-width 1 "Number of columns consumed by the cmd-note field in `mh-scan-format'. -This column will have one of the values: ` ', `D', `^', `+' and -where ` ' is the default value, - - `D' is the `mh-note-deleted' character, - `^' is the `mh-note-refiled' character, and - `+' is the `mh-note-cur' character.") +This column will have one of the values: \" \", \"D\", \"^\", \"+\" and +where \" \" is the default value, + + \"D\" is the `mh-note-deleted' character, + \"^\" is the `mh-note-refiled' character, and + \"+\" is the `mh-note-cur' character.") (defvar mh-scan-destination-width 1 "Number of columns consumed by the destination field in `mh-scan-format'. -This column will have one of ' ', '%', '-', 't', 'c', 'b', or `n' +This column will have one of \" \", \"%\", \"-\", \"t\", \"c\", \"b\", or \"n\" in it. - ' ' blank space is the default character. - '%' indicates that the message in in a named MH sequence. - '-' indicates that the message has been annotated with a replied field. - 't' indicates that the message contains mymbox in the To: field. - 'c' indicates that the message contains mymbox in the Cc: field. - 'b' indicates that the message contains mymbox in the Bcc: field. - 'n' indicates that the message contains a Newsgroups: field.") + \" \" blank space is the default character. + \"%\" indicates that the message in in a named MH sequence. + \"-\" indicates that the message has been annotated with a replied field. + \"t\" indicates that the message contains mymbox in the To: field. + \"c\" indicates that the message contains mymbox in the Cc: field. + \"b\" indicates that the message contains mymbox in the Bcc: field. + \"n\" indicates that the message contains a Newsgroups: field.") (defvar mh-scan-date-width 5 "Number of columns consumed by the date field in `mh-scan-format'. @@ -383,7 +383,7 @@ (defvar mh-scan-date-flag-width 1 "Number of columns consumed to flag (in)valid dates in `mh-scan-format'. -This column will have ` ' for valid and `*' for invalid or +This column will have \" \" for valid and \"*\" for invalid or missing dates.") (defvar mh-scan-from-mbox-width 17 @@ -778,7 +778,7 @@ a) The folder name associated with the first address found in the list `mh-default-folder-list' is used. Each element in - this list contains a `Check Recipient' item. If this item is + this list contains a \"Check Recipient\" item. If this item is turned on, then the address is checked against the recipient instead of the sender. This is useful for mailing lists. @@ -1370,7 +1370,7 @@ (values (format "+%s" folder) (car unseen) (car total)))))))) (defun mh-folder-size-folder (folder) - "Find size of FOLDER using `folder'." + "Find size of FOLDER using \"folder\"." (with-temp-buffer (let ((u (length (cdr (assoc mh-unseen-seq (mh-read-folder-sequences folder nil)))))) @@ -1382,7 +1382,7 @@ (values 0 u folder))))) (defun mh-folder-size-flist (folder) - "Find size of FOLDER using `flist'." + "Find size of FOLDER using \"flist\"." (with-temp-buffer (call-process (expand-file-name "flist" mh-progs) nil t nil "-showzero" "-norecurse" folder "-sequence" (symbol-name mh-unseen-seq)) @@ -1789,20 +1789,20 @@ Indicates all messages in the range <num1> to <num2>, inclusive. The range must be nonempty. -`<num>:N' -`<num>:+N' -`<num>:-N' +<num>:N +<num>:+N +<num>:-N Up to N messages beginning with (or ending with) message num. Num may be any of the predefined symbols: first, prev, cur, next or last. -`first:N' -`prev:N' -`next:N' -`last:N' +first:N +prev:N +next:N +last:N The first, previous, next or last messages, if they exist. -`all' +all All of the messages. For example, a range that shows all of these things is `1 2 3 @@ -2643,7 +2643,7 @@ (defalias 'mh-alt-send 'mh-send) (defalias 'mh-alt-visit-folder 'mh-visit-folder) -;; Save the `b' binding for a future `back'. Maybe? +;; Save the "b" binding for a future `back'. Maybe? (gnus-define-keys mh-folder-mode-map " " mh-page-msg "!" mh-refile-or-write-again @@ -2793,7 +2793,7 @@ ;; ;; When adding a new prefix, ensure that the help message contains "what" the ;; prefix is for. For example, if the word "folder" were not present in the -;; `F' entry, it would not be clear what these commands operated upon. +;; "F" entry, it would not be clear what these commands operated upon. (defvar mh-help-messages '((nil "[i]nc, [.]show, [,]show all, [n]ext, [p]revious,\n" "[d]elete, [o]refile, e[x]ecute,\n"
--- a/lisp/mh-e/mh-funcs.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-funcs.el Fri Dec 23 08:40:31 2005 +0000 @@ -303,7 +303,7 @@ ;;;###mh-autoload (defun mh-store-msg (directory) - "Unpack message created with `uudecode' or `shar'. + "Unpack message created with \"uudecode\" or \"shar\". The default DIRECTORY for extraction is the current directory; however, you have a chance to specify a different extraction @@ -409,7 +409,7 @@ (defun mh-prefix-help () "Display cheat sheet for the commands of the current prefix in minibuffer." (interactive) - ;; We got here because the user pressed a `?', but he pressed a prefix key + ;; We got here because the user pressed a "?", but he pressed a prefix key ;; before that. Since the the key vector starts at index 0, the index of the ;; last keystroke is length-1 and thus the second to last keystroke is at ;; length-2. We use that information to obtain a suitable prefix character
--- a/lisp/mh-e/mh-identity.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-identity.el Fri Dec 23 08:40:31 2005 +0000 @@ -122,7 +122,7 @@ (defun mh-identity-field-handler (field) "Return the handler for header FIELD or nil if none set. The field name is downcased. If the FIELD begins with the -character `:', then it must have a special handler defined in +character \":\", then it must have a special handler defined in `mh-identity-handlers', else return an error since it is not a valid header field." (or (cdr (mh-assoc-ignore-case field mh-identity-handlers))
--- a/lisp/mh-e/mh-inc.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-inc.el Fri Dec 23 08:40:31 2005 +0000 @@ -1,4 +1,4 @@ -;;; mh-inc.el --- MH-E `inc' and separate mail spool handling +;;; mh-inc.el --- MH-E "inc" and separate mail spool handling ;; ;; Copyright (C) 2003, 2004 Free Software Foundation, Inc. @@ -28,7 +28,7 @@ ;; Support for inc. In addition to reading from the system mailbox, inc can ;; also be used to incorporate mail from multiple spool files into separate -;; folders. See `C-h v mh-inc-spool-list'. +;; folders. See "C-h v mh-inc-spool-list". ;;; Change Log:
--- a/lisp/mh-e/mh-index.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-index.el Fri Dec 23 08:40:31 2005 +0000 @@ -362,14 +362,14 @@ Use a prefix argument to repeat the search. Unlike regular searches, the prompt for the folder to search can be -`all' to search all folders; in addition, the search works recursively +\"all\" to search all folders; in addition, the search works recursively on the listed folder. The search criteria are entered in an MH-Pick buffer as described in `mh-search-folder'. To perform the search, type \\<mh-pick-mode-map>\\[mh-do-search]. Another difference from the regular searches is that because the search operates on more than one folder, the messages that are found -are put in a temporary sub-folder of `+mhe-index' and are displayed in +are put in a temporary sub-folder of \"+mhe-index\" and are displayed in an MH-Folder buffer. This buffer is special because it displays messages from multiple folders; each set of messages from a given folder has a heading with the folder name. @@ -554,7 +554,7 @@ "Write index data to file." (ignore-errors (unless (eq major-mode 'mh-folder-mode) - (error "Can't be called from folder in `%s'" major-mode)) + (error "Can't be called from folder in \"%s\"" major-mode)) (let ((data mh-index-data) (msg-checksum-map mh-index-msg-checksum-map) (checksum-origin-map mh-index-checksum-origin-map) @@ -576,7 +576,7 @@ "Read index data from file." (ignore-errors (unless (eq major-mode 'mh-folder-mode) - (error "Can't be called from folder in `%s'" major-mode)) + (error "Can't be called from folder in \"%s\"" major-mode)) (let ((infile (concat buffer-file-name mh-index-data-file)) t1 t2 t3 t4 t5) (with-temp-buffer @@ -1352,9 +1352,9 @@ (defun mh-index-new-messages (folders) "Display unseen messages. -If you use a program such as `procmail' to use `rcvstore' to file +If you use a program such as \"procmail\" to use \"rcvstore\" to file your incoming mail automatically, you can display new, unseen, -messages using this command. All messages in the `unseen' +messages using this command. All messages in the \"unseen\" sequence from the folders in `mh-new-messages-folders' are listed.
--- a/lisp/mh-e/mh-init.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-init.el Fri Dec 23 08:40:31 2005 +0000 @@ -64,7 +64,7 @@ This directory contains, among other things, the mhl program.") (defvar mh-flists-present-flag nil - "Non-nil means that we have `flists'.") + "Non-nil means that we have \"flists\".") ;;;###autoload (put 'mh-progs 'risky-local-variable t) @@ -101,14 +101,14 @@ (defvar mh-variant-in-use nil "The MH variant currently in use; a string with variant and version number. This differs from `mh-variant' when the latter is set to -`autodetect'.") +\"autodetect\".") ;;;###mh-autoload (defun mh-variant-set (variant) "Set the MH variant to VARIANT. Sets `mh-progs', `mh-lib', `mh-lib-progs' and `mh-flists-present-flag'. -If the VARIANT is `autodetect', then first try nmh, then MH and +If the VARIANT is \"autodetect\", then first try nmh, then MH and finally GNU mailutils." (interactive (list (completing-read @@ -202,7 +202,7 @@ (defun mh-variant-mh-info (dir) "Return info for MH variant in DIR assuming a temporary buffer is setup." ;; MH does not have the -version option. - ;; Its version number is included in the output of `-help' as: + ;; Its version number is included in the output of "-help" as: ;; ;; version: MH 6.8.4 #2[UCI] (burrito) of Fri Jan 15 20:01:39 EST 1999 ;; options: [ATHENA] [BIND] [DUMB] [LIBLOCKFILE] [LOCALE] [MAILGROUP] [MHE] @@ -306,7 +306,7 @@ (defun mh-image-load-path () "Ensure that the MH-E images are accessible by `find-image'. Images for MH-E are found in ../../etc/images relative to the -files in `lisp/mh-e'. If `image-load-path' exists (since Emacs +files in \"lisp/mh-e\". If `image-load-path' exists (since Emacs 22), then the images directory is added to it if isn't already there. Otherwise, the images directory is added to the `load-path' if it isn't already there."
--- a/lisp/mh-e/mh-junk.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-junk.el Fri Dec 23 08:40:31 2005 +0000 @@ -111,7 +111,7 @@ SpamAssassin is one of the more popular spam filtering programs. Get it from your local distribution or from http://spamassassin.org/. -To use SpamAssassin, add the following recipes to `.procmailrc': +To use SpamAssassin, add the following recipes to \".procmailrc\": MAILDIR=$HOME/`mhparam Path` @@ -128,57 +128,57 @@ * ^X-Spam-Status: Yes spam/. -If you don't use `spamc', use `spamassassin -P -a'. +If you don't use \"spamc\", use \"spamassassin -P -a\". Note that one of the recipes above throws away messages with a score greater than or equal to 10. Here's how you can determine a value that works best for you. -First, run `spamassassin -t' on every mail message in your archive and +First, run \"spamassassin -t\" on every mail message in your archive and use Gnumeric to verify that the average plus the standard deviation of good mail is under 5, the SpamAssassin default for \"spam\". Using Gnumeric, sort the messages by score and view the messages with the highest score. Determine the score which encompasses all of your interesting messages and add a couple of points to be conservative. -Add that many dots to the `X-Spam-Level:' header field above to send +Add that many dots to the \"X-Spam-Level:\" header field above to send messages with that score down the drain. In the example above, messages with a score of 5-9 are set aside in -the `+spam' folder for later review. The major weakness of rules-based +the \"+spam\" folder for later review. The major weakness of rules-based filters is a plethora of false positives so it is worthwhile to check. If SpamAssassin classifies a message incorrectly, or is unsure, you can use the MH-E commands \\[mh-junk-blacklist] and \\[mh-junk-whitelist]. -The \\[mh-junk-blacklist] command adds a `blacklist_from' entry to -`~/spamassassin/user_prefs', deletes the message, and sends the +The \\[mh-junk-blacklist] command adds a \"blacklist_from\" entry to +\"~/spamassassin/user_prefs\", deletes the message, and sends the message to the Razor, so that others might not see this spam. If the -`sa-learn' command is available, the message is also recategorized as +\"sa-learn\" command is available, the message is also recategorized as spam. -The \\[mh-junk-whitelist] command adds a `whitelist_from' rule to the -`~/.spamassassin/user_prefs' file. If the `sa-learn' command is +The \\[mh-junk-whitelist] command adds a \"whitelist_from\" rule to the +\"~/.spamassassin/user_prefs\" file. If the \"sa-learn\" command is available, the message is also recategorized as ham. Over time, you'll observe that the same host or domain occurs -repeatedly in the `blacklist_from' entries, so you might think that +repeatedly in the \"blacklist_from\" entries, so you might think that you could avoid future spam by blacklisting all mail from a particular domain. The utility function `mh-spamassassin-identify-spammers' helps you do precisely that. This function displays a frequency count of the -hosts and domains in the `blacklist_from' entries from the last blank -line in `~/.spamassassin/user_prefs' to the end of the file. This +hosts and domains in the \"blacklist_from\" entries from the last blank +line in \"~/.spamassassin/user_prefs\" to the end of the file. This information can be used so that you can replace multiple -`blacklist_from' entries with a single wildcard entry such as: +\"blacklist_from\" entries with a single wildcard entry such as: blacklist_from *@*amazingoffersdirect2u.com In versions of SpamAssassin (2.50 and on) that support a Bayesian -classifier, \\[mh-junk-blacklist] uses the `sa-learn' program to +classifier, \\[mh-junk-blacklist] uses the \"sa-learn\" program to recategorize the message as spam. Neither MH-E, nor SpamAssassin, rebuilds the database after adding words, so you will need to run -`sa-learn --rebuild' periodically. This can be done by adding the +\"sa-learn --rebuild\" periodically. This can be done by adding the following to your crontab: 0 * * * * sa-learn --rebuild > /dev/null 2>&1" @@ -215,8 +215,8 @@ (defun mh-spamassassin-whitelist (msg) "Whitelist MSG with SpamAssassin. -The \\[mh-junk-whitelist] command adds a `whitelist_from' rule to -the `~/.spamassassin/user_prefs' file. If the `sa-learn' command +The \\[mh-junk-whitelist] command adds a \"whitelist_from\" rule to +the \"~/.spamassassin/user_prefs\" file. If the \"sa-learn\" command is available, the message is also recategorized as ham. See `mh-spamassassin-blacklist' for more information." @@ -249,7 +249,7 @@ (message "Whitelisting message %d...done" msg)))) (defun mh-spamassassin-add-rule (rule body) - "Add a new rule to `~/.spamassassin/user_prefs'. + "Add a new rule to \"~/.spamassassin/user_prefs\". The name of the rule is RULE and its body is BODY." (save-window-excursion (let* ((line (format "%s\t%s\n" rule body)) @@ -269,10 +269,10 @@ "Identify spammers who are repeat offenders. This function displays a frequency count of the hosts and domains -in the `blacklist_from' entries from the last blank line in -`~/.spamassassin/user_prefs' to the end of the file. This +in the \"blacklist_from\" entries from the last blank line in +\"~/.spamassassin/user_prefs\" to the end of the file. This information can be used so that you can replace multiple -`blacklist_from' entries with a single wildcard entry such as: +\"blacklist_from\" entries with a single wildcard entry such as: blacklist_from *@*amazingoffersdirect2u.com" (interactive) @@ -333,7 +333,7 @@ bogofilter. Note that most Bayesian filters need 1000 to 5000 of each type of message to start doing a good job. -To use bogofilter, add the following recipes to `.procmailrc': +To use bogofilter, add the following recipes to \".procmailrc\": MAILDIR=$HOME/`mhparam Path` @@ -389,7 +389,7 @@ SpamProbe is a Bayesian spam filtering program. Get it from your local distribution or from http://spamprobe.sourceforge.net. -To use SpamProbe, add the following recipes to `.procmailrc': +To use SpamProbe, add the following recipes to \".procmailrc\": MAILDIR=$HOME/`mhparam Path`
--- a/lisp/mh-e/mh-mime.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-mime.el Fri Dec 23 08:40:31 2005 +0000 @@ -469,8 +469,8 @@ (run-hooks 'mh-mh-to-mime-hook)) (defun mh-mh-quote-unescaped-sharp () - "Quote `#' characters that haven't been quoted for \"mhbuild\". -If the `#' character is present in the first column, but it isn't + "Quote \"#\" characters that haven't been quoted for \"mhbuild\". +If the \"#\" character is present in the first column, but it isn't part of a MH-style directive then \"mhbuild\" gives an error. This function will quote all such characters." (save-excursion @@ -604,7 +604,7 @@ description and the DISPOSITION of the attachment. This is basically `mml-attach-file' from Gnus, modified such that a prefix -argument yields an `inline' disposition and Content-Type is determined +argument yields an \"inline\" disposition and Content-Type is determined automatically." (let* ((file (mml-minibuffer-read-file "Attach file: ")) (type (mh-minibuffer-read-type file))
--- a/lisp/mh-e/mh-pick.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-pick.el Fri Dec 23 08:40:31 2005 +0000 @@ -224,7 +224,7 @@ Messages are searched for in the folder named in `mh-searching-folder'. Add the messages found to the sequence -named `search'." +named \"search\"." (interactive) (let ((pattern-list (mh-pick-parse-search-buffer)) (folder mh-searching-folder) @@ -337,9 +337,9 @@ ;; All implementations of pick have special options -cc, -date, -from and ;; -subject that allow to search for corresponding components. Any other ;; component is searched using option --COMPNAME, for example: `pick -;; --x-mailer mh-e'. Mailutils `pick' supports this option using a certain +;; --x-mailer mh-e'. Mailutils "pick" supports this option using a certain ;; kludge, but it prefers the following syntax for this purpose: -;; `--component=COMPNAME --pattern=PATTERN'. +;; "--component=COMPNAME --pattern=PATTERN". ;; -- Sergey Poznyakoff, Aug 2003 (defun mh-pick-regexp-builder (pattern-list) "Generate pick search expression from PATTERN-LIST."
--- a/lisp/mh-e/mh-seq.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-seq.el Fri Dec 23 08:40:31 2005 +0000 @@ -282,7 +282,7 @@ mh-show-seq-tool-bar-map)))) (push 'widen mh-view-ops))) (t - (error "No messages in sequence `%s'" (symbol-name sequence)))))) + (error "No messages in sequence \"%s\"" (symbol-name sequence)))))) ;;;###mh-autoload (defun mh-put-msg-in-seq (range sequence) @@ -302,7 +302,7 @@ (interactive (list (mh-interactive-range "Add messages from") (mh-read-seq-default "Add to" nil))) (unless (mh-valid-seq-p sequence) - (error "Can't put message in invalid sequence `%s'" sequence)) + (error "Can't put message in invalid sequence \"%s\"" sequence)) (let* ((internal-seq-flag (mh-internal-seq sequence)) (original-msgs (mh-seq-msgs (mh-find-seq sequence))) (folders (list mh-current-folder)) @@ -428,7 +428,7 @@ (t (intern input)))) (msgs (mh-seq-to-msgs seq))) (if (and (null msgs) not-empty) - (error "No messages in sequence `%s'" seq)) + (error "No messages in sequence \"%s\"" seq)) seq)) @@ -543,7 +543,7 @@ ((assoc (intern input) seq-list) (cdr (assoc (intern input) seq-list))) ((setq msg-list (mh-translate-range folder input)) msg-list) - (t (error "No messages in range `%s'" input))))) + (t (error "No messages in range \"%s\"" input))))) ;;;###mh-autoload (defun mh-translate-range (folder expr) @@ -884,7 +884,7 @@ ;;;###mh-autoload (defun mh-narrow-to-from (&optional pick-expr) - "Limit to messages with the same `From:' field. + "Limit to messages with the same \"From:\" field. With a prefix argument, edit PICK-EXPR. Use \\<mh-folder-mode-map>\\[mh-widen] to undo this command." @@ -894,7 +894,7 @@ ;;;###mh-autoload (defun mh-narrow-to-cc (&optional pick-expr) - "Limit to messages with the same `Cc:' field. + "Limit to messages with the same \"Cc:\" field. With a prefix argument, edit PICK-EXPR. Use \\<mh-folder-mode-map>\\[mh-widen] to undo this command." @@ -904,7 +904,7 @@ ;;;###mh-autoload (defun mh-narrow-to-to (&optional pick-expr) - "Limit to messages with the same `To:' field. + "Limit to messages with the same \"To:\" field. With a prefix argument, edit PICK-EXPR. Use \\<mh-folder-mode-map>\\[mh-widen] to undo this command."
--- a/lisp/mh-e/mh-utils.el Fri Dec 23 07:47:02 2005 +0000 +++ b/lisp/mh-e/mh-utils.el Fri Dec 23 08:40:31 2005 +0000 @@ -113,14 +113,14 @@ (defvar mh-scan-msg-format-string "%d" "This is a format string for width of the message number in a scan format. -Use `0%d' for zero-filled message numbers. This variable is only +Use \"0%d\" for zero-filled message numbers. This variable is only consulted if `mh-scan-format-file' is set to \"Use MH-E scan Format\".") (defvar mh-scan-msg-search-regexp "^[^0-9]*%d[^0-9]" "This regular expression matches a particular message. -It is a format string; use `%d' to represent the location of the +It is a format string; use \"%d\" to represent the location of the message number within the expression as in the default of \"^[^0-9]*%d[^0-9]\".") @@ -137,7 +137,7 @@ (defvar mh-note-seq ?% "Messages in a user-defined sequence are marked by this character. -Messages in the `search' sequence are marked by this character as +Messages in the \"search\" sequence are marked by this character as well.") @@ -787,7 +787,7 @@ If the buffer we start in is still visible and DONT-RETURN is nil then switch to it after that." `(defun ,function () - ,(format "Calls %s from the message's folder.\n%s\nSee `%s' for more info.\n" + ,(format "Calls %s from the message's folder.\n%s\nSee \"%s\" for more info.\n" original-function (if dont-return "" "When function completes, returns to the show buffer if it is @@ -2107,7 +2107,7 @@ ;; Initialize mh-sub-folders-cache... (defun mh-collect-folder-names () - "Collect folder names by running `flists'." + "Collect folder names by running \"flists\"." (unless mh-flists-process (setq mh-flists-process (mh-exec-cmd-daemon "folders" 'mh-collect-folder-names-filter