X-Git-Url: https://git.cworth.org/git?a=blobdiff_plain;f=manpages%2Fnotmuch-show-1.mdwn;h=11278cb479c055c146ccbf6493cce649e7188616;hb=219490b75a85ca18d449168575a0c7538e71612e;hp=4902b5acffdd090b0c3609e4fec8c0f43980d4dc;hpb=29654905e64093a5275f4a554527231072efccb9;p=notmuch-wiki
diff --git a/manpages/notmuch-show-1.mdwn b/manpages/notmuch-show-1.mdwn
index 4902b5a..11278cb 100644
--- a/manpages/notmuch-show-1.mdwn
+++ b/manpages/notmuch-show-1.mdwn
@@ -28,12 +28,12 @@
--entire-thread=(true|false)
If true, notmuch show outputs all messages in the thread of any
message matching the search terms; if false, it outputs only the
- matching messages. For --format=json and --format=sexp this
- defaults to true. For other formats, this defaults to false.
+ matching messages. For --format=json and --format=sexp this deâ
+ faults to true. For other formats, this defaults to false.
--format=(text|json|sexp|mbox|raw)
- text (default for messages)
+ text (default for messages)
The default plain-text format has all text-content MIME
parts decoded. Various components in the output, (mes-
sage, header, body, attachment, and MIME part), will be
@@ -48,8 +48,8 @@
for automated processing. The nested structure of multiâ
part MIME messages is reflected in nested JSON output. By
default JSON output includes all messages in a matching
- thread; that is, by default, --format=json sets
- --entire-thread. The caller can disable this behaviour by
+ thread; that is, by default, --format=json sets --en-
+ tire-thread. The caller can disable this behaviour by
setting --entire-thread=false. The JSON output is always
encoded as UTF-8 and any message content included in the
output will be charset-converted to UTF-8.
@@ -70,7 +70,7 @@
is termed "mboxrd" format and described in detail here:
http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
- raw (default if --part is given)
+ raw (default if --part is given)
Write the raw bytes of the given MIME part of a message
to standard out. For this format, it is an error to specâ
ify a query that matches more than one message.
@@ -88,9 +88,9 @@
decoding and similar functions.
--format-version=N
- Use the specified structured output format version. This is
- intended for programs that invoke notmuch(1) internally. If
- omitted, the latest supported version will be used.
+ Use the specified structured output format version. This is inâ
+ tended for programs that invoke notmuch(1) internally. If omitâ
+ ted, the latest supported version will be used.
--part=N
Output the single decoded MIME part N of a single message. The
@@ -103,20 +103,37 @@
part still has two MIME parts: part 0 is the whole message
(headers and body) and part 1 is just the body.
+ --sort=(newest-first|oldest-first)
+ This option can be used to present results in either chronologiâ
+ cal order (oldest-first) or reverse chronological order (new-
+ est-first).
+
+ Only threads as a whole are reordered. Ordering of messages
+ within each thread will not be affected by this flag, since that
+ order is always determined by the thread's replies.
+
+ By default, results will be displayed in reverse chronological
+ order, (that is, the newest results will be displayed first).
+
--verify
Compute and report the validity of any MIME cryptographic signaâ
- tures found in the selected content (ie. "multipart/signed"
+ tures found in the selected content (e.g., "multipart/signed"
parts). Status of the signature will be reported (currently only
- supported with --format=json and --format=sexp), and the multiâ
+ supported with --format=json and --format=sexp), and the multiâ
part/signed part will be replaced by the signed data.
- --decrypt=(false|auto|true)
- If true, decrypt any MIME encrypted parts found in the selected
- content (i.e. "multipart/encrypted" parts). Status of the
- decryption will be reported (currently only supported with
- --format=json and --format=sexp) and on successful decryption
- the multipart/encrypted part will be replaced by the decrypted
- content.
+ --decrypt=(false|auto|true|stash)
+ If true, decrypt any MIME encrypted parts found in the selected
+ content (e.g., "multipart/encrypted" parts). Status of the deâ
+ cryption will be reported (currently only supported with --for-
+ mat=json and --format=sexp) and on successful decryption the
+ multipart/encrypted part will be replaced by the decrypted conâ
+ tent.
+
+ stash behaves like true, but upon successful decryption it will
+ also stash the message's session key in the database, and index
+ the cleartext of the message, enabling automatic decryption in
+ the future.
If auto, and a session key is already known for the message,
then it will be decrypted, but notmuch will not try to access
@@ -124,46 +141,79 @@
Use false to avoid even automatic decryption.
- Non-automatic decryption expects a functioning gpg-agent(1) to
- provide any needed credentials. Without one, the decryption will
+ Non-automatic decryption (stash or true, in the absence of a
+ stashed session key) expects a functioning gpg-agent(1) to proâ
+ vide any needed credentials. Without one, the decryption will
fail.
- Note: true implies --verify.
+ Note: setting either true or stash here implies --verify.
+
+ Here is a table that summarizes each of these policies:
+
+ ââââââââââââââââ¬ââââââââ¬âââââââ¬âââââââ¬ââââââââ
+ â â false â auto â true â stash â
+ ââââââââââââââââ¼ââââââââ¼âââââââ¼âââââââ¼ââââââââ¤
+ âShow cleartâ â â X â X â X â
+ âext if sesâ â â â â â
+ âsion key is â â â â â
+ âalready known â â â â â
+ ââââââââââââââââ¼ââââââââ¼âââââââ¼âââââââ¼ââââââââ¤
+ âUse secret â â â X â X â
+ âkeys to show â â â â â
+ âcleartext â â â â â
+ ââââââââââââââââ¼ââââââââ¼âââââââ¼âââââââ¼ââââââââ¤
+ âStash any â â â â X â
+ ânewly recovâ â â â â â
+ âered session â â â â â
+ âkeys, reinâ â â â â â
+ âdexing mesâ â â â â â
+ âsage if found â â â â â
+ ââââââââââââââââ´ââââââââ´âââââââ´âââââââ´ââââââââ
+
+ Note: --decrypt=stash requires write access to the database.
+ Otherwise, notmuch show operates entirely in read-only mode.
Default: auto
--exclude=(true|false)
- Specify whether to omit threads only matching search.tag_exclude
- from the search results (the default) or not. In either case the
- excluded message will be marked with the exclude flag (except
- when output=mbox when there is nowhere to put the flag).
+ Specify whether to omit threads only matching search.exâ
+ clude_tags from the search results (the default) or not. In eiâ
+ ther case the excluded message will be marked with the exclude
+ flag (except when output=mbox when there is nowhere to put the
+ flag).
- If --entire-thread is specified then complete threads are
- returned regardless (with the excluded flag being set when
- appropriate) but threads that only match in an excluded message
- are not returned when --exclude=true.
+ If --entire-thread is specified then complete threads are reâ
+ turned regardless (with the excluded flag being set when approâ
+ priate) but threads that only match in an excluded message are
+ not returned when --exclude=true.
The default is --exclude=true.
--body=(true|false)
- If true (the default) notmuch show includes the bodies of the
- messages in the output; if false, bodies are omitted.
- --body=false is only implemented for the json and sexp formats
- and it is incompatible with --part > 0.
+ If true (the default) notmuch show includes the bodies of the
+ messages in the output; if false, bodies are omitted.
+ --body=false is only implemented for the text, json and sexp
+ formats and it is incompatible with --part > 0.
This is useful if the caller only needs the headers as body-less
output is much faster and substantially smaller.
--include-html
- Include "text/html" parts as part of the output (currently only
- supported with --format=json and --format=sexp). By default,
- unless --part=N is used to select a specific part or
+ Include "text/html" parts as part of the output (currently only
+ supported with --format=text, --format=json and --format=sexp).
+ By default, unless --part=N is used to select a specific part or
--include-html is used to include all "text/html" parts, no part
with content type "text/html" is included in the output.
- A common use of notmuch show is to display a single thread of email
+ A common use of notmuch show is to display a single thread of email
messages. For this, use a search term of "thread:<thread-id>" as can be
- seen in the first column of output from the notmuch search command.
+ seen in the first column of output from the notmuch-search(1) command.
+
+
+CONFIGURATION
+
+ Structured output (json / sexp) is influenced by the configuration opâ
+ tion show.extra_headers. See notmuch-config(1) for details.
EXIT STATUS
@@ -190,7 +240,7 @@
COPYRIGHT
- 2009-2018, Carl Worth and many others
+ 2009-2022, Carl Worth and many others
-0.26
+0.35