]> git.cworth.org Git - notmuch/blobdiff - doc/man1/notmuch-show.rst
doc: cross-reference notmuch man pages with actual links
[notmuch] / doc / man1 / notmuch-show.rst
index 8bfa87c664f98124bbbe5a763cfb45e0c6603589..1291884f61fdd4040a700120e5d50621f318136d 100644 (file)
@@ -1,3 +1,5 @@
+.. _notmuch-show(1):
+
 ============
 notmuch-show
 ============
 ============
 notmuch-show
 ============
@@ -12,7 +14,7 @@ DESCRIPTION
 
 Shows all messages matching the search terms.
 
 
 Shows all messages matching the search terms.
 
-See **notmuch-search-terms(7)** for details of the supported syntax for
+See :any:`notmuch-search-terms(7)` for details of the supported syntax for
 <search-terms>.
 
 The messages will be grouped and sorted based on the threading (all
 <search-terms>.
 
 The messages will be grouped and sorted based on the threading (all
@@ -90,7 +92,7 @@ Supported options for **show** include
 
 ``--format-version=N``
     Use the specified structured output format version. This is
 
 ``--format-version=N``
     Use the specified structured output format version. This is
-    intended for programs that invoke **notmuch(1)** internally. If
+    intended for programs that invoke :any:`notmuch(1)` internally. If
     omitted, the latest supported version will be used.
 
 ``--part=N``
     omitted, the latest supported version will be used.
 
 ``--part=N``
@@ -130,7 +132,7 @@ Supported options for **show** include
     Use ``false`` to avoid even automatic decryption.
 
     Non-automatic decryption (``stash`` or ``true``, in the absence of
     Use ``false`` to avoid even automatic decryption.
 
     Non-automatic decryption (``stash`` or ``true``, in the absence of
-    a stashed session key) expects a functioning **gpg-agent(1)** to
+    a stashed session key) expects a functioning :manpage:`gpg-agent(1)` to
     provide any needed credentials. Without one, the decryption will
     fail.
 
     provide any needed credentials. Without one, the decryption will
     fail.
 
@@ -161,7 +163,7 @@ Supported options for **show** include
     Default: ``auto``
 
 ``--exclude=(true|false)``
     Default: ``auto``
 
 ``--exclude=(true|false)``
-    Specify whether to omit threads only matching search.tag\_exclude
+    Specify whether to omit threads only matching search.exclude\_tags
     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).
     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).
@@ -176,22 +178,24 @@ Supported options for **show** include
 ``--body=(true|false)``
     If true (the default) **notmuch show** includes the bodies of the
     messages in the output; if false, bodies are omitted.
 ``--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.``
+    ``--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``
 
     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-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
-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.
+    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 messages. For this, use a search term of "thread:<thread-id>" as
+can be seen in the first column of output from the
+:any:`notmuch-search(1)` command.
 
 EXIT STATUS
 ===========
 
 EXIT STATUS
 ===========
@@ -207,15 +211,15 @@ This command supports the following special exit status codes
 SEE ALSO
 ========
 
 SEE ALSO
 ========
 
-**notmuch(1)**,
-**notmuch-config(1)**,
-**notmuch-count(1)**,
-**notmuch-dump(1)**,
-**notmuch-hooks(5)**,
-**notmuch-insert(1)**,
-**notmuch-new(1)**,
-**notmuch-reply(1)**,
-**notmuch-restore(1)**,
-**notmuch-search(1)**,
-**notmuch-search-terms(7)**,
-**notmuch-tag(1)**
+:any:`notmuch(1)`,
+:any:`notmuch-config(1)`,
+:any:`notmuch-count(1)`,
+:any:`notmuch-dump(1)`,
+:any:`notmuch-hooks(5)`,
+:any:`notmuch-insert(1)`,
+:any:`notmuch-new(1)`,
+:any:`notmuch-reply(1)`,
+:any:`notmuch-restore(1)`,
+:any:`notmuch-search(1)`,
+:any:`notmuch-search-terms(7)`,
+:any:`notmuch-tag(1)`