X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.el;h=3f27f08e9c1372b32bec7b391c7556c1c070e8c6;hp=6e548f10f022a4f243bb0d3f3252b9b869780fff;hb=335a8aec2bf36a9f947e4ebc333d9977c4606cd4;hpb=de4be1b2293699e45d42b6f395b16d854151a58f diff --git a/notmuch.el b/notmuch.el index 6e548f10..3f27f08e 100644 --- a/notmuch.el +++ b/notmuch.el @@ -789,10 +789,15 @@ which this thread was originally shown." (defun notmuch-substitute-one-command-key (binding) "For a key binding, return a string showing a human-readable representation -of the key as well as the first line of documentation from the bound function." - (concat (format-kbd-macro (vector (car binding))) - "\t" - (notmuch-documentation-first-line (cdr binding)))) +of the key as well as the first line of documentation from the bound function. + +For a mouse binding, return nil." + (let ((key (car binding))) + (if (mouse-event-p key) + nil + (concat (format-kbd-macro (vector key)) + "\t" + (notmuch-documentation-first-line (cdr binding)))))) (defun notmuch-substitute-command-keys (doc) "Like `substitute-command-keys' but with documentation, not function names." @@ -922,30 +927,29 @@ thread from that buffer can be show when done with this one)." (defvar notmuch-search-mode-map (let ((map (make-sparse-keymap))) - (define-key map "a" 'notmuch-search-archive-thread) - (define-key map "b" 'notmuch-search-scroll-down) - (define-key map "f" 'notmuch-search-filter) - (define-key map "m" 'message-mail) - (define-key map "n" 'next-line) - (define-key map "o" 'notmuch-search-toggle-order) - (define-key map "p" 'previous-line) + (define-key map "?" 'notmuch-help) (define-key map "q" 'kill-this-buffer) + (define-key map "x" 'kill-this-buffer) + (define-key map (kbd "") 'notmuch-search-scroll-down) + (define-key map "b" 'notmuch-search-scroll-down) + (define-key map " " 'notmuch-search-scroll-up) + (define-key map "<" 'notmuch-search-first-thread) + (define-key map ">" 'notmuch-search-last-thread) + (define-key map "p" 'notmuch-search-previous-thread) + (define-key map "n" 'notmuch-search-next-thread) (define-key map "r" 'notmuch-search-reply-to-thread) + (define-key map "m" 'message-mail) (define-key map "s" 'notmuch-search) + (define-key map "o" 'notmuch-search-toggle-order) + (define-key map "=" 'notmuch-search-refresh-view) (define-key map "t" 'notmuch-search-filter-by-tag) - (define-key map "x" 'kill-this-buffer) - (define-key map (kbd "RET") 'notmuch-search-show-thread) + (define-key map "f" 'notmuch-search-filter) (define-key map [mouse-1] 'notmuch-search-show-thread) - (define-key map "+" 'notmuch-search-add-tag) - (define-key map "-" 'notmuch-search-remove-tag) (define-key map "*" 'notmuch-search-operate-all) - (define-key map "<" 'beginning-of-buffer) - (define-key map ">" 'notmuch-search-goto-last-thread) - (define-key map "=" 'notmuch-search-refresh-view) - (define-key map "\M->" 'notmuch-search-goto-last-thread) - (define-key map " " 'notmuch-search-scroll-up) - (define-key map (kbd "") 'notmuch-search-scroll-down) - (define-key map "?" 'notmuch-help) + (define-key map "a" 'notmuch-search-archive-thread) + (define-key map "-" 'notmuch-search-remove-tag) + (define-key map "+" 'notmuch-search-add-tag) + (define-key map (kbd "RET") 'notmuch-search-show-thread) map) "Keymap for \"notmuch search\" buffers.") (fset 'notmuch-search-mode-map notmuch-search-mode-map) @@ -954,16 +958,15 @@ thread from that buffer can be show when done with this one)." (defvar notmuch-search-oldest-first t "Show the oldest mail first in the search-mode") - (defun notmuch-search-scroll-up () - "Scroll up, moving point to last message in thread if at end." + "Move forward through search results by one window's worth." (interactive) (condition-case nil (scroll-up nil) - ((end-of-buffer) (notmuch-search-goto-last-thread)))) + ((end-of-buffer) (notmuch-search-last-thread)))) (defun notmuch-search-scroll-down () - "Scroll down, moving point to first message in thread if at beginning." + "Move backward through the search results by one window's worth." (interactive) ; I don't know why scroll-down doesn't signal beginning-of-buffer ; the way that scroll-up signals end-of-buffer, but c'est la vie. @@ -973,15 +976,30 @@ thread from that buffer can be show when done with this one)." ; directly to that position. (We have to count lines since the ; window-start position is not the same as point-min due to the ; invisible thread-ID characters on the first line. - (if (equal (count-lines (point-min) (window-start)) 1) - (goto-char (window-start)) + (if (equal (count-lines (point-min) (window-start)) 0) + (goto-char (point-min)) (scroll-down nil))) -(defun notmuch-search-goto-last-thread () - "Move point to the last thread in the buffer." +(defun notmuch-search-next-thread () + "Select the next thread in the search results." + (interactive) + (next-line)) + +(defun notmuch-search-previous-thread () + "Select the previous thread in the search results." + (interactive) + (previous-line)) + +(defun notmuch-search-last-thread () + "Select the last thread in the search results." (interactive) (goto-char (point-max)) - (forward-line -1)) + (forward-line -2)) + +(defun notmuch-search-first-thread () + "Select the first thread in the search results." + (interactive) + (goto-char (point-min))) (defface notmuch-tag-face '((((class color) @@ -1002,22 +1020,27 @@ thread from that buffer can be show when done with this one)." ;;;###autoload (defun notmuch-search-mode () - "Major mode for searching mail with notmuch. + "Major mode displaying results of a notmuch search. This buffer contains the results of a \"notmuch search\" of your email archives. Each line in the buffer represents a single -thread giving a relative date for the thread and a subject. +thread giving a summary of the thread (a relative date, the +number of matched messages and total messages in the thread, +participants in the thread, a representative subject line, and +any tags). + +By default, pressing RET on any line displays that thread. The +'+' and '-' keys can be used to add or remove tags from a +thread. The 'a' key is a convenience key for archiving a +thread (removing the \"inbox\" tag). The '*' key can be used to +add or remove a tag from all threads in the current buffer. -Pressing RET on any line displays that thread. The '+' and '-' -keys can be used to add or remove tags from a thread. The 'a' key -is a convenience key for archiving a thread (removing the -\"inbox\" tag). +Other useful commands are 'f' for filtering the current search +based on an additional query string, 't' for filtering to include +only messages with a given tag, and 's' to execute a new, global +search. -Other useful commands are `notmuch-search-filter' for -filtering the current search based on an additional query string, -`notmuch-search-filter-by-tag' for filtering to include only -messages with a given tag, and `notmuch-search' to execute a new, -global search. +Complete list of currently available key bindings: \\{notmuch-search-mode-map}" (interactive) @@ -1101,25 +1124,29 @@ and will also appear in a buffer named \"*Notmuch errors*\"." (split-string (buffer-substring beg end)))))) (defun notmuch-search-add-tag (tag) - "Add a tag to messages in the current thread matching the -active query." + "Add a tag to the currently selected thread. + +The tag is added to messages in the currently selected thread +which match the current search terms." (interactive (list (notmuch-select-tag-with-completion "Tag to add: "))) (notmuch-call-notmuch-process "tag" (concat "+" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string) (notmuch-search-set-tags (delete-dups (sort (cons tag (notmuch-search-get-tags)) 'string<)))) (defun notmuch-search-remove-tag (tag) - "Remove a tag from messages in the current thread matching the -active query." + "Remove a tag from the currently selected thread. + +The tag is removed from messages in the currently selected thread +which match the current search terms." (interactive (list (notmuch-select-tag-with-completion "Tag to remove: " (notmuch-search-find-thread-id)))) (notmuch-call-notmuch-process "tag" (concat "-" tag) (notmuch-search-find-thread-id) " and " notmuch-search-query-string) (notmuch-search-set-tags (delete tag (notmuch-search-get-tags)))) (defun notmuch-search-archive-thread () - "Archive the current thread (remove its \"inbox\" tag). + "Archive the currently selected thread (remove its \"inbox\" tag). -This function advances point to the next line when finished." +This function advances the next thread when finished." (interactive) (notmuch-search-remove-tag "inbox") (forward-line)) @@ -1173,12 +1200,12 @@ This function advances point to the next line when finished." (delete-process proc)))) (defun notmuch-search-operate-all (action) - "Operate on all messages matching the current query. Any -number of whitespace separated actions can be given. Each action -must have one of the two forms + "Add/remove tags from all matching messages. - +tagname Add the tag `tagname' - -tagname Remove the tag `tagname' +Tis command adds or removes tags from all messages matching the +current search terms. When called interactively, this command +will prompt for tags to be added or removed. Tags prefixed with +'+' will be added and tags prefixed with '-' will be removed. Each character of the tag name may consist of alphanumeric characters as well as `_.+-'.