X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=man%2Fman1%2Fnotmuch-reply.1;h=58e6a74676d1e98274703667a75e0f549e025dd6;hp=1f86b09138883c6786a58d1034247aa1d4e03f65;hb=80b25792b2fdbb7f495556db360148798e224930;hpb=a4b10675bfe6ee90d84b9880b59c4f5ff15eed3a diff --git a/man/man1/notmuch-reply.1 b/man/man1/notmuch-reply.1 index 1f86b091..58e6a746 100644 --- a/man/man1/notmuch-reply.1 +++ b/man/man1/notmuch-reply.1 @@ -1,6 +1,6 @@ -.TH NOTMUCH-REPLY 1 2012-05-08 "Notmuch 0.13~rc1" +.TH NOTMUCH-REPLY 1 2013-07-28 "Notmuch 0.16" .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,7 +37,7 @@ Supported options for include .RS .TP 4 -.BR \-\-format= ( default | json | headers\-only ) +.BR \-\-format= ( default | json | sexp | headers\-only ) .RS .TP 4 .BR default @@ -48,10 +48,25 @@ 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 ) @@ -74,9 +89,12 @@ user's addresses. 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 the -multipart/encrypted part will be replaced by the decrypted -content. +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. + +Decryption expects a functioning \fBgpg-agent\fR(1) to provide any +needed credentials. Without one, the decryption will fail. .RE See \fBnotmuch-search-terms\fR(7) @@ -89,14 +107,27 @@ 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 issues found in multiple patches. The default format supports -replying to multiple messages at once, but the JSON format does not. +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), -\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), +\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1), \fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)