1.1 --- a/preface.roff	Sun May 20 12:11:42 2012 +0200
     1.2 +++ b/preface.roff	Sun May 20 17:34:40 2012 +0200
     1.3 @@ -1,28 +1,18 @@
     1.4  .H0 "Preface" no
     1.5  
     1.6  .P
     1.7 -MH is a set of mail handling tools with a common concept, similar to
     1.8 -the Unix tool chest, which is a set of file handling tools with a common
     1.9 -concept. nmh is the currently most popular implementation of an
    1.10 -MH-like mail handling system.
    1.11 -This thesis describes an experimental version of nmh, named \fImmh\fP.
    1.12 -
    1.13 -.U2 "Background to this Thesis
    1.14 -.P
    1.15 -I have discovered nmh in September 2009. At that time I used to use the
    1.16 -mail client \fImutt\fP, as many advanced Unix users do.
    1.17 -As I read about nmh, its concepts had convinced me at once.
    1.18 -Learning its different model of email handling had been relatively easy,
    1.19 -because my starting situation was being convinced of the concepts.
    1.20 +I have discovered the mail client \fInmh\fP in September 2009.
    1.21 +At that time I used to use \fImutt\fP, as many advanced Unix users do.
    1.22 +When I read about nmh, its concepts had convinced me at once.
    1.23  The transition from mutt to nmh was similar to
    1.24 -managing files in the Unix shell when being used to graphical file
    1.25 -managers, or like editing with vi when being used to modeless editors.
    1.26 +managing files in the Unix shell when being used to the
    1.27 +\fImidnight commander\fP,
    1.28 +or like editing with vi when being used to modeless editors.
    1.29  Such a change is not trivial, but in being convinced by the
    1.30  concepts and by having done similar transitions for file management
    1.31 -and editing already, it was neither too difficult.
    1.32 +and editing already, it was not too difficult.
    1.33  In contrast, setting up nmh to a convenient state became a tedious task
    1.34  that took several months.
    1.35 -.P
    1.36  Once having nmh arranged to a convenient state, I enjoyed using it
    1.37  because of its conceptional elegance and its scripting capabilities.
    1.38  On the other hand, nevertheless, it still was
    1.39 @@ -35,16 +25,17 @@
    1.40  I wanted to improve the situation.
    1.41  .P
    1.42  In Spring 2010, I asked on the \fInmh-workers\fP mailing list for the
    1.43 -possibility to offer a Google Summer of Code project.
    1.44 -Participating in the development this way appeared attractive to me,
    1.45 -because it would have been possible to have the project
    1.46 -accepted at university. Although generally the nmh community
    1.47 -had been positive on the
    1.48 -suggestion, the administrative work had been to much, eventually.
    1.49 -But my proposal had activated the nmh community.
    1.50 +possibility to offer a Google Summer of Code project for me.
    1.51 +Participating in the development of nmh this way appeared attractive to me,
    1.52 +because I would have been able to work full time on nmh as the project
    1.53 +could have been part of my official studies at university.
    1.54 +Although the nmh community had been generally positive on the suggestion,
    1.55 +the administrative work for a GSoC project had been to much to have
    1.56 +it realized.
    1.57 +Nontheless, my proposal had activated the nmh community.
    1.58  In the following weeks, goals for nmh's future were discussed.
    1.59  In these discussions, I became involved in the
    1.60 -question whether nmh should be an MTA.
    1.61 +question whether nmh should include mail transfer facilities.
    1.62  .[
    1.63  nmh-workers thread mta mua
    1.64  .]
    1.65 @@ -56,51 +47,50 @@
    1.66  .P
    1.67  Half a year later, starting in August 2010,
    1.68  I took one semester off to travel through Latin America.
    1.69 -Within this time, I had to do practical computer work for three months.
    1.70 +During my time in Argentina, I planned to work on Free Software.
    1.71  This brought me back to nmh.
    1.72 -Richard Sandelman, an active nmh user, made it possible for
    1.73 -me to work on nmh. Juan Granda, living in Santiago del
    1.74 -Estero in Argentina, provided a computer with Internet connection for
    1.75 -my work. Thanks to them, I was able to work on nmh during my three-month
    1.76 -stay in Argentina.
    1.77 -Within this time, I became familiar with nmh's code base and
    1.78 -community. I learned how things work. Quickly it became obvious that
    1.79 -I wouldn't succeed with my main goal: improving the character
    1.80 -encoding handling within the project. One of its ramifications is the
    1.81 +Richard Sandelman, an active nmh user, cared for the official basis.
    1.82 +Juan Granda, an argentine Free Software developer,
    1.83 +provided a computer with Internet connection for my work.
    1.84 +Thanks to them, I was able to work on nmh during my three-month
    1.85 +stay in Santiago del Estero in Argentina.
    1.86 +Quickly it became obvious that I wouldn't succeed with my main goal:
    1.87 +improving the character encoding handling within the project.
    1.88 +One of its ramifications is the
    1.89  missing transfer decoding of quoted text in replies.
    1.90  As this is one of the most intricate parts of the system, the goal
    1.91 -was simply set too high. Hence, I dropped the original plan.
    1.92 -Instead, I improved the code base as I read through it. I found minor bugs
    1.93 -for which I proposed fixes to the community. In the same go, I
    1.94 -improved the documentation in minor ways. When I started with
    1.95 -larger code changes, I had to discover that the community was reluctant
    1.96 -to change. Its wish for compatibility was much stronger than its
    1.97 +was simply set too high.
    1.98 +Instead, I improved the code base as I read through it.
    1.99 +I found minor bugs for which I proposed fixes to the community.
   1.100 +In the same go, I improved the documentation in minor ways.
   1.101 +When I started with larger code changes,
   1.102 +I had to discover that the community was reluctant to change.
   1.103 +Its wish for compatibility was much stronger than its
   1.104  wish for convenient out-of-the-box setups \(en in contrast to my opinion.
   1.105  This led to long discussions, again.
   1.106 -I came to understand their point of view, but it is different to mine.
   1.107 +I came to understand their point of view, but it was different to mine.
   1.108  At the end of my three-month project, I had become familiar with
   1.109 -nmh's code base and community. I had improved the project in minor ways,
   1.110 +nmh's code base and community.
   1.111 +I had improved the project in minor ways,
   1.112  and I still was convinced that I wanted to go on to do so.
   1.113  .P
   1.114 -Another half a year later, the end of my studies came within reach.
   1.115 +Another half year later, the end of my studies came within reach.
   1.116  I needed a topic for my master's thesis.
   1.117  No question, I wanted to work on nmh.
   1.118 -But well, not exactly on nmh,
   1.119 -because I had accepted that the nmh community has different goals
   1.120 -than I have. This would result in much discussion and thus little progress.
   1.121 +But well, not exactly on nmh, because I had accepted that the
   1.122 +nmh community has different goals than I have.
   1.123 +This would result in much discussion and thus little progress.
   1.124  After careful thought, I decided to start an experimental version of nmh.
   1.125  I wanted to implement my own ideas of how an MH-like system should look like.
   1.126 -I wanted to see where that would lead to.
   1.127  I wanted to create a usable alternative version to be compared with
   1.128  the present state of nmh.
   1.129 -My work should be proved successful or failed.
   1.130 -The nmh project would not be hurt by my work, but
   1.131 -it would profit from my experiences.
   1.132 +Eventually, my work would be proven successful or not.
   1.133 +In any case, the nmh project would profit from my experiences.
   1.134  
   1.135  .U2 "Focus of this Document
   1.136  .P
   1.137 -This document describes my work on mmh.
   1.138 -It explains the changes to nmh, with focus on their reasons.
   1.139 +This document explains the design goals and implementation decisions
   1.140 +for mmh.
   1.141  It discusses technical, historical, social and philosophical considerations.
   1.142  On the technical side, this document
   1.143  explains how an existing project was stream-lined by removing rough edges
   1.144 @@ -110,23 +100,21 @@
   1.145  as well as the reactions to them, are discussed.
   1.146  Socially, this document describes the effects
   1.147  and experiences of a newcomer with revolutionary aims entering an old
   1.148 -and matured software projects.
   1.149 -Finally, philosophical thoughts on style, mainly based to the Unix philosophy,
   1.150 -are present throughout the discussions.
   1.151 +and matured software project.
   1.152 +Philosophical thoughts on style, mainly based to the Unix
   1.153 +philosophy, are present throughout the discussions.
   1.154 +The document describes the changes to nmh,
   1.155 +but as well, it clarifies my personal perception of the
   1.156 +concepts of MH and Unix, and explain my therefrom resulting point of view.
   1.157  .P
   1.158  This document is written for the community around MH-like mail systems,
   1.159  including developers and users.
   1.160 -First, the document explains the design goals and
   1.161 -implementation decisions for mmh. But as well, it clarifies my
   1.162 -personal perception of the
   1.163 -concepts of MH and Unix, and explain my therefrom resulting point of view.
   1.164  Despite the focus on MH-like systems, this document is may be precious
   1.165  to anyone interested in the Unix philosophy and anyone in contact to
   1.166  old software projects, be it code or community-related.
   1.167  .P
   1.168 -The reader is expected to have good knowledge of Unix, C and emailing.
   1.169 -Good Unix shell
   1.170 -knowledge, including shell scripting, is required. MH relies fundamentally
   1.171 +The reader is expected to be well familiar with Unix, C and emailing.
   1.172 +Good Unix shell knowledge is required, because MH relies fundamentally
   1.173  on the shell. Without the power of the shell, MH becomes a motorbike
   1.174  without winding roads: boring.
   1.175  Introductions to Unix and its shell can be found in ``The UNIX Programming
   1.176 @@ -138,14 +126,13 @@
   1.177  .[
   1.178  bourne unix system
   1.179  .]
   1.180 -The reader is
   1.181 -expected to be familiar with the C programming language, although the
   1.182 -document should be understandable without knowledge of C, too.
   1.183 -``The C Programming Language'' by Kernighan and Ritchie
   1.184 +The reader is assumed to be a C programmer,
   1.185 +but the document should be understandable otherwise, too.
   1.186 +The definitive guide to C is Kernighan and Ritchie's
   1.187 +``The C Programming Language''.
   1.188  .[
   1.189  kernighan ritchie c prog lang
   1.190  .]
   1.191 -is the definitive guide to C.
   1.192  Some book about system-level C programming can be helpful
   1.193  additional literature. Rochkind and Curry have written such books.
   1.194  .[
   1.195 @@ -154,15 +141,16 @@
   1.196  .[
   1.197  curry system prog
   1.198  .]
   1.199 -As large parts of the code are old, old books are likely more helpful
   1.200 -to understanding.
   1.201 -The format of email messages as well as the structure of email transfer
   1.202 -systems should be familiar to the reader, at least on a basic level.
   1.203 -It's advisable to have at least cross-read the RFCs 821 and 822.
   1.204 +As large parts of the source code are old,
   1.205 +old books are likely more helpful for understanding.
   1.206 +The reader is expected to know the format of email messages and
   1.207 +the structure of email transfer systems, at least on a basic level.
   1.208 +It's advisable to have cross-read the RFCs 821 and 822.
   1.209  Further more, basic understanding of MIME is good to have.
   1.210  The Wikipedia provides good introduction-level information to email.
   1.211 +.P
   1.212  Frequent references to the Unix philosophy will be made.
   1.213 -Gancarz had tried to sum the philosophy up in his book
   1.214 +Gancarz has tried to sum it up in his book
   1.215  ``The UNIX Philosophy''.
   1.216  .[
   1.217  gancarz unix phil
   1.218 @@ -181,18 +169,20 @@
   1.219  why unix phil still matters schnalke
   1.220  .]
   1.221  by myself
   1.222 -provides an overview on the topic, including a case study of MH.
   1.223 +provides an overview on the philosophy, including a case study of MH.
   1.224 +.P
   1.225  Although a brief introduction to MH is provided in Chapter 1, the reader
   1.226 -is encouraged to have a look at the \fIMH Book\fP by Jerry Peek.
   1.227 +is encouraged to have a look at the \fIMH Book\fP
   1.228 +``MH & nmh: Email for Users & Programmers'' by Jerry Peek.
   1.229  .[
   1.230  peek mh
   1.231  .]
   1.232 +The current version is available freely on the Internet.
   1.233  It is the definitive guide to MH and nmh.
   1.234 -The current version is available freely on the Internet.
   1.235  .P
   1.236  This document is neither a user's tutorial to mmh nor an introduction
   1.237 -to any of the topics covered. It discusses Unix, email
   1.238 -and system design on an advanced level.
   1.239 +to any of the topics covered.
   1.240 +The technical discussions are on an advanced level.
   1.241  Nevertheless, as knowledge of the fundamental concepts is the most valuable
   1.242  information a user can acquire about some program or software system,
   1.243  this document may be worth a read for non-developers as well.