doc: use program and option directives to document options

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

diff --git a/doc/man1/notmuch-reply.rst b/doc/man1/notmuch-reply.rst
index 168c399c954f403fca7f51f3b1a4bd6436d169bc..4a78a90b2251d51d890a44026ee25dbe03babbd7 100644 (file)
--- a/doc/man1/notmuch-reply.rst
+++ b/doc/man1/notmuch-reply.rst
@@ -36,62 +36,67 @@ The resulting message template is output to stdout.
 
 Supported options for **reply** include
 
-``--format=``\ (**default**\ \|\ **json**\ \|\ **sexp**\ \|\ **headers-only**)
-    **default**
-        Includes subject and quoted message body as an RFC 2822
-        message.
-
-    **json**
-        Produces JSON output containing headers for a reply message
-        and the contents of the original message. This output can be
-        used by a client to create a reply message intelligently.
-
-    **sexp**
-        Produces S-Expression output containing headers for a reply
-        message and the contents of the original message. This output
-        can be used by a client to create a reply message
-        intelligently.
-
-    **headers-only**
-        Only produces In-Reply-To, References, To, Cc, and Bcc
-        headers.
-
-``--format-version=N``
-    Use the specified structured output format version. This is
-    intended for programs that invoke :any:`notmuch(1)` internally. If
-    omitted, the latest supported version will be used.
-
-``--reply-to=``\ (**all**\ \|\ **sender**)
-    **all** (default)
-        Replies to all addresses.
-
-    **sender**
-        Replies only to the sender. If replying to user's own message
-        (Reply-to: or From: header is one of the user's configured
-        email addresses), try To:, Cc:, and Bcc: headers in this
-        order, and copy values from the first that contains something
-        other than only the user's addresses.
-
-``--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.
-
-    If ``auto``, and a session key is already known for the
-    message, then it will be decrypted, but notmuch will not try
-    to access the user's secret keys.
-
-    Use ``false`` to avoid even automatic decryption.
-
-    Non-automatic decryption expects a functioning
-    :manpage:`gpg-agent(1)` to provide any needed credentials. Without
-    one, the decryption will likely fail.
-
-    Default: ``auto``
+.. program:: reply
+
+.. option:: --format=(default|json|sexp|headers-only)
+
+   **default**
+     Includes subject and quoted message body as an RFC 2822
+     message.
+
+   **json**
+     Produces JSON output containing headers for a reply message
+     and the contents of the original message. This output can be
+     used by a client to create a reply message intelligently.
+
+   **sexp**
+     Produces S-Expression output containing headers for a reply
+     message and the contents of the original message. This output
+     can be used by a client to create a reply message
+     intelligently.
+
+   **headers-only**
+     Only produces In-Reply-To, References, To, Cc, and Bcc
+     headers.
+
+.. option:: --format-version=N
+
+   Use the specified structured output format version. This is
+   intended for programs that invoke :any:`notmuch(1)` internally. If
+   omitted, the latest supported version will be used.
+
+.. option:: --reply-to=(all|sender)
+
+   **all** (default)
+     Replies to all addresses.
+
+   **sender**
+     Replies only to the sender. If replying to user's own message
+     (Reply-to: or From: header is one of the user's configured
+     email addresses), try To:, Cc:, and Bcc: headers in this
+     order, and copy values from the first that contains something
+     other than only the user's addresses.
+
+.. option:: --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.
+
+   If ``auto``, and a session key is already known for the
+   message, then it will be decrypted, but notmuch will not try
+   to access the user's secret keys.
+
+   Use ``false`` to avoid even automatic decryption.
+
+   Non-automatic decryption expects a functioning
+   :manpage:`gpg-agent(1)` to provide any needed credentials. Without
+   one, the decryption will likely fail.
+
+   Default: ``auto``
 
 See :any:`notmuch-search-terms(7)` for details of the supported syntax for
 <search-terms>.