docs/master
changeset 159:8b411125645d
Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
author | markus schnalke <meillo@marmaro.de> |
---|---|
date | Mon, 09 Jul 2012 11:16:30 +0200 |
parents | a6dc418ab0a4 |
children | 160b62e77f55 |
files | colophon.roff discussion.roff intro.roff preface.roff |
diffstat | 4 files changed, 130 insertions(+), 102 deletions(-) [+] |
line diff
1.1 --- a/colophon.roff Sun Jul 08 17:25:35 2012 +0200 1.2 +++ b/colophon.roff Mon Jul 09 11:16:30 2012 +0200 1.3 @@ -3,8 +3,8 @@ 1.4 This document was typeset with the 1.5 .I troff 1.6 document preparation system on Unix. 1.7 -After having typset my diploma thesis with Latex, the choice for 1.8 -troff was similar to prefering MH over mutt. 1.9 +After having typset my diploma thesis with LaTeX, 1.10 +the choice for troff was similar to prefering MH over mutt. 1.11 .P 1.12 I used the troff implementation of the Heirloom doctools, 1.13 and built upon the
2.1 --- a/discussion.roff Sun Jul 08 17:25:35 2012 +0200 2.2 +++ b/discussion.roff Mon Jul 09 11:16:30 2012 +0200 2.3 @@ -21,10 +21,11 @@ 2.4 I believe that the development of all-in-one mail systems is obsolete. 2.5 Today, email is too complex to be fully covered by single projects. 2.6 Such a project won't be able to excel in all aspects. 2.7 -Instead, the aspects of email should be covered my multiple projects, 2.8 +Instead, the aspects of email should be covered by multiple projects, 2.9 which then can be combined to form a complete system. 2.10 Excellent implementations for the various aspects of email exist already. 2.11 Just to name three examples: Postfix is a specialized MTA, 2.12 +.\" XXX homepages verlinken 2.13 Procmail is a specialized MDA, and Fetchmail is a specialized MRA. 2.14 I believe that it is best to use such specialized tools instead of 2.15 providing the same function again as a side-component in the project. 2.16 @@ -65,7 +66,7 @@ 2.17 .P 2.18 Focusing on one mail agent role only is motivated by Eric Allman's 2.19 experience with Sendmail. 2.20 -He identified limiting Sendmail the MTA task had be one reason for 2.21 +He identified the limitation of Sendmail to the MTA task as one reason for 2.22 its success: 2.23 .[ [ 2.24 costales sendmail 2.25 @@ -78,12 +79,12 @@ 2.26 were incorporated directly into the user agents. 2.27 .QE 2.28 .P 2.29 -In mmh, the Mail Submission Agent (MSA) is called 2.30 +In nmh, the Mail Submission Agent (MSA) is called 2.31 \fIMessage Transfer Service\fP (MTS). 2.32 This facility, implemented by the 2.33 .Pn post 2.34 command, established network connections and spoke SMTP to submit 2.35 -messages for relay to the outside world. 2.36 +messages to be relayed to the outside world. 2.37 The changes in email demanded changes in this part of nmh too. 2.38 Encryption and authentication for network connections 2.39 needed to be supported, hence TLS and SASL were introduced into nmh. 2.40 @@ -126,7 +127,7 @@ 2.41 from remote locations. 2.42 .Ci ab7b48411962d26439f92f35ed084d3d6275459c 2.43 Instead, it depends on an external tool to cover this task. 2.44 -In mmh exist two paths for messages to enter mmh's mail storage: 2.45 +In mmh, two paths exist for messages to enter mmh's mail storage: 2.46 (1) Mail can be incorporated with 2.47 .Pn inc 2.48 from the system maildrop, or (2) with 2.49 @@ -139,12 +140,12 @@ 2.50 An external MSA is required to transfer mail to the outside world; 2.51 an external MRA is required to retrieve mail from remote machines. 2.52 There exist excellent implementations of such software, 2.53 -which do this specific task likely better than the internal 2.54 -versions had done it. 2.55 -Also, the best suiting programs can be freely chosen. 2.56 +which likely are superior than the internal version. 2.57 +Additionally, the best suiting programs can be freely chosen. 2.58 .P 2.59 As it had already been possible to use an external MSA or MRA, 2.60 why not keep the internal version for convenience? 2.61 +.\" XXX ueberleitung 2.62 The question whether there is sense in having a fall-back pager in all 2.63 the command line tools, for the cases when 2.64 .Pn more 2.65 @@ -202,6 +203,7 @@ 2.66 that covers the field. 2.67 Today, this is a reasonable exchange. 2.68 .P 2.69 +.\" XXX ueberleitung ??? 2.70 Functionality can be added in three different ways: 2.71 .BU 2.72 Implementing the function originally in the project. 2.73 @@ -210,7 +212,8 @@ 2.74 .BU 2.75 Depending on a program that provides the function. 2.76 .P 2.77 -Whereas adding the function originally to the project increases the 2.78 +.\" XXX Rework sentence 2.79 +While adding the function originally to the project increases the 2.80 code size most and requires most maintenance and development work, 2.81 it makes the project most independent of other software. 2.82 Using libraries or external programs require less maintenance work 2.83 @@ -221,7 +224,7 @@ 2.84 thus information can be exchanged more flexible. 2.85 Adding code to a project increases maintenance work. 2.86 .\" XXX ref 2.87 -Implementing complex functions originally in the project adds 2.88 +Implementing complex functions in the project itself adds 2.89 a lot of code. 2.90 This should be avoided if possible. 2.91 Hence, the dependencies only change in kind, not in their existence. 2.92 @@ -230,8 +233,8 @@ 2.93 and 2.94 .Pn libcrypto /\c 2.95 .Pn libssl 2.96 -were treated against program dependencies on an MSA and an MRA. 2.97 -This also meant treating build-time dependencies against run-time 2.98 +were traded against program dependencies on an MSA and an MRA. 2.99 +This also meant trading build-time dependencies against run-time 2.100 dependencies. 2.101 Besides program dependencies providing the stronger separation 2.102 and being more flexible, they also allowed 2.103 @@ -246,6 +249,7 @@ 2.104 Also, the popular MSAs and MRAs have large communities and a lot 2.105 of documentation available. 2.106 Choices for MSAs range from full-featured MTAs like 2.107 +.\" XXX refs 2.108 .I Postfix 2.109 over mid-size MTAs like 2.110 .I masqmail 2.111 @@ -292,7 +296,7 @@ 2.112 was removed 2.113 .Ci 14767c94b3827be7c867196467ed7aea5f6f49b0 2.114 because its use case of writing to the user's terminal 2.115 -on receiving of mail is obsolete. 2.116 +on receival of mail is obsolete. 2.117 If users like to be informed of new mail, the shell's 2.118 .Ev MAILPATH 2.119 variable or graphical notifications are technically more appealing. 2.120 @@ -305,6 +309,7 @@ 2.121 VE 2.122 .BU 2.123 .Pn viamail 2.124 +.\" XXX was macht viamail 2.125 was removed 2.126 .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932 2.127 when the new attachment system was activated, because 2.128 @@ -317,6 +322,7 @@ 2.129 .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6 2.130 .BU 2.131 .Pn msgchk 2.132 +.\" XXX was macht msgchk 2.133 was removed 2.134 .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe , 2.135 because it lost its use case when POP support was removed. 2.136 @@ -343,11 +349,11 @@ 2.137 .Ci 916690191222433a6923a4be54b0d8f6ac01bd02 2.138 because the tool was in conflict with the philosophy of MH. 2.139 It provided an interactive shell to access the features of MH, 2.140 -but it wasn't just a shell, tailored to the needs of mail handling. 2.141 +but it wasn't just a shell tailored to the needs of mail handling. 2.142 Instead it was one large program that had several MH tools built in. 2.143 This conflicts with the major feature of MH of being a tool chest. 2.144 .Pn msh 's 2.145 -main use case had been accessing Bulletin Boards, which have seized to 2.146 +main use case had been accessing Bulletin Boards, which have ceased to 2.147 be popular. 2.148 .P 2.149 Removing 2.150 @@ -422,7 +428,7 @@ 2.151 .Pn slocal 2.152 in need for deeper investigation. 2.153 In the meanwhile, it remains part of mmh. 2.154 -That does not hurt because 2.155 +However, its continued existence is not significant because 2.156 .Pn slocal 2.157 is unrelated to the rest of the project. 2.158 2.159 @@ -432,6 +438,7 @@ 2.160 .Id mhshow 2.161 .P 2.162 Since the very beginning, already in the first concept paper, 2.163 +.\" XXX ref!!! 2.164 .Pn show 2.165 had been MH's message display program. 2.166 .Pn show 2.167 @@ -509,7 +516,7 @@ 2.168 MIME messages, although it is the other way round. 2.169 As 2.170 .Pn mhshow 2.171 -had already be able to display non-MIME messages, it appeared natural 2.172 +had already been able to display non-MIME messages, it appeared natural 2.173 to drop 2.174 .Pn show 2.175 in favor of using 2.176 @@ -554,7 +561,8 @@ 2.177 even more natural. 2.178 Today, mmh's new 2.179 .Pn show 2.180 -became the one single message display program again, with the difference 2.181 +has become the one single message display program once more, 2.182 +with the difference 2.183 that today it handles MIME messages as well as non-MIME messages. 2.184 The outcome of the transition is one program less to maintain, 2.185 no second display program for users to deal with, 2.186 @@ -563,10 +571,11 @@ 2.187 Still, removing the old 2.188 .Pn show 2.189 hurts in one regard: It had been such a simple program. 2.190 -Its lean elegance is missing to the new 2.191 -.Pn show . 2.192 -But there is no chance; 2.193 -supporting MIME demands for higher essential complexity. 2.194 +Its lean elegance is missing from the new 2.195 +.Pn show , 2.196 +.\" XXX 2.197 +however there is no alternative; 2.198 +supporting MIME demands higher essential complexity. 2.199 2.200 .ig 2.201 XXX 2.202 @@ -591,13 +600,13 @@ 2.203 There is the cost of code complexity to be able to customize. 2.204 There is the cost of less tested setups, because there are 2.205 more possible setups and especially corner-cases. 2.206 -And, there is the cost of choice itself. 2.207 +Additionally, there is the cost of choice itself. 2.208 The code complexity directly affects the developers. 2.209 Less tested code affects both, users and developers. 2.210 -The problem of choice affects the users, for once by having to 2.211 -choose, but also by more complex interfaces that require more documentation. 2.212 -Whenever options add little advantages, they should be considered for 2.213 -removal. 2.214 +The problem of choice affects the users, for once by having to choose, 2.215 +but also by more complex interfaces that require more documentation. 2.216 +Whenever options add few advantages but increase the complexity of the 2.217 +system, they should be considered for removal. 2.218 I have reduced the number of project-specific configure options from 2.219 fifteen to three. 2.220 2.221 @@ -611,10 +620,14 @@ 2.222 and 2.223 .Sw --with-cyrus-sasl 2.224 had activated the support for transfer encryption and authentication. 2.225 +.\" XXX cf 2.226 +.\" XXX gruende kurz wiederholen 2.227 This is not needed anymore. 2.228 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3 2.229 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b 2.230 .P 2.231 +.\" XXX cf 2.232 +.\" XXX ``For the same reason ...'' 2.233 The configure switch 2.234 .Sw --enable-pop 2.235 activated the message retrieval facility. 2.236 @@ -624,7 +637,7 @@ 2.237 Whereas the code base changes would only slightly change on toggling 2.238 TLS or SASL support, it changed much on toggling POP support. 2.239 The changes in the code base could hardly be overviewed. 2.240 -By having POP support togglable a second code base had been created, 2.241 +By having POP support togglable, a second code base had been created, 2.242 one that needed to be tested. 2.243 This situation is basically similar for the conditional TLS and SASL 2.244 code, but there the changes are minor and can yet be overviewed. 2.245 @@ -638,6 +651,7 @@ 2.246 .Ar smtp 2.247 or 2.248 .Ar sendmail . 2.249 +.\" XXX naechster Satz ganz raus? 2.250 In mmh this fixed to 2.251 .Ar sendmail . 2.252 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226 2.253 @@ -654,6 +668,7 @@ 2.254 The backup prefix is the string that was prepended to message 2.255 filenames to tag them as deleted. 2.256 By default it had been the comma character `\f(CW,\fP'. 2.257 +.\" XXX Zeitlich ordnen 2.258 In July 2000, Kimmo Suominen introduced 2.259 the configure option 2.260 .Sw --with-hash-backup 2.261 @@ -681,7 +696,7 @@ 2.262 Using the hash as backup prefix can be seen as a precaution against 2.263 data loss. 2.264 .P 2.265 -I removed the configure option but added the profile entry 2.266 +First, I removed the configure option but added the profile entry 2.267 .Pe backup-prefix , 2.268 which allows to specify an arbitrary string as backup prefix. 2.269 .Ci 6c40d481d661d532dd527eaf34cebb6d3f8ed086 2.270 @@ -823,6 +838,7 @@ 2.271 .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf 2.272 The change removed functionality too, but that is minor to the 2.273 improvement by dropping the dependency and the complex autoconf code. 2.274 +.\" XXX argument: slocal ist sowieso nicht teil vom mmh kern 2.275 2.276 .U3 "mh-e Support 2.277 .P 2.278 @@ -849,6 +865,7 @@ 2.279 .Ci a7ce7b4a580d77b6c2c4d980812beb589aa4c643 2.280 Removing the option removed a second code setup that would have 2.281 needed to be tested. 2.282 +.\" XXX datum? 2.283 This change was first done in nmh and thereafter merged into mmh. 2.284 .P 2.285 The interface changes in mmh require mh-e to be adjusted in order 2.286 @@ -918,6 +935,7 @@ 2.287 hadn't supported it already. 2.288 .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9 2.289 Username extensions are possible in mmh, but less convenient to use. 2.290 +.\" XXX covered by next paragraph 2.291 .\" XXX format file %(getenv USERNAME_EXTENSION) 2.292 .P 2.293 The 2.294 @@ -978,8 +996,8 @@ 2.295 Every program in mmh has two generic switches: 2.296 .Sw -help , 2.297 to print a short message on how to use the program, and 2.298 -.Sw -Version , 2.299 -to tell what version of mmh the program belongs to. 2.300 +.Sw -Version 2.301 +[sic!], to tell what version of mmh the program belongs to. 2.302 .P 2.303 Switches change the behavior of programs. 2.304 Programs that do one thing in one way require no switches. 2.305 @@ -1050,7 +1068,7 @@ 2.306 (These numbers include two generic switches, help and version.) 2.307 .P 2.308 The figure displays the number of switches for each of the tools 2.309 -that is available in both, nmh and mmh. 2.310 +that is available in both nmh and mmh. 2.311 The tools are sorted by the number of switches they had in nmh. 2.312 Visible and hidden switches were counted, 2.313 but not the generic help and version switches. 2.314 @@ -1108,7 +1126,7 @@ 2.315 The only flexibility removed with this change is having multiple 2.316 draft folders within one profile. 2.317 I consider this a theoretical problem only. 2.318 -In the same go, the 2.319 +At the same time, the 2.320 .Sw -draft 2.321 switch of 2.322 .Pn anno , 2.323 @@ -1116,9 +1134,9 @@ 2.324 and 2.325 .Pn send 2.326 was removed. 2.327 -The special-casing of `the' draft message became irrelevant after 2.328 +The special treatment of \fIthe\fP draft message became irrelevant after 2.329 the rework of the draft system. 2.330 -(df. Sec. 2.331 +(cf. Sec. 2.332 .Cf draft-folder ) 2.333 Equally, 2.334 .Pn comp 2.335 @@ -1270,7 +1288,9 @@ 2.336 .Pn mhlist 2.337 were removed, doing real size calculations always now 2.338 .Ci 8d8f1c3abc586c005c904e52c4adbfe694d2201c , 2.339 -as 2.340 +as nmh's 2.341 +.Mp mhbuild (1) 2.342 +man page states 2.343 ``This provides an accurate count at the expense of a small delay.'' 2.344 This small delay is not noticable on modern systems. 2.345 .P 2.346 @@ -1303,7 +1323,7 @@ 2.347 switches was completely removed. 2.348 .Ci d1fefd9f614e4dc3cda16da6c69133c1b2005269 2.349 External MIME parts are rare today, having a caching facility 2.350 -for them is appears to be unnecessary. 2.351 +for them appears to be unnecessary. 2.352 .P 2.353 In pre-MIME times, 2.354 .Pn mhl 2.355 @@ -1322,7 +1342,7 @@ 2.356 .P 2.357 .Pn folder 's 2.358 data output is self-explaining enough that 2.359 -displaying the header line makes few sense. 2.360 +displaying the header line makes little sense. 2.361 Hence, the 2.362 .Sw -[no]header 2.363 switch was removed and headers are never printed. 2.364 @@ -1379,7 +1399,7 @@ 2.365 with an empty argument. 2.366 .Ci 75fca31a5b9d5c1a99c74ab14c94438d8852fba9 2.367 (Specifying 2.368 -.Cl "-editor true 2.369 +.Cl "-editor /bin/true 2.370 is nearly the same, only differing by the previous editor being set.) 2.371 .P 2.372 The more important change is the removal of the 2.373 @@ -1404,7 +1424,7 @@ 2.374 .Sw -nowhatnowproc 2.375 switch creates only a draft message. 2.376 As 2.377 -.Cl "-whatnowproc true 2.378 +.Cl "-whatnowproc /bin/true 2.379 causes the same behavior, the 2.380 .Sw -nowhatnowproc 2.381 switch was removed for being redundant. 2.382 @@ -1454,6 +1474,7 @@ 2.383 nor page the output itself (\c 2.384 .Sw -length 2.385 .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ). 2.386 +.\" XXX Ref 2.387 Generally, the pager to use is no longer specified with the 2.388 .Sw -[no]moreproc 2.389 command line switches for 2.390 @@ -1507,6 +1528,7 @@ 2.391 by Rose and 2.392 ``Lists messages in reverse order with the `\-reverse' switch. 2.393 This should be considered a bug.'' by Romine in the documentation. 2.394 +.\" XXX Ref: welche datei genau. 2.395 The question remains why neither Rose and Romine had fixed this 2.396 bug in the eighties when they wrote these comments nor has anyone 2.397 thereafter. 2.398 @@ -1563,8 +1585,8 @@ 2.399 .\" -------------------------------------------------------------- 2.400 .H1 "Modernizing 2.401 .P 2.402 -In the over thirty years of MH's existence, its code base was 2.403 -extended more and more. 2.404 +In the more thirty years of MH's existence, its code base was 2.405 +increasingly extended. 2.406 New features entered the project and became alternatives to the 2.407 existing behavior. 2.408 Relicts from several decades have gathered in the code base, 2.409 @@ -1578,13 +1600,15 @@ 2.410 2.411 .H2 "Code Relicts 2.412 .P 2.413 -My position to drop obsolete functions of mmh, in order to remove old code, 2.414 -is much more revolutional than the nmh community likes to have it. 2.415 -Working on an experimental version, I was able to quickly drop 2.416 +My position regarding the removal of obsolete functions of mmh, 2.417 +.\" XXX ``in order to remove old code,'' 2.418 +is much more revolutional than the nmh community appreciates. 2.419 +Working on an experimental version, I was quickly able to drop 2.420 functionality I considered ancient. 2.421 The need for consensus with peers would have slowed this process down. 2.422 Without the need to justify my decisions, I was able to rush forward. 2.423 In December 2011, Paul Vixie motivated the nmh developers to just 2.424 +.\" XXX ugs 2.425 do the work: 2.426 .[ 2.427 paul vixie edginess nmh-workers 2.428 @@ -1603,18 +1627,20 @@ 2.429 .LP 2.430 I did so already in the months before. 2.431 I pushed forward. 2.432 +.\" XXX semicolon ? 2.433 I simply dropped the cruft. 2.434 .P 2.435 The decision to drop a feature was based on literature research and 2.436 -careful thinking, but whether having had contact to this particular 2.437 +careful thinking, but whether having had contact with this particular 2.438 feature within my own computer life served as a rule of thumb. 2.439 -Always, I explained my reasons in the commit messages 2.440 +I explained my reasons in the commit messages 2.441 in the version control system. 2.442 Hence, others can comprehend my view and argue for undoing the change 2.443 if I have missed an important aspect. 2.444 I was quick in dropping parts. 2.445 -I rather re-included falsely dropped parts than going a slower pace. 2.446 +I rather re-included falsely dropped parts than going at a slower pace. 2.447 Mmh is experimental work; it required tough decisions. 2.448 +.\" XXX ``exp. work'' schon oft gesagt 2.449 2.450 2.451 .U3 "Forking 2.452 @@ -1623,9 +1649,9 @@ 2.453 In earlier times 2.454 .Fu fork() 2.455 had been an expensive system call, because the process's image needed 2.456 -to be duplicated completely at once. 2.457 -This was especially painful in the common case when the image gets 2.458 -replaced by a call to 2.459 +to be completely duplicated at once. 2.460 +This expensive work was especially unnecessary in the commonly occuring 2.461 +case wherein the image is replaced by a call to 2.462 .Fu exec() 2.463 right after having forked the child process. 2.464 The 2.465 @@ -1672,7 +1698,7 @@ 2.466 .Fu fork() 2.467 calls in the code were wrapped into loops to retry the 2.468 .Fu fork() 2.469 -several times, to increase the changes to succeed, eventually. 2.470 +several times, to increase the chances to succeed, eventually. 2.471 On modern systems, a failing 2.472 .Fu fork() 2.473 call is unusual. 2.474 @@ -1695,7 +1721,7 @@ 2.475 header fields is removed in mmh. 2.476 .Ci 064527f7b57ab050e5af13e15ad99aeeab125857 2.477 .BU 2.478 -Native support for 2.479 +The native support for 2.480 .Hd Face 2.481 header fields has been removed, as well. 2.482 .Ci 8e5be81f784682822f5e868c1bf3c8624682bd23 2.483 @@ -1706,7 +1732,7 @@ 2.484 Instead of encoding the image data directly into the header field, 2.485 it contains the hostname and UDP port where the image 2.486 date can be retrieved. 2.487 -There exists even a third Face system, 2.488 +There is even a third Face system, 2.489 which is the successor of 2.490 .Hd X-Face , 2.491 although it re-uses the 2.492 @@ -1750,9 +1776,9 @@ 2.493 but uses a different message delimiter (`\fL\\1\\1\\1\\1\fP', 2.494 commonly written as `\fL^A^A^A^A\fP', instead of `\fLFrom\0\fP'). 2.495 Mbox is the de-facto standard maildrop format on Unix, 2.496 -whereas the MMDF maildrop format became forgotten. 2.497 -I did drop MMDF maildrop format support. 2.498 -Mbox is the only packed mailbox format supported in mmh. 2.499 +whereas the MMDF maildrop format is now forgotten. 2.500 +By dropping the MMDF maildrop format support, 2.501 +mbox became the only packed mailbox format supported in mmh. 2.502 .P 2.503 The simplifications within the code were moderate. 2.504 Mainly, the reading and writing of MMDF mailbox files was removed. 2.505 @@ -1773,9 +1799,6 @@ 2.506 is heavily optimized and thus dangerous to touch. 2.507 The risk of damaging the intricate workings of the optimized code is 2.508 too high. 2.509 -.\" XXX: move somewhere else 2.510 -This problem is known to the developers of nmh, too. 2.511 -They also avoid touching this minefield. 2.512 2.513 2.514 .U3 "Prompter's Control Keys 2.515 @@ -1812,11 +1835,8 @@ 2.516 .P 2.517 More of a funny anecdote is a check for being connected to a 2.518 hardcopy terminal. 2.519 -It remained in the code until Spring 2012, when I finally removed it 2.520 +It remained in the code until spring 2012, when I finally removed it 2.521 .Ci b7764c4a6b71d37918a97594d866258f154017ca . 2.522 -I would be truly happy to see such a terminal in action today, 2.523 -maybe even being able to work on it. 2.524 -But I fear my chances are null. 2.525 .P 2.526 The check only prevented a pager to be placed between the printing 2.527 program (\c 2.528 @@ -1831,7 +1851,7 @@ 2.529 .Ev PAGER 2.530 to 2.531 .Pn cat 2.532 -does the job. 2.533 +is sufficient. 2.534 2.535 2.536 2.537 @@ -1859,7 +1879,9 @@ 2.538 MH's MIME support is a direct implementation of the RFCs. 2.539 The perception of the topic described in the RFCs is clearly visible 2.540 in MH's implementation. 2.541 -In result, MH had all the MIME features but no idea of attachments. 2.542 +.\" XXX rewrite ``no idea''. 2.543 +As a result, 2.544 +MH had all the MIME features but no idea of attachments. 2.545 But users don't need all the MIME features, 2.546 they want convenient attachment handling. 2.547 2.548 @@ -1873,8 +1895,8 @@ 2.549 .Fn docs/README-ATTACHMENTS , 2.550 he described his motivation to do so as such: 2.551 .QS 2.552 -Although nmh contains the necessary functionality for MIME message handing, 2.553 -the interface to this functionality is pretty obtuse. 2.554 +Although nmh contains the necessary functionality for MIME message 2.555 +handing [sic!], the interface to this functionality is pretty obtuse. 2.556 There's no way that I'm ever going to convince my partner to write 2.557 .Pn mhbuild 2.558 composition files! 2.559 @@ -1909,7 +1931,7 @@ 2.560 It is pre-defined to 2.561 .Hd Attach . 2.562 .P 2.563 -To add an attachment to a draft, simply add an attachment header: 2.564 +To add an attachment to a draft, a header line needs to be added: 2.565 .VS 2.566 To: bob 2.567 Subject: The file you wanted 2.568 @@ -1927,7 +1949,7 @@ 2.569 Drafts with attachment headers are converted to MIME automatically by 2.570 .Pn send . 2.571 The conversion to MIME is invisible to the user. 2.572 -The draft stored in the draft folder is always in source form, with 2.573 +The draft stored in the draft folder is always in source form with 2.574 attachment headers. 2.575 If the MIMEification fails, for instance because the file to attach 2.576 is not accessible, the original draft is not changed. 2.577 @@ -1936,7 +1958,7 @@ 2.578 If the attachment header value starts with a plus character (`+'), 2.579 like in 2.580 .Cl "Attach: +bob 30 42" , 2.581 -The given messages in the specified folder will be attached. 2.582 +the given messages in the specified folder will be attached. 2.583 This allowed to simplify 2.584 .Pn forw . 2.585 .Ci f41f04cf4ceca7355232cf7413e59afafccc9550 2.586 @@ -1951,7 +1973,7 @@ 2.587 .Pe automimeproc 2.588 profile entry could be specified to have the `mime' command invoked 2.589 automatically each time. 2.590 -Unfortunately, this approach conflicted with with attachment system 2.591 +Unfortunately, this approach conflicted with attachment system 2.592 because the draft would already be in MIME format at the time 2.593 when the attachment system wanted to MIMEify it. 2.594 To use nmh's attachment system, `mime' must not be called at the 2.595 @@ -1968,9 +1990,10 @@ 2.596 There is no `mime' command at the WhatNow prompt anymore. 2.597 The draft will be converted automatically to MIME when either an 2.598 attachment header or non-ASCII text is present. 2.599 -Further more, the special meaning of the hash character (`#') 2.600 -at line beginnings in the draft message is removed. 2.601 -Users need not at all deal with the whole topic. 2.602 +Furthermore, the hash character (`#') is not special any more 2.603 +at line beginnings in the draft message. 2.604 +.\" XXX REF ? 2.605 +Users need not concern themselves with the whole topic at all. 2.606 .P 2.607 Although the new approach does not anymore support arbitrary MIME 2.608 compositions directly, the full power of 2.609 @@ -1985,18 +2008,17 @@ 2.610 Because the resulting draft does neither contain non-ASCII characters 2.611 nor has it attachment headers, the attachment system will not touch it. 2.612 .P 2.613 -The approach taken in mmh is tailored towards todays most common case: 2.614 -a text part with possibly attachments. 2.615 -This case is simplified a lot for users. 2.616 +The approach taken in mmh is tailored towards today's most common case: 2.617 +a text part, possibly with attachments. 2.618 +This case was simplified. 2.619 2.620 2.621 .U3 "MIME Type Guessing 2.622 .P 2.623 -The use of 2.624 +From the programmer's point of view, the use of 2.625 .Pn mhbuild 2.626 -composition drafts had one notable advantage over attachment headers 2.627 -from the programmer's point of view: The user provides the appropriate 2.628 -MIME types for files to include. 2.629 +composition drafts had one notable advantage over attachment headers: 2.630 +The user provides the appropriate MIME types for files to include. 2.631 The attachment system needs to find out the correct MIME type itself. 2.632 This is a difficult task, yet it spares the user irritating work. 2.633 Determining the correct MIME type of content is partly mechanical, 2.634 @@ -2026,7 +2048,7 @@ 2.635 Nevertheless, modern versions of GNU 2.636 .Pn file , 2.637 which is prevalent on the popular GNU/Linux systems, 2.638 -provides MIME type output in machine-readable form. 2.639 +provide MIME type output in machine-readable form. 2.640 Although this solution is highly system-dependent, 2.641 it solves the difficult problem well. 2.642 On systems where GNU 2.643 @@ -2050,8 +2072,8 @@ 2.644 `application/octet-stream'. 2.645 It is not possible in mmh to override the automatic MIME type guessing 2.646 for a specific file. 2.647 -To do so, the user would need to know in advance for which file 2.648 -the automatic guessing does fail, or the system would require interaction. 2.649 +To do so, either the user would need to know in advance for which file 2.650 +the automatic guessing fails, or the system would require interaction. 2.651 I consider both cases impractical. 2.652 The existing solution should be sufficient. 2.653 If not, the user may always fall back to 2.654 @@ -2136,9 +2158,8 @@ 2.655 Users will likely need to invoke 2.656 .Pn mhstore 2.657 a second time with 2.658 -.Sw -force 2.659 -then. 2.660 -Eventually, only the user can decide in the concrete case. 2.661 +.Sw -force . 2.662 +Eventually, only the user can decide in the specific case. 2.663 This requires interaction, which I like to avoid if possible. 2.664 Appending a unique suffix to the filename is another bad option. 2.665 For now, the behavior remains as it is. 2.666 @@ -2149,15 +2170,16 @@ 2.667 mode. 2.668 Instead of storing message/rfc822 parts as files to disk, 2.669 they are stored as messages into the current mail folder. 2.670 -The same applies to message/partial, only, the parts are reassembled 2.671 -automatically before. 2.672 -Parts of type message/external-body are not automatically retrieved 2.673 -anymore. Instead, Information on how to retrieve them is output. 2.674 +The same applies to message/partial, although the parts are 2.675 +automatically reassembled beforehand. 2.676 +MIME parts of type message/external-body are not automatically retrieved 2.677 +anymore. 2.678 +Instead, information on how to retrieve them is output. 2.679 Not supporting this rare case saved nearly one thousand lines of code. 2.680 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32 2.681 .\" XXX mention somewhere else too: (The profile entry `nmh-access-ftp' 2.682 .\" and sbr/ruserpass.c for reading ~/.netrc are gone now.) 2.683 -Not special anymore is `application/octet-stream; type=tar'. 2.684 +`application/octet-stream; type=tar' is not special anymore. 2.685 Automatically extracting such MIME parts had been the dangerous part 2.686 of the 2.687 .Sw -auto 2.688 @@ -2186,7 +2208,7 @@ 2.689 .Pn mhshow 's 2.690 behavior to the modern view on the topic. 2.691 .P 2.692 -Note that this section completely ignores the original 2.693 +One should note that this section completely ignores the original 2.694 .Pn show 2.695 program, because it was not capable to display MIME messages 2.696 and is no longer part of mmh. 2.697 @@ -2197,6 +2219,7 @@ 2.698 in mmh, this section uses the name 2.699 .Pn mhshow , 2.700 in order to avoid confusion. 2.701 +.\" XXX ref to other section 2.702 .P 2.703 In mmh, the basic idea is that 2.704 .Pn mhshow
3.1 --- a/intro.roff Sun Jul 08 17:25:35 2012 +0200 3.2 +++ b/intro.roff Mon Jul 09 11:16:30 2012 +0200 3.3 @@ -19,6 +19,7 @@ 3.4 .P 3.5 MH is a conceptual email system design and its concrete implementation. 3.6 Notably, MH had started as a design proposal at RAND Corporation, 3.7 +.\" XXX ref to rand corp. 3.8 where the first implementation followed later. 3.9 In spirit, MH is similar to Unix, which 3.10 influenced the world more in being a set of system design concepts 3.11 @@ -153,7 +154,7 @@ 3.12 peek mh book 3.13 .], Part II] 3.14 Rose and Romine provide a deeper and more technical 3.15 -though slightly outdated introduction in only about two dozens pages. 3.16 +though slightly outdated introduction in only about two dozen pages. 3.17 .[ 3.18 rose romine real work 3.19 .] 3.20 @@ -203,6 +204,7 @@ 3.21 While clearly separated on the outside, 3.22 the programs turned out to be fairly interweaved inside. 3.23 .\" XXX FIXME rewrite... 3.24 +.\" nicht zweimal ``interweaved'' 3.25 .\" Unfortunately, the clear separation on the outside turned out to be 3.26 .\" fairly interweaved inside. 3.27 .P 3.28 @@ -213,7 +215,7 @@ 3.29 such approaches, but unfortunately, it led to duplicated functions 3.30 and half-hearted implementation of the concepts. 3.31 .P 3.32 -To provide backward-compatibility, it is a common understanding to not 3.33 +To provide backward-compatibility, it is a common understanding not to 3.34 change the default settings. 3.35 In consequence, the user needs to activate modern features explicitly 3.36 to be able to use them. 3.37 @@ -224,6 +226,7 @@ 3.38 emailing. 3.39 The small but mature community around nmh needs few change 3.40 as they have had their convenient setups for decades. 3.41 +.\" XXX Explain more 3.42 3.43 3.44 .H1 "mmh 3.45 @@ -251,10 +254,12 @@ 3.46 emphasizing that the project follows my visions and preferences. 3.47 (My login name is \fImeillo\fP.) 3.48 This project model was inspired by \fIdwm\fP, 3.49 +.\" XXX Ref 3.50 which is Anselm Garbe's personal window manager \(en 3.51 targeted to satisfy Garbe's personal needs whenever conflicts appear. 3.52 Dwm had retained its lean elegance and its focused character, whereas 3.53 its community-driven predecessor \fIwmii\fP had grown fat over time. 3.54 +.\" XXX ref 3.55 The development of mmh should remain focused. 3.56 3.57 3.58 @@ -311,7 +316,7 @@ 3.59 ideas can be implemented and demonstrated, 3.60 without the need to change nmh or its community. 3.61 Of course, the results of the mmh project shall improve nmh, in the end. 3.62 -By no means is my intend to work against the nmh project. 3.63 +By no means it is my intent to work against the nmh project. 3.64 3.65 3.66 .U2 "Target Field 3.67 @@ -339,7 +344,7 @@ 3.68 .P 3.69 The typical users invoke mmh commands directly in an interactive 3.70 shell session, but they use them to automate mail handling tasks as well. 3.71 -Likely, they runs their mail setup on a server machine, 3.72 +Likely, they run their mail setup on a server machine, 3.73 to which they connect via ssh. 3.74 They might also have local mmh installations on their workstations, 3.75 where they tend to work with mmh directly in the shell instead 3.76 @@ -381,7 +386,7 @@ 3.77 .IP "Modernizing 3.78 Mmh's feature set needs to become more modern. 3.79 Better support for attachment and digital cryptography should be added. 3.80 -MIME support should to be integrated deeper and more naturally. 3.81 +MIME support should be integrated deeper and more naturally. 3.82 The modern email features need to be readily available, out-of-the-box. 3.83 On the other hand, 3.84 bulletin board support and similar obsolete facilities can be dropped out.
4.1 --- a/preface.roff Sun Jul 08 17:25:35 2012 +0200 4.2 +++ b/preface.roff Mon Jul 09 11:16:30 2012 +0200 4.3 @@ -46,7 +46,7 @@ 4.4 I took one semester off to travel through Latin America. 4.5 During my time in Argentina, I wanted to work on Free Software. 4.6 This brought me back to nmh. 4.7 -Richard Sandelman, an active nmh user, cared for the official basis. 4.8 +Richard Sandelman, an active nmh user, took care of the official basis. 4.9 Juan Granda, an Argentine Free Software developer, 4.10 provided a computer with Internet connection. 4.11 Thanks to them, I was able to work on nmh during my three-month