README

mairix is a program for indexing and searching email messages stored in
Maildir, MH or mbox folders.

* Indexing is fast.  It runs incrementally on new messages - any particular
  message only gets scanned once in the lifetime of the index file.

* The search mode populates a "virtual" folder with symlinks(*) which
  point to the real messages.  This folder can be opened as usual in your mail
  program.

* The search mode is very fast.

* Indexing and searching works on the basis of words.  The index file tabulates
  which words occur in which parts (particular headers + body) of which
  messages.

The program is a very useful complement to mail programs like mutt
(http://www.mutt.org/, which supports Maildir, MH and mbox folders) and
Sylpheed (which supports MH folders).

[(*) where the input or output folder is an mbox, a copy of the message is made
instead of symlinking.]

See also the mairix.txt file.

*********************************************************************
 Copyright (C) Richard P. Curnow  2002-2004
 
 This program is free software; you can redistribute it and/or modify
 it under the terms of version 2 of the GNU General Public License as
 published by the Free Software Foundation.
 
 This program is distributed in the hope that it will be useful, but
 WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 General Public License for more details.
 
 You should have received a copy of the GNU General Public License along
 with this program; if not, write to the Free Software Foundation, Inc.,
 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
*********************************************************************

Suggestions, bug reports, experiences, praise, complaints etc to the author
please, at <rc@rc0.org.uk>

Since July 2006, there is a mairix-users mailing list.  To subscribe or to view
the archives, visit

   https://lists.sourceforge.net/lists/listinfo/mairix-users 

The main website for mairix is

   http://www.rc0.org.uk/mairix

The SourceForge project page is

   http://www.sf.net/projects/mairix

ACKNOWLEDGEMENTS
================

See the ACKNOWLEDGEMENTS file