emacs: Add new customization option to sort saved searches

[notmuch] / notmuch.1

diff --git a/notmuch.1 b/notmuch.1
index 10ed32edc1c379699a590445075da72e0c3c46d9..bb20c220b45efc3870fa17a3d5a236bcaa9e3b51 100644 (file)
--- 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 <cworth@cworth.org>
 .\" along with this program.  If not, see http://www.gnu.org/licenses/ .
 .\"
 .\" Author: Carl Worth <cworth@cworth.org>

-.TH NOTMUCH 1 2009-10-31 "Notmuch 0.1"
+.TH NOTMUCH 1 2011-11-17 "Notmuch 0.10~rc2"

 .SH NAME
 notmuch \- thread-based email index, search, and tagging
 .SH SYNOPSIS
 .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.
 
 .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).
 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 <search-terms>.
 See the
 .B "SEARCH SYNTAX"
 section below for details of the supported syntax for <search-terms>.


@@ -357,14 +372,35 @@ section below for details of the supported syntax for <search-terms>.
 .RE
 .RS 4
 .TP 4
 .RE
 .RS 4
 .TP 4

-.BR count " <search-term>..."
+.BR count " [options...] <search-term>..."

 
 Count messages matching the search terms.
 
 
 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
 
 .RE
 .RE
 


@@ -454,7 +490,7 @@ section below for details of the supported syntax for <search-terms>.
 The
 .BR dump " and " restore
 commands can be used to create a textual dump of email tags for backup
 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
 
 .RS 4
 .TP 4


@@ -480,10 +516,12 @@ section below for details of the supported syntax for <search-terms>.
 .RE
 
 .TP
 .RE
 
 .TP

-.BR restore " <filename>"
+.BR restore " [--accumulate] [<filename>]"

 
 Restores the tags from the given file (see
 
 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.
 
 Note: The dump file format is specifically chosen to be
 compatible with the format of files produced by sup-dump.


@@ -491,6 +529,10 @@ 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).
 .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
 .RE
 
 The