X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=6c3d10fd2200be73e24d3f64db1c2e76b8741b62;hp=08bcf147ca35f6500e912b06ea115d04297b0998;hb=d3349358c6a5048559bd2a4faebe476ebd222170;hpb=1a579dfe6b13d959900d8ccb9a86526234ce5669 diff --git a/notmuch.1 b/notmuch.1 index 08bcf147..6c3d10fd 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -112,13 +112,33 @@ The output consists of one line per thread, giving a thread ID, the date of the oldest matched message in the thread, and the subject from that message. -Currently, the supported search terms are as follows, (where - indicate user-supplied values): +Currently, in addition to free text (and quoted phrases) which match +terms appearing anywhere within an email, the following prefixes can +be used to search specific portions of an email, (where +indicate user-supplied values): + + from: + + to: + + subject: tag: + id: + thread: +The from: prefix is used to match the name or address of the sender of +an email message. + +The to: prefix is used to match the names or addresses of any +recipient of an email message, (whether To, Cc, or Bcc). + +Any term prefixed with subject: will match only text from +the subject of an email. Quoted phrases are supported when +searching with: subject:\"this is a phrase\". + Valid tag values include .BR inbox " and " unread by default for new messages added by @@ -147,15 +167,49 @@ operators, but will have to be protected from interpretation by the shell, (such as by putting quotation marks around any parenthesized expression). .TP -.BR show " " +.BR reply " ..." -Show the thread with the given thread ID. +Constructs a reply template for a set of messages. -Displays each message in the thread on stdout. +See the documentation of +.B search +for deatils of the supported syntax of search terms. -Thread ID values are given as the first column in the output of the -"notmuch search" command. These are the random-looking strings of 32 -characters. +To make replying to email easier, +.B notmuch reply +takes an existing set of messages and constructs a suitable mail +template, taking From: and To: messages and using those for the new +To: address; copying Cc: addresses, building a suitable new subject +including Re: at the front, adding the old message IDs to the +References list and setting the In-Reply-To: field correctly. + +The resulting message template is output to stdout. + +.TP +.BR show " ..." + +Shows all messages matching the search terms. + +See the documentation of +.B search +for details of the supported syntax of search terms. + +A common use of +.B notmuch show +is to display a single thread of email messages. For this, use a +search term of "thread:" as can be seen in the first +column of output from the +.B notmuch search +command. + +All messages will be displayed in date order. The output format is +plain-text, with all text-content MIME parts decoded. Various +components in the output, +.RB ( message ", " header ", " body ", " attachment ", and MIME " part ), +will be delimited by easily-parsed markers. Each marker consists of a +Control-L character (ASCII decimal 12), the name of the marker, and +then either an opening or closing brace, ('{' or '}'), to either open +or close the component. .RE The