mirror of
https://git.notmuchmail.org/git/notmuch
synced 2024-12-22 17:34:54 +01:00
notmuch clon
5a9be8a7ad
The output was far too busy otherwise. It's more useful to just show the argument list in the case of "notmuch help <command>" for a specific command. (Credit due to running "git help" and seeing a much more readable list than what was coming out of "notmuch help".) |
||
|---|---|---|
| compat | ||
| config | ||
| contrib | ||
| emacs | ||
| lib | ||
| packaging/fedora | ||
| test | ||
| vim | ||
| .gitignore | ||
| AUTHORS | ||
| configure | ||
| COPYING | ||
| COPYING-GPL-3 | ||
| debugger.c | ||
| gmime-filter-reply.c | ||
| gmime-filter-reply.h | ||
| INSTALL | ||
| json.c | ||
| Makefile | ||
| Makefile.local | ||
| notmuch-client.h | ||
| notmuch-config.c | ||
| notmuch-count.c | ||
| notmuch-dump.c | ||
| notmuch-new.c | ||
| notmuch-reply.c | ||
| notmuch-restore.c | ||
| notmuch-search-tags.c | ||
| notmuch-search.c | ||
| notmuch-setup.c | ||
| notmuch-show.c | ||
| notmuch-tag.c | ||
| notmuch-time.c | ||
| notmuch.1 | ||
| notmuch.c | ||
| notmuch.desktop | ||
| query-string.c | ||
| README | ||
| show-message.c | ||
| TODO | ||
Notmuch - thread-based email index, search and tagging.
Notmuch is a system for indexing, searching, reading, and tagging
large collections of email messages in maildir or mh format. It uses
the Xapian library to provide fast, full-text search with a convenient
search syntax.
Notmuch is free software, released under the GNU General Public
License version 3 (or later).
Building notmuch
----------------
See the INSTALL file for notes on compiling and installing notmuch.
Contacting users and developers
-------------------------------
The website for Notmuch is:
http://notmuchmail.org
The mailing list address for the notmuch community is:
notmuch@notmuchmail.org
We welcome any sort of questions, comments, kudos, or code there.
Subscription is not required, (but if you do subscribe you'll avoid
any delay due to moderation). See the website for subscription
information.
There is also an IRC channel dedicated to talk about using and
developing notmuch:
IRC server: irc.freenode.net
Channel: #notmuch
Interface options
-----------------
Notmuch includes a "notmuch" command-line interface to the system.
This is not a very convenient interface and it is not expected that
users will find it satisfying. Instead, there are two option for
obtaining a more sophisticated interface:
1. Build on top of the "notmuch" command-line interface.
This might be a reasonable option for a very text-oriented
client environment. For example, an emacs-based interface for
notmuch is already under development and is available in the
notmuch.el file in this distribution.
If someone were to write a curses-based interface, or similar,
it might also be reasonable to build on the "notmuch"
command-line interface.
2. Build on top of the notmuch library interface.
This is a better choice for developing an interface that has
full control of the presentation of email threads and
messages. It is expected that anyone integrating Notmuch into
an existing, graphical email program use the notmuch library
interface.
The public interface to the notmuch library is contained in
the notmuch.h header file. The "notmuch" command-line program
in notmuch.c can be used as good example code, since it is a
simple program that is written on top of the library
interface.
As can be seen, alternate interfaces to the Notmuch mail system are
still in development. We would appreciate any contributions to these
efforts.