diff options
| author | Bill Wohler | 2005-11-03 19:59:38 +0000 |
|---|---|---|
| committer | Bill Wohler | 2005-11-03 19:59:38 +0000 |
| commit | be33fce45d923455499211dccd99214581c42816 (patch) | |
| tree | 8f9bd1398166fa350b09851786a5e7c825ffdf41 | |
| parent | 438fc2538471225b6f532bc28c5d70852a834359 (diff) | |
| download | emacs-be33fce45d923455499211dccd99214581c42816.tar.gz emacs-be33fce45d923455499211dccd99214581c42816.zip | |
* mh-customize.el (mh-refile-preserves-sequences-flag)
(mh-tick-seq, mh-update-sequences-after-mh-show-flag): Sync docstrings
with manual.
* mh-e.el (mh-update-sequences): Sync docstrings with manual.
* mh-seq.el (mh-delete-seq, mh-list-sequences, mh-narrow-to-seq)
(mh-widen, mh-toggle-tick, mh-narrow-to-tick): Sync docstrings with
manual.
| -rw-r--r-- | lisp/mh-e/ChangeLog | 12 | ||||
| -rw-r--r-- | lisp/mh-e/mh-customize.el | 25 | ||||
| -rw-r--r-- | lisp/mh-e/mh-e.el | 7 | ||||
| -rw-r--r-- | lisp/mh-e/mh-seq.el | 37 |
4 files changed, 61 insertions, 20 deletions
diff --git a/lisp/mh-e/ChangeLog b/lisp/mh-e/ChangeLog index edc3aa8fca8..3a325b129ed 100644 --- a/lisp/mh-e/ChangeLog +++ b/lisp/mh-e/ChangeLog | |||
| @@ -1,3 +1,15 @@ | |||
| 1 | 2005-11-03 Bill Wohler <wohler@newt.com> | ||
| 2 | |||
| 3 | * mh-customize.el (mh-refile-preserves-sequences-flag) | ||
| 4 | (mh-tick-seq, mh-update-sequences-after-mh-show-flag): Sync | ||
| 5 | docstrings with manual. | ||
| 6 | |||
| 7 | * mh-e.el (mh-update-sequences): Sync docstrings with manual. | ||
| 8 | |||
| 9 | * mh-seq.el (mh-delete-seq, mh-list-sequences, mh-narrow-to-seq) | ||
| 10 | (mh-widen, mh-toggle-tick, mh-narrow-to-tick): Sync docstrings | ||
| 11 | with manual. | ||
| 12 | |||
| 1 | 2005-11-01 Bill Wohler <wohler@newt.com> | 13 | 2005-11-01 Bill Wohler <wohler@newt.com> |
| 2 | 14 | ||
| 3 | * mh-comp.el (mh-redist-full-contents) Convert defvar to | 15 | * mh-comp.el (mh-redist-full-contents) Convert defvar to |
diff --git a/lisp/mh-e/mh-customize.el b/lisp/mh-e/mh-customize.el index f9997e373da..e1141210662 100644 --- a/lisp/mh-e/mh-customize.el +++ b/lisp/mh-e/mh-customize.el | |||
| @@ -1131,29 +1131,34 @@ See also `mh-reply'." | |||
| 1131 | 1131 | ||
| 1132 | (defcustom mh-refile-preserves-sequences-flag t | 1132 | (defcustom mh-refile-preserves-sequences-flag t |
| 1133 | "*Non-nil means that sequences are preserved when messages are refiled. | 1133 | "*Non-nil means that sequences are preserved when messages are refiled. |
| 1134 | If this variable is non-nil and a message belonging to a sequence other than | 1134 | |
| 1135 | cur or Previous-Sequence (see mh-profile 5) is refiled then it is put in the | 1135 | If a message is in any sequence (except \"Previous-Sequence:\" and \"cur\") |
| 1136 | same sequence in the destination folder." | 1136 | when it is refiled, then it will still be in those sequences in the |
| 1137 | destination folder. If this behavior is not desired, then turn off this | ||
| 1138 | option." | ||
| 1137 | :type 'boolean | 1139 | :type 'boolean |
| 1138 | :group 'mh-sequences) | 1140 | :group 'mh-sequences) |
| 1139 | 1141 | ||
| 1140 | (defcustom mh-tick-seq 'tick | 1142 | (defcustom mh-tick-seq 'tick |
| 1141 | "The name of the MH sequence for ticked messages. | 1143 | "The name of the MH sequence for ticked messages. |
| 1142 | You would change this option if you already use the `tick' sequence for your | 1144 | |
| 1143 | own use. You can also disable all of the ticking functions by choosing the | 1145 | You can customize this option if you already use the \"tick\" sequence for |
| 1144 | `Disable Ticking' item but there isn't much advantage to that." | 1146 | your own use. You can also disable all of the ticking functions by choosing |
| 1147 | the \"Disable Ticking\" item but there isn't much advantage to that." | ||
| 1145 | :type '(choice (const :tag "Disable Ticking" nil) | 1148 | :type '(choice (const :tag "Disable Ticking" nil) |
| 1146 | symbol) | 1149 | symbol) |
| 1147 | :group 'mh-sequences) | 1150 | :group 'mh-sequences) |
| 1148 | 1151 | ||
| 1149 | (defcustom mh-update-sequences-after-mh-show-flag t | 1152 | (defcustom mh-update-sequences-after-mh-show-flag t |
| 1150 | "*Non-nil means flush MH sequences to disk after message is shown. | 1153 | "*Non-nil means flush MH sequences to disk after message is shown. |
| 1154 | |||
| 1151 | Three sequences are maintained internally by MH-E and pushed out to MH when a | 1155 | Three sequences are maintained internally by MH-E and pushed out to MH when a |
| 1152 | message is shown. They include the sequence specified by your | 1156 | message is shown. They include the sequence specified by your |
| 1153 | `Unseen-Sequence:' profile entry, `cur', and the sequence listed by | 1157 | \"Unseen-Sequence:\" profile entry, \"cur\", and the sequence listed by the |
| 1154 | the `mh-tick-seq' option which is `tick' by default. | 1158 | option `mh-tick-seq' which is \"tick\" by default. If you do not like this |
| 1155 | If you do not like this behavior, set this option to nil. You can then update | 1159 | behavior, turn off this option. You can then update the state manually with |
| 1156 | the state manually with the \\<mh-folder-mode-map>`\\[mh-execute-commands]', `\\[mh-quit]', or `\\[mh-update-sequences]' commands." | 1160 | the `\\[mh-execute-commands]', `\\[mh-quit]', or `\\[mh-update-sequences]' |
| 1161 | commands." | ||
| 1157 | :type 'boolean | 1162 | :type 'boolean |
| 1158 | :group 'mh-sequences) | 1163 | :group 'mh-sequences) |
| 1159 | 1164 | ||
diff --git a/lisp/mh-e/mh-e.el b/lisp/mh-e/mh-e.el index 7f022687aef..caf870f159e 100644 --- a/lisp/mh-e/mh-e.el +++ b/lisp/mh-e/mh-e.el | |||
| @@ -1254,8 +1254,11 @@ regardless of the size of the `mh-large-folder' variable." | |||
| 1254 | 1254 | ||
| 1255 | 1255 | ||
| 1256 | (defun mh-update-sequences () | 1256 | (defun mh-update-sequences () |
| 1257 | "Update MH's Unseen-Sequence and current folder and message. | 1257 | "Flush MH-E's state out to MH. |
| 1258 | Flush MH-E's state out to MH. The message at the cursor becomes current." | 1258 | This function updates the sequence specified by your \"Unseen-Sequence:\" |
| 1259 | profile component, \"cur\", and the sequence listed by the `mh-tick-seq' | ||
| 1260 | option which is \"tick\" by default. The message at the cursor is used for | ||
| 1261 | \"cur\"." | ||
| 1259 | (interactive) | 1262 | (interactive) |
| 1260 | ;; mh-update-sequences is the opposite of mh-read-folder-sequences, | 1263 | ;; mh-update-sequences is the opposite of mh-read-folder-sequences, |
| 1261 | ;; which updates MH-E's state from MH. | 1264 | ;; which updates MH-E's state from MH. |
diff --git a/lisp/mh-e/mh-seq.el b/lisp/mh-e/mh-seq.el index efbfe0d221f..6dbb5f26c07 100644 --- a/lisp/mh-e/mh-seq.el +++ b/lisp/mh-e/mh-seq.el | |||
| @@ -140,7 +140,11 @@ redone to get the new thread tree. This makes incremental threading easier.") | |||
| 140 | 140 | ||
| 141 | ;;;###mh-autoload | 141 | ;;;###mh-autoload |
| 142 | (defun mh-delete-seq (sequence) | 142 | (defun mh-delete-seq (sequence) |
| 143 | "Delete the SEQUENCE." | 143 | "Delete SEQUENCE. |
| 144 | |||
| 145 | You are prompted for the sequence to delete. Note that this deletes only the | ||
| 146 | sequence, not the messages in the sequence. If you want to delete the | ||
| 147 | messages, use \"\\[universal-argument] \\[mh-delete-msg]\"." | ||
| 144 | (interactive (list (mh-read-seq-default "Delete" t))) | 148 | (interactive (list (mh-read-seq-default "Delete" t))) |
| 145 | (let ((msg-list (mh-seq-to-msgs sequence)) | 149 | (let ((msg-list (mh-seq-to-msgs sequence)) |
| 146 | (internal-flag (mh-internal-seq sequence)) | 150 | (internal-flag (mh-internal-seq sequence)) |
| @@ -161,7 +165,8 @@ redone to get the new thread tree. This makes incremental threading easier.") | |||
| 161 | 165 | ||
| 162 | ;;;###mh-autoload | 166 | ;;;###mh-autoload |
| 163 | (defun mh-list-sequences () | 167 | (defun mh-list-sequences () |
| 164 | "List the sequences defined in the folder being visited." | 168 | "List all sequences in folder. |
| 169 | The list appears in a buffer named \"*MH-E Sequences*\"." | ||
| 165 | (interactive) | 170 | (interactive) |
| 166 | (let ((folder mh-current-folder) | 171 | (let ((folder mh-current-folder) |
| 167 | (temp-buffer mh-sequences-buffer) | 172 | (temp-buffer mh-sequences-buffer) |
| @@ -228,8 +233,13 @@ appears." | |||
| 228 | 233 | ||
| 229 | ;;;###mh-autoload | 234 | ;;;###mh-autoload |
| 230 | (defun mh-narrow-to-seq (sequence) | 235 | (defun mh-narrow-to-seq (sequence) |
| 231 | "Restrict display of this folder to just messages in SEQUENCE. | 236 | "Restrict display to messages in SEQUENCE. |
| 232 | Use \\<mh-folder-mode-map>\\[mh-widen] to undo this command." | 237 | |
| 238 | You are prompted for the name of the sequence. What this command does is show | ||
| 239 | only those messages that are in the selected sequence in the MH-Folder buffer. | ||
| 240 | In addition, it limits further MH-E searches to just those messages. | ||
| 241 | |||
| 242 | When you want to widen the view to all your messages again, use \\[mh-widen]." | ||
| 233 | (interactive (list (mh-read-seq "Narrow to" t))) | 243 | (interactive (list (mh-read-seq "Narrow to" t))) |
| 234 | (with-mh-folder-updating (t) | 244 | (with-mh-folder-updating (t) |
| 235 | (cond ((mh-seq-to-msgs sequence) | 245 | (cond ((mh-seq-to-msgs sequence) |
| @@ -296,7 +306,7 @@ OP is one of 'widen and 'unthread." | |||
| 296 | 306 | ||
| 297 | ;;;###mh-autoload | 307 | ;;;###mh-autoload |
| 298 | (defun mh-widen (&optional all-flag) | 308 | (defun mh-widen (&optional all-flag) |
| 299 | "Restore the previous limit. | 309 | "Remove last restriction. |
| 300 | If optional prefix argument ALL-FLAG is non-nil, remove all limits." | 310 | If optional prefix argument ALL-FLAG is non-nil, remove all limits." |
| 301 | (interactive "P") | 311 | (interactive "P") |
| 302 | (let ((msg (mh-get-msg-num nil))) | 312 | (let ((msg (mh-get-msg-num nil))) |
| @@ -1669,7 +1679,14 @@ start of the region and the second is the point at the end." | |||
| 1669 | 1679 | ||
| 1670 | ;;;###mh-autoload | 1680 | ;;;###mh-autoload |
| 1671 | (defun mh-toggle-tick (range) | 1681 | (defun mh-toggle-tick (range) |
| 1672 | "Toggle tick mark of all messages in RANGE." | 1682 | "Toggle tick mark of all messages in RANGE. |
| 1683 | |||
| 1684 | This command adds messages to the \"tick\" sequence (which you can customize | ||
| 1685 | via the option `mh-tick-seq'). This sequence can be viewed later with the | ||
| 1686 | \\[mh-index-ticked-messages] command. | ||
| 1687 | |||
| 1688 | Check the documentation of `mh-interactive-range' to see how RANGE is read in | ||
| 1689 | interactive use." | ||
| 1673 | (interactive (list (mh-interactive-range "Tick"))) | 1690 | (interactive (list (mh-interactive-range "Tick"))) |
| 1674 | (unless mh-tick-seq | 1691 | (unless mh-tick-seq |
| 1675 | (error "Enable ticking by customizing `mh-tick-seq'")) | 1692 | (error "Enable ticking by customizing `mh-tick-seq'")) |
| @@ -1696,9 +1713,13 @@ start of the region and the second is the point at the end." | |||
| 1696 | 1713 | ||
| 1697 | ;;;###mh-autoload | 1714 | ;;;###mh-autoload |
| 1698 | (defun mh-narrow-to-tick () | 1715 | (defun mh-narrow-to-tick () |
| 1699 | "Limit to messages in `mh-tick-seq'. | 1716 | "Limit to ticked messages. |
| 1700 | 1717 | ||
| 1701 | Use \\<mh-folder-mode-map>\\[mh-widen] to undo this command." | 1718 | What this command does is show only those messages that are in the \"tick\" |
| 1719 | sequence (which you can customize via the `mh-tick-seq' option) in the | ||
| 1720 | MH-Folder buffer. In addition, it limits further MH-E searches to just those | ||
| 1721 | messages. When you want to widen the view to all your messages again, use | ||
| 1722 | \\[mh-widen]." | ||
| 1702 | (interactive) | 1723 | (interactive) |
| 1703 | (cond ((not mh-tick-seq) | 1724 | (cond ((not mh-tick-seq) |
| 1704 | (error "Enable ticking by customizing `mh-tick-seq'")) | 1725 | (error "Enable ticking by customizing `mh-tick-seq'")) |