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

   1 <h1>NOTMUCH(1)</h1>
   2
   3 <h2>NAME</h2>
   4
   5 <pre>
   6        notmuch - thread-based email index, search, and tagging
   7 </pre>
   8
   9 <h2>SYNOPSIS</h2>
  10
  11 <pre>
  12        <b>notmuch</b> <u>command</u> [<u>args</u> ...]
  13 </pre>
  14
  15 <h2>DESCRIPTION</h2>
  16
  17 <pre>
  18        Notmuch  is a command-line based program for indexing, searching, read-
  19        ing, and tagging large collections of email messages.
  20 </pre>
  21
  22 <pre>
  23        This page describes how to get started using notmuch from  the  command
  24        line,  and  gives  a brief overview of the commands available. For more
  25        information on e.g.  <b>notmuch</b> <b>show</b> consult the <b>notmuch-show</b>(1) man page,
  26        also accessible via <b>notmuch</b> <b>help</b> <b>show</b>
  27 </pre>
  28
  29 <pre>
  30        The  quickest  way  to get started with Notmuch is to simply invoke the
  31        <b>notmuch</b> command with no arguments, which will interactively  guide  you
  32        through the process of indexing your mail.
  33 </pre>
  34
  35 <h2>NOTE</h2>
  36
  37 <pre>
  38        While the command-line program <b>notmuch</b> provides powerful functionality,
  39        it does not provide the most convenient interface for that  functional-
  40        ity.  More  sophisticated interfaces are expected to be built on top of
  41        either the command-line interface, or more likely, on top of  the  not-
  42        much  library  interface.  See  http://notmuchmail.org  for  more about
  43        alternate interfaces to notmuch. The emacs-based interface  to  notmuch
  44        (available under <b>emacs/</b> in the Notmuch source distribution) is probably
  45        the most widely used at this time.
  46 </pre>
  47
  48 <h2>COMMANDS</h2>
  49
  50 <h3>SETUP</h3>
  51
  52 <pre>
  53        The <b>notmuch</b> <b>setup</b> command is used to configure Notmuch for  first  use,
  54        (or to reconfigure it later).
  55 </pre>
  56
  57 <pre>
  58        The  setup  command  will prompt for your full name, your primary email
  59        address, any alternate email addresses you use, and the directory  con-
  60        taining your email archives. Your answers will be written to a configu-
  61        ration file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config  .
  62        This configuration file will be created with descriptive comments, mak-
  63        ing it easy to edit by hand later to change the configuration.  Or  you
  64        can run <b>notmuch</b> <b>setup</b> again to change the configuration.
  65 </pre>
  66
  67 <pre>
  68        The  mail  directory you specify can contain any number of sub-directo-
  69        ries and should primarily contain only files with individual email mes-
  70        sages  (eg.  maildir  or  mh archives are perfect). If there are other,
  71        non-email files (such as indexes maintained by  other  email  programs)
  72        then notmuch will do its best to detect those and ignore them.
  73 </pre>
  74
  75 <pre>
  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  cur-
  78        rently stored, it is recommended you first convert it to maildir format
  79        with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
  80 </pre>
  81
  82 <pre>
  83        Invoking <b>notmuch</b> with no command argument will run <b>setup</b> if  the  setup
  84        command has not previously been completed.
  85 </pre>
  86
  87 <h3>OTHER COMMANDS</h3>
  88
  89 <pre>
  90        Several  of the notmuch commands accept search terms with a common syn-
  91        tax. See notmuch-search-terms(7) for more details on the supported syn-
  92        tax.
  93 </pre>
  94
  95 <pre>
  96        The  <b>search</b>,  <b>show</b> and <b>count</b> commands are used to query the email data-
  97        base.
  98 </pre>
  99
 100 <pre>
 101        The <b>reply</b> command is useful for  preparing  a  template  for  an  email
 102        reply.
 103 </pre>
 104
 105 <pre>
 106        The <b>tag</b> command is the only command available for manipulating database
 107        contents.
 108 </pre>
 109
 110 <pre>
 111        The <b>dump</b> and <b>restore</b> commands can be used to create a textual  dump  of
 112        email tags for backup purposes, and to restore from that dump.
 113 </pre>
 114
 115 <pre>
 116        The  <b>config</b>  command can be used to get or set settings int the notmuch
 117        configuration file.
 118 </pre>
 119
 120 <h2>ENVIRONMENT</h2>
 121
 122 <pre>
 123        The following environment variables can be used to control the behavior
 124        of notmuch.
 125 </pre>
 126
 127 <pre>
 128        <b>NOTMUCH</b>_<b>CONFIG</b>
 129               Specifies  the  location of the notmuch configuration file. Not-
 130               much will use ${HOME}/.notmuch-config if this  variable  is  not
 131               set.
 132 </pre>
 133
 134 <h2>SEE ALSO</h2>
 135
 136 <pre>
 137        <b>notmuch-config</b>(1), <b>notmuch-count</b>(1), <b>notmuch-dump</b>(1), <b>notmuch-hooks</b>(5),
 138        <b>notmuch-new</b>(1),    <b>notmuch-reply</b>(1),    <b>notmuch-restore</b>(1),    <b>notmuch-</b>
 139        <b>search</b>(1), <b>notmuch-search-terms</b>(7), <b>notmuch-show</b>(1), <b>notmuch-tag</b>(1)
 140 </pre>
 141
 142 <pre>
 143        The notmuch website: <b>http://notmuchmail.org</b>
 144 </pre>
 145
 146 <h2>CONTACT</h2>
 147
 148 <pre>
 149        Feel  free to send questions, comments, or kudos to the notmuch mailing
 150        list <notmuch@notmuchmail.org> . Subscription is  not  required  before
 151        posting, but is available from the notmuchmail.org website.
 152 </pre>
 153
 154 <pre>
 155        Real-time  interaction  with the Notmuch community is available via IRC
 156        (server: irc.freenode.net, channel: #notmuch).
 157 </pre>
 158
 159 <h1>Notmuch 0.13.2</h1>