diff options
| author | David Bremner <david@tethera.net> | 2023-09-18 06:16:47 -0300 |
|---|---|---|
| committer | David Bremner <david@tethera.net> | 2023-09-18 06:16:47 -0300 |
| commit | 1129cf890ef812321ac8296a4ca964a796df0b87 (patch) | |
| tree | ffe0b3a98a7210c292d94d3ae6c9ebbed70fd4a5 /doc | |
| parent | 12aa05f07cb8aae736895c46fb25e0106daf207c (diff) | |
| parent | d4e0aaa76bd9e7a9e36abf47dc9ad3ea8bc10334 (diff) | |
Merge remote-tracking branch 'origin/master' into nmwebnmweb
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makefile.local | 2 | ||||
| -rw-r--r-- | doc/conf.py | 2 | ||||
| -rw-r--r-- | doc/man1/notmuch-config.rst | 10 | ||||
| -rw-r--r-- | doc/man1/notmuch-git.rst | 4 | ||||
| -rw-r--r-- | doc/man1/notmuch-search.rst | 2 | ||||
| -rw-r--r-- | doc/man1/notmuch-show.rst | 9 | ||||
| -rw-r--r-- | doc/man7/notmuch-sexp-queries.rst | 8 | ||||
| -rw-r--r-- | doc/notmuch-emacs.rst | 45 |
8 files changed, 71 insertions, 11 deletions
diff --git a/doc/Makefile.local b/doc/Makefile.local index 51c729cf..aafa77a0 100644 --- a/doc/Makefile.local +++ b/doc/Makefile.local @@ -159,3 +159,5 @@ $(dir)/config.dox: version.stamp CLEAN := $(CLEAN) $(DOCBUILDDIR) $(DOCBUILDDIR)/.roff.stamp $(DOCBUILDDIR)/.texi.stamp CLEAN := $(CLEAN) $(DOCBUILDDIR)/.html.stamp $(DOCBUILDDIR)/.info.stamp CLEAN := $(CLEAN) $(MAN_GZIP_FILES) $(MAN_ROFF_FILES) $(dir)/conf.pyc $(dir)/config.dox + +CLEAN := $(CLEAN) $(dir)/__pycache__ diff --git a/doc/conf.py b/doc/conf.py index e23cb7d7..7ac13a5d 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -16,7 +16,7 @@ master_doc = 'index' # General information about the project. project = u'notmuch' -copyright = u'2009-2022, Carl Worth and many others' +copyright = u'2009-2023, Carl Worth and many others' location = os.path.dirname(__file__) diff --git a/doc/man1/notmuch-config.rst b/doc/man1/notmuch-config.rst index 388315f6..bd34afa4 100644 --- a/doc/man1/notmuch-config.rst +++ b/doc/man1/notmuch-config.rst @@ -122,6 +122,16 @@ paths are presumed relative to `$HOME` for items in section Default tag prefix (filter) for :any:`notmuch-git`. +.. nmconfig:: index.as_text + + List of regular expressions (without delimiters) for MIME types to + be indexed as text. Currently this applies only to attachments. By + default the regex matches anywhere in the content type; if the + user wants an anchored match, they should include anchors in their + regexes. + + History: This configuration value was introduced in notmuch 0.38. + .. nmconfig:: index.decrypt Policy for decrypting encrypted messages during indexing. Must be diff --git a/doc/man1/notmuch-git.rst b/doc/man1/notmuch-git.rst index ac1908b6..33a46f84 100644 --- a/doc/man1/notmuch-git.rst +++ b/doc/man1/notmuch-git.rst @@ -325,11 +325,11 @@ If it is unset, 'default' is assumed. .. envvar:: NOTMUCH_GIT_DIR - Default location of git repository. Overriden by :option:`--git-dir`. + Default location of git repository. Overridden by :option:`--git-dir`. .. envvar:: NOTMUCH_GIT_PREFIX - Default tag prefix (filter). Overriden by :option:`--tag-prefix`. + Default tag prefix (filter). Overridden by :option:`--tag-prefix`. SEE ALSO ======== diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst index ad305efd..b87737ea 100644 --- a/doc/man1/notmuch-search.rst +++ b/doc/man1/notmuch-search.rst @@ -43,7 +43,7 @@ Supported options for **search** include .. option:: --output=(summary|threads|messages|files|tags) - summary + summary (default) Output a summary of each thread with any message matching the search terms. The summary includes the thread ID, date, the number of messages in the thread (both the number matched and diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst index 2c0a0de6..c13d94de 100644 --- a/doc/man1/notmuch-show.rst +++ b/doc/man1/notmuch-show.rst @@ -130,6 +130,15 @@ Supported options for **show** include By default, results will be displayed in reverse chronological order, (that is, the newest results will be displayed first). +.. option:: --offset=[-]N + + Skip displaying the first N results. With the leading '-', start + at the Nth result from the end. + +.. option:: --limit=N + + Limit the number of displayed results to N. + .. option:: --verify Compute and report the validity of any MIME cryptographic diff --git a/doc/man7/notmuch-sexp-queries.rst b/doc/man7/notmuch-sexp-queries.rst index 422154c7..858ff685 100644 --- a/doc/man7/notmuch-sexp-queries.rst +++ b/doc/man7/notmuch-sexp-queries.rst @@ -274,7 +274,7 @@ EXAMPLES Matches any word starting with "prelim", inside a message subject. -``(subject (starts-wih quick) "brown fox")`` +``(subject (starts-with quick) "brown fox")`` Match messages whose subject contains "quick brown fox", but also "brown fox quicksand". @@ -336,7 +336,7 @@ user defined fields is permitted within a macro. NOTES ===== -.. [#macro-details] Technically macros impliment lazy evaluation and +.. [#macro-details] Technically macros implement lazy evaluation and lexical scope. There is one top level scope containing all macro definitions, but all parameter definitions are local to a given macro. @@ -347,10 +347,10 @@ NOTES .. [#aka-bool] a.k.a. boolean prefixes -.. [#not-phrase] Due to the implemention of phrase fields in Xapian, +.. [#not-phrase] Due to the implementation of phrase fields in Xapian, regex queries could only match individual words. -.. [#not-body] Due the the way ``body`` is implemented in notmuch, +.. [#not-body] Due to the way ``body`` is implemented in notmuch, this modifier is not supported in the ``body`` field. .. [#not-path] Due to the way recursive ``path`` queries are implemented diff --git a/doc/notmuch-emacs.rst b/doc/notmuch-emacs.rst index 846f5e67..7dff7d64 100644 --- a/doc/notmuch-emacs.rst +++ b/doc/notmuch-emacs.rst @@ -14,7 +14,7 @@ manual to refer to the Emacs interface to Notmuch. When this distinction is important, we’ll refer to the Emacs interface as *notmuch-emacs*. -Notmuch-emacs is highly customizable via the the Emacs customization +Notmuch-emacs is highly customizable via the Emacs customization framework (or just by setting the appropriate variables). We try to point out relevant variables in this manual, but in order to avoid duplication of information, you can usually find the most detailed @@ -493,7 +493,7 @@ in :ref:`notmuch-search`. Dealing with duplicates ----------------------- -If there are are multiple files with the same :mailheader:`Message-ID` +If there are multiple files with the same :mailheader:`Message-ID` (see :any:`duplicate-files`), then :any:`notmuch-show` displays the number of duplicates and identifies the current duplicate. In the following example duplicate 3 of 5 is displayed. @@ -606,6 +606,45 @@ can be controlled by the variable ``notmuch-search-oldest-first``. See also :el:defcustom:`notmuch-search-result-format` and :el:defcustom:`notmuch-unthreaded-result-format`. +.. _notmuch-tree-outline: + +notmuch-tree-outline +-------------------- + +When this mode is set, each thread and subthread in the results +list is treated as a foldable section, with its first message as +its header. + +The mode just makes available in the tree buffer all the +keybindings in info:emacs#Outline_Mode, and binds the following +additional keys: + +.. el:define-key:: <tab> + + Cycle visibility state of the current message's tree. + +.. el:define-key:: <M-tab> + + Cycle visibility state of all trees in the buffer. + +The behaviour of this minor mode is affected by the following +customizable variables: + +.. el:defcustom:: notmuch-tree-outline-enabled + + |docstring::notmuch-tree-outline-enabled| + +.. el:defcustom:: notmuch-tree-outline-visibility + + |docstring::notmuch-tree-outline-visibility| + +.. el:defcustom:: notmuch-tree-outline-auto-close + + |docstring::notmuch-tree-outline-auto-close| + +.. el:defcustom:: notmuch-tree-outline-open-on-next + + |docstring::notmuch-tree-outline-open-on-next| .. _notmuch-unthreaded: @@ -678,7 +717,7 @@ operations specified in ``notmuch-tagging-keys``; i.e. each notmuch-tag-undo ---------------- -Each notmuch buffer supporting tagging operations (i.e buffers in +Each notmuch buffer supporting tagging operations (i.e. buffers in :any:`notmuch-show`, :any:`notmuch-search`, :any:`notmuch-tree`, and :any:`notmuch-unthreaded` mode) keeps a local stack of tagging operations. These can be undone via :any:`notmuch-tag-undo`. By default |
