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

   1 .. _notmuch(1):
   2 .. _notmuch-setup(1):
   3
   4 =======
   5 notmuch
   6 =======
   7
   8 SYNOPSIS
   9 ========
  10
  11 **notmuch** [option ...] **command** [arg ...]
  12
  13 DESCRIPTION
  14 ===========
  15
  16 Notmuch is a command-line based program for indexing, searching,
  17 reading, and tagging large collections of email messages.
  18
  19 This page describes how to get started using notmuch from the command
  20 line, and gives a brief overview of the commands available. For more
  21 information on e.g. **notmuch show** consult the
  22 :any:`notmuch-show(1)` man page, also accessible via **notmuch help
  23 show**
  24
  25 The quickest way to get started with Notmuch is to simply invoke the
  26 ``notmuch`` command with no arguments, which will interactively guide
  27 you through the process of indexing your mail.
  28
  29 NOTE
  30 ====
  31
  32 While the command-line program ``notmuch`` provides powerful
  33 functionality, it does not provide the most convenient interface for
  34 that functionality. More sophisticated interfaces are expected to be
  35 built on top of either the command-line interface, or more likely, on
  36 top of the notmuch library interface. See https://notmuchmail.org for
  37 more about alternate interfaces to notmuch. The emacs-based interface to
  38 notmuch (available under **emacs/** in the Notmuch source distribution)
  39 is probably the most widely used at this time.
  40
  41 OPTIONS
  42 =======
  43
  44 Supported global options for ``notmuch`` include
  45
  46 .. program:: notmuch
  47
  48 .. option:: --help [command-name]
  49
  50    Print a synopsis of available commands and exit. With an optional
  51    command name, show the man page for that subcommand.
  52
  53 .. option:: --version
  54
  55    Print the installed version of notmuch, and exit.
  56
  57 .. option:: --config=FILE
  58
  59    Specify the configuration file to use. This overrides any
  60    configuration file specified by :envvar:`NOTMUCH_CONFIG`. The empty
  61    string is a permitted and sometimes useful value of *FILE*, which
  62    tells ``notmuch`` to use only configuration metadata from the database.
  63
  64 .. option:: --uuid=HEX
  65
  66    Enforce that the database UUID (a unique identifier which persists
  67    until e.g. the database is compacted) is HEX; exit with an error
  68    if it is not. This is useful to detect rollover in modification
  69    counts on messages. You can find this UUID using e.g. ``notmuch
  70    count --lastmod``
  71
  72 All global options except ``--config`` can also be specified after the
  73 command. For example, ``notmuch subcommand --uuid=HEX`` is equivalent
  74 to ``notmuch --uuid=HEX subcommand``.
  75
  76 COMMANDS
  77 ========
  78
  79 SETUP
  80 -----
  81
  82 The **notmuch setup** command is used to configure Notmuch for first
  83 use, (or to reconfigure it later).
  84
  85 The setup command will prompt for your full name, your primary email
  86 address, any alternate email addresses you use, and the directory
  87 containing your email archives. Your answers will be written to a
  88 configuration file in :envvar:`NOTMUCH_CONFIG` (if set) or
  89 ${HOME}/.notmuch-config . This configuration file will be created with
  90 descriptive comments, making it easy to edit by hand later to change the
  91 configuration. Or you can run **notmuch setup** again to change the
  92 configuration.
  93
  94 The mail directory you specify can contain any number of sub-directories
  95 and should primarily contain only files with individual email messages
  96 (eg. maildir or mh archives are perfect). If there are other, non-email
  97 files (such as indexes maintained by other email programs) then notmuch
  98 will do its best to detect those and ignore them.
  99
 100 Mail storage that uses mbox format, (where one mbox file contains many
 101 messages), will not work with notmuch. If that's how your mail is
 102 currently stored, it is recommended you first convert it to maildir
 103 format with a utility such as :manpage:`mb2md(1)` before running
 104 **notmuch setup**.
 105
 106 Invoking ``notmuch`` with no command argument will run **setup** if the
 107 setup command has not previously been completed.
 108
 109 OTHER COMMANDS
 110 --------------
 111
 112 Several of the notmuch commands accept search terms with a common
 113 syntax. See :any:`notmuch-search-terms(7)` for more details on the
 114 supported syntax.
 115
 116 The :any:`notmuch-search(1)`, :any:`notmuch-show(1)`,
 117 :any:`notmuch-address(1)` and :any:`notmuch-count(1)` commands are
 118 used to query the email database.
 119
 120 The :any:`notmuch-reply(1)` command is useful for preparing a template
 121 for an email reply.
 122
 123 The :any:`notmuch-tag(1)` command is the only command available for
 124 manipulating database contents.
 125
 126 The :any:`notmuch-dump(1)` and :any:`notmuch-restore(1)` commands can
 127 be used to create a textual dump of email tags for backup purposes,
 128 and to restore from that dump.
 129
 130 The :any:`notmuch-config(1)` command can be used to get or set
 131 settings in the notmuch configuration file.
 132
 133 CUSTOM COMMANDS
 134 ---------------
 135
 136 If the given command is not known to notmuch, notmuch tries to execute
 137 the external **notmuch-<subcommand>** in :envvar:`PATH` instead. This
 138 allows users to have their own notmuch related tools to be run via the
 139 notmuch command. By design, this does not allow notmuch's own commands
 140 to be overridden using external commands.
 141
 142 OPTION SYNTAX
 143 -------------
 144
 145 All options accepting an argument can be used with '=' or ':' as a
 146 separator. Except for boolean options (which would be ambiguous), a
 147 space can also be used as a separator. The following are all
 148 equivalent:
 149
 150 ::
 151
 152    notmuch --config=alt-config config get user.name
 153    notmuch --config:alt-config config get user.name
 154    notmuch --config alt-config config get user.name
 155
 156 ENVIRONMENT
 157 ===========
 158
 159 The following environment variables can be used to control the behavior
 160 of notmuch.
 161
 162 .. envvar:: NOTMUCH_CONFIG
 163
 164    Specifies the location of the notmuch configuration file. See
 165    :any:`notmuch-config(1)` for details.
 166
 167 .. envvar:: NOTMUCH_DATABASE
 168
 169    Specifies the location of the notmuch database. See
 170    :any:`notmuch-config(1)` for details.
 171
 172 .. envvar:: NOTMUCH_PROFILE
 173
 174    Selects among notmuch configurations. See :any:`notmuch-config(1)`
 175    for details.
 176
 177 .. envvar:: NOTMUCH_TALLOC_REPORT
 178
 179    Location to write a talloc memory usage report. See
 180    **talloc\_enable\_leak\_report\_full** in :manpage:`talloc(3)` for more
 181    information.
 182
 183 .. envvar:: NOTMUCH_DEBUG_QUERY
 184
 185    If set to a non-empty value, the notmuch library will print (to
 186    stderr) Xapian queries it constructs.
 187
 188 EXTERNAL COMMANDS
 189 =================
 190
 191 When given a subcommand `foo` not recognized as built-in, notmuch will
 192 try to run the command (e.g. script) `notmuch-foo` in the user's
 193 path. The :envvar:`NOTMUCH_CONFIG` will be set according to
 194 :option:`--config`, if the latter is present.
 195
 196 SEE ALSO
 197 ========
 198
 199 :any:`notmuch-address(1)`,
 200 :any:`notmuch-compact(1)`,
 201 :any:`notmuch-config(1)`,
 202 :any:`notmuch-count(1)`,
 203 :any:`notmuch-dump(1)`,
 204 :any:`notmuch-hooks(5)`,
 205 :any:`notmuch-insert(1)`,
 206 :any:`notmuch-new(1)`,
 207 :any:`notmuch-properties(7)`,
 208 :any:`notmuch-reindex(1)`,
 209 :any:`notmuch-reply(1)`,
 210 :any:`notmuch-restore(1)`,
 211 :any:`notmuch-search(1)`,
 212 :any:`notmuch-search-terms(7)`,
 213 :any:`notmuch-show(1)`,
 214 :any:`notmuch-tag(1)`
 215
 216 The notmuch website: **https://notmuchmail.org**
 217
 218 CONTACT
 219 =======
 220
 221 Feel free to send questions, comments, or kudos to the notmuch mailing
 222 list <notmuch@notmuchmail.org> . Subscription is not required before
 223 posting, but is available from the notmuchmail.org website.
 224
 225 Real-time interaction with the Notmuch community is available via IRC
 226 (server: irc.libera.chat, channel: #notmuch).