git.cworth.org Git - notmuch-wiki/blob - manpages/notmuch-1.mdwn

   1 <h1>NOTMUCH(1)</h1>
   2
   3 <h2>NAME</h2>
   4 <pre>
   5        notmuch - thread-based email index, search, and tagging
   6 </pre>
   7
   8 <h2>SYNOPSIS</h2>
   9 <pre>
  10        <b>notmuch</b> [option ...] <b>command</b> [arg ...]
  11 </pre>
  12
  13 <h2>DESCRIPTION</h2>
  14 <pre>
  15        Notmuch  is a command-line based program for indexing, searching, read‐
  16        ing, and tagging large collections of email messages.
  17
  18        This page describes how to get started using notmuch from  the  command
  19        line,  and  gives  a brief overview of the commands available. For more
  20        information on e.g. <b>notmuch</b> <b>show</b> consult the <a href='../notmuch-show-1/'>notmuch-show</a>(1) man  page,
  21        also accessible via <b>notmuch</b> <b>help</b> <b>show</b>
  22
  23        The  quickest  way  to get started with Notmuch is to simply invoke the
  24        <b>notmuch</b> command with no arguments, which will interactively  guide  you
  25        through the process of indexing your mail.
  26 </pre>
  27
  28 <h2>NOTE</h2>
  29 <pre>
  30        While the command-line program <b>notmuch</b> provides powerful functionality,
  31        it does not provide the most convenient interface for that  functional‐
  32        ity.  More  sophisticated interfaces are expected to be built on top of
  33        either the command-line interface, or more likely, on top of  the  not‐
  34        much  library interface. See <u>https://notmuchmail.org</u> for more about al‐
  35        ternate interfaces to notmuch. The  emacs-based  interface  to  notmuch
  36        (available under <b>emacs/</b> in the Notmuch source distribution) is probably
  37        the most widely used at this time.
  38 </pre>
  39
  40 <h2>OPTIONS</h2>
  41 <pre>
  42        Supported global options for <b>notmuch</b> include
  43
  44        <b>--help</b> <b>[command-name]</b>
  45               Print a synopsis of available commands and  exit.  With  an  op‐
  46               tional command name, show the man page for that subcommand.
  47
  48        <b>--version</b>
  49               Print the installed version of notmuch, and exit.
  50
  51        <b>--config=FILE</b>
  52               Specify  the  configuration file to use. This overrides any con‐
  53               figuration file specified by ${NOTMUCH_CONFIG}. The empty string
  54               is  a  permitted and sometimes useful value of <u>FILE</u>, which tells
  55               <b>notmuch</b> to use only configuration metadata from the database.
  56
  57        <b>--uuid=HEX</b>
  58               Enforce that the database UUID (a unique identifier  which  per‐
  59               sists until e.g. the database is compacted) is HEX; exit with an
  60               error if it is not. This is useful to detect rollover in modifi‐
  61               cation  counts  on  messages.  You can find this UUID using e.g.
  62               <b>notmuch</b> <b>count</b> <b>--lastmod</b>
  63
  64        All global options except <b>--config</b> can also be specified after the com‐
  65        mand.  For example, <b>notmuch</b> <b>subcommand</b> <b>--uuid=HEX</b> is equivalent to <b>not-</b>
  66        <b>much</b> <b>--uuid=HEX</b> <b>subcommand</b>.
  67 </pre>
  68
  69 <h2>COMMANDS</h2>
  70
  71 <h3> &nbsp; SETUP</h3>
  72 <pre>
  73        The <b>notmuch</b> <b>setup</b> command is used to configure Notmuch for  first  use,
  74        (or to reconfigure it later).
  75
  76        The  setup  command  will prompt for your full name, your primary email
  77        address, any alternate email addresses you use, and the directory  con‐
  78        taining your email archives. Your answers will be written to a configu‐
  79        ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config  .
  80        This configuration file will be created with descriptive comments, mak‐
  81        ing it easy to edit by hand later to change the configuration.  Or  you
  82        can run <b>notmuch</b> <b>setup</b> again to change the configuration.
  83
  84        The  mail  directory you specify can contain any number of sub-directo‐
  85        ries and should primarily contain only files with individual email mes‐
  86        sages  (eg.  maildir  or  mh archives are perfect). If there are other,
  87        non-email files (such as indexes maintained by  other  email  programs)
  88        then notmuch will do its best to detect those and ignore them.
  89
  90        Mail  storage that uses mbox format, (where one mbox file contains many
  91        messages), will not work with notmuch. If that&apos;s how your mail is  cur‐
  92        rently stored, it is recommended you first convert it to maildir format
  93        with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
  94
  95        Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if  the  setup
  96        command has not previously been completed.
  97 </pre>
  98
  99 <h3> &nbsp; OTHER COMMANDS</h3>
 100 <pre>
 101        Several  of the notmuch commands accept search terms with a common syn‐
 102        tax. See <b>notmuch-search-terms</b>(7) for more details on the supported syn‐
 103        tax.
 104
 105        The  <b>search</b>,  <b>show</b>,  <b>address</b>  and  <b>count</b> commands are used to query the
 106        email database.
 107
 108        The <b>reply</b> command is useful for preparing a template for an  email  re‐
 109        ply.
 110
 111        The <b>tag</b> command is the only command available for manipulating database
 112        contents.
 113
 114        The <b>dump</b> and <b>restore</b> commands can be used to create a textual  dump  of
 115        email tags for backup purposes, and to restore from that dump.
 116
 117        The  <b>config</b>  command  can be used to get or set settings in the notmuch
 118        configuration file.
 119 </pre>
 120
 121 <h3> &nbsp; CUSTOM COMMANDS</h3>
 122 <pre>
 123        If the given command is not known to notmuch, notmuch tries to  execute
 124        the external <b>notmuch-&lt;subcommand&gt;</b> in ${PATH} instead. This allows users
 125        to have their own notmuch related tools to be run via the notmuch  com‐
 126        mand. By design, this does not allow notmuch&apos;s own commands to be over‐
 127        ridden using external commands.
 128 </pre>
 129
 130 <h3> &nbsp; OPTION SYNTAX</h3>
 131 <pre>
 132        All options accepting an argument can be used with &apos;=&apos; or &apos;:&apos; as a sep‐
 133        arator.  Except for boolean options (which would be ambiguous), a space
 134        can also be used as a separator. The following are all equivalent:
 135
 136           notmuch --config=alt-config config get user.name
 137           notmuch --config:alt-config config get user.name
 138           notmuch --config alt-config config get user.name
 139 </pre>
 140
 141 <h2>ENVIRONMENT</h2>
 142 <pre>
 143        The following environment variables can be used to control the behavior
 144        of notmuch.
 145
 146        <b>NOTMUCH</b>_<b>CONFIG</b>
 147               Specifies  the  location of the notmuch configuration file. Not‐
 148               much will use ${HOME}/.notmuch-config if this  variable  is  not
 149               set.
 150
 151        <b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
 152               Location  to  write a talloc memory usage report. See <b>talloc</b>_<b>en-</b>
 153               <b>able</b>_<b>leak</b>_<b>report</b>_<b>full</b> in <b>talloc</b>(3) for more information.
 154
 155        <b>NOTMUCH</b>_<b>DEBUG</b>_<b>QUERY</b>
 156               If set to a non-empty value, the notmuch library will print  (to
 157               stderr) Xapian queries it constructs.
 158 </pre>
 159
 160 <h2>SEE ALSO</h2>
 161 <pre>
 162        <a href='../notmuch-address-1/'>notmuch-address</a>(1),    <a href='../notmuch-compact-1/'>notmuch-compact</a>(1),    <a href='../notmuch-config-1/'>notmuch-config</a>(1),   <a href='../notmuch-count-1/'>not‐</a>
 163        <a href='../notmuch-count-1/'>much-count</a>(1),  <a href='../notmuch-dump-1/'>notmuch-dump</a>(1),  <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),  <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),
 164        <a href='../notmuch-new-1/'>notmuch-new</a>(1),  <a href='../notmuch-properties-7/'>notmuch-properties</a>(7), <a href='../notmuch-reindex-1/'>notmuch-reindex</a>(1), <a href='../notmuch-reply-1/'>notmuch-re‐</a>
 165        <a href='../notmuch-reply-1/'>ply</a>(1), <a href='../notmuch-restore-1/'>notmuch-restore</a>(1), <a href='../notmuch-search-1/'>notmuch-search</a>(1), <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),
 166        <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 167
 168        The notmuch website: <b>https://notmuchmail.org</b>
 169 </pre>
 170
 171 <h2>CONTACT</h2>
 172 <pre>
 173        Feel  free to send questions, comments, or kudos to the notmuch mailing
 174        list &lt;<u>notmuch@notmuchmail.org</u>&gt; . Subscription is  not  required  before
 175        posting, but is available from the notmuchmail.org website.
 176
 177        Real-time  interaction  with the Notmuch community is available via IRC
 178        (server: irc.libera.net, channel: #notmuch).
 179 </pre>
 180
 181 <h2>AUTHOR</h2>
 182 <pre>
 183        Carl Worth and many others
 184 </pre>
 185
 186 <h2>COPYRIGHT</h2>
 187 <pre>
 188        2009-2021, Carl Worth and many others
 189 </pre>
 190
 191 <h2>0.32</h2>