docs/master: discussion.roff annotate

annotate discussion.roff @ 226:27c28990b844

Added quote by Steve Johnson.

author	markus schnalke <meillo@marmaro.de>
date	Sun, 15 Jul 2012 21:57:51 +0200
parents	d83ab437e3a6
children	157c92fc1597

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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	5 It is structured along the goals chosen for the project.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	6 A selection of the work undertaken
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	7 is described.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	8 .P
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	9 This discussion compares the present version of mmh with the state of
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	10 nmh at the time when the mmh project had started, i.e. fall 2011.
224 b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	11 Recent changes in nmh are rarely part of the discussion.
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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	14 is depicted in the following figure.
187 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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	16
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	17 .sp 1.5
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	18 .KS
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	19 .in 2c
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	20 .so input/mail-agents.pic
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	21 .KE
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	22 .sp 1.5
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	23
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	24 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	25 The ellipses denote mail agents, i.e. different jobs in email processing.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	26 These are:
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	27 .IP "Mail User Agent (MUA)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	28 The only program users directly interact with.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	29 It includes functions to compose new mail, display received mail,
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	30 and to manage the mail storage.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	31 It is called a \fImail client\fP as well.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	32 .IP "Mail Submission Agent (MSA)
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	33 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	34 mail transport system.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	35 Often it is also called an MTA.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	36 .IP "Mail Transfer Agent (MTA)
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	37 A node in the mail transport system.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	38 It transfers incoming mail to a transport node nearer to the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	39 final destination.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	40 An MTA may be the final destination itself.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	41 .IP "Mail Delivery Agent (MDA)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	42 Delivers mail according to a set of rules.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	43 Usually, the messages are stored to disk.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	44 .IP "Mail Retrieval Agent (MRA)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	45 Initiates the transfer of mail from a remote location to the local machine.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	46 (The dashed arrow in the figure represents the pull request.)
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	47 .LP
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	48 The dashed boxes represent entities that usually reside on single machines.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	49 The box on the lower left represents the sender's system.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	50 The box on the upper left represents the first mail transfer node.
224 b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	51 The box on the upper right represents the transfer node responsible
b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	52 for the destination address.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	53 The box on the lower right represents the recipient's system.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	54 Often, the boxes above the dotted line are servers on the Internet.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	55 Many mail clients, including nmh, include all of the components below
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	56 the dotted line.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	57 This is not the case for mmh; it implements the MUA only.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	58
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	59
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	60
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	61
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	62
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	63
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	64 .\" --------------------------------------------------------------
125 0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/ markus schnalke <meillo@marmaro.de> parents: 124 diff changeset	65 .H1 "Streamlining
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	66
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	67 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	68 MH once provided a complete email system.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	69 The community around nmh tries to keep nmh in similar shape.
178 520b3c7abba1 s/a MUA/an MUA/ markus schnalke <meillo@marmaro.de> parents: 177 diff changeset	70 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	71 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	72 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	73 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	74 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	75 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	76 Excellent implementations for the various aspects of email already exist.
223 1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	77 Just to name three examples: Postfix is a specialized MTA, Procmail
1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	78 is a specialized MDA, and Fetchmail is a specialized MRA.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	79 I believe that it is best to use such specialized tools instead of
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	80 providing the same function once more as a side component.
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	81 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	82 Doing something well requires focusing on a small set of specific aspects.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	83 Under the assumption that development which is focussed on a particular
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	84 area 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	85 in their field of focus.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	86 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	87 or modular \(en will never be the best choice in any of the fields.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	88 Even in providing the most consistent all-in-one system, they are likely
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	89 to be beaten by projects that focus exclusively on the creation
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	90 of a homogeneous system by integrating existing mail components.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	91 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	92 Usually, the limiting resource in the community development of
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	93 free software is man power.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	94 If the development effort is spread over a large development area,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	95 it becomes more difficult to compete with the specialists in the
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	96 various fields.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	97 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	98 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	99 .P
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	100 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	101 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	102 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	103 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	104
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	105
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	106 .H2 "Mail Transfer Facilities
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	107 .Id mail-transfer-facilities
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	108 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	109 The removal of the mail transfer facilities, effectively dropping the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	110 MSA and MRA, had been the first work task in the mmh project.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	111 The desire for this change initiated the creation of 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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	115 He identified the limitation of Sendmail
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	116 to the MTA task as one reason for its success:
105 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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	123 This was a departure of the dominant thought of the time,
105 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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	131 command, establishes 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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	133 When email transfer changed, this part needed to be changed 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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	136 This added complexity without improving the core functions.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	137 Furthermore, keeping up with recent developments in the field of
87 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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 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.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	144 All outgoing mail in mmh goes through the
60 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.
223 1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	151 For example, a wrapper script for qmail would be:
87 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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	157 may be removed in the future.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	158 Mmh could 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.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	160 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	161 To retrieve mail, the
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	162 .Pn inc
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	163 command in nmh acts as MRA.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	164 It establishes network connections
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	165 and speaks POP3 to retrieve mail from remote servers.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	166 As with mail submission, the network connections required encryption and
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	167 authentication, thus TLS and SASL were added to nmh.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	168 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	169 additions, too, and likewise for any other changes in mail transfer.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	170 But not in mmh because it has dropped the support for retrieving mail
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	171 from remote locations
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	172 .Ci ab7b48411962d26439f92f35ed084d3d6275459c .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	173 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	174 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	175 (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	176 .Pn inc
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	177 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	178 .Pn rcvstore
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	179 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	180 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	181 With the removal of the MSA and MRA, mmh converted from a complete
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	182 mail system to only an MUA.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	183 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	184 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	185 an external MRA is required to retrieve mail from remote machines.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	186 Excellent implementations of such software exist.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	187 They likely are superior to the internal versions that were removed.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	188 Additionally, the best suiting programs can be chosen freely.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	189 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	190 As it had already been possible to use an external MSA and MRA,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	191 why should the internal version not be kept for convenience?
224 b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	192 Transfered to a different area, the question,
b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	193 whether there is sense in having a fall-back pager in all
b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	194 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	195 .Pn more
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	196 or
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	197 .Pn less
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	198 are not available, appears to be ridiculous.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	199 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	200 and not necessarily available but still the concept of orthogonal
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	201 design holds: ``Write programs that do one thing and do it well''.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	202 .[
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	203 mcilroy unix phil
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	204 p. 53
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	205 .]
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 mcilroy bstj foreword
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	208 .]
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	209 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	210 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	211 In other words:
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	212 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	213 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	214 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	215 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	216 separate projects then they should be separated.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	217 In my opinion, this is the case.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	218 The RFCs suggest this separation by clearly distinguishing the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	219 different mail handling tasks [RFC\\|821].
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	220 The small interfaces between the mail agents support the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	221 separation as well.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	222 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	223 Once, email 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.
224 b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	228 (Essential complexity is the complexity defined by the problem itself
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	229 .[ [
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	230 brooks no silver bullet
224 b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	231 .]].)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	232 Consequently, email systems 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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	234 various roles because they became more extensive and because
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	235 new roles appeared.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	236 As mail system implementations grew, parts of them were split off.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	237 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	238 it was removed in nmh.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	239 Now is the time to go one step further and split off the MSA and MRA,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	240 as well.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	241 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	242 more importantly, it unburdens mmh of the whole field of
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	243 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	244 There is no more need for concern with changes in network transfer.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	245 This independence is gained by depending on external components
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	246 that cover the field.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	247 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	248 In general, 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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	250 By 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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	252 By 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
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	254 By 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
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	256 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	257 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	258 and development work,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	259 it keeps the project's dependence on other software lowest.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	260 Using libraries or external programs requires less maintenance work
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	261 but introduces dependencies on external projects.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	262 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	263 but possibly limit the information exchange.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	264 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	265 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	266 Adding code to a project increases maintenance work.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	267 As implementing complex functions in the project itself adds
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	268 a lot of code, this should be avoided if possible.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	269 Thus, the dependencies only change in their character,
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	270 not in their existence.
66 4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	271 In mmh, library dependencies on
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	272 .Pn libsasl2
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	273 and
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	274 .Pn libcrypto /\c
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	275 .Pn libssl
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	276 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	277 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	278 dependencies.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	279 Besides providing stronger separation and greater flexibility,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	280 program dependencies also allowed
66 4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	281 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	282 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	283 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	284 losing functionality is a convincing argument.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	285 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	286 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	287 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	288 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	289 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	290 of available documentation.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	291
223 1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	292 Choices for MSAs range from small forwarders such as \fIssmtp\fP and
1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	293 \fInullmailer\fP, over mid-size MTAs including \fImasqmail\fP and
1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	294 \fIdma\fP, up to full-featured MTAs as for instance \fIPostfix\fP.
1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	295 MRAs are provided for example by \fIfetchmail\fP, \fIgetmail\fP,
1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	296 \fImpop\fP, and \fIfdm\fP.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	297
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	298
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	299 .H2 "Non-MUA Tools
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	300 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	301 One goal of mmh is to remove the tools that do not significantly
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	302 contribute to the MUA's job.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	303 Loosely related and rarely used tools distract from a lean appearance,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	304 and require maintenance work without adding much to the core task.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	305 By removing these tools, mmh became more streamlined and focused.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	306 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	307 .Pn conflict
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	308 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	309 .Ci 8b235097cbd11d728c07b966cf131aa7133ce5a9
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	310 because it is a mail system maintenance tool and not MUA-related.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	311 It even checked
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	312 .Fn /etc/passwd
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	313 and
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	314 .Fn /etc/group
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	315 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	316 A tool like
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	317 .Pn conflict
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	318 is surely useful, but it should not be shipped with mmh.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	319 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	320 .Pn rcvtty
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	321 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	322 .Ci 14767c94b3827be7c867196467ed7aea5f6f49b0
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	323 because its use case of writing to the user's terminal
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	324 on reception of mail is obsolete.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	325 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	326 .Ev MAILPATH
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	327 variable or graphical notifications are technically more appealing.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	328 Writing to terminals directly is hardly ever desired today.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	329 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	330 .Pn write
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	331 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	332 .VS
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	333 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	334 VE
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	335 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	336 .Pn viamail
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	337 was removed
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	338 .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	339 when the new attachment system was activated, because
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	340 .Pn forw
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	341 could then cover the task itself.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	342 The program
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	343 .Pn sendfiles
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	344 was rewritten as a shell script wrapper around
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	345 .Pn forw .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	346 .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	347 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	348 .Pn msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	349 was removed
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	350 .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe ,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	351 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	352 A call to
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	353 .Pn msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	354 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	355 .VS
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	356 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	357 VE
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	358 Yet, it distinguished between old and new mail, but
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	359 these details can be retrieved with
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	360 .Pn stat (1),
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	361 too.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	362 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	363 in a similar way, if truly necessary.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	364 As mmh's
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	365 .Pn inc
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	366 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	367 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	368 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	369 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	370 .Pn msh
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	371 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	372 .Ci 916690191222433a6923a4be54b0d8f6ac01bd02
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	373 because the tool was in conflict with the philosophy of MH.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	374 It provided an interactive shell to access the features of MH.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	375 However, it was not just a shell tailored to the needs of mail handling,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	376 but one large program that had several MH tools built in.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	377 This conflicted with the major feature of MH of being a tool chest.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	378 .Pn msh 's
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	379 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	380 be popular.
24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	381 .P
24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	382 Removing
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	383 .Pn msh
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	384 together with the truly archaic code relics
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	385 .Pn vmh
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	386 and
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	387 .Pn wmh
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	388 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	389 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	390 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	391 for the same functionality is an advantage.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	392 Less code means less bugs and less maintenance work.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	393 As
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	394 .Pn rcvtty
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	395 and
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	396 .Pn msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	397 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	398 why should one keep them?
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	399 Removing them streamlined mmh.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	400 .Pn viamail 's
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	401 use case is now partly obsolete and partly covered by
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	402 .Pn forw ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	403 hence there is no reason to still maintain it.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	404 .Pn conflict
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	405 is not related to the mail client, and
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	406 .Pn msh
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	407 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	408 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	409 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	410 .Id slocal
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	411 Finally, there is
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	412 .Pn slocal ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	413 which is an MDA and thus not directly MUA-related.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	414 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	415 the idea that mmh is an MUA only.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	416 However,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	417 .Pn slocal
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	418 provides rule-based processing of messages, like filing them into
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	419 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	420 Although
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	421 .Pn slocal
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	422 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	423 technical area (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	424 .Cf mail-transfer-facilities ),
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	425 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	426 As
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	427 .Pn slocal
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	428 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	429 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	430 .Pn slocal .
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	431 For anyone not using MH,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	432 .Pn slocal
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	433 would become yet another independent MDA, like
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	434 .I procmail .
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	435 Then
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	436 .Pn slocal
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	437 could be installed without a complete MH system.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	438 Likewise, mmh users could decide to use
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	439 .I procmail
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	440 without having a second, unused MDA, i.e.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	441 .Pn slocal ,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	442 installed.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	443 That appears to be conceptionally the best solution.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	444 Yet,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	445 .Pn slocal
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	446 is not split off.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	447 I defer the decision over
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	448 .Pn slocal
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	449 out of a need for deeper investigation.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	450 In the meanwhile, it remains part of mmh
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	451 as its continued existence is not significant;
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	452 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	453 is unrelated to the rest of the project.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	454
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	455
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	456
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	457 .H2 "Displaying Messages
155 75f20c925999 Fixed macro typo; and added typo fix found by Boris. markus schnalke <meillo@marmaro.de> parents: 154 diff changeset	458 .Id mhshow
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	459 .P
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	460 Since the very beginning, already in the first concept paper,
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	461 .Pn show
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	462 had been MH's message display program.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	463 .Pn show
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	464 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	465 .Pn mhl
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	466 to have the files formatted.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	467 With MIME, this approach was not sufficient anymore.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	468 MIME messages can consist of multiple parts.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	469 Some parts, like binary attachments or text content in foreign charsets,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	470 are not directly displayable.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	471 .Pn show 's
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	472 understanding of messages and
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	473 .Pn mhl 's
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	474 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	475 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	476 Instead of extending these tools, additional tools were written from
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	477 scratch and were added to the MH tool chest.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	478 Doing so is encouraged by the tool chest approach.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	479 Modular design is a great advantage for extending a system,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	480 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	481 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	482 .Pn mhn .
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	483 The command
82 ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment. markus schnalke <meillo@marmaro.de> parents: 78 diff changeset	484 .Cl "mhn -show 42
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	485 had then shown the message number
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	486 .Fn 42 ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	487 interpreting MIME.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	488 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	489 the split of
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	490 .Pn mhn
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	491 into a set of specialized tools, which together covered the
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	492 multiple aspects of MIME.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	493 One of them was
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	494 .Pn mhshow ,
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	495 which replaced
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	496 .Cl "mhn -show" .
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	497 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	498 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	499 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	500 .Pn show
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	501 and
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	502 .Pn mhshow .
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	503 To ease the life of users,
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	504 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	505 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	506 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	507 if displaying the message would be beyond
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	508 .Pn show 's
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	509 abilities.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	510 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	511 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	512 (possibly through
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	513 .Pn next
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	514 or
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	515 .Pn prev )
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	516 and get the message printed with either
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	517 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	518 or
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	519 .Pn mhshow ,
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	520 whatever was more appropriate.
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	521 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	522 Having two similar tools for basically the same task is redundancy.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	523 Usually, users do not distinguish between
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	524 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	525 and
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	526 .Pn mhshow
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	527 in their daily mail reading.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	528 Having two separate display programs was therefore unnecessary
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	529 from a user's point of view.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	530 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	531 to ensure that the programs behaved in a similar way,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	532 because they were used like a single tool.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	533 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	534 .P
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	535 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	536 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	537 As
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	538 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	539 already had 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	540 to drop
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	541 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	542 in favor of using
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	543 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	544 exclusively
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	545 .Ci 4c1efddfd499300c7e74263e57d8aa137e84c853 .
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	546 Removing
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	547 .Pn show
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	548 is no loss in function, because
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	549 .Pn mhshow
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	550 covers it completely.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	551 Yet, the old behavior of
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	552 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	553 can still be emulated with the simple command line:
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	554 .VS
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	555 mhl `mhpath c`
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	556 VE
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	557 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	558 For convenience,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	559 .Pn mhshow
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	560 was renamed to
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	561 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	562 after
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	563 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	564 was gone.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	565 It is clear that such a rename may confuse future developers when
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	566 trying to understand the history.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	567 Nevertheless, I consider the convenience on the user's side,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	568 to outweigh the inconvenience for understanding the evolution
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	569 of the tools.
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	570 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	571 To prepare for the transition,
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	572 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	573 was reworked to behave more like
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	574 .Pn show
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	575 first (cf. Sec.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	576 .Cf mhshow ).
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	577 Once the tools behaved more alike, the replacing appeared to be
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	578 even more natural.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	579 Today, mmh's new
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	580 .Pn show
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	581 has become the one single message display program once again,
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	582 with the difference
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	583 that today it handles MIME messages as well as non-MIME messages.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	584 The outcomes of the transition are one program less to maintain,
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	585 no second display program for users to deal with,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	586 and less system complexity.
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	587 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	588 Still, removing the old
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	589 .Pn show
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	590 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	591 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	592 .Pn show ,
225 d83ab437e3a6 Removed FIXMEs (XXX) in the sources, those that I won't fix. markus schnalke <meillo@marmaro.de> parents: 224 diff changeset	593 but there is no alternative;
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	594 supporting MIME demands higher essential complexity.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	595
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	596
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	597
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	598 .H2 "Configure Options
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	599 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	600 Customization is a double-edged sword.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	601 It allows better suiting setups, but not for free.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	602 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	603 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	604 more possible setups and especially corner cases.
226 27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	605 Steve Johnson confirms:
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	606 .[ [
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	607 eric raymond the art of unix programming
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	608 .], p. 233]
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	609 .QS
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	610 Unless it is done very carefully, the addition of an on/off
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	611 configuration option can lead to a need to double the amount of
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	612 testing. Since in practice one never does double the amount of testing,
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	613 the practical effect is to reduce the amount of testing that any
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	614 given configuration receives. Ten options leads to 1024 times as much
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	615 testing, and pretty soon you are talking real reliability problems.
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	616 .QE
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	617 .LP
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	618 Additionally, there is the cost of choice itself.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	619 The code complexity directly affects the developers.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	620 Less tested code affects both users and developers.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	621 The problem of choice affects the users, for once by having to choose
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	622 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	623 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	624 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	625 I have reduced the number of project-specific configure options from
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	626 15 to 3.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	627
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	628 .U3 "Mail Transfer Facilities
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	629 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	630 With the removal of the mail transfer facilities 5 configure
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	631 options vanished:
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	632 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	633 The switches
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	634 .Sw --with-tls
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	635 and
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	636 .Sw --with-cyrus-sasl
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	637 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	638 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	639 .\" XXX gruende kurz wiederholen
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	640 They are not needed anymore.
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	641 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	642 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	643 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	644 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	645 .\" XXX ``For the same reason ...''
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	646 The configure switch
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	647 .Sw --enable-pop
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	648 activated the message retrieval facility.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	649 Whereas the code area that had been conditionally compiled in
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	650 for TLS and SASL support was small,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	651 the conditionally compiled code area for POP support was much larger.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	652 The code base had only changed slightly on toggling TLS or SASL
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	653 support but it had changed much on toggling POP support.
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	654 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	655 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	656 one that needed to be tested.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	657 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	658 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	659 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	660 of the original program.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	661 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	662 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	663 Two other options only specified default configuration values:
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	664 .Sw --with-mts
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	665 defined the default transport service
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	666 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226 .
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	667 With
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	668 .Sw --with-smtpservers
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	669 default SMTP servers could be specified
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	670 .Ci 128545e06224233b7e91fc4c83f8830252fe16c9 .
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	671 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	672 In mmh, all messages are handed over to
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	673 .Pn sendmail
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	674 for transportation.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	675
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	676
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	677 .U3 "Backup Prefix
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	678 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	679 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	680 filenames to tag them as deleted.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	681 By default it had been the comma character (`\fL,\fP').
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	682 In July 2000, Kimmo Suominen introduced
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	683 the configure option
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	684 .Sw --with-hash-backup
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	685 to change the default to the hash character `\f(CW#\fP'.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	686 This choice was probably personal preference, but,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	687 being related or not, words that start with the hash character
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	688 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	689 Thus, the command line
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	690 .Cl "rm #13 #15
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	691 calls
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	692 .Pn rm
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	693 without arguments because the first hash character starts a comment
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	694 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	695 To delete the backup files,
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	696 .Cl "rm ./#13 ./#15"
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	697 needs to be used.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	698 Thus, using the hash as backup prefix may be seen as a precaution
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	699 against backup loss.
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	700 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	701 First, I removed the configure option but added the profile entry
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	702 .Pe Backup-Prefix ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	703 which allowed to specify an arbitrary string as backup prefix
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	704 .Ci 6c40d481d661d532dd527eaf34cebb6d3f8ed086 .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	705 This change did not remove the choice but moved it to a location where
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	706 it suited better, in my eyes.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	707 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	708 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	709 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	710 .Cf trash-folder )
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	711 removed the need for the backup prefix completely.
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	712 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	713 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	714
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	715
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	716 .U3 "Editor and Pager
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	717 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	718 The two configure options
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	719 .CW --with-editor=EDITOR
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	720 .CW --with-pager=PAGER
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	721 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	722 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	723 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	724 different systems.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	725 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	726 The programs
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	727 .Pn vi
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	728 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	729 .Pn more
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	730 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	731 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	732 (The specifications for
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	733 .Pn vi
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	734 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	735 .Pn more
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	736 appeared in
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	737 .[
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	738 posix 1987
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	739 .]
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	740 and,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	741 .[
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	742 posix 1992
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	743 .]
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	744 respectively.)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	745 As a first step, these two tools were hard-coded as defaults
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	746 .Ci 5d43a99db70c12a673028c7758c20cbe3e13ef5f .
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	747 Not changed were the
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	748 .Pe editor
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	749 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	750 .Pe moreproc
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	751 profile entries, which allowed the user to override the system defaults.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	752 Later, the concept was reworked again to respect the standard
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	753 environment variables
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	754 .Ev VISUAL
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	755 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	756 .Ev PAGER
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	757 if they are set.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	758 Today, mmh determines the editor to use in the following order,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	759 taking the first available and non-empty item
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	760 .Ci f85f4b7ae62e3d05a945dcd46ead51f0a2a89a9b :
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	761 .LI 1
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	762 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	763 .Ev MMHEDITOR
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	764 .LI 2
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	765 Profile entry
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	766 .Pe Editor
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	767 .LI 3
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	768 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	769 .Ev VISUAL
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	770 .LI 4
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	771 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	772 .Ev EDITOR
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	773 .LI 5
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	774 Command
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	775 .Pn vi .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	776 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	777 The pager to use is determined in a similar order
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	778 .Ci 0c4214ea2aec6497d0d67b436bbee9bc1d225f1e :
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	779 .LI 1
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	780 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	781 .Ev MMHPAGER
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	782 .LI 2
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	783 Profile entry
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	784 .Pe Pager
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	785 (replaces
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	786 .Pe moreproc )
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	787 .LI 3
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	788 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	789 .Ev PAGER
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	790 .LI 4
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	791 Command
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	792 .Pn more .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	793 .LP
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	794 By respecting the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	795 .Ev VISUAL /\c
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	796 .Ev EDITOR
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	797 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	798 .Ev PAGER
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	799 environment variables,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	800 the new behavior complies with the common style on Unix systems.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	801 It is more uniform and clearer for users.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	802
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	803
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	804 .U3 "ndbm
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	805 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	806 .Pn slocal
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	807 used to depend on the database library
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	808 .I ndbm .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	809 The database is used to store the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	810 .Hd Message-ID
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	811 header field values of all messages delivered.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	812 This enabled
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	813 .Pn slocal
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	814 to suppress delivering the same message to the same user twice.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	815 This features was enabled by the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	816 .Sw -suppressdup
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	817 switch.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	818 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	819 As a variety of versions of the database library exist,
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	820 .[
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	821 wolter unix incompat notes dbm
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	822 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	823 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	824 Furthermore, the configure switches
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	825 .Sw --with-ndbm=ARG
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	826 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	827 .Sw --with-ndbmheader=ARG
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	828 were added to help with difficult setups that would
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	829 not be detected automatically or not correctly.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	830 .P
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	831 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	832 .Pn slocal ,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	833 the dependency on
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	834 .I ndbm
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	835 vanished and 120 lines of complex autoconf code could be saved
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	836 .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	837 The change removed functionality but that is considered minor to the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	838 improvement of dropping the dependency and the complex autoconf code.
225 d83ab437e3a6 Removed FIXMEs (XXX) in the sources, those that I won't fix. markus schnalke <meillo@marmaro.de> parents: 224 diff changeset	839
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	840
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	841 .U3 "MH-E Support
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	842 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	843 The configure option
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	844 .Sw --disable-mhe
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	845 was removed when the MH-E support was reworked.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	846 MH-E is the Emacs front-end to MH.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	847 It requires MH to provide minor additional functions.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	848 The
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	849 .Sw --disable-mhe
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	850 configure option had switched off these extensions.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	851 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	852 only the
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	853 .Sw -build
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	854 switches of
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	855 .Pn forw
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	856 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	857 .Pn repl
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	858 are left to be MH-E extensions.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	859 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	860 In consequence, the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	861 .Sw --disable-mhe
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	862 configure option was removed
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	863 .Ci a7ce7b4a580d77b6c2c4d980812beb589aa4c643 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	864 Dropping the option also removed a variant of the code base
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	865 that would have needed to be tested.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	866 This change was undertaken in January 2012 in nmh and
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	867 thereafter merged into mmh.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	868
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	869
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	870 .U3 "Masquerading
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	871 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	872 The configure option
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	873 .Sw --enable-masquerade
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	874 could take up to three arguments:
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	875 .Ar draft_from ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	876 .Ar mmailid ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	877 and
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	878 .Ar username_extension .
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	879 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	880 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	881 .Pn post
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	882 command.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	883 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	884 this field anymore.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	885 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	886 .P
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	887 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	888 .I mmailid
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	889 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	890 available in the original MH.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	891 It provided a
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	892 .I username
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	893 to
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	894 .I fakeusername
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	895 mapping, based on the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	896 .Fn passwd 's
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	897 GECOS field.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	898 Nmh's man page
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	899 .Mp mh-tailor (5)
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	900 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	901 .QS
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	902 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	903 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	904 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	905 `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	906 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	907 ``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	908 .QE
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	909 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	910 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	911 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	912 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	913 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	914 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	915 mail software on the system.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	916 Hence, mmailid masquerading was removed.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	917 .Ci 0836c8000ccb34b59410ef1c15b1b7feac70ce5f
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	918 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	919 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	920 .I username_extension
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	921 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	922 specified by the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	923 .Ev USERNAME_EXTENSION
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	924 environment variable, to it.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	925 This provided support for the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	926 .I user-extension
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	927 feature of qmail
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	928 .[ [
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	929 sill qmail handbook
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	930 .], p. 141]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	931 and the similar
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	932 .I "plussed user
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	933 processing of Sendmail.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	934 .[ [
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	935 sendmail costales
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	936 .], p. 476]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	937 The decision to remove this username_extension masquerading
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	938 was motivated by the fact that
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	939 .Pn spost
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	940 had not supported it yet.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	941 Username extensions can be used in mmh, but less convenient.
225 d83ab437e3a6 Removed FIXMEs (XXX) in the sources, those that I won't fix. markus schnalke <meillo@marmaro.de> parents: 224 diff changeset	942 .\" XXX In the format file: %(getenv USERNAME_EXTENSION)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	943 .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	944 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	945 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	946 .I draft_from
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	947 masquerading type instructed
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	948 .Pn post
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	949 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	950 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	951 header field as SMTP envelope sender.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	952 Sender addresses could be replaced completely.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	953 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	954 with technical differences.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	955 As mmh does not transfer messages itself, the local MTA has final control
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	956 over the sender's address.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	957 Any masquerading mmh introduces may be reverted by the MTA.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	958 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	959 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	960 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	961 .Hd From
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	962 header field and thereby propose 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	963 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	964 address for use as envelope sender address.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	965 .Ci b14ea6073f77b4359aaf3fddd0e105989db9
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	966 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	967 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	968 message header (\c
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	969 .Pn sendmail 's
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	970 .Sw -t
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	971 switch).
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	972 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	973 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	974 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	975 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	976
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	977 .U3 "Remaining Options
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	978 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	979 Two configure options remain in mmh.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	980 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	981 .Sw --with-locking=[dot\|fcntl\|flock\|lockf] .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	982 The idea of removing all methods except the portable
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	983 .I "dot locking
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	984 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	985 requires deeper technical investigation into the topic.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	986 The other option,
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	987 .Sw --enable-debug ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	988 compiles the programs with debugging symbols.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	989 This option is likely to stay.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	990
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	991
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	992
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	993
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	994 .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	995 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	996 The command line switches of MH tools follow a style similar to
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	997 the X Window System style.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	998 The switches consist of a single dash (`\fL-\fP') followed by a word.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	999 For example
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1000 .Cl -truncate .
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1001 To ease typing, the word can be abbreviated, given the remaining
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1002 prefix is unambiguous.
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1003 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	1004 .Cl "-truncate" ,
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1005 .Cl "-trunc" ,
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1006 .Cl "-tr" ,
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1007 and
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1008 .Cl "-t
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1009 is equal.
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1010 As a result, switches can neither be grouped (as in
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1011 .Cl "ls -ltr" )
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1012 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	1013 .Cl "sendmail -q30m" ).
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1014 Many switches have negating counter-parts, which start with `no'.
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1015 For example
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1016 .Cl "-notruncate
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1017 inverts the
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1018 .Cl "-truncate
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1019 switch.
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1020 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	1021 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	1022 .Sw -help ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1023 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	1024 .Sw -Version
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1025 (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	1026 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1027 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	1028 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	1029 In most cases, doing something in exactly one way is too limiting.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1030 If one task should be accomplished in various ways,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1031 switches are a good approach to alter the behavior of a program.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1032 Changing the behavior of programs provides flexibility and customization
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1033 to users, but at the same time it complicates the code,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1034 the documentation, and the usage of the program.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1035 Therefore, the number of switches should be kept small.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1036 A small set of well-chosen switches is best.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1037 Usually, the number of switches increases over time.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1038 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	1039 problem of MH:
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1040 .[ [
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1041 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1042 .], p. 12]
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1043 .QS
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1044 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	1045 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	1046 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	1047 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	1048 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	1049 .QP
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1050 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	1051 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	1052 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	1053 .QE
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1054 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1055 Being reluctant to adding new switches (or \fIoptions\fP,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1056 as Rose and Romine call them) is one part of a counter-action,
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1057 the other part is removing hardly used switches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1058 Nmh's tools have lots of switches already implemented.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1059 Hence, cleaning up by removing some of them was the more important part
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1060 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	1061 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	1062 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	1063 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	1064 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	1065 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	1066 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	1067 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	1068 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	1069 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	1070 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	1071 ``[...]
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1072 .Pn send
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1073 will no doubt acquire an endless number of switches in the years to come''
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1074 .[ [
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1075 rose romine real work
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1076 .], p. 12].
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1077 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	1078 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	1079 but this is not practical.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1080 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	1081 them strictly.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1082 Nevertheless, removing obsolete switches still is an effective approach
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1083 to deal with the problem.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1084 Working on an experimental branch without an established user base,
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1085 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	1086 functions.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1087 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1088 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	1089 .Pn send .
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1090 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	1091 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	1092 have remained in mmh's
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1093 .Pn send .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1094 These numbers include the two generic switches,
182 764738b17b74 Updated the numbers of cmdline switches to recent mmh changes. markus schnalke <meillo@marmaro.de> parents: 181 diff changeset	1095 .Sw -help
764738b17b74 Updated the numbers of cmdline switches to recent mmh changes. markus schnalke <meillo@marmaro.de> parents: 181 diff changeset	1096 and
183 4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1097 .Sw -Version .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1098 .P
183 4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1099 Hidden switches are ones not documented.
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1100 In mmh, 12 tools have hidden switches.
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1101 9 of them are
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1102 .Sw -debug
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1103 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	1104 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1105 The following 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	1106 that is available in both nmh and mmh.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1107 The tools are sorted by the number of switches they had in nmh.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1108 Both visible and hidden switches were counted,
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1109 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	1110 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	1111 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	1112 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	1113 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	1114 has 4 now.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1115 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	1116 to 233.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1117
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1118 .KS
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1119 .in 1c
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1120 .so input/switches.grap
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1121 .KE
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1122
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1123 .P
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1124 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	1125 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	1126 Sometimes, however, the work flow was the other way:
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1127 I looked through the
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1128 .Mp mh-chart (7)
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1129 man page to identify the tools with apparently too many switches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1130 Then I considered the benefit of each switch by examining
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1131 the tool's man page and source code, aided by literature research
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1132 and testing.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1133
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1134
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1135 .U3 "Draft Folder Facility
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1136 .P
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1137 A change early in the project was the complete transition from
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1138 the single draft message to the draft folder facility
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1139 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1140 .\" XXX ref to section ...
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1141 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	1142 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	1143 .[
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1144 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1145 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1146 Since then, the facility was included, inactive by default.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1147 By making it permanently active and by related rework of the tools, the
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1148 .Sw -[no]draftfolder ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1149 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1150 .Sw -draftmessage
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1151 switches could be removed from
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1152 .Pn comp ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1153 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1154 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1155 .Pn dist ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1156 .Pn whatnow ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1157 and
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1158 .Pn send
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1159 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1160 The only flexibility lost with this change is having multiple
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1161 draft folders within one profile.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1162 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	1163 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	1164 .Sw -draft
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1165 switch of
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1166 .Pn anno ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1167 .Pn refile ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1168 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1169 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1170 was removed.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1171 The special treatment of \fIthe\fP draft message became irrelevant after
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1172 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	1173 (cf. Sec.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1174 .Cf draft-folder ).
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1175 Furthermore,
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1176 .Pn comp
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1177 no longer needs a
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1178 .Sw -file
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1179 switch as the draft folder facility together with the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1180 .Sw -form
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1181 switch are sufficient.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1182
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1183
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1184 .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	1185 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1186 .Pn anno
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1187 had the switches
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1188 .Sw -[no]inplace
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1189 to either annotate the message in place and thus preserve hard links,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1190 or annotate a copy to replace the original message.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1191 The latter approach broke hard links.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1192 Following the assumption that linked messages should truly be the
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1193 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	1194 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1195 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	1196 .Sw -inplace
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1197 was made the definitive behavior
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1198 .Ci c8195849d2e366c569271abb0f5f60f4ebf0b4d0 .
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1199 The
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1200 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1201 switches of
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1202 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1203 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1204 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1205 .Pn dist
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1206 could be removed, as well, as they were simply passed through to
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1207 .Pn anno .
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1208 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1209 .Pn burst
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1210 also had
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1211 .Sw -[no]inplace
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1212 switches, but with a different meaning.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1213 With
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1214 .Sw -inplace ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1215 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	1216 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	1217 after this message, renumbering all following messages.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1218 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	1219 in practice, it usually consists of an end-of-digest marker only.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1220 Nonetheless, this behavior appeared less elegant than the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1221 .Sw -noinplace
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1222 behavior, which already had been the default.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1223 Nmh's
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1224 .Mp burst (1)
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1225 man page reads:
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1226 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1227 If
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1228 .Sw -noinplace
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1229 is given, each digest is preserved, no table
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1230 of contents is produced, and the messages contained within
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1231 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	1232 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	1233 .QE
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1234 .LP
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1235 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	1236 .Sw -inplace
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1237 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	1238 it caused.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1239 .Sw -noinplace
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1240 was chosen to be the definitive behavior.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1241 .Ci 68a686adeb39223a5e1ad35e4a24890ec053679d
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1242
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1243
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1244 .U3 "Forms and Format Strings
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1245 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1246 Historically, the tools that had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1247 .Sw -form
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1248 switches to supply a form file had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1249 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1250 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	1251 on the command line directly.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1252 In consequence, the following two lines equaled:
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1253 .VS
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1254 scan -form scan.mailx
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1255 scan -format "`cat /path/to/scan.mailx`"
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1256 VE
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1257 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1258 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1259 switches were dropped in favor for extending the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1260 .Sw -form
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1261 switches
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1262 .Ci f51956be123db66b00138f80464d06f030dbb88d .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1263 If their argument starts with an equal sign (`\fL=\fP'),
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1264 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	1265 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	1266 Thus, now the following two lines equal:
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1267 .VS
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1268 scan -form scan.mailx
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1269 scan -form "=`cat /path/to/scan.mailx`"
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1270 VE
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1271 This rework removed the prefix collision between
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1272 .Sw -form
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1273 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1274 .Sw -format .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1275 Typing `\fL-fo\fP' is sufficient to specify form file or format string.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1276 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1277 The different meaning of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1278 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1279 for
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1280 .Pn forw
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1281 and
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1282 .Pn repl
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1283 was removed in mmh.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1284 .Pn forw
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1285 was completely switched to MIME-type forwarding, thus removing the
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1286 .Sw -[no]format
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1287 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1288 For
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1289 .Pn repl ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1290 the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1291 .Sw -[no]format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1292 switches were reworked to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1293 .Sw -[no]filter
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1294 switches
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1295 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1296 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1297 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1298 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1299 .Pn send
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1300 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1301 .Pn post ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1302 which had a third meaning, were removed likewise
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1303 .Ci f3cb7cde0e6f10451b6848678d95860d512224b9 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1304 Eventually, the ambiguity of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1305 .Sw -format
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1306 switches is resolved by not having such switches anymore in mmh.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1307
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1308
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1309 .U3 "MIME Tools
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1310 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1311 The MIME tools, which once were part of
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1312 .Pn mhn
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1313 (whatever that stood for),
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1314 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	1315 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1316 .Sw -[no]realsize
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1317 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1318 .Pn mhbuild
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1319 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1320 .Pn mhlist
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1321 were removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1322 .Ci 8d8f1c3abc586c005c904e52c4adbfe694d2201c .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1323 Real size calculations are done always now because nmh's
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1324 .Mp mhbuild (1)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1325 man page states that
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1326 ``This provides an accurate count at the expense of a small delay''
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1327 with the small delay not being noticable on modern systems.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1328 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1329 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1330 .Sw -[no]check
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1331 switches were removed together with the support for
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1332 .Hd Content-MD5
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1333 header fields [RFC\\|1864]
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1334 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1335 .Cf content-md5 )
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1336 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1337 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1338 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1339 .Sw -[no]ebcdicsafe
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1340 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1341 .Sw -[no]rfc934mode
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1342 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1343 .Pn mhbuild
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1344 were removed because they are considered obsolete
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1345 .Ci 01a3480928da485b4d6109d36d751dfa71799d58
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1346 .Ci 3363e2624dce0eb8164cf8b3f1ab385c8ff72e88 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1347 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1348 Content caching of external MIME parts, activated with the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1349 .Sw -rcache
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1350 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1351 .Sw -wcache
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1352 switches was completely removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1353 .Ci d1fefd9f614e4dc3cda16da6c69133c1b2005269 .
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1354 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	1355 for them appears to be unnecessary.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1356 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1357 In pre-MIME times,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1358 .Pn mhl
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1359 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	1360 Therefore,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1361 .Pn mhl
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1362 could be simplified to a large extend, reducing the number of its
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1363 switches from 21 to 6
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1364 .Ci 350ad6d3542a07639213cf2a4fe524e829c1e7b6
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1365 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1366
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1367
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1368
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1369
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1370 .U3 "Header Printing
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1371 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1372 .Pn folder 's
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1373 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	1374 displaying the header line makes little sense.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1375 Hence, the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1376 .Sw -[no]header
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1377 switch was removed and headers are never printed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1378 .Ci 601cc73d1fa05ce96faa728f036d6c51b91701c7 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1379 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1380 In
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1381 .Pn mhlist ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1382 the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1383 .Sw -[no]header
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1384 switches were removed, as well
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1385 .Ci b24f96523aaf60e44e04a3ffb1d22e69a13a602f .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1386 In this case, the headers are printed always because the output
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1387 is not self-explaining.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1388 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1389 .Pn scan
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1390 also had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1391 .Sw -[no]header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1392 switches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1393 Printing this header had been sensible until the introduction of
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1394 format strings made it impossible to display column headings.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1395 Only the folder name and the current date remained to be printed.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1396 As this information can be perfectly generated with
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1397 .Pn folder
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1398 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1399 .Pn date ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1400 the switches were removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1401 .Ci c477dc5d1d03fa6d9a8ab3dd3508c63cbddc044e .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1402 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1403 By removing all
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1404 .Sw -header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1405 switches, the collision with
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1406 .Sw -help
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1407 on the first two letters was resolved.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1408 Currently,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1409 .Sw -h
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1410 evaluates to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1411 .Sw -help
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1412 for all tools of mmh.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1413
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1414
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1415 .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	1416 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1417 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1418 .Sw -noedit
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1419 switch of
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1420 .Pn comp ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1421 .Pn repl ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1422 .Pn forw ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1423 .Pn dist ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1424 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1425 .Pn whatnow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1426 was removed and replaced by specifying
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1427 .Sw -editor
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1428 with an empty argument
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1429 .Ci 75fca31a5b9d5c1a99c74ab14c94438d8852fba9 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1430 (Specifying
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1431 .Cl "-editor /bin/true
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1432 is nearly the same. It differs only in setting the previous editor.)
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1433 .P
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1434 The more important change is the removal of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1435 .Sw -nowhatnowproc
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1436 switch
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1437 .Ci ee4f43cf2ef0084ec698e4e87159a94c01940622 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1438 This switch had once introduced an awkward behavior,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1439 as explained in nmh's man page for
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1440 .Mp comp (1):
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1441 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1442 The
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1443 .Sw -editor
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1444 .Ar editor
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1445 switch indicates the editor to use for
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1446 the initial edit. Upon exiting from the editor,
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1447 .Pn comp
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1448 will invoke the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1449 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1450 program. See
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1451 .Mp whatnow (1)
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1452 for a discussion of available options.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1453 The invocation of this program can be
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1454 inhibited by using the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1455 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1456 switch. (In truth of fact, it is the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1457 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1458 program which starts the initial edit.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1459 Hence,
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1460 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1461 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	1462 .QE
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1463 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1464 Effectively, the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1465 .Sw -nowhatnowproc
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1466 switch caused only only a draft message to be created.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1467 As
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1468 .Cl "-whatnowproc /bin/true
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1469 does the same, the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1470 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1471 switch was removed for being redundant.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1472
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1473
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1474
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1475 .U3 "Various
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1476 .BU
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1477 With the removal of MMDF maildrop format support,
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1478 .Pn packf
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1479 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1480 .Pn rcvpack
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1481 no longer needed their
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1482 .Sw -mbox
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1483 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1484 .Sw -mmdf
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1485 switches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1486 The behavior of
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1487 .Sw -mbox
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1488 is the sole behavior now
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1489 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0 .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	1490 Further rework in both tools made the
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1491 .Sw -file
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1492 switch unnecessary
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1493 .Ci ca1023716d4c2ab890696f3e41fa0d94267a940e .
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1494
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1495 .BU
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1496 Mmh's tools do no longer clear the screen (\c
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1497 .Pn scan 's
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1498 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1499 .Pn mhl 's
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1500 .Sw -[no]clear
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1501 switches
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1502 .Ci e57b17343dcb3ff373ef4dd089fbe778f0c7c270
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1503 .Ci 943765e7ac5693ae177fd8d2b5a2440e53ce816e ).
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1504 Neither does
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1505 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1506 ring the bell (\c
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1507 .Sw -[no]bell
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1508 .Ci e11983f44e59d8de236affa5b0d0d3067c192e24 )
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1509 nor does it page the output itself (\c
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1510 .Sw -length
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1511 .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ).
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1512 .\" XXX Ref
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1513 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	1514 .Sw -[no]moreproc
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1515 command line switches for
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1516 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1517 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1518 .Pn show /\c
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1519 .Pn mhshow
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1520 .Ci 39e87a75b5c2d3572ec72e717720b44af291e88a .
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1521
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1522 .BU
96 12348d620245 Spell checking. markus schnalke <meillo@marmaro.de> parents: 95 diff changeset	1523 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	1524 .Sw -version
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1525 switch was renamed to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1526 .Sw -Version
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1527 (with capital `V')
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1528 .Ci 32b2354dbaf4bf934936eb5b102a4a3d2fdd209a .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1529 Every program has the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1530 .Sw -version
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1531 switch but its first three letters collided with the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1532 .Sw -verbose
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1533 switch, present in many programs.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1534 The rename solved this problem once for all.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1535 Although this rename breaks a basic interface, having the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1536 .Sw -V
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1537 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	1538
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1539 .BU
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1540 .Sw -[no]preserve
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1541 of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1542 .Pn refile
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1543 was removed
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1544 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1545 because what use was it anyway?
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1546 Quoting nmh's man page
165 ea6eec1722d1 Improvement by Boris Kraut. markus schnalke <meillo@marmaro.de> parents: 164 diff changeset	1547 .Mp refile (1):
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1548 .QS
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1549 Normally when a message is refiled, for each destination
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1550 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	1551 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	1552 .Sw -preserv
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1553 [sic!] switch will override this message renaming, and try
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1554 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	1555 particular folder occurs when using the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1556 .Sw -preserve
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1557 switch, then
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1558 .Pn refile
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1559 will use the next available message number which
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1560 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	1561 .QE
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1562
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1563 .BU
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1564 The removal of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1565 .Sw -[no]reverse
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1566 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1567 .Pn scan
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1568 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1569 is a bug fix.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1570 This is supported by the comments
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1571 ``\-[no]reverse under #ifdef BERK (I really HATE this)''
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1572 by Rose and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1573 ``Lists messages in reverse order with the `\-reverse' switch.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1574 This should be considered a bug'' by Romine in the changelogs.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1575 The question remains why neither Rose nor Romine have fixed this
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1576 bug in the eighties when they wrote these comments.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1577
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1578
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1579
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1580
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1581
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1582
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1583
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	1584 .\" --------------------------------------------------------------
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1585 .H1 "Modernizing
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1586 .P
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1587 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	1588 increasingly extended.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	1589 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	1590 existing behavior.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1591 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	1592 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	1593 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	1594 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	1595 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	1596 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	1597 .Cf code-style .
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1598
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1599
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1600 .H2 "Code Relics
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1601 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1602 My position regarding the removal of obsolete code
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1603 is much more revolutional than the nmh community appreciates.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1604 Working on an experimental version, I was able to quickly drop
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1605 functionality that I considered ancient.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1606 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	1607 Without the need to justify my decisions, I was able to rush forward.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1608 .P
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1609 In December 2011, Paul Vixie motivated the nmh developers to just
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1610 do the work:
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1611 .[
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1612 paul vixie edginess nmh-workers
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1613 .]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1614 .QS
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1615 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	1616 discuss whether to keep using vfork, just note in [sic!] passing, [...]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1617 we don't need a separate branch for removing vmh
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1618 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	1619 or depending on pure ansi/posix ``libc''.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1620 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1621 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	1622 should just be modern. [...]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1623 let's push forward, aggressively.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1624 .QE
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1625 .LP
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1626 I did so already in the months before.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1627 I pushed forward.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1628 I simply dropped the cruft.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1629 .P
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1630 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	1631 careful thinking, but whether having had contact with this particular
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1632 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	1633 I explained my reasons in the commit messages
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1634 in the version control system.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1635 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	1636 if I have missed an important aspect.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1637 I was quick in dropping parts.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	1638 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	1639 Mmh is experimental work; it requires tough decisions.
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1640
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1641
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1642 .U3 "Process Forking
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	1643 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1644 Being a tool chest, MH creates many processes.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1645 In earlier times
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1646 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1647 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	1648 to be completely duplicated at once.
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	1649 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	1650 case wherein the image is replaced by a call to
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1651 .Fu exec()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1652 right after having forked the child process.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1653 The
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1654 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1655 system call was invented to speed up this particular case.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1656 It completely omits the duplication of the image.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1657 On old systems this resulted in significant speed ups.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1658 Therefore MH used
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1659 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1660 whenever possible.
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1661 .P
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1662 Modern memory management units support copy-on-write semantics, which make
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1663 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1664 almost as fast as
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1665 .Fu vfork() .
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1666 The man page of
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1667 .Mp vfork (2)
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1668 in FreeBSD 8.0 states:
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1669 .QS
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1670 This system call will be eliminated when proper system sharing mechanisms
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1671 are implemented. Users should not depend on the memory sharing semantics
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1672 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	1673 .QE
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1674 .LP
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1675 Vixie supports the removal with the note that ``the last
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1676 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	1677 Eunice. that was 1987''.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1678 .[
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1679 nmh-workers vixie edginess
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1680 .]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1681 I replaced all calls to
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1682 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1683 with calls to
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1684 .Fu fork()
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1685 .Ci 40821f5c1316e9205a08375e7075909cc9968e7d .
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1686 .P
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1687 Related to the costs of
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1688 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1689 is the probability of its success.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1690 In the eighties, on heavy loaded systems, calls to
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1691 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1692 were prone to failure.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1693 Hence, many of the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1694 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1695 calls in the code were wrapped into loops to retry the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1696 .Fu fork()
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1697 several times, to increase the chances to succeed eventually.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1698 On modern systems, a failing
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1699 .Fu fork()
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1700 call is unusual.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1701 Hence, in the rare case when
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1702 .Fu fork()
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1703 fails, mmh programs simply abort
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1704 .Ci 5fbf37ee68e018998ada61eeab73e035b26834b6 .
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1705
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1706
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1707 .U3 "Header Fields
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1708 .BU
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1709 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1710 .Hd Encrypted
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1711 header field was introduced by RFC\\|822,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1712 but already marked as legacy in RFC\\|2822.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1713 Today, OpenPGP provides the basis for standardized exchange of encrypted
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1714 messages [RFC\\|4880, RFC\\|3156].
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1715 Hence, the support for
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1716 .Hd Encrypted
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1717 header fields is removed in mmh
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1718 .Ci 064527f7b57ab050e5af13e15ad99aeeab125857 .
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1719 .BU
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1720 The native support for
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1721 .Hd Face
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1722 header fields has been removed, as well
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1723 .Ci 8e5be81f784682822f5e868c1bf3c8624682bd23 .
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1724 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	1725 .Hd X-Face
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1726 header field in its intent,
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1727 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	1728 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	1729 it contains the hostname and UDP port where the image
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1730 date can be retrieved.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1731 There is even a third Face system,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1732 which is the successor of
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1733 .Hd X-Face ,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1734 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	1735 .Hd Face
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1736 header field name.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1737 It was invented in 2005 and supports colored PNG images.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1738 None of the Face systems described here is popular today.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1739 Hence, mmh has no direct support for them.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1740 .BU
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1741 .Id content-md5
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1742 The
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1743 .Hd Content-MD5
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1744 header field was introduced by RFC\\|1864.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1745 It provides detection of data corruption during the transfer.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1746 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	1747 [RFC\\|1864].
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1748 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	1749 end-to-end relationship is the use of digital signatures.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1750 .\" XXX (RFCs FIXME).
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1751 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	1752 the transmission.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1753 The TCP includes a checksum field therefore.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1754 These two approaches in combinations render the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1755 .Hd Content-MD5
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1756 header field superfluous.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1757 Not a single one out of 4\\|200 messages from two decades
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1758 in the nmh-workers mailing list archive
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1759 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1760 nmh-workers mailing list archive website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1761 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1762 contains a
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1763 .Hd Content-MD5
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1764 header field.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1765 Neither did any of the 60\\|000 messages in my personal mail storage.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1766 Removing the support for this header field
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1767 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda ,
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1768 removed the last place where MD5 computation was needed.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1769 Hence, the MD5 code could be removed as well.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1770 Over 500 lines of code vanished by this one change.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1771
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1772
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1773 .U3 "MMDF maildrop support
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1774 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1775 This type of maildrop format is conceptionally similar to the mbox format,
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1776 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	1777 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	1778 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	1779 whereas the MMDF maildrop format is now forgotten.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1780 Mbox remains as the only packed mailbox format, supported in mmh.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1781 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1782 The simplifications within the code were moderate.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1783 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	1784 But also, switches of
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1785 .Pn packf
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1786 and
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1787 .Pn rcvpack
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1788 could be removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1789 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0 .
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1790 In the message parsing function
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1791 .Fn sbr/m_getfld.c ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1792 knowledge of MMDF packed mail boxes was removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1793 .Ci 684ec30d81e1223a282764452f4902ed4ad1c754 .
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1794 Further code structure simplifications may be possible there,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1795 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	1796 I have not worked on them yet because
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1797 .Fu m_getfld()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1798 is heavily optimized and thus dangerous to touch.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1799 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	1800 too high.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1801
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1802
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1803 .U3 "Prompter's Control Keys
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1804 .P
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1805 The program
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1806 .Pn prompter
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1807 queries the user to fill in a message form.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1808 When used as
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1809 .Cl "comp -editor prompter" ,
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1810 the resulting behavior is similar to
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1811 .Pn mailx .
51 49cf68506b5d Spell checking. markus schnalke <meillo@marmaro.de> parents: 49 diff changeset	1812 Apparently,
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1813 .Pn prompter
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	1814 had not been touched lately.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1815 Otherwise it's hardly explainable why it
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1816 still offered the switches
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1817 .Sw -erase
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1818 .Ar chr
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1819 and
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1820 .Sw -kill
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1821 .Ar chr
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1822 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	1823 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	1824 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	1825 with the standard tool
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1826 .Pn stty .
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1827 The switches are removed now
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1828 .Ci 0bd9750710cdbab80cfb4036dd87af20afe1552f .
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1829
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1830
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1831 .U3 "Hardcopy Terminal Support
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1832 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1833 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	1834 hardcopy terminal.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1835 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	1836 .Ci b7764c4a6b71d37918a97594d866258f154017ca .
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1837 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1838 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	1839 program (\c
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1840 .Pn mhl )
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1841 and the terminal.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1842 In nmh, this could have been ensured statically with the
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1843 .Sw -nomoreproc
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1844 at the command line, too.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	1845 In mmh, setting the profile entry
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1846 .Pe Pager
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1847 or the environment variable
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1848 .Ev PAGER
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1849 to
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1850 .Pn cat
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1851 is sufficient.
104 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
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1854
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1855
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1856 .H2 "Attachments
22 99409e4546d2 Wrote about the removal of tools. markus schnalke <meillo@marmaro.de> parents: 21 diff changeset	1857 .P
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1858 The mind model of email attachments is unrelated to MIME.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1859 Although the MIME RFCs [RFC\\|2045\(en2049] define the technical
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1860 requirements for having attachments, they do not mention the term.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1861 Instead of attachments, MIME talks about ``multi-part message bodies''
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1862 [RFC\\|2045], a more general concept.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1863 Multi-part messages are messages
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1864 ``in which one or more different
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1865 sets of data are combined in a single body''
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1866 [RFC\\|2046].
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1867 MIME keeps its descriptions generic;
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1868 it does not imply specific usage models.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1869 Today, one usage model is prevalent: attachments.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1870 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	1871 attached to it.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1872 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	1873 and parts of arbitrary type following.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1874 .P
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1875 MH's MIME support is a direct implementation of the RFCs.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1876 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	1877 in MH's implementation.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1878 As a result,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1879 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	1880 But users do not need all the MIME features,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1881 they want convenient attachment handling.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1882
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1883
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1884 .U3 "Composing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1885 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1886 In order to improve the situation on the message composing side,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1887 Jon Steinhart had added an attachment system to nmh in 2002
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1888 .Ci 7480dbc14bc90f2d872d434205c0784704213252 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1889 In the file
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1890 .Fn docs/README-ATTACHMENTS ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1891 he described his motivation to do so:
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1892 .QS
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1893 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	1894 handing [sic!], the interface to this functionality is pretty obtuse.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1895 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	1896 .Pn mhbuild
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1897 composition files!
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1898 .QE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1899 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1900 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	1901 In the same document:
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1902 .QS
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1903 These changes simplify the task of managing attachments on draft files.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1904 They allow attachments to be added, listed, and deleted.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1905 MIME messages are automatically created when drafts with attachments
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1906 are sent.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1907 .QE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1908 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1909 Unfortunately, the attachment system, like every new facilities in nmh,
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1910 was inactive by default.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1911 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1912 During my time in Argentina, I tried to improve the attachment system.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1913 But, after long discussions my patch died as a proposal on the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1914 mailing list because of great opposition in the nmh community.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1915 .[
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1916 nmh-workers attachment proposal
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1917 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1918 In January 2012, I extended the patch and applied it to mmh
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1919 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1 .
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1920 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	1921 Instead of command line switches, the
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1922 .Pe Attachment-Header
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1923 profile entry is used to specify
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1924 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	1925 It is pre-defined to
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1926 .Hd Attach .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1927 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1928 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	1929 .VS
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1930 To: bob
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1931 Subject: The file you wanted
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1932 Attach: /path/to/the/file-bob-wanted
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1933 --------
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1934 Here it is.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1935 VE
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1936 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	1937 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	1938 non-interactively with
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1939 .Pn anno :
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1940 .VS
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1941 anno -append -nodate -component Attach -text /path/to/attachment
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1942 VE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1943 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	1944 .Pn send .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1945 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	1946 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	1947 attachment headers.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	1948 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	1949 is not accessible) the original draft is not changed.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1950 .P
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1951 The attachment system handles the forwarding of messages, too.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	1952 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	1953 like in
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1954 .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	1955 the given messages in the specified folder will be attached.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1956 This allowed to simplify
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1957 .Pn forw
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1958 .Ci f41f04cf4ceca7355232cf7413e59afafccc9550 .
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 Closely related to attachments is non-ASCII text content,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1961 because it requires MIME as well.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1962 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	1963 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	1964 This was necessary whenever the draft contained non-ASCII characters.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1965 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	1966 Therefore, the
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1967 .Pe automimeproc
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1968 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	1969 automatically each time.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	1970 Unfortunately, this approach conflicted with the attachment system
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1971 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	1972 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	1973 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	1974 WhatNow prompt and
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1975 .Pe automimeproc
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1976 must not be set in the profile.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1977 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	1978 not caught.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1979 All in all, the solution was complex and irritating.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1980 My patch from December 2010
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1981 .[
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1982 nmh-workers attachment proposal
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1983 .]
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1984 would have simplified the situation.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1985 .P
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1986 Mmh's current solution is even more elaborate.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1987 Any necessary MIMEification is done automatically.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1988 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	1989 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	1990 attachment header or non-ASCII text is present.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	1991 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	1992 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	1993 .\" XXX REF ?
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1994 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	1995 .P
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1996 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	1997 compositions directly, the full power of
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1998 .Pn mhbuild
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1999 can still be accessed.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2000 Given no attachment headers are included, users can create
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2001 .Pn mhbuild
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2002 composition drafts like in nmh.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2003 Then, at the WhatNow prompt, they can invoke
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2004 .Cl "edit mhbuild
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2005 to convert the draft to MIME.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2006 Because the resulting draft neither contains non-ASCII characters
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2007 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	2008 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2009 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	2010 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	2011 This case was simplified.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2012
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2013
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2014 .U3 "MIME Type Guessing
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2015 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2016 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	2017 .Pn mhbuild
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2018 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	2019 The user provides the appropriate MIME types for files to include.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2020 The new attachment system needs to find out the correct MIME type itself.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2021 This is a difficult task.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2022 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	2023 partly intelligent work.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2024 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	2025 forces him to do partly mechanical work.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2026 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	2027 content.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2028 For mmh, the latter option was chosen to spare the user the work
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2029 .Ci 3baec236a39c5c89a9bda8dbd988d643a21decc6 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2030 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2031 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	2032 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	2033 for the common cases.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2034 If no MIME type can be determined, text content is sent as `text/plain',
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2035 anything else under the generic fall-back type `application/octet-stream'.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2036 Mmh implements this approach in the
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2037 .Pn print-mimetype
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2038 script
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2039 .Ci 4b5944268ea0da7bb30598a27857304758ea9b44 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2040 .P
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2041 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	2042 .Pn file .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2043 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	2044 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	2045 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	2046 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	2047 Nevertheless, modern versions of GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2048 .Pn file ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2049 which are 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	2050 provide MIME type output in machine-readable form.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2051 Although this solution is system-dependent,
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2052 it solves the difficult problem well.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2053 On systems where GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2054 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2055 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	2056 One needs to specify the following profile entry to do so:
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2057 .VS
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2058 Mime-Type-Query: file -b --mime
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2059 VE
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2060 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2061 Other versions of
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2062 .Pn file
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2063 might possibly be usable with wrapper scripts that reformat the output.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2064 The diversity among
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2065 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2066 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	2067 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2068 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	2069 for a specific file.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2070 To do so, either the user would need to know in advance for which file
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2071 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	2072 I consider both cases impractical.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2073 The existing solution should be sufficient.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2074 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	2075 .Pn mhbuild
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2076 composition drafts and bypass the attachment system.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2077
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2078
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2079 .U3 "Storing Attachments
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2080 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2081 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	2082 .Pn mhstore .
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2083 The program has two operation modes,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2084 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2085 and
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2086 .Sw -noauto .
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2087 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	2088 MIME part's meta information, if available.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2089 This naming information is usually available for modern attachments.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2090 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	2091 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2092 would have been specified.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2093 In the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2094 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2095 mode, the parts are processed according to rules, defined by
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2096 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2097 profile entries.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2098 These rules define generic filename templates for storing
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2099 or commands to post-process the contents in arbitrary ways.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2100 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	2101 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	2102 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2103 The
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2104 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2105 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	2106 in contrast to the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2107 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2108 mode.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2109 In mmh,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2110 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2111 is not dangerous anymore.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2112 Two changes were necessary:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2113 .LI 1
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2114 Any directory path is removed from the proposed filename.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2115 Thus, the files are always stored in the expected directory.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2116 .Ci 41b6eadbcecf63c9a66aa5e582011987494abefb
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2117 .LI 2
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2118 Tar files are not extracted automatically any more.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2119 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	2120 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2121 .P
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2122 In mmh, the result of
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2123 .Cl "mhstore -auto
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	2124 can be foreseen from the output of
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2125 .Cl "mhlist -verbose" .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2126 Although the
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2127 .Sw -noauto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2128 mode is considered to be more powerful, it is less convenient and
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2129 .Sw -auto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2130 is safe now.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2131 Additionally, storing attachments under their original name
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2132 is intuitive.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2133 Hence,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2134 .Sw -auto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2135 serves better as the default option
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2136 .Ci 3410b680416c49a7617491af38bc1929855a331d .
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2137 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2138 Files are stored into the directory given by the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2139 .Pe Nmh-Storage
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2140 profile entry, if set, or
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2141 into the current working directory, otherwise.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2142 Storing to different directories is only possible with
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2143 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2144 profile entries.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2145 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2146 Still existing files get overwritten silently in both modes.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2147 This can be considered a bug.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2148 Yet, each other behavior has its draw-backs, too.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2149 Refusing to replace files requires adding a
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2150 .Sw -force
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2151 switch.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2152 Users will likely need to invoke
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2153 .Pn mhstore
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2154 a second time with
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2155 .Sw -force .
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2156 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	2157 This requires interaction, which I like to avoid if possible.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2158 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	2159 For now, the behavior remains as it is.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2160 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2161 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	2162 .Pn mhstore 's
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2163 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2164 mode.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2165 Instead of storing message/rfc822 parts as files to disk,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2166 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	2167 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	2168 automatically reassembled beforehand.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2169 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	2170 anymore.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2171 Instead, information on how to retrieve them is output.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2172 Not supporting this rare case saved nearly one thousand lines of code
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2173 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2174 The MIME type `application/octet-stream; type=tar' is not special anymore.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2175 The automatically extracting of such MIME parts had been the
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2176 dangerous part of the
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2177 .Sw -auto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2178 mode
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2179 .Ci 94c80042eae3383c812d9552089953f9846b1bb6 .
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2180
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2181
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2182
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2183 .U3 "Showing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2184 .P
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2185 The program
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2186 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2187 was written to display MIME messages.
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2188 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	2189 Nmh's
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2190 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2191 handles each MIME part independently, presenting them separately
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2192 to the user.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2193 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	2194 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	2195 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	2196 plus possibly attachments.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2197 They are no more seen to be arbitrary MIME hierarchies with
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2198 information on how to display the individual parts.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2199 I adjusted
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2200 .Pn mhshow 's
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2201 behavior to the modern view on the topic.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2202 .P
224 b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	2203 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	2204 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2205 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	2206 and is no longer part of mmh.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2207 .\" XXX ref to other section
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2208 Although
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2209 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2210 was renamed to
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2211 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2212 in mmh, this section uses the name
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2213 .Pn mhshow ,
224 b0e83cfde2bf Further minor improvements. markus schnalke <meillo@marmaro.de> parents: 223 diff changeset	2214 in order to avoid confusion.
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2215 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2216 In mmh, the basic idea is that
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2217 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2218 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	2219 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2220 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2221 invokes a pager session for all its output,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2222 whenever it prints to a terminal
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2223 .Ci a4197ea6ffc5c1550e8b52d5a654bcaaaee04a4e .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2224 In consequence,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2225 .Pn mhl
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2226 does no more invoke a pager
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2227 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70 .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2228 With
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2229 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2230 replacing the original
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2231 .Pn show ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2232 the output of
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2233 .Pn mhl
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2234 no longer goes to the terminal directly, but through
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2235 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2236 Hence,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2237 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2238 does not need to invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2239 The one and only job of
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2240 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2241 is to format messages or parts of them.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2242 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	2243 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2244 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2245 In the intended setup, only text content is be displayed,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2246 in a single pager session.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2247 Non-text content needs to be converted to text by appropriate
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2248 .Pe mhshow-show-*
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2249 profile entries before, if this is possible and wanted.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2250 A common example for this are PDF files.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2251 In mmh, MIME parts are always displayed serially.
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2252 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	2253 is ignored.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2254 It is simply treated as `multipart/mixed'
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2255 .Ci d0581ba306a7299113a346f9b4c46ce97bc4cef6 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2256 This was already possible to requested with the, now removed,
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2257 .Sw -serialonly
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2258 switch of
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2259 .Pn mhshow .
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2260 As MIME parts are always processed exclusively, i.e. serially,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2261 the `\fL%e\fP' escape in
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2262 .Pe mhshow-show-*
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2263 profile entries became useless and was thus removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2264 .Ci a20d405db09b7ccca74d3e8c57550883da49e1ae .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2265 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2266 Other kinds of attachments are ignored.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2267 With
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2268 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2269 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	2270 the message.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2271 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	2272 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2273 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	2274 to the native charset.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2275 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2276 .Pe mhshow-charset-*
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2277 profile entries were needed.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2278 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	2279 text through the
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2280 .Pn iconv
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2281 command, if necessary
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2282 .Ci 2433122c20baccb10b70b49c04c6b0497b5b3b60 .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2283 Custom
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2284 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2285 rules for textual content might need a
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2286 .Cl "iconv -f %c %f \|
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2287 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	2288 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2289 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	2290 has improved, it is not consistent enough.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2291 Further work needs to be done and
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2292 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	2293 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	2294 correctly without the need to configure anything.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2295
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2296
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2297 .ig
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2298
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2299 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2300 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	2301 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	2302 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	2303 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	2304 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	2305 it!
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2306 (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	2307 ~/.netrc are gone now.)
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2308 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2309
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2310 ..
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2311
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2312
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2313
166 f102dcc06bb9 s/digital cryptography/signing and encryption/ markus schnalke <meillo@marmaro.de> parents: 165 diff changeset	2314 .H2 "Signing and Encrypting
22 99409e4546d2 Wrote about the removal of tools. markus schnalke <meillo@marmaro.de> parents: 21 diff changeset	2315 .P
166 f102dcc06bb9 s/digital cryptography/signing and encryption/ markus schnalke <meillo@marmaro.de> parents: 165 diff changeset	2316 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	2317 This functionality needed to be added through third-party software.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2318 In mmh, the functionality is included because it
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2319 is a part of modern email and is likely wanted by users of mmh.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2320 A fresh mmh installation supports signing and encrypting
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2321 out-of-the-box.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2322 Therefore, Neil Rickert's
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2323 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2324 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2325 .Pn mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2326 scripts
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2327 .[
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2328 neil rickert mhsign mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2329 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2330 were included
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2331 .Ci f45cdc98117a84f071759462c7ae212f4bc5ab2e
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2332 .Ci 58cf09aa36e9f7f352a127158bbf1c5678bc6ed8 .
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2333 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	2334 similar of style to the existing tools.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2335 Additionally, no licensing difficulties appeared
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2336 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	2337 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2338 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2339 handles the signing and encrypting part.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2340 It comprises about 250 lines of shell code and interfaces between
223 1fa5a74bf138 Reworked References structure: Collect them all in one Chapter. markus schnalke <meillo@marmaro.de> parents: 220 diff changeset	2341 .Pn gnupg
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2342 and the MH system.
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2343 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	2344 .Pn send
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2345 invokes
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2346 .Pn mhsign
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2347 automatically
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2348 .Ci c7b5e1df086bcc37ff40163ee67571f076cf6683 .
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2349 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	2350 If a draft contains the
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2351 .Hd Sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2352 header field,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2353 .Pn send
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2354 will initiate the signing.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2355 The signing key is either chosen automatically or it is specified by the
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2356 .Pe Pgpkey
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2357 profile entry.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2358 .Pn send
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2359 always create signatures using the PGP/MIME standard [RFC\\|4880],
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2360 but by invoking
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2361 .Pn mhsign
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2362 manually, 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	2363 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	2364 .Hd Enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2365 header field.
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2366 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	2367 in a file called
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2368 .Fn pgpkeys ,
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2369 which contains exceptions and overrides.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2370 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	2371 .Pn mhsign
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2372 will refuse to encrypt it.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2373 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	2374 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	2375 approach.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2376 .P
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2377 .Pn mhpgp
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2378 is the companion to
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2379 .Pn mhsign .
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2380 It verifies signatures and decrypts messages.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2381 Encrypted messages can be either temporarily decrypted and displayed
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2382 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	2383 Currently,
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2384 .Pn mhpgp
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2385 needs to be invoked manually.
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2386 The integration into
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2387 .Pn show
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2388 and
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2389 .Pn mhstore
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2390 to verify signatures and decrypt messages as needed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2391 is planned but not yet realized.
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2392 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2393 Both scripts were written for nmh.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2394 Hence they needed to be adjust
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2395 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	2396 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	2397 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	2398 .P
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2399 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	2400 most recent features in mmh.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2401 It has not had the time to mature.
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2402 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	2403 direct the further development of the facility.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2404 Already 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	2405 .Sw -[no]sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2406 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2407 .Sw -[no]enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2408 switches to
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2409 .Pn send ,
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2410 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	2411 A profile entry:
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2412 .VS
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2413 send: -sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2414 VE
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2415 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	2416 With the present approach, a
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2417 .Hd Send
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2418 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	2419 to achieve the same result.
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2420 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	2421 template files clean.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2422
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2423
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2424
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2425
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2426 .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	2427 .P
14 55ec590cfa07 Wrote about the draft folder. markus schnalke <meillo@marmaro.de> parents: 12 diff changeset	2428
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2429 .U3 "Draft Folder
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2430 .Id draft-folder
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2431 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2432 In the beginning, MH had the concept of a draft message.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2433 This was a file named
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2434 .Fn draft
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2435 in the MH directory, which was treated special.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2436 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	2437 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	2438 the user had to decide among:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2439 .LI 1
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2440 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	2441 .LI 2
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2442 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	2443 .LI 3
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2444 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	2445 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2446 Working on multiple drafts was only possible in alternation.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2447 For that, 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	2448 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	2449 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	2450 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	2451 help anything.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2452 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2453 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	2454 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	2455 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	2456 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	2457 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	2458 out-of-the-box.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2459 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	2460 .Mp mh-draft (5)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2461 to better document the feature.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2462 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2463 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	2464 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	2465 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	2466 complex cases.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2467 The concept of the draft message is too limited for the problem
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2468 it tries to solve.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2469 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	2470 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	2471 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	2472 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	2473 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	2474 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	2475 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	2476 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2477 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	2478 default name.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2479 I chose the name
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2480 .Fn +drafts ,
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2481 for obvious reasons.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2482 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	2483 .Sw -draftfolder
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2484 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2485 .Sw -draftmessage
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2486 could be removed.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2487 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	2488 new concept.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2489 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	2490 approaches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2491 By fully switching to the draft folder, the tools could be
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2492 simplified by dropping the awkward draft message handling code.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2493 .Sw -draft
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2494 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	2495 special.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2496 It became indistinguishable to operating on any other message.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2497 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2498 .P
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2499 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	2500 .Ci 2d48b455c303a807041c35e4248955f8bec59eeb .
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2501 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	2502 Refiling drafts is without difference to refiling other messages.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2503 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	2504 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	2505 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2506 still has
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2507 .Sw -[no]use
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2508 for switching between two modes:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2509 .LI 1
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2510 Modifying an existing draft, with
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2511 .Sw -use .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2512 .LI 2
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2513 Composing a new draft, possibly taking some existing message as template,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2514 with
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2515 .Sw -nouse ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2516 the default.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2517 .LP
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2518 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	2519 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2520 is deterministic.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2521 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2522 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2523 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	2524 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	2525 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	2526 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	2527 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	2528 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2529 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	2530 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2531 Dropping the draft message concept in favor for the draft folder concept,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2532 replaced special cases with regular cases.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2533 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	2534 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	2535 but applies them.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2536 .Cl "scan +drafts" ,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2537 for instance, is a truly natural request.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2538 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2539 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	2540 The original improvement of mmh is dropping the old draft message approach
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2541 and thus simplifying the tools, the documentation,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2542 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	2543 Although my part in the draft handling improvement was small,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2544 it was important.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2545
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2546
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2547 .U3 "Trash Folder
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2548 .Id trash-folder
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 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	2551 Historically, a message was ``deleted'' by prepending a specific
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	2552 \fIbackup prefix\fP, usually the comma character,
4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	2553 to the file name.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2554 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	2555 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	2556 Although files remained in the file system,
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2557 the messages were no longer visible in MH.
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2558 To truly delete them, a maintenance job was needed.
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2559 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	2560 For instance:
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2561 .VS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2562 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	2563 VE
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2564 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	2565 within the grace time interval by stripping the
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2566 backup prefix from the file name \(en usually but not always.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2567 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	2568 message
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2569 .Fn 6 ,
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2570 became file
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2571 .Fn ,6 .
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2572 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	2573 the number one above the highest existing message number.
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2574 In this case the message would be named
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2575 .Fn 6 ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2576 reusing the number.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2577 If this new message would be removed as well,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2578 then the backup of the former message becomes overwritten.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2579 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	2580 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	2581 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	2582 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	2583 ``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	2584 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	2585 same folder is removed before.'' the statement becomes complex.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2586 A user will hardly be able to keep track of all removals to know
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2587 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	2588 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	2589 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2590 Furthermore, the backup files were scattered within the whole mail storage.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2591 This complicated managing them.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2592 It was 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	2593 .Pn find ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2594 but everything is more convenient
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2595 if the deleted messages are collected in one place.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2596 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2597 The profile entry
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2598 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2599 (previously named
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2600 .Pe Delete-Prog )
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2601 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	2602 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	2603 the specified messages.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2604 This had overridden the default action, described above.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2605 Refiling the to-be-removed files to a trash folder was the usual example.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2606 Nmh's man page
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2607 .Mp rmm (1)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2608 proposes to set the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2609 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2610 to
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2611 .Cl "refile +d
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2612 to move messages to the trash folder
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2613 .Fn +d
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2614 instead of renaming them with the backup prefix.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2615 The man page additionally proposes the expunge command
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2616 .Cl "rm `mhpath +d all`
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2617 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	2618 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2619 Removing messages in such a way has advantages:
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2620 .LI 1
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2621 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	2622 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	2623 Existing and removed messages are thus separated more strictly.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2624 .LI 2
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2625 No backup files are silently overwritten.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2626 .LI 3
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2627 Most important, however, removed messages are kept in the MH domain.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2628 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	2629 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	2630 .Pn refile
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2631 can restore deleted messages.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2632 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	2633 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	2634 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2635 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	2636 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	2637 Hence,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2638 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2639 calls
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2640 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2641 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	2642 .Fn +trash
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2643 by default.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2644 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	2645 .Cl "rmm -unlink +trash a" ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2646 where the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2647 .Sw -unlink
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2648 switch causes the files to be unlinked.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2649 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2650 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2651 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2652 Dropping the legacy approach and converting to the new approach
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2653 completely, simplified the code base.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2654 The relationship between
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2655 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2656 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2657 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2658 was inverted.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2659 In mmh,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2660 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2661 invokes
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2662 .Pn refile .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2663 That used to be the other way round.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2664 Yet, the relationship is simpler now.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2665 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	2666 .Mp refile (1),
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2667 can no longer occur:
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2668 .QS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2669 Since
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2670 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2671 uses your
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2672 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2673 to delete the message, the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2674 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2675 must NOT call
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2676 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2677 without specifying
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2678 .Sw -normmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2679 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	2680 .QE
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2681 .LP
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2682 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2683 either unlinks a message with
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2684 .Fu unlink()
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2685 or invokes
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2686 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2687 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	2688 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2689 does not invoke any tools.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2690 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2691 By generalizing the message removal in the way that it became covered
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2692 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	2693
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2694
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2695
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2696
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2697
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2698 .H2 "Modern Defaults
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2699 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2700 Nmh has a bunch of convenience-improving features inactive by default,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2701 although one can expect every new user to want them active.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2702 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	2703 with old versions.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2704 But what are old versions?
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2705 Still, the highly useful draft folder facility has not been activated
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2706 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	2707 .[
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2708 rose romine real work
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2709 .]
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2710 The community seems not to care.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2711 .P
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2712 In nmh, new users are required to first build up
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2713 a profile before they can access the modern features.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2714 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	2715 for modern emailing.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2716 The point is not the customization of the setup,
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2717 but the need to activate generally useful facilities.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2718 Yet, the real problem lies less in enabling the features,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2719 as this is 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	2720 The real problem is that new users need deep insight into the project
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2721 to discover the available but inactive features.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2722 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	2723 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	2724 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	2725 documentation.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2726 If I would have installed nmh from source back then, I could agree.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2727 Yet, I had used a pre-packaged version and had expected that it would
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2728 just work.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2729 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	2730 and I am a software developer,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2731 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	2732 How can we expect users to be even more advanced than me,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2733 just to enable them to use MH in a convenient and modern way?
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2734 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	2735 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	2736 before they truly used the system,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2737 although they had been motivated in the beginning.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2738 New users 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	2739 we developers should spare them further inconveniences.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2740 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2741 Maintaining compatibility for its own sake is bad,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2742 because the code base will collect more and more compatibility code.
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	2743 Sticking to the compatibility code means remaining limited;
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2744 whereas adjusting to the changes renders the compatibility unnecessary.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2745 Keeping unused alternatives in the code for longer than a short
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2746 grace time is a bad choice as they likely
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2747 gather bugs by not being constantly tested.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2748 Also, the increased code size and the greater number of conditions
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2749 increase the maintenance costs.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2750 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	2751 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	2752 important.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2753 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	2754 Hence, compatibility is hardly important for technical reasons.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2755 Its importance originates from personal reasons rather.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2756 Nmh's user base is small and old.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2757 Changing the interfaces causes inconvenience to long-term users of MH.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2758 It forces them to change their many years old MH configurations.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2759 I do understand this aspect, but by sticking to the old users,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2760 new users are kept from entering the world of MH.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2761 But the future lies in new users.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2762 In consequence, mmh invites new users by providing a convenient
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2763 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	2764 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2765 In mmh, all modern features are active by default and many previous
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2766 approaches are removed or only accessible in a manual way.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2767 New default features include:
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2768 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2769 The attachment system (\c
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2770 .Hd Attach )
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2771 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1 .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2772 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2773 The draft folder facility (\c
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2774 .Fn +drafts )
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2775 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2776 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2777 The unseen sequence (`u')
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2778 .Ci c2360569e1d8d3678e294eb7c1354cb8bf7501c1
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2779 and the sequence negation prefix (`!')
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2780 .Ci db74c2bd004b2dc9bf8086a6d8bf773ac051f3cc .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2781 .BU
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2782 Quoting the original message in the reply
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2783 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6 .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2784 .BU
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2785 Forwarding messages using MIME
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2786 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1 .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2787 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2788 An mmh setup with a profile that defines only the path to the
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2789 mail storage, is already convenient to use.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2790 Again, Paul Vixie's supports the direction I took:
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2791 ``the `main branch' should just be modern''.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2792 .[
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2793 paul vixie edginess nmh-workers
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2794 .]
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2795
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2796
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2797
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
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2800 .\" --------------------------------------------------------------
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2801 .H1 "Styling
16 81f703140554 Wrote about the trash folder. markus schnalke <meillo@marmaro.de> parents: 14 diff changeset	2802 .P
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2803 Kernighan and Pike have emphasized the importance of style in the
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2804 preface of \fPThe Practice of Programming\fP:
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2805 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2806 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	2807 .], p. x]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2808 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2809 Chapter 1 discusses programming style.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2810 Good style is so important to good programming that we have chosen
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2811 to cover it first.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2812 .QE
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2813 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	2814 to improve on style.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2815 Many of them follow the advice given in the quoted book.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2816
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2817
127 4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2818
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2819
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2820 .H2 "Code Style
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2821 .Id code-style
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2822 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2823 .U3 "Indentation Style
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2824 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2825 Indentation styles are the holy cow of programming.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2826 Kernighan and Pike write:
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2827 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2828 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	2829 .], p. 10]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2830 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2831 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	2832 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	2833 application.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2834 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	2835 time arguing.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2836 .QE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2837 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2838 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	2839 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	2840 For instance the indentation with tab characters only.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2841 The number of tabs corresponds to the nesting level \(en
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2842 one tab, one level.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2843 Tab characters provide flexible visual appearance because developers
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2844 can adjust their width as prefered.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2845 There is no more need to check for the correct mixture of
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2846 tabs and spaces.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2847 Two simple rules ensure the integrity and flexibility of the visual
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2848 appearance:
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2849 .LI 1
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2850 Leading whitespace must consist of tabs only.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2851 .LI 2
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2852 All other whitespace should be spaces.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2853 .LP
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2854 Although reformatting existing code should be avoided, I did it.
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	2855 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	2856 .Ci a485ed478abbd599d8c9aab48934e7a26733ecb1
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2857
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2858 .U3 "Comments
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2859 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2860 Kernighan and Pike demand: ``Don't belabor the obvious''.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2861 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2862 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	2863 .], p. 23]
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2864 Following the advice, I removed unnecessary comments.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2865 For instance, I removed all comments in the following code excerpt
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2866 .Ci 426543622b377fc5d091455cba685e114b6df674 :
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2867 .VS
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2868 context_replace(curfolder, folder); /* update current folder */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2869 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	2870 seq_save(mp); /* synchronize message sequences */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2871 folder_free(mp); /* free folder/message structure */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2872 context_save(); /* save the context file */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2873
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2874 [...]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2875
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2876 int c; /* current character */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2877 char cp; / miscellaneous character pointer */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2878
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2879 [...]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2880
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2881 /* NUL-terminate the field */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2882 *cp = '\0';
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2883 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2884 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2885 The information in each of the comments was present in the code
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2886 statements already, except for the NUL-termination, which became
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2887 obvious from the context.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2888
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2889
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2890 .U3 "Names
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2891 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2892 Regarding this topic, Kernighan and Pike suggest:
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2893 ``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	2894 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2895 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	2896 .], p. 4]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2897 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	2898 .Fu check_charset()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2899 to
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2900 .Fu is_native_charset()
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2901 .Ci 8d77b48284c58c135a6b2787e721597346ab056d .
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2902 The same change additionally fixed a violation of ``Be accurate'',
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	2903 .[ [
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	2904 kernighan pike practice of programming
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	2905 .], p. 4]
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2906 as the code did not match the expectation the function suggested.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2907 It did not compare charset names but prefixes of them only.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2908 In case the native charset was `ISO-8859-1', then
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2909 .VS
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2910 check_charset("ISO-8859-11", strlen("ISO-8859-11"))
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2911 VE
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2912 had returned true although the upper halves of the code pages
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2913 are different.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2914 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2915 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	2916 .VS
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2917 m_unknown(in); /* the MAGIC invocation... */
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2918 VE
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2919 Renaming the obscure
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2920 .Fu m_unknown()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2921 function was a delightful event, although it made the code less funny
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2922 .Ci 611d68d19204d7cbf5bd585391249cb5bafca846 .
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2923 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2924 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	2925 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	2926 ``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	2927 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2928 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	2929 .], p. 19]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2930 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2931 The argument
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2932 .CW outnum
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2933 of the function
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2934 .Fu scan()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2935 in
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2936 .Fn uip/scansbr.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2937 holds the number of the message to be created.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2938 As well it encodes program logic with negative numbers and zero.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2939 This led to obscure code.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2940 I clarified the code by introducing two variables that extracted
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2941 the hidden information:
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2942 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2943 int incing = (outnum > 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2944 int ismbox = (outnum != 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2945 VE
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2946 The readable names are thus used in conditions;
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2947 the variable
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2948 .CW outnum
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2949 is used only to extract ordinary message numbers
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2950 .Ci b8b075c77be7794f3ae9ff0e8cedb12b48fd139f .
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2951 .P
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2952 Through the clarity improvement of the change detours in the program
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2953 logic of related code parts became apparent.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2954 The implementation was simplified.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2955 This possibility to improve had been invisible before
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2956 .Ci aa60b0ab5e804f8befa890c0a6df0e3143ce0723 .
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2957 .P
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2958 The names just described were a first step, yet the situation
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2959 was further improved by giving names to the magic values of
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2960 .CW outnum :
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2961 .VS
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2962 #define SCN_MBOX (-1)
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2963 #define SCN_FOLD 0
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2964 VE
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2965 The two variables were updated thereafter as well:
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2966 .VS
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2967 int incing = (outnum != SCN_MBOX && outnum != SCN_FOLD);
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2968 int scanfolder = (outnum == SCN_FOLD);
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2969 VE
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2970 Furthermore,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2971 .CW ismbox
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2972 was replaced by
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2973 .CW scanfolder
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2974 because that matched better to the program logic.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2975 .Ci 7ffb36d28e517a6f3a10272056fc127592ab1c19
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2976
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2977
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2978
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2979
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2980 .H2 "Structural Rework
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2981 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2982 Although the stylistic changes described already improve the
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2983 readability of the source code, all of them were changes ``in the small''.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2984 Structural changes, in contrast, affect much larger code areas.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2985 They are more difficult to accomplish but lead to larger improvements,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2986 especially as they often 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	2987 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2988 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	2989 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	2990 .[ [
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	2991 kernighan pike practice of programming
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2992 .], p. 28].
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2993 Following are two examples of structural rework that demonstrate
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2994 why style is important in the first place.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2995
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2996
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2997 .U3 "Rework of \f(CWanno\fP
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2998 .P
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2999 Until 2002,
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3000 .Pn anno
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3001 had six functional command line switches:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3002 .Sw -component
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3003 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3004 .Sw -text ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3005 each with an argument,
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3006 and the two pairs of flags,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3007 .Sw -[no]date
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3008 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3009 .Sw -[no]inplace .
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3010 Then Jon Steinhart introduced his attachment system.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3011 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	3012 .Pn anno .
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3013 He added five more switches:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3014 .Sw -draft ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3015 .Sw -list ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3016 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3017 .Sw -append ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3018 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3019 .Sw -number ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3020 the last one taking an argument
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3021 .Ci 7480dbc14bc90f2d872d434205c0784704213252 .
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3022 Later,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3023 .Sw -[no]preserve
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3024 was added as well
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3025 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f .
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3026 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	3027 .Mp anno (1)
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3028 read:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3029 .VS
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3030 anno [+folder] [msgs] [-component f(CIfieldfP] [-inplace \| -noinplace]
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3031 [-date \| -nodate] [-draft] [-append] [-list] [-delete]
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3032 [-number [f(CInumfP\|fPallfP]] [-preserve \| -nopreserve] [-version]
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3033 [-help] [-text f(CIbodyfP]
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3034 VE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3035 .LP
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3036 The implementation followed the same structure.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3037 Problems became visible when
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3038 .Cl "anno -list -number 42
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3039 worked on the current message instead of on message number 42,
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3040 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3041 .Cl "anno -list -number l:5
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	3042 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	3043 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	3044 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	3045 There, the correct use of
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3046 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3047 was defined as being
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3048 .Cl "[-number [num\|all]]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3049 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	3050 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3051 read:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3052 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3053 The
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3054 .Sw -list
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3055 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	3056 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	3057 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	3058 .Sw -number
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3059 option is also used.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3060 .QE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3061 .LP
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3062 The problem was manifold.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3063 Semantically, the argument to the
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3064 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3065 switch is only necessary in combination with
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3066 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3067 but not with
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3068 .Sw -list .
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3069 The code, however, required a numeric argument in any case.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3070 If the argument was missing or non-numeric,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3071 .Pn anno
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3072 aborted with an error message that additionally had an off-by-one error.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3073 It printed the name of the switch one before the concerned one.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3074 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3075 Trying to fix these problems on the surface would not have solved them.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3076 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	3077 structure of the problem and the structure implemented in the program.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3078 Such structural differences can only be solved by adjusting the
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3079 structure of the implementation to the structure of the problem.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3080 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3081 Steinhart had added the new
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3082 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3083 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3084 .Sw -delete
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3085 switches in a style similar to the other switches though
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3086 they are of structural different type.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3087 Semantically,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3088 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3089 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3090 .Sw -delete
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3091 introduce operation modes.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3092 Historically,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3093 .Pn anno
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3094 had only one operation mode: adding header fields.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3095 With the extension, two more modes were added:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3096 listing and deleting header fields.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3097 The structure of the code changes did not pay respect to this
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3098 fundamental change.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3099 Neither the implementation nor the documentation did clearly
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3100 declare the exclusive operation modes as such.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3101 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	3102 .Pn anno
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3103 and its documentation
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3104 .Ci d54c8db8bdf01e8381890f7729bc0ef4a055ea11 .
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3105 .P
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3106 The difference is visible in both the code and the documentation.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3107 For instance in the following code excerpt:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3108 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3109 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	3110 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	3111 [...]
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3112 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3113 delete = 0;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3114 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3115 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3116 list = 1;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3117 continue;
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3118 VE
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3119 .LP
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3120 which was replaced by:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3121 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3122 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	3123 [...]
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3124 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3125 mode = MODE_DEL;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3126 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3127 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3128 mode = MODE_LIST;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3129 continue;
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3130 VE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3131 .LP
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3132 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	3133 it is easier to understand as well.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3134 The same applies to the documentation.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3135 The man page was completely reorganized to propagate the same structure.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3136 This is already visible in the Synopsis section:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3137 .VS
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3138 anno [+folder] [msgs] [-component f(CIfieldfP] [-text fPbodyfP]
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3139 [-append] [-date \| -nodate] [-preserve \| -nopreserve]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3140 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3141
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3142 anno -delete [+folder] [msgs] [-component fPfieldfP] [-text
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3143 fPbodyfP] [-number fPnum fP\| fPall fP] [-preserve \| -nopreserve]
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3144 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3145
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3146 anno -list [+folder] [msgs] [-component fPfieldfP] [-number]
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3147 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3148 VE
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3149
16 81f703140554 Wrote about the trash folder. markus schnalke <meillo@marmaro.de> parents: 14 diff changeset	3150
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	3151
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3152 .U3 "Path Conversion
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3153 .P
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3154 Four kinds of path names can appear in MH:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3155 .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	3156 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	3157 .Fn /etc/passwd .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3158 .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	3159 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	3160 .Fn ./foo/bar .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3161 .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	3162 Absolute MH folder paths, like
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3163 .Fn +projects/mmh .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3164 .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	3165 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	3166 .Fn @subfolder .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3167 .LP
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3168 Relative MH folder paths, are hardly documented
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3169 although they are useful for large mail storages.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3170 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	3171 .Fn @ ',
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3172 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	3173 .Fn . '.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3174 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3175 To allow MH tools to understand all four notations,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3176 they need to be able to convert between them.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3177 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	3178 .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	3179 (``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	3180 .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	3181 (``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	3182 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	3183 than two comments, which described obvious information.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3184 The signatures of the four exported functions did not explain their
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3185 semantics:
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3186 .LI 1
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3187 .CW "char path(char , int);
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3188 .LI 2
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3189 .CW "char pluspath(char );
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3190 .LI 3
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3191 .CW "char m_mailpath(char );
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3192 .LI 4
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3193 .CW "char m_maildir(char );
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3194 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3195 My investigations provided the following descriptions:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3196 .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	3197 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	3198 .Fu path()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3199 defines the type as which the path given in the first parameter should
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3200 be treated.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3201 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	3202 Folder paths are converted to absolute folder paths.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3203 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	3204 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	3205 The result is a pointer to newly allocated memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3206 .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	3207 .Fu pluspath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3208 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	3209 .Fu path() ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3210 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	3211 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	3212 An empty string parameter causes a buffer overflow.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3213 .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	3214 .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	3215 converts directory paths to absolute directory paths.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3216 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	3217 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	3218 Hence, this function can not be used for folder paths.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3219 In any case, the result is an absolute directory path,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3220 returned as a pointer to newly allocated memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3221 .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	3222 .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	3223 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	3224 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	3225 All other strings are prepended with the current working directory.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3226 Hence, this function can not be used for folder paths.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3227 The result is either an absolute directory path or a relative
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3228 directory path, starting with dot or dot-dot.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3229 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	3230 static memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3231 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3232 The situation was obscure, irritating, error-prone, and non-orthogonal.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3233 Additionally, no clear terminology was used to name the different
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3234 kinds of path names.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3235 Sometimes, the names were even misleading, much as the first argument of
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3236 .Fu m_mailpath() ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3237 which was named
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3238 .CW folder ,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3239 although
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3240 .Fu m_mailpath()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3241 could not be used with MH folder arguments.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3242 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3243 I clarified the path name conversion by complete rework.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3244 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	3245 A path name is either in the Unix domain, then it is called
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3246 \fIdirectory path\fP (\fIdirpath\fP for short) or it is in the MH domain,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3247 then it is called \fIfolder path\fP (\fIfolpath\fP for short).
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3248 The two terms need to be used with strict distinction.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3249 Often a clear terminology indicates that the problem is understood.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3250 Second, I exploited the concept of path type indicators.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3251 By requiring every path name to start with a distinct type identifier,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3252 the conversion between the types could be fully automated.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3253 This allows the tools to accept paths of any type from the user.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3254 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	3255 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	3256 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	3257 current message.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3258 .Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3259 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	3260 .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	3261 .Fu expandfol()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3262 converts folder paths to absolute folder paths.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3263 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	3264 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	3265 The result is a pointer to static memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3266 .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	3267 .Fu expanddir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3268 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	3269 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	3270 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	3271 The result is a pointer to static memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3272 .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	3273 .Fu toabsdir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3274 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	3275 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	3276 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	3277 path name.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3278 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	3279 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3280 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	3281 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	3282 same type.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3283 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	3284 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	3285 All of the functions return pointers to static memory.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3286 The file
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3287 .Fn sbr/path.c
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3288 contains the implementation of the functions;
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3289 .Fn sbr/m_maildir.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3290 was removed.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3291 .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	3292 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3293 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	3294 .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	3295 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3296 .Fu getdeffol()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3297 and
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3298 .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	3299 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3300 .Fu getcurfol() ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3301 which only wraps
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3302 .Fu expandfol(""@"")
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3303 for convenience.
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3304 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	3305 .Fn sbr/getfolder.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3306 into
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3307 .Fn sbr/path.c
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3308 as well.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3309 .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	3310 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3311 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	3312 .Fu etcpath()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3313 is now included in
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3314 .Fn sbr/path.c ,
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3315 too
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3316 .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	3317 Previously, it had been located in
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3318 .Fn config/config.c .
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3319 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3320 Now,
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3321 .Fn sbr/path.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3322 contains all path handling code.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3323 Besides being less code, its readability is highly improved.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3324 The functions follow a common style and are well documented.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3325
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3326
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3327
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3328
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3329 .H2 "Profile Reading
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3330 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3331 The MH profile contains the configuration of a user-specific MH setup.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3332 MH tools read the profile right after starting up
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3333 because it contains the location of the user's mail storage
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3334 and similar settings that influence the whole setup.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3335 Furthermore, the profile contains the default switches for the tools
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3336 as well.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3337 The context file is read along with the profile.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3338 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3339 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	3340 Among them were
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3341 .Pn post /\c
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3342 .Pn spost ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3343 .Pn mhmail ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3344 and
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3345 .Pn slocal .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3346 The reason why these tools ignored the profile were not clearly stated.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3347 During a 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	3348 David Levine posted an explanation, quoting John Romine:
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3349 .[
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3350 nmh-workers levine post profile
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3351 .]
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3352
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3353 .QS
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3354 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	3355 agrees and provides an example that convinces me:
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3356 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3357 My take on this is that
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3358 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3359 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	3360 .Fn .mh_profile
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3361 (only front-end UI programs read the profile).
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3362 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3363 For example, there can be contexts where
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3364 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3365 is called by a helper program (like `\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3366 .Pn mhmail ')
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3367 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	3368 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	3369 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3370 My suggestion would be to have
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3371 .Pn send
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3372 pass a (hidden) `\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3373 .Sw -fileproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3374 .Ar proc '
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3375 option to
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3376 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3377 if needed.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3378 You could also
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3379 use an environment variable (I think
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3380 .Pn send /\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3381 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3382 do this).
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3383 .QE
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3384 .sp \n(PDu
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3385 I think that's the way to go.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3386 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	3387 not an environment variable.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3388 .QE
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3389
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3390 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3391 To solve the problem that
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3392 .Pn post
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3393 does not honor the
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3394 .Pe fileproc
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3395 profile entry,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3396 the community roughly agreed that a switch
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3397 .Sw -fileproc
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3398 should be added to
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3399 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3400 to be able to pass a different fileproc.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3401 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	3402 the problem; it only removes a single symptom.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3403 The actual problem is that
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3404 .Pn post
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3405 does not behave as expected,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3406 though all programs should behave as expected.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3407 Clear and general concepts are a precondition for this.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3408 Thus, there should be no separation into ``front-end UI programs''
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3409 and ones that ``should not be called by users directly''.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3410 The real solution is having all MH tools read the profile.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3411 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3412 But the problem has a further aspect,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3413 which originates from
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3414 .Pn mhmail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3415 mainly.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3416 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3417 was intended to be a replacement for
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3418 .Pn mailx
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3419 on systems with MH installations.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3420 In difference to
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3421 .Pn mailx ,
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3422 .Pn mhmail
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3423 used MH's
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3424 .Pn post
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3425 to send the message.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3426 The idea was that using
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3427 .Pn mhmail
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3428 should not be influenced whether the user had
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3429 MH set up for himself or not.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3430 Therefore
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3431 .Pn mhmail
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3432 had not read the profile.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3433 As
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3434 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3435 used
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3436 .Pn post ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3437 .Pn post
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3438 was not allowed to read the profile neither.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3439 This is the reason for the actual problem.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3440 Yet, this was not considered much of a problem because
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3441 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3442 was not intended to be used by users directly.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3443 To invoke
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3444 .Pn post ,
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3445 .Pn send
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3446 was used an a front-end.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3447 .Pn send
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3448 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	3449 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3450 \(en an awkward solution.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3451 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3452 The important insight is that
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3453 .Pn mhmail
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3454 is a wolf in sheep's clothing.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3455 This alien tool broke the concepts because it was treated like
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3456 a normal MH tool.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3457 Instead it should have been treated accordingly to its foreign style.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3458 .P
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3459 The solution is not to prevent the tools from reading the profile but
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3460 to instruct them to read a different profile.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3461 .Pn mhmail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3462 could have set up a well-defined profile and caused the following
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3463 .Pn post
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3464 to use this profile by exporting an environment variable.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3465 With this approach, no special cases would have been introduced
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3466 and no surprises would have been caused.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3467 By writing a wrapper program to provide a clean temporary profile,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3468 the concept could have been generalized orthogonally to the whole
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3469 MH tool chest.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3470 .P
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3471 In mmh, the wish to have
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3472 .Pn mhmail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3473 as a replacement for
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3474 .Pn mailx
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3475 is considered obsolete.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3476 Mmh's
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3477 .Pn mhmail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3478 does no longer cover this use-case
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3479 .Ci d36e56e695fe1c482c7920644bfbb6386ac9edb0 .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3480 Currently,
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3481 .Pn mhmail
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3482 is in a transition state
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3483 .Ci 32d4f9daaa70519be3072479232ff7be0500d009 .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3484 It may become a front-end to
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3485 .Pn comp ,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3486 which provides an alternative interface which can be more convenient
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3487 in some cases.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3488 This would convert
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3489 .Pn mhmail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3490 into an ordinary MH tool.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3491 If, however, this idea does not convince, then
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3492 .Pn mhmail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3493 will be removed.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3494 .P
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3495 In the mmh tool chest, every program reads the profile.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3496 (\c
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3497 .Pn slocal
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3498 is not considered part of the mmh tool chest (cf. Sec.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3499 .Cf slocal ).)
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3500 Mmh has no
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3501 .Pn post
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3502 program, but it has
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3503 .Pn spost ,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3504 which now does read the profile
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3505 .Ci 3e017a7abbdf69bf0dff7a4073275961eda1ded8 .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3506 Following this change,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3507 .Pn send
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3508 and
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3509 .Pn spost
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3510 can be considered for merging.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3511 Besides
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3512 .Pn send ,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3513 .Pn spost
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3514 is only invoked directly by the to-be-changed
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3515 .Pn mhmail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3516 implementation and by
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3517 .Pn rcvdist ,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3518 which requires rework anyway.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3519
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3520 .P
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3521 Jeffrey Honig quoted Marshall T. Rose explaining the decision that
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3522 .Pn post
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3523 ignores the profile:
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3524 .[
197 05a243dffaca Added refs to the Preface; splitted the bib. markus schnalke <meillo@marmaro.de> parents: 187 diff changeset	3525 nmh-workers honig post profile
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3526 .]
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3527 .QS
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3528 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	3529 what the man page says.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3530 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	3531 .QE
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3532 .LP
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3533 The explanation neither matches the problem concered exactly
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3534 nor is the interpretation clear.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3535 If the described desire addresses the technical level,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3536 then it conflicts fundametally with the Unix philosophy,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3537 precisely because the indistinquishability of human and script
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3538 input is the main reason for the huge software leverage in Unix.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3539 If, however, the described desire addresses the user's view,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3540 then different technical solutions are more appropriate.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3541 The two cases can be regarded simply as two different MH setups.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3542 Hence, mapping the problem of different behavior between interactive and
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3543 automated use on the concept of switching between different profiles,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3544 marks it already solved.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3545
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3546
127 4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	3547
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3548 .H2 "Standard Libraries
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	3549 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3550 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	3551 Hence, MH included own implementations of functions
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3552 that were neither standardized nor widely available, back then.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3553 Today, twenty years after POSIX and ANSI C were published,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3554 developers can expect that systems comply with these standards.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3555 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	3556 can and should be dropped.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3557 Kernighan and Pike advise: ``Use standard libraries''.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3558 .[ [
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3559 kernighan pike practice of programming
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3560 .], p. 196]
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3561 Actually, MH had followed this advice in history,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3562 but it had not adjusted to more recent changes in this field.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3563 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3564 .Fu snprintf()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3565 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	3566 almost everywhere because of its high usefulness.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3567 Thus, the project's own implementation of
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3568 .Fu snprintf()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3569 was dropped in March 2012 in favor for using the one of the
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3570 standard library
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3571 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32 .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3572 Such decisions limit the portability of mmh
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3573 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	3574 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	3575 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3576 As I am still in my twenties, have no programming experience from
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3577 past decades.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3578 I have not followed the evolution of C through time.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3579 I have not suffered from the the Unix wars.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3580 I have not longed for standardization.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3581 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	3582 were well established already.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3583 Thus, I needed to learn about the history in retrospective.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3584 I have only read a lot of books about the (good) old times.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3585 This put 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	3586 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	3587 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	3588 heart from their own experience.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3589 Being aware of the situation, I rather let people with more historic
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3590 experience do the transition from ancient code constructs to
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3591 standardized ones.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3592 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	3593 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	3594 also removing the conditionals compilation of now standardized features.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3595 Ken Hornstein and David Levine had their part in this work, as well.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3596 Often, I only pulled the changes over from nmh into mmh.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3597 These changes include many commits, among them:
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3598 .Ci 768b5edd9623b7238e12ec8dfc409b82a1ed9e2d
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3599 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	3600 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3601 Nevertheless, I worked on the task as well, tidying up the
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3602 \fIMH standard library\fP,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3603 .Fn libmh.a .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3604 It is located in the
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3605 .Fn sbr
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3606 (``subroutines'') directory in the source tree and
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3607 includes functions that mmh tools usually need.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3608 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	3609 and folder handling, but as well
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3610 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	3611 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	3612 functions of the standard library.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3613 .BU
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3614 I have replaced the
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3615 .Fu atooi()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3616 function with calls to
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3617 .Fu strtoul() ,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3618 setting the third parameter, the base, to eight.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3619 .Fu strtoul()
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3620 is part of C89 and thus considered safe to use
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3621 .Ci c490c51b3c0f8871b6953bd0c74551404f840a74 .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3622 .BU
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3623 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	3624 .Fu memmove()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3625 and
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3626 .Fu strerror()
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3627 .Ci b067ff5c465a5d243ce5a19e562085a9a1a97215 ,
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3628 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	3629 to support SunOS 4.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3630 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	3631 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	3632 put a load on mmh.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3633 .BU
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3634 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3635 .Fu copy()
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3636 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	3637 parameter two.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3638 In contrast to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3639 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3640 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	3641 The code was adjusted to replace
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3642 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3643 with
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3644 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3645 except within
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3646 .Fu concat() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3647 where
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3648 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3649 was more convenient.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3650 Therefore, the definition of
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3651 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3652 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	3653 .Fu concat()
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3654 and its visibility it limited to that
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3655 .Ci 552fd7253e5ee9e554c5c7a8248a6322aa4363bb .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3656 .BU
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3657 The function
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3658 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3659 had been a generalized version of
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3660 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3661 with minor differences.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3662 As all calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3663 .Fu r1bindex()
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3664 had the slash (`\fL/\fP') as delimiter anyway,
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3665 replacing
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3666 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3667 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	3668 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3669 became desirable.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3670 Unfortunately, many of the 54 calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3671 .Fu r1bindex()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3672 depended on a special behavior,
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3673 which differed from the POSIX specification for
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3674 .Fu basename() .
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3675 Hence,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3676 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3677 was kept but renamed to
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3678 .Fu mhbasename() ,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3679 setting the delimiter to the slash
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3680 .Ci 240013872c392fe644bd4f79382d9f5314b4ea60 .
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3681 For possible uses of
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3682 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3683 with a different delimiter,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3684 the ANSI C function
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3685 .Fu strrchr()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3686 provides the core functionality.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3687 .BU
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3688 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3689 .Fu ssequal()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3690 function \(en apparently for ``substring equal'' \(en
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3691 was renamed to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3692 .Fu isprefix() ,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3693 because this is what it actually checked
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3694 .Ci c20b4fa14515c7ab388ce35411d89a7a92300711.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3695 Its source file had included both of the following comments, no joke.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3696 .in -\n(PIu
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3697 .VS
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3698 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3699 * THIS CODE DOES NOT WORK AS ADVERTISED.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3700 * 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	3701 * 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	3702 * 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	3703 * should be kept if it's sufficient.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3704 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3705
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3706 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3707 * 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	3708 * 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	3709 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3710 VE
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3711 .in +\n(PIu
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3712 Eventually, the function was completely replaced with calls to
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3713 .Fu strncmp()
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3714 .Ci b0b1dd37ff515578cf7cba51625189eb34a196cb .
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3715
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3716
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3717
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3718
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3719
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3720 .H2 "User Data Locations
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3721 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3722 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	3723 The profile is a file named
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3724 .Fn \&.mh_profile
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3725 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3726 It contains the static configuration.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3727 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	3728 .Pe Path .
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3729 The MH directory contains the mail storage and is the first
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3730 place to search for form files, scan formats, and similar
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3731 configuration files.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3732 The location of the MH directory can be chosen freely by the user.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3733 The usual name is a directory named
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3734 .Fn Mail
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3735 in the user's home directory.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3736 .P
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	3737 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	3738 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	3739 configuration file.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3740 Why else should the mail storage and the configuration files be intermixed?
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3741 They are of different kind:
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3742 One kind is the data to be operated on and the other kind is
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3743 the configuration to change how tools operate.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3744 Splitting the configuration between the profile and the MH directory
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3745 is inappropriate, as well.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3746 I improved the situation by breaking compatibility.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3747 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3748 In mmh, personal data is grouped by type.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3749 This results in two distinct parts:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3750 the mail storage and the configuration.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3751 The mail storage directory still contains all the messages,
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3752 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	3753 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	3754 located there.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3755 Therefore, the directory is no longer called the user's \fIMH directory\fP
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3756 but the user's \fImail storage\fP.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3757 Its location is still user-chosen, with the default name
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3758 .Fn Mail
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3759 in the user's home directory.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3760 The configuration is grouped together in the hidden directory
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3761 .Fn \&.mmh
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3762 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3763 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	3764 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	3765 .Fn profile .
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3766 The path to the profile is no longer
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3767 .Fn $HOME/.mh_profile
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3768 but
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3769 .Fn $HOME/.mmh/profile .
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3770 (The alternative of having file
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3771 .Fn $HOME/.mh_profile
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3772 and a configuration directory
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3773 .Fn $HOME/.mmh
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3774 appeared to be inconsistent.)
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3775 .P
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3776 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	3777 Unix users.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3778 The main achievement of the change is the clear and sensible separation
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3779 of the mail storage and the configuration.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3780 .Ci 7030d7edb099bff36ded7548bb5380f7acab4f9b
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3781 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3782 As MH allows users to have multiple MH setups,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3783 it is necessary to switch the profile.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3784 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	3785 personal MH setup.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3786 In nmh, the environment variable
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3787 .Ev MH
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3788 is used to specify a different profile.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3789 To operate in the same MH setup with a separate context, the
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3790 .Ev MHCONTEXT
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3791 environment variable is used.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3792 This allows having a separate current folder in each terminal at
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3793 the same time, for instance.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3794 In mmh, three environment variables replace the two of nmh.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3795 .Ev MMH
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3796 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	3797 .Fn .mmh ).
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3798 .Ev MMHP
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3799 and
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3800 .Ev MMHC
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3801 override the paths to the profile and context file, respectively.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3802 This approach allows the set of personal configuration files to be chosen
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3803 independently of the profile, context, and mail storage.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3804 The new approach has no functional disadvantages,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3805 as every setup I can imagine can be implemented with both approaches,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3806 possibly even easier with the new one.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3807 .Ci 7030d7edb099bff36ded7548bb5380f7acab4f9b
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3808
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3809
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3810
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3811
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3812
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3813 .H2 "Modularization
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3814 .Id modularization
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3815 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3816 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	3817 .Fn uip
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3818 (``user interface programs'') directory.
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3819 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	3820 For example,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3821 .Pn rmm
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3822 is built from
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3823 .Fn uip/rmm.c .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3824 Some source files are used for multiple programs.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3825 For example
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3826 .Fn uip/scansbr.c
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3827 is used for both
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3828 .Pn scan
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3829 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3830 .Pn inc .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3831 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	3832 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	3833 32 programs depended on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3834 17 programs depended on one source file only.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3835 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	3836 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	3837 18 programs depend on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3838 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	3839 (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	3840 as well as shell scripts and multiple names for the same program.)
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3841 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3842 Splitting the source code of a large program into multiple files can
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3843 increase the readability of its source code,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3844 but most of the mmh tools are small and straight-forward programs.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3845 In exception of the MIME handling tools (i.e.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3846 .Pn mhbuild ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3847 .Pn mhstore ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3848 .Pn show ,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3849 etc.),
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3850 .Pn pick
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3851 is the only tool with more than one thousand lines of source code.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3852 Splitting programs with less than one thousand lines of code into
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3853 multiple source files leads seldom to better readability.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3854 For such tools, splitting still makes sense
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3855 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	3856 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	3857 for including it in the MH library
b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	3858 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	3859 .Fn uip/packsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3860 for instance, provides the core program logic for the
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3861 .Pn packf
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3862 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3863 .Pn rcvpack
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3864 programs.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3865 .Fn uip/packf.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3866 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3867 .Fn uip/rcvpack.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3868 mainly wrap the core function appropriately.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3869 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	3870 As another example,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3871 .Fn uip/termsbr.c
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3872 accesses terminal properties, which requires linking with the
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3873 \fItermcap\fP or a \fIcurses\fP library.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3874 If
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3875 .Fn uip/termsbr.c
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3876 is included in the MH library, then every program needs to be linked
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3877 with termcap or curses, although only few of the programs use
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3878 the library.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3879 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3880 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	3881 into multiple source files improves the readability.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3882 The program
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3883 .Pn mhstore ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3884 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	3885 lines of code in summary.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3886 The main code file
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3887 .Fn uip/mhstore.c
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3888 consists of 800 lines; the other 1\\|700 lines are code reused in
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3889 other MIME handling tools.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3890 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	3891 a MH-MIME library, as a companion to the MH standard library.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3892 This is left to be done.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3893 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	3894 The work already accomplished focussed on the non-MIME tools.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3895 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	3896 This eases the understanding of the code base.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3897 In nmh,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3898 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3899 was built from six source files:
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3900 .Fn comp.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3901 .Fn whatnowproc.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3902 .Fn whatnowsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3903 .Fn sendsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3904 .Fn annosbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3905 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3906 .Fn distsbr.c .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3907 In mmh, it builds from only two:
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3908 .Fn comp.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3909 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3910 .Fn whatnowproc.c .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3911 In nmh's
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3912 .Pn comp ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3913 the core function of
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3914 .Pn whatnow ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3915 .Pn send ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3916 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3917 .Pn anno
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3918 were all compiled into
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3919 .Pn comp .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3920 This saved the need to execute these programs with
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3921 the expensive system calls
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3922 .Fu fork()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3923 and
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3924 .Fu exec() .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3925 Whereas this approach improved the time performance,
346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3926 it interwove the source code.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3927 Core functionalities were not encapsulated into programs but into
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3928 function, which were then wrapped by programs.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3929 For example,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3930 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3931 included the function
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3932 .Fu annotate() .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3933 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	3934 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3935 and called
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3936 .Fu annotate() .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3937 Because the function
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3938 .Fu annotate()
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3939 was used like the tool
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3940 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3941 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	3942 When another pair of command line switches was added to
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3943 .Pn anno ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3944 a rather ugly hack was implemented to avoid adding another parameter
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3945 to the function
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3946 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f .
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3947 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3948 In mmh, the relevant code of
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3949 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3950 comprises the two files
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3951 .Fn uip/comp.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3952 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3953 .Fn uip/whatnowproc.c ,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3954 together 210 lines of code,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3955 whereas in nmh,
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3956 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3957 comprises six files with 2\\|450 lines.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3958 Not all of the code in these six files is actually used by
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3959 .Pn comp ,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3960 but the reader needed to read it all to know which parts are relevant.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3961 Understanding nmh's
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3962 .Pn comp ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3963 required understanding the inner workings of
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3964 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3965 first.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3966 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	3967 to be examined.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3968 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	3969 have avoided obscure programming techniques.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3970 Here, it should be recalled that information passed in obscure ways
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3971 through the program's source base, due to the aforementioned hack
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3972 to save an additional parameter in nmh's
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3973 .Pn anno .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3974 .P
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3975 In mmh, understanding
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3976 .Pn comp
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3977 requires to read only 210 lines of code to read, whereas the amount
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3978 is ten times more for nmh's
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3979 .Pn comp .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3980 .P
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3981 By separating the tools on the program-level,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3982 the boundaries are clearly visible, as the interfaces are calls to
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3983 .Fu exec()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3984 rather than arbitrary function calls.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3985 Additionally, this kind of separation is more strict because
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3986 it is technically enforced by the operating system;
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3987 it can not be simply bypassed with global variables.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3988 Good separation simplifies the understanding of program code
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3989 because the area influenced by any particular statement is small.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3990 As I have read a lot in nmh's code base during the last two years,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3991 I have learned about the easy and the difficult parts.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3992 In my observation, the understanding of code is enormously eased
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3993 if the influenced area is small and clearly bounded.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3994 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	3995 Yet, the real problem is another:
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3996 Nmh violates the golden ``one tool, one job'' rule of the Unix philosophy.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3997 Understanding
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3998 .Pn comp
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3999 requires understanding
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4000 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4001 and
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4002 .Fn uip/sendsbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4003 because
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4004 .Pn comp
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4005 annotates and sends messages.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4006 In nmh, there surely exist the tools
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4007 .Pn anno
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4008 and
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4009 .Pn send ,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4010 which cover these jobs,
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4011 but
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4012 .Pn comp
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4013 and
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4014 .Pn repl
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4015 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4016 .Pn forw
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4017 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4018 .Pn dist
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4019 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4020 .Pn whatnow
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4021 and
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4022 .Pn viamail
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4023 \(en they all (!) \(en
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4024 have the same annotating and sending functions included, once more.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4025 As a result,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4026 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4027 sends messages without using
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4028 .Pn send .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4029 The situation is the same as if
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4030 .Pn grep
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4031 would page its output without using
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4032 .Pn more
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4033 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	4034 .P
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4035 The clear separation on the surface of nmh
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4036 \(en the tool chest approach \(en
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4037 is violated on the level below.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4038 This violation is for the sake of time performance.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4039 Decades ago, sacrificing readability and conceptional beauty
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4040 for speed might have been necessary to prevent MH from being
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4041 unusably slow, but today this is not the case anymore.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4042 No longer should speed improvements that became unnecessary be kept.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4043 No longer should readability or conceptional beauty be sacrificed.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4044 No longer should the Unix philosophy's ``one tool, one job''
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4045 guideline be violated.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4046 Therefore, mmh's
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4047 .Pn comp
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4048 no longer sends messages.
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4049 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4050 In mmh, different jobs are divided among separate programs that
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4051 invoke each other as needed.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4052 In consequence,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4053 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4054 invokes
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4055 .Pn whatnow
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4056 which thereafter invokes
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4057 .Pn send
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4058 .Ci 3df5ab3c116e6d4a2fb4bb5cc9dfc5f781825815
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4059 .Ci c73c00bfccd22ec77e9593f47462aeca4a8cd9c0 .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4060 The clear separation on the surface is maintained on the level below.
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4061 Human users and other tools use the same interface \(en
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4062 annotations, for example, are made by invoking
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4063 .Pn anno ,
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4064 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	4065 .Ci 469a4163c2a1a43731d412eaa5d9cae7d670c48b
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4066 .Ci aed384169af5204b8002d06e7a22f89197963d2d
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4067 .Ci 3caf9e298a8861729ca8b8a84f57022b6f3ea742 .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4068 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	4069 the decrease of
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4070 .Fn uip/*sbr.c
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4071 files confirm the improvement
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4072 .Ci 9e6d91313f01c96b4058d6bf419a8ca9a207bc33
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4073 .ci 81744a46ac9f845d6c2b9908074d269275178d2e
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4074 .Ci f0f858069d21111f0dbea510044593f89c9b0829
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4075 .Ci 0503a6e9be34f24858b55b555a5c948182b9f24b
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4076 .Ci 27826f9353e0f0b04590b7d0f8f83e60462b90f0
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4077 .Ci d1da1f94ce62160aebb30df4063ccbc53768656b
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4078 .Ci c42222869e318fff5dec395eca3e776db3075455 .
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4079 This is also visible in the complexity of the build dependency graphs:
145 3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4080
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4081 .sp
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4082 Nmh:
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4083 .BP input/deps-nmh.eps .5i
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4084 .EP
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4085 .sp
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4086 Mmh:
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4087 .BP input/deps-mmh.eps .8i
95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4088 .EP
145 3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4089
226 27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	4090 The figures display all program to source file relationships where
27c28990b844 Added quote by Steve Johnson. markus schnalke <meillo@marmaro.de> parents: 225 diff changeset	4091 programs (ellipses) are built from multiple source files (rectangles).
220 95257474a123 Further improvements in the discussion; added build dependency graphs. markus schnalke <meillo@marmaro.de> parents: 219 diff changeset	4092 The primary source file of each program is omited from the graph.

Mercurial > docs > master

annotate discussion.roff @ 226:27c28990b844