Use sysexits.h for better exit-codes
[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 inteded 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 young and small; nmh is established and matured; MH is ancient.
12
13 This distribution uses the term ``nmh'' to describe something common
14 to nmh and mmh, in order to give credit. Where mmh differs much from
15 nmh, the term ``mmh'' is used to avoid confusing the user.
16 Unfortunately, the terms are not used fully consistent.
17
18
19 Installing
20 ----------
21 Please read the INSTALL file.
22
23
24 Copying
25 -------
26 Mmh uses a BSD-style license, which should be in the top-level of the
27 distribution in a file named COPYRIGHT.
28
29
30 Users
31 -----
32 Start with reading the man page mmh-intro(7). It explains the first
33 steps. For convenience in the shell, have a look at the files
34 docs/COMPLETION-*. They give cookbook examples of how to set up mmh-
35 specific tab completion in your shell.
36
37
38 Developers
39 ----------
40 Information of interest to mmh developers can be found in the
41 README.developers file in the docs subdirectory of this distribution.
42 Markus Schnalke's master's thesis explains the existence, shape, and
43 focus of mmh. You should read it before working on mmh. If you're
44 hacking on the code, you should subscribe to the nmh-workers mailing
45 list. To do so, please visit the nmh-workers info page at
46 <http://lists.nongnu.org/mailman/listinfo/nmh-workers>. Up to now,
47 mmh has no separate mailing list.
48
49
50 Bug reports
51 -----------
52 Please send bug reports and suggestions to either Markus Schnalke
53 <meillo@marmaro.de> or to the <nmh-workers@nongnu.org> mailing list.
54
55
56 Acknowledgments
57 ---------------
58 The MH system was originally developed in 1979 by the RAND
59 Corporation. It was written primarily by Bruce S. Borden after ideas
60 in a memo by R. Stockton Gaines and Norman Z. Shapiro. In 1982,
61 the University of California, Irvine took up maintenance of the
62 software, under the direction of Marshall T. Rose and John L. Romine.
63
64 nmh was started by Richard Coleman (coleman@math.gatech.edu) after
65 development on MH mostly stopped. He did the original autoconfiscation
66 and most of the other work up until version 1.0. nmh is currently being
67 developed and maintained by a loosely organized group of volunteers.
68
69
70 For more information
71 --------------------
72 There is more information in the docs subdirectory. Please note that
73 several documents are historic.
74
75 The mmh website is located at <http://marmaro.de/prog/mmh/>.
76 Feel free to contact Markus Schnalke <meillo@marmaro.de>.
77
78 (The nmh website is located at <http://nmh.nongnu.org/>.)