git.notmuchmail.org Git - notmuch/blob - man/man1/notmuch.1

   1 .\" notmuch - Not much of an email program, (just index, search and tagging)
   2 .\"
   3 .\" Copyright © 2009 Carl Worth
   4 .\"
   5 .\" Notmuch is free software: you can redistribute it and/or modify
   6 .\" it under the terms of the GNU General Public License as published by
   7 .\" the Free Software Foundation, either version 3 of the License, or
   8 .\" (at your option) any later version.
   9 .\"
  10 .\" Notmuch is distributed in the hope that it will be useful,
  11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\" GNU General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public License
  16 .\" along with this program.  If not, see http://www.gnu.org/licenses/ .
  17 .\"
  18 .\" Author: Carl Worth <cworth@cworth.org>
  19 .TH NOTMUCH 1 2013-12-30 "Notmuch 0.17"
  20 .SH NAME
  21 notmuch \- thread-based email index, search, and tagging
  22 .SH SYNOPSIS
  23 .B notmuch
  24 .RI "[" option " ...] " command  " [" arg " ...]"
  25 .SH DESCRIPTION
  26 Notmuch is a command-line based program for indexing, searching,
  27 reading, and tagging large collections of email messages.
  28
  29 This page describes how to get started using notmuch from the command
  30 line, and gives a brief overview of the commands available. For more
  31 information on e.g.
  32 .B notmuch show
  33 consult the \fBnotmuch-show\fR(1) man page, also accessible via
  34 .B notmuch help show
  35
  36 The quickest way to get started with Notmuch is to simply invoke the
  37 .B notmuch
  38 command with no arguments, which will interactively guide you through
  39 the process of indexing your mail.
  40 .SH NOTE
  41 While the command-line program
  42 .B notmuch
  43 provides powerful functionality, it does not provide the most
  44 convenient interface for that functionality. More sophisticated
  45 interfaces are expected to be built on top of either the command-line
  46 interface, or more likely, on top of the notmuch library
  47 interface. See http://notmuchmail.org for more about alternate
  48 interfaces to notmuch. The emacs-based interface to notmuch (available under
  49 .B emacs/
  50 in the Notmuch source distribution) is probably the most widely used at
  51 this time.
  52
  53 .SH OPTIONS
  54
  55 Supported global options for
  56 .B notmuch
  57 include
  58
  59 .RS 4
  60 .TP 4
  61 .B \-\-help
  62
  63 Print a synopsis of available commands and exit.
  64 .RE
  65
  66 .RS 4
  67 .TP 4
  68 .B \-\-version
  69
  70 Print the installed version of notmuch, and exit.
  71 .RE
  72
  73 .RS 4
  74 .TP 4
  75 .B \-\-config=FILE
  76
  77 Specify the configuration file to use. This overrides any
  78 configuration file specified by ${NOTMUCH_CONFIG}.
  79
  80 .RE
  81
  82 .SH COMMANDS
  83
  84
  85 .SS SETUP
  86
  87 The
  88 .B notmuch setup
  89 command is used to configure Notmuch for first use, (or to reconfigure
  90 it later).
  91
  92 The setup command will prompt for your full name, your primary email
  93 address, any alternate email addresses you use, and the directory
  94 containing your email archives. Your answers will be written to a
  95 configuration file in ${NOTMUCH_CONFIG} (if set) or
  96 ${HOME}/.notmuch-config . This configuration file will be created with
  97 descriptive comments, making it easy to edit by hand later to change the
  98 configuration. Or you can run
  99 .B "notmuch setup"
 100 again to change the configuration.
 101
 102 The mail directory you specify can contain any number of
 103 sub-directories and should primarily contain only files with individual
 104 email messages (eg. maildir or mh archives are perfect). If there are
 105 other, non-email files (such as indexes maintained by other email
 106 programs) then notmuch will do its best to detect those and ignore
 107 them.
 108
 109 Mail storage that uses mbox format, (where one mbox file contains many
 110 messages), will not work with notmuch. If that's how your mail is
 111 currently stored, it is recommended you first convert it to maildir
 112 format with a utility such as mb2md before running
 113 .B "notmuch setup" .
 114
 115 Invoking
 116 .B notmuch
 117 with no command argument will run
 118 .B setup
 119 if the setup command has not previously been completed.
 120 .RE
 121
 122 .SS OTHER COMMANDS
 123
 124 Several of the notmuch commands accept search terms with a common
 125 syntax. See \fNnotmuch-search-terms\fR(7)
 126 for more details on the supported syntax.
 127
 128 The
 129 .BR search ", " show " and " count
 130 commands are used to query the email database.
 131
 132 The
 133 .B reply
 134 command is useful for preparing a template for an email reply.
 135
 136 The
 137 .B tag
 138 command is the only command available for manipulating database
 139 contents.
 140
 141
 142 The
 143 .BR dump " and " restore
 144 commands can be used to create a textual dump of email tags for backup
 145 purposes, and to restore from that dump.
 146
 147 The
 148 .B config
 149 command can be used to get or set settings int the notmuch
 150 configuration file.
 151
 152 .SH ENVIRONMENT
 153 The following environment variables can be used to control the
 154 behavior of notmuch.
 155 .TP
 156 .B NOTMUCH_CONFIG
 157 Specifies the location of the notmuch configuration file. Notmuch will
 158 use ${HOME}/.notmuch\-config if this variable is not set.
 159
 160 .TP
 161 .B NOTMUCH_TALLOC_REPORT
 162 Location to write a talloc memory usage report. See
 163 .B talloc_enable_leak_report_full
 164 in \fBtalloc\fR(3)
 165 for more information.
 166
 167 .TP
 168 .B NOTMUCH_DEBUG_QUERY
 169 If set to a non-empty value, the notmuch library will print (to stderr) Xapian
 170 queries it constructs.
 171
 172 .SH SEE ALSO
 173
 174 \fBnotmuch-config\fR(1), \fBnotmuch-count\fR(1),
 175 \fBnotmuch-dump\fR(1), \fBnotmuch-hooks\fR(5),
 176 \fBnotmuch-insert\fR(1), \fBnotmuch-new\fR(1),
 177 \fBnotmuch-reply\fR(1), \fBnotmuch-restore\fR(1),
 178 \fBnotmuch-search\fR(1), \fBnotmuch-search-terms\fR(7),
 179 \fBnotmuch-show\fR(1), \fBnotmuch-tag\fR(1)
 180
 181
 182 The notmuch website:
 183 .B http://notmuchmail.org
 184 .SH CONTACT
 185 Feel free to send questions, comments, or kudos to the notmuch mailing
 186 list <notmuch@notmuchmail.org> . Subscription is not required before
 187 posting, but is available from the notmuchmail.org website.
 188
 189 Real-time interaction with the Notmuch community is available via IRC
 190 (server: irc.freenode.net, channel: #notmuch).