(define-key map (kbd "DEL") 'notmuch-show-rewind)
(define-key map " " 'notmuch-show-advance-marking-read-and-archiving)
(define-key map "|" 'notmuch-show-pipe-message)
- (define-key map "?" 'describe-mode)
+ (define-key map "?" 'notmuch-help)
(define-key map (kbd "TAB") 'notmuch-show-next-button)
(define-key map (kbd "M-TAB") 'notmuch-show-previous-button)
map)
(notmuch-show-markup-message)))
(notmuch-show-hide-markers))
+(defun notmuch-documentation-first-line (symbol)
+ "Return the first line of the documentation string for SYMBOL."
+ (let ((doc (documentation symbol)))
+ (if doc
+ (with-temp-buffer
+ (insert (documentation symbol))
+ (goto-char (point-min))
+ (let ((beg (point)))
+ (end-of-line)
+ (buffer-substring beg (point))))
+ "")))
+
+(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))))
+
+(defun notmuch-substitute-command-keys (doc)
+ "Like `substitute-command-keys' but with documentation, not function names."
+ (let ((beg 0))
+ (while (string-match "\\\\{\\([^}[:space:]]*\\)}" doc beg)
+ (let ((map (substring doc (match-beginning 1) (match-end 1))))
+ (setq doc (replace-match (mapconcat 'notmuch-substitute-one-command-key
+ (cdr (symbol-value (intern map))) "\n") 1 1 doc)))
+ (setq beg (match-end 0)))
+ doc))
+
+(defun notmuch-help ()
+ "Display help for the current notmuch mode."
+ (interactive)
+ (let ((mode major-mode))
+ (with-help-window (help-buffer)
+ (princ (notmuch-substitute-command-keys (documentation mode t))))))
+
;;;###autoload
(defun notmuch-show-mode ()
"Major mode for viewing a thread with notmuch.
mode-name "notmuch-show")
(setq buffer-read-only t))
-;;;###autoload
-
(defgroup notmuch nil
"Notmuch mail reader for Emacs."
:group 'mail)
(setq btn (forward-button 1))
(error (setq btn nil)))
))
- (beginning-of-buffer)
+ (goto-char (point-min))
))))
)))
(defvar notmuch-search-mode-map
(let ((map (make-sparse-keymap)))
- (define-key map "a" 'notmuch-search-archive-thread)
+ (define-key map "?" 'notmuch-help)
+ (define-key map "q" 'kill-this-buffer)
+ (define-key map "x" 'kill-this-buffer)
+ (define-key map (kbd "<DEL>") 'notmuch-search-scroll-down)
(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 " " 'notmuch-search-scroll-up)
+ (define-key map "<" 'beginning-of-buffer)
+ (define-key map ">" 'notmuch-search-goto-last-thread)
(define-key map "p" 'previous-line)
- (define-key map "q" 'kill-this-buffer)
+ (define-key map "n" 'next-line)
(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 [mouse-1] 'notmuch-search-show-thread)
- (define-key map "+" 'notmuch-search-add-tag)
- (define-key map "-" 'notmuch-search-remove-tag)
+ (define-key map "f" 'notmuch-search-filter)
(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 "<DEL>") 'notmuch-search-scroll-down)
- (define-key map "?" 'describe-mode)
+ (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 [mouse-1] 'notmuch-search-show-thread)
+ (define-key map (kbd "RET") 'notmuch-search-show-thread)
map)
"Keymap for \"notmuch search\" buffers.")
(fset 'notmuch-search-mode-map notmuch-search-mode-map)
(goto-char (point-max))
(forward-line -1))
+(defface notmuch-tag-face
+ '((((class color)
+ (background dark))
+ (:foreground "OliveDrab1"))
+ (((class color)
+ (background light))
+ (:foreground "navy blue" :bold t))
+ (t
+ (:bold t)))
+ "Notmuch search mode face used to highligh tags."
+ :group 'notmuch)
+
+(defvar notmuch-tag-face-alist nil
+ "List containing the tag list that need to be highlighed")
+
+(defvar notmuch-search-font-lock-keywords nil)
+
;;;###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)
(setq truncate-lines t)
(setq major-mode 'notmuch-search-mode
mode-name "notmuch-search")
- (setq buffer-read-only t))
+ (setq buffer-read-only t)
+ (if (not notmuch-tag-face-alist)
+ (add-to-list 'notmuch-search-font-lock-keywords (list
+ "(\\([^)]*\\))$" '(1 'notmuch-tag-face)))
+ (progn
+ (setq notmuch-search-tags (mapcar 'car notmuch-tag-face-alist))
+ (loop for notmuch-search-tag in notmuch-search-tags
+ do (add-to-list 'notmuch-search-font-lock-keywords (list
+ (concat "([^)]*\\(" notmuch-search-tag "\\)[^)]*)$")
+ `(1 ,(cdr (assoc notmuch-search-tag notmuch-tag-face-alist))))))))
+ (set (make-local-variable 'font-lock-defaults)
+ '(notmuch-search-font-lock-keywords t)))
(defun notmuch-search-find-thread-id ()
"Return the thread for the current thread"
(get-text-property (point) 'notmuch-search-thread-id))
(defun notmuch-search-show-thread ()
+ "Display the currently selected thread."
(interactive)
(let ((thread-id (notmuch-search-find-thread-id)))
(if (> (length thread-id) 0)
(let ((words action-split))
(when (null words) (error "No operation given"))
(while words
- (unless (string-match-p "^[\+\-][_\+\-\\w]+$" (car words))
+ (unless (string-match-p "^[-+][-+_.[:word:]]+$" (car words))
(error "Action must be of the form `+thistag -that_tag'"))
(setq words (cdr words))))
(apply 'notmuch-call-notmuch-process "tag"
(append action-split (list notmuch-search-query-string) nil))))
+;;;###autoload
(defun notmuch-search (query &optional oldest-first)
"Run \"notmuch search\" with the given query string and display results."
(interactive "sNotmuch search: ")
(list (notmuch-select-tag-with-completion "Filter by tag: ")))
(notmuch-search (concat notmuch-search-query-string " and tag:" tag) notmuch-search-oldest-first))
+
+;;;###autoload
(defun notmuch ()
"Run notmuch to display all mail with tag of 'inbox'"
(interactive)
(define-key map (kbd "RET") 'notmuch-folder-show-search)
(define-key map "<" 'beginning-of-buffer)
(define-key map "=" 'notmuch-folder)
- (define-key map "?" 'describe-mode)
+ (define-key map "?" 'notmuch-help)
(define-key map [mouse-1] 'notmuch-folder-show-search)
map)
"Keymap for \"notmuch folder\" buffers.")
(if search
(notmuch-search (cdr search) notmuch-search-oldest-first))))
+;;;###autoload
(defun notmuch-folder ()
"Show the notmuch folder view and update the displayed counts."
(interactive)
projects / notmuch / blobdiff