emacs: Add new option notmuch-search-hide-excluded

[notmuch] / doc / man1 / notmuch-show.rst

diff --git a/doc/man1/notmuch-show.rst b/doc/man1/notmuch-show.rst
index 64639174d6c2763049d2b65d3c7d58c8c1bb00c6..c13d94de024400fa2ca9642424ab6ec03284ad56 100644 (file)
--- a/doc/man1/notmuch-show.rst
+++ b/doc/man1/notmuch-show.rst
@@ -27,6 +27,12 @@ Supported options for **show** include
 
 .. program:: show
 
 
 .. program:: show
 

+.. option:: --duplicate=N
+
+   Output duplicate number N. The numbering starts from 1, and matches
+   the order used by :option:`search --duplicate` and
+   :option:`search --output=files <search --output>`
+

 .. option:: --entire-thread=(true|false)
 
    If true, **notmuch show** outputs all messages in the thread of
 .. option:: --entire-thread=(true|false)
 
    If true, **notmuch show** outputs all messages in the thread of


@@ -36,7 +42,7 @@ Supported options for **show** include
 
 .. option:: --format=(text|json|sexp|mbox|raw)
 
 
 .. option:: --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, (**message**,
      **header**, **body**, **attachment**, and MIME **part**), will
      The default plain-text format has all text-content MIME parts
      decoded. Various components in the output, (**message**,
      **header**, **body**, **attachment**, and MIME **part**), will


@@ -46,7 +52,7 @@ Supported options for **show** include
      '}'), to either open or close the component. For a multipart
      MIME message, these parts will be nested.
 
      '}'), to either open or close the component. For a multipart
      MIME message, these parts will be nested.
 

-   **json**
+   json

      The output is formatted with Javascript Object Notation
      (JSON). This format is more robust than the text format for
      automated processing. The nested structure of multipart MIME
      The output is formatted with Javascript Object Notation
      (JSON). This format is more robust than the text format for
      automated processing. The nested structure of multipart MIME


@@ -58,7 +64,7 @@ Supported options for **show** include
      as UTF-8 and any message content included in the output will
      be charset-converted to UTF-8.
 
      as UTF-8 and any message content included in the output will
      be charset-converted to UTF-8.
 

-   **sexp**
+   sexp

      The output is formatted as the Lisp s-expression (sexp)
      equivalent of the JSON format above. Objects are formatted as
      property lists whose keys are keywords (symbols preceded by a
      The output is formatted as the Lisp s-expression (sexp)
      equivalent of the JSON format above. Objects are formatted as
      property lists whose keys are keywords (symbols preceded by a


@@ -66,7 +72,7 @@ Supported options for **show** include
      formatted as ``nil``. As for JSON, the s-expression output is
      always encoded as UTF-8.
 
      formatted as ``nil``. As for JSON, the s-expression output is
      always encoded as UTF-8.
 

-   **mbox**
+   mbox

      All matching messages are output in the traditional, Unix mbox
      format with each message being prefixed by a line beginning
      with "From " and a blank line separating each message. Lines
      All matching messages are output in the traditional, Unix mbox
      format with each message being prefixed by a line beginning
      with "From " and a blank line separating each message. Lines


@@ -77,7 +83,7 @@ Supported options for **show** include
 
        http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html
 
 
        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 specify a
      query that matches more than one message.
      Write the raw bytes of the given MIME part of a message to
      standard out. For this format, it is an error to specify a
      query that matches more than one message.


@@ -124,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).
 
    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
 .. option:: --verify
 
    Compute and report the validity of any MIME cryptographic


@@ -221,6 +236,13 @@ 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.
 
 can be seen in the first column of output from the
 :any:`notmuch-search(1)` command.
 

+CONFIGURATION
+=============
+
+Structured output (json / sexp) is influenced by the configuration
+option :nmconfig:`show.extra_headers`. See
+:any:`notmuch-config(1)` for details.
+

 EXIT STATUS
 ===========
 
 EXIT STATUS
 ===========