# HG changeset patch # User markus schnalke # Date 1340482097 -7200 # Node ID 3c4e5f0a7e7b9d318be6d7a8f2d3a05bc206bdca # Parent 9ff356d84c578e5a0fae8e94b9a0aba0a64de030 Included (English language) corrections by Kate. diff -r 9ff356d84c57 -r 3c4e5f0a7e7b ch01.roff --- a/ch01.roff Thu Jun 21 08:58:56 2012 +0200 +++ b/ch01.roff Sat Jun 23 22:08:17 2012 +0200 @@ -10,7 +10,7 @@ .P This chapter introduces MH, its history, concepts and how it is used. It describes nmh's code base and community to give the reader -a better understanding of the state from which mmh started off. +a better understanding of the state of mmh when it started off. Further more, this chapter outlines the mmh project itself, describing the motivation for it and its goals. @@ -29,19 +29,19 @@ .U2 "History .P In 1977 at RAND Corporation, Norman Shapiro and Stockton Gaines -had proposed the design +proposed the design of a new mail handling system, called ``Mail Handler'' (MH), to superseed RAND's old monolithic ``Mail System'' (MS). Two years later, in 1979, Bruce Borden took the proposal and implemented a prototype of MH. -Before the prototype had been available, the concept was +Before the prototype's existence, the concept was believed to be practically unusable. -But the prototype had proven successful and replaced MS thereafter. +But the prototype proved successful and replaced MS thereafter. In replacing MS, MH grew to an all-in-one mail system. .P -In the early Eighties, -the University of California at Irvine (UCI) had started to use MH. -Marshall T. Rose and John L. Romine became the driving force then. +In the early eighties, +the University of California at Irvine (UCI) started to use MH. +Marshall T. Rose and John L. Romine then became the driving force. They took over the development and pushed MH forward. RAND had put the code into the public domain by then. MH was developed at UCI at the time when the Internet appeared, @@ -51,7 +51,7 @@ RFCs. In the advent of MIME, MH was the first implementation of this new email standard. .P -In the Nineties, the Internet had become popular and in December 1996, +In the nineties, the Internet had become popular and in December 1996, Richard Coleman initiated the ``New Mail Handler'' (nmh) project. Nmh is a fork of MH 6.8.3 and bases strongly on the \fILBL changes\fP by Van Jacobson, Mike Karels and Craig Leres. @@ -64,7 +64,7 @@ Some systems might still provide old MH, but mainly for historical reasons. .P In the last years, the work on nmh was mostly maintenance work. -However, the development revived in December 2011 +However, development was revived in December 2011 and stayed busy since then. .U2 "Concepts @@ -76,23 +76,23 @@ .P The mail storage consists of \fImail folders\fP (directories) and \fPmessages\fP (regular files). -Each message is stored in a separate file in the format it had been +Each message is stored in a separate file in the format it was received (i.e. transfer format). The files are named with ascending numbers in each folder. The specific format of the mail storage characterizes MH in the same way -like the format of the file system characterizes Unix. +as the format of the file system characterizes Unix. .P MH tools maintain a \fIcontext\fP, which includes the current mail folder. Processes in Unix have a similar context, containing the current working directory, for instance. In contrast, the process context is maintained by the Unix kernel automatically, whereas MH tools need to maintain the MH context themselves. -The user can have one MH context or multiple ones, he can even share it -with other users. +The user can have one MH context or multiple ones; he can even share it +with others. .P Messages are named by their numeric filename, but they can have symbolic names, too. These are either automatically updated -position names like being the next or the last message, +position names such as the next or the last message, or user-settable group names for arbitrary sets of messages. These names are called sequences. Sequences can be bound to the containing folder or to the context. @@ -148,7 +148,7 @@ .U2 "Using MH .P It is strongly recommended to have a look at the MH Book, -which introduces well into using MH. +which offers a thorough introduction to using MH. .[ [ peek mh book .], Part II] @@ -160,7 +160,7 @@ .P Following is an example mail handling session. It uses mmh but is mostly compatible with nmh and old MH. -Details might vary but the look'n'feel is the same. +Details might vary but the look and feel is the same. .VF input/mh-session @@ -168,14 +168,14 @@ .H1 "nmh: Code and Community .P In order to understand the condition, goals and dynamics of a project, -one needs to know the reasons. +one needs to know the reasons behind them. This section explains the background. .P -MH predates the Internet, it comes from times before networking was universal, +MH predates the Internet; it comes from times before networking was universal, it comes from times when emailing was small, short and simple. -Then it grew, spread and adopted to the changes email went through. +Then it grew, spread and adapted to the changes email went through. Its core-concepts, however, remained the same. -During the Eighties students at UCI actively worked on MH. +During the eighties, students at UCI actively worked on MH. They added new features and optimized the code for the then popular systems. All this still was in times before POSIX and ANSI C. As large parts of the code stem from this time, today's nmh source code @@ -183,30 +183,34 @@ BSD-specific code and constructs tailored for hardware of that time are frequent. .P -Nmh started about a decade after the POSIX and ANSI C standards had been +Nmh started about a decade after the POSIX and ANSI C standards were established. A more modern coding style entered the code base, but still a part of the developers came from ``the old days''. The developer -base became more diverse and thus resulted in code of different style. +base became more diverse, thus broadening the range of different +coding styles. Programming practices from different decades merged in the project. As several peers added code, the system became more a conglomeration of single tools rather than a homogeneous of-one-cast mail system. Still, the existing basic concepts held it together. They were mostly untouched throughout the years. .P -Despite the tool chest approach at the surface \(en a collection -of separate small programs \(en on the source code level -it is much more interweaved. +Despite the separation of the tool chest approach at the surface +\(en a collection of small, separate programs \(en +on the source code level, it is much more interweaved. Several separate components were compiled into one program for efficiency reasons. -This lead to intricate innards. -Unfortunately, the clear separation on the outside appeared as being -pretty interweaved inside. +This led to intricate innards. +While clearly separated on the outside, +the programs turned out to be fairly interweaved inside. +.\" XXX FIXME rewrite... +.\" Unfortunately, the clear separation on the outside turned out to be +.\" fairly interweaved inside. .P -The advent of MIME rose the complexity of email by a magnitude. +The advent of MIME raised the complexity of email by a magnitude. This is visible in nmh. The MIME-related parts are the most complex ones. -It's also visible that MIME support had been added on top of the old MH core. +It is also visible that MIME support was added on top of the old MH core. MH's tool chest style made this easily possible and encourages -such approaches, but unfortunately, it lead to duplicated functions +such approaches, but unfortunately, it led to duplicated functions and half-hearted implementation of the concepts. .P To provide backward-compatibility, it is a common understanding to not @@ -216,16 +220,16 @@ This puts a burden on new users, because out-of-the-box nmh remains in the same ancient style. If nmh is seen to be a back-end, then this compatibility surely is important. -However, in the same go, new users have difficulties to use nmh for modern +However, in the same go, new users have difficulties using nmh for modern emailing. -The small but matured community around nmh hardly needs much change -as they have their convenient setups since decades. +The small but mature community around nmh needs few change +as they have had their convenient setups for decades. .H1 "mmh .P I started to work on my experimental version in October 2011, -at a time when there were no more than three commits to nmh +at a time when there had been no more than three commits to nmh since the beginning of the year. In December, when I announced my work in progress on the nmh-workers mailing list, @@ -238,8 +242,8 @@ nmh-workers vixie edginess .] After long years of stagnation, nmh became actively developed again. -Hence, while I was working on mmh, the community was working on nmh, -in parallel. +Hence, while I was working on mmh, the community was once more working +on nmh, in parallel. .P The name \fImmh\fP may stand for \fImodern mail handler\fP, because the project tries to modernize nmh. @@ -260,31 +264,31 @@ Tool chests are powerful because they can be perfectly automated and extended. They allow arbitrary kinds of front-ends to be implemented on top of them quickly and without internal knowledge. -Additionally, tool chests are much better to maintain than monolithic +Additionally, tool chests are easier to maintain than monolithic programs. As there are few tool chests for emailing and as MH-like ones are the most -popular among them they should be developed further. +popular among them, they should be developed further. This keeps their conceptional elegance and unique scripting qualities available to users. -Mmh will create a modern and convenient entry point to MH-like systems +Mmh creates a modern and convenient entry point to MH-like systems for new and interested users. .P The mmh project is motivated by deficits of nmh and my wish for general changes, combined with the nmh community's reluctancy to change. .P -nmh hadn't adjusted to modern emailing needs well enough. +At that time, nmh had not adjusted to modern emailing needs well enough. The default setup was completely unusable for modern emailing. Too much setup work was required. Several modern features were already available but the community -didn't wanted to have them as default. -mmh is a way to change this. +did not want to have them as default. +Mmh is a way to change this. .P In my eyes, MH's concepts could be exploited even better and the style of the tools could be improved. Both would simplify and generalize the system, providing cleaner interfaces and more software leverage at the same time. -mmh is a way to demonstrate this. +Mmh is a way to demonstrate this. .P In providing several parts of an email system, nmh can hardly compete with the large specialized projects that focus @@ -293,18 +297,18 @@ on the most unique part of MH and letting the user pick his preferred set of other mail components. Today's pre-packaged software components encourage this model. -mmh is a way to go for this approach. +Mmh is a way to go for this approach. .P -It's worthwhile to fork nmh for the development of mmh, because +It is worthwhile to fork nmh for the development of mmh, because the two projects focus on different goals and differ in fundamental questions. -The nmh community's reluctance to change conflicts -with my strong will to change. +The nmh community's reluctance regarding change conflicts +with my strong desire for it. In developing a separate experimental version new approaches can easily be tried out without the need to discuss changes beforehand. In fact, revolutionary changes are hardly possible otherwise. .P -The mmh project provides the basis to implemented and demonstrated -the listed ideas without the need to change nmh or its community. +The mmh project implements and demonstrates the listed ideas +without the need to change nmh or its community. Of course, the results of the mmh project shall improve nmh, in the end. .U2 "Target Field diff -r 9ff356d84c57 -r 3c4e5f0a7e7b preface.roff --- a/preface.roff Thu Jun 21 08:58:56 2012 +0200 +++ b/preface.roff Sat Jun 23 22:08:17 2012 +0200 @@ -15,22 +15,20 @@ that took several months. Once having nmh arranged to a convenient state, I enjoyed using it because of its conceptional elegance and its scripting capabilities. -Nevertheless, it still was inconvenient for handling attachments, +Nevertheless, it was still inconvenient for handling attachments, non-ASCII character encodings, and similar features of modern emailing. My setup demanded more and more additional configuration and helper scripts to have nmh behave the way I wanted; yet my expectations were rather common for modern emailing. -In being a computer scientist and programmer, -I wanted to improve the situation. +As a computer scientist and programmer, I wanted to improve the situation. .P -In Spring 2010, I asked on the \fInmh-workers\fP mailing list for the -possibility to offer a Google Summer of Code project for me. -Participating in the development of nmh this way appeared attractive to me, -because I would have been able to work full time on nmh. -Although the nmh community had been generally positive on the suggestion, -the administrative work for a GSoC project had been to much to have -it realized. -Nontheless, my proposal had activated the nmh community. +In Spring 2010, I sent a message to the \fInmh-workers\fP mailing list, +asking for the possibility to offer a Google Summer of Code project for me. +Participating in the development of nmh in this manner appeared attractive +to me, because I would have been able to work full time on nmh. +Although the nmh community had reacted generally positive to the suggestion, +the administrative work for a GSoC project would had been too much. +Nonetheless, my proposal had activated the nmh community. In the following weeks, goals for nmh's future were discussed. In these discussions, I became involved in the question whether nmh should include mail transfer facilities. @@ -49,11 +47,11 @@ During my time in Argentina, I wanted to work on Free Software. This brought me back to nmh. Richard Sandelman, an active nmh user, cared for the official basis. -Juan Granda, an argentine Free Software developer, +Juan Granda, an Argentine Free Software developer, provided a computer with Internet connection. Thanks to them, I was able to work on nmh during my three-month stay in Santiago del Estero, Argentina. -Quickly it became obvious that I wouldn't succeed with my main goal, +Quickly it became obvious that I would not succeed with my main goal, to improve the character encoding handling. (One of its ramifications is the missing transfer decoding of quoted text in replies.) @@ -66,7 +64,7 @@ I had to discover that the community was reluctant to change. Its wish for compatibility was much stronger than its wish for convenient out-of-the-box setups \(en in contrast to my opinion. -This led to long discussions, again. +This, once again, led to long discussions. I came to understand their point of view, but it was different to mine. At the end of my three-month project, I had become familiar with nmh's code base and community, @@ -75,9 +73,9 @@ .P Another half year later, the end of my studies came within reach. I needed a topic for my master's thesis. -No question, I wanted to work on nmh. -But well, not exactly on nmh, because I had accepted that the -nmh community has different goals than I have. +Without question, I wanted to work on nmh. +But not exactly on nmh, because I had accepted that its +community has different goals than I have. Working on nmh would result in much discussion and, in consequence, little progress. After careful thought, I decided to start an experimental version of nmh. @@ -94,14 +92,14 @@ It discusses technical, historical, social and philosophical considerations. On the technical side, this document explains how an existing project was stream-lined by removing rough edges -and exploiting the central concepts better. -On the historical -side, changes through time in the use cases and the email features, -as well as the reactions to them, are discussed. +and better exploitation of the central concepts. +On the historical side, changes through time are discussed, +regarding the use cases and the email features, +as well as the reactions to them. Socially, this document describes the effects and experiences of a newcomer with revolutionary aims entering an old and matured software project. -Philosophical thoughts on style, mainly based to the Unix +Philosophical thoughts on style, mainly based on the Unix philosophy, are present throughout the discussions. The document describes the changes to nmh, but as well, it clarifies my personal perception of the @@ -109,11 +107,11 @@ .P This document is written for the community around MH-like mail systems, including developers and users. -Despite the focus on MH-like systems, this document is may be precious -to anyone interested in the Unix philosophy and anyone in contact to -old software projects, be it code or community-related. +Despite the focus on MH-like systems, this document may be valuable +to anyone interested in the Unix philosophy and anyone in contact with +old software projects, be it code- or community-related. .P -The reader is expected to be well familiar with Unix, C and emailing. +The reader is expected to be familiar with Unix, C and emailing. Good Unix shell knowledge is required, because MH relies fundamentally on the shell. Without the power of the shell, MH becomes a motorbike without winding roads: boring. @@ -133,21 +131,21 @@ .[ kernighan ritchie c prog lang .] -Some book about system-level C programming can be helpful -additional literature. Rochkind and Curry have written such books. +A book about system-level C programming can be helpful +additional literature, such as those written by Rochkind and Curry. .[ rochkind advanced unix prog .] .[ curry system prog .] -As large parts of the source code are old, -old books are likely more helpful for understanding. +Old books are likely more helpful for understanding, +because large parts of the source code are old. The reader is expected to know the format of email messages and the structure of email transfer systems, at least on a basic level. It's advisable to have cross-read the RFCs 821 and 822. Further more, basic understanding of MIME is good to have. -The Wikipedia provides good introduction-level information to email. +The Wikipedia provides good introduction-level information about email. .P Frequent references to the Unix philosophy will be made. Gancarz has tried to sum it up in his book