aboutsummaryrefslogtreecommitdiffhomepage
path: root/man/man1/notmuch.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/man1/notmuch.1')
-rw-r--r--man/man1/notmuch.144
1 files changed, 43 insertions, 1 deletions
diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1
index a6573084..033cc107 100644
--- a/man/man1/notmuch.1
+++ b/man/man1/notmuch.1
@@ -21,7 +21,7 @@
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,6 +156,19 @@ 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),