Include a static copy of the CVS log in the dist tarball
[mmh] / README
1 Meillo's Mail Handler (mmh)
2 ===========================
3
4 Mmh is a modified version of the electronic mail handling system nmh.
5 Nmh (new MH) itself was originally based on the package MH-6.8.3, and
6 was intended to be a (mostly) compatible drop-in replacement for MH.
7 In contrast, mmh is not intended to be a drop-in replacement for nmh,
8 rather mmh breaks compatibility to nmh in order to modernize and
9 simplify it.
10
11 Mmh is small and simple; nmh is established and matured; MH is ancient.
12
13 Unfortunately, the usage of the terms `mmh' and `nmh' is not fully
14 consistent within the distribution.
15
16
17 Installing
18 ----------
19 See the INSTALL file.
20
21
22 Copying
23 -------
24 Mmh uses a BSD-style license, which can be found in the COPYRIGHT
25 file.
26
27
28 Users
29 -----
30 Start by reading the man page mmh-intro(7). It explains the first
31 steps. For convenience in the shell, have a look at the files
32 docs/COMPLETION-*. They give cookbook examples of how to set up mmh-
33 specific tab completion in your shell.
34
35
36 Developers
37 ----------
38 Information of interest to mmh developers can be found in the
39 README.developers file in the docs subdirectory of this distribution.
40 Markus Schnalke's master's thesis explains the existence, shape, and
41 focus of mmh. You should read it before working on mmh. If you're
42 hacking on the code, you should subscribe to mmh's mailing list. To
43 do so, send a message to <mmh-request@marmaro.de> with the subject
44 ``subscribe''.
45
46
47 Bug reports
48 -----------
49 Please send bug reports and suggestions to the mailing list:
50 <mmh@marmaro.de>.
51
52
53 Acknowledgments
54 ---------------
55 The MH system was originally developed by the RAND Corporation,
56 starting in 1979. It was written mainly by Bruce S. Borden after
57 ideas in a memo by R. Stockton Gaines and Norman Z. Shapiro. In
58 1982, the University of California, Irvine took up maintenance of
59 the software, under the direction of Marshall T. Rose and John L.
60 Romine.
61
62 Nmh was started by Richard Coleman (coleman@math.gatech.edu) after
63 development on MH mostly stopped. He did the original autoconfiscation
64 and most of the other work up until version 1.0. Nmh is currently being
65 developed and maintained by a loosely organized group of volunteers.
66
67
68 More information
69 ----------------
70 There is more information in the docs subdirectory. Some of the
71 documents are historic, however.
72
73 The mmh website is located at <http://marmaro.de/prog/mmh/>.
74 Feel free to contact Markus Schnalke <meillo@marmaro.de>.
75
76 (The nmh website is located at <http://nmh.nongnu.org/>.)