annotate discussion.roff @ 124:3d30fd938aa9

Spellchecking.
author markus schnalke <meillo@marmaro.de>
date Sat, 30 Jun 2012 15:05:06 +0200
parents 740f4128dea7
children 0e102cec0c73
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1 .H0 "Discussion
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3 This main chapter discusses the practical work done in the mmh project.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
4 It is structured along the goals to achieve.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
5 The concrete work done
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
6 is described in the examples of how the general goals were achieved.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
7 The discussion compares the current version of mmh with the state of
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
8 nmh just before the mmh project started, i.e. Fall 2011.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
9 Current changes of nmh will be mentioned only as side notes.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
10 .\" XXX where do I discuss the parallel development of nmh?
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
11
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
12
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
13
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
14 .H1 "Stream-Lining
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
15
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
16 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
17 MH had been considered an all-in-one system for mail handling.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
18 The community around nmh has a similar understanding.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
19 In fundamental difference, mmh shall be a MUA only.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
20 I believe that the development of all-in-one mail systems is obsolete.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
21 Today, email is too complex to be fully covered by single projects.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
22 Such a project won't be able to excel in all aspects.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
23 Instead, the aspects of email should be covered my multiple projects,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
24 which then can be combined to form a complete system.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
25 Excellent implementations for the various aspects of email exist already.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
26 Just to name three examples: Postfix is a specialized MTA,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
27 Procmail is a specialized MDA, and Fetchmail is a specialized MRA.
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
28 I believe that it is best to use such specialized tools instead of
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
29 providing the same function again as a side-component in the project.
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
30 .P
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
31 Doing something well, requires to focus on a small set of specific aspects.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
32 Under the assumption that focused development produces better results
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
33 in the particular area, specialized projects will be superior
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
34 in their field of focus.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
35 Hence, all-in-one mail system projects \(en no matter if monolithic
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
36 or modular \(en will never be the best choice in any of the fields.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
37 Even in providing the best consistent all-in-one system they are likely
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
38 to be beaten by projects that focus only on integrating existing mail
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
39 components to a homogeneous system.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
40 .P
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
41 The limiting resource in Free Software community development
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
42 is usually man power.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
43 If the development power is spread over a large development area,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
44 it becomes even more difficult to compete with the specialists in the
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
45 various fields.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
46 The concrete situation for MH-based mail systems is even tougher,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
47 given the small and aged community, including both developers and users,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
48 it has.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
49 .P
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
50 In consequence, I believe that the available development resources
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
51 should focus on the point where MH is most unique.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
52 This is clearly the user interface \(en the MUA.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
53 Peripheral parts should be removed to stream-line mmh for the MUA task.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
54
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
55
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
56 .H2 "Mail Transfer Facilities
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
57 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
58 In contrast to nmh, which also provides mail submission and mail retrieval
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
59 agents, mmh is a MUA only.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
60 This general difference initiated the development of mmh.
66
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
61 Removing the mail transfer facilities had been the first work task
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
62 in the mmh project.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
63 .P
105
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
64 Focusing on one mail agent role only is motivated by Eric Allman's
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
65 experience with Sendmail.
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
66 He identified limiting Sendmail the MTA task had be one reason for
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
67 its success:
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
68 .[ [
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
69 costales sendmail
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
70 .], p. xviii]
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
71 .QS
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
72 Second, I limited myself to the routing function \(en
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
73 I wouldn't write user agents or delivery back-ends.
105
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
74 This was a departure of the dominant through of the time,
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
75 in which routing logic, local delivery, and often the network code
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
76 were incorporated directly into the user agents.
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
77 .QE
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
78 .P
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
79 In mmh, the Mail Submission Agent (MSA) is called
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
80 \fIMessage Transfer Service\fP (MTS).
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
81 This facility, implemented by the
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
82 .Pn post
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
83 command, established network connections and spoke SMTP to submit
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
84 messages for relay to the outside world.
105
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
85 The changes in email demanded changes in this part of nmh too.
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
86 Encryption and authentication for network connections
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
87 needed to be supported, hence TLS and SASL were introduced into nmh.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
88 This added complexity to nmh without improving it in its core functions.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
89 Also, keeping up with recent developments in the field of
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
90 mail transfer requires development power and specialists.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
91 In mmh this whole facility was simply cut off.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
92 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
93 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
94 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
95 Instead, mmh depends on an external MSA.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
96 The only outgoing interface available to mmh is the
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
97 .Pn sendmail
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
98 command, which almost any MSA provides.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
99 If not, a wrapper program can be written.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
100 It must read the message from the standard input, extract the
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
101 recipient addresses from the message header, and hand the message
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
102 over to the MSA.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
103 For example, a wrapper script for qmail would be:
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
104 .VS
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
105 #!/bin/sh
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
106 # ignore command line arguments
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
107 exec qmail-inject
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
108 VE
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
109 The requirement to parse the recipient addresses out of the message header
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
110 is likely to be removed in the future.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
111 Then mmh would give the recipient addresses as command line arguments.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
112 This appears to be the better interface.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
113 .\" XXX implement it
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
114 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
115 To retrieve mail, the
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
116 .Pn inc
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
117 command acted as Mail Retrieval Agent (MRA).
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
118 It established network connections
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
119 and spoke POP3 to retrieve mail from remote servers.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
120 As with mail submission, the network connections required encryption and
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
121 authentication, thus TLS and SASL were added.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
122 Support for message retrieval through IMAP will become necessary
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
123 to be added soon, too, and likewise for any other changes in mail transfer.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
124 Not so for mmh because it has dropped the support for retrieving mail
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
125 from remote locations.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
126 .Ci ab7b48411962d26439f92f35ed084d3d6275459c
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
127 Instead, it depends on an external tool to cover this task.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
128 In mmh exist two paths for messages to enter mmh's mail storage:
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
129 (1) Mail can be incorporated with
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
130 .Pn inc
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
131 from the system maildrop, or (2) with
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
132 .Pn rcvstore
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
133 by reading them, one at a time, from the standard input.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
134 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
135 With the removal of the MSA and MRA, mmh converted from an all-in-one
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
136 mail system to being a MUA only.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
137 Now, of course, mmh depends on third-party software.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
138 An external MSA is required to transfer mail to the outside world;
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
139 an external MRA is required to retrieve mail from remote machines.
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
140 There exist excellent implementations of such software,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
141 which do this specific task likely better than the internal
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
142 versions had done it.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
143 Also, the best suiting programs can be freely chosen.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
144 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
145 As it had already been possible to use an external MSA or MRA,
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
146 why not keep the internal version for convenience?
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
147 The question whether there is sense in having a fall-back pager in all
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
148 the command line tools, for the cases when
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
149 .Pn more
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
150 or
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
151 .Pn less
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
152 aren't available, appears to be ridiculous.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
153 Of course, MSAs and MRAs are more complex than text pagers
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
154 and not necessarily available but still the concept of orthogonal
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
155 design holds: ``Write programs that do one thing and do it well.''
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
156 .[
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
157 mcilroy unix phil
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
158 p. 53
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
159 .]
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
160 .[
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
161 mcilroy bstj foreword
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
162 .]
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
163 Here, this part of the Unix philosophy was applied not only
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
164 to the programs but to the project itself.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
165 In other words:
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
166 ``Develop projects that focus on one thing and do it well.''
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
167 Projects grown complex should be split for the same reasons programs grown
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
168 complex should be split.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
169 If it is conceptionally more elegant to have the MSA and MRA as
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
170 separate projects then they should be separated.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
171 This is the case here, in my opinion.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
172 The RFCs propose this separation by clearly distinguishing the different
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
173 mail handling tasks.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
174 .[
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
175 rfc 821
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
176 .]
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
177 The small interfaces between the mail agents support the separation.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
178 .P
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
179 In the beginning, email had been small and simple.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
180 At that time,
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
181 .Pn /bin/mail
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
182 had covered anything there was to email and still had been small
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
183 and simple.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
184 Later, the essential complexity of email increased.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
185 (Essential complexity is the complexity defined by the problem itself.\0
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
186 .[[
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
187 brooks no silver bullet
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
188 .]])
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
189 Email systems reacted to this change: They grew.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
190 RFCs started to introduce the concept of mail agents to separate the
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
191 various tasks because they became more extensive and new tasks appeared.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
192 As the mail systems grew even more, parts were split off.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
193 In nmh, for instance, the POP server, which was included in the original
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
194 MH, was removed.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
195 Now is the time to go one step further and split the MSA and MRA off, too.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
196 Not only does this decrease the code size of the project,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
197 but, more important, it unburdens mmh of the whole field of
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
198 message transfer with all its implications for the project.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
199 There is no more need to concern with changes in network transfer.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
200 This independence is received by depending on an external program
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
201 that covers the field.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
202 Today, this is a reasonable exchange.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
203 .P
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
204 Functionality can be added in three different ways:
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
205 .BU
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
206 Implementing the function originally in the project.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
207 .BU
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
208 Depending on a library that provides the function.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
209 .BU
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
210 Depending on a program that provides the function.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
211 .P
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
212 Whereas adding the function originally to the project increases the
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
213 code size most and requires most maintenance and development work,
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
214 it makes the project most independent of other software.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
215 Using libraries or external programs require less maintenance work
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
216 but introduces dependencies on external software.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
217 Programs have the smallest interfaces and provide the best separation
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
218 but possibly limit the information exchange.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
219 External libraries are stronger connected than external programs,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
220 thus information can be exchanged more flexible.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
221 Adding code to a project increases maintenance work.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
222 .\" XXX ref
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
223 Implementing complex functions originally in the project adds
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
224 a lot of code.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
225 This should be avoided if possible.
66
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
226 Hence, the dependencies only change in kind, not in their existence.
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
227 In mmh, library dependencies on
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
228 .Pn libsasl2
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
229 and
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
230 .Pn libcrypto /\c
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
231 .Pn libssl
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
232 were treated against program dependencies on an MSA and an MRA.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
233 This also meant treating build-time dependencies against run-time
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
234 dependencies.
66
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
235 Besides program dependencies providing the stronger separation
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
236 and being more flexible, they also allowed
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
237 over 6\|000 lines of code to be removed from mmh.
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
238 This made mmh's code base about 12\|% smaller.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
239 Reducing the project's code size by such an amount without actually
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
240 losing functionality is a convincing argument.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
241 Actually, as external MSAs and MRAs are likely superior to the
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
242 project's internal versions, the common user even gains functionality.
66
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
243 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
244 Users of MH should not have problems to set up an external MSA and MRA.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
245 Also, the popular MSAs and MRAs have large communities and a lot
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
246 of documentation available.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
247 Choices for MSAs range from full-featured MTAs like
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
248 .I Postfix
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
249 over mid-size MTAs like
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
250 .I masqmail
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
251 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
252 .I dma
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
253 to small forwarders like
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
254 .I ssmtp
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
255 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
256 .I nullmailer .
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
257 Choices for MRAs include
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
258 .I fetchmail ,
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
259 .I getmail ,
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
260 .I mpop
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
261 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
262 .I fdm .
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
263
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
264
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
265 .H2 "Non-MUA Tools
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
266 .P
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
267 One goal of mmh is to remove the tools that are not part of the MUA's task.
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
268 Further more, any tools that don't improve the MUA's job significantly
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
269 should be removed.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
270 Loosely related and rarely used tools distract from the lean appearance.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
271 They require maintenance work without adding much to the core task.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
272 By removing these tools, the project shall become more stream-lined
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
273 and focused.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
274 In mmh the following tools are not available anymore:
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
275 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
276 .Pn conflict
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
277 was removed
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
278 .Ci 8b235097cbd11d728c07b966cf131aa7133ce5a9
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
279 because it is a mail system maintenance tool that is not MUA-related.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
280 It even checked
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
281 .Fn /etc/passwd
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
282 and
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
283 .Fn /etc/group
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
284 for consistency, which is completely unrelated to email.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
285 A tool like
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
286 .Pn conflict
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
287 is surely useful, but it should not be shipped with mmh.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
288 .\" XXX historic reasons?
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
289 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
290 .Pn rcvtty
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
291 was removed
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
292 .Ci 14767c94b3827be7c867196467ed7aea5f6f49b0
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
293 because its use case of writing to the user's terminal
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
294 on receiving of mail is obsolete.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
295 If users like to be informed of new mail, the shell's
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
296 .Ev MAILPATH
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
297 variable or graphical notifications are technically more appealing.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
298 Writing directly to terminals is hardly ever wanted today.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
299 If though one wants to have it this way, the standard tool
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
300 .Pn write
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
301 can be used in a way similar to:
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
302 .VS
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
303 scan -file - | write `id -un`
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
304 VE
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
305 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
306 .Pn viamail
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
307 was removed
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
308 .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
309 when the new attachment system was activated, because
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
310 .Pn forw
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
311 could then cover the task itself.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
312 The program
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
313 .Pn sendfiles
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
314 was rewritten as a shell script wrapper around
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
315 .Pn forw .
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
316 .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
317 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
318 .Pn msgchk
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
319 was removed
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
320 .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe ,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
321 because it lost its use case when POP support was removed.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
322 A call to
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
323 .Pn msgchk
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
324 provided hardly more information than:
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
325 .VS
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
326 ls -l /var/mail/meillo
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
327 VE
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
328 It did distinguish between old and new mail, but
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
329 this detail information can be retrieved with
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
330 .Pn stat (1),
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
331 too.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
332 A small shell script could be written to print the information
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
333 in a similar way, if truly necessary.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
334 As mmh's
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
335 .Pn inc
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
336 only incorporates mail from the user's local maildrop,
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
337 and thus no data transfers over slow networks are involved,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
338 there's hardly any need to check for new mail before incorporating it.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
339 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
340 .Pn msh
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
341 was removed
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
342 .Ci 916690191222433a6923a4be54b0d8f6ac01bd02
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
343 because the tool was in conflict with the philosophy of MH.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
344 It provided an interactive shell to access the features of MH,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
345 but it wasn't just a shell, tailored to the needs of mail handling.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
346 Instead it was one large program that had several MH tools built in.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
347 This conflicts with the major feature of MH of being a tool chest.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
348 .Pn msh 's
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
349 main use case had been accessing Bulletin Boards, which have seized to
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
350 be popular.
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
351 .P
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
352 Removing
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
353 .Pn msh ,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
354 together with the truly archaic code relicts
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
355 .Pn vmh
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
356 and
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
357 .Pn wmh ,
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
358 saved more than 7\|000 lines of C code \(en
66
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
359 about 15\|% of the project's original source code amount.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
360 Having less code \(en with equal readability, of course \(en
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
361 for the same functionality is an advantage.
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
362 Less code means less bugs and less maintenance work.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
363 As
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
364 .Pn rcvtty
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
365 and
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
366 .Pn msgchk
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
367 are assumed to be rarely used and can be implemented in different ways,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
368 why should one keep them?
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
369 Removing them stream-lines mmh.
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
370 .Pn viamail 's
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
371 use case is now partly obsolete and partly covered by
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
372 .Pn forw ,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
373 hence there's no reason to still maintain it.
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
374 .Pn conflict
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
375 is not related to the mail client, and
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
376 .Pn msh
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
377 conflicts with the basic concept of MH.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
378 Theses two tools might still be useful, but they should not be part of mmh.
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
379 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
380 Finally, there's
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
381 .Pn slocal .
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
382 .Pn slocal
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
383 is an MDA and thus not directly MUA-related.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
384 It should be removed from mmh, because including it conflicts with
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
385 the idea that mmh is a MUA only.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
386 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
387 should rather become a separate project.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
388 However,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
389 .Pn slocal
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
390 provides rule-based processing of messages, like filing them into
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
391 different folders, which is otherwise not available in mmh.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
392 Although
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
393 .Pn slocal
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
394 does neither pull in dependencies nor does it include a separate
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
395 technical area (cf. Sec. XXX), still,
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
396 it accounts for about 1\|000 lines of code that need to be maintained.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
397 As
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
398 .Pn slocal
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
399 is almost self-standing, it should be split off into a separate project.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
400 This would cut the strong connection between the MUA mmh and the MDA
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
401 .Pn slocal .
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
402 For anyone not using MH,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
403 .Pn slocal
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
404 would become yet another independent MDA, like
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
405 .I procmail .
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
406 Then
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
407 .Pn slocal
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
408 could be installed without the complete MH system.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
409 Likewise, mmh users could decide to use
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
410 .I procmail
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
411 without having a second, unused MDA,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
412 .Pn slocal ,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
413 installed.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
414 That appears to be conceptionally the best solution.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
415 Yet,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
416 .Pn slocal
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
417 is not split off.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
418 I defer the decision over
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
419 .Pn slocal
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
420 in need for deeper investigation.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
421 In the meanwhile, it remains part of mmh.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
422 That does not hurt because
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
423 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
424 is unrelated to the rest of the project.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
425
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
426
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
427 .H2 "\fLshow\fP and \fPmhshow\fP
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
428 .P
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
429 Since the very beginning \(en already in the first concept paper \(en
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
430 .Pn show
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
431 had been MH's message display program.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
432 .Pn show
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
433 mapped message numbers and sequences to files and invoked
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
434 .Pn mhl
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
435 to have the files formatted.
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
436 With MIME, this approach wasn't sufficient anymore.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
437 MIME messages can consist of multiple parts. Some parts are not
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
438 directly displayable and text content might be encoded in
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
439 foreign charsets.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
440 .Pn show 's
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
441 understanding of messages and
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
442 .Pn mhl 's
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
443 display capabilities couldn't cope with the task any longer.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
444 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
445 Instead of extending these tools, additional tools were written from
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
446 scratch and added to the MH tool chest.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
447 Doing so is encouraged by the tool chest approach.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
448 Modular design is a great advantage for extending a system,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
449 as new tools can be added without interfering with existing ones.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
450 First, the new MIME features were added in form of the single program
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
451 .Pn mhn .
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
452 The command
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
453 .Cl "mhn -show 42
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
454 would show the MIME message numbered 42.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
455 With the 1.0 release of nmh in February 1999, Richard Coleman finished
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
456 the split of
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
457 .Pn mhn
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
458 into a set of specialized tools, which together covered the
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
459 multiple aspects of MIME.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
460 One of them was
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
461 .Pn mhshow ,
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
462 which replaced
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
463 .Cl "mhn -show" .
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
464 It was capable of displaying MIME messages appropriately.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
465 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
466 From then on, two message display tools were part of nmh,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
467 .Pn show
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
468 and
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
469 .Pn mhshow .
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
470 To ease the life of users,
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
471 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
472 was extended to automatically hand the job over to
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
473 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
474 if displaying the message would be beyond
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
475 .Pn show 's
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
476 abilities.
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
477 In consequence, the user would simply invoke
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
478 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
479 (possibly through
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
480 .Pn next
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
481 or
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
482 .Pn prev )
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
483 and get the message printed with either
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
484 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
485 or
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
486 .Pn mhshow ,
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
487 whatever was more appropriate.
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
488 .P
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
489 Having two similar tools for essentially the same task is redundant.
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
490 Usually,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
491 users wouldn't distinguish between
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
492 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
493 and
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
494 .Pn mhshow
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
495 in their daily mail reading.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
496 Having two separate display programs was therefore mainly unnecessary
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
497 from a user's point of view.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
498 Besides, the development of both programs needed to be in sync,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
499 to ensure that the programs behaved in a similar way,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
500 because they were used like a single tool.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
501 Different behavior would have surprised the user.
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
502 .P
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
503 Today, non-MIME messages are rather seen to be a special case of
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
504 MIME messages, although it is the other way round.
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
505 As
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
506 .Pn mhshow
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
507 had already be able to display non-MIME messages, it appeared natural
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
508 to drop
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
509 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
510 in favor of using
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
511 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
512 exclusively.
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
513 .Ci 4c1efddfd499300c7e74263e57d8aa137e84c853
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
514 Removing
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
515 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
516 is no loss in function, because functionally
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
517 .Pn mhshow
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
518 covers it completely.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
519 The old behavior of
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
520 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
521 can still be emulated with the simple command line:
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
522 .VS
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
523 mhl `mhpath c`
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
524 VE
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
525 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
526 For convenience,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
527 .Pn mhshow
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
528 was renamed to
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
529 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
530 after
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
531 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
532 was gone.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
533 It is clear that such a rename may confuse future developers when
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
534 trying to understand the history.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
535 Nevertheless, I consider the convenience on the user's side,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
536 to call
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
537 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
538 when they want a message to be displayed, to outweigh the inconvenience
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
539 on the developer's side when understanding the project history.
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
540 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
541 To prepare for the transition,
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
542 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
543 was reworked to behave more like
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
544 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
545 first.
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
546 (cf. Sec. XXX)
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
547 Once the tools behaved more alike, the replacing appeared to be
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
548 even more natural.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
549 Today, mmh's new
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
550 .Pn show
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
551 became the one single message display program again, with the difference
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
552 that today it handles MIME messages as well as non-MIME messages.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
553 The outcome of the transition is one program less to maintain,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
554 no second display program for users to deal with,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
555 and less system complexity.
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
556 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
557 Still, removing the old
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
558 .Pn show
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
559 hurts in one regard: It had been such a simple program.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
560 Its lean elegance is missing to the new
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
561 .Pn show .
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
562 But there is no chance;
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
563 supporting MIME demands for higher essential complexity.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
564
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
565
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
566 .H2 "Configure Options
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
567 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
568 Customization is a double-edged sword.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
569 It allows better suiting setups, but not for free.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
570 There is the cost of code complexity to be able to customize.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
571 There is the cost of less tested setups, because there are
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
572 more possible setups and especially corner-cases.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
573 And, there is the cost of choice itself.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
574 The code complexity directly affects the developers.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
575 Less tested code affects both, users and developers.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
576 The problem of choice affects the users, for once by having to
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
577 choose, but also by more complex interfaces that require more documentation.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
578 Whenever options add little advantages, they should be considered for
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
579 removal.
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
580 I have reduced the number of project-specific configure options from
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
581 fifteen to three.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
582
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
583 .U3 "Mail Transfer Facilities
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
584 .P
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
585 With the removal of the mail transfer facilities five configure
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
586 options vanished:
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
587 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
588 The switches
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
589 .Sw --with-tls
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
590 and
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
591 .Sw --with-cyrus-sasl
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
592 had activated the support for transfer encryption and authentication.
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
593 This is not needed anymore.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
594 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
595 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
596 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
597 The configure switch
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
598 .Sw --enable-pop
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
599 activated the message retrieval facility.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
600 The code area that would be conditionally compiled in for TLS and SASL
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
601 support had been small.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
602 The conditionally compiled code area for POP support had been much larger.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
603 Whereas the code base changes would only slightly change on toggling
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
604 TLS or SASL support, it changed much on toggling POP support.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
605 The changes in the code base could hardly be overviewed.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
606 By having POP support togglable a second code base had been created,
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
607 one that needed to be tested.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
608 This situation is basically similar for the conditional TLS and SASL
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
609 code, but there the changes are minor and can yet be overviewed.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
610 Still, conditional compilation of a code base creates variations
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
611 of the original program.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
612 More variations require more testing and maintenance work.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
613 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
614 Two other options only specified default configuration values:
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
615 .Sw --with-mts
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
616 defined the default transport service, either
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
617 .Ar smtp
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
618 or
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
619 .Ar sendmail .
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
620 In mmh this fixed to
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
621 .Ar sendmail .
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
622 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
623 With
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
624 .Sw --with-smtpservers
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
625 default SMTP servers for the
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
626 .Ar smtp
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
627 transport service could be specified.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
628 .Ci 128545e06224233b7e91fc4c83f8830252fe16c9
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
629 Both of them became irrelevant.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
630
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
631 .U3 "Backup Prefix
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
632 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
633 The backup prefix is the string that was prepended to message
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
634 filenames to tag them as deleted.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
635 By default it had been the comma character `\f(CW,\fP'.
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
636 In July 2000, Kimmo Suominen introduced
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
637 the configure option
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
638 .Sw --with-hash-backup
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
639 to change the default to the hash symbol `\f(CW#\fP'.
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
640 The choice was probably personal preference, because first, the
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
641 option was named
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
642 .Sw --with-backup-prefix.
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
643 and had the prefix symbol as argument.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
644 But giving the hash symbol as argument caused too many problems
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
645 for Autoconf,
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
646 thus the option was limited to use the hash symbol as the default prefix.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
647 This supports the assumption, that the choice for the hash was
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
648 personal preference only.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
649 Being related or not, words that start with the hash symbol
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
650 introduce a comment in the Unix shell.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
651 Thus, the command line
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
652 .Cl "rm #13 #15
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
653 calls
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
654 .Pn rm
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
655 without arguments because the first hash symbol starts the comment
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
656 that reaches until the end of the line.
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
657 To delete the backup files,
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
658 .Cl "rm ./#13 ./#15"
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
659 needs to be used.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
660 Using the hash as backup prefix can be seen as a precaution against
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
661 data loss.
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
662 .P
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
663 I removed the configure option but added the profile entry
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
664 .Pe backup-prefix ,
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
665 which allows to specify an arbitrary string as backup prefix.
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
666 .Ci 6c40d481d661d532dd527eaf34cebb6d3f8ed086
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
667 Profile entries are the common method to change mmh's behavior.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
668 This change did not remove the choice but moved it to a location where
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
669 it suited better.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
670 .P
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
671 Eventually, however, the new trash folder concept
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
672 .Cf "Sec. XXX
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
673 obsoleted the concept of the backup prefix completely.
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
674 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
675 .\" (Well, there still are corner-cases to remove until the backup
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
676 .\" prefix can be laid to rest, eventually.)
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
677 .\" FIXME: Do this work in the code!
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
678
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
679 .U3 "Editor and Pager
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
680 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
681 The two configure options
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
682 .CW --with-editor=EDITOR
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
683 .CW --with-pager=PAGER
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
684 were used to specify the default editor and pager at configure time.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
685 Doing so at configure time made sense in the eighties,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
686 when the set of available editors and pagers varied much across
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
687 different systems.
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
688 Today, the situation is more homogeneous.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
689 The programs
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
690 .Pn vi
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
691 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
692 .Pn more
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
693 can be expected to be available on every Unix system,
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
694 as they are specified by POSIX since two decades.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
695 (The specifications for
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
696 .Pn vi
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
697 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
698 .Pn more
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
699 appeared in
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
700 .[
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
701 posix 1987
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
702 .]
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
703 and,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
704 .[
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
705 posix 1992
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
706 .]
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
707 respectively.)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
708 As a first step, these two tools were hard-coded as defaults.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
709 .Ci 5d43a99db70c12a673028c7758c20cbe3e13ef5f
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
710 Not changed were the
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
711 .Pe editor
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
712 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
713 .Pe moreproc
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
714 profile entries, which allowed the user to override the system defaults.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
715 Later, the concept was reworked to respect the standard environment
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
716 variables
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
717 .Ev VISUAL
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
718 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
719 .Ev PAGER
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
720 if they are set.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
721 Today, mmh determines the editor to use in the following order,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
722 taking the first available and non-empty item:
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
723 .IP (1)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
724 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
725 .Ev MMHEDITOR
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
726 .IP (2)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
727 Profile entry
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
728 .Pe Editor
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
729 .IP (3)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
730 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
731 .Ev VISUAL
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
732 .IP (4)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
733 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
734 .Ev EDITOR
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
735 .IP (5)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
736 Command
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
737 .Pn vi .
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
738 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
739 .Ci f85f4b7ae62e3d05a945dcd46ead51f0a2a89a9b
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
740 .P
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
741 The pager to use is determined in a similar order,
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
742 also taking the first available and non-empty item:
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
743 .IP (1)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
744 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
745 .Ev MMHPAGER
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
746 .IP (2)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
747 Profile entry
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
748 .Pe Pager
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
749 (replaces
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
750 .Pe moreproc )
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
751 .IP (3)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
752 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
753 .Ev PAGER
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
754 .IP (4)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
755 Command
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
756 .Pn more .
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
757 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
758 .Ci 0c4214ea2aec6497d0d67b436bbee9bc1d225f1e
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
759 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
760 By respecting the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
761 .Ev VISUAL /\c
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
762 .Ev EDITOR
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
763 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
764 .Ev PAGER
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
765 environment variables,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
766 the new behavior confirms better to the common style on Unix systems.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
767 Additionally, the new approach is more uniform and clearer to users.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
768
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
769
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
770 .U3 "ndbm
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
771 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
772 .Pn slocal
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
773 used to depend on
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
774 .I ndbm ,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
775 a database library.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
776 The database is used to store the `\fLMessage-ID\fP's of all
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
777 messages delivered.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
778 This enables
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
779 .Pn slocal
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
780 to suppress delivering the same message to the same user twice.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
781 (This features was enabled by the
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
782 .Sw -suppressdup
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
783 switch.)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
784 .P
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
785 A variety of versions of the database library exist.
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
786 .[
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
787 wolter unix incompat notes dbm
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
788 .]
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
789 Complicated autoconf code was needed to detect them correctly.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
790 Further more, the configure switches
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
791 .Sw --with-ndbm=ARG
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
792 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
793 .Sw --with-ndbmheader=ARG
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
794 were added to help with difficult setups that would
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
795 not be detected automatically or correctly.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
796 .P
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
797 By removing the suppress duplicates feature of
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
798 .Pn slocal ,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
799 the dependency on
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
800 .I ndbm
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
801 vanished and 120 lines of complex autoconf code could be saved.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
802 .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
803 The change removed functionality too, but that is minor to the
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
804 improvement by dropping the dependency and the complex autoconf code.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
805
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
806 .U3 "mh-e Support
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
807 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
808 The configure option
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
809 .Sw --disable-mhe
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
810 was removed when the mh-e support was reworked.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
811 Mh-e is the Emacs front-end to MH.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
812 It requires MH to provide minor additional functions.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
813 The
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
814 .Sw --disable-mhe
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
815 configure option could switch these extensions off.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
816 After removing the support for old versions of mh-e,
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
817 only the
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
818 .Sw -build
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
819 switches of
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
820 .Pn forw
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
821 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
822 .Pn repl
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
823 are left to be mh-e extensions.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
824 They are now always built in because they add little code and complexity.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
825 In consequence, the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
826 .Sw --disable-mhe
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
827 configure option was removed
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
828 .Ci a7ce7b4a580d77b6c2c4d980812beb589aa4c643
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
829 Removing the option removed a second code setup that would have
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
830 needed to be tested.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
831 This change was first done in nmh and thereafter merged into mmh.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
832 .P
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
833 The interface changes in mmh require mh-e to be adjusted in order
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
834 to be able to use mmh as back-end.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
835 This will require minor changes to mh-e, but removing the
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
836 .Sw -build
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
837 switches would require more rework.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
838
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
839 .U3 "Masquerading
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
840 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
841 The configure option
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
842 .Sw --enable-masquerade
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
843 could take up to three arguments:
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
844 `draft_from', `mmailid', and `username_extension'.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
845 They activated different types of address masquerading.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
846 All of them were implemented in the SMTP-speaking
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
847 .Pn post
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
848 command, which provided an MSA.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
849 Address masquerading is an MTA's task and mmh does not cover
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
850 this field anymore.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
851 Hence, true masquerading needs to be implemented in the external MTA.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
852 .P
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
853 The
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
854 .I mmailid
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
855 masquerading type is the oldest one of the three and the only one
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
856 available in the original MH.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
857 It provided a
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
858 .I username
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
859 to
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
860 .I fakeusername
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
861 mapping, based on the password file's GECOS field.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
862 The man page
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
863 .Mp mh-tailor(5)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
864 described the use case as being the following:
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
865 .QS
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
866 This is useful if you want the messages you send to always
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
867 appear to come from the name of an MTA alias rather than your
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
868 actual account name. For instance, many organizations set up
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
869 `First.Last' sendmail aliases for all users. If this is
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
870 the case, the GECOS field for each user should look like:
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
871 ``First [Middle] Last <First.Last>''
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
872 .QE
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
873 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
874 As mmh sends outgoing mail via the local MTA only,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
875 the best location to do such global rewrites is there.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
876 Besides, the MTA is conceptionally the right location because it
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
877 does the reverse mapping for incoming mail (aliasing), too.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
878 Further more, masquerading set up there is readily available for all
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
879 mail software on the system.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
880 Hence, mmailid masquerading was removed.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
881 .Ci 0836c8000ccb34b59410ef1c15b1b7feac70ce5f
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
882 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
883 The
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
884 .I username_extension
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
885 masquerading type did not replace the username but would append a suffix,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
886 specified by the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
887 .Ev USERNAME_EXTENSION
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
888 environment variable, to it.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
889 This provided support for the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
890 .I user-extension
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
891 feature of qmail and the similar
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
892 .I "plussed user
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
893 processing of sendmail.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
894 The decision to remove this username_extension masquerading was
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
895 motivated by the fact that
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
896 .Pn spost
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
897 hadn't supported it already.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
898 .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
899 Username extensions are possible in mmh, but less convenient to use.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
900 .\" XXX format file %(getenv USERNAME_EXTENSION)
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
901 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
902 The
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
903 .I draft_from
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
904 masquerading type instructed
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
905 .Pn post
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
906 to use the value of the
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
907 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
908 header field as SMTP envelope sender.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
909 Sender addresses could be replaced completely.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
910 .Ci b14ea6073f77b4359aaf3fddd0e105989db9
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
911 Mmh offers a kind of masquerading similar in effect, but
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
912 with technical differences.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
913 As mmh does not transfer messages itself, the local MTA has final control
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
914 over the sender's address. Any masquerading mmh introduces may be reverted
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
915 by the MTA.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
916 In times of pedantic spam checking, an MTA will take care to use
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
917 sensible envelope sender addresses to keep its own reputation up.
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
918 Nonetheless, the MUA can set the
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
919 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
920 header field and thereby propose
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
921 a sender address to the MTA.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
922 The MTA may then decide to take that one or generate the canonical sender
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
923 address for use as envelope sender address.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
924 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
925 In mmh, the MTA will always extract the recipient and sender from the
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
926 message header (\c
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
927 .Pn sendmail 's
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
928 .Sw -t
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
929 switch).
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
930 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
931 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
932 header field of the draft may be set arbitrary by the user.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
933 If it is missing, the canonical sender address will be generated by the MTA.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
934
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
935 .U3 "Remaining Options
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
936 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
937 Two configure options remain in mmh.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
938 One is the locking method to use:
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
939 .Sw --with-locking=[dot|fcntl|flock|lockf] .
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
940 The idea of removing all methods except the portable dot locking
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
941 and having that one as the default is appealing, but this change
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
942 requires deeper technical investigation into the topic.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
943 The other option,
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
944 .Sw --enable-debug ,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
945 compiles the programs with debugging symbols and does not strip them.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
946 This option is likely to stay.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
947
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
948
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
949
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
950
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
951 .H2 "Command Line Switches
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
952 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
953 The command line switches of MH tools follow the X Window style.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
954 They are words, introduced by a single dash.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
955 For example:
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
956 .Cl "-truncate" .
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
957 Every program in mmh has two generic switches:
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
958 .Sw -help ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
959 to print a short message on how to use the program, and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
960 .Sw -Version ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
961 to tell what version of mmh the program belongs to.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
962 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
963 Switches change the behavior of programs.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
964 Programs that do one thing in one way require no switches.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
965 In most cases, doing something in exactly one way is too limiting.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
966 If there is basically one task to accomplish, but it should be done
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
967 in various ways, switches are a good approach to alter the behavior
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
968 of a program.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
969 Changing the behavior of programs provides flexibility and customization
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
970 to users, but at the same time it complicates the code, documentation and
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
971 usage of the program.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
972 .\" XXX: Ref
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
973 Therefore, the number of switches should be kept small.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
974 A small set of well-chosen switches does no harm.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
975 But usually, the number of switches increases over time.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
976 Already in 1985, Rose and Romine have identified this as a major
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
977 problem of MH:
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
978 .[ [
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
979 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
980 .], p. 12]
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
981 .QS
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
982 A complaint often heard about systems which undergo substantial development
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
983 by many people over a number of years, is that more and more options are
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
984 introduced which add little to the functionality but greatly increase the
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
985 amount of information a user needs to know in order to get useful work done.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
986 This is usually referred to as creeping featurism.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
987 .QP
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
988 Unfortunately MH, having undergone six years of off-and-on development by
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
989 ten or so well-meaning programmers (the present authors included),
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
990 suffers mightily from this.
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
991 .QE
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
992 .P
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
993 Being reluctant to adding new switches \(en or `options',
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
994 as Rose and Romine call them \(en is one part of a counter-action,
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
995 the other part is removing hardly used switches.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
996 Nmh's tools had lots of switches already implemented,
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
997 hence, cleaning up by removing some of them was the more important part
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
998 of the counter-action.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
999 Removing existing functionality is always difficult because it
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1000 breaks programs that use these functions.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1001 Also, for every obsolete feature, there'll always be someone who still
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1002 uses it and thus opposes its removal.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1003 This puts the developer into the position,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1004 where sensible improvements to style are regarded as destructive acts.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1005 Yet, living with the featurism is far worse, in my eyes, because
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1006 future needs will demand adding further features,
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1007 worsening the situation more and more.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1008 Rose and Romine added in a footnote,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1009 ``[...]
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1010 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1011 will no doubt acquire an endless number of switches in the years to come.''
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1012 Although clearly humorous, the comment points to the nature of the problem.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1013 Refusing to add any new switches would encounter the problem at its root,
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1014 but this is not practical.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1015 New needs will require new switches and it would be unwise to block
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1016 them strictly.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1017 Nevertheless, removing obsolete switches still is an effective approach
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1018 to deal with the problem.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1019 Working on an experimental branch without an established user base,
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1020 eased my work because I did not offend users when I removed existing
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1021 functions.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1022 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1023 Rose and Romine counted 24 visible and 9 more hidden switches for
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1024 .Pn send .
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1025 In nmh, they increased up to 32 visible and 12 hidden ones.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1026 At the time of writing, no more than 7 visible switches and 1 hidden switch
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1027 have remained in mmh's
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1028 .Pn send .
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1029 (These numbers include two generic switches, help and version.)
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1030 .P
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1031 Fig. XXX
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1032 .\" XXX Ref
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1033 displays the number of switches for each of the tools that is available
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1034 in both, nmh and mmh.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1035 The tools are sorted by the number of switches they had in nmh.
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1036 Visible and hidden switches were counted,
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1037 but not the generic help and version switches.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1038 Whereas in the beginning of the project, the average tool had 11 switches,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1039 now it has no more than 5 \(en only half as many.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1040 If the `no' switches and similar inverse variant are folded onto
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1041 their counter-parts, the average tool had 8 switches in pre-mmh times and
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1042 has 4 now.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1043 The total number of functional switches in mmh dropped from 465
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1044 to 234.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1045
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1046 .KS
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1047 .in 1c
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1048 .so input/switches.grap
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1049 .KE
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1050
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1051 .P
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1052 A part of the switches vanished after functions were removed.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1053 This was the case for network mail transfer, for instance.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1054 Sometimes, however, the work flow was the other way:
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1055 I looked through the
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1056 .Mp mh-chart (7)
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1057 man page to identify the tools with apparently too many switches.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1058 Then considering the value of each of the switches by examining
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1059 the tool's man page and source code, aided by recherche and testing.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1060 This way, the removal of functions was suggested by the aim to reduce
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1061 the number of switches per command.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1062
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1063
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1064 .U3 "Draft Folder Facility
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1065 .P
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1066 A change early in the project was the complete transition from
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1067 the single draft message to the draft folder facility.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1068 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1069 The draft folder facility was introduced in the mid-eighties, when
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1070 Rose and Romine called it a ``relatively new feature''.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1071 .[
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1072 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1073 .]
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1074 Since then, the facility had existed but was inactive by default.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1075 The default activation and the related rework of the tools made it
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1076 possible to remove the
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1077 .Sw -[no]draftfolder ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1078 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1079 .Sw -draftmessage
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1080 switches from
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1081 .Pn comp ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1082 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1083 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1084 .Pn dist ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1085 .Pn whatnow ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1086 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1087 .Pn send .
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1088 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1089 The only flexibility removed with this change is having multiple
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1090 draft folders within one profile.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1091 I consider this a theoretical problem only.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1092 In the same go, the
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1093 .Sw -draft
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1094 switch of
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1095 .Pn anno ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1096 .Pn refile ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1097 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1098 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1099 was removed.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1100 The special-casing of `the' draft message became irrelevant after
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1101 the rework of the draft system.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1102 (See Sec. XXX.)
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1103 Equally,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1104 .Pn comp
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1105 lost its
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1106 .Sw -file
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1107 switch.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1108 The draft folder facility, together with the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1109 .Sw -form
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1110 switch, are sufficient.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1111
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1112
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1113 .U3 "In Place Editing
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1114 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1115 .Pn anno
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1116 had the switches
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1117 .Sw -[no]inplace
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1118 to either annotate the message in place and thus preserve hard links,
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1119 or annotate a copy to replace the original message, breaking hard links.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1120 Following the assumption that linked messages should truly be the
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1121 same message, and annotating it should not break the link, the
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1122 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1123 switches were removed and the previous default
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1124 .Sw -inplace
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1125 was made the only behavior.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1126 .Ci c8195849d2e366c569271abb0f5f60f4ebf0b4d0
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1127 The
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1128 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1129 switches of
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1130 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1131 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1132 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1133 .Pn dist
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1134 could be removed, too, as they were simply passed through to
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1135 .Pn anno .
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1136 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1137 .Pn burst
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1138 also had
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1139 .Sw -[no]inplace
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1140 switches, but with different meaning.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1141 With
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1142 .Sw -inplace ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1143 the digest had been replaced by the table of contents (i.e. the
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1144 introduction text) and the burst messages were placed right
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1145 after this message, renumbering all following messages.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1146 Also, any trailing text of the digest was lost, though,
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1147 in practice, it usually consists of an end-of-digest marker only.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1148 Nontheless, this behavior appeared less elegant than the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1149 .Sw -noinplace
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1150 behavior, which already had been the default.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1151 Nmh's
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1152 .Mp burst (1)
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1153 man page reads:
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1154 .sp \n(PDu
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1155 .QS
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1156 If -noinplace is given, each digest is preserved, no table
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1157 of contents is produced, and the messages contained within
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1158 the digest are placed at the end of the folder. Other messages
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1159 are not tampered with in any way.
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1160 .QE
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1161 .LP
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1162 The decision to drop the
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1163 .Sw -inplace
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1164 behavior was supported by the code complexity and the possible data loss
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1165 it caused.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1166 .Sw -noinplace
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1167 was chosen to be the definitive behavior.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1168 .Ci 68a686adeb39223a5e1ad35e4a24890ec053679d
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1169
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1170
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1171 .U3 "Forms and Format Strings
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1172 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1173 Historically, the tools that had
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1174 .Sw -form
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1175 switches to supply a form file had
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1176 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1177 switches as well to supply the contents of a form file as a string
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1178 on the command line directly.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1179 In consequence, the following two lines equaled:
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1180 .VS
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1181 scan -form scan.mailx
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1182 scan -format "`cat .../scan.mailx`"
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1183 VE
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1184 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1185 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1186 switches were dropped in favor for extending the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1187 .Sw -form
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1188 switches.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1189 .Ci f51956be123db66b00138f80464d06f030dbb88d
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1190 If their argument starts with an equal sign (`='),
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1191 then the rest of the argument is taken as a format string,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1192 otherwise the arguments is treated as the name of a format file.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1193 Thus, now the following two lines equal:
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1194 .VS
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1195 scan -form scan.mailx
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1196 scan -form "=`cat .../scan.mailx`"
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1197 VE
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1198 This rework removed the prefix collision between
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1199 .Sw -form
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1200 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1201 .Sw -format .
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1202 Now, typing
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1203 .Sw -fo
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1204 suffices to specify form or format string.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1205 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1206 The different meaning of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1207 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1208 for
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1209 .Pn repl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1210 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1211 .Pn forw
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1212 was removed in mmh.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1213 .Pn forw
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1214 was completely switched to MIME-type forwarding, thus removing the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1215 .Sw -[no]format .
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1216 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1217 For
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1218 .Pn repl ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1219 the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1220 .Sw -[no]format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1221 switches were reworked to
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1222 .Sw -[no]filter
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1223 switches.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1224 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1225 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1226 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1227 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1228 .Pn send
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1229 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1230 .Pn post ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1231 which had a third meaning,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1232 were removed likewise.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1233 .Ci f3cb7cde0e6f10451b6848678d95860d512224b9
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1234 Eventually, the ambiguity of the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1235 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1236 switches was resolved by not anymore having any such switch in mmh.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1237
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1238
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1239 .U3 "MIME Tools
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1240 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1241 The MIME tools, which were once part of
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1242 .Pn mhn
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1243 [sic!],
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1244 had several switches that added little practical value to the programs.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1245 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1246 .Sw -[no]realsize
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1247 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1248 .Pn mhbuild
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1249 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1250 .Pn mhlist
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1251 were removed, doing real size calculations always now
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1252 .Ci 8d8f1c3abc586c005c904e52c4adbfe694d2201c ,
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1253 as
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1254 ``This provides an accurate count at the expense of a small delay.''
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1255 This small delay is not noticable on modern systems.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1256 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1257 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1258 .Sw -[no]check
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1259 switches were removed together with the support for
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1260 .Hd Content-MD5
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1261 header fields.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1262 .[
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1263 rfc 1864
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1264 .]
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1265 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1266 (See Sec. XXX)
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1267 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1268 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1269 .Sw -[no]ebcdicsafe
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1270 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1271 .Sw -[no]rfc934mode
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1272 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1273 .Pn mhbuild
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1274 were removed because they are considered obsolete.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1275 .Ci 01a3480928da485b4d6109d36d751dfa71799d58
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1276 .Ci 3363e2624dce0eb8164cf8b3f1ab385c8ff72e88
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1277 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1278 Content caching of external MIME parts, activated with the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1279 .Sw -rcache
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1280 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1281 .Sw -wcache
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1282 switches was completely removed.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1283 .Ci d1fefd9f614e4dc3cda16da6c69133c1b2005269
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1284 External MIME parts are rare today, having a caching facility
96
12348d620245 Spell checking.
markus schnalke <meillo@marmaro.de>
parents: 95
diff changeset
1285 for them is appears to be unnecessary.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1286 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1287 In pre-MIME times,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1288 .Pn mhl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1289 had covered many tasks that are part of MIME handling today.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1290 Therefore,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1291 .Pn mhl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1292 could be simplified to a large extend, reducing the number of its
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1293 switches from 21 to 6.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1294 .Ci 350ad6d3542a07639213cf2a4fe524e829c1e7b6
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1295 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1296
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1297
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1298 .U3 "Mail Transfer Switches
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1299 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1300 With the removal of the mail transfer facilities, a lot of switches
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1301 vanished automatically.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1302 .Pn inc
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1303 lost 9 switches, namely
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1304 .Sw -host ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1305 .Sw -port ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1306 .Sw -user ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1307 .Sw -proxy ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1308 .Sw -snoop ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1309 .Sw -[no]pack ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1310 as well as
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1311 .Sw -sasl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1312 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1313 .Sw -saslmech .
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1314 .Pn send
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1315 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1316 .Pn post
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1317 lost 11 switches each, namely
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1318 .Sw -server ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1319 .Sw -port ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1320 .Sw -client ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1321 .Sw -user ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1322 .Sw -mail ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1323 .Sw -saml ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1324 .Sw -send ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1325 .Sw -soml ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1326 .Sw -snoop ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1327 as well as
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1328 .Sw -sasl ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1329 .Sw -saslmech ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1330 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1331 .Sw -tls .
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1332 .Pn send
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1333 had the switches only to pass them further to
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1334 .Pn post ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1335 because the user would invoke
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1336 .Pn post
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1337 not directly, but through
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1338 .Pn send .
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1339 All these switches, except
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1340 .Sw -snoop
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1341 were usually defined as default switches in the user's profile,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1342 but hardly given in interactive usage.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1343 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1344 Of course, those switches did not really ``vanish'', but the configuration
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1345 they did was handed over to external MSAs and MRAs.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1346 Instead of setting up the mail transfer in mmh, it is set up in
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1347 external tools.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1348 Yet, this simplifies mmh.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1349 Specialized external tools will likely have simple configuration files.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1350 Hence, instead of having one complicated central configuration file,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1351 the configuration of each domain is separate.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1352 Although the user needs to learn to configure each of the tools,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1353 each configuration is likely much simpler.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1354
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1355
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1356 .U3 "Maildrop Formats
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1357 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1358 With the removal of MMDF maildrop format support,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1359 .Pn packf
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1360 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1361 .Pn rcvpack
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1362 no longer needed their
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1363 .Sw -mbox
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1364 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1365 .Sw -mmdf
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1366 switches.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1367 .Sw -mbox
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1368 is the sole behavior now.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1369 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1370 In the same go,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1371 .Pn packf
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1372 and
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1373 .Pn rcvpack
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1374 were reworked (see Sec. XXX) and their
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1375 .Sw -file
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1376 switch became unnecessary.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1377 .Ci ca1023716d4c2ab890696f3e41fa0d94267a940e
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1378
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1379
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1380 .U3 "Terminal Magic
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1381 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1382 Mmh's tools will no longer clear the screen (\c
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1383 .Pn scan 's
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1384 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1385 .Pn mhl 's
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1386 .Sw -[no]clear
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1387 switches
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1388 .Ci e57b17343dcb3ff373ef4dd089fbe778f0c7c270
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1389 .Ci 943765e7ac5693ae177fd8d2b5a2440e53ce816e ).
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1390 Neither will
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1391 .Pn mhl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1392 ring the bell (\c
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1393 .Sw -[no]bell
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1394 .Ci e11983f44e59d8de236affa5b0d0d3067c192e24 )
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1395 nor page the output itself (\c
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1396 .Sw -length
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1397 .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ).
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1398 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1399 Generally, the pager to use is no longer specified with the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1400 .Sw -[no]moreproc
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1401 command line switches for
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1402 .Pn mhl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1403 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1404 .Pn show /\c
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1405 .Pn mhshow .
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1406 .Ci 39e87a75b5c2d3572ec72e717720b44af291e88a
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1407 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1408 .Pn prompter
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1409 lost its
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1410 .Sw -erase
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1411 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1412 .Sw -kill
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1413 switches because today the terminal cares for the line editing keys.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1414
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1415
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1416 .U3 "Header Printing
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1417 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1418 .Pn folder 's
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1419 data output is self-explaining enough that
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1420 displaying the header line makes few sense.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1421 Hence, the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1422 .Sw -[no]header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1423 switch was removed and headers are never printed.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1424 .Ci 601cc73d1fa05ce96faa728f036d6c51b91701c7
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1425 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1426 In
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1427 .Pn mhlist ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1428 the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1429 .Sw -[no]header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1430 switches were removed, too.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1431 .Ci b24f96523aaf60e44e04a3ffb1d22e69a13a602f
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1432 But in this case headers are always printed,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1433 because the output is not self-explaining.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1434 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1435 .Pn scan
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1436 also had
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1437 .Sw -[no]header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1438 switches.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1439 Printing the header had been sensible until the introduction of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1440 format strings made it impossible to display the column headings.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1441 Only the folder name and the current date remained to be printed.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1442 As this information can be perfectly retrieved by
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1443 .Pn folder
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1444 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1445 .Pn date ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1446 consequently, the switches were removed.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1447 .Ci c477dc5d1d03fa6d9a8ab3dd3508c63cbddc044e
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1448 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1449 By removing all
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1450 .Sw -header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1451 switches, the collision with
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1452 .Sw -help
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1453 on the first two letters was resolved.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1454 Currently,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1455 .Sw -h
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1456 evaluates to
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1457 .Sw -help
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1458 for all tools of mmh.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1459
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1460
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1461 .U3 "Suppressing Edits or the WhatNow Shell
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1462 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1463 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1464 .Sw -noedit
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1465 switch of
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1466 .Pn comp ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1467 .Pn repl ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1468 .Pn forw ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1469 .Pn dist ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1470 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1471 .Pn whatnow
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1472 was removed, but it can now be replaced by specifying
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1473 .Sw -editor
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1474 with an empty argument.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1475 .Ci 75fca31a5b9d5c1a99c74ab14c94438d8852fba9
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1476 (Specifying
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1477 .Cl "-editor true
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1478 is nearly the same, only differing by the previous editor being set.)
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1479 .P
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1480 The more important change is the removal of the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1481 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1482 switch.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1483 .Ci ee4f43cf2ef0084ec698e4e87159a94c01940622
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1484 This switch had introduced an awkward behavior, as explained in nmh's
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1485 man page for
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1486 .Mp comp (1):
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1487 .QS
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1488 The \-editor editor switch indicates the editor to use for
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1489 the initial edit. Upon exiting from the editor, comp will
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1490 invoke the whatnow program. See whatnow(1) for a discussion
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1491 of available options. The invocation of this program can be
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1492 inhibited by using the \-nowhatnowproc switch. (In truth of
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1493 fact, it is the whatnow program which starts the initial
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1494 edit. Hence, \-nowhatnowproc will prevent any edit from
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1495 occurring.)
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1496 .QE
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1497 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1498 Effectively, the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1499 .Sw -nowhatnowproc
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1500 switch creates only a draft message.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1501 As
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1502 .Cl "-whatnowproc true
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1503 causes the same behavior, the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1504 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1505 switch was removed for being redundant.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1506 Likely, the
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1507 .Sw -nowhatnowproc
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1508 switch was intended to be used by front-ends.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1509
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1510
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1511 .U3 "Compatibility Switches
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1512 .BU
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1513 The hidden
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1514 .Sw -[no]total
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1515 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1516 .Pn flist .
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1517 They were simply the inverse of the visible
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1518 .Sw -[no]fast
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1519 switches:
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1520 .Sw -total
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1521 was
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1522 .Sw -nofast
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1523 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1524 .Sw -nototal
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1525 was
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1526 .Sw -fast .
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1527 I removed the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1528 .Sw -[no]total
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1529 legacy.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1530 .Ci ea21fe2c4bd23c639bef251398fae809875732ec
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1531 .BU
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1532 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1533 .Sw -subject
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1534 switch of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1535 .Pn sortm
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1536 existed for compatibility only.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1537 It can be fully replaced by
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1538 .Cl "-textfield subject
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1539 thus it was removed.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1540 .Ci 00140a3c86e9def69d98ba2ffd4d6e50ef6326ea
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1541
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1542
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1543 .U3 "Various
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1544 .BU
96
12348d620245 Spell checking.
markus schnalke <meillo@marmaro.de>
parents: 95
diff changeset
1545 In order to avoid prefix collisions among switch names, the
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1546 .Sw -version
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1547 switch was renamed to
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1548 .Sw -Version
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1549 (with capital `V').
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1550 .Ci 32b2354dbaf4bf934936eb5b102a4a3d2fdd209a
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1551 Every program has the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1552 .Sw -version
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1553 switch but its first three letters collided with the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1554 .Sw -verbose
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1555 switch, present in many programs.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1556 The rename solved this problem once for all.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1557 Although this rename breaks a basic interface, having the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1558 .Sw -V
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1559 abbreviation to display the version information, isn't all too bad.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1560 .BU
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1561 .Sw -[no]preserve
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1562 of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1563 .Pn refile
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1564 was removed because what use was it anyway?
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1565 .QS
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1566 Normally when a message is refiled, for each destination
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1567 folder it is assigned the number which is one above the current
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1568 highest message number in that folder. Use of the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1569 \-preserv [sic!] switch will override this message renaming, and try
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1570 to preserve the number of the message. If a conflict for a
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1571 particular folder occurs when using the \-preserve switch,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1572 then refile will use the next available message number which
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1573 is above the message number you wish to preserve.
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1574 .QE
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1575 .BU
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1576 The removal of the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1577 .Sw -[no]reverse
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1578 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1579 .Pn scan
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1580 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1581 is a bug fix, supported by the comments
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1582 ``\-[no]reverse under #ifdef BERK (I really HATE this)''
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1583 by Rose and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1584 ``Lists messages in reverse order with the `\-reverse' switch.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1585 This should be considered a bug.'' by Romine in the documentation.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1586 The question remains why neither Rose and Romine had fixed this
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1587 bug in the eighties when they wrote these comments nor has anyone
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1588 thereafter.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1589
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1590
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1591 .ig
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1592
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1593 forw: [no]dashstuffing(mhl)
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1594
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1595 mhshow: [no]pause [no]serialonly
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1596
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1597 mhmail: resent queued
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1598 inc: snoop, (pop)
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1599
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1600 mhl: [no]faceproc folder sleep
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1601 [no]dashstuffing(forw) digest list volume number issue number
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1602
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1603 prompter: [no]doteof
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1604
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1605 refile: [no]preserve [no]unlink [no]rmmproc
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1606
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1607 send: [no]forward [no]mime [no]msgid
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1608 [no]push split [no]unique (sasl) width snoop [no]dashstuffing
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1609 attach attachformat
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1610 whatnow: (noedit) attach
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1611
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1612 slocal: [no]suppressdups
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1613
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1614 spost: [no]filter [no]backup width [no]push idanno
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1615 [no]check(whom) whom(whom)
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1616
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1617 whom: ???
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1618
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1619 ..
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1620
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1621
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1622 .ig
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1623
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1624 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1625 In the best case, all switches are unambiguous on the first character,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1626 or on the three-letter prefix for the `no' variants.
96
12348d620245 Spell checking.
markus schnalke <meillo@marmaro.de>
parents: 95
diff changeset
1627 Reducing switch prefix collisions, shortens the necessary prefix length
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1628 the user must type.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1629 Having less switches helps best.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1630
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1631 ..
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1632
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1633
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1634 .\" XXX: whatnow prompt commands
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1635
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1636
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1637
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1638
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1639 .H1 "Modernizing
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1640 .P
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1641 In the over thirty years of MH's existence, its code base was
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1642 extended more and more.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1643 New features entered the project and became alternatives to the
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1644 existing behavior.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1645 Relicts from several decades have gathered in the code base,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1646 but seldom obsolete features were dropped.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1647 This section describes the removing of old code
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1648 and the modernizing of the default setup.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1649 It focuses on the functional aspect only;
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1650 the non-functional aspects of code style are discussed in
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1651 .\" FIXME REF
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1652 Sec. XXX.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1653
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1654
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1655 .H2 "Code Relicts
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1656 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1657 My position to drop obsolete functions of mmh, in order to remove old code,
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1658 is much more revolutional than the nmh community likes to have it.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1659 Working on an experimental version, I was able to quickly drop
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1660 functionality I considered ancient.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1661 The need for consensus with peers would have slowed this process down.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1662 Without the need to justify my decisions, I was able to rush forward.
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1663 In December 2011, Paul Vixie motivated the nmh developers to just
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1664 do the work:
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1665 .[
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1666 paul vixie edginess nmh-workers
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1667 .]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1668 .QS
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1669 let's stop walking on egg shells with this code base. there's no need to
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1670 discuss whether to keep using vfork, just note in [sic!] passing, [...]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1671 we don't need a separate branch for removing vmh
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1672 or ridding ourselves of #ifdef's or removing posix replacement functions
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1673 or depending on pure ansi/posix "libc".
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1674 .QP
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1675 these things should each be a day or two of work and the "main branch"
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1676 should just be modern. [...]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1677 let's push forward, aggressively.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1678 .QE
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1679 .LP
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1680 I did so already in the months before.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1681 I pushed forward.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1682 I simply dropped the cruft.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1683 .P
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1684 The decision to drop a feature was based on literature research and
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1685 careful thinking, but whether having had contact to this particular
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1686 feature within my own computer life served as a rule of thumb.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1687 Always, I explained my reasons in the commit messages
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1688 in the version control system.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1689 Hence, others can comprehend my view and argue for undoing the change
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1690 if I have missed an important aspect.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1691 I was quick in dropping parts.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1692 I rather re-included falsely dropped parts than going a slower pace.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1693 Mmh is experimental work; it required tough decisions.
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1694
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1695
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1696 .U3 "Forking
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
1697 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1698 Being a tool chest, MH creates many processes.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1699 In earlier times
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1700 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1701 had been an expensive system call, because the process's image needed
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1702 to be duplicated completely at once.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1703 This was especially painful in the common case when the image gets
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1704 replaced by a call to
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1705 .Fu exec()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1706 right after having forked the child process.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1707 The
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1708 .Fu vfork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1709 system call was invented to speed up this particular case.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1710 It completely omits the duplication of the image.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1711 On old systems this resulted in significant speed ups.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1712 Therefore MH used
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1713 .Fu vfork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1714 whenever possible.
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1715 .P
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1716 Modern memory management units support copy-on-write semantics, which make
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1717 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1718 almost as fast as
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1719 .Fu vfork() .
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1720 The man page of
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1721 .Mp vfork (2)
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1722 in FreeBSD 8.0 states:
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1723 .QS
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1724 This system call will be eliminated when proper system sharing mechanisms
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1725 are implemented. Users should not depend on the memory sharing semantics
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1726 of vfork() as it will, in that case, be made synonymous to fork(2).
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1727 .QE
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1728 .LP
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1729 Vixie supports the removal with the note that ``the last
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1730 system on which fork was so slow that an mh user would notice it, was
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1731 Eunice. that was 1987''.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1732 .[
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1733 nmh-workers vixie edginess
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1734 .]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1735 I replaced all calls to
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1736 .Fu vfork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1737 with calls to
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1738 .Fu fork() .
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1739 .Ci 40821f5c1316e9205a08375e7075909cc9968e7d
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1740 .P
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1741 Related to the costs of
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1742 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1743 is the probability of its success.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1744 In the eighties, on heavy loaded systems, calls to
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1745 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1746 were prone to failure.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1747 Hence, many of the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1748 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1749 calls in the code were wrapped into loops to retry the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1750 .Fu fork()
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1751 several times, to increase the changes to succeed, eventually.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1752 On modern systems, a failing
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1753 .Fu fork()
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1754 call is unusual.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1755 Hence, in the rare case when
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1756 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1757 fails, mmh programs simply abort.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1758 .Ci 5fbf37ee68e018998ada61eeab73e035b26834b6
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1759
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1760
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1761 .U3 "Header Fields
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1762 .BU
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1763 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1764 .Hd Encrypted
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1765 header field was introduced by RFC\|822,
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1766 but already marked as legacy in RFC\|2822.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1767 Today, OpenPGP provides the basis for standardized exchange of encrypted
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1768 messages [RFC\|4880, RFC\|3156].
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1769 Hence, the support for
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1770 .Hd Encrypted
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1771 header fields is removed in mmh.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1772 .Ci 064527f7b57ab050e5af13e15ad99aeeab125857
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1773 .BU
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1774 Native support for
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1775 .Hd Face
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1776 header fields has been removed, as well.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1777 .Ci 8e5be81f784682822f5e868c1bf3c8624682bd23
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1778 This feature is similar to the
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1779 .Hd X-Face
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1780 header field in its intent,
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1781 but takes a different approach to store the image.
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1782 Instead of encoding the image data directly into the header field,
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1783 it contains the hostname and UDP port where the image
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1784 date can be retrieved.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1785 There exists even a third Face system,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1786 which is the successor of
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1787 .Hd X-Face ,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1788 although it re-uses the
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1789 .Hd Face
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1790 header field.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1791 It was invented in 2005 and supports colored PNG images.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1792 None of the Face systems described here is popular today.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1793 Hence, mmh has no direct support for them.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1794 .BU
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1795 The
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1796 .Hd Content-MD5
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1797 header field was introduced by RFC\|1864.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1798 It provides detection of data corruption during the transfer.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1799 But it can not ensure verbatim end-to-end delivery of the contents
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1800 [RFC\|1864].
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1801 The proper approach to verify content integrity in an
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1802 end-to-end relationship is the use of digital cryptography.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1803 .\" XXX (RFCs FIXME).
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1804 On the other hand, transfer protocols should detect corruption during
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1805 the transmission.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1806 The TCP includes a checksum field therefore.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1807 These two approaches in combinations render the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1808 .Hd Content-MD5
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1809 header field superfluous.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1810 Not a single one out of 4\|200 messages from two decades
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1811 in an nmh-workers mailing list archive contains a
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1812 .Hd Content-MD5
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1813 header field.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1814 Neither did any of the 60\|000 messages in my personal mail storage.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1815 Removing the support for this header field,
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1816 removed the last place where MD5 computation was needed.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1817 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1818 Hence, the MD5 code could be removed as well.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1819 Over 500 lines of code vanished by this one change.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1820
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1821
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1822 .U3 "MMDF maildrop support
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1823 .P
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1824 This type of format is conceptionally similar to the mbox format,
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1825 but uses a different message delimiter (`\fL^A^A^A^A\fP' instead of
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1826 `\fLFrom\0\fP').
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1827 Mbox is the de-facto standard maildrop format on Unix,
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1828 whereas the MMDF maildrop format became forgotten.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1829 I did drop MMDF maildrop format support.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1830 Mbox is the only packed mailbox format supported in mmh.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1831 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1832 The simplifications within the code were moderate.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1833 Mainly, the reading and writing of MMDF mailbox files was removed.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1834 But also, switches of
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1835 .Pn packf
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1836 and
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1837 .Pn rcvpack
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1838 could be removed.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1839 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1840 In the message parsing function
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1841 .Fn sbr/m_getfld.c ,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1842 knowledge of MMDF packed mail boxes was removed.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1843 .Ci 684ec30d81e1223a282764452f4902ed4ad1c754
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1844 Further code structure simplifications may be possible there,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1845 because only one single packed mailbox format is left to be supported.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1846 I have not worked on them yet because
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1847 .Fu m_getfld()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1848 is heavily optimized and thus dangerous to touch.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1849 The risk of damaging the intricate workings of the optimized code is
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1850 too high.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1851 .\" XXX: move somewhere else
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1852 This problem is know to the developers of nmh, too.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1853 They also avoid touching this minefield.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1854
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1855
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1856 .U3 "Prompter's Control Keys
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1857 .P
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1858 The program
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1859 .Pn prompter
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1860 queries the user to fill in a message form.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1861 When used by
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1862 .Pn comp
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1863 as
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1864 .Cl "comp -editor prompter" ,
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1865 the resulting behavior is similar to
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1866 .Pn mailx .
51
49cf68506b5d Spell checking.
markus schnalke <meillo@marmaro.de>
parents: 49
diff changeset
1867 Apparently,
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1868 .Pn prompter
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1869 hadn't been touched lately.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1870 Otherwise it's hardly explainable why it
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1871 still offered the switches
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1872 .Sw -erase
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1873 .Ar chr
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1874 and
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1875 .Sw -kill
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1876 .Ar chr
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1877 to name the characters for command line editing.
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1878 The times when this had been necessary are long time gone.
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1879 Today these things work out-of-the-box, and if not, are configured
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1880 with the standard tool
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1881 .Pn stty .
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1882 The switches are removed now
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1883 .Ci 0bd9750710cdbab80cfb4036dd87af20afe1552f .
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1884
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1885
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1886 .U3 "Hardcopy Terminal Support
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1887 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1888 More of a funny anecdote is a check for being connected to a
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1889 hardcopy terminal.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1890 It remained in the code until Spring 2012, when I finally removed it
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1891 .Ci b7764c4a6b71d37918a97594d866258f154017ca .
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1892 I would be truly happy to see such a terminal in action today,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1893 maybe even being able to work on it.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1894 But I fear my chances are null.
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1895 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1896 The check only prevented a pager to be placed between the printing
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1897 program (\c
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1898 .Pn mhl )
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1899 and the terminal.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1900 In nmh, this could have been ensured statically with the
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1901 .Sw -nomoreproc
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1902 at the command line, too.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
1903 In mmh, setting the profile entry
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1904 .Pe Pager
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1905 or the environment variable
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1906 .Ev PAGER
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1907 to
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1908 .Pn cat
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1909 does the job.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1910
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1911
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1912
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1913
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1914 .H2 "Attachments
22
99409e4546d2 Wrote about the removal of tools.
markus schnalke <meillo@marmaro.de>
parents: 21
diff changeset
1915 .P
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1916 The mind model of email attachments is unrelated to MIME.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1917 Although the MIME RFCs (2045 through 2049) define the technical
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1918 requirements for having attachments, they do not mention the word
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1919 ``attachment''.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1920 Instead of attachments, MIME talks about ``multi-part message bodies''
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1921 [RFC\|2045], a more general concept.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1922 Multi-part messages are messages
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1923 ``in which one or more different
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1924 sets of data are combined in a single body''
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1925 [RFC\|2046].
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1926 MIME keeps its descriptions generic;
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1927 it does not imply specific usage models.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1928 One usage model became prevalent: attachments.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1929 The idea is having a main text document with files of arbitrary kind
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1930 attached to it.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1931 In MIME terms, this is a multi-part message having a text part first
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1932 and parts of arbitrary type following.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1933 .P
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1934 MH's MIME support is a direct implementation of the RFCs.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1935 The perception of the topic described in the RFCs is clearly visible
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1936 in MH's implementation.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1937 In result, MH had all the MIME features but no idea of attachments.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1938 But users don't need all the MIME features,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1939 they want convenient attachment handling.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1940
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1941
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1942 .U3 "Composing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1943 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1944 In order to improve the situation on the message composing side,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1945 Jon Steinhart had added an attachment system to nmh in 2002.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1946 .Ci 7480dbc14bc90f2d872d434205c0784704213252
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1947 In the file
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1948 .Fn docs/README-ATTACHMENTS ,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1949 he described his motivation to do so as such:
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1950 .QS
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1951 Although nmh contains the necessary functionality for MIME message handing,
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1952 the interface to this functionality is pretty obtuse.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1953 There's no way that I'm ever going to convince my partner to write
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1954 .Pn mhbuild
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1955 composition files!
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1956 .QE
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1957 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1958 With this change, the mind model of attachments entered nmh.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1959 In the same document:
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1960 .QS
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1961 These changes simplify the task of managing attachments on draft files.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1962 They allow attachments to be added, listed, and deleted.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1963 MIME messages are automatically created when drafts with attachments
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1964 are sent.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1965 .QE
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1966 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1967 Unfortunately, the attachment system,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1968 like any new facilities in nmh,
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1969 was inactive by default.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1970 .P
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1971 During my work in Argentina, I tried to improve the attachment system.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1972 But, because of great opposition in the nmh community,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1973 my patch died as a proposal on the mailing list, after long discussions.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1974 .[
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1975 nmh-workers attachment proposal
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1976 .]
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1977 In January 2012, I extended the patch and applied it to mmh.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1978 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1979 In mmh, the attachment system is active by default.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1980 Instead of command line switches, the
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1981 .Pe Attachment-Header
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1982 profile entry is used to specify
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1983 the name of the attachment header field.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1984 It is pre-defined to
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1985 .Hd Attach .
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1986 .P
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1987 To add an attachment to a draft, simply add an attachment header:
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1988 .VS
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1989 To: bob
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1990 Subject: The file you wanted
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1991 Attach: /path/to/the/file-bob-wanted
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1992 --------
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1993 Here it is.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1994 VE
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1995 The header field can be added to the draft manually in the editor,
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1996 or by using the `attach' command at the WhatNow prompt, or
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1997 non-interactively with
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1998 .Pn anno :
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1999 .VS
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2000 anno -append -nodate -component Attach -text /path/to/attachment
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2001 VE
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2002 Drafts with attachment headers are converted to MIME automatically by
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2003 .Pn send .
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2004 The conversion to MIME is invisible to the user.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2005 The draft stored in the draft folder is always in source form, with
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2006 attachment headers.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2007 If the MIMEification fails, for instance because the file to attach
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2008 is not accessible, the original draft is not changed.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2009 .P
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2010 The attachment system handles the forwarding of messages, too.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2011 If the attachment header value starts with a plus character (`+'),
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2012 like in
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2013 .Cl "Attach: +bob 30 42" ,
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2014 The given messages in the specified folder will be attached.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2015 This allowed to simplify
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2016 .Pn forw .
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2017 .Ci f41f04cf4ceca7355232cf7413e59afafccc9550
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2018 .P
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2019 Closely related to attachments is non-ASCII text content,
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2020 because it requires MIME too.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2021 In nmh, the user needed to call `mime' at the WhatNow prompt
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2022 to have the draft converted to MIME.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2023 This was necessary whenever the draft contained non-ASCII characters.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2024 If the user did not call `mime', a broken message would be sent.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2025 Therefore, the
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2026 .Pe automimeproc
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2027 profile entry could be specified to have the `mime' command invoked
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2028 automatically each time.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2029 Unfortunately, this approach conflicted with with attachment system
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2030 because the draft would already be in MIME format at the time
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2031 when the attachment system wanted to MIMEify it.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2032 To use nmh's attachment system, `mime' must not be called at the
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2033 WhatNow prompt and
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2034 .Pe automimeproc
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2035 must not be set in the profile.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2036 But then the case of non-ASCII text without attachment headers was
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2037 not caught.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2038 All in all, the solution was complex and irritating.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2039 My patch from December 2010 would have simplified the situation.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2040 .P
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2041 Mmh's current solution is even more elaborate.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2042 Any necessary MIMEification is done automatically.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2043 There is no `mime' command at the WhatNow prompt anymore.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2044 The draft will be converted automatically to MIME when either an
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2045 attachment header or non-ASCII text is present.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2046 Further more, the special meaning of the hash character (`#')
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2047 at line beginnings in the draft message is removed.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2048 Users need not at all deal with the whole topic.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2049 .P
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2050 Although the new approach does not anymore support arbitrary MIME
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2051 compositions directly, the full power of
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2052 .Pn mhbuild
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2053 can still be accessed.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2054 Given no attachment headers are included, the user can create
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2055 .Pn mhbuild
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2056 composition drafts like in nmh.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2057 Then, at the WhatNow prompt, he needs to invoke
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2058 .Cl "edit mhbuild
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2059 to convert it to MIME.
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
2060 Because the resulting draft does neither contain non-ASCII characters
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2061 nor has it attachment headers, the attachment system will not touch it.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2062 .P
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2063 The approach taken in mmh is tailored towards todays most common case:
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2064 a text part with possibly attachments.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2065 This case is simplified a lot for users.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2066
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2067
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2068 .U3 "MIME Type Guessing
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2069 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2070 The use of
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2071 .Pn mhbuild
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2072 composition drafts had one notable advantage over attachment headers
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2073 from the programmer's point of view: The user provides the appropriate
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2074 MIME types for files to include.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2075 The attachment system needs to find out the correct MIME type itself.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2076 This is a difficult task, yet it spares the user irritating work.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2077 Determining the correct MIME type of content is partly mechanical,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2078 partly intelligent work.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2079 Forcing the user to find out the correct MIME type,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2080 forces him to do partly mechanical work.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2081 Letting the computer do the work, can lead to bad choices for difficult
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2082 content.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2083 For mmh, the latter option was chosen.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2084 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2085 Determining the MIME type by the suffix of the file name is a dumb
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2086 approach, yet it is simple to implement and provides good results
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2087 for the common cases.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2088 Mmh implements this approach in the
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2089 .Pn print-mimetype
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2090 script.
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2091 .Ci 4b5944268ea0da7bb30598a27857304758ea9b44
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2092 Using it is the default choice.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2093 .P
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2094 A far better, though less portable, approach is the use of
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2095 .Pn file .
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2096 This standard tool tries to determine the type of files.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2097 Unfortunately, its capabilities and accuracy varies from system to system.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2098 Additionally, its output was only intended for human beings,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2099 but not to be used by programs.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2100 It varies much.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2101 Nevertheless, modern versions of GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2102 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2103 which is prevalent on the popular GNU/Linux systems,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2104 provides MIME type output in machine-readable form.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2105 Although this solution is highly system-dependent,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2106 it solves the difficult problem well.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2107 On systems where GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2108 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2109 version 5.04 or higher, is available it should be used.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2110 One needs to specify the following profile entry to do so:
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2111 .Ci 3baec236a39c5c89a9bda8dbd988d643a21decc6
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2112 .VS
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2113 Mime-Type-Query: file -b --mime
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2114 VE
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2115 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2116 Other versions of
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2117 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2118 might possibly be usable with wrapper scripts to reformat the output.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2119 The diversity among
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2120 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2121 implementations is great; one needs to check the local variant.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2122 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2123 If no MIME type can be determined, text content gets sent as
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2124 `text/plain' and anything else under the generic fall-back type
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2125 `application/octet-stream'.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2126 It is not possible in mmh to override the automatic MIME type guessing
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2127 for a specific file.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2128 To do so, the user would need to know in advance for which file
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2129 the automatic guessing does fail, or the system would require interaction.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2130 I consider both cases impractical.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2131 The existing solution should be sufficient.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2132 If not, the user may always fall back to
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2133 .Pn mhbuild
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2134 composition drafts and ignore the attachment system.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2135
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2136
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2137 .U3 "Storing Attachments
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2138 .P
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2139 Extracting MIME parts of a message and storing them to disk is done by
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2140 .Pn mhstore .
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2141 The program has two operation modes,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2142 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2143 and
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2144 .Sw -noauto .
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2145 With the former one, each part is stored under the filename given in the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2146 MIME part's meta information, if available.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2147 This naming information is usually available for modern attachments.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2148 If no filename is available, this MIME part is stored as if
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2149 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2150 would have been specified.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2151 In the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2152 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2153 mode, the parts are processed according to rules, defined by
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2154 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2155 profile entries.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2156 These rules define generic filename templates for storing
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2157 or commands to post-process the contents in arbitrary ways.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2158 If no matching rule is available the part is stored under a generic
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2159 filename, built from message number, MIME part number, and MIME type.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2160 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2161 The
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2162 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2163 mode had been the default in nmh because it was considered safe,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2164 in contrast to the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2165 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2166 mode.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2167 In mmh,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2168 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2169 is not dangerous anymore.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2170 Two changes were necessary:
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2171 .BU
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2172 Any directory path is removed from the proposed filename.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2173 Thus, the files are always stored in the expected directory.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2174 .Ci 41b6eadbcecf63c9a66aa5e582011987494abefb
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2175 .BU
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2176 Tar files are not extracted automatically any more.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2177 Thus, the rest of the file system will not be touched.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2178 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2179 .LP
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2180 Now, the outcome of mmh's
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2181 .Cl "mhstore -auto
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
2182 can be foreseen from the output of
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2183 .Cl "mhlist -verbose" .
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2184 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2185 The
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2186 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2187 mode is seen to be more powerful but less convenient.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2188 On the other hand,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2189 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2190 is safe now and
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2191 storing attachments under their original name is intuitive.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2192 Hence,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2193 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2194 serves better as the default option.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2195 .Ci 3410b680416c49a7617491af38bc1929855a331d
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2196 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2197 Files are stored into the directory given by the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2198 .Pe Nmh-Storage
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2199 profile entry, if set, or
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2200 into the current working directory, otherwise.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2201 Storing to different directories is only possible with
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2202 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2203 profile entries.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2204 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2205 Still, in both modes, existing files get overwritten silently.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2206 This can be considered a bug.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2207 Yet, each other behavior has its draw-backs, too.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2208 Refusing to replace files requires adding a
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2209 .Sw -force
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2210 option.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2211 Users will likely need to invoke
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2212 .Pn mhstore
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2213 a second time with
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2214 .Sw -force
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2215 then.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2216 Eventually, only the user can decide in the concrete case.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2217 This requires interaction, which I like to avoid if possible.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2218 Appending a unique suffix to the filename is another bad option.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2219 For now, the behavior remains as it is.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2220 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2221 In mmh, only MIME parts of type message are special in
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2222 .Pn mhstore 's
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2223 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2224 mode.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2225 Instead of storing message/rfc822 parts as files to disk,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2226 they are stored as messages into the current mail folder.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2227 The same applies to message/partial, only, the parts are reassembled
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2228 automatically before.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2229 Parts of type message/external-body are not automatically retrieved
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2230 anymore. Instead, Information on how to retrieve them is output.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2231 Not supporting this rare case saved nearly one thousand lines of code.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2232 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2233 .\" XXX mention somewhere else too: (The profile entry `nmh-access-ftp'
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2234 .\" and sbr/ruserpass.c for reading ~/.netrc are gone now.)
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2235 Not special anymore is `application/octet-stream; type=tar'.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2236 Automatically extracting such MIME parts had been the dangerous part
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2237 of the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2238 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2239 mode.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2240 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2241
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2242
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2243
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2244 .U3 "Showing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2245 .P
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2246 The program
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2247 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2248 had been written to display MIME messages.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2249 It implemented the conceptional view of the MIME RFCs.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2250 Nmh's
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2251 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2252 handled each MIME part independently, presenting them separately
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2253 to the user.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2254 This does not match today's understanding of email attachments,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2255 where displaying a message is seen to be a single, integrated operation.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2256 Today, email messages are expected to consist of a main text part
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2257 plus possibly attachments.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2258 They are not any more seen to be arbitrary MIME hierarchies with
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2259 information on how to display the individual parts.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2260 I adjusted
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2261 .Pn mhshow 's
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2262 behavior to the modern view on the topic.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2263 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2264 Note that this section completely ignores the original
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2265 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2266 program, because it was not capable to display MIME messages
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2267 and is no longer part of mmh.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2268 Although
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2269 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2270 was renamed to
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2271 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2272 in mmh, this section uses the name
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2273 .Pn mhshow ,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2274 in order to avoid confusion.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2275 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2276 In mmh, the basic idea is that
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2277 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2278 should display a message in one single pager session.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2279 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2280 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2281 invokes a pager session for all its output,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2282 whenever it prints to a terminal.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2283 .Ci a4197ea6ffc5c1550e8b52d5a654bcaaaee04a4e
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2284 In consequence,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2285 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2286 does no more invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2287 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2288 With
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2289 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2290 replacing the original
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2291 .Pn show ,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2292 output from
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2293 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2294 does not go to the terminal directly, but through
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2295 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2296 Hence,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2297 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2298 does not need to invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2299 The one and only job of
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2300 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2301 is to format messages or parts of them.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2302 The only place in mmh, where a pager is invoked is
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2303 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2304 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2305 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2306 profile entries can be used to display MIME parts in a specific way.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2307 For instance, PDF and Postscript files could be converted to plain text
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2308 to display them in the terminal.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2309 In mmh, the displaying of MIME parts will always be done serially.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2310 The request to display the MIME type `multipart/parallel' in parallel
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2311 is ignored.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2312 It is simply treated as `multipart/mixed'.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2313 .Ci d0581ba306a7299113a346f9b4c46ce97bc4cef6
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2314 This could already be requested with the, now removed,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2315 .Sw -serialonly
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2316 switch of
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2317 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2318 As MIME parts are always processed exclusively , i.e. serially,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2319 the `%e' escape in
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2320 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2321 profile entries became useless and was thus removed.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2322 .Ci a20d405db09b7ccca74d3e8c57550883da49e1ae
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2323 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2324 In the intended setup, only text content would be displayed.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2325 Non-text content would be converted to text by appropriate
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2326 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2327 profile entries before, if possible and wanted.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2328 All output would be displayed in a single pager session.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2329 Other kinds of attachments are ignored.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2330 With
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2331 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2332 profile entries for them, they can be displayed serially along
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2333 the message.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2334 For parallel display, the attachments need to be stored to disk first.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2335 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2336 To display text content in foreign charsets, they need to be converted
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2337 to the native charset.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2338 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2339 .Pe mhshow-charset-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2340 profile entries used to be needed.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2341 In mmh, the conversion is done automatically by piping the text through
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2342 the
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2343 .Pn iconv
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2344 command, if necessary.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2345 .Ci 2433122c20baccb10b70b49c04c6b0497b5b3b60
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2346 Custom
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2347 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2348 rules for textual content might need a
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2349 .Cl "iconv -f %c %f |
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2350 prefix to have the text converted to the native charset.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2351 .P
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2352 Although the conversion of foreign charsets to the native one
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2353 has improved, it is not consistent enough.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2354 Further work needs to be done and
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2355 the basic concepts in this field need to be re-thought.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2356 Though, the default setup of mmh displays message in foreign charsets
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2357 correctly without the need to configure anything.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2358
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2359
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2360 .ig
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2361
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2362 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2363 mhshow/mhstore: Removed support for retrieving message/external-body parts.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2364 These tools won't download the contents automatically anymore. Instead,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2365 they print the information needed to get the contents. If someone should
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2366 really receive one of those rare message/external-body messages, he can
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2367 do the job manually. We save nearly a thousand lines of code. That's worth
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2368 it!
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2369 (The profile entry `nmh-access-ftp' and sbr/ruserpass.c for reading
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2370 ~/.netrc are gone now.)
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2371 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2372
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2373 ..
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2374
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2375
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2376
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2377 .H2 "Digital Cryptography
22
99409e4546d2 Wrote about the removal of tools.
markus schnalke <meillo@marmaro.de>
parents: 21
diff changeset
2378 .P
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2379 Signing and encryption.
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2380 .P
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2381 FIXME
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2382
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2383
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2384
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2385 .H2 "Modern Defaults
22
99409e4546d2 Wrote about the removal of tools.
markus schnalke <meillo@marmaro.de>
parents: 21
diff changeset
2386 .P
116
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2387 Nmh has a bunch of convenience-improving features inactive by default,
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2388 although one can expect every new user wanting to have them active.
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2389 The reason they are inactive by default is the wish to stay compatible
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2390 with old versions.
116
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2391 But what is the definition for old versions.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2392 Still, the highly useful draft folder facility is not active by default
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2393 although it had been introduced over twenty-five years ago
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2394 .[
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2395 rose romine real work
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2396 .]
116
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2397 \(en the community seems not to care.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2398 This is one of several examples that require new users to build up
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2399 their profile before they can access the modern features of nmh.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2400 Without an extensively built-up profile, the setup is hardly usable
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2401 for modern emailing.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2402 The point is not the customization of the setup,
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2403 but the activating of generally useful facilities.
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2404 .P
116
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2405 Yet, the real problem lies less in enabling the features, as this is
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2406 straight forward as soon as one knows what he wants.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2407 The real problem is that new users need deep insights into the project
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2408 before they find out what they are missing and that nmh actually
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2409 provides it already, it just was not activated.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2410 To give an example, I needed one year of using nmh
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2411 before I became aware of the existence of the attachment system.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2412 One could argue that this fact disqualifies my reading of the
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2413 documentation.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2414 If I would have installed nmh from source back then, I could agree.
116
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2415 Yet, I had used a prepackaged version and had expected that it would
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2416 just work.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2417 Nevertheless, I had been convinced by the concepts of MH already
116
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2418 and I am a software developer,
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2419 still I required a lot of time to discover the cool features.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2420 How can we expect users to be even more advanced than me,
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2421 just to allow them use MH in a convenient and modern way?
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2422 Unless they are strongly convinced of the concepts, they will fail.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2423 I have seen friends of me giving up disappointed
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2424 before they truly used the system,
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2425 although they had been motivated in the beginning.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2426 They suffer hard enough to get used to the toolchest approach,
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2427 we should spare them further inconveniences.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2428 .P
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2429 Maintaining compatibility for its own sake is for no good.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2430 If any MH implementation would be the back-end of widespread
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2431 email clients with large user bases, compatibility would be more
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2432 important.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2433 Yet, it appears as if this is not the case.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2434 Hence, compatibility is hardly important for technical reasons.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2435 Its importance originates rather from personal reasons.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2436 Nmh's user base is small and old.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2437 Changing the interfaces would cause inconvenience to long-term users of MH.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2438 It would force them to change their many years old MH configurations.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2439 I do understand this aspect, but it keeps new users from using MH.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2440 By sticking to the old users, new users are kept away.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2441 Yet, the future lies in new users.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2442 Hence, mmh invites new users by providing a convenient and modern setup,
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2443 readily usable out-of-the-box.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2444 .P
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2445 In mmh, all modern features are active by default.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2446 In consequence, a setup with a profile that defines only the path to the
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2447 mail storage, is already convenient to use.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2448 Again, Paul Vixie's ``edginess'' appeal supports the direction I took:
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2449 ``the `main branch' should just be modern''.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2450 .[
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2451 paul vixie edginess nmh-workers
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2452 .]
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2453 .P
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2454 Modern features that are active in mmh by default include:
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2455 .BU
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2456 The attachment system (\c
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2457 .Hd Attach ).
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2458 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2459 .BU
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2460 The draft folder facility (\c
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2461 .Fn +drafts ).
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2462 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2463 .BU
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2464 The unseen sequence (`u')
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2465 .Ci c2360569e1d8d3678e294eb7c1354cb8bf7501c1
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2466 and the sequence negation prefix (`!').
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2467 .Ci db74c2bd004b2dc9bf8086a6d8bf773ac051f3cc
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2468 .BU
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2469 Quoting the original message in the reply.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2470 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2471 .BU
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2472 Forwarding messages using MIME.
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2473 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1
4fbd14dc5e91 Wrote about modern defaults.
markus schnalke <meillo@marmaro.de>
parents: 114
diff changeset
2474
22
99409e4546d2 Wrote about the removal of tools.
markus schnalke <meillo@marmaro.de>
parents: 21
diff changeset
2475
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2476
14
55ec590cfa07 Wrote about the draft folder.
markus schnalke <meillo@marmaro.de>
parents: 12
diff changeset
2477
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
2478 .H1 "Code Style
16
81f703140554 Wrote about the trash folder.
markus schnalke <meillo@marmaro.de>
parents: 14
diff changeset
2479 .P
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2480 Kernighan and Pike have emphasized the importance of style in the
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2481 preface of their book:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2482 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2483 kernighan pike practice of programming
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2484 .], p. x]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2485 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2486 Chapter 1 discusses programming style.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2487 Good style is so important to good programming that we have chose
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2488 to cover it first.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2489 .QE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2490 This section covers changes in mmh that were motivated by the desire
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2491 to improve on style.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2492 Many of them follow the rules given in the quoted book.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2493 .[
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2494 kernighan pike practice of programming
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2495 .]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2496
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2497
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2498 .H2 "Style
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2499 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2500 .U3 "Indentation Style
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2501 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2502 Indentation styles are the holy cow of programmers.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2503 Again Kernighan and Pike:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2504 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2505 kernighan pike practice of programming
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2506 .], p. 10]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2507 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2508 Programmers have always argued about the layout of programs,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2509 but the specific style is much less important than its consistent
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2510 application.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2511 Pick one style, preferably ours, use it consistently, and don't waste
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2512 time arguing.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2513 .QE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2514 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2515 I agree that the constant application is most important,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2516 but I believe that some styles have advantages over others.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2517 For instance the indentation with tab characters only.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2518 Tab characters directly map to the nesting level \(en
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2519 one tab, one level.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2520 Tab characters are flexible because developers can adjust them to
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2521 whatever width they like to have.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2522 There is no more need to run
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2523 .Pn unexpand
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2524 or
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2525 .Pn entab
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2526 programs to ensure the correct mixture of leading tabs and spaces.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2527 The simple rules are: (1) Leading whitespace must consist of tabs only.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2528 (2) Any other whitespace should consist of spaces.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2529 These two rules ensure the integrity of the visual appearance.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2530 Although reformatting existing code should be avoided, I did it.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2531 I did not waste time arguing; I just did it.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2532 .Ci a485ed478abbd599d8c9aab48934e7a26733ecb1
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2533
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2534 .U3 "Comments
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2535 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2536 Section 1.6 of
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2537 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2538 kernighan pike practice of programming
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2539 .], p. 23]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2540 demands: ``Don't belabor the obvious.''
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2541 Hence, I simply removed all the comments in the following code excerpt:
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2542 .VS
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2543 context_replace(curfolder, folder); /* update current folder */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2544 seq_setcur(mp, mp->lowsel); /* update current message */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2545 seq_save(mp); /* synchronize message sequences */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2546 folder_free(mp); /* free folder/message structure */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2547 context_save(); /* save the context file */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2548
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2549 [...]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2550
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2551 int c; /* current character */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2552 char *cp; /* miscellaneous character pointer */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2553
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2554 [...]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2555
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2556 /* NUL-terminate the field */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2557 *cp = '\0';
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2558 VE
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2559 .Ci 426543622b377fc5d091455cba685e114b6df674
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2560 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2561 The names of the functions explain enough already.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2562
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2563 .U3 "Names
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2564 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2565 Kernighan and Pike suggest:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2566 ``Use active names for functions''.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2567 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2568 kernighan pike practice of programming
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2569 .], p. 4]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2570 One application of this rule was the rename of
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2571 .Fu check_charset()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2572 to
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2573 .Fu is_native_charset() .
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2574 .Ci 8d77b48284c58c135a6b2787e721597346ab056d
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2575 The same change fixed a violation of ``Be accurate'' as well.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2576 The code did not match the expectation the function suggested,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2577 as it, for whatever reason, only compared the first ten characters
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2578 of the charset name.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2579 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2580 More important than using active names is using descriptive names.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2581 Renaming the obscure function
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2582 .Fu m_unknown()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2583 was a delightful event.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2584 .Ci 611d68d19204d7cbf5bd585391249cb5bafca846
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2585 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2586 Magic numbers are generally considered bad style.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2587 Obviously, Kernighan and Pike agree:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2588 ``Give names to magic numbers''.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2589 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2590 kernighan pike practice of programming
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2591 .], p. 19]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2592 One such change was naming the type of input \(en mbox or mail folder \(en
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2593 to be scanned:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2594 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2595 #define SCN_MBOX (-1)
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2596 #define SCN_FOLD 0
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2597 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2598 .Ci 7ffb36d28e517a6f3a10272056fc127592ab1c19
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2599 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2600 The argument
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2601 .Ar outnum
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2602 of the function
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2603 .Fu scan()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2604 in
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2605 .Fn uip/scansbr.c
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2606 defines the number of the message to be created.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2607 If no message is to be created, the argument is misused to transport
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2608 program logic.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2609 This lead to obscure code.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2610 I improved the clarity of the code by introducing two variables:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2611 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2612 int incing = (outnum > 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2613 int ismbox = (outnum != 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2614 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2615 They cover the magic values and are used for conditions.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2616 The variable
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2617 .Ar outnum
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2618 is only used when it holds an ordinary message number.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2619 .Ci b8b075c77be7794f3ae9ff0e8cedb12b48fd139f
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2620 The clarity improvement of the change showed detours in the program logic
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2621 of related code parts.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2622 Having the new variables with descriptive names, a more
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2623 straight forward implementation became apparent.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2624 Before the clarification was done,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2625 the possibility to improve had not be seen.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2626 .Ci aa60b0ab5e804f8befa890c0a6df0e3143ce0723
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2627
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2628 .U3 "Rework of \f(CWanno\fP
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2629 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2630 At the end of their chapter on style,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2631 Kernighan and Pike ask: ``But why worry about style?''
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2632 The following example of my rework of
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2633 .Pn anno
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2634 provides an answer why style is important in the first place.
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2635 .P
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2636 Until 2002,
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2637 .Pn anno
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2638 had six functional command line switches,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2639 .Sw -component
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2640 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2641 .Sw -text ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2642 which took an argument each,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2643 and the two pairs of flags,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2644 .Sw -[no]date
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2645 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2646 .Sw -[no]inplace.,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2647 .Sw -component
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2648 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2649 .Sw -text ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2650 which took an argument each,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2651 and the two pairs of flags,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2652 .Sw -[no]date
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2653 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2654 .Sw -[no]inplace .
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2655 Then Jon Steinhart introduced his attachment system.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2656 In need for more advanced annotation handling, he extended
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2657 .Pn anno .
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2658 He added five more switches:
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2659 .Sw -draft ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2660 .Sw -list ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2661 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2662 .Sw -append ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2663 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2664 .Sw -number ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2665 the last one taking an argument.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2666 .Ci 7480dbc14bc90f2d872d434205c0784704213252
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2667 Later,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2668 .Sw -[no]preserve
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2669 was added.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2670 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2671 Then, the Synopsis section of the man page
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2672 .Mp anno (1)
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2673 read:
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2674 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2675 anno [+folder] [msgs] [-component field] [-inplace | -noinplace]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2676 [-date | -nodate] [-draft] [-append] [-list] [-delete]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2677 [-number [num|all]] [-preserve | -nopreserve] [-version]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2678 [-help] [-text body]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2679 VE
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2680 .LP
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2681 The implementation followed the same structure.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2682 Problems became visible when
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2683 .Cl "anno -list -number 42
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2684 worked on the current message instead on message number 42,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2685 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2686 .Cl "anno -list -number l:5
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
2687 did not work on the last five messages but failed with the mysterious
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2688 error message: ``anno: missing argument to -list''.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2689 Yet, the invocation matched the specification in the man page.
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2690 There, the correct use of
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2691 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2692 was defined as being
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2693 .Cl "[-number [num|all]]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2694 and the textual description for the combination with
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2695 .Sw -list
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2696 read:
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2697 .QS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2698 The -list option produces a listing of the field bodies for
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2699 header fields with names matching the specified component,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2700 one per line. The listing is numbered, starting at 1, if
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2701 the -number option is also used.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2702 .QE
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2703 .LP
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2704 The problem was manifold.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2705 The code required a numeric argument to the
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2706 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2707 switch.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2708 If it was missing or non-numeric,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2709 .Pn anno
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2710 aborted with an error message that had an off-by-one error,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2711 printing the switch one before the failing one.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2712 Semantically, the argument to the
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2713 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2714 switch is only necessary in combination with
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2715 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2716 but not with
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2717 .Sw -list .
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2718 In the former case it is even necessary.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2719 .P
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2720 Trying to fix these problems on the surface would not have solved it truly.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2721 The problems discovered originate from a discrepance between the semantic
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2722 structure of the problem and the structure implemented in the program.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2723 Such structural differences can not be cured on the surface.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2724 They need to be solved by adjusting the structure of the implementation
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2725 to the structure of the problem.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2726 .P
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2727 In 2002, the new switches
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2728 .Sw -list
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2729 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2730 .Sw -delete
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2731 were added in the same way, the
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2732 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2733 switch for instance had been added.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2734 Yet, they are of structural different type.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2735 Semantically,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2736 .Sw -list
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2737 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2738 .Sw -delete
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2739 introduce modes of operation.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2740 Historically,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2741 .Pn anno
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2742 had only one operation mode: adding header fields.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2743 With the extension, it got two moder modes:
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2744 listing and deleting header fields.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2745 The structure of the code changes did not pay respect to this
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2746 fundamental change to
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2747 .Pn anno 's
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2748 behavior.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2749 Neither the implementation nor the documentation did clearly
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2750 define them as being exclusive modes of operation.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2751 Having identified the problem, I solved it by putting structure into
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2752 .Pn anno
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2753 and its documentation.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2754 .Ci d54c8db8bdf01e8381890f7729bc0ef4a055ea11
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2755 .P
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2756 The difference is visible in both, the code and the documentation.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2757 The following code excerpt:
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2758 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2759 int delete = -2; /* delete header element if set */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2760 int list = 0; /* list header elements if set */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2761 [...]
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2762 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2763 delete = 0;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2764 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2765 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2766 list = 1;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2767 continue;
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2768 VE
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2769 .LP
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2770 was replaced by:
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2771 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2772 static enum { MODE_ADD, MODE_DEL, MODE_LIST } mode = MODE_ADD;
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2773 [...]
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2774 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2775 mode = MODE_DEL;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2776 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2777 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2778 mode = MODE_LIST;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2779 continue;
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2780 VE
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2781 .LP
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2782 The replacement code does not only reflect the problem's structure better,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2783 it is easier to understand as well.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2784 The same applies to the documentation.
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2785 The man page was completely reorganized to propagate the same structure.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2786 This is visible in the Synopsis section:
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2787 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2788 anno [+folder] [msgs] [-component field] [-text body]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2789 [-append] [-date | -nodate] [-preserve | -nopreserve]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2790 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2791
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2792 anno -delete [+folder] [msgs] [-component field] [-text
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2793 body] [-number num | all ] [-preserve | -nopreserve]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2794 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2795
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2796 anno -list [+folder] [msgs] [-component field] [-number]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2797 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2798 VE
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2799 .\" XXX think about explaining the -preserve rework?
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2800
16
81f703140554 Wrote about the trash folder.
markus schnalke <meillo@marmaro.de>
parents: 14
diff changeset
2801
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
2802
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2803 .H2 "Standard Libraries
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2804 .P
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2805 MH is one decade older than the POSIX and ANSI C standards.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2806 Hence, MH included own implementations of functions
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2807 that are standardized and thus widely available today,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2808 but were not back then.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2809 Today, twenty years after the POSIX and ANSI C were published,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2810 developers can expect system to comply with these standards.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2811 In consequence, MH-specific replacements for standard functions
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2812 can and should be dropped.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2813 Kernighan and Pike advise: ``Use standard libraries.''
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2814 .[ [
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2815 kernighan pike practice of programming
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2816 .], p. 196]
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2817 Actually, MH had followed this advice in history,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2818 but it had not adjusted to the changes in this field.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2819 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2820 .Fu snprintf()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2821 function, for instance, was standardized with C99 and is available
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2822 almost everywhere because of its high usefulness.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2823 In project's own implementation of
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2824 .Fu snprintf()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2825 was dropped in March 2012 in favor for using the one of the
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2826 standard library.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2827 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2828 Such decisions limit the portability of mmh
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2829 if systems don't support these standardized and widespread functions.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2830 This compromise is made because mmh focuses on the future.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2831 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2832 I am not yet thirty years old and my C and Unix experience comprises
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2833 only half a dozen years.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2834 Hence, I need to learn about the history in retrospective.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2835 I have not used those ancient constructs myself.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2836 I have not suffered from their incompatibilities.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2837 I have not longed for standardization.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2838 All my programming experience is from a time when ANSI C and POSIX
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2839 were well established already.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2840 I have only read a lot of books about the (good) old times.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2841 This puts me in a difficult positions when working with old code.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2842 I need to freshly acquire knowledge about old code constructs and ancient
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2843 programming styles, whereas older programmers know these things by
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2844 heart from their own experience.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2845 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2846 Being aware of the situation, I rather let people with more historic
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2847 experience replace ancient code constructs with standardized ones.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2848 Lyndon Nerenberg covered large parts of this task for the nmh project.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2849 He converted project-specific functions to POSIX replacements,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2850 also removing the conditionals compilation of now standardized features.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2851 Ken Hornstein and David Levine had their part in the work, too.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2852 Often, I only needed to pull over changes from nmh into mmh.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2853 These changes include many commits; these are among them:
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2854 .Ci 768b5edd9623b7238e12ec8dfc409b82a1ed9e2d
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2855 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32 .
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2856 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2857 During my own work, I tidied up the \fIMH standard library\fP,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2858 .Fn libmh.a ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2859 which is located in the
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2860 .Fn sbr
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2861 (``subroutines'') directory in the source tree.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2862 The MH library includes functions that mmh tools usually need.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2863 Among them are MH-specific functions for profile, context, sequence,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2864 and folder handling, but as well
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2865 MH-independent functions, such as auxiliary string functions,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2866 portability interfaces and error-checking wrappers for critical
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2867 functions of the standard library.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2868 .P
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2869 I have replaced the
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2870 .Fu atooi()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2871 function with calls to
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2872 .Fu strtoul()
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2873 with the third parameter \(en the base \(en set to eight.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2874 .Fu strtoul()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2875 is part of C89 and thus considered safe to use.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2876 .Ci c490c51b3c0f8871b6953bd0c74551404f840a74
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2877 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2878 I did remove project-included fallback implementations of
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2879 .Fu memmove()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2880 and
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2881 .Fu strerror() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2882 although Peter Maydell had re-included them into nmh in 2008
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2883 to support SunOS 4.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2884 Nevertheless, these functions are part of ANSI C.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2885 Systems that do not even provide full ANSI C support should not
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2886 put a load on mmh.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2887 .Ci b067ff5c465a5d243ce5a19e562085a9a1a97215
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2888 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2889 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2890 .Fu copy()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2891 function copies the string in argument one to the location in two.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2892 In contrast to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2893 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2894 it returns a pointer to the terminating null-byte in the destination area.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2895 The code was adjusted to replace
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2896 .Fu copy()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2897 with
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2898 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2899 except within
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2900 .Fu concat() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2901 where
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2902 .Fu copy()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2903 was more convenient.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2904 Therefore, the definition of
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2905 .Fu copy()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2906 was moved into the source file of
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2907 .Fu concat()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2908 and its visibility is now limited to it.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2909 .Ci 552fd7253e5ee9e554c5c7a8248a6322aa4363bb
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2910 .P
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2911 The function
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2912 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2913 had been a generalized version of
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2914 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2915 with minor differences.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2916 As all calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2917 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2918 had the slash (`/') as delimiter anyway,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2919 replacing
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2920 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2921 with the more specific and better-named function
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2922 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2923 became desirable.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2924 Unfortunately, many of the 54 calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2925 .Fu r1bindex()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2926 depended on a special behavior,
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2927 which differed from the POSIX specification for
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2928 .Fu basename() .
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2929 Hence,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2930 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2931 was kept but renamed to
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2932 .Fu mhbasename() ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2933 fixing the delimiter to the slash.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2934 .Ci 240013872c392fe644bd4f79382d9f5314b4ea60
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2935 For possible uses of
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2936 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2937 with a different delimiter,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2938 the ANSI C function
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2939 .Fu strrchr()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2940 provides the core functionality.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2941 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2942 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2943 .Fu ssequal()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2944 function \(en apparently for ``substring equal'' \(en
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2945 was renamed to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2946 .Fu isprefix() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2947 because this is what it actually checks.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2948 .Ci c20b4fa14515c7ab388ce35411d89a7a92300711
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2949 Its source file had included the following comments, no joke.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2950 .VS
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2951 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2952 * THIS CODE DOES NOT WORK AS ADVERTISED.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2953 * It is actually checking if s1 is a PREFIX of s2.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2954 * All calls to this function need to be checked to see
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2955 * if that needs to be changed. Prefix checking is cheaper, so
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2956 * should be kept if it's sufficient.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2957 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2958
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2959 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2960 * Check if s1 is a substring of s2.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2961 * If yes, then return 1, else return 0.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2962 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2963 VE
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2964 Two months later, it was completely removed by replacing it with
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2965 .Fu strncmp() .
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2966 .Ci b0b1dd37ff515578cf7cba51625189eb34a196cb
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2967
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2968
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2969
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2970
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2971
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2972 .H2 "Modularization
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2973 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2974 The source code of the mmh tools is located in the
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2975 .Fn uip
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2976 (``user interface programs'') directory.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2977 Each tools has a source file with the same name.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2978 For example,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2979 .Pn rmm
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2980 is built from
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2981 .Fn uip/rmm.c .
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2982 Some source files are used for multiple programs.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2983 For example
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2984 .Fn uip/scansbr.c
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2985 is used for both,
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2986 .Pn scan
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2987 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2988 .Pn inc .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2989 In nmh, 49 tools were built from 76 source files.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2990 This is a ratio of 1.6 source files per program.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2991 32 programs depended on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2992 17 programs depended on one source file only.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2993 In mmh, 39 tools are built from 51 source files.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2994 This is a ratio of 1.3 source files per program.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2995 18 programs depend on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2996 21 programs depend on one source file only.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2997 (These numbers and the ones in the following text ignore the MH library
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
2998 as well as shell scripts and multiple names for the same program.)
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2999 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3000 Splitting the source code of a large program into multiple files can
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3001 increase the readability of its source code.
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
3002 Most of the mmh tools, however, are simple and straight-forward programs.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3003 With the exception of the MIME handling tools,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3004 .Pn pick
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3005 is the largest tools.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3006 It contains 1\|037 lines of source code (measured with
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3007 .Pn sloccount ), excluding the MH library.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3008 Only the MIME handling tools (\c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3009 .Pn mhbuild ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3010 .Pn mhstore ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3011 .Pn show ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3012 etc.)
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3013 are larger.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3014 Splitting programs with less than 1\|000 lines of code into multiple
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3015 source files seldom leads to better readability.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3016 For such tools, splitting makes sense
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3017 when parts of the code are reused in other programs,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3018 and the reused code fragment is not general enough
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3019 for including it in the MH library,
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
3020 or, if the code has dependencies on a library that only few programs need.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3021 .Fn uip/packsbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3022 for instance, provides the core program logic for the
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3023 .Pn packf
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3024 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3025 .Pn rcvpack
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3026 programs.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3027 .Fn uip/packf.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3028 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3029 .Fn uip/rcvpack.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3030 mainly wrap the core function appropriately.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3031 No other tools use the folder packing functions.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3032 As another example,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3033 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3034 provides termcap support, which requires linking with a termcap or
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3035 curses library.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3036 Including
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3037 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3038 into the MH library would require every program to be linked with
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3039 termcap or curses, although only few of the programs require it.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3040 .P
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3041 The task of MIME handling is complex enough that splitting its code
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3042 into multiple source files improves the readability.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3043 The program
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3044 .Pn mhstore ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3045 for instance, is compiled out of seven source files with 2\|500
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3046 lines of code in summary.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3047 The main code file
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3048 .Fn uip/mhstore.c
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3049 consists of 800 lines; the other 1\|700 lines of code are reused in
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3050 other MIME handling tools.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3051 It seems to be worthwhile to bundle the generic MIME handling code into
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3052 a MH-MIME library, as a companion to the MH standard library.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3053 This is left open for the future.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3054 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3055 The work already done, focussed on the non-MIME tools.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3056 The amount of code compiled into each program was reduced.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3057 This eases the understanding of the code base.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3058 In nmh,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3059 .Pn comp
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3060 was built from six source files:
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3061 .Fn comp.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3062 .Fn whatnowproc.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3063 .Fn whatnowsbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3064 .Fn sendsbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3065 .Fn annosbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3066 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3067 .Fn distsbr.c .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3068 In mmh, it builds from only two:
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3069 .Fn comp.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3070 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3071 .Fn whatnowproc.c .
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3072 In nmh's
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3073 .Pn comp ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3074 the core function of
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3075 .Pn whatnow ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3076 .Pn send ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3077 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3078 .Pn anno
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3079 were compiled into
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3080 .Pn comp .
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3081 This saved the need to execute these programs with
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3082 .Fu fork()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3083 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3084 .Fu exec() ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3085 two expensive system calls.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3086 Whereis this approach improved the time performance,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3087 it interweaved the source code.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3088 Core functionalities were not encapsulated into programs but into
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3089 function, which were then wrapped by programs.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3090 For example,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3091 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3092 included the function
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3093 .Fu annotate() .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3094 Each program that wanted to annotate messages, included the source file
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3095 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3096 and called
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3097 .Fu annotate() .
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3098 Because the function
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3099 .Fu annotate()
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3100 was used like the tool
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3101 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3102 it had seven parameters, reflecting the command line switches of the tool.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3103 When another pair of command line switches was added to
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3104 .Pn anno ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3105 a rather ugly hack was implemented to avoid adding another parameter
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3106 to the function.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3107 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3108 .P
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3109 Separation simplifies the understanding of program code
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3110 because the area influenced by any particular statement is smaller.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3111 The separating on the program-level is more strict than the separation
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3112 on the function level.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3113 In mmh, the relevant code of
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3114 .Pn comp
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3115 comprises the two files
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3116 .Fn uip/comp.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3117 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3118 .Fn uip/whatnowproc.c ,
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3119 together 210 lines of code.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3120 In nmh,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3121 .Pn comp
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3122 comprises six files with 2\|450 lines.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3123 Not all of the code in these six files was actually used by
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3124 .Pn comp ,
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3125 but the code reader needed to read all of the code first to know which
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3126 parts were used.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3127 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3128 As I have read a lot in the code base during the last two years,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3129 I learned about the easy and the difficult parts.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3130 Code is easy to understand if:
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3131 .BU
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3132 The influenced code area is small
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3133 .BU
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
3134 The boundaries are strictly defined
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3135 .BU
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3136 The code is written straight-forward
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3137 .P
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3138 .\" XXX move this paragraph somewhere else?
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3139 Reading
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3140 .Pn rmm 's
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3141 source code in
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3142 .Fn uip/rmm.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3143 is my recommendation for a beginner's entry point into the code base of nmh.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3144 The reasons are that the task of
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3145 .Pn rmm
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3146 is straight forward and it consists of one small source code file only,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3147 yet its source includes code constructs typical for MH tools.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3148 With the introduction of the trash folder in mmh,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3149 .Pn rmm
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3150 became a bit more complex, because it invokes
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3151 .Pn refile .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3152 Still, it is a good example for a simple tool with clear sources.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3153 .P
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3154 Understanding
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3155 .Pn comp
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3156 requires to read 210 lines of code in mmh, but ten times as much in nmh.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3157 Due to the aforementioned hack in
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3158 .Pn anno
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3159 to save the additional parameter, information passed through the program's
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3160 source base in obscure ways.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3161 Thus, understanding
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3162 .Pn comp ,
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3163 required understanding the inner workings of
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3164 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3165 first.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3166 To be sure to fully understand a program, its whole source code needs
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3167 to be examined.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3168 Not doing so is a leap of faith, assuming that the developers
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3169 have avoided obscure programming techniques.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3170 By separating the tools on the program-level, the boundaries are
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3171 clearly visible and technically enforced.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3172 The interfaces are calls to
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3173 .Fu exec()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3174 rather than arbitrary function calls.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3175 .P
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3176 But the real problem is another:
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3177 Nmh violates the golden ``one tool, one job'' rule of the Unix philosophy.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3178 Understanding
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3179 .Pn comp
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3180 requires understanding
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3181 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3182 and
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3183 .Fn uip/sendsbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3184 because
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3185 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3186 does annotate and send messages.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3187 In nmh, there surely exists the tool
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3188 .Pn send ,
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3189 which does (almost) only send messages.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3190 But
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3191 .Pn comp
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3192 and
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3193 .Pn repl
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3194 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3195 .Pn forw
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3196 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3197 .Pn dist
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3198 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3199 .Pn whatnow
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3200 and
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3201 .Pn viamail ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3202 they all (!) have the same message sending function included, too.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3203 In result,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3204 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3205 sends messages without using
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3206 .Pn send .
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3207 The situation is the same as if
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3208 .Pn grep
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3209 would page without
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3210 .Pn more
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3211 just because both programs are part of the same code base.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3212 .P
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3213 The clear separation on the surface \(en the toolchest approach \(en
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3214 is violated on the level below.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3215 This violation is for the sake of time performance.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3216 On systems where
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3217 .Fu fork()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3218 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3219 .Fu exec()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3220 are expensive, the quicker response might be noticable.
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
3221 In the old times, sacrificing readability and conceptional beauty for
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
3222 speed might even have been a must to prevent MH from being unusably slow.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3223 Whatever the reasons had been, today they are gone.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3224 No longer should we sacrifice readability or conceptional beauty.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3225 No longer should we violate the Unix philosophy's ``one tool, one job''
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3226 guideline.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3227 No longer should we keep speed improvements that became unnecessary.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3228 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3229 Therefore, mmh's
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3230 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3231 does no longer send messages.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3232 In mmh, different jobs are divided among separate programs that
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3233 invoke each other as needed.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3234 In consequence,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3235 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3236 invokes
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3237 .Pn whatnow
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3238 which thereafter invokes
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3239 .Pn send .
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3240 The clear separation on the surface is maintained on the level below.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3241 Human users and the tools use the same interface \(en
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3242 annotations, for example, are made by invoking
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3243 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3244 no matter if requested by programs or by human beings.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3245 The decrease of tools built from multiple source files and thus
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3246 the decrease of
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3247 .Fn uip/*sbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3248 files confirm the improvement.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3249 .P
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3250 One disadvantage needs to be taken with this change:
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3251 The compiler can no longer check the integrity of the interfaces.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3252 By changing the command line interfaces of tools, it is
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3253 the developer's job to adjust the invocations of these tools as well.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3254 As this is a manual task and regression tests, which could detect such
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
3255 problems, are not available yet, it is prone to errors.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3256 These errors will not be detected at compile time but at run time.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3257 Installing regression tests is a task left to do.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3258 In the best case, a uniform way of invoking tools from other tools
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3259 can be developed to allow automated testing at compile time.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3260
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
3261
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
3262
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3263
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3264 .H2 "Separation
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3265
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3266 .U3 "MH Directory Split
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
3267 .P
19
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3268 In MH and nmh, a personal setup had consisted of two parts:
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3269 The MH profile, named
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3270 .Fn \&.mh_profile
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3271 and being located directly in the user's home directory.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3272 And the MH directory, where all his mail messages and also his personal
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3273 forms, scan formats, other configuration files are stored.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3274 The location
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3275 of this directory could be user-chosen.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3276 The default was to name it
19
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3277 .Fn Mail
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3278 and have it directly in the home directory.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3279 .P
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3280 I've never liked the data storage and the configuration to be intermixed.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3281 They are different kinds of data.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3282 One part, are the messages,
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3283 which are the data to operate on.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3284 The other part, are the personal
19
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3285 configuration files, which are able to change the behavior of the operations.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3286 The actual operations are defined in the profile, however.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3287 .P
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3288 When storing data, one should try to group data by its type.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3289 There's sense in the Unix file system hierarchy, where configuration
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3290 file are stored separate (\c
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3291 .Fn /etc )
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3292 to the programs (\c
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3293 .Fn /bin
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3294 and
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3295 .Fn /usr/bin )
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3296 to their sources (\c
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3297 .Fn /usr/src ).
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3298 Such separation eases the backup management, for instance.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3299 .P
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3300 In mmh, I've reorganized the file locations.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3301 Still there are two places:
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3302 There's the mail storage directory, which, like in MH, contains all the
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3303 messages, but, unlike in MH, nothing else.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3304 Its location still is user-chosen, with the default name
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3305 .Fn Mail ,
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3306 in the user's home directory.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3307 This is much similar to the case in nmh.
19
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3308 The configuration files, however, are grouped together in the new directory
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3309 .Fn \&.mmh
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3310 in the user's home directory.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3311 The user's profile now is a file, named
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3312 .Fn profile ,
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3313 in this mmh directory.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3314 Consistently, the context file and all the personal forms, scan formats,
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3315 and the like, are also there.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3316 .P
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3317 The naming changed with the relocation.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3318 The directory where everything, except the profile, had been stored (\c
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3319 .Fn $HOME/Mail ),
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3320 used to be called \fIMH directory\fP.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3321 Now, this directory is called the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3322 user's \fImail storage\fP.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3323 The name \fImmh directory\fP is now given to
19
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3324 the new directory
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3325 (\c
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3326 .Fn $HOME/.mmh ),
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3327 containing all the personal configuration files.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3328 .P
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3329 The separation of the files by type of content is logical and convenient.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3330 There are no functional differences as any possible setup known to me
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3331 can be implemented with both approaches, although likely a bit easier
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3332 with the new approach.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3333 The main goal of the change had been to provide
19
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3334 sensible storage locations for any type of personal mmh file.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3335 .P
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3336 In order for one user to have multiple MH setups, he can use the
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3337 environment variable
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3338 .Ev MH
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3339 the point to a different profile file.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3340 The MH directory (mail storage plus personal configuration files) is
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3341 defined by the
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3342 .Pe Path
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3343 profile entry.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3344 The context file could be defined by the
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3345 .Pe context
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3346 profile entry or by the
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3347 .Ev MHCONTEXT
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3348 environment variable.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3349 The latter is useful to have a distinct context (e.g. current folders)
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3350 in each terminal window, for instance.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3351 In mmh, there are three environment variables now.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3352 .Ev MMH
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3353 may be used to change the location of the mmh directory.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3354 .Ev MMHP
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3355 and
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3356 .Ev MMHC
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3357 change the profile and context files, respectively.
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3358 Besides providing a more consistent feel (which simply is the result
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3359 of being designed anew), the set of personal configuration files can
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3360 be chosen independently from the profile (including mail storage location)
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3361 and context, now.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3362 Being it relevant for practical use or not, it
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3363 de-facto is an improvement.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3364 However, the main achievement is the
19
ab5253e48c74 Wrote about the directory split.
markus schnalke <meillo@marmaro.de>
parents: 18
diff changeset
3365 split between mail storage and personal configuration files.
17
b3c37947764e Several minor text improvements.
markus schnalke <meillo@marmaro.de>
parents: 16
diff changeset
3366
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
3367
49
d3a02f5e63b3 Various rework.
markus schnalke <meillo@marmaro.de>
parents: 23
diff changeset
3368
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3369
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3370
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3371
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3372
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
3373 .H1 "Concept Exploitation/Homogeneity
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3374
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3375
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3376 .H2 "Draft Folder
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3377 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3378 Historically, MH provided exactly one draft message, named
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3379 .Fn draft
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3380 and
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3381 being located in the MH directory.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3382 When starting to compose another message
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3383 before the former one was sent, the user had been questioned whether to use,
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3384 refile or replace the old draft.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3385 Working on multiple drafts at the same time
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3386 was impossible.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3387 One could only work on them in alteration by refiling the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3388 previous one to some directory and fetching some other one for reediting.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3389 This manual draft management needed to be done each time the user wanted
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3390 to switch between editing one draft to editing another.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3391 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3392 To allow true parallel editing of drafts, in a straight forward way, the
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3393 draft folder facility exists.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3394 It had been introduced already in July 1984
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3395 by Marshall T. Rose.
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
3396 The facility was inactive by default.
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
3397 Even in nmh, the draft folder facility remained inactive by default.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3398 At least, Richard Coleman added the man page
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3399 .Mp mh-draft(5)
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3400 to document
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3401 the feature well.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3402 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3403 The only advantage of not using the draft folder facility is the static
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3404 name of the draft file.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3405 This could be an issue for MH front-ends like mh-e.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3406 But as they likely want to provide working on multiple drafts in parallel,
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3407 the issue is only concerning compatibility.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3408 The aim of nmh to stay compatible
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3409 prevented the default activation of the draft folder facility.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3410 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3411 On the other hand, a draft folder is the much more natural concept than
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3412 a draft message.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3413 MH's mail storage consists of folders and messages,
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3414 the messages named with ascending numbers.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3415 A draft message breaks with this
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3416 concept by introducing a message in a file named
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3417 .Fn draft .
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3418 This draft
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3419 message is special.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3420 It can not be simply listed with the available tools,
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3421 but instead requires special switches.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3422 I.e. corner-cases were
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3423 introduced.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3424 A draft folder, in contrast, does not introduce such
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3425 corner-cases.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3426 The available tools can operate on the messages within that
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3427 folder like on any messages within any mail folders.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3428 The only difference
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3429 is the fact that the default folder for
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3430 .Pn send
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3431 is the draft folder,
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3432 instead of the current folder, like for all other tools.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3433 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3434 The trivial part of the change was activating the draft folder facility
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3435 by default and setting a default name for this folder.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3436 Obviously, I chose
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3437 the name
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3438 .Fn +drafts .
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3439 This made the
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3440 .Sw -draftfolder
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3441 and
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3442 .Sw -draftmessage
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3443 switches useless, and I could remove them.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3444 The more difficult but also the part that showed the real improvement,
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3445 was updating the tools to the new concept.
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3446 .Sw -draft
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3447 switches could
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3448 be dropped, as operating on a draft message became indistinguishable to
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3449 operating on any other message for the tools.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3450 .Pn comp
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3451 still has its
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3452 .Sw -use
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3453 switch for switching between its two modes: (1) Compose a new
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3454 draft, possibly by taking some existing message as a form.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3455 (2) Modify
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3456 an existing draft.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3457 In either case, the behavior of
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3458 .Pn comp is
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3459 deterministic.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3460 There is no more need to query the user.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3461 I consider this
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3462 a major improvement.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3463 By making
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3464 .Pn send
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3465 simply operate on the current
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3466 message in the draft folder by default, with message and folder both
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3467 overridable by specifying them on the command line, it is now possible
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3468 to send a draft anywhere within the storage by simply specifying its folder
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3469 and name.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3470 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3471 All theses changes converted special cases to regular cases, thus
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3472 simplifying the tools and increasing the flexibility.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3473
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3474
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3475 .H2 "Trash Folder
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3476 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3477 Similar to the situation for drafts is the situation for removed messages.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3478 Historically, a message was deleted by renaming.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3479 A specific
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3480 \fIbackup prefix\fP, often comma (\c
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3481 .Fn , )
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3482 or hash (\c
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3483 .Fn # ),
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3484 being prepended to the file name.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3485 Thus, MH wouldn't recognize the file
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3486 as a message anymore, as only files whose name consists of digits only
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3487 are treated as messages.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3488 The removed messages remained as files in the
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3489 same directory and needed some maintenance job to truly delete them after
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3490 some grace time.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3491 Usually, by running a command similar to
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3492 .VS
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3493 find /home/user/Mail -ctime +7 -name ',*' | xargs rm
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3494 VE
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3495 in a cron job.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3496 Within the grace time interval
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3497 the original message could be restored by stripping the
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3498 the backup prefix from the file name.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3499 If however, the last message of
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3500 a folder is been removed \(en say message
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3501 .Fn 6
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3502 becomes file
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3503 .Fn ,6
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3504 \(en and a new message enters the same folder, thus the same
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3505 numbered being given again \(en in our case
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3506 .Fn 6
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3507 \(en, if that one
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3508 is removed too, then the backup of the former message gets overwritten.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3509 Thus, the ability to restore removed messages does not only depend on
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3510 the ``sweeping cron job'' but also on the removing of further messages.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3511 This is undesirable, because the real mechanism is hidden from the user
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3512 and the consequences of further removals are not always obvious.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3513 Further more, the backup files are scattered within the whole mail
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3514 storage, instead of being collected at one place.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3515 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3516 To improve the situation, the profile entry
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3517 .Pe rmmproc
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3518 (previously named
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3519 .Pe Delete-Prog )
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3520 was introduced, very early.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3521 It could be set to any command, which would care for the mail removal
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3522 instead of taking the default action, described above.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3523 Refiling the to-be-removed files to some garbage folder was a common
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3524 example.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3525 Nmh's man page
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3526 .Mp rmm(1)
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3527 proposes
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3528 .Cl "refile +d
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3529 to move messages to the garbage folder and
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3530 .Cl "rm `mhpath +d all`
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3531 the empty the garbage folder.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3532 Managing the message removal this way is a sane approach.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3533 It keeps
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3534 the removed messages in one place, makes it easy to remove the backup
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3535 files, and, most important, enables the user to use the tools of MH
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3536 itself to operate on the removed messages.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3537 One can
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3538 .Pn scan
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3539 them,
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3540 .Pn show
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3541 them, and restore them with
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3542 .Pn refile .
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3543 There's no more
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3544 need to use
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3545 .Pn mhpath
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3546 to switch over from MH tools to Unix tools \(en MH can do it all itself.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3547 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3548 This approach matches perfect with the concepts of MH, thus making
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3549 it powerful.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3550 Hence, I made it the default.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3551 And even more, I also
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3552 removed the old backup prefix approach, as it is clearly less powerful.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3553 Keeping unused alternative in the code is a bad choice as they likely
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3554 gather bugs, by not being constantly tested.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3555 Also, the increased code
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3556 size and more conditions crease the maintenance costs.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3557 By strictly
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3558 converting to the trash folder approach, I simplified the code base.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3559 .Pn rmm
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3560 calls
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3561 .Pn refile
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3562 internally to move the to-be-removed
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3563 message to the trash folder (\c
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3564 .Fn +trash
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3565 by default).
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
3566 Messages
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3567 there can be operated on like on any other message in the storage.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3568 The sweep clean, one can use
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3569 .Cl "rmm -unlink +trash a" ,
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3570 where the
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
3571 .Sw -unlink
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3572 switch causes the files to be truly unliked instead
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3573 of moved to the trash folder.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3574
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3575
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3576 .H2 "Path Notations
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3577 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3578 foo
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3579
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3580
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3581 .H2 "MIME Integration
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3582 .P
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3583 user-visible access to whole messages and MIME parts are inherently
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3584 different
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3585
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3586
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3587 .H2 "Of One Cast
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3588 .P