docs/master
view ch01.roff @ 77:0947c24dd4c6
style: Added .Cf for references within the document.
I need to find out how to insert the correct section numbers.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Tue, 05 Jun 2012 22:23:51 +0200 |
| parents | d9c18bd9ed92 |
| children | ff4537327162 |
line source
1 .RN 1
3 .H0 "Introduction
4 .P
5 MH is a set of mail handling tools with a common concept, similar to
6 the Unix tool chest, which is a set of file handling tools with a common
7 concept. \fInmh\fP is the currently most popular implementation of an
8 MH-like mail handling system.
9 This thesis describes an experimental version of nmh, named \fImmh\fP.
10 .P
11 This chapter introduces MH, its history, concepts and how it is used.
12 It describes nmh's code base and community to give the reader
13 a better understanding of the state from which mmh started off.
14 Further more, this chapter outlines the mmh project itself,
15 describing the motivation for it and its goals.
18 .H1 "MH \(en the Mail Handler
19 .P
20 MH is a conceptual email system design and its concrete implementation.
21 Notably, MH had started as a design proposal at RAND Corporation,
22 where the first implementation followed later.
23 In spirit, MH is similar to Unix, which
24 influenced the world more in being a set of system design concepts
25 than in being a specific software product.
26 The ideas behind Unix are summarized in the \fIUnix philosophy\fP.
27 MH follows this philosophy.
29 .U2 "History
30 .P
31 In 1977 at RAND Corporation, Norman Shapiro and Stockton Gaines
32 had proposed the design
33 of a new mail handling system, called ``Mail Handler'' (MH),
34 to superseed RAND's old monolithic ``Mail System'' (MS).
35 Two years later, in 1979, Bruce Borden took the proposal and implemented a
36 prototype of MH.
37 Before the prototype had been available, the concept was
38 believed to be practically unusable.
39 But the prototype had proven successful and replaced MS thereafter.
40 In replacing MS, MH grew to an all-in-one mail system.
41 .P
42 In the early Eighties,
43 the University of California at Irvine (UCI) had started to use MH.
44 Marshall T. Rose and John L. Romine became the driving force then.
45 They took over the development and pushed MH forward.
46 RAND had put the code into the public domain by then.
47 MH was developed at UCI at the time when the Internet appeared,
48 when UCB implemented the TCP/IP stack, and when Allman wrote Sendmail.
49 MH was extended as emailing became more featured.
50 The development of MH was closely related to the development of email
51 RFCs. In the advent of MIME, MH was the first implementation of this new
52 email standard.
53 .P
54 In the Nineties, the Internet had become popular and in December 1996,
55 Richard Coleman initiated the ``New Mail Handler'' (nmh) project.
56 Nmh is a fork of MH 6.8.3 and bases strongly on the
57 \fILBL changes\fP by Van Jacobson, Mike Karels and Craig Leres.
58 Colman intended to modernize MH and improve its portability and
59 MIME handling capabilities.
60 This should be done openly within the Internet community.
61 The development of MH at UCI stopped after the 6.8.4 release in
62 February 1996, soon after the development of nmh had started.
63 Today, nmh has almost completely replaced the original MH.
64 Some systems might still provide old MH, but mainly for historical reasons.
65 .P
66 In the last years, the work on nmh was mostly maintenance work.
67 However, the development revived in December 2011
68 and stayed busy since then.
70 .U2 "Concepts
71 .P
72 MH consists of a set of tools, each covering a specific task of
73 email handling, like composing a message, replying to a message,
74 refiling a message to a different folder, listing the messages in a folder.
75 All of the programs operate on a common mail storage.
76 .P
77 The mail storage consists of \fImail folders\fP (directories) and
78 \fPmessages\fP (regular files).
79 Each message is stored in a separate file in the format it had been
80 received (i.e. transfer format).
81 The files are named with ascending numbers in each folder.
82 The specific format of the mail storage characterizes MH in the same way
83 like the format of the file system characterizes Unix.
84 .P
85 MH tools maintain a \fIcontext\fP, which includes the current mail folder.
86 Processes in Unix have a similar context, containing the current working
87 directory, for instance. In contrast, the process context is maintained
88 by the Unix kernel automatically, whereas MH tools need to maintain the MH
89 context themselves.
90 The user can have one MH context or multiple ones, he can even share it
91 with other users.
92 .P
93 Messages are named by their numeric filename, but they can have symbolic names,
94 too. These are either automatically updated
95 position names like being the next or the last message,
96 or user-settable group names for arbitrary sets of messages.
97 These names are called sequences.
98 Sequences can be bound to the containing folder or to the context.
99 .P
100 The user's \fIprofile\fP is a file that contains his MH configuration.
101 Default switches for the individual tools can be specified to
102 adjust them to the user's personal preferences.
103 Multiple versions of the same command with different
104 default values can also be created very easily.
105 Form templates for new messages or for replies are easily changeable,
106 and output is adjustable with format files.
107 Almost every part of the system can be adjusted to personal preference.
108 .P
109 The system is well scriptable and extensible.
110 New MH tools are built out of or on top of existing ones quickly.
111 Further more, MH encourages the user to tailor, extend and automate the system.
112 As the MH tool chest was modeled after the Unix tool chest, the
113 properties of the latter apply to the former as well.
115 .U2 "Using MH
116 .P
117 It is strongly recommended to have a look at the MH Book,
118 which introduces well into using MH.
119 .[ [
120 peek mh book
121 .], Part II]
122 Rose and Romine provide a deeper and more technical
123 though slightly outdated introduction in only about two dozens pages.
124 .[
125 rose romine real work
126 .]
127 .P
128 Following is an example mail handling session.
129 It uses mmh but is mostly compatible with nmh and old MH.
130 Details might vary but the look'n'feel is the same.
131 .DS
132 $ \f(CBinc\fP
133 Incorporating new mail into inbox...
135 1+ 2012-05-16 11:16 meillo@dream.home Hello
136 2 2012-05-16 11:17 meillo@dream.home book
138 $ \f(CBshow\fP
139 Date: Wed, 16 May 2012 11:16:00 +0200
140 To: meillo
141 From: <meillo@dream.home.schnalke.org>
142 Subject: Hello
144 part text/plain 13
145 mmh is great
147 $ \f(CBnext\fP
148 Date: Wed, 16 May 2012 11:17:24 +0200
149 To: meillo
150 From: <meillo@dream.home.schnalke.org>
151 Subject: book
153 part text/plain 79
154 Hello meillo,
156 have a look at the ``Daemon book''. You need to read that!
158 foo
160 $ \f(CBrmm 1\fP
162 $ \f(CBscan\fP
163 2+ 2012-05-16 11:17 meillo@dream.home book
165 $
166 .DE
169 .H1 "nmh: Code and Community
170 .P
171 In order to understand the condition, goals and dynamics of a project,
172 one needs to know the reasons.
173 This section explains the background.
174 .P
175 MH predates the Internet, it comes from times before networking was universal,
176 it comes from times when emailing was small, short and simple.
177 Then it grew, spread and adopted to the changes email went through.
178 Its core-concepts, however, remained the same.
179 During the Eighties students at UCI actively worked on MH.
180 They added new features and optimized the code for the then popular systems.
181 All this still was in times before POSIX and ANSI C.
182 As large parts of the code stem from this time, today's nmh source code
183 still contains many ancient parts.
184 BSD-specific code and constructs tailored for hardware of that time
185 are frequent.
186 .P
187 Nmh started about a decade after the POSIX and ANSI C standards had been
188 established. A more modern coding style entered the code base, but still
189 a part of the developers came from ``the old days''. The developer
190 base became more diverse and thus resulted in code of different style.
191 Programming practices from different decades merged in the project.
192 As several peers added code, the system became more a conglomeration
193 of single tools rather than a homogeneous of-one-cast mail system.
194 Still, the existing basic concepts held it together.
195 They were mostly untouched throughout the years.
196 .P
197 Despite the tool chest approach at the surface \(en a collection
198 of separate small programs \(en on the source code level
199 it is much more interweaved.
200 Several separate components were compiled into one program
201 for efficiency reasons.
202 This lead to intricate innards.
203 Unfortunately, the clear separation on the outside appeared as being
204 pretty interweaved inside.
205 .P
206 The advent of MIME rose the complexity of email by a magnitude.
207 This is visible in nmh. The MIME-related parts are the most complex ones.
208 It's also visible that MIME support had been added on top of the old MH core.
209 MH's tool chest style made this easily possible and encourages
210 such approaches, but unfortunately, it lead to duplicated functions
211 and half-hearted implementation of the concepts.
212 .P
213 To provide backward-compatibility, it is a common understanding to not
214 change the default settings.
215 In consequence, the user needs to activate modern features explicitly
216 to be able to use them.
217 This puts a burden on new users, because out-of-the-box nmh remains
218 in the same ancient style.
219 If nmh is seen to be a back-end, then this compatibility surely is important.
220 However, in the same go, new users have difficulties to use nmh for modern
221 emailing.
222 The small but matured community around nmh hardly needs much change
223 as they have their convenient setups since decades.
226 .H1 "mmh
227 .P
228 I started to work on my experimental version in October 2011,
229 at a time when there were no more than three commits to nmh
230 since the beginning of the year.
231 In December, when I announced my work in progress on the
232 nmh-workers mailing list,
233 .[
234 nmh-workers mmh announce December
235 .]
236 nmh's community became active, too.
237 This movement was heavily pushed by Paul Vixie's ``edginess'' comment.
238 .[
239 nmh-workers vixie edginess
240 .]
241 After long years of stagnation, nmh became actively developed again.
242 Hence, while I was working on mmh, the community was working on nmh,
243 in parallel.
244 .P
245 The name \fImmh\fP may stand for \fImodern mail handler\fP,
246 because the project tries to modernize nmh.
247 Personally however, I prefer to call mmh \fImeillo's mail handler\fP,
248 emphasizing that the project follows my visions and preferences.
249 (My login name is \fImeillo\fP.)
250 This project model was inspired by \fIdwm\fP,
251 which is Anselm Garbe's personal window manager \(en
252 targeted to satisfy Garbe's personal needs whenever conflicts appear.
253 Dwm had retained its lean elegance and its focused character, whereas
254 its community-driven predecessor \fIwmii\fP had grown fat over time.
255 The development of mmh should remain focused.
258 .U2 "Motivation
259 .P
260 MH is the most important of very few command line tool chest email systems.
261 Tool chests are powerful because they can be perfectly automated and
262 extended. They allow arbitrary kinds of front-ends to be
263 implemented on top of them quickly and without internal knowledge.
264 Additionally, tool chests are much better to maintain than monolithic
265 programs.
266 As there are few tool chests for emailing and as MH-like ones are the most
267 popular among them they should be developed further.
268 This keeps their
269 conceptional elegance and unique scripting qualities available to users.
270 Mmh will create a modern and convenient entry point to MH-like systems
271 for new and interested users.
272 .P
273 The mmh project is motivated by deficits of nmh and
274 my wish for general changes, combined
275 with the nmh community's reluctancy to change.
276 .P
277 nmh hadn't adjusted to modern emailing needs well enough.
278 The default setup was completely unusable for modern emailing.
279 Too much setup work was required.
280 Several modern features were already available but the community
281 didn't wanted to have them as default.
282 mmh is a way to change this.
283 .P
284 In my eyes, MH's concepts could be exploited even better and
285 the style of the tools could be improved. Both would simplify
286 and generalize the system, providing cleaner interfaces and more
287 software leverage at the same time.
288 mmh is a way to demonstrate this.
289 .P
290 In providing several parts of an email system, nmh can hardly
291 compete with the large specialized projects that focus
292 on only one of the components.
293 The situation can be improved by concentrating the development power
294 on the most unique part of MH and letting the user pick his preferred
295 set of other mail components.
296 Today's pre-packaged software components encourage this model.
297 mmh is a way to go for this approach.
298 .P
299 It's worthwhile to fork nmh for the development of mmh, because
300 the two projects focus on different goals and differ in fundamental questions.
301 The nmh community's reluctance to change conflicts
302 with my strong will to change.
303 In developing a separate experimental version new approaches can
304 easily be tried out without the need to discuss changes beforehand.
305 In fact, revolutionary changes are hardly possible otherwise.
306 .P
307 The mmh project provides the basis to implemented and demonstrated
308 the listed ideas without the need to change nmh or its community.
309 Of course, the results of the mmh project shall improve nmh, in the end.
311 .U2 "Target Field
312 .P
313 Any effort needs to be targeted towards a specific goal
314 in order to be successful.
315 Following is a description of the imagined typical mmh user.
316 mmh should satisfy his needs.
317 .\" XXX Remove the next sentence?
318 Actually, as mmh is my personal version of MH, this is a description
319 of myself.
320 .P
321 The target user of mmh likes Unix and its philosophy.
322 He likes to use programs that are conceptionally appealing.
323 He's familiar with the command line and enjoys its power.
324 He is at least capable of shell scripting and wants to improve his
325 productivity by scripting the mail system.
326 He naturally uses modern email features, like attachments,
327 non-ASCII text, and digital cryptography.
328 He is able to setup email system components besides mmh,
329 and actually likes the choice to pick the ones he prefers.
330 He has a reasonably modern system that complies to standards,
331 like POSIX and ANSI C.
332 .P
333 The typical user invokes mmh commands directly in an interactive
334 shell session, but as well, he uses them to automate mail handling tasks.
335 Likely, he runs his mail setup on a server machine, to which he connects
336 via ssh. He might also have local mmh installations on his workstations,
337 but does rather not rely on graphical front-ends. He definitely wants
338 to be flexible and thus be able to change his setup to suite his needs.
339 .P
340 The typical mmh user is a programmer himself.
341 He likes to, occasionally, take the opportunity of Free Software to put
342 hands on and get involved in the software he uses.
343 Hence, he likes small and clean code bases and he cares for code quality.
344 In general, he believes that:
345 .BU
346 Elegance \(en i.e. simplicity, clarity and generality \(en
347 is most important.
348 .BU
349 Concepts are more important than the concrete implementation.
350 .BU
351 Code optimizations for anything but readability should be avoided
352 if possible.
353 .BU
354 Having a lot of choice is bad.
355 .BU
356 Removed code is debugged code.
358 .U2 "Goals
359 .P
360 The general goals for the mmh project are the following:
361 .IP "Stream-lining
362 Mmh should be stripped down to its core, which is the MUA part of emailing.
363 The feature set should be distilled to the ones really needed,
364 effectively removing corner-cases.
365 Parts that don't add to the main task of being a conceptionally
366 appealing MUA should be removed.
367 This includes, the MTA and MRA facilities.
368 Choice should be reduced to the main options.
369 .IP "Modernizing
370 Mmh's feature set needs to become more modern.
371 Better support for attachment and digital cryptography needs to be added.
372 MIME support needs to be integrated deeper and more naturally.
373 The modern email features need to be readily available, out-of-the-box.
374 And on the other hand,
375 bulletin board support and similar obsolete facilities need to be dropped
376 out.
377 Likewise, ancient technologies, like hardcopy terminals, should not
378 be supported any further.
379 .IP "Code style
380 Mmh's source code needs to be updated to modern standards.
381 Standardized library functions should replace non-standard versions
382 whenever possible.
383 Code should be separated into distinct modules when possible.
384 Time and space optimizations should to be replaced by
385 clear and readable code.
386 A uniform programming style should prevail.
387 .IP "Homogeneity
388 The available concepts need to be expanded as far as possible.
389 A small set of concepts should prevail thoroughly throughout the system.
390 The whole system should appear to be of-one-style.
391 It should feel like being cast as one.