doc: clean up manpages

Many of the manpages didn't treat literal text as literal text.  I've
tried to normalize some of the restructured text to make it a bit more
regular.

several of the synopsis lines are still untouched by this cleanup, but
i'm not sure what the right way to represent those is in .rst,
actually.

In particular find that if i rebuild the manpages, sometimes i end up
with some of the synopsis lines showing – (U+2013 EN DASH) where they
should have -- (2 × U+002D HYPHEN-MINUS) in the generated nroff
output, though i have not tracked down the source of this error yet.
This commit is contained in:
Daniel Kahn Gillmor 2018-06-19 18:36:16 -04:00 committed by David Bremner
parent 0741e48c3d
commit fd3c93650d
6 changed files with 30 additions and 30 deletions

View file

@ -32,8 +32,8 @@ Supported options for **address** include
``--output=(sender|recipients|count|address)`` ``--output=(sender|recipients|count|address)``
Controls which information appears in the output. This option can Controls which information appears in the output. This option can
be given multiple times to combine different outputs. When be given multiple times to combine different outputs. When
neither --output=sender nor --output=recipients is neither ``--output=sender`` nor ``--output=recipients`` is
given, --output=sender is implied. given, ``--output=sender`` is implied.
**sender** **sender**
Output all addresses from the *From* header. Output all addresses from the *From* header.
@ -63,19 +63,19 @@ Supported options for **address** include
**no** **no**
Output all occurrences of addresses in the matching Output all occurrences of addresses in the matching
messages. This is not applicable with --output=count. messages. This is not applicable with ``--output=count``.
**mailbox** **mailbox**
Deduplicate addresses based on the full, case sensitive name Deduplicate addresses based on the full, case sensitive name
and email address, or mailbox. This is effectively the same as and email address, or mailbox. This is effectively the same as
piping the --deduplicate=no output to **sort | uniq**, except piping the ``--deduplicate=no`` output to **sort | uniq**, except
for the order of results. This is the default. for the order of results. This is the default.
**address** **address**
Deduplicate addresses based on the case insensitive address Deduplicate addresses based on the case insensitive address
part of the mailbox. Of all the variants (with different name part of the mailbox. Of all the variants (with different name
or case), print the one occurring most frequently among the or case), print the one occurring most frequently among the
matching messages. If --output=count is specified, include all matching messages. If ``--output=count`` is specified, include all
variants in the count. variants in the count.
``--sort=``\ (**newest-first**\ \|\ **oldest-first**) ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
@ -86,7 +86,7 @@ Supported options for **address** include
By default, results will be displayed in reverse chronological By default, results will be displayed in reverse chronological
order, (that is, the newest results will be displayed first). order, (that is, the newest results will be displayed first).
However, if either --output=count or --deduplicate=address is However, if either ``--output=count`` or ``--deduplicate=address`` is
specified, this option is ignored and the order of the results is specified, this option is ignored and the order of the results is
unspecified. unspecified.

View file

@ -21,7 +21,7 @@ incremental backup than the native database files.)
See **notmuch-search-terms(7)** for details of the supported syntax See **notmuch-search-terms(7)** for details of the supported syntax
for <search-terms>. With no search terms, a dump of all messages in for <search-terms>. With no search terms, a dump of all messages in
the database will be generated. A "--" argument instructs notmuch that the database will be generated. A ``--`` argument instructs notmuch that
the remaining arguments are search terms. the remaining arguments are search terms.
Supported options for **dump** include Supported options for **dump** include

View file

@ -75,7 +75,7 @@ Supported options for **reply** include
If ``true``, decrypt any MIME encrypted parts found in the If ``true``, decrypt any MIME encrypted parts found in the
selected content (i.e., "multipart/encrypted" parts). Status selected content (i.e., "multipart/encrypted" parts). Status
of the decryption will be reported (currently only supported of the decryption will be reported (currently only supported
with --format=json and --format=sexp), and on successful with ``--format=json`` and ``--format=sexp``), and on successful
decryption the multipart/encrypted part will be replaced by decryption the multipart/encrypted part will be replaced by
the decrypted content. the decrypted content.

View file

