X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=41f7c7e450826a703e8d14585d09d1a17849dbe7;hp=9d0473d5941423b310bf3c0af9389c2d49399064;hb=b9eac48c22f53f84ed1d9c1d8ca862a7b638c9ac;hpb=2e9c7aba99598eafd7b5fc52897da14ea13af216 diff --git a/notmuch.1 b/notmuch.1 index 9d0473d5..41f7c7e4 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -126,7 +126,7 @@ syntax. See the section below for more details on the supported syntax. The -.BR search " and "show +.BR search ", " show " and " count commands are used to query the email database. .RS 4 .TP 4 @@ -201,13 +201,13 @@ matched message will be displayed. .RS 4 .TP 4 -.B \-\-format=(json|text) +.B \-\-format=(text|json|mbox) .RS 4 .TP 4 .B text -The default plain-text format has text-content MIME parts +The default plain-text format has 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 @@ -220,12 +220,27 @@ or close the component. .TP 4 .B json -Format output as Javascript Object Notation (JSON). JSON output always -includes all messages in a matching thread; in effect +The output is formatted with Javascript Object Notation (JSON). This +format is more robust than the text format for automated +processing. JSON output always includes all messages in a matching +thread; in effect .B \-\-format=json implies .B \-\-entire\-thread +.RE +.RS 4 +.TP 4 +.B mbox + +All matching messages are output in the traditional, Unix mbox format +with each message being prefixed by a line beginning with "From " and +a blank line separating each message. Lines in the message content +beginning with "From " (preceded by zero or more '>' characters) have +an additional '>' character added. This reversible escaping +is termed "mboxrd" format and described in detail here: +http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html + .RE A common use of .B notmuch show @@ -239,6 +254,16 @@ See the .B "SEARCH SYNTAX" section below for details of the supported syntax for . .RE +.TP +.BR count " ..." + +Count messages matching the search terms. + +The number of matching messages is output to stdout. + +With no search terms, a count of all messages in the database will be +displayed. +.RE .RE The @@ -256,12 +281,12 @@ takes an existing set of messages and constructs a suitable mail template. The Reply-to header (if any, otherwise From:) is used for the To: address. Vales 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 +in primary_mail or other_email in the .notmuch\-config file) in the recipient list 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 +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 @@ -280,8 +305,8 @@ include .BR default Includes subject and quoted message body. .TP -.BR headers-only -Only produces In-Reply-To, References, To, Cc, and Bcc headers. +.BR headers\-only +Only produces In\-Reply\-To, References, To, Cc, and Bcc headers. .RE See the @@ -305,18 +330,18 @@ contents. .RS 4 .TP 4 -.BR tag " +|- [...] [--] ..." +.BR tag " +|\- [...] [\-\-] ..." Add/remove tags for all messages matching the search terms. -Tags prefixed by '+' are added while those prefixed by '-' are +Tags prefixed by '+' are added while those prefixed by '\-' are removed. For each message, tag removal is performed before tag addition. The beginning of is recognized by the first -argument that begins with neither '+' nor '-'. Support for -an initial search term beginning with '+' or '-' is provided -by allowing the user to specify a "--" argument to separate +argument that begins with neither '+' nor '\-'. Support for +an initial search term beginning with '+' or '\-' is provided +by allowing the user to specify a "\-\-" argument to separate the tags from the search terms. See the @@ -361,7 +386,7 @@ command can used to output a single part of a multi-part MIME message. .RS 4 .TP 4 -.BR part " --part= ..." +.BR part " \-\-part= ..." Output a single MIME part of a message. @@ -370,7 +395,7 @@ stdout. The search terms must match only a single message, otherwise this command will fail. The part number should match the part "id" field output by the -"--format=json" option of "notmuch show". If the message specified by +"\-\-format=json" option of "notmuch show". If the message specified by the search terms does not include a part with the specified "id" there will be no output. @@ -379,6 +404,34 @@ See the section below for details of the supported syntax for . .RE +The +.B config +command can be used to get settings from the notmuch configuration +file. + +.RS 4 +.TP 4 +.BR "config get "
. + +Get settings from the notmuch configuration file. + +The value of the specified configuration item is printed to stdout. If +the item has multiple values, each value is separated by a newline +character. + +Available configuration items include at least + + database.path + + user.name + + user.primary_email + + user.other_email + + new.tags +.RE + .SH SEARCH SYNTAX Several notmuch commands accept a common syntax for search terms. @@ -387,6 +440,9 @@ which will match all messages that contain all of the given terms/phrases in the body, the subject, or any of the sender or recipient headers. +As a special case, a search string consisting of exactly a single +asterisk ("*") will match all messages. + In addition to free text, the following prefixes can be used to force terms to match against specific portions of an email, (where indicate user-supplied values): @@ -438,7 +494,7 @@ as well as any other tag values added manually with For .BR id: , -message ID values are the literal contents of the Message-ID: header +message ID values are the literal contents of the Message\-ID: header of email messages, but without the '<', '>' delimiters. The @@ -467,21 +523,21 @@ particular time range, (based on the Date: header) with a syntax of: .. Each timestamp is a number representing the number of seconds since -1970-01-01 00:00:00 UTC. This is not the most convenient means of +1970\-01\-01 00:00:00 UTC. This is not the most convenient means of expressing date ranges, but until notmuch is fixed to accept a more convenient form, one can use the date program to construct timestamps. For example, with the bash shell the folowing syntax would -specify a date range to return messages from 2009-10-01 until the +specify a date range to return messages from 2009\-10\-01 until the current time: - $(date +%s -d 2009-10-01)..$(date +%s) + $(date +%s \-d 2009\-10\-01)..$(date +%s) .SH ENVIRONMENT The following environment variables can be used to control the behavior of notmuch. .TP .B NOTMUCH_CONFIG Specifies the location of the notmuch configuration file. Notmuch will -use ${HOME}/.notmuch-config if this variable is not set. +use ${HOME}/.notmuch\-config if this variable is not set. .SH SEE ALSO The emacs-based interface to notmuch (available as .B notmuch.el