X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=man%2Fman1%2Fnotmuch.1;h=fe4965c30501a14f2abbcf950e87b72a489d1ca7;hp=3ab1af5dda9b4906c75c75661adbdbde18853478;hb=80b25792b2fdbb7f495556db360148798e224930;hpb=916aefc2de504a3f658145352c690c170504c8c1 diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1 index 3ab1af5d..fe4965c3 100644 --- a/man/man1/notmuch.1 +++ b/man/man1/notmuch.1 @@ -16,12 +16,12 @@ .\" along with this program. If not, see http://www.gnu.org/licenses/ . .\" .\" Author: Carl Worth -.TH NOTMUCH 1 2012-02-29 "Notmuch 0.12~rc1" +.TH NOTMUCH 1 2013-07-28 "Notmuch 0.16" .SH NAME notmuch \- thread-based email index, search, and tagging .SH SYNOPSIS .B notmuch -.IR command " [" args " ...]" +.RI "[" option " ...] " command " [" arg " ...]" .SH DESCRIPTION Notmuch is a command-line based program for indexing, searching, reading, and tagging large collections of email messages. @@ -50,6 +50,35 @@ interfaces to notmuch. The emacs-based interface to notmuch (available under in the Notmuch source distribution) is probably the most widely used at this time. +.SH OPTIONS + +Supported global options for +.B notmuch +include + +.RS 4 +.TP 4 +.B \-\-help + +Print a synopsis of available commands and exit. +.RE + +.RS 4 +.TP 4 +.B \-\-version + +Print the installed version of notmuch, and exit. +.RE + +.RS 4 +.TP 4 +.B \-\-config=FILE + +Specify the configuration file to use. This overrides any +configuration file specified by ${NOTMUCH_CONFIG}. + +.RE + .SH COMMANDS @@ -127,14 +156,27 @@ behavior of notmuch. .B NOTMUCH_CONFIG Specifies the location of the notmuch configuration file. Notmuch will use ${HOME}/.notmuch\-config if this variable is not set. + +.TP +.B NOTMUCH_TALLOC_REPORT +Location to write a talloc memory usage report. See +.B talloc_enable_leak_report_full +in \fBtalloc\fR(3) +for more information. + +.TP +.B NOTMUCH_DEBUG_QUERY +If set to a non-empty value, the notmuch library will print (to stderr) Xapian +queries it constructs. + .SH SEE ALSO \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1), -\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \fBnotmuch-new\fR(1), -\fBnotmuch-part\fR(1), \fBnotmuch-reply\fR(1), -\fBnotmuch-restore\fR(1), \fBnotmuch-search\fR(1), -\fBnotmuch-search-terms\fR(7), \fBnotmuch-show\fR(1), -\fBnotmuch-tag\fR(1) +\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), +\fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1), +\fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1), +\fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7), +\fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1) The notmuch website: