git.cworth.org Git - obsolete/notmuch-wiki/blob - manpages/notmuch-setup-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> [<u>option</u> ...] <u>command</u> [<u>arg</u> ...]
  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  http://notmuchmail.org  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>
  45
  46                Print a synopsis of available commands and exit.
  47
  48            <b>--version</b>
  49
  50                Print the installed version of notmuch, and exit.
  51
  52            <b>--config=FILE</b>
  53
  54                Specify the configuration file to use. This overrides any  con-
  55                figuration file specified by ${NOTMUCH_CONFIG}.
  56 </pre>
  57
  58 <h2>COMMANDS</h2>
  59
  60 <h3> &nbsp; SETUP</h3>
  61 <pre>
  62        The  <b>notmuch</b>  <b>setup</b> command is used to configure Notmuch for first use,
  63        (or to reconfigure it later).
  64
  65        The setup command will prompt for your full name,  your  primary  email
  66        address,  any alternate email addresses you use, and the directory con-
  67        taining your email archives. Your answers will be written to a configu-
  68        ration  file in ${NOTMUCH_CONFIG} (if set) or ${HOME}/.notmuch-config .
  69        This configuration file will be created with descriptive comments, mak-
  70        ing  it  easy to edit by hand later to change the configuration. Or you
  71        can run <b>notmuch</b> <b>setup</b> again to change the configuration.
  72
  73        The mail directory you specify can contain any number  of  sub-directo-
  74        ries and should primarily contain only files with individual email mes-
  75        sages (eg. maildir or mh archives are perfect).  If  there  are  other,
  76        non-email  files  (such  as indexes maintained by other email programs)
  77        then notmuch will do its best to detect those and ignore them.
  78
  79        Mail storage that uses mbox format, (where one mbox file contains  many
  80        messages),  will not work with notmuch. If that&apos;s how your mail is cur-
  81        rently stored, it is recommended you first convert it to maildir format
  82        with a utility such as mb2md before running <b>notmuch</b> <b>setup</b> <b>.</b>
  83
  84        Invoking  <b>notmuch</b>  with no command argument will run <b>setup</b> if the setup
  85        command has not previously been completed.
  86 </pre>
  87
  88 <h3> &nbsp; OTHER COMMANDS</h3>
  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
  94        The <b>search</b>, <b>show</b> and <b>count</b> commands are used to query the  email  data-
  95        base.
  96
  97        The  <b>reply</b>  command  is  useful  for  preparing a template for an email
  98        reply.
  99
 100        The <b>tag</b> command is the only command available for manipulating database
 101        contents.
 102
 103        The  <b>dump</b>  and <b>restore</b> commands can be used to create a textual dump of
 104        email tags for backup purposes, and to restore from that dump.
 105
 106        The <b>config</b> command can be used to get or set settings int  the  notmuch
 107        configuration file.
 108 </pre>
 109
 110 <h2>ENVIRONMENT</h2>
 111 <pre>
 112        The following environment variables can be used to control the behavior
 113        of notmuch.
 114
 115        <b>NOTMUCH</b>_<b>CONFIG</b>
 116               Specifies the location of the notmuch configuration  file.  Not-
 117               much  will  use  ${HOME}/.notmuch-config if this variable is not
 118               set.
 119
 120        <b>NOTMUCH</b>_<b>TALLOC</b>_<b>REPORT</b>
 121               Location to  write  a  talloc  memory  usage  report.  See  <b>tal-</b>
 122               <b>loc</b>_<b>enable</b>_<b>leak</b>_<b>report</b>_<b>full</b> in <b>talloc</b>(3) for more information.
 123
 124        <b>NOTMUCH</b>_<b>DEBUG</b>_<b>QUERY</b>
 125               If  set to a non-empty value, the notmuch library will print (to
 126               stderr) Xapian queries it constructs.
 127 </pre>
 128
 129 <h2>SEE ALSO</h2>
 130 <pre>
 131        <a href='../notmuch-config-1/'>notmuch-config</a>(1), <a href='../notmuch-count-1/'>notmuch-count</a>(1), <a href='../notmuch-dump-1/'>notmuch-dump</a>(1), <a href='../notmuch-hooks-5/'>notmuch-hooks</a>(5),
 132        <a href='../notmuch-insert-1/'>notmuch-insert</a>(1),     <a href='../notmuch-new-1/'>notmuch-new</a>(1),    <a href='../notmuch-reply-1/'>notmuch-reply</a>(1),    <a href='../notmuch-restore-1/'>notmuch-</a>
 133        <a href='../notmuch-restore-1/'>restore</a>(1),   <a href='../notmuch-search-1/'>notmuch-search</a>(1),   <a href='../notmuch-search-terms-7/'>notmuch-search-terms</a>(7),    <a href='../notmuch-show-1/'>notmuch-</a>
 134        <a href='../notmuch-show-1/'>show</a>(1), <a href='../notmuch-tag-1/'>notmuch-tag</a>(1)
 135
 136        The notmuch website: <b>http://notmuchmail.org</b>
 137 </pre>
 138
 139 <h2>CONTACT</h2>
 140 <pre>
 141        Feel  free to send questions, comments, or kudos to the notmuch mailing
 142        list &lt;notmuch@notmuchmail.org&gt; . Subscription is  not  required  before
 143        posting, but is available from the notmuchmail.org website.
 144
 145        Real-time  interaction  with the Notmuch community is available via IRC
 146        (server: irc.freenode.net, channel: #notmuch).
 147 </pre>
 148
 149 <h2>Notmuch 0.16</h2>