Mercurial > docs > master

annotate discussion.roff @ 216:91999f2cddeb

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updates of the Colophon.
author markus schnalke <meillo@marmaro.de>
date Fri, 13 Jul 2012 18:35:36 +0200
parents 9317d789cef9
children f3f65376bef9
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
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
3 This main chapter discusses the practical work accomplished in the
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
4 mmh project.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
5 It is structured along the goals set for the project.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
6 The concrete work undertaken
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
7 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
8 The discussion compares the current version of mmh with the state of
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
9 nmh just before the mmh project started, i.e. fall 2011.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
10 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
11 .\" XXX where do I discuss the parallel development of nmh?
187
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
12 .P
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
13 For the reader's convenience, the structure of modern email systems
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
14 is depicted in the figure.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
15 It illustrates the path a message takes from sender to recipient.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
16 .sp
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
17 .KS
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
18 .in 2c
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
19 .so input/mail-agents.pic
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
20 .KE
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
21 .sp
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
22 .LP
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
23 The ellipses denote mail agents, i.e. different jobs in email processing:
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
24 .IP "Mail User Agent (MUA)
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
25 The only program the user interacts directly with.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
26 It includes functions to compose new mail, display received mail,
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
27 and to manage the mail storage.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
28 Also called \fImail client\fP.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
29 .IP "Mail Submission Agent (MSA)
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
30 A special kind of Mail Transfer Agent, used to submit mail into the
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
31 mail transport system.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
32 .IP "Mail Transfer Agent (MTA)
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
33 A node in the mail transport system.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
34 Transfers incoming mail to a transport node nearer to the final destination.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
35 It may be the final destination itself.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
36 .IP "Mail Delivery Agent (MDA)
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
37 Delivers mail by storing it onto disk, usually according to a set of rules.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
38 .IP "Mail Retrieval Agent (MRA)
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
39 Initiates the transfer of mail from a remote server to the local machine.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
40 (The dashed arrow represents the pull request.)
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
41 .P
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
42 The dashed boxes represent groups that usually reside on single machines.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
43 The box on the lower left represents the sender's local system.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
44 The box on the upper left represents the first mail transfer node.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
45 The box on the upper right represents the transfer node responsible for the
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
46 destination address.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
47 The box on the lower right represents the recipient's local system.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
48 Often, the boxes above the dotted line are servers on the Internet.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
49 Many mail clients, including nmh, have all of the components below
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
50 the dotted line implemented.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
51 Not so in mmh, which is an MUA only.
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
52
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
53
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
54
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
55
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
56
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
57
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
58 .\" --------------------------------------------------------------
125
0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/
markus schnalke <meillo@marmaro.de>
parents: 124
diff changeset
59 .H1 "Streamlining
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
60
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
61 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
62 MH once provided anything necessary for email handling.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
63 The community around nmh has the similar understanding that nmh should
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
64 provide a complete email system.
178
520b3c7abba1 s/a MUA/an MUA/
markus schnalke <meillo@marmaro.de>
parents: 177
diff changeset
65 In fundamental contrast, mmh shall be an MUA only.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
66 I believe that the development of all-in-one mail systems is obsolete.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
67 Today, email is too complex to be fully covered by a single project.
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
68 Such a project will not be able to excel in all aspects.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
69 Instead, the aspects of email should be covered by multiple projects,
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
70 which then can be combined to form a complete system.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
71 Excellent implementations for the various aspects of email already exist.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
72 Just to name three examples: Postfix is a specialized MTA,
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
73 .\" XXX homepages verlinken
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
74 Procmail is a specialized MDA, and Fetchmail is a specialized MRA.
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
75 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
76 providing the same function again as a side-component in the project.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
77 .\" XXX mail agent picture here
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
78 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
79 Doing something well requires focusing on a small set of specific aspects.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
80 Under the assumption that development focussed on a particular area
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
81 produces better results there, specialized projects will be superior
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
82 in their field of focus.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
83 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
84 or modular \(en will never be the best choice in any of the fields.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
85 Even in providing the best consistent all-in-one system, they are likely
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
86 to be beaten by projects that focus only on integrating existing mail
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
87 components to create a homogeneous system.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
88 .P
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
89 The limiting resource in the community development of free software
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
90 is usually man power.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
91 .\" XXX FIXME ref!
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
92 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
93 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
94 various fields.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
95 The concrete situation for MH-based mail systems is even tougher,
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
96 given their small and aged community, concerning both developers and users.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
97 .P
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
98 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
99 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
100 This is clearly the user interface \(en the MUA.
125
0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/
markus schnalke <meillo@marmaro.de>
parents: 124
diff changeset
101 Peripheral parts should be removed to streamline 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
102
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
103
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
104 .H2 "Mail Transfer Facilities
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
105 .Id mail-transfer-facilities
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
106 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
107 In contrast to nmh, which also provides mail submission and mail retrieval
178
520b3c7abba1 s/a MUA/an MUA/
markus schnalke <meillo@marmaro.de>
parents: 177
diff changeset
108 agents, mmh is an MUA only.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
109 This general difference initiated the development of mmh.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
110 The removal of the mail transfer facilities was the first work task
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
111 in the mmh project.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
112 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
113 Focusing on one mail agent role only, is motivated by Eric Allman's
105
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
114 experience with Sendmail.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
115 He identified the limitation of Sendmail to the MTA task as one reason for
105
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
116 its success:
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
117 .[ [
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
118 costales sendmail
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
119 .], p. xviii]
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
120 .QS
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
121 Second, I limited myself to the routing function \(en
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
122 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
123 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
124 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
125 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
126 .QE
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
127 .P
187
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
128 In nmh, the MSA is called \fIMessage Transfer Service\fP (MTS).
105
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
129 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
130 .Pn post
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML.
markus schnalke <meillo@marmaro.de>
parents: 104
diff changeset
131 command, established network connections and spoke SMTP to submit
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
132 messages to be relayed to the outside world.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
133 The changes in email demanded changes in this part of nmh as well.
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
134 Encryption and authentication for network connections
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
135 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
136 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
137 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
138 mail transfer requires development power and specialists.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
139 In mmh, this whole facility was simply cut off.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
140 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
141 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
142 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
143 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
144 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
145 .Pn sendmail
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
146 command, which almost any MSA provides.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
147 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
148 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
149 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
150 over to the MSA.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
151 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
152 .VS
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
153 #!/bin/sh
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
154 exec qmail-inject # ignore command line arguments
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
155 VE
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
156 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
157 is likely to be removed in the future.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
158 Then mmh would pass the recipient addresses as command line arguments.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
159 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
160 .\" XXX implement it
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
161 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
162 To retrieve mail, the
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
163 .Pn inc
187
5360f5fdb118 Added mail agent figure.
markus schnalke <meillo@marmaro.de>
parents: 183
diff changeset
164 command acted as an MRA.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
165 It established network connections
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
166 and spoke POP3 to retrieve mail from remote servers.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
167 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
168 authentication, thus TLS and SASL were added.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
169 Support for message retrieval through IMAP will soon become necessary
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
170 additions, too, and likewise for any other changes in mail transfer.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
171 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
172 from remote locations.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
173 .Ci ab7b48411962d26439f92f35ed084d3d6275459c
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
174 Instead, it depends on an external tool to cover this task.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
175 Mmh has two paths for messages to enter mmh's mail storage:
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
176 (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
177 .Pn inc
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
178 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
179 .Pn rcvstore
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
180 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
181 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
182 With the removal of the MSA and MRA, mmh converted from an all-in-one
178
520b3c7abba1 s/a MUA/an MUA/
markus schnalke <meillo@marmaro.de>
parents: 177
diff changeset
183 mail system to being an MUA only.
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
184 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
185 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
186 an external MRA is required to retrieve mail from remote machines.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
187 Excellent implementations of such software exist,
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
188 which likely are superior than the internal version.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
189 Additionally, 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
190 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
191 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
192 why not keep the internal version for convenience?
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
193 .\" XXX ueberleitung
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
194 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
195 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
196 .Pn more
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
197 or
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
198 .Pn less
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
199 are not available, appears to be ridiculous.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
200 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
201 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
202 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
203 .[
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
204 mcilroy unix phil
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
205 p. 53
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
206 .]
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
207 .[
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
208 mcilroy bstj foreword
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
209 .]
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
210 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
211 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
212 In other words:
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
213 Develop projects that focus on one thing and do it well.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
214 Projects which have grown complex should be split, for the same
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
215 reasons that programs which have grown complex should be split.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
216 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
217 separate projects then they should be separated.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
218 In my opinion, this is the case here.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
219 The RFCs propose this separation by clearly distinguishing the different
199
5cd9bacdfcd3 Updated RFCs.
markus schnalke <meillo@marmaro.de>
parents: 197
diff changeset
220 mail handling tasks [RFC\|821].
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
221 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
222 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
223 Email once had been small and simple.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
224 At that time,
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
225 .Pn /bin/mail
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
226 had covered everything there was to email and still was small and simple.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
227 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
228 (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
229 .[[
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
230 brooks no silver bullet
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
231 .]])
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
232 Email systems reacted to this change: they grew.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
233 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
234 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
235 As the mail systems grew even more, parts were split off.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
236 For instance, a POP server was included in the original MH;
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
237 it was removed in nmh.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
238 Now is the time to go one step further and split off the MSA and MRA, too.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
239 Not only does this decrease the code size of the project,
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
240 more importantly, it unburdens mmh of the whole field of
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
241 message transfer with all its implications for the project.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
242 There is no more need for concern with changes in network transfer.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
243 This independence is gained by depending on an external program
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
244 that covers the field.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
245 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
246 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
247 .\" XXX ueberleitung ???
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
248 Functionality can be added in three different ways:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
249 .LI 1
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
250 Implementing the function in the project itself.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
251 .LI 2
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
252 Depending on a library that provides the function.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
253 .LI 3
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
254 Depending on a program that provides the function.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
255 .LP
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
256 .\" XXX Rework sentence
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
257 While implementing the function in the project itself leads to the
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
258 largest increase in code size and requires the most maintenance
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
259 and development work,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
260 it increases the project's independence of other software the most.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
261 Using libraries or external programs requires less maintenance work
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
262 but introduces dependencies on external software.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
263 Programs have the smallest interfaces and provide the best separation,
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
264 but possibly limit the information exchange.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
265 External libraries are more strongly connected than external programs,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
266 thus information can be exchanged in a more flexible manner.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
267 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
268 .\" XXX ref
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
269 Implementing complex functions in the project itself adds
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
270 a lot of code.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
271 This should be avoided if possible.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
272 Hence, the dependencies only change in their character,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
273 not in their existence.
66
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
274 In mmh, library dependencies on
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
275 .Pn libsasl2
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
276 and
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
277 .Pn libcrypto /\c
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
278 .Pn libssl
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
279 were traded against program dependencies on an MSA and an MRA.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
280 This also meant trading build-time dependencies against run-time
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
281 dependencies.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
282 Besides providing stronger separation and greater flexibility,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
283 program dependencies also allowed
66
4c9f4d05d90e Rework and extension of text from yesterday.
markus schnalke <meillo@marmaro.de>
parents: 63
diff changeset
284 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
285 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
286 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
287 losing functionality is a convincing argument.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
288 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
289 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
290 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
291 Users of MH should not have problems setting 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
292 Also, the popular MSAs and MRAs have large communities and a lot
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
293 of available documentation.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
294 Choices for MSAs range from full-featured MTAs such as
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
295 .\" XXX refs
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
296 .I Postfix ,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
297 over mid-size MTAs such as
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
298 .I masqmail
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
299 and
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
300 .I dma ,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
301 to small forwarders such as
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
302 .I ssmtp
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
303 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
304 .I nullmailer .
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
305 Choices for MRAs include
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
306 .I fetchmail ,
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
307 .I getmail ,
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
308 .I mpop
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
309 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
310 .I fdm .
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
311
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
312
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
313 .H2 "Non-MUA Tools
60
6a92e0208de0 Wrote about the removal of the mail transfer facilities.
markus schnalke <meillo@marmaro.de>
parents: 58
diff changeset
314 .P
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
315 One goal of mmh is to remove the tools that are not part of the MUA's task.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
316 Furthermore, any tools that do not significantly improve the MUA's job
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
317 should be removed.
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
318 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
319 They require maintenance work without adding much to the core task.
125
0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/
markus schnalke <meillo@marmaro.de>
parents: 124
diff changeset
320 By removing these tools, the project shall become more streamlined
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
321 and focused.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
322 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
323 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
324 .Pn conflict
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
325 was removed
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
326 .Ci 8b235097cbd11d728c07b966cf131aa7133ce5a9
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
327 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
328 It even checked
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
329 .Fn /etc/passwd
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
330 and
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
331 .Fn /etc/group
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
332 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
333 A tool like
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
334 .Pn conflict
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
335 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
336 .\" XXX historic reasons?
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
337 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
338 .Pn rcvtty
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
339 was removed
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
340 .Ci 14767c94b3827be7c867196467ed7aea5f6f49b0
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
341 because its use case of writing to the user's terminal
200
c299ed65d015 Spell checked.
markus schnalke <meillo@marmaro.de>
parents: 199
diff changeset
342 on reception of mail is obsolete.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
343 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
344 .Ev MAILPATH
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
345 variable or graphical notifications are technically more appealing.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
346 Writing directly to terminals is hardly ever desired today.
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
347 If, though, one prefers this approach, the standard tool
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
348 .Pn write
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
349 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
350 .VS
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
351 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
352 VE
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
353 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
354 .Pn viamail
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
355 .\" XXX was macht viamail
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
356 was removed
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
357 .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
358 when the new attachment system was activated, because
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
359 .Pn forw
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
360 could then cover the task itself.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
361 The program
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
362 .Pn sendfiles
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
363 was rewritten as a shell script wrapper around
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
364 .Pn forw .
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
365 .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
366 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
367 .Pn msgchk
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
368 .\" XXX was macht msgchk
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
369 was removed
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
370 .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe ,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
371 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
372 A call to
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
373 .Pn msgchk
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
374 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
375 .VS
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
376 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
377 VE
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
378 It did distinguish between old and new mail, but
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
379 these details can be retrieved with
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
380 .Pn stat (1),
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
381 too.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
382 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
383 in a similar way, if truly necessary.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
384 As mmh's
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
385 .Pn inc
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
386 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
387 and thus no data transfers over slow networks are involved,
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
388 there is 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
389 .BU
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
390 .Pn msh
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
391 was removed
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
392 .Ci 916690191222433a6923a4be54b0d8f6ac01bd02
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
393 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
394 It provided an interactive shell to access the features of MH,
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
395 but it was not just a shell tailored to the needs of mail handling.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
396 Instead, it was one large program that had several MH tools built in.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
397 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
398 .Pn msh 's
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
399 main use case had been accessing Bulletin Boards, which have ceased to
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
400 be popular.
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
401 .P
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
402 Removing
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
403 .Pn msh
212
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
404 together with the truly archaic code relics
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
405 .Pn vmh
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
406 and
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
407 .Pn wmh
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
408 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
409 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
410 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
411 for the same functionality is an advantage.
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
412 Less code means less bugs and less maintenance work.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
413 As
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
414 .Pn rcvtty
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
415 and
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
416 .Pn msgchk
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
417 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
418 why should one keep them?
125
0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/
markus schnalke <meillo@marmaro.de>
parents: 124
diff changeset
419 Removing them streamlines mmh.
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
420 .Pn viamail 's
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
421 use case is now partly obsolete and partly covered by
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
422 .Pn forw ,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
423 hence there's no reason to still maintain it.
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
424 .Pn conflict
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
425 is not related to the mail client, and
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
426 .Pn msh
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
427 conflicts with the basic concept of MH.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
428 These 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
429 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
430 Finally, there is
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
431 .Pn slocal .
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
432 .Pn slocal
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
433 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
434 It should be removed from mmh, because including it conflicts with
178
520b3c7abba1 s/a MUA/an MUA/
markus schnalke <meillo@marmaro.de>
parents: 177
diff changeset
435 the idea that mmh is an MUA only.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
436 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
437 should rather become a separate project.
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
438 However,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
439 .Pn slocal
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
440 provides rule-based processing of messages, like filing them into
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
441 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
442 Although
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
443 .Pn slocal
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
444 neither pulls in dependencies, nor does it include a separate
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
445 technical area (cf. Sec.
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
446 .Cf mail-transfer-facilities ),
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
447 it still 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
448 As
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
449 .Pn slocal
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
450 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
451 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
452 .Pn slocal .
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
453 For anyone not using MH,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
454 .Pn slocal
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
455 would become yet another independent MDA, like
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
456 .I procmail .
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
457 Then
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
458 .Pn slocal
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
459 could be installed without the complete MH system.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
460 Likewise, mmh users could decide to use
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
461 .I procmail
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
462 without having a second, unused MDA,
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
463 .Pn slocal ,
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
464 installed.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
465 That appears to be conceptionally the best solution.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
466 Yet,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
467 .Pn slocal
87
7d5b180de542 All kinds of rework plus new refs.
markus schnalke <meillo@marmaro.de>
parents: 85
diff changeset
468 is not split off.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
469 I defer the decision over
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
470 .Pn slocal
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
471 out of a need for deeper investigation.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
472 In the meanwhile, it remains part of mmh.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
473 However, its continued existence is not significant because
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
474 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
475 is unrelated to the rest of the project.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
476
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
477
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
478
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
479 .H2 "Displaying Messages
155
75f20c925999 Fixed macro typo; and added typo fix found by Boris.
markus schnalke <meillo@marmaro.de>
parents: 154
diff changeset
480 .Id mhshow
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
481 .P
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
482 Since the very beginning, already in the first concept paper,
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
483 .\" XXX ref!!!
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
484 .Pn show
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
485 had been MH's message display program.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
486 .Pn show
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
487 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
488 .Pn mhl
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
489 to have the files formatted.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
490 With MIME, this approach was not sufficient anymore.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
491 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
492 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
493 foreign charsets.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
494 .Pn show 's
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
495 understanding of messages and
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
496 .Pn mhl 's
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
497 display capabilities could not cope with the task any longer.
62
24aabbfe5794 Minor rework of larger text areas.
markus schnalke <meillo@marmaro.de>
parents: 60
diff changeset
498 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
499 Instead of extending these tools, additional tools were written from
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
500 scratch and added to the MH tool chest.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
501 Doing so is encouraged by the tool chest approach.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
502 Modular design is a great advantage for extending a system,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
503 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
504 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
505 .Pn mhn .
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
506 The command
82
ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment.
markus schnalke <meillo@marmaro.de>
parents: 78
diff changeset
507 .Cl "mhn -show 42
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
508 would show the MIME message numbered 42.
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
509 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
510 the split of
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
511 .Pn mhn
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
512 into a set of specialized tools, which together covered the
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
513 multiple aspects of MIME.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
514 One of them was
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
515 .Pn mhshow ,
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
516 which replaced
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
517 .Cl "mhn -show" .
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
518 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
519 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
520 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
521 .Pn show
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
522 and
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
523 .Pn mhshow .
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
524 To ease the life of users,
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
525 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
526 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
527 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
528 if displaying the message would be beyond
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
529 .Pn show 's
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
530 abilities.
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
531 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
532 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
533 (possibly through
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
534 .Pn next
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
535 or
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
536 .Pn prev )
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
537 and get the message printed with either
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
538 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
539 or
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
540 .Pn mhshow ,
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
541 whatever was more appropriate.
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
542 .P
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
543 Having two similar tools for essentially the same task is redundant.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
544 Usually, users would not distinguish between
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
545 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
546 and
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
547 .Pn mhshow
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
548 in their daily mail reading.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
549 Having two separate display programs was therefore mainly unnecessary
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
550 from a user's point of view.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
551 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
552 to ensure that the programs behaved in a similar way,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
553 because they were used like a single tool.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
554 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
555 .P
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
556 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
557 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
558 As
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
559 .Pn mhshow
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
560 had already been 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
561 to drop
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
562 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
563 in favor of using
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
564 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
565 exclusively.
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
566 .Ci 4c1efddfd499300c7e74263e57d8aa137e84c853
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
567 Removing
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
568 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
569 is no loss in function, because functionally
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
570 .Pn mhshow
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
571 covers it completely.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
572 The old behavior of
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
573 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
574 can still be emulated with the simple command line:
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
575 .VS
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
576 mhl `mhpath c`
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
577 VE
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
578 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
579 For convenience,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
580 .Pn mhshow
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
581 was renamed to
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
582 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
583 after
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
584 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
585 was gone.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
586 It is clear that such a rename may confuse future developers when
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
587 trying to understand the history.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
588 Nevertheless, I consider the convenience on the user's side,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
589 to call
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
590 .Pn show
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
591 when they want a message to be displayed, to outweigh the inconvenience
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
592 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
593 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
594 To prepare for the transition,
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
595 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
596 was reworked to behave more like
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
597 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
598 first.
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
599 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
600 .Cf mhshow )
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
601 .\" XXX code commits?
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
602 Once the tools behaved more alike, the replacing appeared to be
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
603 even more natural.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
604 Today, mmh's new
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
605 .Pn show
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
606 has become the one single message display program once more,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
607 with the difference
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
608 that today it handles MIME messages as well as non-MIME messages.
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
609 The outcome of the transition is one program less to maintain,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
610 no second display program for users to deal with,
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
611 and less system complexity.
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
612 .P
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
613 Still, removing the old
69
f80ced4e749b Wrote more about the show-mhshow merge.
markus schnalke <meillo@marmaro.de>
parents: 66
diff changeset
614 .Pn show
88
30830e3b9e98 Further rework.
markus schnalke <meillo@marmaro.de>
parents: 87
diff changeset
615 hurts in one regard: It had been such a simple program.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
616 Its lean elegance is missing from the new
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
617 .Pn show ,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
618 .\" XXX
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
619 however there is no alternative;
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
620 supporting MIME demands higher essential complexity.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
621
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
622 .ig
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
623 XXX
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
624 Consider including text on scan listings here
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
625
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
626 Scan listings shall not contain body content. Hence, removed this feature.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
627 Scan listings shall operator on message headers and non-message information
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
628 only. Displaying the beginning of the body complicates everything too much.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
629 That's no surprise, because it's something completely different. If you
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
630 want to examine the body, then use show(1)/mhshow(1).
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
631 Changed the default scan formats accordingly.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
632 .Ci 70b2643e0da8485174480c644ad9785c84f5bff4
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
633 ..
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
634
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
635
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
636
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
637
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
638 .H2 "Configure Options
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
639 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
640 Customization is a double-edged sword.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
641 It allows better suiting setups, but not for free.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
642 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
643 There is the cost of less tested setups, because there are
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
644 more possible setups and especially corner cases.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
645 Additionally, there is the cost of choice itself.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
646 The code complexity directly affects the developers.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
647 Less tested code affects both users and developers.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
648 The problem of choice affects the users, for once by having to choose,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
649 but also by more complex interfaces that require more documentation.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
650 Whenever options add few advantages but increase the complexity of the
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
651 system, they should be considered for removal.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
652 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
653 fifteen to three.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
654
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
655 .U3 "Mail Transfer Facilities
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
656 .P
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
657 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
658 options vanished:
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
659 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
660 The switches
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
661 .Sw --with-tls
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
662 and
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
663 .Sw --with-cyrus-sasl
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
664 had activated the support for transfer encryption and authentication.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
665 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
666 .\" XXX gruende kurz wiederholen
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
667 This is not needed anymore.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
668 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
669 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
670 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
671 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
672 .\" XXX ``For the same reason ...''
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
673 The configure switch
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
674 .Sw --enable-pop
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
675 activated the message retrieval facility.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
676 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
677 support had been small.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
678 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
679 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
680 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
681 The changes in the code base could hardly be overviewed.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
682 By having POP support togglable, a second code base had been created,
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
683 one that needed to be tested.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
684 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
685 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
686 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
687 of the original program.
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
688 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
689 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
690 Two other options only specified default configuration values:
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
691 .Sw --with-mts
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
692 defined the default transport service.
85
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
693 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
fb0d1b4c8fb1 Extended the text about mail transfer configure options.
markus schnalke <meillo@marmaro.de>
parents: 84
diff changeset
694 With
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
695 .Sw --with-smtpservers
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
696 default SMTP servers could be specified.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
697 .Ci 128545e06224233b7e91fc4c83f8830252fe16c9
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
698 Both of them became irrelevant when the SMTP transport service was removed.
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
699 .\" XXX code ref
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
700 In mmh, all messages are handed over to
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
701 .Pn sendmail
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
702 for transportation.
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
703
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
704
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
705 .U3 "Backup Prefix
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
706 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
707 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
708 filenames to tag them as deleted.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
709 By default it had been the comma character (`\fL,\fP').
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
710 .\" XXX Zeitlich ordnen
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
711 In July 2000, Kimmo Suominen introduced
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
712 the configure option
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
713 .Sw --with-hash-backup
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
714 to change the default to the hash character `\f(CW#\fP'.
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
715 The choice was probably personal preference, because first, the
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
716 option was named
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
717 .Sw --with-backup-prefix.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
718 and had the prefix character as argument.
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
719 But giving the hash character as argument caused too many problems
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
720 for Autoconf,
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
721 thus the option was limited to use the hash character as the default prefix.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
722 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
723 personal preference only.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
724 Being related or not, words that start with the hash character
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
725 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
726 Thus, the command line
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
727 .Cl "rm #13 #15
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
728 calls
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
729 .Pn rm
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
730 without arguments because the first hash character starts the comment
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
731 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
732 To delete the backup files,
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
733 .Cl "rm ./#13 ./#15"
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
734 needs to be used.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
735 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
736 data loss.
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
737 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
738 First, I removed the configure option but added the profile entry
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
739 .Pe backup-prefix ,
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
740 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
741 .Ci 6c40d481d661d532dd527eaf34cebb6d3f8ed086
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
742 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
743 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
744 it suited better.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
745 .P
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
746 Eventually, however, the new trash folder concept
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
747 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
748 .Cf trash-folder )
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
749 removed the need for the backup prefix completely.
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
750 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
751 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
752
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
753
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
754 .U3 "Editor and Pager
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
755 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
756 The two configure options
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
757 .CW --with-editor=EDITOR
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
758 .CW --with-pager=PAGER
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
759 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
760 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
761 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
762 different systems.
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
763 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
764 The programs
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
765 .Pn vi
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
766 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
767 .Pn more
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
768 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
769 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
770 (The specifications for
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
771 .Pn vi
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
772 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
773 .Pn more
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
774 appeared in
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
775 .[
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
776 posix 1987
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
777 .]
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
778 and,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
779 .[
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
780 posix 1992
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
781 .]
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
782 respectively.)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
783 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
784 .Ci 5d43a99db70c12a673028c7758c20cbe3e13ef5f
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
785 Not changed were the
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
786 .Pe editor
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
787 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
788 .Pe moreproc
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
789 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
790 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
791 variables
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
792 .Ev VISUAL
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
793 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
794 .Ev PAGER
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
795 if they are set.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
796 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
797 taking the first available and non-empty item:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
798 .LI 1
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
799 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
800 .Ev MMHEDITOR
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
801 .LI 2
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
802 Profile entry
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
803 .Pe Editor
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
804 .LI 3
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
805 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
806 .Ev VISUAL
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
807 .LI 4
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
808 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
809 .Ev EDITOR
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
810 .LI 5
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
811 Command
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
812 .Pn vi .
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
813 .LP
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
814 .Ci f85f4b7ae62e3d05a945dcd46ead51f0a2a89a9b
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
815 .P
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
816 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
817 also taking the first available and non-empty item:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
818 .LI 1
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
819 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
820 .Ev MMHPAGER
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
821 .LI 2
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
822 Profile entry
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
823 .Pe Pager
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
824 (replaces
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
825 .Pe moreproc )
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
826 .LI 3
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
827 Environment variable
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
828 .Ev PAGER
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
829 .LI 4
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
830 Command
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
831 .Pn more .
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
832 .LP
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
833 .Ci 0c4214ea2aec6497d0d67b436bbee9bc1d225f1e
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
834 .P
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
835 By respecting the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
836 .Ev VISUAL /\c
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
837 .Ev EDITOR
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
838 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
839 .Ev PAGER
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
840 environment variables,
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
841 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
842 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
843
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
844
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
845 .U3 "ndbm
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
846 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
847 .Pn slocal
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
848 used to depend on
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
849 .I ndbm ,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
850 a database library.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
851 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
852 messages delivered.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
853 This enables
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
854 .Pn slocal
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
855 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
856 (This features was enabled by the
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
857 .Sw -suppressdup
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
858 switch.)
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
859 .P
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
860 A variety of versions of the database library exist.
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
861 .[
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
862 wolter unix incompat notes dbm
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
863 .]
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
864 Complicated autoconf code was needed to detect them correctly.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
865 Furthermore, the configure switches
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
866 .Sw --with-ndbm=ARG
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
867 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
868 .Sw --with-ndbmheader=ARG
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
869 were added to help with difficult setups that would
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
870 not be detected automatically or correctly.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
871 .P
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
872 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
873 .Pn slocal ,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
874 the dependency on
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
875 .I ndbm
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
876 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
877 .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf
89
83bfb4dbf59f Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 88
diff changeset
878 The change removed functionality too, but that is minor to the
78
64f177ca2af1 Text rework.
markus schnalke <meillo@marmaro.de>
parents: 76
diff changeset
879 improvement by dropping the dependency and the complex autoconf code.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
880 .\" XXX argument: slocal ist sowieso nicht teil vom mmh kern
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
881
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
882 .U3 "mh-e Support
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
883 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
884 The configure option
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
885 .Sw --disable-mhe
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
886 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
887 Mh-e is the Emacs front-end to MH.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
888 It requires MH to provide minor additional functions.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
889 The
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
890 .Sw --disable-mhe
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
891 configure option could switch these extensions off.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
892 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
893 only the
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
894 .Sw -build
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
895 switches of
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
896 .Pn forw
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
897 and
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
898 .Pn repl
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
899 are left to be mh-e extensions.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
900 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
901 In consequence, the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
902 .Sw --disable-mhe
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
903 configure option was removed
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
904 .Ci a7ce7b4a580d77b6c2c4d980812beb589aa4c643
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
905 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
906 needed to be tested.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
907 .\" XXX datum?
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
908 This change was first accomplished in nmh and thereafter merged into mmh.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
909 .P
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
910 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
911 to be able to use mmh as back-end.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
912 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
913 .Sw -build
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
914 switches would require more rework.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
915
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
916 .U3 "Masquerading
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
917 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
918 The configure option
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
919 .Sw --enable-masquerade
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
920 could take up to three arguments:
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
921 `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
922 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
923 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
924 .Pn post
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
925 command, which provided an MSA.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
926 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
927 this field anymore.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
928 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
929 .P
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
930 The
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
931 .I mmailid
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
932 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
933 available in the original MH.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
934 It provided a
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
935 .I username
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
936 to
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
937 .I fakeusername
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
938 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
939 The man page
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
940 .Mp mh-tailor (5)
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
941 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
942 .QS
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
943 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
944 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
945 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
946 `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
947 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
948 ``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
949 .QE
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
950 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
951 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
952 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
953 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
954 does the reverse mapping for incoming mail (aliasing), too.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
955 Furthermore, 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
956 mail software on the system.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
957 Hence, mmailid masquerading was removed.
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
958 .Ci 0836c8000ccb34b59410ef1c15b1b7feac70ce5f
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
959 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
960 The
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
961 .I username_extension
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
962 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
963 specified by the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
964 .Ev USERNAME_EXTENSION
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
965 environment variable, to it.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
966 This provided support for the
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
967 .I user-extension
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
968 feature of qmail and the similar
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
969 .I "plussed user
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
970 processing of sendmail.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
971 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
972 motivated by the fact that
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
973 .Pn spost
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
974 had not supported it already.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
975 .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
976 Username extensions are possible in mmh, but less convenient to use.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
977 .\" XXX covered by next paragraph
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
978 .\" 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
979 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
980 The
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
981 .I draft_from
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
982 masquerading type instructed
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
983 .Pn post
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
984 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
985 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
986 header field as SMTP envelope sender.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
987 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
988 .Ci b14ea6073f77b4359aaf3fddd0e105989db9
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
989 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
990 with technical differences.
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
991 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
992 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
993 by the MTA.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
994 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
995 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
996 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
997 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
998 header field and thereby propose
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
999 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
1000 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
1001 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
1002 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1003 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
1004 message header (\c
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1005 .Pn sendmail 's
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1006 .Sw -t
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1007 switch).
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1008 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1009 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1010 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
1011 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
1012
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1013 .U3 "Remaining Options
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1014 .P
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1015 Two configure options remain in mmh.
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1016 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
1017 .Sw --with-locking=[dot|fcntl|flock|lockf] .
76
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
1018 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
1019 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
1020 requires deeper technical investigation into the topic.
2e61e0004a8f Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 74
diff changeset
1021 The other option,
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1022 .Sw --enable-debug ,
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1023 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
1024 This option is likely to stay.
72
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
1025
bae9273b5802 Wrote about configure options (not finished yet).
markus schnalke <meillo@marmaro.de>
parents: 69
diff changeset
1026
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1027
63
abbaca05ee8e More text.
markus schnalke <meillo@marmaro.de>
parents: 62
diff changeset
1028
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1029 .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
1030 .P
212
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1031 The command line switches of MH tools are similar to the X Window style.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
1032 .\" XXX ref
212
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1033 They consist of a single dash (`\fL-\fP') followed by a word.
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1034 To ease typing, the word can be abbreviated, given the remaining
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1035 prefix remains unambiguous.
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1036 If no other switch starts with the letter `t', then any of
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1037 .Cl "-truncate" ,
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1038 .Cl "-trunc" ,
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1039 .Cl "-tr" ,
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1040 and
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1041 .Cl "-t
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1042 is equal.
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1043 As a result, switches can neither be grouped (as in
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1044 .Cl "ls -ltr" )
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1045 nor can switch arguments be appended directly to the switch (as in
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1046 .Cl "sendmail -q30m" ).
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1047 Many switches have negating counter-parts, which start with `no'.
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1048 For example
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1049 .Cl "-notruncate
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1050 inverts the
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1051 .Cl "-truncate
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1052 switch.
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1053 They exist to override the effect of default switches in the profile.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1054 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
1055 .Sw -help ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1056 to print a short message on how to use the program, and
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1057 .Sw -Version
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1058 (with capital `V'), to tell what version of mmh the program belongs to.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1059 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1060 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
1061 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
1062 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
1063 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
1064 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
1065 of a program.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1066 Changing the behavior of programs provides flexibility and customization
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1067 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
1068 usage of the program.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1069 .\" XXX: Ref
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1070 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
1071 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
1072 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
1073 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
1074 problem of MH:
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1075 .[ [
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1076 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1077 .], p. 12]
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1078 .QS
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1079 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
1080 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
1081 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
1082 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
1083 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
1084 .QP
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1085 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
1086 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
1087 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
1088 .QE
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1089 .P
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1090 Being reluctant to adding new switches \(en or `options',
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1091 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
1092 the other part is removing hardly used switches.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1093 Nmh's tools had lots of switches already implemented,
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1094 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
1095 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
1096 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
1097 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
1098 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
1099 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
1100 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
1101 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
1102 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
1103 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
1104 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
1105 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
1106 ``[...]
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1107 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1108 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
1109 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
1110 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
1111 but this is not practical.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1112 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
1113 them strictly.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1114 Nevertheless, removing obsolete switches still is an effective approach
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1115 to deal with the problem.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1116 Working on an experimental branch without an established user base,
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1117 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
1118 functions.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1119 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1120 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
1121 .Pn send .
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1122 In nmh, they increased up to 32 visible and 12 hidden ones.
182
764738b17b74 Updated the numbers of cmdline switches to recent mmh changes.
markus schnalke <meillo@marmaro.de>
parents: 181
diff changeset
1123 At the time of writing, no more than 4 visible switches and 1 hidden switch
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1124 have remained in mmh's
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1125 .Pn send .
183
4c5055a0e981 Explained `hidden switches'.
markus schnalke <meillo@marmaro.de>
parents: 182
diff changeset
1126 These numbers include two generic switches,
182
764738b17b74 Updated the numbers of cmdline switches to recent mmh changes.
markus schnalke <meillo@marmaro.de>
parents: 181
diff changeset
1127 .Sw -help
764738b17b74 Updated the numbers of cmdline switches to recent mmh changes.
markus schnalke <meillo@marmaro.de>
parents: 181
diff changeset
1128 and
183
4c5055a0e981 Explained `hidden switches'.
markus schnalke <meillo@marmaro.de>
parents: 182
diff changeset
1129 .Sw -Version .
4c5055a0e981 Explained `hidden switches'.
markus schnalke <meillo@marmaro.de>
parents: 182
diff changeset
1130 Hidden switches are ones not documented.
4c5055a0e981 Explained `hidden switches'.
markus schnalke <meillo@marmaro.de>
parents: 182
diff changeset
1131 In mmh, 12 tools have hidden switches.
4c5055a0e981 Explained `hidden switches'.
markus schnalke <meillo@marmaro.de>
parents: 182
diff changeset
1132 9 of them are
4c5055a0e981 Explained `hidden switches'.
markus schnalke <meillo@marmaro.de>
parents: 182
diff changeset
1133 .Sw -debug
4c5055a0e981 Explained `hidden switches'.
markus schnalke <meillo@marmaro.de>
parents: 182
diff changeset
1134 switches, the other 6 provide special interfaces for internal use.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1135 .P
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1136 The figure displays the number of switches for each of the tools
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1137 that is available in both nmh and mmh.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1138 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
1139 Visible and hidden switches were counted,
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1140 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
1141 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
1142 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
1143 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
1144 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
1145 has 4 now.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1146 The total number of functional switches in mmh dropped from 465
182
764738b17b74 Updated the numbers of cmdline switches to recent mmh changes.
markus schnalke <meillo@marmaro.de>
parents: 181
diff changeset
1147 to 233.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1148
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1149 .KS
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1150 .in 1c
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1151 .so input/switches.grap
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1152 .KE
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1153
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1154 .P
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1155 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
1156 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
1157 Sometimes, however, the work flow was the other way:
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1158 I looked through the
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1159 .Mp mh-chart (7)
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1160 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
1161 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
1162 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
1163 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
1164 the number of switches per command.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1165
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1166
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1167 .U3 "Draft Folder Facility
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1168 .P
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1169 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
1170 the single draft message to the draft folder facility.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1171 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1172 .\" XXX ref to section ...
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1173 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
1174 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
1175 .[
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1176 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1177 .]
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1178 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
1179 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
1180 possible to remove the
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1181 .Sw -[no]draftfolder ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1182 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1183 .Sw -draftmessage
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1184 switches from
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1185 .Pn comp ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1186 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1187 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1188 .Pn dist ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1189 .Pn whatnow ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1190 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1191 .Pn send .
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1192 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1193 The only flexibility removed with this change is having multiple
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1194 draft folders within one profile.
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1195 I consider this a theoretical problem only.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1196 At the same time, the
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1197 .Sw -draft
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1198 switch of
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1199 .Pn anno ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1200 .Pn refile ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1201 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1202 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1203 was removed.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1204 The special treatment of \fIthe\fP draft message became irrelevant after
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1205 the rework of the draft system.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1206 (cf. Sec.
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1207 .Cf draft-folder )
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1208 Furthermore,
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1209 .Pn comp
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1210 no longer needs a
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1211 .Sw -file
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1212 switch as the draft folder facility together with the
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1213 .Sw -form
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1214 switch are sufficient.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1215
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1216
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1217 .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
1218 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1219 .Pn anno
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1220 had the switches
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1221 .Sw -[no]inplace
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1222 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
1223 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
1224 Following the assumption that linked messages should truly be the
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1225 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
1226 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1227 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
1228 .Sw -inplace
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1229 was made the only behavior.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1230 .Ci c8195849d2e366c569271abb0f5f60f4ebf0b4d0
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1231 The
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1232 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1233 switches of
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1234 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1235 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1236 and
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1237 .Pn dist
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1238 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
1239 .Pn anno .
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1240 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1241 .Pn burst
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1242 also had
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1243 .Sw -[no]inplace
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1244 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
1245 With
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1246 .Sw -inplace ,
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1247 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
1248 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
1249 after this message, renumbering all following messages.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1250 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
1251 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
1252 Nontheless, this behavior appeared less elegant than the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1253 .Sw -noinplace
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1254 behavior, which already had been the default.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1255 Nmh's
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1256 .Mp burst (1)
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1257 man page reads:
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1258 .QS
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1259 If
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1260 .Sw -noinplace
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1261 is given, each digest is preserved, no table
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1262 of contents is produced, and the messages contained within
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1263 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
1264 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
1265 .QE
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1266 .LP
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1267 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
1268 .Sw -inplace
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1269 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
1270 it caused.
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1271 .Sw -noinplace
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1272 was chosen to be the definitive behavior.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1273 .Ci 68a686adeb39223a5e1ad35e4a24890ec053679d
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1274
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1275
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1276 .U3 "Forms and Format Strings
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 Historically, the tools that had
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1279 .Sw -form
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1280 switches to supply a form file had
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1281 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1282 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
1283 on the command line directly.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1284 In consequence, the following two lines equaled:
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1285 .VS
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1286 scan -form scan.mailx
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1287 scan -format "`cat .../scan.mailx`"
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1288 VE
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1289 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1290 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1291 switches were dropped in favor for extending the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1292 .Sw -form
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1293 switches.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1294 .Ci f51956be123db66b00138f80464d06f030dbb88d
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1295 If their argument starts with an equal sign (`='),
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1296 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
1297 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
1298 Thus, now the following two lines equal:
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1299 .VS
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1300 scan -form scan.mailx
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1301 scan -form "=`cat .../scan.mailx`"
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1302 VE
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1303 This rework removed the prefix collision between
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1304 .Sw -form
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1305 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1306 .Sw -format .
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1307 Now, typing
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1308 .Sw -fo
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1309 suffices to specify form or format string.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1310 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1311 The different meaning of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1312 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1313 for
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1314 .Pn repl
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 forw
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1317 was removed in mmh.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1318 .Pn forw
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1319 was completely switched to MIME-type forwarding, thus removing the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1320 .Sw -[no]format .
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1321 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1322 For
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1323 .Pn repl ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1324 the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1325 .Sw -[no]format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1326 switches were reworked to
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1327 .Sw -[no]filter
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1328 switches.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1329 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1330 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1331 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1332 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1333 .Pn send
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1334 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1335 .Pn post ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1336 which had a third meaning,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1337 were removed likewise.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1338 .Ci f3cb7cde0e6f10451b6848678d95860d512224b9
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1339 Eventually, the ambiguity of the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1340 .Sw -format
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1341 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
1342
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1343
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1344 .U3 "MIME Tools
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1345 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1346 The MIME tools, which were once part of
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1347 .Pn mhn
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1348 .\" XXX
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1349 (whatever that stood for),
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1350 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
1351 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1352 .Sw -[no]realsize
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1353 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1354 .Pn mhbuild
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1355 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1356 .Pn mhlist
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1357 were removed, doing real size calculations always now
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1358 .Ci 8d8f1c3abc586c005c904e52c4adbfe694d2201c ,
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1359 as nmh's
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1360 .Mp mhbuild (1)
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1361 man page states
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1362 ``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
1363 This small delay is not noticable on modern systems.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1364 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1365 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1366 .Sw -[no]check
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1367 switches were removed together with the support for
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1368 .Hd Content-MD5
199
5cd9bacdfcd3 Updated RFCs.
markus schnalke <meillo@marmaro.de>
parents: 197
diff changeset
1369 header fields [RFC\|1864].
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1370 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1371 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1372 .Cf content-md5 )
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1373 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1374 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1375 .Sw -[no]ebcdicsafe
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1376 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1377 .Sw -[no]rfc934mode
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1378 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1379 .Pn mhbuild
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1380 were removed because they are considered obsolete.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1381 .Ci 01a3480928da485b4d6109d36d751dfa71799d58
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1382 .Ci 3363e2624dce0eb8164cf8b3f1ab385c8ff72e88
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1383 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1384 Content caching of external MIME parts, activated with the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1385 .Sw -rcache
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1386 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1387 .Sw -wcache
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1388 switches was completely removed.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1389 .Ci d1fefd9f614e4dc3cda16da6c69133c1b2005269
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1390 External MIME parts are rare today, having a caching facility
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1391 for them appears to be unnecessary.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1392 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1393 In pre-MIME times,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1394 .Pn mhl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1395 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
1396 Therefore,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1397 .Pn mhl
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1398 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
1399 switches from 21 to 6.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1400 .Ci 350ad6d3542a07639213cf2a4fe524e829c1e7b6
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1401 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1402
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1403
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1404
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1405
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1406 .U3 "Header Printing
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 folder 's
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1409 data output is self-explaining enough that
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1410 displaying the header line makes little sense.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1411 Hence, the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1412 .Sw -[no]header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1413 switch was removed and headers are never printed.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1414 .Ci 601cc73d1fa05ce96faa728f036d6c51b91701c7
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1415 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1416 In
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1417 .Pn mhlist ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1418 the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1419 .Sw -[no]header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1420 switches were removed, too.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1421 .Ci b24f96523aaf60e44e04a3ffb1d22e69a13a602f
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1422 But in this case headers are always printed,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1423 because the output is not self-explaining.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1424 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1425 .Pn scan
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1426 also had
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1427 .Sw -[no]header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1428 switches.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1429 Printing the header had been sensible until the introduction of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1430 format strings made it impossible to display the column headings.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1431 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
1432 As this information can be perfectly retrieved by
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1433 .Pn folder
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1434 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1435 .Pn date ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1436 consequently, the switches were removed.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1437 .Ci c477dc5d1d03fa6d9a8ab3dd3508c63cbddc044e
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1438 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1439 By removing all
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1440 .Sw -header
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1441 switches, the collision with
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1442 .Sw -help
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1443 on the first two letters was resolved.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1444 Currently,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1445 .Sw -h
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1446 evaluates to
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1447 .Sw -help
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1448 for all tools of mmh.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1449
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1450
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1451 .U3 "Suppressing Edits or the Invocation of the WhatNow Shell
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1452 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1453 The
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1454 .Sw -noedit
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1455 switch of
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1456 .Pn comp ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1457 .Pn repl ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1458 .Pn forw ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1459 .Pn dist ,
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1460 and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1461 .Pn whatnow
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1462 was removed, but it can now be replaced by specifying
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1463 .Sw -editor
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1464 with an empty argument.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1465 .Ci 75fca31a5b9d5c1a99c74ab14c94438d8852fba9
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1466 (Specifying
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1467 .Cl "-editor /bin/true
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1468 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
1469 .P
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1470 The more important change is the removal of the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1471 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1472 switch.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1473 .Ci ee4f43cf2ef0084ec698e4e87159a94c01940622
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1474 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
1475 man page for
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1476 .Mp comp (1):
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1477 .QS
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1478 The
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1479 .Sw -editor
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1480 .Ar editor
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1481 switch indicates the editor to use for
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1482 the initial edit. Upon exiting from the editor,
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1483 .Pn comp
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1484 will invoke the
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1485 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1486 program. See
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1487 .Mp whatnow (1)
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1488 for a discussion of available options.
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1489 The invocation of this program can be
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1490 inhibited by using the
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1491 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1492 switch. (In truth of fact, it is the
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1493 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1494 program which starts the initial edit.
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1495 Hence,
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1496 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1497 will prevent any edit from occurring.)
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1498 .QE
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1499 .P
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1500 Effectively, the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1501 .Sw -nowhatnowproc
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1502 switch creates only a draft message.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1503 As
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1504 .Cl "-whatnowproc /bin/true
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1505 causes the same behavior, the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1506 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1507 switch was removed for being redundant.
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1508 Likely, the
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1509 .Sw -nowhatnowproc
100
6ae7dc4a3a02 Included changes proposed by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 98
diff changeset
1510 switch was intended to be used by front-ends.
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1511
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1512
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1513
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1514 .U3 "Various
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1515 .BU
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1516 With the removal of MMDF maildrop format support,
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1517 .Pn packf
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1518 and
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1519 .Pn rcvpack
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1520 no longer needed their
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1521 .Sw -mbox
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1522 and
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1523 .Sw -mmdf
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1524 switches.
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1525 .Sw -mbox
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1526 is the sole behavior now.
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1527 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
1528 Further rework in both tools made the
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1529 .Sw -file
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
1530 switch unnecessary.
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1531 .Ci ca1023716d4c2ab890696f3e41fa0d94267a940e
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1532
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1533 .BU
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1534 Mmh's tools will no longer clear the screen (\c
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1535 .Pn scan 's
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1536 and
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1537 .Pn mhl 's
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1538 .Sw -[no]clear
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1539 switches
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1540 .Ci e57b17343dcb3ff373ef4dd089fbe778f0c7c270
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1541 .Ci 943765e7ac5693ae177fd8d2b5a2440e53ce816e ).
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1542 Neither will
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1543 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1544 ring the bell (\c
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1545 .Sw -[no]bell
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1546 .Ci e11983f44e59d8de236affa5b0d0d3067c192e24 )
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1547 nor page the output itself (\c
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1548 .Sw -length
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1549 .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ).
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1550 .\" XXX Ref
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1551 Generally, the pager to use is no longer specified with the
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1552 .Sw -[no]moreproc
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1553 command line switches for
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1554 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1555 and
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1556 .Pn show /\c
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1557 .Pn mhshow .
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1558 .Ci 39e87a75b5c2d3572ec72e717720b44af291e88a
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1559
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1560 .BU
96
12348d620245 Spell checking.
markus schnalke <meillo@marmaro.de>
parents: 95
diff changeset
1561 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
1562 .Sw -version
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1563 switch was renamed to
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1564 .Sw -Version
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1565 (with capital `V').
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1566 .Ci 32b2354dbaf4bf934936eb5b102a4a3d2fdd209a
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1567 Every program has the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1568 .Sw -version
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1569 switch but its first three letters collided with the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1570 .Sw -verbose
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1571 switch, present in many programs.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1572 The rename solved this problem once for all.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1573 Although this rename breaks a basic interface, having the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1574 .Sw -V
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1575 abbreviation to display the version information, isn't all too bad.
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1576
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1577 .BU
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1578 .Sw -[no]preserve
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1579 of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1580 .Pn refile
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
1581 was removed
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
1582 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
1583 because what use was it anyway?
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
1584 Quoting nmh's man page
165
ea6eec1722d1 Improvement by Boris Kraut.
markus schnalke <meillo@marmaro.de>
parents: 164
diff changeset
1585 .Mp refile (1):
98
d894191d7a33 style: Changed the block quote approach. New QS and QE.
markus schnalke <meillo@marmaro.de>
parents: 97
diff changeset
1586 .QS
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1587 Normally when a message is refiled, for each destination
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1588 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
1589 highest message number in that folder. Use of the
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1590 .Sw -preserv
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1591 [sic!] switch will override this message renaming, and try
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1592 to preserve the number of the message. If a conflict for a
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1593 particular folder occurs when using the
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1594 .Sw -preserve
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1595 switch, then
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1596 .Pn refile
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1597 will use the next available message number which
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1598 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
1599 .QE
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1600
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1601 .BU
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1602 The removal of the
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1603 .Sw -[no]reverse
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1604 switches of
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1605 .Pn scan
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1606 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1607 is a bug fix, supported by the comments
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1608 ``\-[no]reverse under #ifdef BERK (I really HATE this)''
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1609 by Rose and
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1610 ``Lists messages in reverse order with the `\-reverse' switch.
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1611 This should be considered a bug.'' by Romine in the documentation.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1612 .\" XXX Ref: welche datei genau.
97
29a7454fcded Added references to commits.
markus schnalke <meillo@marmaro.de>
parents: 96
diff changeset
1613 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
1614 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
1615 thereafter.
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1616
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1617
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1618 .ig
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1619
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1620 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
1621
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1622 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
1623
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1624 mhmail: resent queued
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1625 inc: snoop, (pop)
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1626
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1627 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
1628 [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
1629
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1630 prompter: [no]doteof
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1631
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1632 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
1633
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1634 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
1635 [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
1636 attach attachformat
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1637 whatnow: (noedit) attach
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1638
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1639 slocal: [no]suppressdups
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1640
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1641 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
1642 [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
1643
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1644 whom: ???
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1645
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1646 ..
93
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1647
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1648
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1649 .ig
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1650
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1651 .P
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1652 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
1653 or on the three-letter prefix for the `no' variants.
96
12348d620245 Spell checking.
markus schnalke <meillo@marmaro.de>
parents: 95
diff changeset
1654 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
1655 the user must type.
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1656 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
1657
093ccf39a45e Write text about removal of switches; Included the grap figure.
markus schnalke <meillo@marmaro.de>
parents: 89
diff changeset
1658 ..
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1659
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1660
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1661 .\" XXX: whatnow prompt commands
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1662
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1663
95
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1664
edac7e46a9f2 More text about switches.
markus schnalke <meillo@marmaro.de>
parents: 93
diff changeset
1665
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
1666 .\" --------------------------------------------------------------
74
cefaa856d431 A lot of new text about configure switches.
markus schnalke <meillo@marmaro.de>
parents: 72
diff changeset
1667 .H1 "Modernizing
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1668 .P
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1669 In the more than thirty years of MH's existence, its code base was
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1670 increasingly extended.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1671 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
1672 existing behavior.
212
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1673 Relics from several decades have gathered in the code base,
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
1674 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
1675 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
1676 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
1677 It focuses on the functional aspect only;
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1678 the non-functional aspects of code style are discussed in Sec.
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1679 .Cf code-style .
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1680
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1681
212
9317d789cef9 Various improvements and rework.
markus schnalke <meillo@marmaro.de>
parents: 200
diff changeset
1682 .H2 "Code Relics
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1683 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1684 My position regarding the removal of obsolete functions of mmh,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1685 .\" XXX ``in order to remove old code,''
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1686 is much more revolutional than the nmh community appreciates.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1687 Working on an experimental version, I was quickly able to drop
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1688 functionality I considered ancient.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1689 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
1690 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
1691 In December 2011, Paul Vixie motivated the nmh developers to just
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1692 .\" XXX ugs
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1693 do the work:
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1694 .[
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1695 paul vixie edginess nmh-workers
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1696 .]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1697 .QS
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1698 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
1699 discuss whether to keep using vfork, just note in [sic!] passing, [...]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1700 we don't need a separate branch for removing vmh
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1701 or ridding ourselves of #ifdef's or removing posix replacement functions
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1702 or depending on pure ansi/posix ``libc''.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1703 .QP
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
1704 these things should each be a day or two of work and the ``main branch''
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1705 should just be modern. [...]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1706 let's push forward, aggressively.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1707 .QE
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1708 .LP
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1709 I did so already in the months before.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1710 I pushed forward.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1711 .\" XXX semicolon ?
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1712 I simply dropped the cruft.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1713 .P
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1714 The decision to drop a feature was based on literature research and
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1715 careful thinking, but whether having had contact with this particular
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1716 feature within my own computer life served as a rule of thumb.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1717 I explained my reasons in the commit messages
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1718 in the version control system.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1719 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
1720 if I have missed an important aspect.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1721 I was quick in dropping parts.
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
1722 I rather include falsely dropped parts again, than going at a slower pace.
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
1723 Mmh is experimental work; it requires tough decisions.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1724 .\" XXX ``exp. work'' schon oft gesagt
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1725
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1726
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1727 .U3 "Forking
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
1728 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1729 Being a tool chest, MH creates many processes.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1730 In earlier times
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1731 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1732 had been an expensive system call, because the process's image needed
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1733 to be completely duplicated at once.
200
c299ed65d015 Spell checked.
markus schnalke <meillo@marmaro.de>
parents: 199
diff changeset
1734 This expensive work was especially unnecessary in the commonly occurring
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1735 case wherein the image is replaced by a call to
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1736 .Fu exec()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1737 right after having forked the child process.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1738 The
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1739 .Fu vfork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1740 system call was invented to speed up this particular case.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1741 It completely omits the duplication of the image.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1742 On old systems this resulted in significant speed ups.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1743 Therefore MH used
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1744 .Fu vfork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1745 whenever possible.
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1746 .P
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1747 Modern memory management units support copy-on-write semantics, which make
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 almost as fast as
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1750 .Fu vfork() .
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1751 The man page of
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1752 .Mp vfork (2)
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1753 in FreeBSD 8.0 states:
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1754 .QS
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1755 This system call will be eliminated when proper system sharing mechanisms
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1756 are implemented. Users should not depend on the memory sharing semantics
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1757 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
1758 .QE
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1759 .LP
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1760 Vixie supports the removal with the note that ``the last
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1761 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
1762 Eunice. that was 1987''.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1763 .[
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1764 nmh-workers vixie edginess
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1765 .]
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1766 I replaced all calls to
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1767 .Fu vfork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1768 with calls to
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1769 .Fu fork() .
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1770 .Ci 40821f5c1316e9205a08375e7075909cc9968e7d
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1771 .P
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1772 Related to the costs of
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1773 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1774 is the probability of its success.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1775 In the eighties, on heavy loaded systems, calls to
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1776 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1777 were prone to failure.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1778 Hence, many of the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1779 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1780 calls in the code were wrapped into loops to retry the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1781 .Fu fork()
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1782 several times, to increase the chances to succeed, eventually.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1783 On modern systems, a failing
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1784 .Fu fork()
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1785 call is unusual.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1786 Hence, in the rare case when
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1787 .Fu fork()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1788 fails, mmh programs simply abort.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1789 .Ci 5fbf37ee68e018998ada61eeab73e035b26834b6
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1790
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1791
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1792 .U3 "Header Fields
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1793 .BU
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1794 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1795 .Hd Encrypted
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1796 header field was introduced by RFC\|822,
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1797 but already marked as legacy in RFC\|2822.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1798 Today, OpenPGP provides the basis for standardized exchange of encrypted
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1799 messages [RFC\|4880, RFC\|3156].
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1800 Hence, the support for
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1801 .Hd Encrypted
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1802 header fields is removed in mmh.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1803 .Ci 064527f7b57ab050e5af13e15ad99aeeab125857
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1804 .BU
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1805 The native support for
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1806 .Hd Face
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1807 header fields has been removed, as well.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1808 .Ci 8e5be81f784682822f5e868c1bf3c8624682bd23
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1809 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
1810 .Hd X-Face
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1811 header field in its intent,
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1812 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
1813 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
1814 it contains the hostname and UDP port where the image
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1815 date can be retrieved.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1816 There is even a third Face system,
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1817 which is the successor of
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1818 .Hd X-Face ,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1819 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
1820 .Hd Face
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1821 header field.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1822 It was invented in 2005 and supports colored PNG images.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1823 None of the Face systems described here is popular today.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1824 Hence, mmh has no direct support for them.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1825 .BU
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
1826 .Id content-md5
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1827 The
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1828 .Hd Content-MD5
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1829 header field was introduced by RFC\|1864.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1830 It provides detection of data corruption during the transfer.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1831 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
1832 [RFC\|1864].
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1833 The proper approach to verify content integrity in an
166
f102dcc06bb9 s/digital cryptography/signing and encryption/
markus schnalke <meillo@marmaro.de>
parents: 165
diff changeset
1834 end-to-end relationship is the use of digital signatures.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1835 .\" XXX (RFCs FIXME).
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1836 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
1837 the transmission.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1838 The TCP includes a checksum field therefore.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1839 These two approaches in combinations render the
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1840 .Hd Content-MD5
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1841 header field superfluous.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1842 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
1843 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
1844 .Hd Content-MD5
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1845 header field.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1846 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
1847 Removing the support for this header field,
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1848 removed the last place where MD5 computation was needed.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1849 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1850 Hence, the MD5 code could be removed as well.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1851 Over 500 lines of code vanished by this one change.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1852
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1853
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1854 .U3 "MMDF maildrop support
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1855 .P
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1856 This type of format is conceptionally similar to the mbox format,
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1857 but uses a different message delimiter (`\fL\\1\\1\\1\\1\fP',
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
1858 commonly written as `\fL^A^A^A^A\fP', instead of `\fLFrom\0\fP').
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1859 Mbox is the de-facto standard maildrop format on Unix,
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1860 whereas the MMDF maildrop format is now forgotten.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1861 By dropping the MMDF maildrop format support,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1862 mbox became the only packed mailbox format supported in mmh.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1863 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1864 The simplifications within the code were moderate.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1865 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
1866 But also, switches of
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1867 .Pn packf
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1868 and
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1869 .Pn rcvpack
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1870 could be removed.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1871 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1872 In the message parsing function
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1873 .Fn sbr/m_getfld.c ,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1874 knowledge of MMDF packed mail boxes was removed.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1875 .Ci 684ec30d81e1223a282764452f4902ed4ad1c754
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1876 Further code structure simplifications may be possible there,
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1877 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
1878 I have not worked on them yet because
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1879 .Fu m_getfld()
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1880 is heavily optimized and thus dangerous to touch.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1881 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
1882 too high.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1883
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1884
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1885 .U3 "Prompter's Control Keys
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1886 .P
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1887 The program
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1888 .Pn prompter
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1889 queries the user to fill in a message form.
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1890 When used by
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1891 .Pn comp
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1892 as
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1893 .Cl "comp -editor prompter" ,
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1894 the resulting behavior is similar to
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1895 .Pn mailx .
51
49cf68506b5d Spell checking.
markus schnalke <meillo@marmaro.de>
parents: 49
diff changeset
1896 Apparently,
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1897 .Pn prompter
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
1898 had not been touched lately.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1899 Otherwise it's hardly explainable why it
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1900 still offered the switches
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1901 .Sw -erase
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1902 .Ar chr
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1903 and
84
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1904 .Sw -kill
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field)
markus schnalke <meillo@marmaro.de>
parents: 82
diff changeset
1905 .Ar chr
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1906 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
1907 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
1908 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
1909 with the standard tool
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1910 .Pn stty .
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1911 The switches are removed now
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1912 .Ci 0bd9750710cdbab80cfb4036dd87af20afe1552f .
20
7a100c80fa91 Some new text (show/mhshow; prompter).
markus schnalke <meillo@marmaro.de>
parents: 19
diff changeset
1913
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1914
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1915 .U3 "Hardcopy Terminal Support
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1916 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1917 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
1918 hardcopy terminal.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1919 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
1920 .Ci b7764c4a6b71d37918a97594d866258f154017ca .
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1921 .P
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1922 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
1923 program (\c
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1924 .Pn mhl )
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1925 and the terminal.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1926 In nmh, this could have been ensured statically with the
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1927 .Sw -nomoreproc
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1928 at the command line, too.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
1929 In mmh, setting the profile entry
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1930 .Pe Pager
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1931 or the environment variable
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1932 .Ev PAGER
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1933 to
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1934 .Pn cat
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1935 is sufficient.
104
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1936
2818ca27d24c Various text rework.
markus schnalke <meillo@marmaro.de>
parents: 102
diff changeset
1937
21
bb8a8be49024 Wrote about Face support and vfork().
markus schnalke <meillo@marmaro.de>
parents: 20
diff changeset
1938
12
7ca384d68edc Wrote some text for removal of old code.
markus schnalke <meillo@marmaro.de>
parents: 0
diff changeset
1939
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
1940 .H2 "Attachments
22
99409e4546d2 Wrote about the removal of tools.
markus schnalke <meillo@marmaro.de>
parents: 21
diff changeset
1941 .P
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1942 The mind model of email attachments is unrelated to MIME.
199
5cd9bacdfcd3 Updated RFCs.
markus schnalke <meillo@marmaro.de>
parents: 197
diff changeset
1943 Although the MIME RFCs [RFC\|2045\(enRFC\|2049] define the technical
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1944 requirements for having attachments, they do not mention the word
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
1945 attachment.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1946 Instead of attachments, MIME talks about ``multi-part message bodies''
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1947 [RFC\|2045], a more general concept.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1948 Multi-part messages are messages
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1949 ``in which one or more different
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1950 sets of data are combined in a single body''
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1951 [RFC\|2046].
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1952 MIME keeps its descriptions generic;
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1953 it does not imply specific usage models.
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1954 One usage model became prevalent: attachments.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1955 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
1956 attached to it.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1957 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
1958 and parts of arbitrary type following.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1959 .P
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1960 MH's MIME support is a direct implementation of the RFCs.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1961 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
1962 in MH's implementation.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1963 .\" XXX rewrite ``no idea''.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1964 As a result,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1965 MH had all the MIME features but no idea of attachments.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
1966 But users do not need all the MIME features,
109
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1967 they want convenient attachment handling.
2b094b8fb422 Rework of existing text.
markus schnalke <meillo@marmaro.de>
parents: 108
diff changeset
1968
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1969
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1970 .U3 "Composing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1971 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1972 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
1973 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
1974 .Ci 7480dbc14bc90f2d872d434205c0784704213252
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1975 In the file
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1976 .Fn docs/README-ATTACHMENTS ,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1977 he described his motivation to do so as such:
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1978 .QS
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1979 Although nmh contains the necessary functionality for MIME message
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
1980 handing [sic!], the interface to this functionality is pretty obtuse.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1981 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
1982 .Pn mhbuild
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1983 composition files!
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1984 .QE
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1985 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1986 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
1987 In the same document:
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1988 .QS
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1989 These changes simplify the task of managing attachments on draft files.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1990 They allow attachments to be added, listed, and deleted.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1991 MIME messages are automatically created when drafts with attachments
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1992 are sent.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1993 .QE
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1994 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1995 Unfortunately, the attachment system,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
1996 like any new facilities in nmh,
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
1997 was inactive by default.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1998 .P
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
1999 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
2000 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
2001 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
2002 .[
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2003 nmh-workers attachment proposal
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2004 .]
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
2005 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
2006 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2007 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
2008 Instead of command line switches, the
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2009 .Pe Attachment-Header
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2010 profile entry is used to specify
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2011 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
2012 It is pre-defined to
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2013 .Hd Attach .
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2014 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2015 To add an attachment to a draft, a header line needs to be added:
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2016 .VS
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2017 To: bob
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2018 Subject: The file you wanted
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2019 Attach: /path/to/the/file-bob-wanted
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2020 --------
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2021 Here it is.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2022 VE
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2023 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
2024 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
2025 non-interactively with
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2026 .Pn anno :
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2027 .VS
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2028 anno -append -nodate -component Attach -text /path/to/attachment
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2029 VE
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2030 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
2031 .Pn send .
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2032 The conversion to MIME is invisible to the user.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2033 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
2034 attachment headers.
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
2035 If the MIMEification fails (e.g. because the file to attach
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
2036 is not accessible) the original draft is not changed.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2037 .P
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2038 The attachment system handles the forwarding of messages, too.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
2039 If the attachment header value starts with a plus character (`\fL+\fP'),
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2040 like in
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2041 .Cl "Attach: +bob 30 42" ,
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2042 the given messages in the specified folder will be attached.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2043 This allowed to simplify
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2044 .Pn forw .
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2045 .Ci f41f04cf4ceca7355232cf7413e59afafccc9550
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2046 .P
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2047 Closely related to attachments is non-ASCII text content,
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2048 because it requires MIME too.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2049 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
2050 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
2051 This was necessary whenever the draft contained non-ASCII characters.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2052 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
2053 Therefore, the
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2054 .Pe automimeproc
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2055 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
2056 automatically each time.
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
2057 Unfortunately, this approach conflicted with the attachment system
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2058 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
2059 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
2060 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
2061 WhatNow prompt and
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2062 .Pe automimeproc
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2063 must not be set in the profile.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2064 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
2065 not caught.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2066 All in all, the solution was complex and irritating.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2067 My patch from December 2010
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2068 .[
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2069 nmh-workers attachment proposal
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2070 .]
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2071 would have simplified the situation.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2072 .P
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2073 Mmh's current solution is even more elaborate.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2074 Any necessary MIMEification is done automatically.
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2075 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
2076 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
2077 attachment header or non-ASCII text is present.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
2078 Furthermore, the hash character (`\fL#\fP') is not special any more
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2079 at line beginnings in the draft message.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2080 .\" XXX REF ?
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2081 Users need not concern themselves with the whole topic at all.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2082 .P
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2083 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
2084 compositions directly, the full power of
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2085 .Pn mhbuild
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2086 can still be accessed.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2087 Given no attachment headers are included, the user can create
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2088 .Pn mhbuild
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2089 composition drafts like in nmh.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2090 Then, at the WhatNow prompt, he needs to invoke
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2091 .Cl "edit mhbuild
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2092 to convert it to MIME.
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
2093 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
2094 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
2095 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2096 The approach taken in mmh is tailored towards today's most common case:
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2097 a text part, possibly with attachments.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2098 This case was simplified.
101
e8e6adb14beb Wrote about attachments.
markus schnalke <meillo@marmaro.de>
parents: 100
diff changeset
2099
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2100
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2101 .U3 "MIME Type Guessing
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2102 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2103 From the programmer's point of view, the use of
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2104 .Pn mhbuild
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2105 composition drafts had one notable advantage over attachment headers:
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2106 The user provides the appropriate MIME types for files to include.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2107 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
2108 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
2109 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
2110 partly intelligent work.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2111 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
2112 forces him to do partly mechanical work.
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
2113 Letting the computer do the work can lead to bad choices for difficult
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2114 content.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2115 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
2116 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2117 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
2118 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
2119 for the common cases.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2120 Mmh implements this approach in the
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2121 .Pn print-mimetype
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2122 script.
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2123 .Ci 4b5944268ea0da7bb30598a27857304758ea9b44
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2124 Using it is the default choice.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2125 .P
112
4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs.
markus schnalke <meillo@marmaro.de>
parents: 110
diff changeset
2126 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
2127 .Pn file .
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2128 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
2129 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
2130 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
2131 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
2132 It varies much.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2133 Nevertheless, modern versions of GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2134 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2135 which is prevalent on the popular GNU/Linux systems,
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2136 provide MIME type output in machine-readable form.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2137 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
2138 it solves the difficult problem well.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2139 On systems where GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2140 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2141 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
2142 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
2143 .Ci 3baec236a39c5c89a9bda8dbd988d643a21decc6
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2144 .VS
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2145 Mime-Type-Query: file -b --mime
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2146 VE
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2147 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2148 Other versions of
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2149 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2150 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
2151 The diversity among
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2152 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2153 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
2154 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2155 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
2156 `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
2157 `application/octet-stream'.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2158 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
2159 for a specific file.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2160 To do so, either the user would need to know in advance for which file
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2161 the automatic guessing fails, or the system would require interaction.
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2162 I consider both cases impractical.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2163 The existing solution should be sufficient.
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2164 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
2165 .Pn mhbuild
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2166 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
2167
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2168
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2169 .U3 "Storing Attachments
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2170 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
2171 Extracting MIME parts of a message and storing them to disk is performed by
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2172 .Pn mhstore .
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2173 The program has two operation modes,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2174 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2175 and
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2176 .Sw -noauto .
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2177 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
2178 MIME part's meta information, if available.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2179 This naming information is usually available for modern attachments.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2180 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
2181 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2182 would have been specified.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2183 In the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2184 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2185 mode, the parts are processed according to rules, defined by
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2186 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2187 profile entries.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2188 These rules define generic filename templates for storing
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2189 or commands to post-process the contents in arbitrary ways.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2190 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
2191 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
2192 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2193 The
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2194 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2195 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
2196 in contrast to the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2197 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2198 mode.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2199 In mmh,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2200 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2201 is not dangerous anymore.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2202 Two changes were necessary:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2203 .LI 1
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2204 Any directory path is removed from the proposed filename.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2205 Thus, the files are always stored in the expected directory.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2206 .Ci 41b6eadbcecf63c9a66aa5e582011987494abefb
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2207 .LI 2
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2208 Tar files are not extracted automatically any more.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2209 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
2210 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2211 .LP
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2212 Now, the outcome of mmh's
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2213 .Cl "mhstore -auto
110
4c0f13b1e0e8 Spellchecked.
markus schnalke <meillo@marmaro.de>
parents: 109
diff changeset
2214 can be foreseen from the output of
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2215 .Cl "mhlist -verbose" .
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2216 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2217 The
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2218 .Sw -noauto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2219 mode is seen to be more powerful but less convenient.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2220 On the other hand,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2221 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2222 is safe now and
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2223 storing attachments under their original name is intuitive.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2224 Hence,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2225 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2226 serves better as the default option.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2227 .Ci 3410b680416c49a7617491af38bc1929855a331d
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2228 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2229 Files are stored into the directory given by the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2230 .Pe Nmh-Storage
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2231 profile entry, if set, or
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2232 into the current working directory, otherwise.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2233 Storing to different directories is only possible with
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2234 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2235 profile entries.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2236 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2237 Still, in both modes, existing files get overwritten silently.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2238 This can be considered a bug.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2239 Yet, each other behavior has its draw-backs, too.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2240 Refusing to replace files requires adding a
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2241 .Sw -force
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2242 option.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2243 Users will likely need to invoke
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2244 .Pn mhstore
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2245 a second time with
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2246 .Sw -force .
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2247 Eventually, only the user can decide in the specific case.
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2248 This requires interaction, which I like to avoid if possible.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2249 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
2250 For now, the behavior remains as it is.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2251 .P
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2252 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
2253 .Pn mhstore 's
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2254 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2255 mode.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2256 Instead of storing message/rfc822 parts as files to disk,
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2257 they are stored as messages into the current mail folder.
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2258 The same applies to message/partial, although the parts are
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2259 automatically reassembled beforehand.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2260 MIME parts of type message/external-body are not automatically retrieved
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2261 anymore.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2262 Instead, information on how to retrieve them is output.
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2263 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
2264 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2265 .\" 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
2266 .\" and sbr/ruserpass.c for reading ~/.netrc are gone now.)
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2267 `application/octet-stream; type=tar' is not special anymore.
108
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2268 Automatically extracting such MIME parts had been the dangerous part
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2269 of the
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2270 .Sw -auto
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2271 mode.
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2272 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
dd5620bf8659 Wrote about storing attachments.
markus schnalke <meillo@marmaro.de>
parents: 107
diff changeset
2273
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2274
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2275
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2276 .U3 "Showing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2277 .P
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2278 The program
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2279 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2280 had been written to display MIME messages.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2281 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
2282 Nmh's
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2283 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2284 handled each MIME part independently, presenting them separately
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2285 to the user.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2286 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
2287 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
2288 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
2289 plus possibly attachments.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2290 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
2291 information on how to display the individual parts.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2292 I adjusted
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2293 .Pn mhshow 's
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2294 behavior to the modern view on the topic.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2295 .P
159
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi.
markus schnalke <meillo@marmaro.de>
parents: 157
diff changeset
2296 One should note that this section completely ignores the original
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2297 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2298 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
2299 and is no longer part of mmh.
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
2300 .\" XXX ref to other section
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2301 Although
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2302 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2303 was renamed to
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2304 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2305 in mmh, this section uses the name
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2306 .Pn mhshow ,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2307 in order to avoid confusion.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2308 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2309 In mmh, the basic idea is that
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2310 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2311 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
2312 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2313 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2314 invokes a pager session for all its output,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2315 whenever it prints to a terminal.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2316 .Ci a4197ea6ffc5c1550e8b52d5a654bcaaaee04a4e
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2317 In consequence,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2318 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2319 does no more invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2320 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2321 With
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2322 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2323 replacing the original
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2324 .Pn show ,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2325 output from
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2326 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2327 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
2328 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2329 Hence,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2330 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2331 does not need to invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2332 The one and only job of
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2333 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2334 is to format messages or parts of them.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2335 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
2336 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2337 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2338 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2339 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
2340 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
2341 to display them in the terminal.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
2342 In mmh, MIME parts will always be displayed serially.
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2343 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
2344 is ignored.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2345 It is simply treated as `multipart/mixed'.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2346 .Ci d0581ba306a7299113a346f9b4c46ce97bc4cef6
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2347 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
2348 .Sw -serialonly
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2349 switch of
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2350 .Pn mhshow .
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
2351 As MIME parts are always processed exclusively, i.e. serially,
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2352 the `%e' escape in
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2353 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2354 profile entries became useless and was thus removed.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2355 .Ci a20d405db09b7ccca74d3e8c57550883da49e1ae
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2356 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2357 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
2358 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
2359 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2360 profile entries before, if possible and wanted.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2361 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
2362 Other kinds of attachments are ignored.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2363 With
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2364 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2365 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
2366 the message.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2367 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
2368 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2369 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
2370 to the native charset.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2371 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2372 .Pe mhshow-charset-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2373 profile entries used to be needed.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
2374 In mmh, the conversion is performed automatically by piping the
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
2375 text through the
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2376 .Pn iconv
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2377 command, if necessary.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2378 .Ci 2433122c20baccb10b70b49c04c6b0497b5b3b60
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2379 Custom
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2380 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2381 rules for textual content might need a
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2382 .Cl "iconv -f %c %f |
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2383 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
2384 .P
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2385 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
2386 has improved, it is not consistent enough.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2387 Further work needs to be done and
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2388 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
2389 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
2390 correctly without the need to configure anything.
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2391
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2392
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2393 .ig
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2394
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2395 .P
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2396 mhshow/mhstore: Removed support for retrieving message/external-body parts.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
2397 These tools will not download the contents automatically anymore. Instead,
114
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2398 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
2399 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
2400 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
2401 it!
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2402 (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
2403 ~/.netrc are gone now.)
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2404 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2405
92cbd3fa1c40 Wrote text about displaying mime messages.
markus schnalke <meillo@marmaro.de>
parents: 112
diff changeset
2406 ..
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2407
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2408
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2409
166
f102dcc06bb9 s/digital cryptography/signing and encryption/
markus schnalke <meillo@marmaro.de>
parents: 165
diff changeset
2410 .H2 "Signing and Encrypting
22
99409e4546d2 Wrote about the removal of tools.
markus schnalke <meillo@marmaro.de>
parents: 21
diff changeset
2411 .P
166
f102dcc06bb9 s/digital cryptography/signing and encryption/
markus schnalke <meillo@marmaro.de>
parents: 165
diff changeset
2412 Nmh offers no direct support for digital signatures and message encryption.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2413 This functionality needed to be added through third-party software.
166
f102dcc06bb9 s/digital cryptography/signing and encryption/
markus schnalke <meillo@marmaro.de>
parents: 165
diff changeset
2414 In mmh, the functionality should be included because it
f102dcc06bb9 s/digital cryptography/signing and encryption/
markus schnalke <meillo@marmaro.de>
parents: 165
diff changeset
2415 is a part of modern email and likely wanted by users of mmh.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2416 A fresh mmh installation should support signing and encrypting
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2417 out-of-the-box.
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2418 Therefore, Neil Rickert's
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2419 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2420 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2421 .Pn mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2422 scripts
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2423 .[
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2424 neil rickert mhsign mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2425 .]
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2426 were included into mmh
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2427 .Ci f45cdc98117a84f071759462c7ae212f4bc5ab2e
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2428 .Ci 58cf09aa36e9f7f352a127158bbf1c5678bc6ed8 .
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2429 The scripts fit well because they are lightweight and
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2430 similar of style to the existing tools.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2431 Additionally, no licensing difficulties appeared,
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2432 as they are part of the public domain.
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2433 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2434 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2435 handles the signing and encrypting part.
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2436 It comprises about 250 lines of shell code and interfaces between
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2437 .Pn gnupg
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2438 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2439 the MH system.
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2440 It was meant to be invoked manually at the WhatNow prompt, but in mmh,
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2441 .Pn send
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2442 invokes
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2443 .pn mhsign
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2444 automatically
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2445 .Ci c7b5e1df086bcc37ff40163ee67571f076cf6683 .
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2446 Special header fields were introduced to request this action.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2447 If a draft contains the
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2448 .Hd Sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2449 header field,
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2450 .Pn send
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2451 will initiate the signing.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2452 The signing key is either chosen automatically or specified by the
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2453 .Pe Pgpkey
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2454 profile entry.
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2455 .Pn send
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2456 always create signatures using the PGP/MIME standard, \" REF XXX
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2457 but by manually invoking
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2458 .Pn mhsign ,
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2459 old-style non-MIME signatures can be created as well.
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2460 To encrypt an outgoing message, the draft needs to contain an
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2461 .Hd Enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2462 header field.
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2463 Public keys of all recipients are searched for in the gnupg keyring and
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2464 in a file called
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2465 .Fn pgpkeys ,
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2466 which contains exceptions and overrides.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2467 Unless public keys are found for all recipients,
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2468 .Pn mhsign
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2469 will refuse to encrypt it.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2470 Currently, messages with hidden (BCC) recipients can not be encrypted.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2471 This work is pending because it requires a structurally more complex
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2472 approach.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2473 .P
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2474 .Pn mhpgp
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2475 is the companion to
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2476 .Pn mhsign .
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2477 It verifies signatures and decrypts messages.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2478 Encrypted messages can either be temporarily decrypted for display
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2479 or permanently decrypted and stored into the current folder.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2480 Currently,
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2481 .Pn mhpgp
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2482 needs to be invoked manually.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2483 The integration into
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2484 .Pn show
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2485 and
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2486 .Pn mhstore
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2487 to verify signatures and decrypt messages as needs
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2488 is planned but not realized yet.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2489 .P
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2490 Both scripts were written for nmh, hence they needed to be adjust
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2491 according to the differences between nmh and mmh.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2492 For instance, they use the backup prefix no longer.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2493 Furthermore, compatibility support for old PGP features was dropped.
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2494 .P
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2495 The integrated message signing and encrypting support is one of the
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2496 most recent features in mmh.
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2497 It has not yet had the time to mature.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2498 User feedback and personal experience need to be accumulated to
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2499 direct the further development of the facility.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2500 Although the feedback and experience is still missing,
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2501 it seems to be worthwhile to consider adding
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2502 .Sw -[no]sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2503 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2504 .Sw -[no]enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2505 switches to
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2506 .Pn send ,
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2507 to be able to override the corresponding header fields.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2508 A profile entry:
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2509 .VS
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2510 send: -sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2511 VE
177
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2512 would then activate signing for all outgoing messages.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2513 With the present approach, a
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2514 .Hd Send
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2515 header component needs to be added to each draft template
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2516 to achieve the same result.
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2517 Adding the switches would ease the work greatly and keep the
3d7db5c7965d Finished the section on signing and encryption.
markus schnalke <meillo@marmaro.de>
parents: 173
diff changeset
2518 template files clean.
157
0cce17978f0a Wrote about signing and encrypting. Not finished yet.
markus schnalke <meillo@marmaro.de>
parents: 155
diff changeset
2519
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2520
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
2521
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
2522
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2523 .H2 "Draft and Trash Folder
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2524 .P
14
55ec590cfa07 Wrote about the draft folder.
markus schnalke <meillo@marmaro.de>
parents: 12
diff changeset
2525
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2526 .U3 "Draft Folder
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
2527 .Id draft-folder
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2528 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2529 In the beginning, MH had the concept of a draft message.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2530 This is the file
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2531 .Fn draft
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2532 in the MH directory, which is treated special.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2533 On composing a message, this draft file was used.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2534 When starting to compose another message before the former one was sent,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2535 the user had to decide among:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2536 .LI 1
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2537 Using the old draft to finish and send it before starting with a new one.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2538 .LI 2
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2539 Discarding the old draft and replacing it with a new one.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2540 .LI 3
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2541 Preserving the old draft by refiling it to a folder.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2542 .LP
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2543 It was only possible to work in alternation on multiple drafts.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2544 Therefore, the current draft needed to be refiled to a folder and
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2545 another one re-used for editing.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2546 Working on multiple drafts at the same time was impossible.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2547 The usual approach of switching to a different MH context did not
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2548 help anything.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2549 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2550 The draft folder facility exists to
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2551 allow true parallel editing of drafts, in a straight forward way.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2552 It was introduced by Marshall T. Rose, already in 1984.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2553 Similar to other new features, the draft folder was inactive by default.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2554 Even in nmh, the highly useful draft folder was not available
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2555 out-of-the-box.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2556 At least, Richard Coleman added the man page
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2557 .Mp mh-draft (5)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2558 to better document the feature.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2559 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2560 Not using the draft folder facility has the single advantage of having
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2561 the draft file at a static location.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2562 This is simple in simple cases but the concept does not scale for more
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2563 complex cases.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2564 The concept of the draft message is too limited for the problem.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2565 Therefore the draft folder was introduced.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2566 It is the more powerful and more natural concept.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2567 The draft folder is a folder like any other folder in MH.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2568 Its messages can be listed like any other messages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2569 A draft message is no longer a special case.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2570 Tools do not need special switches to work on the draft message.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2571 Hence corner cases were removed.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2572 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2573 The trivial part of the work was activating the draft folder with a
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2574 default name.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2575 I chose the name
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2576 .Fn +drafts
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2577 for obvious reasons.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2578 In consequence, the command line switches
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2579 .Sw -draftfolder
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2580 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2581 .Sw -draftmessage
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2582 could be removed.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2583 More difficult but also more improving was updating the tools to the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2584 new concept.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2585 For nearly three decades, the tools needed to support two draft handling
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2586 approaches.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2587 By fully switching to the draft folder, the tools could be simplified
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2588 by dropping the awkward draft message handling code.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2589 .Sw -draft
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2590 switches were removed because operating on a draft message is no longer
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2591 special.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2592 It became indistinguishable to operating on any other message.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2593 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2594 .P
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2595 There is no more need to query the user for draft handling
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2596 .Ci 2d48b455c303a807041c35e4248955f8bec59eeb .
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2597 It is always possible to add another new draft.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2598 Refiling drafts is without difference to refiling other messages.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2599 All of these special cases are gone.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2600 Yet, one draft-related switch remained.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2601 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2602 still has
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2603 .Sw -[no]use
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2604 for switching between two modes:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2605 .LI 1
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2606 .Sw -use
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2607 to modify an existing draft.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2608 .LI 2
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2609 .Sw -nouse
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2610 to compose a new draft, possibly taking some existing message as template.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2611 .LP
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2612 In either case, the behavior of
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2613 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2614 is deterministic.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2615 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2616 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2617 now operates on the current message in the draft folder by default.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2618 As message and folder can both be overridden by specifying them on
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2619 the command line, it is possible to send any message in the mail storage
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2620 by simply specifying its number and folder.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2621 In contrast to the other tools,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2622 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2623 takes the draft folder as its default folder.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2624 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2625 Dropping the draft message concept in favor for the draft folder concept,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2626 removed special cases with regular cases.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2627 This simplified the source code of the tools, as well as the concepts.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2628 In mmh, draft management does not break with the MH concepts
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2629 but applies them.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2630 .Cl "scan +drafts" ,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2631 for instance, is a truly natural request.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
2632 Most of the work was already performed by Rose in the eighties.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2633 The original improvement of mmh is dropping the old draft message approach
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2634 and thus simplifying the tools, the documentation and the system as a whole.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2635 Although my part in the draft handling improvement was small,
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2636 it was an important one.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2637
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2638
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2639 .U3 "Trash Folder
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
2640 .Id trash-folder
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2641 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2642 Similar to the situation for drafts is the situation for removed messages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2643 Historically, a message was ``deleted'' by prepending a specific
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
2644 \fIbackup prefix\fP, usually the comma character,
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
2645 to the file name.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2646 The specific file would then be ignored by MH because only files with
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2647 names consisting of digits only are treated as messages.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2648 Although files remained in the file system,
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2649 the messages were no longer visible in MH.
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2650 To truly delete them, a maintenance job was needed.
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2651 Usually a cron job was installed to delete them after a grace time.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2652 For instance:
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2653 .VS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2654 find $HOME/Mail -type f -name ',*' -ctime +7 -delete
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2655 VE
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2656 In such a setup, the original message could be restored
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2657 within the grace time interval by stripping the
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2658 backup prefix from the file name.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2659 But the user could not rely on this statement.
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2660 If the last message of a folder with six messages (\fL1-6\fP) was removed,
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2661 message
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2662 .Fn 6 ,
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2663 became file
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2664 .Fn ,6 .
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2665 If then a new message entered the same folder, it would be named with
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2666 the number one above the highest existing message number.
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2667 In this case the message would be named
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2668 .Fn 6
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2669 then.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2670 If this new message would be removed as well,
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2671 then the backup of the former message is overwritten.
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2672 Hence, the ability to restore removed messages did not only depend on
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2673 the sweeping cron job but also on the removing of further messages.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2674 It is undesirable to have such obscure and complex mechanisms.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2675 The user should be given a small set of clear assertions, such as
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2676 ``Removed files are restorable within a seven-day grace time.''
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2677 With the addition ``... unless a message with the same name in the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2678 same folder is removed before.'' the statement becomes complex.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2679 A user will hardly be able to keep track of any removal to know
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2680 if the assertion still holds true for a specific file.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2681 In practice, the real mechanism is unclear to the user.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2682 The consequences of further removals are not obvious.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2683 .P
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2684 Furthermore, the backup files are scattered within the whole mail storage.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2685 This complicates managing them.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2686 It is possible with the help of
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2687 .Pn find ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2688 but everything would be more convenient
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2689 if the deleted messages would be collected in one place.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2690 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2691 The profile entry
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2692 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2693 (previously named
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2694 .Pe Delete-Prog )
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2695 was introduced very early to improve the situation.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2696 It could be set to any command, which would be executed to remove
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2697 the specified messages.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2698 This would override the default action described above.
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2699 Refiling the to-be-removed files to a trash folder is the usual example.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2700 Nmh's man page
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2701 .Mp rmm (1)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2702 proposes to set the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2703 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2704 to
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2705 .Cl "refile +d
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2706 to move messages to the trash folder,
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2707 .Fn +d ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2708 instead of renaming them with the backup prefix.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2709 The man page proposes additionally the expunge command
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2710 .Cl "rm `mhpath +d all`
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2711 to empty the trash folder.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2712 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2713 Removing messages in such a way has advantages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2714 The mail storage is prevented from being cluttered with removed messages
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2715 because they are all collected in one place.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2716 Existing and removed messages are thus separated more strictly.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2717 No backup files are silently overwritten.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2718 But most important is the ability to keep removed messages in the MH domain.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2719 Messages in the trash folder can be listed like those in any other folder.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2720 Deleted messages can be displayed like any other messages.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
2721 .Pn refile
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
2722 can restore deleted messages.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2723 All operations on deleted files are still covered by the MH tools.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2724 The trash folder is just like any other folder in the mail storage.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2725 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2726 Similar to the draft folder case, I dropped the old backup prefix approach
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2727 in favor for replacing it by the better suiting trash folder system.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2728 Hence,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2729 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2730 calls
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2731 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2732 to move the to-be-removed message to the trash folder,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2733 .Fn +trash
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2734 by default.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2735 To sweep it clean, the user can use
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2736 .Cl "rmm -unlink +trash a" ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2737 where the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2738 .Sw -unlink
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2739 switch causes the files to be unlinked.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2740 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2741 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2742 .P
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2743 Dropping the legacy approach and converting to the new approach completely
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2744 simplified the code base.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2745 The relationship between
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2746 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2747 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2748 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2749 was inverted.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2750 In mmh,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2751 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2752 invokes
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2753 .Pn refile ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2754 which used to be the other way round.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2755 Yet, the relationship is simpler now.
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2756 Loops, like described in nmh's man page for
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2757 .Mp refile (1),
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
2758 can no longer occur:
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2759 .QS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2760 Since
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2761 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2762 uses your
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2763 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2764 to delete the message, the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2765 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2766 must NOT call
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2767 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2768 without specifying
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2769 .Sw -normmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2770 or you will create an infinite loop.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2771 .QE
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2772 .LP
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2773 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2774 either unlinks a message with
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2775 .Fu unlink()
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2776 or invokes
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2777 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2778 to move it to the trash folder.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2779 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2780 does not invoke any tools.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2781 .P
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2782 By generalizing the message removal in the way that it became covered
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2783 by the MH concepts made the whole system more powerful.
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2784
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2785
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2786
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2787
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2788
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2789 .H2 "Modern Defaults
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2790 .P
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2791 Nmh has a bunch of convenience-improving features inactive by default,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2792 although one can expect every new user wanting to have them active.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2793 The reason they are inactive by default is the wish to stay compatible
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2794 with old versions.
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2795 But what is the definition for old versions?
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2796 Still, the highly useful draft folder facility has not been activated
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2797 by default although it was introduced over twenty-five years ago.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2798 .[
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2799 rose romine real work
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2800 .]
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2801 The community seems not to care.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2802 This is one of several examples that require new users to first build up
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2803 a profile before they can access the modern features of nmh.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2804 Without an extensive profile, the setup is hardly usable
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2805 for modern emailing.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2806 The point is not the customization of the setup,
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2807 but the need to activate generally useful facilities.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2808 .P
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2809 Yet, the real problem lies less in enabling the features, as this is
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2810 straight forward as soon as one knows what he wants.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2811 The real problem is that new users need deep insight into the project
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2812 to find out about inactive features nmh already provides.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2813 To give an example, I needed one year of using nmh
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2814 before I became aware of the existence of the attachment system.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2815 One could argue that this fact disqualifies my reading of the
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2816 documentation.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2817 If I would have installed nmh from source back then, I could agree.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2818 Yet, I had used a prepackaged version and had expected that it would
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2819 just work.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2820 Nevertheless, I had been convinced by the concepts of MH already
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2821 and I am a software developer,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2822 still I required a lot of time to discover the cool features.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2823 How can we expect users to be even more advanced than me,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2824 just to allow them use MH in a convenient and modern way?
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2825 Unless they are strongly convinced of the concepts, they will fail.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2826 I have seen friends of me giving up disappointed
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2827 before they truly used the system,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2828 although they had been motivated in the beginning.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
2829 They suffer hard enough to get used to the tool chest approach,
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
2830 we developers should spare them further inconveniences.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2831 .P
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2832 Maintaining compatibility for its own sake is bad,
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2833 because the code base collects more and more compatibility code.
200
c299ed65d015 Spell checked.
markus schnalke <meillo@marmaro.de>
parents: 199
diff changeset
2834 Sticking to the compatibility code means remaining limited;
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2835 whereas adjusting to the changes renders the compatibility unnecessary.
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2836 Keeping unused alternatives in the code is a bad choice as they likely
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2837 gather bugs, by not being well tested.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2838 Also, the increased code size and the greater number of conditions
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2839 increase the maintenance costs.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2840 If any MH implementation would be the back-end of widespread
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2841 email clients with large user bases, compatibility would be more
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2842 important.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2843 Yet, it appears as if this is not the case.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2844 Hence, compatibility is hardly important for technical reasons.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2845 Its importance originates rather from personal reasons.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2846 Nmh's user base is small and old.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2847 Changing the interfaces would cause inconvenience to long-term users of MH.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2848 It would force them to change their many years old MH configurations.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2849 I do understand this aspect, but by sticking to the old users,
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2850 new users are kept away.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2851 Yet, the future lies in new users.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2852 In consequence, mmh invites new users by providing a convenient
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2853 and modern setup, readily usable out-of-the-box.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2854 .P
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2855 In mmh, all modern features are active by default and many previous
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2856 approaches are removed or only accessible in manual ways.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2857 New default features include:
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2858 .BU
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2859 The attachment system (\c
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2860 .Hd Attach ).
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2861 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2862 .BU
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2863 The draft folder facility (\c
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2864 .Fn +drafts ).
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2865 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2866 .BU
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2867 The unseen sequence (`u')
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2868 .Ci c2360569e1d8d3678e294eb7c1354cb8bf7501c1
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2869 and the sequence negation prefix (`!').
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2870 .Ci db74c2bd004b2dc9bf8086a6d8bf773ac051f3cc
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2871 .BU
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2872 Quoting the original message in the reply.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2873 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2874 .BU
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2875 Forwarding messages using MIME.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2876 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
2877 .LP
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2878 In consequence, a setup with a profile that defines only the path to the
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2879 mail storage, is already convenient to use.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2880 Again, Paul Vixie's ``edginess'' call supports the direction I took:
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2881 ``the `main branch' should just be modern''.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2882 .[
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2883 paul vixie edginess nmh-workers
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2884 .]
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2885
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2886
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2887
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2888
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2889
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
2890 .\" --------------------------------------------------------------
131
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion.
markus schnalke <meillo@marmaro.de>
parents: 130
diff changeset
2891 .H1 "Styling
16
81f703140554 Wrote about the trash folder.
markus schnalke <meillo@marmaro.de>
parents: 14
diff changeset
2892 .P
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2893 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
2894 preface of their book:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2895 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2896 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
2897 .], p. x]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2898 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2899 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
2900 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
2901 to cover it first.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2902 .QE
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2903 This section covers changes in mmh that were guided by the desire
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2904 to improve on style.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2905 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
2906 .[
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2907 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
2908 .]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2909
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2910
127
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'.
markus schnalke <meillo@marmaro.de>
parents: 126
diff changeset
2911
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'.
markus schnalke <meillo@marmaro.de>
parents: 126
diff changeset
2912
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'.
markus schnalke <meillo@marmaro.de>
parents: 126
diff changeset
2913 .H2 "Code Style
154
63e885fb48ba Converted some internal references to the new macros.
markus schnalke <meillo@marmaro.de>
parents: 145
diff changeset
2914 .Id code-style
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2915 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2916 .U3 "Indentation Style
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2917 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2918 Indentation styles are the holy cow of programmers.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2919 Kernighan and Pike
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2920 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2921 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
2922 .], p. 10]
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
2923 wrote:
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2924 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2925 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
2926 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
2927 application.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
2928 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
2929 time arguing.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2930 .QE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2931 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2932 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
2933 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
2934 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
2935 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
2936 one tab, one level.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2937 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
2938 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
2939 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
2940 .Pn unexpand
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2941 or
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2942 .Pn entab
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2943 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
2944 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
2945 (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
2946 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
2947 Although reformatting existing code should be avoided, I did it.
200
c299ed65d015 Spell checked.
markus schnalke <meillo@marmaro.de>
parents: 199
diff changeset
2948 I did not waste time arguing; I just reformatted the code.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2949 .Ci a485ed478abbd599d8c9aab48934e7a26733ecb1
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2950
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2951 .U3 "Comments
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2952 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2953 Section 1.6 of
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2954 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2955 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
2956 .], p. 23]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2957 demands: ``Don't belabor the obvious.''
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
2958 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
2959 .VS
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2960 context_replace(curfolder, folder); /* update current folder */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2961 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
2962 seq_save(mp); /* synchronize message sequences */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2963 folder_free(mp); /* free folder/message structure */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2964 context_save(); /* save the context file */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2965
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2966 [...]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2967
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2968 int c; /* current character */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2969 char *cp; /* miscellaneous character pointer */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2970
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2971 [...]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2972
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2973 /* NUL-terminate the field */
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2974 *cp = '\0';
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2975 VE
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
2976 .Ci 426543622b377fc5d091455cba685e114b6df674
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2977 .P
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2978 The program code explains enough itself, already.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
2979
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2980
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2981 .U3 "Names
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2982 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2983 Kernighan and Pike suggest:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2984 ``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
2985 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2986 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
2987 .], p. 4]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2988 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
2989 .Fu check_charset()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2990 to
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2991 .Fu is_native_charset() .
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2992 .Ci 8d77b48284c58c135a6b2787e721597346ab056d
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2993 The same change fixed a violation of ``Be accurate''
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2994 .[ [
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2995 kernighan pike practice of programming
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2996 .], p. 4]
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
2997 as well.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
2998 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
2999 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
3000 of the charset name.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3001 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3002 More important than using active names is using descriptive names.
145
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
3003 .VS
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
3004 m_unknown(in); /* the MAGIC invocation... */
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
3005 VE
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
3006 Renaming the obscure
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3007 .Fu m_unknown()
145
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
3008 function was a delightful event, although it made the code less funny.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3009 .Ci 611d68d19204d7cbf5bd585391249cb5bafca846
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3010 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3011 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
3012 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
3013 ``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
3014 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3015 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
3016 .], p. 19]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3017 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
3018 to be scanned:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3019 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3020 #define SCN_MBOX (-1)
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3021 #define SCN_FOLD 0
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3022 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3023 .Ci 7ffb36d28e517a6f3a10272056fc127592ab1c19
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3024 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3025 The argument
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3026 .Ar outnum
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3027 of the function
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3028 .Fu scan()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3029 in
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3030 .Fn uip/scansbr.c
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3031 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
3032 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
3033 program logic.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3034 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
3035 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
3036 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3037 int incing = (outnum > 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3038 int ismbox = (outnum != 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3039 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3040 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
3041 The variable
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3042 .Ar outnum
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3043 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
3044 .Ci b8b075c77be7794f3ae9ff0e8cedb12b48fd139f
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3045 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
3046 of related code parts.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3047 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
3048 straight forward implementation became apparent.
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
3049 Before the code was clarified, the possibility to improve had not be seen.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3050 .Ci aa60b0ab5e804f8befa890c0a6df0e3143ce0723
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3051
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3052
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3053
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3054 .H2 "Structural Rework
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3055 .P
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3056 Although the stylistic changes described up to here improve the
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3057 readability of the source code, all of them are changes ``in the small''.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3058 Structural changes affect a much larger area.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3059 They are more difficult to do but lead to larger improvements,
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3060 especially as they influence the outer shape of the tools as well.
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3061 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3062 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
3063 Kernighan and Pike ask: ``But why worry about style?''
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
3064 .[ [
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
3065 kernighan pike practice of programming
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
3066 .], p. 28]
136
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3067 Following are two examples of structural rework that show
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3068 why style is important in the first place.
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3069
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3070
470d5db0c06c Minor rework.
markus schnalke <meillo@marmaro.de>
parents: 134
diff changeset
3071 .U3 "Rework of \f(CWanno\fP
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3072 .P
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3073 Until 2002,
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3074 .Pn anno
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3075 had six functional command line switches,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3076 .Sw -component
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3077 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3078 .Sw -text ,
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3079 which have an argument each,
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3080 and the two pairs of flags,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3081 .Sw -[no]date
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3082 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3083 .Sw -[no]inplace .
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3084 Then Jon Steinhart introduced his attachment system.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3085 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
3086 .Pn anno .
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3087 He added five more switches:
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3088 .Sw -draft ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3089 .Sw -list ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3090 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3091 .Sw -append ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3092 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3093 .Sw -number ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3094 the last one taking an argument.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3095 .Ci 7480dbc14bc90f2d872d434205c0784704213252
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3096 Later,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3097 .Sw -[no]preserve
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3098 was added.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3099 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3100 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
3101 .Mp anno (1)
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3102 read:
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3103 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3104 anno [+folder] [msgs] [-component field] [-inplace | -noinplace]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3105 [-date | -nodate] [-draft] [-append] [-list] [-delete]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3106 [-number [num|all]] [-preserve | -nopreserve] [-version]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3107 [-help] [-text body]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3108 VE
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3109 .LP
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3110 The implementation followed the same structure.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3111 Problems became visible when
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3112 .Cl "anno -list -number 42
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3113 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
3114 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3115 .Cl "anno -list -number l:5
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
3116 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
3117 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
3118 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
3119 There, the correct use of
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3120 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3121 was defined as being
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3122 .Cl "[-number [num|all]]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3123 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
3124 .Sw -list
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3125 read:
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3126 .QS
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3127 The
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3128 .Sw -list
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3129 option produces a listing of the field bodies for
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3130 header fields with names matching the specified component,
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3131 one per line. The listing is numbered, starting at 1, if the
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3132 .Sw -number
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3133 option is also used.
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3134 .QE
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3135 .LP
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3136 The problem was manifold.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3137 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
3138 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3139 switch.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3140 If it was missing or non-numeric,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3141 .Pn anno
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3142 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
3143 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
3144 Semantically, the argument to the
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3145 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3146 switch is only necessary in combination with
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3147 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3148 but not with
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3149 .Sw -list .
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3150 .P
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3151 Trying to fix these problems on the surface would not have solved
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3152 them truly, as they originate from a discrepance between the
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3153 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
3154 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
3155 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
3156 to the structure of the problem.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3157 .P
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3158 In 2002, the new switches
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3159 .Sw -list
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3160 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3161 .Sw -delete
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3162 were added in the same way, the
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3163 .Sw -number
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3164 switch for instance had been added.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3165 Yet, they are of structural different type.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3166 Semantically,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3167 .Sw -list
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3168 and
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3169 .Sw -delete
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3170 introduce modes of operation.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3171 Historically,
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3172 .Pn anno
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3173 had only one operation mode: adding header fields.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3174 With the extension it got two more modes:
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3175 .\" XXX got
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3176 listing and deleting header fields.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3177 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
3178 fundamental change to
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3179 .Pn anno 's
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3180 behavior.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3181 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
3182 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
3183 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
3184 .Pn anno
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3185 and its documentation.
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3186 .Ci d54c8db8bdf01e8381890f7729bc0ef4a055ea11
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3187 .P
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3188 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
3189 The following code excerpt:
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3190 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3191 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
3192 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
3193 [...]
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3194 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3195 delete = 0;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3196 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3197 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3198 list = 1;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3199 continue;
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3200 VE
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3201 .LP
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3202 was replaced by:
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3203 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3204 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
3205 [...]
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3206 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3207 mode = MODE_DEL;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3208 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3209 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3210 mode = MODE_LIST;
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3211 continue;
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3212 VE
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3213 .LP
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3214 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
3215 it is easier to understand as well.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3216 The same applies to the documentation.
120
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3217 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
3218 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
3219 .VS
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3220 anno [+folder] [msgs] [-component field] [-text body]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3221 [-append] [-date | -nodate] [-preserve | -nopreserve]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3222 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3223
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3224 anno -delete [+folder] [msgs] [-component field] [-text
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3225 body] [-number num | all ] [-preserve | -nopreserve]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3226 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3227
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3228 anno -list [+folder] [msgs] [-component field] [-number]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3229 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1).
markus schnalke <meillo@marmaro.de>
parents: 118
diff changeset
3230 VE
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3231 .\" 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
3232
16
81f703140554 Wrote about the trash folder.
markus schnalke <meillo@marmaro.de>
parents: 14
diff changeset
3233
0
dc2bfef4cda7 Initial commit: Basic structure, macros and fonts.
markus schnalke <meillo@marmaro.de>
parents:
diff changeset
3234
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3235 .U3 "Path Conversion
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3236 .P
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3237 Four kinds of path names can appear in MH:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3238 .LI 1
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3239 Absolute Unix directory paths, like
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3240 .Fn /etc/passwd .
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3241 .LI 2
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3242 Relative Unix directory paths, like
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3243 .Fn ./foo/bar .
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3244 .LI 3
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3245 Absolute MH folder paths, like
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3246 .Fn +friends/phil .
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3247 .LI 4
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3248 Relative MH folder paths, like
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3249 .Fn @subfolder .
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3250 .LP
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3251 The last type, relative MH folder paths, are hardly documented.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3252 Nonetheless, they are useful for large mail storages.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3253 The current mail folder is specified as `\c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3254 .Fn @ ',
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3255 just like the current directory is specified as `\c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3256 .Fn . '.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3257 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3258 To allow MH tools to understand all four notations,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3259 they need to convert between them.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3260 .\" XXX between?
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3261 In nmh, these path name conversion functions were located in the files
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3262 .Fn sbr/path.c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3263 (``return a pathname'') and
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3264 .Fn sbr/m_maildir.c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3265 (``get the path for the mail directory'').
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3266 The seven functions in the two files were documented with no more
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3267 than two comments, which described obvious information.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3268 The function signatures were neither explaining:
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3269 .VS
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3270 char *path(char *, int);
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3271 char *pluspath(char *);
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3272 char *m_mailpath(char *);
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3273 char *m_maildir(char *);
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3274 VE
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3275 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3276 My investigation provides the following description:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3277 .LI 1
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3278 The second parameter of
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3279 .Fu path()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3280 defines the type of path given as first parameter.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3281 Directory paths are converted to absolute directory paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3282 Folder paths are converted to absolute folder paths.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3283 Folder paths must not include a leading `\fL@\fP' character.
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3284 Leading plus characters are preserved.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3285 The result is a pointer to newly allocated memory.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3286 .LI 2
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3287 .Fu pluspath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3288 is a convenience-wrapper to
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3289 .Fu path() ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3290 to convert folder paths only.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3291 This function can not be used for directory paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3292 An empty string parameter causes a buffer overflow.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3293 .LI 3
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3294 .Fu m_mailpath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3295 converts directory paths to absolute directory paths.
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3296 The characters `\fL+\fP' or `\fL@\fP' at the beginning of the path name are
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3297 treated literal, i.e. as the first character of a relative directory path.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3298 Hence, this function can not be used for folder paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3299 In any case, the result is an absolute directory path.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3300 The result is a pointer to newly allocated memory.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3301 .LI 4
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3302 .Fu m_maildir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3303 returns the parameter unchanged if it is an absolute directory path
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3304 or begins with the entry `\fL.\fP' or `\fL..\fP'.
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3305 All other strings are prepended with the current working directory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3306 Hence, this functions can not be used for folder paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3307 The result is either an absolute directory path or a relative
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3308 directory path, starting with a dot.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3309 In contrast to the other functions, the result is a pointer to
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3310 static memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3311 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3312 The situation was obscure, irritating, error-prone, and non-orthogonal.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3313 No clear terminology was used to name the different kinds of path names.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3314 The first argument of
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3315 .Fu m_mailpath() ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3316 for instance, was named
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3317 .Ar folder ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3318 though
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3319 .Fu m_mailpath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3320 can not be used for MH folders.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3321 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3322 I reworked the path name conversion completely, introducing clarity.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3323 First of all, the terminology needed to be defined.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3324 A path name is either in the Unix domain, then it is called
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3325 \fIdirectory path\fP, `dirpath' for short, or it is in the MH domain,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3326 then it is called \fIfolder path\fP, `folpath' for short.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3327 The two terms need to be used with strict distinction.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3328 Having a clear terminology is often an indicator of having understood
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3329 the problem itself.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3330 Second, I exploited the concept of path type indicators.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3331 By requesting every path name to start with a clear type identifier,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3332 conversion between the types can be fully automated.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3333 Thus the tools can accept paths of any type from the user.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3334 Therefore, it was necessary to require relative directory paths to be
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3335 prefixed with a dot character.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3336 In consequence, the dot character could no longer be an alias for the
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3337 current message.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3338 .Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3339 Third, I created three new functions to replace the previous mess:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3340 .LI 1
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3341 .Fu expandfol()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3342 converts folder paths to absolute folder paths,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3343 without the leading plus character.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3344 Directory paths are simply passed through.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3345 This function is to be used for folder paths only, thus the name.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3346 The result is a pointer to static memory.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3347 .LI 2
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3348 .Fu expanddir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3349 converts directory paths to absolute directory paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3350 Folder paths are treated as relative directory paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3351 This function is to be used for directory paths only, thus the name.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3352 The result is a pointer to static memory.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3353 .LI 3
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3354 .Fu toabsdir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3355 converts any type of path to an absolute directory path.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3356 This is the function of choice for path conversion.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3357 Absolute directory paths are the most general representation of a
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3358 path name.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3359 The result is a pointer to static memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3360 .P
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3361 .\" XXX ueberfluessig?
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3362 The new functions have names that indicate their use.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3363 Two of the functions convert relative to absolute path names of the
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3364 same type.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3365 The third function converts any path name type to the most general one,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3366 the absolute directory path.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3367 All of the functions return pointers to static memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3368 All three functions are implemented in
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3369 .Fn sbr/path.c .
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3370 .Fn sbr/m_maildir.c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3371 is removed.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3372 .Ci d39e2c447b0d163a5a63f480b23d06edb7a73aa0
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3373 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3374 Along with the path conversion rework, I also replaced
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3375 .Fu getfolder(FDEF)
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3376 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3377 .Fu getdeffol()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3378 and
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3379 .Fu getfolder(FCUR)
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3380 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3381 .Fu getcurfol() ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3382 which is only a convenience wrapper for
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3383 .Fu expandfol("@") .
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3384 This code was moved from
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3385 .Fn sbr/getfolder.c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3386 to
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3387 .Fn sbr/path.c .
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3388 .Ci d39e2c447b0d163a5a63f480b23d06edb7a73aa0
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3389 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3390 The related function
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3391 .Fu etcpath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3392 was moved to
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3393 .Fn sbr/path.c ,
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3394 too
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3395 .Ci b4c29794c12099556151d93a860ee51badae2e35 .
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3396 Previously, it had been located in
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3397 .Fn config/config.c ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3398 for whatever reasons.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3399 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3400 .Fn sbr/path.c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3401 now contains all path handling code.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3402 .\" XXX naechste zeile weg?
134
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3403 Only 173 lines of code were needed to replace the previous 252 lines.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3404 The readability of the code is highly improved.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3405 Additionally, each of the six exported and one static functions
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings
markus schnalke <meillo@marmaro.de>
parents: 133
diff changeset
3406 is introduced by an explaining comment.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3407
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3408
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3409
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3410
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3411 .H2 "Profile Reading
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3412 .P
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3413 The MH profile contains the configuration for the user-specific MH setup.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3414 MH tools read the profile right after starting up,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3415 as it contains the location of the user's mail storage
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3416 and similar settings that influence the whole setup.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
3417 Furthermore, the profile contains the default switches for the tools,
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3418 hence, it must be read before the command line switches are processed.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3419 .P
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3420 For historic reasons, some MH tools did not read the profile and context.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3421 Among them were
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3422 .Pn post /\c
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3423 .Pn spost ,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3424 .Pn mhmail ,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3425 and
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3426 .Pn slocal .
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3427 The reason why these tools ignored the profile were not clearly stated.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3428 During the discussion on the nmh-workers mailing list,
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
3429 David Levine posted an explanation, quoting John Romine:
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3430 .[
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3431 nmh-workers levine post profile
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3432 .]
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3433 .QS
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3434 I asked John Romine and here's what he had to say, which
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3435 agrees and provides an example that convinces me:
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3436 .QS
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3437 My take on this is that
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3438 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3439 should not be called by users directly, and it doesn't read the
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3440 .Fn .mh_profile
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3441 (only front-end UI programs read the profile).
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3442 .QP
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3443 For example, there can be contexts where
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3444 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3445 is called by a helper program (like `\c
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3446 .Pn mhmail ')
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3447 which may be run by a non-MH user.
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3448 We don't want this to prompt the user to create an MH profile, etc.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3449 .QP
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3450 My suggestion would be to have
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3451 .Pn send
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3452 pass a (hidden) `\c
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3453 .Sw -fileproc
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3454 .Ar proc '
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3455 option to
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3456 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3457 if needed.
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3458 You could also
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3459 use an environment variable (I think
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3460 .Pn send /\c
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3461 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3462 do this).
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3463 .QE
164
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3464 I think that's the way to go.
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3465 My personal preference is to use a command line option,
5c01017be420 Reacted to suggestions by Aaron Mueller.
markus schnalke <meillo@marmaro.de>
parents: 159
diff changeset
3466 not an environment variable.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3467 .QE
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3468 .P
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3469 To solve the problem of
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3470 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3471 not honoring the
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3472 .Pe fileproc
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3473 profile entry,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3474 the community roughly agreed that a switch
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3475 .Sw -fileproc
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3476 should be added to
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3477 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3478 to be able to pass a different fileproc.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3479 I strongly disagree with this approach because it does not solve
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3480 the problem; it only removes a single symptom.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3481 The problem is that
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3482 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3483 does not behave as expected.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3484 But all programs should behave as expected.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3485 Clear and simple concepts are a precondition for this.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3486 Hence, the real solution is having all MH tools read the profile.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3487 .P
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3488 The problem has a further aspect.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3489 It mainly originates in
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3490 .Pn mhmail .
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3491 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3492 was intended to be a replacement for
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3493 .Pn mailx
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3494 on systems with MH installations.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3495 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3496 should have been able to use just like
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3497 .Pn mailx ,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3498 but sending the message via MH's
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3499 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3500 instead of
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3501 .Pn sendmail .
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3502 Using
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3503 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3504 should not be influenced by the question whether the user had
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3505 MH set up for himself or not.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3506 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3507 did not read the profile as this requests the user to set up MH
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3508 if not done yet.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3509 As
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3510 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3511 used
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3512 .Pn post ,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3513 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3514 could not read the profile neither.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3515 This is the reason why
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3516 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3517 does not read the profile.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3518 This is the reason for the actual problem.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3519 It was not much of a problem because
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3520 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3521 was not intended to be used by users directly.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3522 .Pn send
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3523 is the interactive front-end to
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3524 .Pn post .
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3525 .Pn send
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3526 read the profile and passed all relevant values on the command line to
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3527 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3528 \(en an awkward solution.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3529 .P
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3530 The important insight is that
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3531 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3532 is no true MH tool.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3533 The concepts broke because this outlandish tool was treated as any other
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3534 MH tool.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3535 Instead it should have been treated accordingly to its foreign style.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3536 The solution is not to prevent the tools reading the profile but
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3537 to instruct them reading a different profile.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3538 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3539 could have set up a well-defined profile and caused all MH tools
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3540 in the session to use it by exporting an environment variable.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3541 With this approach, no special cases would have been introduced,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3542 no surprises would have been caused.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3543 By writing a clean-profile-wrapper, the concept could have been
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3544 generalized orthogonally to the whole MH tool chest.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3545 Then Rose's motivation behind the decision that
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3546 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3547 ignores the profile, as quoted by Jeffrey Honig,
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
3548 would have become possible:
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3549 .[
197
05a243dffaca Added refs to the Preface; splitted the bib.
markus schnalke <meillo@marmaro.de>
parents: 187
diff changeset
3550 nmh-workers honig post profile
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3551 .]
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3552 .QS
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3553 when you run mh commands in a script, you want all the defaults to be
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3554 what the man page says.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3555 when you run a command by hand, then you want your own defaults...
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3556 .QE
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3557 .LP
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3558 Yet, I consider this explanation shortsighted.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3559 We should rather regard theses two cases as just two different MH setups,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3560 based on two different profiles.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3561 Mapping such problems on the concepts of switching between different
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3562 profiles, solves them once for all.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3563 .P
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3564 In mmh, the wish to have
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3565 .Pn mhmail
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3566 as a replacement for
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3567 .Pn mailx
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3568 is considered obsolete.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3569 Mmh's
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3570 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3571 does no longer cover this use-case.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3572 Currently,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3573 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3574 is in a transition state.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3575 .Ci 32d4f9daaa70519be3072479232ff7be0500d009
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3576 It may become a front-end to
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3577 .Pn comp ,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3578 which provides an interface more convenient in some cases.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3579 In this case,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3580 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3581 will become an ordinary MH tool, reading the profile.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3582 If, however, this idea will not convince, then
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3583 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3584 will be removed.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3585 .P
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3586 Every program in the mmh tool chest reads the profile.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3587 The only exception is
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3588 .Pn slocal ,
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3589 which is not considered part of the mmh tool chest.
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3590 This MDA is only distributed with mmh, currently.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3591 Mmh has no
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3592 .Pn post
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3593 program, but
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3594 .Pn spost ,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3595 which now reads the profile.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3596 .Ci 3e017a7abbdf69bf0dff7a4073275961eda1ded8
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3597 With this change,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3598 .Pn send
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3599 and
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3600 .Pn spost
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3601 can be considered to be merged.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3602 .Pn spost
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
3603 is only invoked directly by the to-be-changed
138
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3604 .Pn mhmail
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3605 implementation and by
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3606 .Pn rcvdist ,
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3607 which will require rework.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3608 .P
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3609 The
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3610 .Fu context_foil()
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3611 function to pretend to have read an empty profile was removed.
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3612 .Ci 68af8da96bea87a5541988870130b6209ce396f6
cc35686f359e Wrote about profile reading.
markus schnalke <meillo@marmaro.de>
parents: 136
diff changeset
3613 All mmh tools read the profile.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3614
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3615
127
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'.
markus schnalke <meillo@marmaro.de>
parents: 126
diff changeset
3616
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3617 .H2 "Standard Libraries
58
814c33b96d89 Restructured the content in ch03.
markus schnalke <meillo@marmaro.de>
parents: 51
diff changeset
3618 .P
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3619 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
3620 Hence, MH included own implementations of functions
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3621 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
3622 but were not back then.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3623 Today, twenty years after the POSIX and ANSI C were published,
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3624 developers can expect systems to comply with these standards.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3625 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
3626 can and should be dropped.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3627 Kernighan and Pike advise: ``Use standard libraries.''
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3628 .[ [
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3629 kernighan pike practice of programming
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3630 .], p. 196]
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3631 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
3632 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
3633 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3634 .Fu snprintf()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3635 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
3636 almost everywhere because of its high usefulness.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3637 The project's own implementation of
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3638 .Fu snprintf()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3639 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
3640 standard library.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3641 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3642 Such decisions limit the portability of mmh
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3643 if systems do not support these standardized and widespread functions.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3644 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
3645 .P
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3646 .\" XXX kuerzen und mit dem naechsten Absatz vereinen
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3647 I am still in my twenties and my C and Unix experience comprises
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3648 only half a dozen years.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3649 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
3650 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
3651 I have not suffered from their incompatibilities.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3652 I have not longed for standardization.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3653 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
3654 were well established already.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3655 I have only read a lot of books about the (good) old times.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3656 This puts me in a difficult position when working with old code.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3657 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
3658 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
3659 heart from their own experience.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3660 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3661 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
3662 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
3663 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
3664 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
3665 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
3666 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
3667 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
3668 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
3669 .Ci 768b5edd9623b7238e12ec8dfc409b82a1ed9e2d
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3670 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32 .
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
3671 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3672 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
3673 .Fn libmh.a ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3674 which is located in the
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3675 .Fn sbr
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3676 (``subroutines'') directory in the source tree.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3677 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
3678 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
3679 and folder handling, but as well
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3680 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
3681 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
3682 functions of the standard library.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3683 .P
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3684 I have replaced the
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3685 .Fu atooi()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3686 function with calls to
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3687 .Fu strtoul()
139
b7b81ae9c9d8 Removed and moved some paragraphs.
markus schnalke <meillo@marmaro.de>
parents: 138
diff changeset
3688 with the third parameter, the base, set to eight.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3689 .Fu strtoul()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3690 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
3691 .Ci c490c51b3c0f8871b6953bd0c74551404f840a74
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3692 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3693 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
3694 .Fu memmove()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3695 and
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3696 .Fu strerror() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3697 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
3698 to support SunOS 4.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3699 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
3700 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
3701 put a load on mmh.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3702 .Ci b067ff5c465a5d243ce5a19e562085a9a1a97215
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3703 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3704 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3705 .Fu copy()
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3706 function copies the string in parameter one to the location in
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3707 parameter two.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3708 In contrast to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3709 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3710 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
3711 The code was adjusted to replace
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3712 .Fu copy()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3713 with
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3714 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3715 except within
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3716 .Fu concat() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3717 where
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3718 .Fu copy()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3719 was more convenient.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3720 Therefore, the definition of
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3721 .Fu copy()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3722 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
3723 .Fu concat()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3724 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
3725 .Ci 552fd7253e5ee9e554c5c7a8248a6322aa4363bb
102
a782488c85f5 More text about attachments mainly, plus some rearrangements.
markus schnalke <meillo@marmaro.de>
parents: 101
diff changeset
3726 .P
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3727 The function
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3728 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3729 had been a generalized version of
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3730 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3731 with minor differences.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3732 As all calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3733 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3734 had the slash (`/') as delimiter anyway,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3735 replacing
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3736 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3737 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
3738 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3739 became desirable.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3740 Unfortunately, many of the 54 calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3741 .Fu r1bindex()
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3742 depended on a special behavior,
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3743 which differed from the POSIX specification for
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3744 .Fu basename() .
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3745 Hence,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3746 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3747 was kept but renamed to
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3748 .Fu mhbasename() ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3749 fixing the delimiter to the slash.
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3750 .Ci 240013872c392fe644bd4f79382d9f5314b4ea60
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3751 For possible uses of
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3752 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3753 with a different delimiter,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3754 the ANSI C function
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3755 .Fu strrchr()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3756 provides the core functionality.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3757 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3758 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3759 .Fu ssequal()
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3760 function \(en apparently for ``substring equal'' \(en
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3761 was renamed to
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3762 .Fu isprefix() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3763 because this is what it actually checks.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3764 .Ci c20b4fa14515c7ab388ce35411d89a7a92300711
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3765 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
3766 .VS
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3767 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3768 * THIS CODE DOES NOT WORK AS ADVERTISED.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3769 * 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
3770 * 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
3771 * 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
3772 * should be kept if it's sufficient.
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3773 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3774
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3775 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3776 * 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
3777 * 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
3778 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3779 VE
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3780 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
3781 .Fu strncmp() .
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3782 .Ci b0b1dd37ff515578cf7cba51625189eb34a196cb
121
edbc6e1dc636 New text on Standard Libraries plus spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 120
diff changeset
3783
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3784
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3785
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3786
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3787
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3788 .H2 "User Data Locations
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3789 .P
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3790 In nmh, a personal setup consists of the MH profile and the MH directory.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3791 The profile is a file named
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3792 .Fn \&.mh_profile
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3793 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3794 It contains the static configuration.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3795 It also contains the location of the MH directory in the profile entry
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3796 .Pe Path .
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3797 The MH directory contains the mail storage and is the first
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3798 place to search for personal forms, scan formats, and similar
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3799 configuration files.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3800 The location of the MH directory can be chosen freely by the user.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3801 The default and usual name is a directory named
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3802 .Fn Mail
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3803 in the home directory.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3804 .P
200
c299ed65d015 Spell checked.
markus schnalke <meillo@marmaro.de>
parents: 199
diff changeset
3805 The way MH data is split between profile and MH directory is a legacy.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3806 It is only sensible in a situation where the profile is the only
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3807 configuration file.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3808 Why else should the mail storage and the configuration files be intermixed?
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3809 They are different kinds of data:
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3810 The data to be operated on and the configuration to change how
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3811 tools operate.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3812 .\" XXX bad ... inapropriate?
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3813 Splitting the configuration between the profile and the MH directory
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3814 is bad.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3815 Merging the mail storage and the configuration in one directory is bad
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3816 as well.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3817 As the mail storage and the configuration were not separated sensibly
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3818 in the first place, I did it now.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3819 .P
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3820 Personal mmh data is grouped by type, resulting in two distinct parts:
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
3821 the mail storage and the configuration.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3822 In mmh, the mail storage directory still contains all the messages,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3823 but, in exception of public sequences files, nothing else.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3824 In difference to nmh, the auxiliary configuration files are no longer
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3825 located there.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3826 Therefore, the directory is no longer called the user's \fIMH directory\fP
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3827 but his \fImail storage\fP.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3828 Its location is still user-chosen, with the default name
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3829 .Fn Mail ,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3830 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3831 In mmh, the configuration is grouped together in
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3832 the hidden directory
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3833 .Fn \&.mmh
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3834 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3835 This \fImmh directory\fP contains the context file, personal forms,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3836 scan formats, and the like, but also the user's profile, now named
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3837 .Fn profile .
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3838 The location of the profile is no longer fixed to
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3839 .Fn $HOME/.mh_profile
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3840 but to
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3841 .Fn $HOME/.mmh/profile .
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3842 Having both the file
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3843 .Fn $HOME/.mh_profile
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3844 and the configuration directory
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3845 .Fn $HOME/.mmh
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3846 appeared to be inconsistent.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3847 The approach chosen for mmh is consistent, simple, and familiar to
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3848 Unix users.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3849 .Ci 7030d7edb099bff36ded7548bb5380f7acab4f9b
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3850 .P
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3851 MH allows users to have multiple MH setups.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3852 Therefore, it is necessary to select a different profile.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3853 The profile is the single entry point to access the rest of a
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3854 personal MH setup.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3855 In nmh, the environment variable
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3856 .Ev MH
200
c299ed65d015 Spell checked.
markus schnalke <meillo@marmaro.de>
parents: 199
diff changeset
3857 could be used to specify a different profile.
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3858 To operate in the same MH setup with a separate context,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3859 the
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3860 .Ev MHCONTEXT
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3861 environment variable could be used.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3862 This allows having own current folders and current messages in
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3863 each terminal, for instance.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3864 In mmh, three environment variables are used.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3865 .Ev MMH
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3866 overrides the default location of the mmh directory (\c
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3867 .Fn .mmh ).
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3868 .Ev MMHP
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3869 and
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3870 .Ev MMHC
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3871 override the paths to the profile and context files, respectively.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3872 This approach allows the set of personal configuration files to be chosen
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3873 independently from the profile, context, and mail storage.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
3874 .Ci 7030d7edb099bff36ded7548bb5380f7acab4f9b
133
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3875 .P
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3876 The separation of the files by type is sensible and convenient.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3877 The new approach has no functional disadvantages,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3878 as every setup I can imagine can be implemented with both approaches,
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3879 possibly even easier with the new approach.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3880 The main achievement of the change is the clear and sensible split
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3881 between mail storage and configuration.
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3882
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3883
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3884
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3885
02660c14f6a8 Further re-ordering of the sections.
markus schnalke <meillo@marmaro.de>
parents: 131
diff changeset
3886
118
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3887 .H2 "Modularization
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style.
markus schnalke <meillo@marmaro.de>
parents: 116
diff changeset
3888 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3889 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
3890 .Fn uip
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3891 (``user interface programs'') directory.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3892 Each tool has a source file with the name of the command.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3893 For example,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3894 .Pn rmm
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3895 is built from
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3896 .Fn uip/rmm.c .
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3897 Some source files are used for multiple programs.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3898 For example
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3899 .Fn uip/scansbr.c
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
3900 is used for both
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3901 .Pn scan
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3902 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3903 .Pn inc .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3904 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
3905 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
3906 32 programs depended on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3907 17 programs depended on one source file only.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3908 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
3909 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
3910 18 programs depend on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3911 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
3912 (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
3913 as well as shell scripts and multiple names for the same program.)
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3914 .\" XXX graph
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3915 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3916 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
3917 increase the readability of its source code.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3918 .\" XXX however?
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3919 Most of the mmh tools are simple and straight-forward programs.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3920 With the exception of the MIME handling tools,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3921 .Pn pick
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
3922 is the largest tool.
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
3923 It contains 1\|037 lines of source code, excluding the MH library.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3924 Only the MIME handling tools (\c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3925 .Pn mhbuild ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3926 .Pn mhstore ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3927 .Pn show ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3928 etc.)
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3929 are larger.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3930 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
3931 source files seldom leads to better readability.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3932 For such tools, splitting makes sense
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3933 when parts of the code are reused in other programs,
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
3934 and the reused code fragment is (1) not general enough
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
3935 for including it in the MH library
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
3936 or (2) has dependencies on a library that only few programs need.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3937 .Fn uip/packsbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3938 for instance, provides the core program logic for the
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3939 .Pn packf
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3940 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3941 .Pn rcvpack
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3942 programs.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3943 .Fn uip/packf.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3944 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3945 .Fn uip/rcvpack.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3946 mainly wrap the core function appropriately.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3947 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
3948 As another example,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3949 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3950 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
3951 curses library.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3952 Including
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3953 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3954 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
3955 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
3956 .P
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3957 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
3958 into multiple source files improves the readability.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3959 The program
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3960 .Pn mhstore ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3961 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
3962 lines of code in summary.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3963 The main code file
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3964 .Fn uip/mhstore.c
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3965 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
3966 other MIME handling tools.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3967 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
3968 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
3969 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
3970 .P
169
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate.
markus schnalke <meillo@marmaro.de>
parents: 168
diff changeset
3971 The work already accomplished focussed on the non-MIME tools.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3972 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
3973 This eases the understanding of the code base.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3974 In nmh,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3975 .Pn comp
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3976 was built from six source files:
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3977 .Fn comp.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3978 .Fn whatnowproc.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3979 .Fn whatnowsbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3980 .Fn sendsbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3981 .Fn annosbr.c ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3982 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3983 .Fn distsbr.c .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3984 In mmh, it builds from only two:
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3985 .Fn comp.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3986 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3987 .Fn whatnowproc.c .
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3988 In nmh's
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3989 .Pn comp ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3990 the core function of
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3991 .Pn whatnow ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3992 .Pn send ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3993 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3994 .Pn anno
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3995 were compiled into
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3996 .Pn comp .
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
3997 This saved the need to execute these programs with
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3998 .Fu fork()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
3999 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4000 .Fu exec() ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4001 two expensive system calls.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
4002 Whereas this approach improved the time performance,
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
4003 it interwove the source code.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4004 Core functionalities were not encapsulated into programs but into
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4005 function, which were then wrapped by programs.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4006 For example,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4007 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4008 included the function
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4009 .Fu annotate() .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4010 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
4011 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4012 and called
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4013 .Fu annotate() .
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4014 Because the function
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4015 .Fu annotate()
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4016 was used like the tool
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4017 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4018 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
4019 When another pair of command line switches was added to
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4020 .Pn anno ,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4021 a rather ugly hack was implemented to avoid adding another parameter
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4022 to the function.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4023 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4024 .P
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4025 Separation simplifies the understanding of program code
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4026 because the area influenced by any particular statement is smaller.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4027 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
4028 on the function level.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4029 In mmh, the relevant code of
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4030 .Pn comp
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4031 comprises the two files
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4032 .Fn uip/comp.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4033 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4034 .Fn uip/whatnowproc.c ,
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4035 together 210 lines of code.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4036 In nmh,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4037 .Pn comp
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4038 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
4039 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
4040 .Pn comp ,
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4041 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
4042 parts were used.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4043 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4044 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
4045 I learned about the easy and the difficult parts.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
4046 Code is easy to understand if the influenced code area is small
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
4047 and its boundaries are strictly defined.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
4048 Furthermore, the code needs to solve the problem in a straight-forward way.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4049 .P
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4050 .\" XXX move this paragraph somewhere else?
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4051 Reading
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4052 .Pn rmm 's
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4053 source code in
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4054 .Fn uip/rmm.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4055 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
4056 The reasons are that the task of
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4057 .Pn rmm
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4058 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
4059 yet its source includes code constructs typical for MH tools.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4060 With the introduction of the trash folder in mmh,
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4061 .Pn rmm
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4062 became a bit more complex, because it invokes
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4063 .Pn refile .
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4064 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
4065 .P
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4066 Understanding
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4067 .Pn comp
180
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
4068 .\" XXX kate fragen: more vs. as much
731e747a805b Applied corrections by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 179
diff changeset
4069 requires to read 210 lines of code in mmh, but ten times more in nmh.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4070 Due to the aforementioned hack in
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4071 .Pn anno
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4072 to save the additional parameter, information passed through the program's
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4073 source base in obscure ways.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4074 Thus, understanding
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4075 .Pn comp ,
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4076 required understanding the inner workings of
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4077 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4078 first.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4079 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
4080 to be examined.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4081 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
4082 have avoided obscure programming techniques.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4083 By separating the tools on the program-level, the boundaries are
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4084 clearly visible and technically enforced.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4085 The interfaces are calls to
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4086 .Fu exec()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4087 rather than arbitrary function calls.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4088 .P
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4089 But the real problem is another:
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4090 Nmh violates the golden ``one tool, one job'' rule of the Unix philosophy.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
4091 .\" XXX ref
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4092 Understanding
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4093 .Pn comp
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4094 requires understanding
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4095 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4096 and
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4097 .Fn uip/sendsbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4098 because
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4099 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4100 does annotate and send messages.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4101 In nmh, there surely exists the tool
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4102 .Pn send ,
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
4103 which does mainly send messages.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4104 But
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4105 .Pn comp
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4106 and
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4107 .Pn repl
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4108 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4109 .Pn forw
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4110 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4111 .Pn dist
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4112 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4113 .Pn whatnow
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4114 and
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4115 .Pn viamail ,
179
b59201e345e5 Applied further corrections by Aaron.
markus schnalke <meillo@marmaro.de>
parents: 178
diff changeset
4116 they all (!) have the same message sending function included, as well.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4117 In result,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4118 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4119 sends messages without using
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4120 .Pn send .
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4121 The situation is the same as if
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4122 .Pn grep
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4123 would page without
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4124 .Pn more
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4125 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
4126 .P
173
4c7db172fb59 Various corrections and improvements.
markus schnalke <meillo@marmaro.de>
parents: 171
diff changeset
4127 The clear separation on the surface \(en the tool chest approach \(en
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4128 is violated on the level below.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4129 This violation is for the sake of time performance.
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4130 On systems where
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4131 .Fu fork()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4132 and
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4133 .Fu exec()
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4134 are expensive, the quicker response might be noticable.
124
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
4135 In the old times, sacrificing readability and conceptional beauty for
3d30fd938aa9 Spellchecking.
markus schnalke <meillo@marmaro.de>
parents: 123
diff changeset
4136 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
4137 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
4138 No longer should we sacrifice readability or conceptional beauty.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4139 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
4140 guideline.
181
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc
markus schnalke <meillo@marmaro.de>
parents: 180
diff changeset
4141 .\" XXX ref
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4142 No longer should we keep speed improvements that became unnecessary.
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4143 .P
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4144 Therefore, mmh's
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4145 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4146 does no longer send messages.
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4147 In mmh, different jobs are divided among separate programs that
122
c234656329e0 Wrote about modularization.
markus schnalke <meillo@marmaro.de>
parents: 121
diff changeset
4148 invoke each other as needed.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4149 In consequence,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4150 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4151 invokes
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4152 .Pn whatnow
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4153 which thereafter invokes
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4154 .Pn send .
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4155 .Ci 3df5ab3c116e6d4a2fb4bb5cc9dfc5f781825815
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4156 .Ci c73c00bfccd22ec77e9593f47462aeca4a8cd9c0
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4157 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
4158 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
4159 annotations, for example, are made by invoking
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4160 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4161 no matter if requested by programs or by human beings.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4162 .Ci 469a4163c2a1a43731d412eaa5d9cae7d670c48b
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4163 .Ci aed384169af5204b8002d06e7a22f89197963d2d
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4164 .Ci 3caf9e298a8861729ca8b8a84f57022b6f3ea742
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4165 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
4166 the decrease of
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4167 .Fn uip/*sbr.c
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4168 files confirm the improvement.
168
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4169 .Ci 9e6d91313f01c96b4058d6bf419a8ca9a207bc33
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4170 .ci 81744a46ac9f845d6c2b9908074d269275178d2e
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4171 .Ci f0f858069d21111f0dbea510044593f89c9b0829
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4172 .Ci 0503a6e9be34f24858b55b555a5c948182b9f24b
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4173 .Ci 27826f9353e0f0b04590b7d0f8f83e60462b90f0
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4174 .Ci d1da1f94ce62160aebb30df4063ccbc53768656b
277eeb5ba223 Applied suggestions by Lydi.
markus schnalke <meillo@marmaro.de>
parents: 166
diff changeset
4175 .Ci c42222869e318fff5dec395eca3e776db3075455
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4176 .P
145
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4177 .\" XXX move this paragraph up somewhere
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4178 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
4179 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
4180 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
4181 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
4182 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
4183 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
4184 These errors will not be detected at compile time but at run time.
171
346ff7e201f5 Applied suggestions by Boris.
markus schnalke <meillo@marmaro.de>
parents: 169
diff changeset
4185 Installing regression tests is a pending task.
123
740f4128dea7 Reworked and extended the text about Modularization.
markus schnalke <meillo@marmaro.de>
parents: 122
diff changeset
4186 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
4187 can be developed to allow automated testing at compile time.
145
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4188
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4189
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4190 .ig
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4191 XXX consider writing about mhl vs. mhlproc
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4192
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4193 sbr/showfile.c
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4194
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4195 23 /*
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4196 24 ** If you have your lproc listed as "mhl",
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4197 25 ** then really invoked the mhlproc instead
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4198 26 ** (which is usually mhl anyway).
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4199 27 */
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4200
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4201 Sat Nov 24 19:09:14 1984 /mtr (agent: Marshall Rose) <uci@udel-dewey>
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4202
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4203 sbr/showfile.c: if lproc is "mhl", use mhlproc for consistency
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4204 (Actually, user should use "lproc: show", "showproc: mhl".)
3361e53dfcd6 Added comments and a source quote.
markus schnalke <meillo@marmaro.de>
parents: 139
diff changeset
4205 ..