X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.1;h=d64dd1e78f3672ebb8be16ce4165c9c814e43bc5;hp=82b48c3b942758790017cf4a1e2cf957d637a7f4;hb=9cfafc070a4df4935781a274f039dc63790ed0c2;hpb=a06889c8d48eff3f3fc76b5cbacc60ce46bd65da diff --git a/notmuch.1 b/notmuch.1 index 82b48c3b..d64dd1e7 100644 --- a/notmuch.1 +++ b/notmuch.1 @@ -16,7 +16,7 @@ .\" along with this program. If not, see http://www.gnu.org/licenses/ . .\" .\" Author: Carl Worth -.TH NOTMUCH 1 2009-10-31 "Notmuch 0.1" +.TH NOTMUCH 1 2011-11-23 "Notmuch 0.10" .SH NAME notmuch \- thread-based email index, search, and tagging .SH SYNOPSIS @@ -214,11 +214,26 @@ when sorting by .B newest\-first the threads will be sorted by the newest message in each thread. -.RE -.RS 4 By default, results will be displayed in reverse chronological order, (that is, the newest results will be displayed first). +.RE + +.RS 4 +.TP 4 +.BR \-\-offset=[\-]N + +Skip displaying the first N results. With the leading '\-', start at the Nth +result from the end. +.RE + +.RS 4 +.TP 4 +.BR \-\-limit=N + +Limit the number of displayed results to N. +.RE +.RS 4 See the .B "SEARCH SYNTAX" section below for details of the supported syntax for . @@ -287,7 +302,13 @@ 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: + +.nf +.nh http://homepage.ntlworld.com/jonathan.deboynepollard/FGA/mail-mbox-formats.html +.hy +.fi +. .RE .RS 4 .TP 4 @@ -312,8 +333,29 @@ message. Output the single decoded MIME part N of a single message. The search terms must match only a single message. Message parts are numbered in a depth-first walk of the message MIME structure, and are identified -in the 'json' or -'text' output formats. +in the 'json' or 'text' output formats. +.RE + +.RS 4 +.TP 4 +.B \-\-verify + +Compute and report the validity of any MIME cryptographic signatures +found in the selected content (ie. "multipart/signed" parts). Status +of the signature will be reported (currently only supported with +--format=json), and the multipart/signed part will be replaced by the +signed data. +.RE + +.RS 4 +.TP 4 +.B \-\-decrypt + +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. .RE A common use of @@ -330,14 +372,35 @@ section below for details of the supported syntax for . .RE .RS 4 .TP 4 -.BR count " ..." +.BR count " [options...] ..." Count messages matching the search terms. -The number of matching messages is output to stdout. +The number of matching messages (or threads) is output to stdout. + +With no search terms, a count of all messages (or threads) in the database will +be displayed. -With no search terms, a count of all messages in the database will be -displayed. +Supported options for +.B count +include +.RS 4 +.TP 4 +.B \-\-output=(messages|threads) + +.RS 4 +.TP 4 +.B messages + +Output the number of matching messages. This is the default. +.RE +.RS 4 +.TP 4 +.B threads + +Output the number of matching threads. +.RE +.RE .RE .RE @@ -427,25 +490,38 @@ section below for details of the supported syntax for . The .BR dump " and " restore commands can be used to create a textual dump of email tags for backup -purposes, and to restore from that dump +purposes, and to restore from that dump. .RS 4 .TP 4 -.BR dump " []" +.BR dump " [] [--] []" Creates a plain-text dump of the tags of each message. -The output is to the given filename, if any, or to stdout. +Output is to the given filename, if any, or to stdout. Note that +using the filename argument is deprecated. These tags are the only data in the notmuch database that can't be recreated from the messages themselves. The output of notmuch dump is therefore the only critical thing to backup (and much more friendly to incremental backup than the native database files.) + +With no search terms, a dump of all messages in the database will be +generated. A "--" argument instructs notmuch that the +remaining arguments are search terms. + +See the +.B "SEARCH SYNTAX" +section below for details of the supported syntax for . +.RE + .TP -.BR restore " " +.BR restore " [--accumulate] []" Restores the tags from the given file (see -.BR "notmuch dump" "." +.BR "notmuch dump" ")." + +The input is read from the given filename, if any, or from stdin. Note: The dump file format is specifically chosen to be compatible with the format of files produced by sup-dump. @@ -453,11 +529,15 @@ So if you've previously been using sup for mail, then the .B "notmuch restore" command provides you a way to import all of your tags (or labels as sup calls them). + +The --accumulate switch causes the union of the existing and new tags to be +applied, instead of replacing each message's tags as they are read in from the +dump file. .RE The .B part -command can used to output a single part of a multi-part MIME message. +command can used to output a single part of a multipart MIME message. .RS 4 .TP 4 @@ -614,13 +694,13 @@ expression). Finally, results can be restricted to only messages within a 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 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 +timestamps. For example, with the bash shell the following syntax would specify a date range to return messages from 2009\-10\-01 until the current time: