Documentation for notmuch reply --format=(default|headers-only)

Signed-off-by: Jed Brown <jed@59A2.org>
This commit is contained in:
Jed Brown 2009-11-28 18:56:15 +01:00 committed by Carl Worth
parent 0a41c34310
commit a2a522a758
2 changed files with 33 additions and 5 deletions

View file

@ -211,9 +211,9 @@ section below for details of the supported syntax for <search-terms>.
The The
.B reply .B reply
command is useful for preparing a template for an email reply. command is useful for preparing a template for an email reply.
.RS 4
.TP .TP 4
.BR reply " <search-term>..." .BR reply " [options...] <search-term>..."
Constructs a reply template for a set of messages. Constructs a reply template for a set of messages.
@ -236,6 +236,21 @@ each line with '> ' and included in the body.
The resulting message template is output to stdout. The resulting message template is output to stdout.
Supported options for
.B reply
include
.RS
.TP 4
.BR \-\-format= ( default | headers\-only )
.RS
.TP 4
.BR default
Includes subject and quoted message body.
.TP
.BR headers-only
Only produces In-Reply-To, References, To, Cc, and Bcc headers.
.RE
See the See the
.B "SEARCH SYNTAX" .B "SEARCH SYNTAX"
section below for details of the supported syntax for <search-terms>. section below for details of the supported syntax for <search-terms>.
@ -248,6 +263,7 @@ 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 thread, replying to the entire thread allows for the reply to comment
on issue found in multiple patches. on issue found in multiple patches.
.RE .RE
.RE
The The
.B tag .B tag

View file

@ -204,7 +204,7 @@ command_t commands[] = {
"\t\tSee \"notmuch help search-terms\" for details of the search\n" "\t\tSee \"notmuch help search-terms\" for details of the search\n"
"\t\tterms syntax." }, "\t\tterms syntax." },
{ "reply", notmuch_reply_command, { "reply", notmuch_reply_command,
"<search-terms> [...]", "[options...] <search-terms> [...]",
"\t\tConstruct a reply template for a set of messages.", "\t\tConstruct a reply template for a set of messages.",
"\t\tConstructs a new message as a reply to a set of existing\n" "\t\tConstructs a new message as a reply to a set of existing\n"
"\t\tmessages. The Reply-To: header (if any, otherwise From:) is\n" "\t\tmessages. The Reply-To: header (if any, otherwise From:) is\n"
@ -213,10 +213,22 @@ command_t commands[] = {
"\n" "\n"
"\t\tA suitable subject is constructed. The In-Reply-to: and\n" "\t\tA suitable subject is constructed. The In-Reply-to: and\n"
"\t\tReferences: headers are set appropriately, and the content\n" "\t\tReferences: headers are set appropriately, and the content\n"
"\t\tof the original messages is quoted and included in the body.\n" "\t\tof the original messages is quoted and included in the body\n"
"\t\t(unless --format=headers-only is given).\n"
"\n" "\n"
"\t\tThe resulting message template is output to stdout.\n" "\t\tThe resulting message template is output to stdout.\n"
"\n" "\n"
"\t\tSupported options for reply include:\n"
"\n"
"\t\t--format=(default|headers-only)\n"
"\n"
"\t\t\tdefault:\n"
"\t\t\t\tIncludes subject and quoted message body.\n"
"\n"
"\t\t\theaders-only:\n"
"\t\t\t\tOnly produces In-Reply-To, References, To\n"
"\t\t\t\tCc, and Bcc headers.\n"
"\n"
"\t\tSee \"notmuch help search-terms\" for details of the search\n" "\t\tSee \"notmuch help search-terms\" for details of the search\n"
"\t\tterms syntax." }, "\t\tterms syntax." },
{ "tag", notmuch_tag_command, { "tag", notmuch_tag_command,