git.cworth.org Git - obsolete/notmuch-old/blob - 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 2009-10-31 "Notmuch 0.1"
  20 .SH NAME
  21 notmuch \- thread-based email index, search, and tagging
  22 .SH SYNOPSIS
  23 .B notmuch
  24 .IR command " [" args " ...]"
  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 The quickest way to get started with Notmuch is to simply invoke the
  30 .B notmuch
  31 command with no arguments, which will interactively guide you through
  32 the process of indexing your mail.
  33 .SH NOTE
  34 While the command-line program
  35 .B notmuch
  36 provides powerful functionality, it does not provide the most
  37 convenient interface for that functionality. More sophisticated
  38 interfaces are expected to be built on top of either the command-line
  39 interface, or more likely, on top of the notmuch library
  40 interface. See http://notmuchmail.org for more about alternate
  41 interfaces to notmuch.
  42 .SH COMMANDS
  43 The
  44 .BR setup
  45 command is used to configure Notmuch for first use, (or to reconfigure
  46 it later).
  47 .RS 4
  48 .TP 4
  49 .B setup
  50
  51 Interactively sets up notmuch for first use.
  52
  53 The setup command will prompt for your full name, your primary email
  54 address, any alternate email addresses you use, and the directory
  55 containing your email archives. Your answers will be written to a
  56 configuration file in ${NOTMUCH_CONFIG} (if set) or
  57 ${HOME}/.notmuch-config . This configuration file will be created with
  58 descriptive comments, making it easy to edit by hand later to change the
  59 configuration. Or you can run
  60 .B "notmuch setup"
  61 again to change the configuration.
  62
  63 The mail directory you specify can contain any number of
  64 sub-directories and should primarily contain only files with individual
  65 email messages (eg. maildir or mh archives are perfect). If there are
  66 other, non-email files (such as indexes maintained by other email
  67 programs) then notmuch will do its best to detect those and ignore
  68 them.
  69
  70 Mail storage that uses mbox format, (where one mbox file contains many
  71 messages), will not work with notmuch. If that's how your mail is
  72 currently stored, it is recommended you first convert it to maildir
  73 format with a utility such as mb2md before running
  74 .B "notmuch setup" .
  75
  76 Invoking
  77 .B notmuch
  78 with no command argument will run
  79 .B setup
  80 if the setup command has not previously been completed.
  81 .RE
  82
  83 The
  84 .B new
  85 command is used to incorporate new mail into the notmuch database.
  86 .RS 4
  87 .TP 4
  88 .B new
  89
  90 Find and import any new messages to the database.
  91
  92 The
  93 .B new
  94 command scans all sub-directories of the database, performing
  95 full-text indexing on new messages that are found. Each new message
  96 will automatically be tagged with both the
  97 .BR inbox " and " unread
  98 tags.
  99
 100 You should run
 101 .B "notmuch new"
 102 once after first running
 103 .B "notmuch setup"
 104 to create the initial database. The first run may take a long time if
 105 you have a significant amount of mail (several hundred thousand
 106 messages or more). Subsequently, you should run
 107 .B "notmuch new"
 108 whenever new mail is delivered and you wish to incorporate it into the
 109 database. These subsequent runs will be much quicker than the initial
 110 run.
 111
 112 Note:
 113 .B notmuch new
 114 runs (other than the first run) will skip any read-only directories,
 115 so you can use that to mark directories that will not receive any new
 116 mail (and make
 117 .B notmuch new
 118 even faster).
 119
 120 Invoking
 121 .B notmuch
 122 with no command argument will run
 123 .B new
 124 if
 125 .B "notmuch setup"
 126 has previously been completed, but
 127 .B "notmuch new"
 128 has not previously been run.
 129 .RE
 130
 131 Several of the notmuch commands accept search terms with a common
 132 syntax. See the
 133 .B "SEARCH SYNTAX"
 134 section below for more details on the supported syntax.
 135
 136 The
 137 .BR search " and "show
 138 commands are used to query the email database.
 139 .RS 4
 140 .TP 4
 141 .BR search " [options...] <search-term>..."
 142
 143 Search for messages matching the given search terms, and display as
 144 results the threads containing the matched messages.
 145
 146 The output consists of one line per thread, giving a thread ID, the
 147 date of the newest (or oldest, depending on the sort option) matched
 148 message in the thread, the number of matched messages and total
 149 messages in the thread, the names of all participants in the thread,
 150 and the subject of the newest (or oldest) message.
 151
 152 Supported options for
 153 .B search
 154 include
 155 .RS 4
 156 .TP 4
 157 .BR \-\-sort= ( newest\-first | oldest\-first )
 158
 159 This option can be used to present results in either chronological order
 160 .RB ( oldest\-first )
 161 or reverse chronological order
 162 .RB ( newest\-first ).
 163
 164 Note: The thread order will be distinct between these two options
 165 (beyond being simply reversed). When sorting by
 166 .B oldest\-first
 167 the threads will be sorted by the oldest message in each thread, but
 168 when sorting by
 169 .B newest\-first
 170 the threads will be sorted by the newest message in each thread.
 171
 172 By default, results will be displayed in reverse chronological order,
 173 (that is, the newest results will be displayed first).
 174
 175 See the
 176 .B "SEARCH SYNTAX"
 177 section below for details of the supported syntax for <search-terms>.
 178 .RE
 179 .TP
 180 .BR show " <search-term>..."
 181
 182 Shows all messages matching the search terms.
 183
 184 The messages will be grouped and sorted based on the threading (all
 185 replies to a particular message will appear immediately after that
 186 message in date order). The output is not indented by default, but
 187 depth tags are printed so that proper indentation can be performed by
 188 a post-processor (such as the emacs interface to notmuch).
 189
 190 The  output format  is plain-text,  with all  text-content  MIME parts
 191 decoded. Various components in the output,
 192 .RB ( message ", " header ", " body ", " attachment ", and MIME " part ),
 193 will be delimited by easily-parsed markers. Each marker consists of a
 194 Control-L character (ASCII decimal 12), the name of the marker, and
 195 then either an opening or closing brace, ('{' or '}'), to either open
 196 or close the component.
 197
 198 A common use of
 199 .B notmuch show
 200 is to display a single thread of email messages. For this, use a
 201 search term of "thread:<thread-id>" as can be seen in the first
 202 column of output from the
 203 .B notmuch search
 204 command.
 205
 206 See the
 207 .B "SEARCH SYNTAX"
 208 section below for details of the supported syntax for <search-terms>.
 209 .RE
 210
 211 The
 212 .B reply
 213 command is useful for preparing a template for an email reply.
 214 .RS 4
 215 .TP 4
 216 .BR reply " [options...] <search-term>..."
 217
 218 Constructs a reply template for a set of messages.
 219
 220 To make replying to email easier,
 221 .B notmuch reply
 222 takes an existing set of messages and constructs a suitable mail
 223 template. The Reply-to header (if any, otherwise From:) is used for
 224 the To: address. Vales from the To: and Cc: headers are copied, but
 225 not including any of the current user's email addresses (as configured
 226 in primary_mail or other_email in the .notmuch-config file) in the
 227 recipient list
 228
 229 It also builds a suitable new subject, including Re: at the front (if
 230 not already present), and adding the message IDs of the messages being
 231 replied to to the References list and setting the In-Reply-To: field
 232 correctly.
 233
 234 Finally, the original contents of the emails are quoted by prefixing
 235 each line with '> ' and included in the body.
 236
 237 The resulting message template is output to stdout.
 238
 239 Supported options for
 240 .B reply
 241 include
 242 .RS
 243 .TP 4
 244 .BR \-\-format= ( default | headers\-only )
 245 .RS
 246 .TP 4
 247 .BR default
 248 Includes subject and quoted message body.
 249 .TP
 250 .BR headers-only
 251 Only produces In-Reply-To, References, To, Cc, and Bcc headers.
 252 .RE
 253
 254 See the
 255 .B "SEARCH SYNTAX"
 256 section below for details of the supported syntax for <search-terms>.
 257
 258 Note: It is most common to use
 259 .B "notmuch reply"
 260 with a search string matching a single message, (such as
 261 id:<message-id>), but it can be useful to reply to several messages at
 262 once. For example, when a series of patches are sent in a single
 263 thread, replying to the entire thread allows for the reply to comment
 264 on issue found in multiple patches.
 265 .RE
 266 .RE
 267
 268 The
 269 .B tag
 270 command is the only command available for manipulating database
 271 contents.
 272
 273 .RS 4
 274 .TP 4
 275 .BR tag " +<tag>|-<tag> [...] [--] <search-term>..."
 276
 277 Add/remove tags for all messages matching the search terms.
 278
 279 Tags prefixed by '+' are added while those prefixed by '-' are
 280 removed. For each message, tag removal is performed before tag
 281 addition.
 282
 283 The beginning of <search-terms> is recognized by the first
 284 argument that begins with neither '+' nor '-'. Support for
 285 an initial search term beginning with '+' or '-' is provided
 286 by allowing the user to specify a "--" argument to separate
 287 the tags from the search terms.
 288
 289 See the
 290 .B "SEARCH SYNTAX"
 291 section below for details of the supported syntax for <search-terms>.
 292 .RE
 293
 294 The
 295 .BR dump " and " restore
 296 commands can be used to create a textual dump of email tags for backup
 297 purposes, and to restore from that dump
 298
 299 .RS 4
 300 .TP 4
 301 .BR dump " [<filename>]"
 302
 303 Creates a plain-text dump of the tags of each message.
 304
 305 The output is to the given filename, if any, or to stdout.
 306
 307 These tags are the only data in the notmuch database that can't be
 308 recreated from the messages themselves.  The output of notmuch dump is
 309 therefore the only critical thing to backup (and much more friendly to
 310 incremental backup than the native database files.)
 311 .TP
 312 .BR restore " <filename>"
 313
 314 Restores the tags from the given file (see
 315 .BR "notmuch dump" "."
 316
 317 Note: The dump file format is specifically chosen to be
 318 compatible with the format of files produced by sup-dump.
 319 So if you've previously been using sup for mail, then the
 320 .B "notmuch restore"
 321 command provides you a way to import all of your tags (or labels as
 322 sup calls them).
 323 .SH SEARCH SYNTAX
 324 Several notmuch commands accept a common syntax for search terms.
 325
 326 The search terms can consist of free-form text (and quoted phrases)
 327 which will match all messages that contain all of the given
 328 terms/phrases in the body, the subject, or any of the sender or
 329 recipient headers.
 330
 331 In addition to free text, the following prefixes can be used to force
 332 terms to match against specific portions of an email, (where
 333 <brackets> indicate user-supplied values):
 334
 335         from:<name-or-address>
 336
 337         to:<name-or-address>
 338
 339         subject:<word-or-quoted-phrase>
 340
 341         attachment:<word>
 342
 343         tag:<tag>
 344
 345         id:<message-id>
 346
 347         thread:<thread-id>
 348
 349 The
 350 .B from:
 351 prefix is used to match the name or address of the sender of an email
 352 message.
 353
 354 The
 355 .B to:
 356 prefix is used to match the names or addresses of any recipient of an
 357 email message, (whether To, Cc, or Bcc).
 358
 359 Any term prefixed with
 360 .B subject:
 361 will match only text from the subject of an email. Searching for a
 362 phrase in the subject is supported by including quotation marks around
 363 the phrase, immediately following
 364 .BR subject: .
 365
 366 The
 367 .B attachment:
 368 prefix can be used to search for specific filenames (or extensions) of
 369 attachments to email messages.
 370
 371 For
 372 .BR tag: ,
 373 valid tag values include
 374 .BR inbox " and " unread
 375 by default for new messages added by
 376 .B notmuch new
 377 as well as any other tag values added manually with
 378 .BR "notmuch tag" .
 379
 380 For
 381 .BR id: ,
 382 message ID values are the literal contents of the Message-ID: header
 383 of email messages, but without the '<', '>' delimiters.
 384
 385 The
 386 .B thread:
 387 prefix can be used with the thread ID values that are generated
 388 internally by notmuch (and do not appear in email messages). These
 389 thread ID values can be seen in the first column of output from
 390 .B "notmuch search"
 391
 392 In addition to individual terms, multiple terms can be
 393 combined with Boolean operators (
 394 .BR and ", " or ", " not
 395 , etc.). Each term in the query will be implicitly connected by a
 396 logical AND if no explicit operator is provided, (except that terms
 397 with a common prefix will be implicitly combined with OR until we get
 398 Xapian defect #402 fixed).
 399
 400 Parentheses can also be used to control the combination of the Boolean
 401 operators, but will have to be protected from interpretation by the
 402 shell, (such as by putting quotation marks around any parenthesized
 403 expression).
 404
 405 Finally, results can be restricted to only messages within a
 406 particular time range, (based on the Date: header) with a syntax of:
 407
 408         <intial-timestamp>..<final-timestamp>
 409
 410 Each timestamp is a number representing the number of seconds since
 411 1970-01-01 00:00:00 UTC. This is not the most convenient means of
 412 expressing date ranges, but until notmuch is fixed to accept a more
 413 convenient form, one can use the date program to construct
 414 timestamps. For example, with the bash shell the folowing syntax would
 415 specify a date range to return messages from 2009-10-01 until the
 416 current time:
 417
 418         $(date +%s -d 2009-10-01)..$(date +%s)
 419 .SH SEE ALSO
 420 The emacs-based interface to notmuch (available as
 421 .B notmuch.el
 422 in the Notmuch distribution).
 423
 424 The notmuch website:
 425 .B http://notmuchmail.org
 426 .SH CONTACT
 427 Feel free to send questions, comments, or kudos to the notmuch mailing
 428 list <notmuch@notmuchmail.org> . Subscription is not required before
 429 posting, but is available from the notmuchmail.org website.
 430
 431 Real-time interaction with the Notmuch community is available via IRC
 432 (server: irc.freenode.net, channel: #notmuch).