git.notmuchmail.org Git - notmuch/blob - doc/man1/notmuch.rst

   1 =======
   2 notmuch
   3 =======
   4
   5 SYNOPSIS
   6 ========
   7
   8 **notmuch** [option ...] **command** [arg ...]
   9
  10 DESCRIPTION
  11 ===========
  12
  13 Notmuch is a command-line based program for indexing, searching,
  14 reading, and tagging large collections of email messages.
  15
  16 This page describes how to get started using notmuch from the command
  17 line, and gives a brief overview of the commands available. For more
  18 information on e.g. **notmuch show** consult the **notmuch-show(1)** man
  19 page, also accessible via **notmuch help show**
  20
  21 The quickest way to get started with Notmuch is to simply invoke the
  22 ``notmuch`` command with no arguments, which will interactively guide
  23 you through the process of indexing your mail.
  24
  25 NOTE
  26 ====
  27
  28 While the command-line program ``notmuch`` provides powerful
  29 functionality, it does not provide the most convenient interface for
  30 that functionality. More sophisticated interfaces are expected to be
  31 built on top of either the command-line interface, or more likely, on
  32 top of the notmuch library interface. See http://notmuchmail.org for
  33 more about alternate interfaces to notmuch. The emacs-based interface to
  34 notmuch (available under **emacs/** in the Notmuch source distribution)
  35 is probably the most widely used at this time.
  36
  37 OPTIONS
  38 =======
  39
  40 Supported global options for ``notmuch`` include
  41
  42     ``--help``
  43         Print a synopsis of available commands and exit.
  44
  45     ``--version``
  46         Print the installed version of notmuch, and exit.
  47
  48     ``--config=FILE``
  49         Specify the configuration file to use. This overrides any
  50         configuration file specified by ${NOTMUCH\_CONFIG}.
  51
  52 COMMANDS
  53 ========
  54
  55 SETUP
  56 -----
  57
  58 The **notmuch setup** command is used to configure Notmuch for first
  59 use, (or to reconfigure it later).
  60
  61 The setup command will prompt for your full name, your primary email
  62 address, any alternate email addresses you use, and the directory
  63 containing your email archives. Your answers will be written to a
  64 configuration file in ${NOTMUCH\_CONFIG} (if set) or
  65 ${HOME}/.notmuch-config . This configuration file will be created with
  66 descriptive comments, making it easy to edit by hand later to change the
  67 configuration. Or you can run **notmuch setup** again to change the
  68 configuration.
  69
  70 The mail directory you specify can contain any number of sub-directories
  71 and should primarily contain only files with individual email messages
  72 (eg. maildir or mh archives are perfect). If there are other, non-email
  73 files (such as indexes maintained by other email programs) then notmuch
  74 will do its best to detect those and ignore them.
  75
  76 Mail storage that uses mbox format, (where one mbox file contains many
  77 messages), will not work with notmuch. If that's how your mail is
  78 currently stored, it is recommended you first convert it to maildir
  79 format with a utility such as mb2md before running **notmuch setup .**
  80
  81 Invoking ``notmuch`` with no command argument will run **setup** if the
  82 setup command has not previously been completed.
  83
  84 OTHER COMMANDS
  85 --------------
  86
  87 Several of the notmuch commands accept search terms with a common
  88 syntax. See **notmuch-search-terms**\ (7) for more details on the
  89 supported syntax.
  90
  91 The **search**, **show**, **address** and **count** commands are used
  92 to query the email database.
  93
  94 The **reply** command is useful for preparing a template for an email
  95 reply.
  96
  97 The **tag** command is the only command available for manipulating
  98 database contents.
  99
 100 The **dump** and **restore** commands can be used to create a textual
 101 dump of email tags for backup purposes, and to restore from that dump.
 102
 103 The **config** command can be used to get or set settings in the notmuch
 104 configuration file.
 105
 106 ENVIRONMENT
 107 ===========
 108
 109 The following environment variables can be used to control the behavior
 110 of notmuch.
 111
 112 **NOTMUCH\_CONFIG**
 113     Specifies the location of the notmuch configuration file. Notmuch
 114     will use ${HOME}/.notmuch-config if this variable is not set.
 115
 116 **NOTMUCH\_TALLOC\_REPORT**
 117     Location to write a talloc memory usage report. See
 118     **talloc\_enable\_leak\_report\_full** in **talloc(3)** for more
 119     information.
 120
 121 **NOTMUCH\_DEBUG\_QUERY**
 122     If set to a non-empty value, the notmuch library will print (to
 123     stderr) Xapian queries it constructs.
 124
 125 SEE ALSO
 126 ========
 127
 128 **notmuch-config(1)**, **notmuch-count(1)**, **notmuch-dump(1)**,
 129 **notmuch-hooks(5)**, **notmuch-insert(1)**, **notmuch-new(1)**,
 130 **notmuch-reply(1)**, **notmuch-restore(1)**, **notmuch-search(1)**,
 131 **notmuch-search-terms(7)**, **notmuch-show(1)**, **notmuch-tag(1)**,
 132 **notmuch-address(1)**
 133
 134 The notmuch website: **http://notmuchmail.org**
 135
 136 CONTACT
 137 =======
 138
 139 Feel free to send questions, comments, or kudos to the notmuch mailing
 140 list <notmuch@notmuchmail.org> . Subscription is not required before
 141 posting, but is available from the notmuchmail.org website.
 142
 143 Real-time interaction with the Notmuch community is available via IRC
 144 (server: irc.freenode.net, channel: #notmuch).