git.cworth.org Git - notmuch-wiki/blob - index.mdwn

   1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
   2 # Why Notmuch?
   3
   4 * "Not much mail" is what Notmuch thinks about your email
   5   collection. Even if you receive 12000 messages per month or have on
   6   the order of millions of messages that you've been saving for
   7   decades. Regardless, Notmuch will be able to quickly search all of
   8   it. It's just plain not much mail.
   9
  10 * "Not much mail" is also what you should have in your inbox at any
  11   time. Notmuch gives you what you need, (tags and fast search), so
  12   that you can keep your inbox tamed and focus on what really matters
  13   in your life, (which is surely not email).
  14
  15 * Notmuch is an answer to <a href="http://sup.rubyforge.org/">Sup</a>.
  16   Sup is a very good email program written by William Morgan (and
  17   others) and is the direct inspiration for Notmuch. Notmuch began as
  18   an effort to rewrite performance-critical pieces of Sup in C rather
  19   than ruby. From there, it grew into a separate project. One
  20   significant contribution Notmuch makes compared to Sup is the
  21   separation of the indexer/searcher from the user interface. (Notmuch
  22   provides a library interface so that its indexing/searching/tagging
  23   features can be integrated into any email program.)
  24
  25 * Notmuch is not much of an email program. It doesn't receive messages
  26   (no POP or IMAP suport). It doesn't send messages (no mail composer,
  27   no network code at all). And for what it does do (email search) that
  28   work is provided by an external library, <a
  29   href="http://xapian.org/">Xapian</a>. So if Notmuch provides no user
  30   interface and Xapian does all the heavy lifting, then what's left
  31   here? Not much.  </ul>
  32
  33 Notmuch is still in the early stages of development, but there are
  34 already three user interfaces available for it (one for emacs, one for
  35 vim, and another using curses for running within a terminal). If
  36 you've been looking for a fast, global-search and tag-based email
  37 reader to use within your text editor or in a terminal, then Notmuch
  38 may be exactly what you've been looking for.
  39
  40 Otherwise, if you're a developer of an existing email program and
  41 would love a good library interface for fast, global search with
  42 support for arbitrary tags, then Notmuch also may be exactly what
  43 you've been looking for.
  44
  45 ## Documentation
  46
  47 So far, there is not much documentation.  Eventually, the wiki will
  48 contain a reference for users.  This is what we have so far:
  49
  50 * [[initialtagging|Initial Tagging]]
  51 * [[emacstips|Emacs Tips]]
  52
  53 Apart from the wiki, help is available via email.  Join the mailing
  54 list.  Read the archives.  Ask questions.
  55
  56 ## Source code
  57
  58 Either way, please feel free to jump in. All of the code for Notmuch
  59 is available as <a
  60 href="http://www.fsf.org/licensing/essays/free-sw.html">free
  61 software</a> released under the GNU
  62 <a href="http://www.fsf.org/licensing/licenses/gpl.html">GPL version
  63 3</a>. The latest versions
  64 can be checked out via git with this command:
  65
  66         git clone git://notmuchmail.org/git/notmuch
  67
  68 You can browse the <a
  69 href="http://git.notmuchmail.org/git/notmuch">Notmuch code history</a>
  70 online. And finally, you can <a
  71 href="http://notmuchmail.org/mailman/listinfo/notmuch-commits">subscribe
  72 to the notmuch-commits list</a> to watch every commit made to notmuch
  73 and the notmuchmail.org web site.
  74
  75 Patches are most welcome and should be sent to notmuch&#64;notmuchmail.org.
  76 Please try to follow the [patch submission guidelines of the Git
  77 project](http://repo.or.cz/w/git.git?a=blob;f=Documentation/SubmittingPatches;hb=HEAD)
  78 when submitting patches to notmuch. We are currently test-driving a [Patchwork
  79 instance](http://patchwork.notmuchmail.org/project/notmuch) to help us keep track
  80 of [the patches](http://patchwork.notmuchmail.org/project/notmuch/list).
  81
  82 ## Contact: Email & IRC
  83
  84 Comments? Please feel free to email the notmuch mailing list:
  85 notmuch&#64;notmuchmail.org (subscription is not required, but you can
  86 subscribe to the [notmuch list](http://notmuchmail.org/mailman/listinfo/notmuch) if you would like to). You can also browse the
  87 <a href="http://notmuchmail.org/pipermail/notmuch/">online archives</a>
  88 of the mailing list, read them as a <a href="http://n3.nabble.com/notmuch-f198994.html">web forum (nabble)</a>, or download a <a href="http://notmuchmail.org/archives/notmuch.mbox">mbox file</a> of the entire mailing-list.
  89
  90 The mb2md utility can be used to convert the archives to maildir format which is convenient for reading the archives within notmuch itself.
  91
  92 If you prefer real-time chat, there is often someone on the [#notmuch](irc://chat.freenode.net/#notmuch)@irc.freenode.net IRC channel.
  93
  94 ## Emacs Tips and Tricks
  95
  96 The best supported interface to notmuch is based on emacs and can be tweaked extensively. We have started to collect some tips and tricks [here](/emacstips).
  97
  98 ### Website
  99
 100 This wiki is maintained using [ikiwiki](http://ikiwiki.info). You can pull and
 101 push changes using the following URL (no authentication necessary):
 102
 103     git://notmuchmail.org/git/notmuch-wiki
 104
 105 As the above is still broken, you will currently need to use [this](http://git.cworth.org/git/notmuch-wiki?a=commit;h=023952dcb7cbf5d4bd9c8ba2c79bac11d54af1d4), in order to change this site.