debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2024-11-23 03:18:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
notmuch/man/man1/notmuch-reply.1

134 lines
3.8 KiB
Groff
Raw Normal View History

version: bump to 0.17~rc4 Unfortunately release-checks.sh will whine a bit because it has not caught up with the renaming of the version macros.
2013-12-28 23:40:05 +01:00
.TH NOTMUCH-REPLY 1 2013-12-28 "Notmuch 0.17~rc4"
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.SH NAME
manpages: consistent "format" for NAME section The NAME section in manpages generally doesn't start with capital letter (unless the word is 'proper noun') and doesn't end with period. Notmuch manual pages now matches that "format".
2012-06-24 23:53:27 +02:00
notmuch-reply \- constructs a reply template for a set of messages
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.SH SYNOPSIS
.B notmuch reply
.RI "[" options "...] <" search-term ">..."
.SH DESCRIPTION
Constructs a reply template for a set of messages.
To make replying to email easier,
.B notmuch reply
takes an existing set of messages and constructs a suitable mail
cli: add support for replying just to the sender in "notmuch reply" Add new option --reply-to=(all|sender) to "notmuch reply" to select whether to reply to all (sender and all recipients), or just sender. Reply to all remains the default. Credits to Mark Walters <markwalters1009@gmail.com> for his similar earlier work where I picked up the basic idea of handling reply-to-sender in add_recipients_from_message(). All bugs are mine, though. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-14 15:46:16 +01:00
template. The Reply-to: header (if any, otherwise From:) is used for
the To: address. Unless
.BR \-\-reply-to=sender
is specified, values from the To: and Cc: headers are copied, but not
including any of the current user's email addresses (as configured in
primary_mail or other_email in the .notmuch\-config file) in the
recipient list.
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
It also builds a suitable new subject, including Re: at the front (if
not already present), and adding the message IDs of the messages being
replied to to the References list and setting the In\-Reply\-To: field
correctly.
Finally, the original contents of the emails are quoted by prefixing
each line with '> ' and included in the body.
The resulting message template is output to stdout.
Supported options for
.B reply
include
.RS
.TP 4
Updating man pages for new S-Expression output format. Add sections about the new S-Expression output format (--format=sexp) to the notmuch-search, notmuch-reply and notmuch-show man pages.
2012-12-06 22:12:15 +01:00
.BR \-\-format= ( default | json | sexp | headers\-only )
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.RS
.TP 4
.BR default
reply: Use RFC 2822/MIME wholly for text format template Previously, reply's default text format used an odd mix of RFC 2045 MIME encoding for the reply template's body and some made-up RFC 2822-like UTF-8 format for the headers. The intent was to present the headers to the user in a nice, un-encoded format, but this assumed that whatever ultimately sent the email would RFC 2047-encode the headers, while at the same time the body was already RFC 2045 encoded, so it assumed that whatever sent the email would *not* re-encode the body. This can be fixed by either producing a fully decoded UTF-8 reply template, or a fully encoded MIME-compliant RFC 2822 message. This patch does the latter because it is a) Well-defined by RFC 2822 and MIME (while any UTF-8 format would be ad hoc). b) Ready to be piped to sendmail. The point of the text format is to be minimal, so a user should be able to pop up the template in whatever editor they want, edit it, and push it to sendmail. c) Consistent with frontend capabilities. If a frontend has the smarts to RFC 2047 encode the headers before sending the mail, it probably has the smarts to RFC 2047 decode them before presenting the template to a user for editing. Also, as far as I know, nothing automated consumes the reply text format, so changing this should not cause serious problems. (And if anything does still consume this format, it probably gets these encoding issues wrong anyway.)
2013-08-16 17:35:43 +02:00
Includes subject and quoted message body as an RFC 2822 message.
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.TP
man: Update notmuch-reply man page for JSON format.
2012-03-18 17:32:38 +01:00
.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
Updating man pages for new S-Expression output format. Add sections about the new S-Expression output format (--format=sexp) to the notmuch-search, notmuch-reply and notmuch-show man pages.
2012-12-06 22:12:15 +01:00
.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
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.BR headers\-only
Only produces In\-Reply\-To, References, To, Cc, and Bcc headers.
.RE
man/*: formatting cleanup Fix some problems with indentation (controlled by markup) and whitespace. - notmuch.1: reformat Use .SS macro to make "notmuch setup" a subsection. Introduce another subsection for the remaining commands. - notmuch-config.1: reformat Put all the syntax in the synopsis. Supposedly this is the the UNIX way. - notmuch-reply.1: fix formatting issues. Give nicer formatting for synopsis. Insert missing SEE ALSO header. - notmuch-dump.1: reformat using subsections These seems more natural, although, as mentioned, it does require referring back to the synopsis. Or maybe copying parts of the synopsis
2011-12-20 01:53:37 +01:00
.RE
reply: Support --format-version
2012-12-16 04:17:26 +01:00
.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
cli: add support for replying just to the sender in "notmuch reply" Add new option --reply-to=(all|sender) to "notmuch reply" to select whether to reply to all (sender and all recipients), or just sender. Reply to all remains the default. Credits to Mark Walters <markwalters1009@gmail.com> for his similar earlier work where I picked up the basic idea of handling reply-to-sender in add_recipients_from_message(). All bugs are mine, though. Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-14 15:46:16 +01:00
.RS
.TP 4
.BR \-\-reply\-to= ( all | sender )
.RS
.TP 4
.BR all " (default)"
Replies to all addresses.
.TP 4
.BR 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.
.RE
.RE
man: Add --decrypt to reply flags
2012-03-18 17:32:39 +01:00
.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
man: show and reply --decrypt option requires gpg-agent
2013-03-01 17:43:26 +01:00
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.
man: Add --decrypt to reply flags
2012-03-18 17:32:39 +01:00
.RE
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
man/*: fixup page references - Replace references to section X below with page refences. - Add SEE ALSO to each page. This is a bit error prone, because each SEE ALSO section is different, i.e. a page does not refer to itself.
2011-12-20 02:41:48 +01:00
See \fBnotmuch-search-terms\fR(7)
for details of the supported syntax for <search-terms>.
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
Note: It is most common to use
.B "notmuch reply"
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
man: Update notmuch-reply man page for JSON format.
2012-03-18 17:32:38 +01:00
on issues found in multiple patches. The default format supports
Updating man pages for new S-Expression output format. Add sections about the new S-Expression output format (--format=sexp) to the notmuch-search, notmuch-reply and notmuch-show man pages.
2012-12-06 22:12:15 +01:00
replying to multiple messages at once, but the JSON and S-Expression
formats do not.
initial splitting of notmuch.1 We mostly just cut and paste the command descriptions into individual files, with a short header added to each one. The splitting into subdirectories is to support the use of ./man as an element in MANPATH, e.g. for testing.
2011-12-19 03:38:24 +01:00
.RE
.RE
man: add missing SEE ALSO header to notmuch reply man page Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-08 21:57:22 +01:00
reply: Support --format-version
2012-12-16 04:17:26 +01:00
.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.
man: add missing SEE ALSO header to notmuch reply man page Signed-off-by: Jani Nikula <jani@nikula.org>
2012-01-08 21:57:22 +01:00
.SH SEE ALSO
man/*: fixup page references - Replace references to section X below with page refences. - Add SEE ALSO to each page. This is a bit error prone, because each SEE ALSO section is different, i.e. a page does not refer to itself.
2011-12-20 02:41:48 +01:00
\fBnotmuch\fR(1), \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
man: reference notmuch-insert.1 Add references to notmuch-insert.1 from other man pages.
2013-06-23 06:23:58 +02:00
\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
man: update SEE ALSO references in man pages Drop references to notmuch-part(1). Reference all man pages. Fix man page section of notmuch-dump(1).
2012-03-11 22:36:16 +01:00
\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1),
\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1),
\fBnotmuch-tag\fR(1)
Reference in a new issue Copy permalink