man: document the notmuch --config=FILE global option

[notmuch] / man / man1 / notmuch.1

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

-.TH NOTMUCH 1 2011-12-04 "Notmuch 0.10.2"
+.TH NOTMUCH 1 2013-02-17 "Notmuch 0.15.2"

 .SH NAME
 notmuch \- thread-based email index, search, and tagging
 .SH SYNOPSIS
 .B notmuch
 .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.
 .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.
 
 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
 
 
 .SH COMMANDS
 
 


@@ -93,9 +122,8 @@ if the setup command has not previously been completed.
 .SS OTHER COMMANDS
 
 Several of the notmuch commands accept search terms with a common
 .SS OTHER COMMANDS
 
 Several of the notmuch commands accept search terms with a common

-syntax. See the
-.B "SEARCH SYNTAX"
-section below for more details on the supported syntax.
+syntax. See \fNnotmuch-search-terms\fR(7)
+for more details on the supported syntax.

 
 The
 .BR search ", " show " and " count
 
 The
 .BR search ", " show " and " count


@@ -128,8 +156,23 @@ 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.
 .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.
+

 .SH SEE ALSO
 
 .SH SEE ALSO
 

+\fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
+\fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5), \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:
 .B http://notmuchmail.org
 .SH CONTACT
 The notmuch website:
 .B http://notmuchmail.org
 .SH CONTACT