docs/master
view ch03.roff @ 95:edac7e46a9f2
More text about switches.
| author | markus schnalke <meillo@marmaro.de> |
|---|---|
| date | Sat, 16 Jun 2012 13:26:30 +0200 |
| parents | 093ccf39a45e |
| children | 12348d620245 |
line source
1 .H0 "Discussion
2 .P
3 This main chapter discusses the practical work done in the mmh project.
4 It is structured along the goals to achieve. The concrete work done
5 is described in the examples of how the general goals were achieved.
6 The discussion compares the current version of mmh with the state of
7 nmh just before the mmh project started, i.e. Fall 2011.
8 Current changes of nmh will be mentioned only as side notes.
9 .\" XXX where do I discuss the parallel development of nmh?
13 .H1 "Stream-lining
15 .P
16 MH had been considered an all-in-one system for mail handling.
17 The community around nmh has a similar understanding.
18 In fundamental difference, mmh shall be a MUA only.
19 I believe that the development of all-in-one mail systems is obsolete.
20 Today, email is too complex to be fully covered by single projects.
21 Such a project won't be able to excel in all aspects.
22 Instead, the aspects of email should be covered my multiple projects,
23 which then can be combined to form a complete system.
24 Excellent implementations for the various aspects of email exist already.
25 Just to name three examples: Postfix is a specialized MTA,
26 Procmail is a specialized MDA, and Fetchmail is a specialized MRA.
27 I believe that it is best to use such specialized tools instead of
28 providing the same function again as a side-component in the project.
29 .P
30 Doing something well, requires to focus on a small set of specific aspects.
31 Under the assumption that focused development produces better results
32 in the particular area, specialized projects will likely be superior
33 in their field of focus.
34 Hence, all-in-one mail system projects \(en no matter if monolithic
35 or modular \(en will never be the best choice in any of the fields.
36 Even in providing the best consistent all-in-one system they are likely
37 to be beaten by projects that focus only on integrating existing mail
38 components to a homogeneous system.
39 .P
40 The limiting resource in Free Software community development
41 is usually man power.
42 If the development power is spread over a large development area,
43 it becomes even more difficult to compete with the specialists in the
44 various fields.
45 The concrete situation for MH-based mail systems is even tougher,
46 given the small and aged community, including both developers and users,
47 it has.
48 .P
49 In consequence, I believe that the available development resources
50 should be focused on the point where MH is most unique.
51 This is clearly the user interface \(en the MUA.
52 Peripheral parts should be removed to stream-line mmh for the MUA task.
55 .H2 "Removal of the Mail Transfer Facilities
56 .P
57 In contrast to nmh, which also provides mail submission and mail retrieval
58 agents, mmh is a MUA only.
59 This general difference in the view on the character of nmh
60 initiated the development of mmh.
61 Removing the mail transfer facilities had been the first work task
62 in the mmh project.
63 .P
64 The MSA is called \fIMessage Transfer Service\fP (MTS) in nmh.
65 The facility established network connections and spoke SMTP to submit
66 messages for relay to the outside world.
67 This part was implemented by the
68 .Pn post
69 command.
70 The changes in emailing in the last years
71 demanded changes in this part of nmh too.
72 Encryption and authentication for network connections
73 needed to be supported, hence TLS and SASL were introduced into nmh.
74 This added complexity to nmh without improving it in its core functions.
75 Also, keeping up with recent developments in the field of
76 mail transfer requires development power and specialists.
77 In mmh this whole facility was simply cut off.
78 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
79 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
80 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
81 Instead, mmh depends on an external MSA.
82 The only outgoing interface available to mmh is the
83 .Pn sendmail
84 command, which almost any MSA provides.
85 If not, a wrapper program can be written.
86 It must read the message from the standard input, extract the
87 recipient addresses from the message header, and hand the message
88 over to the MSA.
89 For example, a wrapper script for qmail would be:
90 .VS
91 #!/bin/sh
92 # ignore command line arguments
93 exec qmail-inject
94 VE
95 The requirement to parse the recipient addresses out of the message header
96 is likely to be removed in the future.
97 Then mmh would give the recipient addresses as command line arguments.
98 This is clearly the better interface, but mmh does not provide it yet.
99 .\" XXX implement it
100 .P
101 To retrieve mail, the
102 .Pn inc
103 command established network connections
104 and spoke POP3 to retrieve mail from remote servers.
105 As with mail submission, the network connections required encryption and
106 authentication, thus TLS and SASL were added.
107 Support for message retrieval through IMAP will become necessary
108 to be added soon, too, and so on for any changes in mail transfer.
109 Mmh has dropped the support for retrieving mail from remote locations.
110 .Ci ab7b48411962d26439f92f35ed084d3d6275459c
111 Instead, it depends on an external tool to cover this task.
112 In mmh there exist two paths for messages to enter mmh's mail storage:
113 (1) Mail can be incorporate with
114 .Pn inc
115 from the system maildrop, or (2) with
116 .Pn rcvstore
117 by reading them, one at a time, from the standard input.
118 .P
119 With the removal of the MSA and MRA, mmh converted from an all-in-one
120 mail system to being a MUA only.
121 Following the Unix philosophy, it now focuses on one job and
122 tries to do that one well.
123 Not only the programs follow that tenet but also the project itself does so.
124 Now, of course, mmh depends on third-party software.
125 An external MSA is required to transfer mail to the outside world;
126 an external MRA is required to retrieve mail from remote machines.
127 There exist excellent implementations of such software,
128 which do this specific task likely better than the internal
129 versions had done it.
130 Also, the best suiting programs can be freely chosen.
131 .P
132 As it had already been possible to use an external MSA or MRA,
133 why not keep the internal version for convenience?
134 The question whether there is sense in having a fall-back pager in all
135 the command line tools, for the cases when
136 .Pn more
137 or
138 .Pn less
139 aren't available, appears to be ridiculous.
140 Now, an MSA or MRA is more complex than a text pager
141 and not necessarily available but still the concept of orthogonal
142 design holds: ``Write programs that do one thing and do it well.''
143 .[
144 mcilroy unix phil
145 p. 53
146 .]
147 .[
148 mcilroy bstj foreword
149 .]
150 Here, this part of the Unix philosophy was applied not only
151 to the programs but to the project itself.
152 In other words:
153 ``Develop projects that focus on one thing and do it well.''
154 Projects grown complex should be split for the same reasons programs grown
155 complex should be split.
156 If it is conceptionally more elegant to have the MSA and MRA
157 separate projects then they should be separated.
158 This is the case here, in my opinion.
159 The RFCs propose this separation by clearly distinguishing the different
160 mail handling tasks.
161 .[
162 rfc 821
163 .]
164 The small interfaces between the mail agents support the separation.
165 .P
166 In the beginning, email had been small and simple.
167 (\c
168 .Pn /bin/mail
169 had once covered anything there was to email and still had been small
170 and simple.)
171 Then the essential complexity of email increased.
172 (Essential complexity is the complexity defined by the problem itself.\0
173 .[[
174 brooks no silver bullet
175 .]])
176 Email systems reacted to this change: They grew.
177 RFCs started to introduce mail agents and separated the various tasks
178 because the existing tasks became more extensive and new tasks appeared.
179 Again, email systems grew, or they split parts off.
180 In nmh, for instance, the POP server, which the original MH had included,
181 was removed.
182 Now is the time to go one step further and remove the MSA and MRA, too.
183 Not only does this decrease the code size of the project,
184 but, more important, it unburdens mmh of the whole field of
185 message transfer with all its implications for the project.
186 There's no more need to concern with changes in network transfer.
187 This independence is received by depending on an external program
188 that covers the field.
189 Today, this is a reasonable exchange.
190 .P
191 Function can be added in three different ways:
192 .BU
193 Implementing the function originally in the project.
194 .BU
195 Depending on a library that provides the function.
196 .BU
197 Depending on a program that provides the function.
198 .P
199 Whereas adding the function originally to the project increases the
200 code size most and requires most maintenance and development work,
201 it makes the project most independent of other software.
202 Using libraries or external programs require less maintenance work
203 but introduces dependencies on external software.
204 Programs have the smallest interfaces and provide the best separation
205 but possibly limit the information exchange.
206 External libraries are stronger connected than external programs,
207 thus information can be exchanged more flexible.
208 Adding code to a project increases maintenance work.
209 .\" XXX ref
210 Implementing complex functions originally in the project will add
211 a lot of code.
212 This should be avoided if possible.
213 Hence, the dependencies only change in kind, not in their existence.
214 In mmh, library dependencies on
215 .Pn libsasl2
216 and
217 .Pn libcrypto /\c
218 .Pn libssl
219 were treated against program dependencies on an MSA and an MRA.
220 This also meant treating build-time dependencies against run-time
221 dependencies.
222 Besides program dependencies providing the stronger separation
223 and being more flexible, they also allowed
224 over 6\|000 lines of code to be removed from mmh.
225 This made mmh's code base about 12\|% smaller.
226 Reducing the project's code size by such an amount without actually
227 losing functionality is a convincing argument.
228 Actually, as external MSAs and MRAs are likely superior to the
229 project's internal versions, the common user even gains functionality.
230 .P
231 Users of MH should not have problems to set up an external MSA and MRA.
232 Also, the popular MSAs and MRAs have large communities and a lot
233 of documentation available.
234 Choices for MSAs range from full-featured MTAs like
235 .I Postfix
236 over mid-size MTAs like
237 .I masqmail
238 and
239 .I dma
240 to small forwarders like
241 .I ssmtp
242 and
243 .I nullmailer .
244 Choices for MRAs include
245 .I fetchmail ,
246 .I getmail ,
247 .I mpop
248 and
249 .I fdm .
252 .H2 "Removal of non-MUA Tools
253 .P
254 One goal of mmh is to remove the tools that are not part of the MUA's task.
255 Further more, any tools that don't improve the MUA's job significantly
256 should be removed.
257 Loosely related and rarely used tools distract from the lean appearance.
258 They require maintenance work without adding much to the core task.
259 On removing these tools, the project shall become more stream-lined
260 and focused.
261 In mmh the following tools are not available anymore:
262 .BU
263 .Pn conflict
264 was removed
265 .Ci 8b235097cbd11d728c07b966cf131aa7133ce5a9
266 because it is a mail system maintenance tool that is not MUA-related.
267 It even checked
268 .Fn /etc/passwd
269 and
270 .Fn /etc/group
271 for consistency, which is completely unrelated to email.
272 A tool like
273 .Pn conflict
274 is surely useful, but it should not be shipped with mmh.
275 .\" XXX historic reasons?
276 .BU
277 .Pn rcvtty
278 was removed
279 .Ci 14767c94b3827be7c867196467ed7aea5f6f49b0
280 because its use case of writing to the user's terminal
281 on receiving of mail is obsolete.
282 If users like to be informed of new mail, the shell's
283 .Ev MAILPATH
284 variable or graphical notifications are technically more appealing.
285 Writing directly to a terminals is hardly ever wanted today.
286 If though one wants to have it this way, the standard tool
287 .Pn write
288 can be used in a way similar to:
289 .VS
290 scan -file - | write `id -un`
291 VE
292 .BU
293 .Pn viamail
294 was removed
295 .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932
296 when the new attachment system was activated, because
297 .Pn forw
298 could then cover the task itself.
299 The program
300 .Pn sendfiles
301 was rewritten as a shell script wrapper around
302 .Pn forw .
303 .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6
304 .BU
305 .Pn msgchk
306 was removed
307 .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe ,
308 because it lost its use case when POP support was removed.
309 A call to
310 .Pn msgchk
311 provided hardly more information than:
312 .VS
313 ls -l /var/mail/meillo
314 VE
315 It did distinguished between old and new mail, but
316 this detail information and can be retrieved with
317 .Pn stat (1),
318 too.
319 A very small shell script could be written to output the information
320 in a similar way, if truly necessary.
321 As mmh's
322 .Pn inc
323 only incorporates mail from the user's local maildrop,
324 and thus no data transfers over slow networks are involved,
325 there's hardly any need to check for new mail before incorporating it.
326 .BU
327 .Pn msh
328 was removed
329 .Ci 916690191222433a6923a4be54b0d8f6ac01bd02
330 because the tool was in conflict with the philosophy of MH.
331 It provided an interactive shell to access the features of MH,
332 but it wasn't just a shell, tailored to the needs of mail handling.
333 Instead it was one large program that had several MH tools built in.
334 This conflicts with the major feature of MH of being a tool chest.
335 .Pn msh 's
336 main use case had been accessing Bulletin Boards, which have seized to
337 be popular.
338 .P
339 Removing
340 .Pn msh ,
341 together with the truly archaic code relicts
342 .Pn vmh
343 and
344 .Pn wmh ,
345 saved more than 7\|000 lines of C code \(en
346 about 15\|% of the project's original source code amount.
347 .P
348 Having less code (with equal readability, of course)
349 for the same functionality is an advantage.
350 Less code means less bugs and less maintenance work.
351 As
352 .Pn rcvtty
353 and
354 .Pn msgchk
355 are assumed to be rarely used and can be implemented in different ways,
356 why should one keep them?
357 Removing them stream-lines mmh.
358 .Pn viamail 's
359 use case is now partly obsolete and partly covered by
360 .Pn forw ,
361 hence there's no reason to still maintain it.
362 .Pn conflict
363 is not related to the mail client, and
364 .Pn msh
365 conflicts with the basic concept of MH.
366 Theses two tools might still be useful, but they should not be part of mmh.
367 .P
368 Finally, there's
369 .Pn slocal .
370 .Pn slocal
371 is an MDA and thus not directly MUA-related.
372 It should be removed, because including it is a violation
373 of the idea that mmh is a MUA only.
374 It should become a separate project.
375 However,
376 .Pn slocal
377 provides rule-based processing of messages, like filing them into
378 different folders, which is otherwise not available in mmh.
379 Although
380 .Pn slocal
381 does neither pull in dependencies nor does it include a separate
382 technical area (cf. Sec. XXX),
383 still it accounts for about 1\|000 lines of code that need to be maintained.
384 As
385 .Pn slocal
386 is almost self-standing, it should be split off into a separate project.
387 This would cut the strong connection between the MUA mmh and the MDA
388 .Pn slocal .
389 For anyone not using MH,
390 .Pn slocal
391 would become yet another independent MDA, like
392 .I procmail .
393 The need to install a complete MH system to have
394 .Pn slocal
395 would be gone.
396 Likewise, mmh users could decide to use
397 .I procmail
398 without having a second, unused MDA,
399 .Pn slocal ,
400 installed.
401 That's conceptionally the best solution.
402 Yet,
403 .Pn slocal
404 is not split off.
405 I feel unsure with removing it from mmh.
406 Hence, I defer the decision over
407 .Pn slocal .
408 In the meanwhile
409 .Pn slocal
410 does not hurt because it is unrelated to the rest of mmh.
413 .H2 "\fLshow\fP and \fPmhshow\fP
414 .P
415 Since the very beginning \(en already in the first concept paper \(en
416 .Pn show
417 had been MH's message display program.
418 .Pn show
419 mapped message numbers and sequences to files and invoked
420 .Pn mhl
421 to have the files formatted.
422 With MIME, this approach wasn't sufficient anymore.
423 MIME messages can consist of multiple parts, some of which aren't
424 directly displayable, further more text content might be encoded in
425 foreign charsets.
426 .Pn show 's
427 understanding of messages and
428 .Pn mhl 's
429 display capabilities couldn't cope with the task any longer.
430 .P
431 Instead of extending these tools, additional tools were written from
432 scratch and added to the MH tool chest.
433 Doing so is encouraged by the tool chest approach.
434 Modular design is a great advantage for extending a system,
435 as new tools can be added without interfering with existing ones.
436 First, the new MIME features were added in form of the single program
437 .Pn mhn .
438 The command
439 .Cl "mhn -show 42
440 would show the MIME message numbered 42.
441 With the 1.0 release of nmh in February 1999, Richard Coleman finished
442 the split of
443 .Pn mhn
444 into a set of specialized tools, which together covered the
445 multiple aspects of MIME.
446 One of them was
447 .Pn mhshow ,
448 which replaced
449 .Cl "mhn -show" .
450 It was capable of displaying MIME messages appropriately.
451 .P
452 From then on, two message display tools were part of nmh,
453 .Pn show
454 and
455 .Pn mhshow .
456 To ease the life of users,
457 .Pn show
458 was extended to automatically hand the job over to
459 .Pn mhshow
460 if displaying the message would be beyond
461 .Pn show 's
462 abilities.
463 In consequence, the user would simply invoke
464 .Pn show
465 (possibly through
466 .Pn next
467 or
468 .Pn prev )
469 and get the message printed with either
470 .Pn show
471 or
472 .Pn mhshow ,
473 whatever was more appropriate.
474 .P
475 Having two similar tools for essentially the same task is redundant.
476 Usually,
477 users wouldn't distinguish between
478 .Pn show
479 and
480 .Pn mhshow
481 in their daily mail reading.
482 Having two separate display programs was therefore mainly unnecessary
483 from a user's point of view.
484 Besides, the development of both programs needed to be in sync,
485 to ensure that the programs behaved in a similar way,
486 because they were used like a single tool.
487 Different behavior would have surprised the user.
488 .P
489 Today, non-MIME messages are rather seen to be a special case of
490 MIME messages, although it's the other way round.
491 As
492 .Pn mhshow
493 had already be able to display non-MIME messages, it appeared natural
494 to drop
495 .Pn show
496 in favor of using
497 .Pn mhshow
498 exclusively.
499 .Ci 4c1efddfd499300c7e74263e57d8aa137e84c853
500 Removing
501 .Pn show
502 is no loss in function, because functionally
503 .Pn mhshow
504 covers it completely.
505 The old behavior of
506 .Pn show
507 can still be emulated with the simple command line:
508 .VS
509 mhl `mhpath c`
510 VE
511 .P
512 For convenience,
513 .Pn mhshow
514 was renamed to
515 .Pn show
516 after
517 .Pn show
518 was gone.
519 It is clear that such a rename may confuse future developers when
520 trying to understand the history.
521 Nevertheless, I consider the convenience on the user's side,
522 to call
523 .Pn show
524 when they want a message to be displayed, to outweigh the inconvenience
525 on the developer's side when understanding the project history.
526 .P
527 To prepare for the transition,
528 .Pn mhshow
529 was reworked to behave more like
530 .Pn show
531 first.
532 (cf. Sec. XXX)
533 Once the tools behaved more alike, the replacing appeared to be
534 even more natural.
535 Today, mmh's new
536 .Pn show
537 became the one single message display program again, with the difference
538 that today it handles MIME messages as well as non-MIME messages.
539 The outcome of the transition is one program less to maintain,
540 no second display program for users to deal with,
541 and less system complexity.
542 .P
543 Still, removing the old
544 .Pn show
545 hurts in one regard: It had been such a simple program.
546 Its lean elegance is missing to the new
547 .Pn show .
548 But there is no chance;
549 supporting MIME demands for higher essential complexity.
552 .H2 "Removal of Configure Options
553 .P
554 Customization is a double-edged sword.
555 It allows better suiting setups, but not for free.
556 There is the cost of code complexity to be able to customize.
557 There is the cost of less tested setups, because there are
558 more possible setups and especially corner-cases.
559 And, there is the cost of choice itself.
560 The code complexity directly affects the developers.
561 Less tested code affects both, users and developers.
562 The problem of choice affects the users, for once by having to
563 choose, but also by complexer interfaces that require more documentation.
564 Whenever options add little advantages, they should be considered for
565 removal.
566 I have reduced the number of project-specific configure options from
567 fifteen to three.
569 .U3 "Mail Transfer Facilities
570 .P
571 With the removal of the mail transfer facilities five configure
572 options vanished:
573 .P
574 The switches
575 .Sw --with-tls
576 and
577 .Sw --with-cyrus-sasl
578 had activated the support for transfer encryption and authentication.
579 This is not needed anymore.
580 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
581 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
582 .P
583 The configure switch
584 .Sw --enable-pop
585 activated the message retrieval facility.
586 The code area that would be conditionally compiled in for TLS and SASL
587 support had been small.
588 The conditionally compiled code area for POP support had been much larger.
589 Whereas the code base changes would only slightly change on toggling
590 TLS or SASL support, it changed much on toggling POP support.
591 The changes in the code base could hardly be overviewed.
592 By having POP support togglable a second code base had been created,
593 one that needed to be tested.
594 This situation is basically similar for the conditional TLS and SASL
595 code, but there the changes are minor and can yet be overviewed.
596 Still, conditional compilation of a code base creates variations
597 of the original program.
598 More variations require more testing and maintenance work.
599 .P
600 Two other options only specified default configuration values:
601 .Sw --with-mts=[smtp|sendmail]
602 defined the default transport service.
603 In mmh this fixed to
604 .Ar sendmail .
605 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
606 With
607 .Sw --with-smtpservers=[server1...]
608 default SMTP servers for the
609 .Ar smtp
610 transport service could be specified.
611 .Ci 128545e06224233b7e91fc4c83f8830252fe16c9
612 Both of them became irrelevant.
614 .U3 "Backup Prefix
615 .P
616 The backup prefix is the string that was prepended to message
617 filenames to tag them as deleted.
618 By default it had been the comma character `\f(CW,\fP'.
619 In July 2000, Kimmo Suominen introduced
620 the configure option
621 .Sw --with-hash-backup
622 to change the default to the hash symbol `\f(CW#\fP'.
623 The choice was probably personal preference, because first, the
624 option was named
625 .Sw --with-backup-prefix.
626 and had the prefix symbol as argument.
627 Because giving the hash symbol as argument caused to many problems
628 for configure,
629 the option was limited to use the hash symbol as the default prefix.
630 This makes me believe, that the choice for the hash was personal preference.
631 Being it related or not, words that start with the hash symbol
632 introduce a comment in the Unix shell.
633 Thus, the command line
634 .Cl "rm #13 #15
635 calls
636 .Pn rm
637 without arguments because the first hash symbol starts the comment
638 that reaches until the end of the line.
639 To delete the backup files,
640 .Cl "rm ./#13 ./#15"
641 needs to be used.
642 Using the hash as backup prefix can be seen as a precaution agains
643 data loss.
644 .P
645 I removed the configure option but added the profile entry
646 .Pe backup-prefix ,
647 which allows to specify an arbitrary string as backup prefix.
648 .Ci 6c40d481d661d532dd527eaf34cebb6d3f8ed086
649 Profile entries are the common method to change mmh's behavior.
650 This change did not remove the choice but moved it to a location where
651 it suited better.
652 .P
653 Eventually, however, the new trash folder concept
654 .Cf "Sec. XXX
655 obsoleted the concept of the backup prefix completely.
656 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
657 (Well, there still are corner-cases to remove until the backup
658 prefix can be laid to rest, eventually.)
659 .\" FIXME: Do this work in the code!
661 .U3 "Editor and Pager
662 .P
663 The two configure options
664 .CW --with-editor=EDITOR
665 .CW --with-pager=PAGER
666 were used to specify the default editor and pager at configure time.
667 Doing so at configure time made sense in the Eighties,
668 when the set of available editors and pagers varied much across
669 different systems.
670 Today, the situation is more homogeneous.
671 The programs
672 .Pn vi
673 and
674 .Pn more
675 can be expected to be available on every Unix system,
676 as they are specified by POSIX since two decades.
677 (The specifications for
678 .Pn vi
679 and
680 .Pn more
681 appeared in
682 .[
683 posix 1987
684 .]
685 and,
686 .[
687 posix 1992
688 .]
689 respectively.)
690 As a first step, these two tools were hard-coded as defaults.
691 .Ci 5d43a99db70c12a673028c7758c20cbe3e13ef5f
692 Not changed were the
693 .Pe editor
694 and
695 .Pe moreproc
696 profile entries, which allowed the user to override the system defaults.
697 Later, the concept was reworked to respect the standard environment
698 variables
699 .Ev VISUAL
700 and
701 .Ev PAGER
702 if they are set.
703 Today, mmh determines the editor to use in the following order,
704 taking the first available and non-empty item:
705 .IP (1)
706 Environment variable
707 .Ev MMHEDITOR
708 .IP (2)
709 Profile entry
710 .Pe Editor
711 .IP (3)
712 Environment variable
713 .Ev VISUAL
714 .IP (4)
715 Environment variable
716 .Ev EDITOR
717 .IP (5)
718 Command
719 .Pn vi .
720 .P
721 .Ci f85f4b7ae62e3d05a945dcd46ead51f0a2a89a9b
722 .P
723 The pager to use is determined in a similar order,
724 also taking the first available and non-empty item:
725 .IP (1)
726 Environment variable
727 .Ev MMHPAGER
728 .IP (2)
729 Profile entry
730 .Pe Pager
731 (replaces
732 .Pe moreproc )
733 .IP (3)
734 Environment variable
735 .Ev PAGER
736 .IP (4)
737 Command
738 .Pn more .
739 .P
740 .Ci 0c4214ea2aec6497d0d67b436bbee9bc1d225f1e
741 .P
742 By respecting the
743 .Ev VISUAL /\c
744 .Ev EDITOR
745 and
746 .Ev PAGER
747 environment variables,
748 the new behavior confirms better to the common style on Unix systems.
749 Additionally, the new approach is more uniform and clearer to users.
751 .U3 "Locale
752 .P
753 The configure option
754 .Sw --disable-locale
755 was removed because POSIX provides locale support and there's
756 hardly any need to disable locale support.
757 .Ci ccf4f175ef4c4e7522f9510a4a1149c15d810dd9
759 .U3 "ndbm
760 .P
761 .Pn slocal
762 used to depend on
763 .I ndbm ,
764 a database library.
765 The database is used to store the `\fLMessage-ID\fP's of all
766 messages delivered.
767 This enables
768 .Pn slocal
769 to suppress delivering the same message to the same user twice.
770 (This features was enabled by the
771 .Sw -suppressdup
772 switch.)
773 .P
774 A variety of version of the database library exist.
775 .[
776 wolter unix incompat notes dbm
777 .]
778 Complicated autoconf code was needed to detect them correctly.
779 Further more, the configure switches
780 .Sw --with-ndbm=ARG
781 and
782 .Sw --with-ndbmheader=ARG
783 were added to help with difficult setups that would
784 not be detected automatically or correctly.
785 .P
786 By removing the suppress duplicates feature of
787 .Pn slocal ,
788 the dependency on
789 .I ndbm
790 vanished and 120 lines of complex autoconf code could be saved.
791 .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf
792 The change removed functionality too, but that is minor to the
793 improvement by dropping the dependency and the complex autoconf code.
795 .U3 "mh-e Support
796 .P
797 The configure option
798 .Sw --disable-mhe
799 was removed when the mh-e support was reworked.
800 Mh-e is the Emacs front-end to MH.
801 It requires MH to provide minor additional functions.
802 The
803 .Sw --disable-mhe
804 configure option could switch these extensions off.
805 After removing the support for old versions of mh-e,
806 only the
807 .Sw -build
808 switches of
809 .Pn forw
810 and
811 .Pn repl
812 are left to be mh-e extensions.
813 They are now always built in because they add little code and complexity.
814 In consequence, the
815 .Sw --disable-mhe
816 configure option was removed
817 .Ci a7ce7b4a580d77b6c2c4d980812beb589aa4c643
818 Removing the option removed a second code setup that would have
819 needed to be tested.
820 This change was first done in nmh and thereafter merged into mmh.
821 .P
822 The interface changes in mmh require mh-e to be adjusted in order
823 to be able to use mmh as back-end.
824 This will require minor changes to mh-e, but removing the
825 .Sw -build
826 switches would require more rework.
828 .U3 "Masquerading
829 .P
830 The configure option
831 .Sw --enable-masquerade
832 could take up to three arguments:
833 `draft_from', `mmailid', and `username_extension'.
834 They activated different types of address masquerading.
835 All of them were implemented in the SMTP-speaking
836 .Pn post
837 command, which provided an MSA.
838 Address masquerading is an MTA's task and mmh does not cover
839 this field anymore.
840 Hence, true masquerading needs to be implemented in the external MTA.
841 .P
842 The
843 .I mmailid
844 masquerading type is the oldest one of the three and the only one
845 available in the original MH.
846 It provided a
847 .I username
848 to
849 .I fakeusername
850 mapping, based on the password file's GECOS field.
851 The man page
852 .Mp mh-tailor(5)
853 described the use case as being the following:
854 .QP
855 This is useful if you want the messages you send to always
856 appear to come from the name of an MTA alias rather than your
857 actual account name. For instance, many organizations set up
858 `First.Last' sendmail aliases for all users. If this is
859 the case, the GECOS field for each user should look like:
860 ``First [Middle] Last <First.Last>''
861 .P
862 As mmh sends outgoing mail via the local MTA only,
863 the best location to do such global rewrites is there.
864 Besides, the MTA is conceptionally the right location because it
865 does the reverse mapping for incoming mail (aliasing), too.
866 Further more, masquerading set up there is readily available for all
867 mail software on the system.
868 Hence, mmailid masquerading was removed.
869 .Ci 0836c8000ccb34b59410ef1c15b1b7feac70ce5f
870 .P
871 The
872 .I username_extension
873 masquerading type did not replace the username but would append a suffix,
874 specified by the
875 .Ev USERNAME_EXTENSION
876 environment variable, to it.
877 This provided support for the
878 .I user-extension
879 feature of qmail and the similar
880 .I "plussed user
881 processing of sendmail.
882 The decision to remove this username_extension masquerading was
883 motivated by the fact that
884 .Pn spost
885 hadn't supported it already.
886 .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9
887 Username extensions are possible in mmh, but less convenient to use.
888 .\" XXX format file %(getenv USERNAME_EXTENSION)
889 .P
890 The
891 .I draft_from
892 masquerading type instructed
893 .Pn post
894 to use the value of the
895 .Hd From
896 header field as SMTP envelope sender.
897 Sender addresses could be replaced completely.
898 .Ci b14ea6073f77b4359aaf3fddd0e105989db9
899 Mmh offers a kind of masquerading similar in effect, but
900 with technical differences.
901 As mmh does not transfer messages itself, the local MTA has final control
902 over the sender's address. Any masquerading mmh introduces may be reverted
903 by the MTA.
904 In times of pedantic spam checking, an MTA will take care to use
905 sensible envelope sender addresses to keep its own reputation up.
906 Nonetheless, the MUA can set the
907 .Hd From
908 header field and thereby propose
909 a sender address to the MTA.
910 The MTA may then decide to take that one or generate the canonical sender
911 address for use as envelope sender address.
912 .P
913 In mmh, the MTA will always extract the recipient and sender from the
914 message header (\c
915 .Pn sendmail 's
916 .Sw -t
917 switch).
918 The
919 .Hd From
920 header field of the draft may be set arbitrary by the user.
921 If it is missing, the canonical sender address will be generated by the MTA.
923 .U3 "Remaining Options
924 .P
925 Two configure options remain in mmh.
926 One is the locking method to use:
927 .Sw --with-locking=[dot|fcntl|flock|lockf] .
928 The idea of removing all methods except the portable dot locking
929 and having that one as the default is appealing, but this change
930 requires deeper technical investigation into the topic.
931 The other option,
932 .Sw --enable-debug ,
933 compiles the programs with debugging symbols and does not strip them.
934 This option is likely to stay.
939 .H2 "Removal of Switches
940 .P
941 The command line switches of MH tools follow the X Window style.
942 They are words, introduced by a single dash.
943 For example:
944 .Cl "-truncate" .
945 Every program in mmh has two generic switches:
946 .Sw -help ,
947 to print a short message on how to use the program, and
948 .Sw -Version ,
949 to tell what version of mmh the program belongs to.
950 .P
951 Switches change the behavior of programs.
952 Programs that do one thing in one way require no switches.
953 In most cases, doing something in exactly one way is too limiting.
954 If it is basically the same task to accomplish, but it should be done
955 in various ways, switches are a good approach to alter the behavior
956 of a program.
957 Changing the behavior of programs provides flexibility and customization
958 to users, but in the same way it complicates the code, documentation and
959 usage of the program.
960 Therefore, the number of switches should be kept small.
961 A small set of well-chosen switches does no harm.
962 But usually, the number of switches increases over time.
963 Already in 1985, Rose and Romine have identified this as a major
964 problem of MH:
965 .[ [
966 rose romine real work
967 .], p. 12]
968 .sp
969 .QP
970 A complaint often heard about systems which undergo substantial development
971 by many people over a number of years, is that more and more options are
972 introduced which add little to the functionality but greatly increase the
973 amount of information a user needs to know in order to get useful work done.
974 This is usually referred to as creeping featurism.
975 .QP
976 Unfortunately MH, having undergone six years of off-and-on development by
977 ten or so well-meaning programmers (the present authors included),
978 suffers mightily from this.
979 .sp
980 .P
981 Adding new switches only reluctantly is one part of the counter-action,
982 the other is removing hardly used switches.
983 Now that there are lots of switches already implemented,
984 removing some of them is more important.
985 Removing existing functionality is always difficult because it
986 breaks programs that use these functions.
987 Also, for every obsolete feature, there'll always be someone who still
988 uses it and thus opposes its removal.
989 This puts the developer into the position,
990 where sensible improvements to style are regarded as destructive acts.
991 Yet, living with the featurism is far worse, in my eyes.
992 Future needs will demand adding new features,
993 worsening the situation more and more.
994 Rose and Romine added in a footnote,
995 ``[...]
996 .Pn send
997 will no doubt acquire an endless number of switches in the years to come.''
998 Although clearly humorous, the comment displays the nature of
999 the problem.
1000 Though refusing to add any new switches would encounter the problem
1001 at its root, it is not practical.
1002 But removing obsolete switches is an effective approach to deal with the
1003 problem.
1004 Working on an experimental branch,
1005 eased this work because I had not to offend users.
1006 .P
1007 Rose and Romine counted 24 visible and 9 more hidden switches for
1008 .Pn send .
1009 At the beginning of mmh, it were 32 visible and 12 hidden ones.
1010 At the time of writing, mmh's
1011 .Pn send
1012 has 7 visible switches and 1 hidden switch.
1013 (In each of the examples, the two generic help and version switches
1014 are included.)
1015 .P
1016 Figure XXX
1017 .\" XXX Ref
1018 displays the number of switches for each of the tools that was not
1019 removed from or newly added to mmh.
1020 Both, visible and hidden switches, were counted, but
1021 not the generic help and version switches.
1022 Whereas in the beginning of the project, the average tool had 11 switches,
1023 now it has no more than 5 \(en only half as many.
1024 If the `no' switches and similar inverse variant are folded onto
1025 their counter-parts, the numbers are 8 in pre-mmh to 4 now.
1026 The total number of functional switches in mmh dropped from 465
1027 to 234.
1029 .KS
1030 .in 1c
1031 .so input/switches.grap
1032 .KE
1034 .P
1035 A part of the switches vanished after functions were removed.
1036 This was the case for network mail transfer, for instance.
1037 Sometimes the work flow was the other way:
1038 The trying to reduce the number of switches suggested the removal of
1039 functions.
1041 .U3 "Draft Folder Facility
1042 .P
1043 A change early in the project was the completely transition from
1044 the single draft message to the draft folder facility.
1045 The draft folder facility was introduced in the mid-Eighties.
1046 (Rose and Romine called it a ``relatively new feature''
1047 .[
1048 rose romine real work
1049 .]
1050 in 1985.)
1051 Since then, the facility had existed but had remained deactive by default.
1052 The default activation and the related rework of the tools made it
1053 possible to remove the
1054 .Sw -[no]draftfolder ,
1055 and
1056 .Sw -draftmessage
1057 switches from
1058 .Pn comp ,
1059 .Pn repl ,
1060 .Pn forw ,
1061 .Pn dist ,
1062 .Pn whatnow ,
1063 and
1064 .Pn send .
1065 The only flexibility removed is having multiple draft folders
1066 within one profile.
1067 I consider this only a theoretical setup.
1068 In the same go, the
1069 .Sw -draft
1070 switch of
1071 .Pn anno ,
1072 .Pn refile ,
1073 and
1074 .Pn send
1075 was removed.
1076 The special-casing of `the' draft message became irrelevant after
1077 the rework of the draft system.
1078 (See Sec. XXX.)
1079 Equally,
1080 .Pn comp
1081 lost its
1082 .Sw -file
1083 switch.
1084 The draft folder facility, together with the
1085 .Sw -form
1086 switch, are sufficient.
1089 .U3 "Inplace Editing
1090 .P
1091 .Pn anno
1092 had the switches
1093 .Sw -[no]inplace
1094 to either annotate the message inplace and thus preserve hard links,
1095 or annotate a copy to replace the original message, breaking hard links.
1096 Following the assumption that linked messages are the same message,
1097 and annotating it should not break the link, the
1098 .Sw -[no]inplace
1099 switches were removed and the previous default
1100 .Sw -inplace
1101 was made the only behavior.
1102 The
1103 .Sw -[no]inplace
1104 switches of
1105 .Pn repl ,
1106 .Pn forw ,
1107 and
1108 .Pn dist
1109 could be removed, too, as they were simply passed through to
1110 .Pn anno .
1111 .P
1112 .Pn burst
1113 also had
1114 .Sw -[no]inplace
1115 switches, but with different meaning.
1116 With
1117 .Sw -inplace ,
1118 the digest had been replaced by the table of contents (i.e. the
1119 introduction text) and the bursted messages were placed right
1120 after this message, renumbering all following messages.
1121 Also, any trailing text of the digest was lost, though,
1122 in practice, it usually consists of an end-of-digest marker only.
1123 Nontheless, this behavior appeared less elegant than the
1124 .Sw -noinplace
1125 behavior, which already had been the default.
1126 Nmh's
1127 .Mp burst (1)
1128 man page reads:
1129 .sp \n(PDu
1130 .QP
1131 If -noinplace is given, each digest is preserved, no table
1132 of contents is produced, and the messages contained within
1133 the digest are placed at the end of the folder. Other messages
1134 are not tampered with in any way.
1135 .sp \n(PDu
1136 .LP
1137 The decision to drop the
1138 .Sw -inplace
1139 behavior was supported by the code complexity and the possible data loss
1140 it caused.
1141 .Sw -noinplace
1142 was chosen to be the definitive behavior.
1145 .U3 "Forms and Format Strings
1146 .P
1147 Historically, the tools that had
1148 .Sw -form
1149 switches to supply a form file had
1150 .Sw -format
1151 switches as well to supply the contents of a form file as a string
1152 on the command line directly.
1153 In consequence, the following two lines equaled:
1154 .VS
1155 scan -form scan.mailx
1156 scan -format "`cat .../scan.mailx`"
1157 VE
1158 The
1159 .Sw -format
1160 switches were dropped in favor for extending the
1161 .Sw -form
1162 switches.
1163 If their argument starts with an equal sign (`='),
1164 then the rest of the argument is taken as a format string,
1165 otherwise the arguments is treated as the name of a format file.
1166 Thus, now the following two lines equal:
1167 .VS
1168 scan -form scan.mailx
1169 scan -form "=`cat .../scan.mailx`"
1170 VE
1171 This rework removed the prefix collision between
1172 .Sw -form
1173 and
1174 .Sw -format .
1175 Now, typing
1176 .Sw -fo
1177 suffices to specify form or format string.
1178 .P
1179 The different meaning of
1180 .Sw -format
1181 for
1182 .Pn repl
1183 and
1184 .Pn forw
1185 was removed in mmh.
1186 .Pn forw
1187 was completely switched to MIME-type forwarding, thus removing the
1188 .Sw -[no]format .
1189 For
1190 .Pn repl ,
1191 the
1192 .Sw -[no]format
1193 switches were reworked to
1194 .Sw -[no]filter
1195 switches.
1196 The
1197 .Sw -format
1198 switches of
1199 .Pn send
1200 and
1201 .Pn post ,
1202 which had a third meaning,
1203 were removed likewise.
1204 Eventually, the ambiguity of the
1205 .Sw -format
1206 switches was resolved by not anymore having any such switch in mmh.
1209 .U3 "MIME Tools
1210 .P
1211 The MIME tools, which were once part of
1212 .Pn mhn ,
1213 had several switches that added little practical value to the programs.
1214 The
1215 .Sw -[no]realsize
1216 switches of
1217 .Pn mhbuild
1218 and
1219 .Pn mhlist
1220 were removed, doing real size calculations always now, as
1221 ``This provides an accurate count at the expense of a small delay.''
1222 This small delay is not noticable on modern systems.
1223 .P
1224 The
1225 .Sw -[no]check
1226 switches were removed together with the support for
1227 .Hd Content-MD5
1228 header fields.
1229 .[
1230 rfc 1864
1231 .]
1232 (See Sec. XXX)
1233 .P
1234 The
1235 .Sw -[no]ebcdicsafe
1236 and
1237 .Sw -[no]rfc934mode
1238 switches of
1239 .Pn mhbuild
1240 were removed because they are considered obsolete.
1241 .P
1242 Content caching of external MIME parts, activated with the
1243 .Sw -rcache
1244 and
1245 .Sw -wcache
1246 switches was completely removed.
1247 External MIME parts are truly rare today, having a caching facility
1248 for them is appeares to be unnecessary.
1249 .P
1250 In pre-MIME times,
1251 .Pn mhl
1252 had covered many tasks that are part of MIME handling today.
1253 Therefore,
1254 .Pn mhl
1255 could be simplified to a large extend, reducing the number of its
1256 switches from 21 to 6.
1259 .U3 "Mail Transfer Switches
1260 .P
1261 With the removal of the mail transfer facilities, a lot of switches
1262 vanished automatically.
1263 .Pn inc
1264 lost 9 switches, namely
1265 .Sw -host ,
1266 .Sw -port ,
1267 .Sw -user ,
1268 .Sw -proxy ,
1269 .Sw -snoop ,
1270 .Sw -[no]pack ,
1271 as well as
1272 .Sw -sasl
1273 and
1274 .Sw -saslmech .
1275 .Pn send
1276 and
1277 .Pn post
1278 lost 11 switches each, namely
1279 .Sw -server ,
1280 .Sw -port ,
1281 .Sw -client ,
1282 .Sw -user ,
1283 .Sw -mail ,
1284 .Sw -saml ,
1285 .Sw -send ,
1286 .Sw -soml ,
1287 .Sw -snoop ,
1288 as well as
1289 .Sw -sasl ,
1290 .Sw -saslmech ,
1291 and
1292 .Sw -tls .
1293 .Pn send
1294 had the switches only to pass them further to
1295 .Pn post ,
1296 because the user would invoke
1297 .Pn post
1298 not directly, but through
1299 .Pn send .
1300 All these switches, except
1301 .Sw -snoop
1302 were usually defined as default switches in the user's profile,
1303 but hardly given in interactive usage.
1304 .P
1305 Of course, those switches did not really ``vanish'', but the configuration
1306 they did was handed over to external MSAs and MRAs.
1307 Instead of setting up the mail transfer in mmh, it is set up in
1308 external tools.
1309 Yet, this simplifies mmh.
1310 Specialized external tools will likely have simple configuration files.
1311 Hence, instead of having one complicated central configuration file,
1312 the configuration of each domain is separate.
1313 Although the user needs to learn to configure each of the tools,
1314 each configuration is likely much simpler.
1317 .U3 "Maildrop Formats
1318 .P
1319 With the removal of MMDF maildrop format support,
1320 .Pn packf
1321 and
1322 .Pn rcvpack
1323 no longer needed their
1324 .Sw -mbox
1325 and
1326 .Sw -mmdf
1327 switches.
1328 .Sw -mbox
1329 is the sole behavior now.
1330 In the same go,
1331 .Pn packf
1332 was reworked (see Sec. XXX) and its
1333 .Sw -file
1334 switch became unnecessary.
1337 .U3 "Terminal Magic
1338 .P
1339 Mmh's tools will no longer clear the screen (\c
1340 .Pn scan 's
1341 and
1342 .Pn mhl 's
1343 .Sw -[no]clear
1344 switches).
1345 Neither will
1346 .Pn mhl
1347 ring the bell (\c
1348 .Sw -[no]bell )
1349 nor page the output itself (\c
1350 .Sw -length ).
1351 .P
1352 Generally, the pager to use is no longer specified with the
1353 .Sw -[no]moreproc
1354 command line switches for
1355 .Pn mhl
1356 and
1357 .Pn show /\c
1358 .Pn mhshow .
1359 .P
1360 .Pn prompter
1361 lost its
1362 .Sw -erase
1363 and
1364 .Sw -kill
1365 switches because today the terminal cares for the line editing keys.
1368 .U3 "Header Printing
1369 .P
1370 .Pn folder 's
1371 data output is self-explaining enough that
1372 displaying the header line makes few sense.
1373 Hence, the
1374 .Sw -[no]header
1375 switch was removed and headers are never printed.
1376 .P
1377 In
1378 .Pn mhlist ,
1379 the
1380 .Sw -[no]header
1381 switches were removed, too.
1382 But in this case headers are always printed,
1383 because the output is not self-explaining.
1384 .P
1385 .Pn scan
1386 also had
1387 .Sw -[no]header
1388 switches.
1389 Printing the header had been sensible until the introduction of
1390 format strings made it impossible to display the column headings.
1391 Only the folder name and the current date remained to be printed.
1392 As this information can be perfectly retrieved by
1393 .Pn folder
1394 and
1395 .Pn date ,
1396 consequently, the switches were removed.
1397 .P
1398 By removing all
1399 .Sw -header
1400 switches, the collision with
1401 .Sw -help
1402 on the first two letters was resolved.
1403 Currently,
1404 .Sw -h
1405 evaluates to
1406 .Sw -help
1407 for all tools of mmh.
1410 .U3 "Suppressing Edits or the WhatNow Shell
1411 .P
1412 The
1413 .Sw -noedit
1414 switches of
1415 .Pn comp ,
1416 .Pn repl ,
1417 .Pn forw ,
1418 .Pn dist ,
1419 and
1420 .Pn whatnow
1421 was removed, but it can now be replaced by specifying
1422 .Sw -editor
1423 with an empty argument.
1424 (Specifying
1425 .Cl "-editor true
1426 is nearly the same, only differing by the previous editor being set.)
1427 .P
1428 The more important change is the removal of the
1429 .Sw -nowhatnowproc
1430 switch.
1431 This switch had introduced an awkward behavior, as explained in nmh's
1432 man page for
1433 .Mp comp (1):
1434 .QP
1435 The \-editor editor switch indicates the editor to use for
1436 the initial edit. Upon exiting from the editor, comp will
1437 invoke the whatnow program. See whatnow(1) for a discussion
1438 of available options. The invocation of this program can be
1439 inhibited by using the \-nowhatnowproc switch. (In truth of
1440 fact, it is the whatnow program which starts the initial
1441 edit. Hence, \-nowhatnowproc will prevent any edit from
1442 occurring.)
1443 .P
1444 Effectively, the
1445 .Sw -nowhatnowproc
1446 switch stored a copy of the form file into the draft folder.
1447 As
1448 .Cl "-whatnowproc true
1449 causes the same behavior, the
1450 .Sw -nowhatnowproc
1451 switch was removed for being redundant.
1452 Likely, however, the intention for specifying
1453 .Sw -nowhatnowproc
1454 is sending a fully prepared form file at once.
1455 This can be done with
1456 .Cl "-whatnowproc send" .
1459 .U3 "Compatibility Switches
1460 .BU
1461 The hidden
1462 .Sw -[no]total
1463 switches of
1464 .Pn flist .
1465 They were simply the inverse of the visible
1466 .Sw -[no]fast
1467 switches:
1468 .Sw -total
1469 was
1470 .Sw -nofast
1471 and
1472 .Sw -nototal
1473 was
1474 .Sw -fast .
1475 I removed the
1476 .Sw -[no]total
1477 legacy.
1478 .BU
1479 The
1480 .Sw -subject
1481 switch of
1482 .Pn sortm
1483 existed for compatibility only.
1484 It can be fully replaced by
1485 .Cl "-textfield subject
1486 thus it was removed.
1489 .U3 "Various
1490 .BU
1491 In order to avoid prefix collisions amoung switch names, the
1492 .Sw -version
1493 switch was renamed to
1494 .Sw -Version
1495 (with capital `V').
1496 Every program has the
1497 .Sw -version
1498 switch but its first three letters collided with the
1499 .Sw -verbose
1500 switch, present in many programs.
1501 The rename solved this problem once for all.
1502 Although this rename breaks a basic interface, having the
1503 .Sw -V
1504 abbreviation to display the version information, isn't all too bad.
1505 .BU
1506 .Sw -[no]preserve
1507 of
1508 .Pn refile
1509 was removed because what use was it anyway?
1510 .QP
1511 Normally when a message is refiled, for each destination
1512 folder it is assigned the number which is one above the current
1513 highest message number in that folder. Use of the
1514 \-preserv [sic!] switch will override this message renaming, and try
1515 to preserve the number of the message. If a conflict for a
1516 particular folder occurs when using the \-preserve switch,
1517 then refile will use the next available message number which
1518 is above the message number you wish to preserve.
1519 .BU
1520 The removal of the
1521 .Sw -[no]reverse
1522 switches of
1523 .Pn scan
1524 is a bug fix, supported by the comments
1525 ``\-[no]reverse under #ifdef BERK (I really HATE this)''
1526 by Rose and
1527 ``Lists messages in reverse order with the `\-reverse' switch.
1528 This should be considered a bug.'' by Romine in the documentation.
1529 The question remaining is why neither Rose and Romine had fixed this
1530 bug in the Eighties when they wrote these comments nor has anyone
1531 thereafter.
1534 .ig
1536 forw: [no]dashstuffing(mhl)
1538 mhshow: [no]pause [no]serialonly
1540 mhmail: resent queued
1541 inc: snoop, (pop)
1543 mhl: [no]faceproc folder sleep
1544 [no]dashstuffing(forw) digest list volume number issue number
1546 prompter: [no]doteof
1548 refile: [no]preserve [no]unlink [no]rmmproc
1550 send: [no]forward [no]mime [no]msgid
1551 [no]push split [no]unique (sasl) width snoop [no]dashstuffing
1552 attach attachformat
1553 whatnow: (noedit) attach
1555 slocal: [no]suppressdups
1557 spost: [no]filter [no]backup width [no]push idanno
1558 [no]check(whom) whom(whom)
1560 whom: ???
1562 ..
1565 .ig
1567 .P
1568 To ease typing, the switches can be abbreviated as much as the remaining
1569 prefix remains unambiguous.
1570 If in our example no other switch would start with the letter `t', then
1571 .Cl "-truncate" ,
1572 .Cl "-trunc" ,
1573 .Cl "-tr" ,
1574 and
1575 .Cl "-t
1576 would all be the same.
1577 As a result, switches can neither be grouped (as in
1578 .Cl "ls -ltr" )
1579 nor can switch arguments be appended directly to the switch (as in
1580 .Cl "sendmail -q30m" ).
1581 .P
1582 Many switches have negating counter-parts, which start with `no'.
1583 For example
1584 .Cl "-notruncate
1585 inverts the
1586 .Cl "-truncate
1587 switch.
1588 They exist to undo the effect of default switches in the profile.
1589 If the user has chosen to change the default behavior of some tool
1590 by adding a default switch to the profile,
1591 he can still undo this change in behavior by specifiying the inverse
1592 switch on the command line.
1593 .P
1594 In the best case, all switches are unambiguous on the first character,
1595 or on the three-letter prefix for the `no' variants.
1596 Reducing switch prefix collisions, shortens the necessary prefix lenght
1597 the user must type.
1598 Having less switches helps best.
1600 ..
1605 .H1 "Modernizing
1608 .H2 "Removal of Code Relicts
1609 .P
1610 The code base of mmh originates from the late Seventies,
1611 had been extensively
1612 worked on in the mid Eighties, and had been partly reorganized and extended
1613 in the Nineties. Relicts of all those times had gathered in the code base.
1614 My goal was to remove any ancient code parts. One part of the task was
1615 converting obsolete code constructs to standard constructs, the other part
1616 was dropping obsolete functions.
1617 .P
1618 As I'm not even thirty years old and have no more than seven years of
1619 Unix experience, I needed to learn about the history in retrospective.
1620 Older people likely have used those ancient constructs themselves
1621 and have suffered from their incompatibilities and have longed for
1622 standardization. Unfortunately, I have only read that others had done so.
1623 This put me in a much more difficult positions when working on the old
1624 code. I needed to recherche what other would have known by heart from
1625 experience. All my programming experience comes from a time past ANSI C
1626 and past POSIX. Although I knew about the times before, I took the
1627 current state implicitly for granted most of the time.
1628 .P
1629 Being aware of
1630 these facts, I rather let people with more historic experience solve the
1631 task of converting the ancient code constructs to standardized ones.
1632 Luckily, Lyndon Nerenberg focused on this task at the nmh project.
1633 He converted large parts of the code to POSIX constructs, removing
1634 the conditionals compilation for now standardized features.
1635 I'm thankful for this task being solved. I only pulled the changes into
1636 mmh.
1637 .P
1638 The other task \(en dropping ancient functionality to remove old code \(en
1639 I did myself, though. My position to strip mmh to the bare minimum of
1640 frequently used features is much more revolutional than the nmh community
1641 likes it. Without the need to justify my decisions, I was able to quickly
1642 remove functionality I considered ancient.
1643 The need to discuss my decisions with
1644 peers likely would have slowed this process down. Of course, I researched
1645 if a particular feature really should be dropped. Having not had any
1646 contact to this feature within my computer life was a first indicator to
1647 drop it, but I also asked others and searched the literature for modern
1648 usage of the feature. If it appeared to be truly ancient, I dropped it.
1649 The reason for dropping is always part of the commit message in the
1650 version control system. Thus, it is easy for others to check their
1651 view on the topic with mine and possibly to argue for reinclusion.
1653 .U2 "MMDF maildrop support
1654 .P
1655 I did drop any support for the MMDF maildrop format. This type of format
1656 is conceptionally similar to the mbox format, but uses four bytes with
1657 value 1 (\fL^A^A^A^A\fP) as message delimiter,
1658 instead of the string ``\fLFrom\ \fP''.
1659 Due to the similarity and mbox being the de-facto standard maildrop
1660 format on Unix, but also due to the larger influence of Sendmail than MMDF,
1661 the MMDF maildrop format had vanished.
1662 .P
1663 The simplifications within the code were only moderate. Switches could
1664 be removed from tools like
1665 .L packf ,
1666 which generate packed mailboxes. Only one packed mailbox format remained:
1667 mbox.
1668 The most important changes affect the equally named mail parsing routine in
1669 .L sbr/m_getfld.c .
1670 The direct MMDF code had been removed, but as now only one packed mailbox
1671 format is left, code structure simplifications are likely possible.
1672 The reason why they are still outstanding is the heavily optimized code
1673 of
1674 .Fu m_getfld() .
1675 Changes beyond a small local scope \(en
1676 which restructuring in its core is \(en cause a high risk of damaging
1677 the intricate workings of the optimized code. This problem is know
1678 to the developers of nmh, too. They also avoid touching this minefield
1679 if possible.
1681 .U2 "UUCP Bang Paths
1682 .P
1683 More questionably than the former topic is the removal of support for the
1684 UUCP bang path address style. However, the user may translate the bang
1685 paths on retrieval to Internet addresses and the other way on posting
1686 messages. The former can be done my an MDA like procmail; the latter
1687 by a sendmail wrapper. This would ensure that any address handling would
1688 work as expected. However, it might just work well without any
1689 such modifications, as mmh does not touch addresses much, in general.
1690 But I can't ensure as I have never used an environment with bang paths.
1691 Also, the behavior might break at any point in further development.
1693 .U2 "Hardcopy terminal support
1694 .P
1695 More of a funny anecdote is the remaining of a check for printing to a
1696 hardcopy terminal until Spring 2012, when I finally removed it.
1697 I surely would be very happy to see such a terminal in action, maybe
1698 actually being able to work on it, but I fear my chances are null.
1699 .P
1700 The check only prevented a pager to be placed between the outputting
1701 program (\c
1702 .Pn mhl )
1703 and the terminal. This could have been ensured with
1704 the
1705 .Sw -nomoreproc
1706 at the command line statically, too.
1708 .U2 "Removed support for header fields
1709 .P
1710 The
1711 .Hd Encrypted
1712 header field had been introduced by RFC\^822, but already
1713 marked legacy in RFC 2822. It was superseded by FIXME.
1714 Mmh does no more support this header field.
1715 .P
1716 Native support for
1717 .Hd Face
1718 header fields had been removed, as well.
1719 The feature is similar to the
1720 .Hd X-Face
1721 header field in its intent,
1722 but takes a different approach to store the image.
1723 Instead of encoding the image data directly into the header field,
1724 the it contains the hostname and UDP port where the image
1725 date could be retrieved.
1726 Neither
1727 .Hd X-Face
1728 nor the here described
1729 .Hd Face
1730 system
1731 \**
1732 .FS
1733 There is also a newer but different system, invented 2005,
1734 using
1735 .Hd Face
1736 headers.
1737 It is the successor of
1738 .Hd X-Face
1739 providing colored PNG images.
1740 .FE
1741 became well used in the large scale.
1742 It's still possible to use a Face systems,
1743 although mmh does not provide support for any of the different systems
1744 anymore. It's fairly easy to write a small shell script to
1745 extract the embedded or fetch the external Face data and display the image.
1746 Own
1747 .Hd Face
1748 header field can be added into the draft template files.
1749 .P
1750 .Hd Content-MD5
1751 header fields were introduced by RFC\^1864. They provide only
1752 a verification of data corruption during the transfer. By no means can
1753 they ensure verbatim end-to-end delivery of the contents. This is clearly
1754 stated in the RFC. The proper approach to provide verificationability
1755 of content in an end-to-end relationship is the use of digital cryptography
1756 (RFCs FIXME). On the other hand, transfer protocols should ensure the
1757 integrity of the transmission. In combinations these two approaches
1758 make the
1759 .Hd Content-MD5
1760 header field useless. In consequence, I removed
1761 the support for it. By this removal, MD5 computation is not needed
1762 anywhere in mmh. Hence, over 500 lines of code were removed by this one
1763 change. Even if the
1764 .Hd Content-MD5
1765 header field is useful sometimes,
1766 I value its usefulness less than the improvement in maintainability, caused
1767 by the removal.
1769 .U2 "Prompter's Control Keys
1770 .P
1771 The program
1772 .Pn prompter
1773 queries the user to fill in a message form. When used by
1774 .Pn comp
1775 as:
1776 .VS
1777 comp -editor prompter
1778 VE
1779 the resulting behavior is similar to
1780 .Pn mailx .
1781 Apparently,
1782 .Pn prompter
1783 hadn't been touched lately. Otherwise it's hardly explainable why it
1784 still offered the switches
1785 .Sw -erase
1786 .Ar chr
1787 and
1788 .Sw -kill
1789 .Ar chr
1790 to name the characters for command line editing.
1791 The times when this had been necessary are long time gone.
1792 Today these things work out-of-the-box, and if not, are configured
1793 with the standard tool
1794 .Pn stty .
1796 .U2 "Vfork and Retry Loops
1797 .P
1798 MH creates many processes, which is a consequence of the tool chest approach.
1799 In earlier times
1800 .Fu fork()
1801 had been an expensive system call, as the process's whole image needed
1802 to be duplicated. One common case is replacing the image with
1803 .Fu exec()
1804 right after having forked the child process.
1805 To speed up this case, the
1806 .Fu vfork()
1807 system call was invented at Berkeley. It completely omits copying the
1808 image. If the image gets replaced right afterwards then unnecessary
1809 work is omited. On old systems this results in large speed ups.
1810 MH uses
1811 .Fu vfork()
1812 whenever possible.
1813 .P
1814 Memory management units that support copy-on-write semantics make
1815 .Fu fork()
1816 almost as fast as
1817 .Fu vfork()
1818 in the cases when they can be exchanged.
1819 With
1820 .Fu vfork()
1821 being more error-prone and hardly faster, it's preferable to simply
1822 use
1823 .Fu fork()
1824 instead.
1825 .P
1826 Related to the costs of
1827 .Fu fork()
1828 is the probability of its success.
1829 Today on modern systems, the system call will succeed almost always.
1830 In the Eighties on heavy loaded systems, as they were common at
1831 universities, this had been different. Thus, many of the
1832 .Fu fork()
1833 calls were wrapped into loops to retry to fork several times in
1834 short intervals, in case of previous failure.
1835 In mmh, the program aborts at once if the fork failed.
1836 The user can reexecute the command then. This is expected to be a
1837 very rare case on modern systems, especially personal ones, which are
1838 common today.
1841 .H2 "Attachments
1842 .P
1843 MIME
1846 .H2 "Digital Cryptography
1847 .P
1848 Signing and encryption.
1851 .H2 "Good Defaults
1852 .P
1853 foo
1858 .H1 "Code style
1859 .P
1860 foo
1863 .H2 "Standard Code
1864 .P
1865 POSIX
1868 .H2 "Separation
1870 .U2 "MH Directory Split
1871 .P
1872 In MH and nmh, a personal setup had consisted of two parts:
1873 The MH profile, named
1874 .Fn \&.mh_profile
1875 and being located directly in the user's home directory.
1876 And the MH directory, where all his mail messages and also his personal
1877 forms, scan formats, other configuration files are stored. The location
1878 of this directory could be user-chosen. The default was to name it
1879 .Fn Mail
1880 and have it directly in the home directory.
1881 .P
1882 I've never liked the data storage and the configuration to be intermixed.
1883 They are different kinds of data. One part, are the messages,
1884 which are the data to operate on. The other part, are the personal
1885 configuration files, which are able to change the behavior of the operations.
1886 The actual operations are defined in the profile, however.
1887 .P
1888 When storing data, one should try to group data by its type.
1889 There's sense in the Unix file system hierarchy, where configuration
1890 file are stored separate (\c
1891 .Fn /etc )
1892 to the programs (\c
1893 .Fn /bin
1894 and
1895 .Fn /usr/bin )
1896 to their sources (\c
1897 .Fn /usr/src ).
1898 Such separation eases the backup management, for instance.
1899 .P
1900 In mmh, I've reorganized the file locations.
1901 Still there are two places:
1902 There's the mail storage directory, which, like in MH, contains all the
1903 messages, but, unlike in MH, nothing else.
1904 Its location still is user-chosen, with the default name
1905 .Fn Mail ,
1906 in the user's home directory. This is much similar to the case in nmh.
1907 The configuration files, however, are grouped together in the new directory
1908 .Fn \&.mmh
1909 in the user's home directory.
1910 The user's profile now is a file, named
1911 .Fn profile ,
1912 in this mmh directory.
1913 Consistently, the context file and all the personal forms, scan formats,
1914 and the like, are also there.
1915 .P
1916 The naming changed with the relocation.
1917 The directory where everything, except the profile, had been stored (\c
1918 .Fn $HOME/Mail ),
1919 used to be called \fIMH directory\fP. Now, this directory is called the
1920 user's \fImail storage\fP. The name \fImmh directory\fP is now given to
1921 the new directory
1922 (\c
1923 .Fn $HOME/.mmh ),
1924 containing all the personal configuration files.
1925 .P
1926 The separation of the files by type of content is logical and convenient.
1927 There are no functional differences as any possible setup known to me
1928 can be implemented with both approaches, although likely a bit easier
1929 with the new approach. The main goal of the change had been to provide
1930 sensible storage locations for any type of personal mmh file.
1931 .P
1932 In order for one user to have multiple MH setups, he can use the
1933 environment variable
1934 .Ev MH
1935 the point to a different profile file.
1936 The MH directory (mail storage plus personal configuration files) is
1937 defined by the
1938 .Pe Path
1939 profile entry.
1940 The context file could be defined by the
1941 .Pe context
1942 profile entry or by the
1943 .Ev MHCONTEXT
1944 environment variable.
1945 The latter is useful to have a distinct context (e.g. current folders)
1946 in each terminal window, for instance.
1947 In mmh, there are three environment variables now.
1948 .Ev MMH
1949 may be used to change the location of the mmh directory.
1950 .Ev MMHP
1951 and
1952 .Ev MMHC
1953 change the profile and context files, respectively.
1954 Besides providing a more consistent feel (which simply is the result
1955 of being designed anew), the set of personal configuration files can
1956 be chosen independently from the profile (including mail storage location)
1957 and context, now. Being it relevant for practical use or not, it
1958 de-facto is an improvement. However, the main achievement is the
1959 split between mail storage and personal configuration files.
1962 .H2 "Modularization
1963 .P
1964 whatnowproc
1965 .P
1966 The \fIMH library\fP
1967 .Fn libmh.a
1968 collects a bunch of standard functions that many of the MH tools need,
1969 like reading the profile or context files.
1970 This doesn't hurt the separation.
1973 .H2 "Style
1974 .P
1975 Code layout, goto, ...
1980 .H1 "Concept Exploitation/Homogeneity
1983 .H2 "Draft Folder
1984 .P
1985 Historically, MH provided exactly one draft message, named
1986 .Fn draft
1987 and
1988 being located in the MH directory. When starting to compose another message
1989 before the former one was sent, the user had been questioned whether to use,
1990 refile or replace the old draft. Working on multiple drafts at the same time
1991 was impossible. One could only work on them in alteration by refiling the
1992 previous one to some directory and fetching some other one for reediting.
1993 This manual draft management needed to be done each time the user wanted
1994 to switch between editing one draft to editing another.
1995 .P
1996 To allow true parallel editing of drafts, in a straight forward way, the
1997 draft folder facility exists. It had been introduced already in July 1984
1998 by Marshall T. Rose. The facility was deactivated by default.
1999 Even in nmh, the draft folder facility remained deactivated by default.
2000 At least, Richard Coleman added the man page
2001 .Mp mh-draft(5)
2002 to document
2003 the feature well.
2004 .P
2005 The only advantage of not using the draft folder facility is the static
2006 name of the draft file. This could be an issue for MH front-ends like mh-e.
2007 But as they likely want to provide working on multiple drafts in parallel,
2008 the issue is only concerning compatibility. The aim of nmh to stay compatible
2009 prevented the default activation of the draft folder facility.
2010 .P
2011 On the other hand, a draft folder is the much more natural concept than
2012 a draft message. MH's mail storage consists of folders and messages,
2013 the messages named with ascending numbers. A draft message breaks with this
2014 concept by introducing a message in a file named
2015 .Fn draft .
2016 This draft
2017 message is special. It can not be simply listed with the available tools,
2018 but instead requires special switches. I.e. corner-cases were
2019 introduced. A draft folder, in contrast, does not introduce such
2020 corner-cases. The available tools can operate on the messages within that
2021 folder like on any messages within any mail folders. The only difference
2022 is the fact that the default folder for
2023 .Pn send
2024 is the draft folder,
2025 instead of the current folder, like for all other tools.
2026 .P
2027 The trivial part of the change was activating the draft folder facility
2028 by default and setting a default name for this folder. Obviously, I chose
2029 the name
2030 .Fn +drafts .
2031 This made the
2032 .Sw -draftfolder
2033 and
2034 .Sw -draftmessage
2035 switches useless, and I could remove them.
2036 The more difficult but also the part that showed the real improvement,
2037 was updating the tools to the new concept.
2038 .Sw -draft
2039 switches could
2040 be dropped, as operating on a draft message became indistinguishable to
2041 operating on any other message for the tools.
2042 .Pn comp
2043 still has its
2044 .Sw -use
2045 switch for switching between its two modes: (1) Compose a new
2046 draft, possibly by taking some existing message as a form. (2) Modify
2047 an existing draft. In either case, the behavior of
2048 .Pn comp is
2049 deterministic. There is no more need to query the user. I consider this
2050 a major improvement. By making
2051 .Pn send
2052 simply operate on the current
2053 message in the draft folder by default, with message and folder both
2054 overridable by specifying them on the command line, it is now possible
2055 to send a draft anywhere within the storage by simply specifying its folder
2056 and name.
2057 .P
2058 All theses changes converted special cases to regular cases, thus
2059 simplifying the tools and increasing the flexibility.
2062 .H2 "Trash Folder
2063 .P
2064 Similar to the situation for drafts is the situation for removed messages.
2065 Historically, a message was deleted by renaming. A specific
2066 \fIbackup prefix\fP, often comma (\c
2067 .Fn , )
2068 or hash (\c
2069 .Fn # ),
2070 being prepended to the file name. Thus, MH wouldn't recognize the file
2071 as a message anymore, as only files whose name consists of digits only
2072 are treated as messages. The removed messages remained as files in the
2073 same directory and needed some maintenance job to truly delete them after
2074 some grace time. Usually, by running a command similar to
2075 .VS
2076 find /home/user/Mail -ctime +7 -name ',*' | xargs rm
2077 VE
2078 in a cron job. Within the grace time interval
2079 the original message could be restored by stripping the
2080 the backup prefix from the file name. If however, the last message of
2081 a folder is been removed \(en say message
2082 .Fn 6
2083 becomes file
2084 .Fn ,6
2085 \(en and a new message enters the same folder, thus the same
2086 numbered being given again \(en in our case
2087 .Fn 6
2088 \(en, if that one
2089 is removed too, then the backup of the former message gets overwritten.
2090 Thus, the ability to restore removed messages does not only depend on
2091 the ``sweeping cron job'' but also on the removing of further messages.
2092 This is undesirable, because the real mechanism is hidden from the user
2093 and the consequences of further removals are not always obvious.
2094 Further more, the backup files are scattered within the whole mail
2095 storage, instead of being collected at one place.
2096 .P
2097 To improve the situation, the profile entry
2098 .Pe rmmproc
2099 (previously named
2100 .Pe Delete-Prog )
2101 was introduced, very early.
2102 It could be set to any command, which would care for the mail removal
2103 instead of taking the default action, described above.
2104 Refiling the to-be-removed files to some garbage folder was a common
2105 example. Nmh's man page
2106 .Mp rmm(1)
2107 proposes
2108 .Cl "refile +d
2109 to move messages to the garbage folder and
2110 .Cl "rm `mhpath +d all`
2111 the empty the garbage folder.
2112 Managing the message removal this way is a sane approach. It keeps
2113 the removed messages in one place, makes it easy to remove the backup
2114 files, and, most important, enables the user to use the tools of MH
2115 itself to operate on the removed messages. One can
2116 .Pn scan
2117 them,
2118 .Pn show
2119 them, and restore them with
2120 .Pn refile .
2121 There's no more
2122 need to use
2123 .Pn mhpath
2124 to switch over from MH tools to Unix tools \(en MH can do it all itself.
2125 .P
2126 This approach matches perfect with the concepts of MH, thus making
2127 it powerful. Hence, I made it the default. And even more, I also
2128 removed the old backup prefix approach, as it is clearly less powerful.
2129 Keeping unused alternative in the code is a bad choice as they likely
2130 gather bugs, by not being constantly tested. Also, the increased code
2131 size and more conditions crease the maintenance costs. By strictly
2132 converting to the trash folder approach, I simplified the code base.
2133 .Pn rmm
2134 calls
2135 .Pn refile
2136 internally to move the to-be-removed
2137 message to the trash folder (\c
2138 .Fn +trash
2139 by default). Messages
2140 there can be operated on like on any other message in the storage.
2141 The sweep clean, one can use
2142 .Cl "rmm -unlink +trash a" ,
2143 where the
2144 .Sw -unlink
2145 switch causes the files to be truly unliked instead
2146 of moved to the trash folder.
2149 .H2 "Path Notations
2150 .P
2151 foo
2154 .H2 "MIME Integration
2155 .P
2156 user-visible access to whole messages and MIME parts are inherently
2157 different
2160 .H2 "Of One Cast
2161 .P