X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=man%2Fman1%2Fnotmuch.1;h=923fefecb247731ba36de9dc1eb45854800f4174;hp=590118742aea0321778c3a781bac9c071e92cca0;hb=6daee9b082f6683b21631c7e1dffaba6dcffe9be;hpb=482033f8f81b19228a7b74458f2b13ee3d6c1a17 diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1 index 59011874..923fefec 100644 --- a/man/man1/notmuch.1 +++ b/man/man1/notmuch.1 @@ -16,16 +16,23 @@ .\" along with this program. If not, see http://www.gnu.org/licenses/ . .\" .\" Author: Carl Worth -.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 -.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. +This page describes how to get started using notmuch from the command +line, and gives a brief overview of the commands available. For more +information on e.g. +.B notmuch show +consult the \fBnotmuch-show\fR(1) man page, also accessible via +.B notmuch help show + The quickest way to get started with Notmuch is to simply invoke the .B notmuch command with no arguments, which will interactively guide you through @@ -38,7 +45,40 @@ convenient interface for that functionality. More sophisticated interfaces are expected to be built on top of either the command-line interface, or more likely, on top of the notmuch library interface. See http://notmuchmail.org for more about alternate -interfaces to notmuch. +interfaces to notmuch. The emacs-based interface to notmuch (available under +.B emacs/ +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 @@ -82,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 -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 @@ -117,10 +156,22 @@ 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. + .SH SEE ALSO -The emacs-based interface to notmuch (available as -.B notmuch.el -in the Notmuch distribution). + +\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