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
  35        alternate 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
  46               optional 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}.
  54
  55        <b>--uuid=HEX</b>
  56               Enforce that the database UUID (a unique identifier  which  per‐
  57               sists until e.g. the database is compacted) is HEX; exit with an
  58               error if it is not. This is useful to detect rollover in modifi‐
  59               cation  counts  on  messages.  You can find this UUID using e.g.
  60               <b>notmuch</b> <b>count</b> <b>--lastmod</b>
  61
  62        All global options except <b>--config</b> can also be specified after the com‐
  63        mand.  For example, <b>notmuch</b> <b>subcommand</b> <b>--uuid=HEX</b> is equivalent to <b>not-</b>
  64        <b>much</b> <b>--uuid=HEX</b> <b>subcommand</b>.
  65 </pre>
  66
  67 <h2>COMMANDS</h2>
  68
  69 <h3> &nbsp; SETUP</h3>
  70 <pre>
  71        The <b>notmuch</b> <b>setup</b> command is used to configure Notmuch for  first  use,
  72        (or to reconfigure it later).
  73
  74        The  setup  command  will prompt for your full name, your primary email
  75        address, any alternate email addresses you use, and the directory  con‐
  76        taining your email archives. Your answers will be written to a configu‐
  77        ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config  .
  78        This configuration file will be created with descriptive comments, mak‐
  79        ing it easy to edit by hand later to change the configuration.  Or  you
  80        can run <b>notmuch</b> <b>setup</b> again to change the configuration.
  81
  82        The  mail  directory you specify can contain any number of sub-directo‐
  83        ries and should primarily contain only files with individual email mes‐
  84        sages  (eg.  maildir  or  mh archives are perfect). If there are other,
  85        non-email files (such as indexes maintained by  other  email  programs)
  86        then notmuch will do its best to detect those and ignore them.
  87
  88        Mail  storage that uses mbox format, (where one mbox file contains many
  89        messages), will not work with notmuch. If that&apos;s how your mail is  cur‐
  90        rently stored, it is recommended you first convert it to maildir format
  91        with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
  92
  93        Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if  the  setup
  94        command has not previously been completed.
  95 </pre>
  96
  97 <h3> &nbsp; OTHER COMMANDS</h3>
  98 <pre>
  99        Several  of the notmuch commands accept search terms with a common syn‐
 100        tax. See <b>notmuch-search-terms</b>(7) for more details on the supported syn‐
 101        tax.
 102
 103        The  <b>search</b>,  <b>show</b>,  <b>address</b>  and  <b>count</b> commands are used to query the
 104        email database.
 105
 106        The <b>reply</b> command is useful for  preparing  a  template  for  an  email
 107        reply.
 108
 109        The <b>tag</b> command is the only command available for manipulating database
 110        contents.
 111
 112        The <b>dump</b> and <b>restore</b> commands can be used to create a textual  dump  of
 113        email tags for backup purposes, and to restore from that dump.
 114
 115        The  <b>config</b>  command  can be used to get or set settings in the notmuch
 116        configuration file.
 117 </pre>
 118
 119 <h3> &nbsp; CUSTOM COMMANDS</h3>
 120 <pre>
 121        If the given command is not known to notmuch, notmuch tries to  execute
 122        the external <b>notmuch-&lt;subcommand&gt;</b> in ${PATH} instead. This allows users
 123        to have their own notmuch related tools to be run via the notmuch  com‐
 124        mand. By design, this does not allow notmuch&apos;s own commands to be over‐
 125        ridden using external commands.
 126 </pre>
 127
 128 <h3> &nbsp; OPTION SYNTAX</h3>
 129 <pre>
 130        All options accepting an argument can be used with &apos;=&apos; or &apos;:&apos; as a sep‐
 131        arator.  Except for boolean options (which would be ambiguous), a space
 132        can also be used as a separator. The following are all equivalent:
 133
 134           notmuch --config=alt-config config get user.name
 135           notmuch --config:alt-config config get user.name
 136           notmuch --config alt-config config get user.name
 137 </pre>
 138
 139 <h2>ENVIRONMENT</h2>
 140 <pre>
 141        The following environment variables can be used to control the behavior
 142        of notmuch.
 143
 144        <b>NOTMUCH</b>_<b>CONFIG</b>
 145               Specifies  the  location of the notmuch configuration file. Not‐
 146               much will use ${HOME}/.notmuch-config if this  variable  is  not
 147               set.
 148
 149        <b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
 150               Location  to  write  a  talloc  memory  usage  report.  See <b>tal-</b>
 151               <b>loc</b>_<b>enable</b>_<b>leak</b>_<b>report</b>_<b>full</b> in <b>talloc</b>(3) for more information.
 152
 153        <b>NOTMUCH</b>_<b>DEBUG</b>_<b>QUERY</b>
 154               If set to a non-empty value, the notmuch library will print  (to
 155               stderr) Xapian queries it constructs.
 156 </pre>
 157
 158 <h2>SEE ALSO</h2>
 159 <pre>
 160        <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>
 161        <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),
 162        <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/'>not‐</a>
 163        <a href='../notmuch-reply-1/'>much-reply</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/'>not‐</a>
 164        <a href='../notmuch-search-terms-7/'>much-search-terms</a>(7), <a href='../notmuch-show-1/'>notmuch-show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 165
 166        The notmuch website: <b>https://notmuchmail.org</b>
 167 </pre>
 168
 169 <h2>CONTACT</h2>
 170 <pre>
 171        Feel  free to send questions, comments, or kudos to the notmuch mailing
 172        list &lt;<u>notmuch@notmuchmail.org</u>&gt; . Subscription is  not  required  before
 173        posting, but is available from the notmuchmail.org website.
 174
 175        Real-time  interaction  with the Notmuch community is available via IRC
 176        (server: irc.freenode.net, channel: #notmuch).
 177 </pre>
 178
 179 <h2>AUTHOR</h2>
 180 <pre>
 181        Carl Worth and many others
 182 </pre>
 183
 184 <h2>COPYRIGHT</h2>
 185 <pre>
 186        2009-2020, Carl Worth and many others
 187 </pre>
 188
 189 <h2>0.30</h2>