reply: Support --format-version

[notmuch] / man / man1 / notmuch-reply.1

diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1
index deb3ae1d8494de8b7cfba8c162b0a0d7dab59642..9fa1956113bdad1f526323d63ca0ebc6d2751175 100644 (file)
--- a/man/man1/notmuch-reply.1
+++ b/man/man1/notmuch-reply.1
@@ -1,6 +1,6 @@
-.TH NOTMUCH-REPLY 1 2012-03-18 "Notmuch 0.12~rc2"
+.TH NOTMUCH-REPLY 1 2012-08-20 "Notmuch 0.14"
 .SH NAME
-notmuch-reply \- Constructs a reply template for a set of messages.
+notmuch-reply \- constructs a reply template for a set of messages
 
 .SH SYNOPSIS
 
@@ -37,16 +37,36 @@ Supported options for
 include
 .RS
 .TP 4
-.BR \-\-format= ( default | headers\-only )
+.BR \-\-format= ( default | json | sexp | headers\-only )
 .RS
 .TP 4
 .BR default
 Includes subject and quoted message body.
 .TP
+.BR 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.
+.TP
+.BR 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.
+.TP
 .BR headers\-only
 Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
 .RE
 .RE
+
+.RS
+.TP 4
+.BR \-\-format-version=N
+
+Use the specified structured output format version.  This is intended
+for programs that invoke \fBnotmuch\fR(1) internally.  If omitted, the
+latest supported version will be used.
+.RE
+
 .RS
 .TP 4
 .BR \-\-reply\-to= ( all | sender )
@@ -63,6 +83,16 @@ values from the first that contains something other than only the
 user's addresses.
 .RE
 .RE
+.RS
+.TP 4
+.B \-\-decrypt
+
+Decrypt any MIME encrypted parts found in the selected content
+(ie. "multipart/encrypted" parts). Status of the decryption will be
+reported (currently only supported with --format=json and --format=sexp)
+and the multipart/encrypted part will be replaced by the decrypted
+content.
+.RE
 
 See \fBnotmuch-search-terms\fR(7)
 for details of the supported syntax for <search-terms>.
@@ -73,10 +103,23 @@ with a search string matching a single message, (such as
 id:<message-id>), but it can be useful to reply to several messages at
 once. For example, when a series of patches are sent in a single
 thread, replying to the entire thread allows for the reply to comment
-on issue found in multiple patches.
+on issues found in multiple patches. The default format supports
+replying to multiple messages at once, but the JSON and S-Expression
+formats do not.
 .RE
 .RE
 
+.SH EXIT STATUS
+
+This command supports the following special exit status codes
+
+.TP
+.B 20
+The requested format version is too old.
+.TP
+.B 21
+The requested format version is too new.
+
 .SH SEE ALSO
 
 \fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),