@ -47,25 +47,25 @@ Supported options for **search** include
**threads** **threads**
Output the thread IDs of all threads with any message matching Output the thread IDs of all threads with any message matching
the search terms, either one per line (--format=text), the search terms, either one per line (``--format=text``),
separated by null characters (--format=text0), as a JSON array separated by null characters (``--format=text0``), as a JSON array
(--format=json), or an S-Expression list (--format=sexp). (``--format=json``), or an S-Expression list (``--format=sexp``).
**messages** **messages**
Output the message IDs of all messages matching the search Output the message IDs of all messages matching the search
terms, either one per line (--format=text), separated by null terms, either one per line (``--format=text``), separated by null
characters (--format=text0), as a JSON array (--format=json), characters (``--format=text0``), as a JSON array (``--format=json``),
or as an S-Expression list (--format=sexp). or as an S-Expression list (``--format=sexp``).
**files** **files**
Output the filenames of all messages matching the search Output the filenames of all messages matching the search
terms, either one per line (--format=text), separated by null terms, either one per line (``--format=text``), separated by null
characters (--format=text0), as a JSON array (--format=json), characters (``--format=text0``), as a JSON array (``--format=json``),
or as an S-Expression list (--format=sexp). or as an S-Expression list (``--format=sexp``).
Note that each message may have multiple filenames associated Note that each message may have multiple filenames associated
with it. All of them are included in the output (unless with it. All of them are included in the output (unless
limited with the --duplicate=N option). This may be limited with the ``--duplicate=N`` option). This may be
particularly confusing for **folder:** or **path:** searches particularly confusing for **folder:** or **path:** searches
in a specified directory, as the messages may have duplicates in a specified directory, as the messages may have duplicates
in other directories that are included in the output, although in other directories that are included in the output, although
@ -73,9 +73,9 @@ Supported options for **search** include
**tags** **tags**
Output all tags that appear on any message matching the search Output all tags that appear on any message matching the search
terms, either one per line (--format=text), separated by null terms, either one per line (``--format=text``), separated by null
characters (--format=text0), as a JSON array (--format=json), characters (``--format=text0``), as a JSON array (``--format=json``),
or as an S-Expression list (--format=sexp). or as an S-Expression list (``--format=sexp``).
``--sort=``\ (**newest-first**\ \|\ **oldest-first**) ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)
This option can be used to present results in either chronological This option can be used to present results in either chronological

View file

@ -71,7 +71,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 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 standard out. For this format, it is an error to specify a
query that matches more than one message. query that matches more than one message.
@ -105,16 +105,16 @@ Supported options for **show** include
``--verify`` ``--verify``
Compute and report the validity of any MIME cryptographic Compute and report the validity of any MIME cryptographic
signatures found in the selected content (ie. "multipart/signed" signatures found in the selected content (e.g., "multipart/signed"
parts). Status of the signature will be reported (currently only parts). Status of the signature will be reported (currently only
supported with --format=json and --format=sexp), and the supported with ``--format=json`` and ``--format=sexp``), and the
multipart/signed part will be replaced by the signed data. multipart/signed part will be replaced by the signed data.
``--decrypt=(false|auto|true|stash)`` ``--decrypt=(false|auto|true|stash)``
If ``true``, decrypt any MIME encrypted parts found in the If ``true``, decrypt any MIME encrypted parts found in the
selected content (i.e. "multipart/encrypted" parts). Status of selected content (e.g., "multipart/encrypted" parts). Status of
the decryption will be reported (currently only supported the decryption will be reported (currently only supported
with --format=json and --format=sexp) and on successful with ``--format=json`` and ``--format=sexp``) and on successful
decryption the multipart/encrypted part will be replaced by decryption the multipart/encrypted part will be replaced by
the decrypted content. the decrypted content.
@ -166,7 +166,7 @@ Supported options for **show** include
excluded message will be marked with the exclude flag (except when excluded message will be marked with the exclude flag (except when
output=mbox when there is nowhere to put the flag). output=mbox when there is nowhere to put the flag).
If --entire-thread is specified then complete threads are returned If ``--entire-thread`` is specified then complete threads are returned
regardless (with the excluded flag being set when appropriate) but regardless (with the excluded flag being set when appropriate) but
threads that only match in an excluded message are not returned threads that only match in an excluded message are not returned
when ``--exclude=true.`` when ``--exclude=true.``
@ -184,7 +184,7 @@ Supported options for **show** include
``--include-html`` ``--include-html``
Include "text/html" parts as part of the output (currently only Include "text/html" parts as part of the output (currently only
supported with --format=json and --format=sexp). By default, supported with ``--format=json`` and ``--format=sexp``). By default,
unless ``--part=N`` is used to select a specific part or unless ``--part=N`` is used to select a specific part or
``--include-html`` is used to include all "text/html" parts, no ``--include-html`` is used to include all "text/html" parts, no
part with content type "text/html" is included in the output. part with content type "text/html" is included in the output.

View file

@ -7,7 +7,7 @@ SYNOPSIS
**notmuch** **count** [option ...] <*search-term*> ... **notmuch** **count** [option ...] <*search-term*> ...
**notmuch** **dump** [--format=(batch-tag|sup)] [--] [--output=<*file*>] [--] [<*search-term*> ...] **notmuch** **dump** [--gzip] [--format=(batch-tag|sup)] [--output=<*file*>] [--] [<*search-term*> ...]
**notmuch** **reindex** [option ...] <*search-term*> ... **notmuch** **reindex** [option ...] <*search-term*> ...
@ -150,7 +150,7 @@ lastmod:<initial-revision>..<final-revision>
The **lastmod:** prefix can be used to restrict the result by the The **lastmod:** prefix can be used to restrict the result by the
database revision number of when messages were last modified (tags database revision number of when messages were last modified (tags
were added/removed or filenames changed). This is usually used in were added/removed or filenames changed). This is usually used in
conjunction with the **--uuid** argument to **notmuch search** to conjunction with the ``--uuid`` argument to **notmuch search** to
find messages that have changed since an earlier query. find messages that have changed since an earlier query.
query:<name> query:<name>