]> git.notmuchmail.org Git - notmuch/blobdiff - man/man1/notmuch.1
notmuch.1: smooth wording.
[notmuch] / man / man1 / notmuch.1
index 74f892e8780057c738e90573753f09b99cd63eba..fb8c0018efeb2264d2b9d1feab6968116fc00704 100644 (file)
@@ -26,6 +26,13 @@ notmuch \- thread-based email index, search, and tagging
 Notmuch is a command-line based program for indexing, searching,
 reading, and tagging large collections of email messages.
 
 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
 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,17 +45,20 @@ 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 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
 .SH COMMANDS
+
+
+.SS SETUP
+
 The
 The
-.BR setup
+.B notmuch setup
 command is used to configure Notmuch for first use, (or to reconfigure
 it later).
 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
 
 The setup command will prompt for your full name, your primary email
 address, any alternate email addresses you use, and the directory
@@ -80,7 +90,7 @@ with no command argument will run
 if the setup command has not previously been completed.
 .RE
 
 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
 
 Several of the notmuch commands accept search terms with a common
 syntax. See the
@@ -91,11 +101,9 @@ The
 .BR search ", " show " and " count
 commands are used to query the email database.
 
 .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.
 The
 .B reply
 command is useful for preparing a template for an email reply.
-.RS 4
 
 The
 .B tag
 
 The
 .B tag
@@ -121,9 +129,6 @@ behavior of notmuch.
 Specifies the location of the notmuch configuration file. Notmuch will
 use ${HOME}/.notmuch\-config if this variable is not set.
 .SH SEE ALSO
 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).
 
 The notmuch website:
 .B http://notmuchmail.org
 
 The notmuch website:
 .B http://notmuchmail.org