Disambiguate Debian notmuch package and notmuch for emacs package.
[notmuch-wiki] / index.mdwn
1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
2 # Notmuch -- Just an email system
3
4 If you've been looking for a fast, global-search and tag-based email
5 system to use within your text editor or in a terminal...
6
7 If you're the kind of person that gets excited about being able to
8 write shell scripts for exploring and manipulating your email...
9
10 If you're a developer of an existing email program and would love a
11 good library interface for fast, global search with support for
12 arbitrary tags...
13
14 If you want the convenience of fast, reliable search of all your
15 email, but don't want to give a 3rd-party access to your email...
16
17 Then notmuch may be exactly what you've been looking for.
18
19 [[!toc levels=2]]
20
21 ## Why is it named Notmuch?
22
23 * "Not much mail" is what Notmuch thinks about your email
24   collection. Even if you receive 12000 messages per month or have on
25   the order of millions of messages that you've been saving for
26   decades. Regardless, Notmuch will be able to quickly search all of
27   it. It's just plain not much mail.
28
29 * "Not much mail" is also what you should have in your inbox at any
30   time. Notmuch gives you what you need, (tags and fast search), so
31   that you can keep your inbox tamed and focus on what really matters
32   in your life, (which is surely not email).
33
34 * Notmuch is an answer to [Sup](http://sup-heliotrope.github.io/).
35   Sup is a very good email program written by William Morgan (and
36   others) and is the direct inspiration for Notmuch. Notmuch began as
37   an effort to rewrite performance-critical pieces of Sup in C rather
38   than Ruby. From there, it grew into a separate project. One
39   significant contribution Notmuch makes compared to Sup is the
40   separation of the indexer/searcher from the user interface. (Notmuch
41   provides a library interface so that its indexing/searching/tagging
42   features can be integrated into any email program.)
43
44 * Notmuch is not much of an email program. It doesn't receive messages
45   (no POP or IMAP support). It doesn't send messages (no mail composer,
46   no network code at all). And for what it does do (email search) that
47   work is provided by an external library,
48   [Xapian](http://xapian.org).  So if Notmuch provides no user
49   interface and Xapian does all the heavy lifting, then what's left
50   here? Not much.
51
52 ## News
53
54 [[Notmuch news|news]] (mostly release notes and changes).
55
56 ## Getting Started
57
58 To get started with Notmuch, just run "notmuch" at the command line.
59 This command will walk you through initial setup, including specifying
60 the location of your mail store and how to start the initial indexing.
61
62 For a little more detailed guide, see [[Getting Started with
63 Notmuch|getting-started]].
64
65 ## Email Clients and Front Ends
66
67 Notmuch ships with a powerful set of [[command-line tools|manpages]], an
68 [[email client for Emacs|notmuch-emacs]], another
69 [client for vim](https://git.notmuchmail.org/git/notmuch/blob/HEAD:/vim/README),
70 and a [[Mutt integration script|notmuch-mutt]].
71
72 There are also many other [[email clients, frontends and tools|frontends]] based
73 on Notmuch.
74
75 ## Documentation
76
77   * [[Notmuch manual pages|manpages]]
78   * [[Email clients and frontends|frontends]]
79   * [[General how-tos|howto]]
80   * [[Frequently Asked Questions|faq]]
81   * [[Searching]]
82   * [[Excluding and deleting messages|excluding]]
83   * [[Initial tagging|Initial_Tagging]]
84   * Tips for using Notmuch with [[Emacs|emacstips]], [[Vim|vimtips]], and [[Mutt|mutttips]]
85   * [[Emacs remote usage|remoteusage]]
86   * [[Performance|performance]]
87   * [[References|references]]
88   * [[Notmuch Library Language Bindings|bindings]]
89
90 Apart from the wiki, help is available via email and on IRC (see
91 below).  Join the mailing list.  Read the archives.  Ask questions.
92
93 ## Screenshots
94
95 * [[Emacs UI screenshots|screenshots]]
96
97 ## Obtaining Notmuch
98
99 [Notmuch source releases](https://notmuchmail.org/releases/) are available as
100 source tar balls.
101
102 Notmuch is packaged for at least the following operating systems and
103 distributions:
104
105 * [Arch Linux](https://www.archlinux.org/packages/?q=notmuch)
106 * [Debian](http://packages.debian.org/search?keywords=notmuch)
107 * [Fedora](https://src.fedoraproject.org/rpms/notmuch)
108 * [FreeBSD](http://www.freshports.org/mail/notmuch)
109 * [Gentoo](http://packages.gentoo.org/package/net-mail/notmuch)
110 * [NetBSD](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/notmuch/README.html)
111 * [openSUSE](https://build.opensuse.org/search?search_text=notmuch)
112 * macOS [Homebrew](https://github.com/Homebrew/homebrew-core/blob/09baa1c3f5a30f8450d2145d4fd988e4b4d48070/Formula/notmuch.rb), [MacPorts](https://ports.macports.org/port/notmuch), or [pkgsrc](http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/mail/notmuch/README.html).
113 * [Slackware](http://slackbuilds.org/repository/13.37/office/notmuch/)
114 * [Ubuntu](http://packages.ubuntu.com/search?keywords=notmuch)
115
116 ## Contact: Email & IRC
117
118 Comments? Please feel free to email the notmuch mailing list:
119 <mailto:notmuch@notmuchmail.org> (subscription is not required, but you can
120 also subscribe to the
121 [notmuch mailing list](https://nmbug.notmuchmail.org/list/)). You
122 can also browse the
123 [online list archives](https://nmbug.notmuchmail.org/nmweb/) or
124 download an [archive](https://nmbug.notmuchmail.org/archive/notmuch-list.tar.xz)
125 of the entire mailing-list.
126
127 The archive unpacks to maildir format which is convenient for reading
128 the archives within notmuch itself.
129
130 If you prefer real-time chat, there is often someone on the
131 [#notmuch](irc://irc.libera.chat/#notmuch)@irc.libera.chat IRC channel. Don't
132 ask if you can ask a question, just ask, and please wait for an answer, we might
133 not be in your timezone.
134
135 ## Troubleshooting, Reporting Bugs and Feature Requests
136
137 Please send bug reports and feature requests to the [Notmuch mailing
138 list](https://nmbug.notmuchmail.org/list/)
139 <mailto:notmuch@notmuchmail.org>.
140
141 For hints about troubleshooting and bug reporting see [[bugs]].
142
143 Please see the [nmbug status page](https://nmbug.notmuchmail.org/status/) for
144 lists of [known bugs](https://nmbug.notmuchmail.org/status/#Bugs) and [feature
145 requests](https://nmbug.notmuchmail.org/status/#Wish-list).
146
147 ## Development and Contributing
148
149 All of the code for Notmuch is available as [free
150 software](https://www.fsf.org/licensing/essays/free-sw.html) released
151 under the GNU [GPL version
152 3](https://www.fsf.org/licensing/licenses/gpl.html). The latest
153 versions can be checked out via git with this command:
154
155         git clone https://git.notmuchmail.org/git/notmuch
156
157 You can browse the [Notmuch code history
158 online](https://git.notmuchmail.org/git/notmuch). [The Notmuch OpenHub project
159 page](https://www.openhub.net/p/notmuch) has a nice summary of the codebase and
160 activity.
161
162 Continuous integration build and test suite status: [![Build Status](https://travis-ci.org/notmuch/notmuch.svg?branch=master)](https://travis-ci.org/notmuch/notmuch)
163
164 Contributions, such as patches, to Notmuch are most welcome. Please refer to the
165 [[guide to contributing|contributing]].
166
167 ## Website
168
169 This website is a wiki, maintained using [ikiwiki](http://ikiwiki.info). Here
170 are [[instructions on how to edit the wiki|wikiwriteaccess]]. The wiki contents
171 are mostly [[dual licensed under CC-BY-SA-3.0 and GPLv3+|COPYING]].