.\" 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 2012-05-15 "Notmuch 0.13"
.SH NAME
notmuch \- thread-based email index, search, and tagging
.SH SYNOPSIS
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
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 COMMANDS
+
+
+.SS SETUP
+
The
-.BR setup
+.B notmuch setup
command is used to configure Notmuch for first use, (or to reconfigure
it later).
-.RS 4
-.TP 4
-.B setup
-
-Interactively sets up notmuch for first use.
The setup command will prompt for your full name, your primary email
address, any alternate email addresses you use, and the directory
if the setup command has not previously been completed.
.RE
-
+.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
commands are used to query the email database.
-
The
.B reply
command is useful for preparing a template for an email reply.
-.RS 4
The
.B tag
Specifies the location of the notmuch configuration file. Notmuch will
use ${HOME}/.notmuch\-config if this variable is not set.
.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