doc/emacs: document a few notmuch-hello customizable variables.

[notmuch] / doc / notmuch-emacs.rst

diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst
index 991539bf94c8972ec87165a1d5103b7473424f51..785287858d24cca3bbf9fe62a16bb9a2fd267361 100644 (file)
--- a/doc/notmuch-emacs.rst
+++ b/doc/notmuch-emacs.rst
@@ -46,8 +46,47 @@ a mouse or by positioning the cursor and pressing ``<return>``
 |                    Customize Notmuch or this page.
 
 You can change the overall appearance of the notmuch-hello screen by
-customizing the variable :index:`notmuch-hello-sections`.
+customizing the variables
 
+:index:`notmuch-hello-sections`
+       |docstring::notmuch-hello-sections|
+
+:index:`notmuch-hello-thousands-separator`
+       |docstring::notmuch-hello-thousands-separator|
+
+:index:`notmuch-show-logo`
+       |docstring::notmuch-show-logo|
+
+:index:`!notmuch-column-control`
+    Controls the number of columns for saved searches/tags in notmuch view.
+
+    This variable has three potential types of values:
+
+    .. describe:: t
+
+       Automatically calculate the number of columns possible based
+       on the tags to be shown and the window width.
+
+    .. describe:: integer <n>
+
+       A lower bound on the number of characters that will
+       be used to display each column.
+
+    .. describe:: float <f>
+
+       A fraction of the window width that is the lower bound on the
+       number of characters that should be used for each column.
+
+    So:
+
+    - if you would like two columns of tags, set this to 0.5.
+
+    - if you would like a single column of tags, set this to 1.0.
+
+    - if you would like tags to be 30 characters wide, set this to 30.
+
+    - if you don't want to worry about all of this nonsense, leave
+      this set to `t`.
 
 
 notmuch-hello key bindings
@@ -221,6 +260,9 @@ pressing RET after positioning the cursor on a hidden part.
 ``+,-``
     Add or remove arbitrary tags from the current message.
 
+``!``
+    |docstring::notmuch-show-toggle-elide-non-matching|
+
 ``?``
     Display full set of key bindings
 
@@ -235,6 +277,27 @@ Display of messages can be controlled by the following variables
 :index:`notmuch-show-header-line`
        |docstring::notmuch-show-header-line|
 
+:index:`notmuch-multipart/alternative-discouraged`
+
+   Which mime types to hide by default for multipart messages.
+
+   Can either be a list of mime types (as strings) or a function
+   mapping a plist representing the current message to such a list.
+   The following example function would discourage `text/html` and
+   `multipart/related` generally, but discourage `text/plain` should
+   the message be sent from `whatever@example.com`.
+
+   .. code:: lisp
+
+      (defun my--determine-discouraged (msg)
+        (let* ((headers (plist-get msg :headers))
+               (from (or (plist-get headers :From) "")))
+          (cond
+           ((string-match "whatever@example.com" from)
+            (list "text/plain"))
+           (t
+            (list "text/html" "multipart/related")))))
+
 .. _show-copy:
 
 Copy to kill-ring
@@ -354,6 +417,8 @@ following key bindings:
 ``k``
     Tagging operations using :ref:`notmuch-tag-jump`
 
+``C-_`` ``C-/`` ``C-x u``: Undo previous tagging operation using :ref:`notmuch-tag-undo`
+
 .. _notmuch-jump:
 
 notmuch-jump