docs/master: discussion.roff annotate

annotate discussion.roff @ 219:8c537982d718

Further improvements of the discussion chapter. There's a bit more to come ... tomorrow.

author	markus schnalke <meillo@marmaro.de>
date	Sat, 14 Jul 2012 23:19:27 +0200
parents	f3f65376bef9
children	95257474a123

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.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	11 Recent changes in nmh are seldom part of the discussion.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	12 Sometimes they are mentioned in side notes.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	13 .P
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	14 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	15 is depicted in the following figure.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	16 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	17
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	18 .sp 1.5
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	19 .KS
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	20 .in 2c
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	21 .so input/mail-agents.pic
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	22 .KE
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	23 .sp 1.5
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	24
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	25 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	26 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	27 These are:
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	28 .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	29 The only program users directly interact with.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	30 It includes functions to compose new mail, display received mail,
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	31 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	32 It is called a \fImail client\fP as well.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	33 .IP "Mail Submission Agent (MSA)
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	34 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	35 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	36 Often it is also called an MTA.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	37 .IP "Mail Transfer Agent (MTA)
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	38 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	39 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	40 final destination.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	41 An MTA may be the final destination itself.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	42 .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	43 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	44 Usually, the messages are stored to disk.
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	45 .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	46 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	47 (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	48 .LP
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	49 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	50 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	51 The box on the upper left represents the first mail transfer node.
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	52 The box on the upper right represents the transfer node responsible for the
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	53 destination address.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	54 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	55 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	56 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	57 the dotted line.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	58 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	59
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	60
5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	61
58 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
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	64
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	65 .\" --------------------------------------------------------------
125 0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/ markus schnalke <meillo@marmaro.de> parents: 124 diff changeset	66 .H1 "Streamlining
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	67
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	68 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	69 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	70 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	71 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	72 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	73 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	74 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	75 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	76 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	77 Excellent implementations for the various aspects of email already exist.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	78 Just to name three examples: Postfix
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	79 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	80 postfix website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	81 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	82 is a specialized MTA, Procmail
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	83 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	84 procmail website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	85 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	86 is a specialized MDA, and Fetchmail
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	87 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	88 fetchmail website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	89 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	90 is a specialized MRA.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	91 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	92 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	93 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	94 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	95 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	96 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	97 in their field of focus.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	98 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	99 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	100 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	101 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	102 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	103 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	104 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	105 free software is man power.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	106 .\" XXX FIXME ref!
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	107 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	108 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	109 various fields.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	110 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	111 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	112 .P
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	113 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	114 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	115 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	116 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	117
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	118
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	119 .H2 "Mail Transfer Facilities
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	120 .Id mail-transfer-facilities
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	121 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	122 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	123 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	124 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	125 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	126 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	127 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	128 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	129 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	130 sendmail website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	131 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	132 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	133 .[ [
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	134 costales sendmail
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	135 .], p. xviii]
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	136 .QS
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	137 Second, I limited myself to the routing function \(en
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	138 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	139 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	140 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	141 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	142 .QE
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	143 .P
187 5360f5fdb118 Added mail agent figure. markus schnalke <meillo@marmaro.de> parents: 183 diff changeset	144 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	145 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	146 .Pn post
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	147 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	148 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	149 When email transfer changed, this part needed to be changed as well.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	150 Encryption and authentication for network connections
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	151 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	152 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	153 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	154 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	155 In mmh, this whole facility was simply cut off
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	156 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	157 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	158 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b .
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	159 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	160 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	161 .Pn sendmail
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	162 command, which almost any MSA provides.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	163 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	164 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	165 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	166 over to the MSA.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	167 For example, a wrapper script for qmail
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	168 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	169 qmail website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	170 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	171 would be:
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	172 .VS
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	173 #!/bin/sh
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	174 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	175 VE
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	176 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	177 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	178 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	179 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	180 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	181 To retrieve mail, the
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	182 .Pn inc
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	183 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	184 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	185 and speaks POP3 to retrieve mail from remote servers.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	186 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	187 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	188 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	189 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	190 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	191 from remote locations
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	192 .Ci ab7b48411962d26439f92f35ed084d3d6275459c .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	193 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	194 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	195 (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	196 .Pn inc
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	197 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	198 .Pn rcvstore
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	199 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	200 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	201 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	202 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	203 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	204 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	205 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	206 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	207 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	208 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	209 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	210 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	211 why should the internal version not be kept for convenience?
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	212 .\" XXX commas correct?
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	213 Transfered to a different area,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	214 the question whether there is sense in having a fall-back pager in all
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	215 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	216 .Pn more
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	217 or
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	218 .Pn less
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	219 are not available, appears to be ridiculous.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	220 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	221 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	222 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	223 .[
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	224 mcilroy unix phil
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	225 p. 53
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	226 .]
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	227 .[
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	228 mcilroy bstj foreword
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	229 .]
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	230 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	231 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	232 In other words:
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	233 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	234 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	235 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	236 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	237 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	238 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	239 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	240 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	241 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	242 separation as well.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	243 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	244 Once, email had been small and simple.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	245 At that time,
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	246 .Pn /bin/mail
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	247 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	248 Later, the essential complexity of email increased.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	249 (Essential complexity is the complexity defined by the problem itself.\&
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	250 .[ [
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	251 brooks no silver bullet
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	252 .]])
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	253 Consequently, email systems grew.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	254 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	255 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	256 new roles appeared.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	257 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	258 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	259 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	260 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	261 as well.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	262 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	263 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	264 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	265 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	266 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	267 that cover the field.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	268 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	269 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	270 .LI 1
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	271 By implementing the function in the project itself.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	272 .LI 2
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	273 By depending on a library that provides the function.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	274 .LI 3
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	275 By depending on a program that provides the function.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	276 .LP
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	277 .\" XXX Rework sentence
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	278 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	279 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	280 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	281 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	282 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	283 but introduces dependencies on external projects.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	284 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	285 but possibly limit the information exchange.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	286 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	287 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	288 Adding code to a project increases maintenance work.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	289 .\" XXX ref
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	290 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	291 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	292 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	293 not in their existence.
66 4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	294 In mmh, library dependencies on
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	295 .Pn libsasl2
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	296 and
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	297 .Pn libcrypto /\c
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	298 .Pn libssl
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	299 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	300 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	301 dependencies.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	302 Besides providing stronger separation and greater flexibility,
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	303 program dependencies also allowed
66 4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	304 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	305 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	306 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	307 losing functionality is a convincing argument.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	308 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	309 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	310 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	311 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	312 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	313 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	314
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	315 Choices for MSAs range from small forwarders such as
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	316 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	317 ssmtp website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	318 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	319 and,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	320 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	321 nullmailer website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	322 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	323 over mid-size MTAs including
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	324 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	325 masqmail website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	326 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	327 and,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	328 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	329 dma dragonfly mail agent website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	330 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	331 up to full-featured MTAs as for instance.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	332 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	333 postfix website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	334 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	335 MRAs are provided for example by
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	336 .[ [
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	337 fetchmail website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	338 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	339 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	340 getmail website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	341 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	342 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	343 mpop website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	344 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	345 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	346 fdm website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	347 .]].
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	348
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	349
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	350 .H2 "Non-MUA Tools
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	351 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	352 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	353 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	354 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	355 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	356 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	357 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	358 .Pn conflict
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	359 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	360 .Ci 8b235097cbd11d728c07b966cf131aa7133ce5a9
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	361 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	362 It even checked
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	363 .Fn /etc/passwd
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	364 and
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	365 .Fn /etc/group
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	366 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	367 A tool like
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	368 .Pn conflict
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	369 is surely useful, but it should not be shipped with mmh.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	370 .\" XXX historic reasons?
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	371 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	372 .Pn rcvtty
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	373 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	374 .Ci 14767c94b3827be7c867196467ed7aea5f6f49b0
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	375 because its use case of writing to the user's terminal
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	376 on reception of mail is obsolete.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	377 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	378 .Ev MAILPATH
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	379 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	380 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	381 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	382 .Pn write
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	383 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	384 .VS
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	385 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	386 VE
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	387 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	388 .Pn viamail
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	389 .\" XXX was macht viamail
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	390 was removed
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	391 .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	392 when the new attachment system was activated, because
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	393 .Pn forw
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	394 could then cover the task itself.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	395 The program
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	396 .Pn sendfiles
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	397 was rewritten as a shell script wrapper around
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	398 .Pn forw .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	399 .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	400 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	401 .Pn msgchk
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	402 .\" XXX was macht msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	403 was removed
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	404 .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe ,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	405 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	406 A call to
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	407 .Pn msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	408 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	409 .VS
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	410 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	411 VE
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	412 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	413 these details can be retrieved with
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	414 .Pn stat (1),
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	415 too.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	416 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	417 in a similar way, if truly necessary.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	418 As mmh's
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	419 .Pn inc
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	420 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	421 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	422 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	423 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	424 .Pn msh
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	425 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	426 .Ci 916690191222433a6923a4be54b0d8f6ac01bd02
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	427 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	428 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	429 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	430 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	431 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	432 .Pn msh 's
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	433 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	434 be popular.
24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	435 .P
24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	436 Removing
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	437 .Pn msh
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	438 together with the truly archaic code relics
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	439 .Pn vmh
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	440 and
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	441 .Pn wmh
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	442 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	443 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	444 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	445 for the same functionality is an advantage.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	446 Less code means less bugs and less maintenance work.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	447 As
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	448 .Pn rcvtty
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	449 and
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	450 .Pn msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	451 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	452 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	453 Removing them streamlined mmh.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	454 .Pn viamail 's
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	455 use case is now partly obsolete and partly covered by
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	456 .Pn forw ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	457 hence there is no reason to still maintain it.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	458 .Pn conflict
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	459 is not related to the mail client, and
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	460 .Pn msh
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	461 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	462 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	463 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	464 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	465 .Pn slocal ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	466 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	467 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	468 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	469 However,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	470 .Pn slocal
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	471 provides rule-based processing of messages, like filing them into
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	472 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	473 Although
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	474 .Pn slocal
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	475 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	476 technical area (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	477 .Cf mail-transfer-facilities ),
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	478 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	479 As
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	480 .Pn slocal
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	481 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	482 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	483 .Pn slocal .
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	484 For anyone not using MH,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	485 .Pn slocal
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	486 would become yet another independent MDA, like
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	487 .I procmail .
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	488 Then
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	489 .Pn slocal
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	490 could be installed without a complete MH system.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	491 Likewise, mmh users could decide to use
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	492 .I procmail
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	493 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	494 .Pn slocal ,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	495 installed.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	496 That appears to be conceptionally the best solution.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	497 Yet,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	498 .Pn slocal
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	499 is not split off.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	500 I defer the decision over
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	501 .Pn slocal
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	502 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	503 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	504 as its continued existence is not significant;
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	505 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	506 is unrelated to the rest of the project.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	507
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	508
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	509
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	510 .H2 "Displaying Messages
155 75f20c925999 Fixed macro typo; and added typo fix found by Boris. markus schnalke <meillo@marmaro.de> parents: 154 diff changeset	511 .Id mhshow
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	512 .P
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	513 Since the very beginning, already in the first concept paper,
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	514 .\" XXX ref!!!
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	515 .Pn show
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	516 had been MH's message display program.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	517 .Pn show
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	518 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	519 .Pn mhl
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	520 to have the files formatted.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	521 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	522 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	523 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	524 are not directly displayable.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	525 .Pn show 's
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	526 understanding of messages and
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	527 .Pn mhl 's
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	528 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	529 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	530 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	531 scratch and were added to the MH tool chest.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	532 Doing so is encouraged by the tool chest approach.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	533 Modular design is a great advantage for extending a system,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	534 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	535 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	536 .Pn mhn .
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	537 The command
82 ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment. markus schnalke <meillo@marmaro.de> parents: 78 diff changeset	538 .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	539 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	540 .Fn 42 ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	541 interpreting MIME.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	542 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	543 the split of
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	544 .Pn mhn
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	545 into a set of specialized tools, which together covered the
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	546 multiple aspects of MIME.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	547 One of them was
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	548 .Pn mhshow ,
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	549 which replaced
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	550 .Cl "mhn -show" .
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	551 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	552 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	553 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	554 .Pn show
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	555 and
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	556 .Pn mhshow .
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	557 To ease the life of users,
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	558 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	559 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	560 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	561 if displaying the message would be beyond
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	562 .Pn show 's
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	563 abilities.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	564 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	565 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	566 (possibly through
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	567 .Pn next
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	568 or
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	569 .Pn prev )
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	570 and get the message printed with either
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	571 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	572 or
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	573 .Pn mhshow ,
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	574 whatever was more appropriate.
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	575 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	576 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	577 Usually, users do not distinguish between
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	578 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	579 and
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	580 .Pn mhshow
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	581 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	582 Having two separate display programs was therefore unnecessary
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	583 from a user's point of view.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	584 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	585 to ensure that the programs behaved in a similar way,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	586 because they were used like a single tool.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	587 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	588 .P
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	589 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	590 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	591 As
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	592 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	593 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	594 to drop
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	595 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	596 in favor of using
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	597 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	598 exclusively
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	599 .Ci 4c1efddfd499300c7e74263e57d8aa137e84c853 .
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	600 Removing
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	601 .Pn show
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	602 is no loss in function, because
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	603 .Pn mhshow
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	604 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	605 Yet, the old behavior of
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	606 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	607 can still be emulated with the simple command line:
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	608 .VS
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	609 mhl `mhpath c`
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	610 VE
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	611 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	612 For convenience,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	613 .Pn mhshow
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	614 was renamed to
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	615 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	616 after
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	617 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	618 was gone.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	619 It is clear that such a rename may confuse future developers when
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	620 trying to understand the history.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	621 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	622 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	623 of the tools.
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	624 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	625 To prepare for the transition,
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	626 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	627 was reworked to behave more like
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	628 .Pn show
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	629 first (cf. Sec.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	630 .Cf mhshow ).
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	631 .\" XXX code commits?
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	632 Once the tools behaved more alike, the replacing appeared to be
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	633 even more natural.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	634 Today, mmh's new
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	635 .Pn show
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	636 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	637 with the difference
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	638 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	639 The outcomes of the transition are one program less to maintain,
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	640 no second display program for users to deal with,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	641 and less system complexity.
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	642 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	643 Still, removing the old
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	644 .Pn show
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	645 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	646 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	647 .Pn show ,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	648 .\" XXX
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	649 however there is no alternative;
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	650 supporting MIME demands higher essential complexity.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	651
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	652 .ig
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	653 XXX
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	654 Consider including text on scan listings here
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	655
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	656 Scan listings shall not contain body content. Hence, removed this feature.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	657 Scan listings shall operator on message headers and non-message information
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	658 only. Displaying the beginning of the body complicates everything too much.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	659 That's no surprise, because it's something completely different. If you
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	660 want to examine the body, then use show(1)/mhshow(1).
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	661 Changed the default scan formats accordingly.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	662 .Ci 70b2643e0da8485174480c644ad9785c84f5bff4
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	663 ..
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	664
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	665
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	666
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	667
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	668 .H2 "Configure Options
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	669 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	670 Customization is a double-edged sword.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	671 It allows better suiting setups, but not for free.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	672 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	673 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	674 more possible setups and especially corner cases.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	675 Additionally, there is the cost of choice itself.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	676 The code complexity directly affects the developers.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	677 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	678 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	679 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	680 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	681 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	682 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	683 15 to 3.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	684
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	685 .U3 "Mail Transfer Facilities
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	686 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	687 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	688 options vanished:
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	689 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	690 The switches
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	691 .Sw --with-tls
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	692 and
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	693 .Sw --with-cyrus-sasl
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	694 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	695 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	696 .\" 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	697 They are not needed anymore.
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	698 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	699 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 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 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	702 .\" XXX ``For the same reason ...''
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	703 The configure switch
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	704 .Sw --enable-pop
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	705 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	706 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	707 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	708 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	709 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	710 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	711 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	712 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	713 one that needed to be tested.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	714 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	715 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	716 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	717 of the original program.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	718 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	719 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	720 Two other options only specified default configuration values:
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	721 .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	722 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	723 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226 .
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	724 With
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	725 .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	726 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	727 .Ci 128545e06224233b7e91fc4c83f8830252fe16c9 .
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	728 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	729 .\" XXX code ref
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	730 In mmh, all messages are handed over to
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	731 .Pn sendmail
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	732 for transportation.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	733
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	734
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	735 .U3 "Backup Prefix
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	736 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	737 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	738 filenames to tag them as deleted.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	739 By default it had been the comma character (`\fL,\fP').
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	740 .\" XXX Zeitlich ordnen
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	741 In July 2000, Kimmo Suominen introduced
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	742 the configure option
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	743 .Sw --with-hash-backup
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	744 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	745 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	746 being related or not, words that start with the hash character
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	747 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	748 Thus, the command line
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	749 .Cl "rm #13 #15
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	750 calls
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	751 .Pn rm
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	752 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	753 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	754 To delete the backup files,
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	755 .Cl "rm ./#13 ./#15"
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	756 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	757 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	758 against backup loss.
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	759 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	760 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	761 .Pe Backup-Prefix ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	762 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	763 .Ci 6c40d481d661d532dd527eaf34cebb6d3f8ed086 .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	764 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	765 it suited better, in my eyes.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	766 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	767 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	768 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	769 .Cf trash-folder )
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	770 removed the need for the backup prefix completely.
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	771 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	772 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	773
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	774
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	775 .U3 "Editor and Pager
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	776 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	777 The two configure options
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	778 .CW --with-editor=EDITOR
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	779 .CW --with-pager=PAGER
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	780 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	781 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	782 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	783 different systems.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	784 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	785 The programs
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	786 .Pn vi
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	787 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	788 .Pn more
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	789 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	790 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	791 (The specifications for
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	792 .Pn vi
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	793 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	794 .Pn more
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	795 appeared in
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	796 .[
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	797 posix 1987
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	798 .]
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	799 and,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	800 .[
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	801 posix 1992
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	802 .]
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	803 respectively.)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	804 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	805 .Ci 5d43a99db70c12a673028c7758c20cbe3e13ef5f .
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	806 Not changed were the
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	807 .Pe editor
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	808 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	809 .Pe moreproc
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	810 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	811 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	812 environment variables
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	813 .Ev VISUAL
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	814 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	815 .Ev PAGER
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	816 if they are set.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	817 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	818 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	819 .Ci f85f4b7ae62e3d05a945dcd46ead51f0a2a89a9b :
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	820 .LI 1
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	821 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	822 .Ev MMHEDITOR
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	823 .LI 2
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	824 Profile entry
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	825 .Pe Editor
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	826 .LI 3
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	827 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	828 .Ev VISUAL
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	829 .LI 4
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	830 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	831 .Ev EDITOR
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	832 .LI 5
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	833 Command
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	834 .Pn vi .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	835 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	836 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	837 .Ci 0c4214ea2aec6497d0d67b436bbee9bc1d225f1e :
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	838 .LI 1
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	839 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	840 .Ev MMHPAGER
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	841 .LI 2
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	842 Profile entry
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	843 .Pe Pager
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	844 (replaces
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	845 .Pe moreproc )
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	846 .LI 3
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	847 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	848 .Ev PAGER
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	849 .LI 4
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	850 Command
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	851 .Pn more .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	852 .LP
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	853 By respecting the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	854 .Ev VISUAL /\c
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	855 .Ev EDITOR
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 .Ev PAGER
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	858 environment variables,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	859 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	860 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	861
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	862
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	863 .U3 "ndbm
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	864 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	865 .Pn slocal
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	866 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	867 .I ndbm .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	868 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	869 .Hd Message-ID
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	870 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	871 This enabled
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	872 .Pn slocal
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	873 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	874 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	875 .Sw -suppressdup
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	876 switch.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	877 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	878 As a variety of versions of the database library exist,
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	879 .[
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	880 wolter unix incompat notes dbm
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	881 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	882 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	883 Furthermore, the configure switches
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	884 .Sw --with-ndbm=ARG
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	885 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	886 .Sw --with-ndbmheader=ARG
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	887 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	888 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	889 .P
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	890 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	891 .Pn slocal ,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	892 the dependency on
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	893 .I ndbm
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	894 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	895 .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	896 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	897 improvement of dropping the dependency and the complex autoconf code.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	898 .\" XXX argument: slocal ist sowieso nicht teil vom mmh kern
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	899
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	900 .U3 "MH-E Support
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	901 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	902 The configure option
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	903 .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	904 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	905 MH-E is the Emacs front-end to MH.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	906 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	907 mh-e emacs website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	908 .]
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	909 It requires MH to provide minor additional functions.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	910 The
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	911 .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	912 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	913 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	914 only the
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	915 .Sw -build
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	916 switches of
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	917 .Pn forw
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	918 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	919 .Pn repl
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	920 are left to be MH-E extensions.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	921 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	922 In consequence, the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	923 .Sw --disable-mhe
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	924 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	925 .Ci a7ce7b4a580d77b6c2c4d980812beb589aa4c643 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	926 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	927 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	928 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	929 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	930
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	931
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	932 .U3 "Masquerading
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	933 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	934 The configure option
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	935 .Sw --enable-masquerade
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	936 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	937 .Ar draft_from ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	938 .Ar mmailid ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	939 and
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	940 .Ar username_extension .
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	941 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	942 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	943 .Pn post
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	944 command.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	945 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	946 this field anymore.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	947 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	948 .P
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	949 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	950 .I mmailid
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	951 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	952 available in the original MH.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	953 It provided a
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	954 .I username
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	955 to
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	956 .I fakeusername
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	957 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	958 .Fn passwd 's
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	959 GECOS field.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	960 Nmh's man page
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	961 .Mp mh-tailor (5)
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	962 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	963 .QS
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	964 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	965 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	966 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	967 `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	968 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	969 ``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	970 .QE
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	971 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	972 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	973 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	974 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	975 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	976 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	977 mail software on the system.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	978 Hence, mmailid masquerading was removed.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	979 .Ci 0836c8000ccb34b59410ef1c15b1b7feac70ce5f
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	980 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	981 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	982 .I username_extension
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	983 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	984 specified by the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	985 .Ev USERNAME_EXTENSION
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	986 environment variable, to it.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	987 This provided support for the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	988 .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	989 feature of qmail
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	990 .[ [
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	991 sill qmail handbook
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	992 .], p. 141]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	993 and the similar
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	994 .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	995 processing of Sendmail.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	996 .[ [
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	997 sendmail costales
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	998 .], p. 476]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	999 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	1000 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	1001 .Pn spost
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1002 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	1003 Username extensions can be used in mmh, but less convenient.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1004 .\" XXX covered by next paragraph
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	1005 .\" XXX 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	1006 .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1007 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1008 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1009 .I draft_from
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1010 masquerading type instructed
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1011 .Pn post
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1012 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	1013 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1014 header field as SMTP envelope sender.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	1015 Sender addresses could be replaced completely.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	1016 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	1017 with technical differences.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	1018 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	1019 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	1020 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	1021 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	1022 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	1023 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	1024 .Hd From
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1025 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	1026 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	1027 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	1028 .Ci b14ea6073f77b4359aaf3fddd0e105989db9
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1029 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1030 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	1031 message header (\c
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1032 .Pn sendmail 's
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1033 .Sw -t
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1034 switch).
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1035 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1036 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1037 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	1038 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	1039
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1040 .U3 "Remaining Options
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1041 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1042 Two configure options remain in mmh.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1043 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	1044 .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	1045 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	1046 .I "dot locking
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	1047 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	1048 requires deeper technical investigation into the topic.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	1049 The other option,
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1050 .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	1051 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	1052 This option is likely to stay.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	1053
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	1054
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1055
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	1056
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1057 .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	1058 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1059 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	1060 the X Window System style.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	1061 .\" XXX ref
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1062 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	1063 For example
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1064 .Cl -truncate .
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1065 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	1066 prefix is unambiguous.
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1067 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	1068 .Cl "-truncate" ,
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1069 .Cl "-trunc" ,
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1070 .Cl "-tr" ,
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1071 and
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1072 .Cl "-t
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1073 is equal.
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1074 As a result, switches can neither be grouped (as in
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1075 .Cl "ls -ltr" )
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1076 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	1077 .Cl "sendmail -q30m" ).
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1078 Many switches have negating counter-parts, which start with `no'.
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1079 For example
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1080 .Cl "-notruncate
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1081 inverts the
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1082 .Cl "-truncate
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1083 switch.
9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1084 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	1085 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	1086 .Sw -help ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1087 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	1088 .Sw -Version
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1089 (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	1090 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1091 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	1092 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	1093 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	1094 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	1095 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	1096 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	1097 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	1098 the documentation, and the usage of the program.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1099 .\" XXX: Ref
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1100 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	1101 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	1102 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	1103 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	1104 problem of MH:
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1105 .[ [
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1106 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1107 .], p. 12]
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1108 .QS
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1109 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	1110 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	1111 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	1112 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	1113 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	1114 .QP
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1115 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	1116 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	1117 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	1118 .QE
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1119 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1120 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	1121 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	1122 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	1123 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	1124 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	1125 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	1126 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	1127 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	1128 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	1129 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	1130 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	1131 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	1132 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	1133 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	1134 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	1135 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	1136 ``[...]
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1137 .Pn send
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1138 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	1139 .[ [
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1140 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	1141 .], p. 12].
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1142 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	1143 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	1144 but this is not practical.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1145 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	1146 them strictly.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1147 Nevertheless, removing obsolete switches still is an effective approach
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1148 to deal with the problem.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1149 Working on an experimental branch without an established user base,
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1150 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	1151 functions.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1152 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1153 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	1154 .Pn send .
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1155 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	1156 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	1157 have remained in mmh's
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1158 .Pn send .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1159 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	1160 .Sw -help
764738b17b74 Updated the numbers of cmdline switches to recent mmh changes. markus schnalke <meillo@marmaro.de> parents: 181 diff changeset	1161 and
183 4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1162 .Sw -Version .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1163 .P
183 4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1164 Hidden switches are ones not documented.
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1165 In mmh, 12 tools have hidden switches.
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1166 9 of them are
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1167 .Sw -debug
4c5055a0e981 Explained `hidden switches'. markus schnalke <meillo@marmaro.de> parents: 182 diff changeset	1168 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	1169 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1170 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	1171 that is available in both nmh and mmh.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1172 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	1173 Both visible and hidden switches were counted,
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1174 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	1175 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	1176 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	1177 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	1178 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	1179 has 4 now.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1180 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	1181 to 233.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1182
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1183 .KS
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1184 .in 1c
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1185 .so input/switches.grap
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1186 .KE
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1187
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1188 .P
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1189 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	1190 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	1191 Sometimes, however, the work flow was the other way:
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1192 I looked through the
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1193 .Mp mh-chart (7)
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1194 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	1195 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	1196 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	1197 and testing.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1198
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1199
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1200 .U3 "Draft Folder Facility
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1201 .P
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1202 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	1203 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	1204 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1205 .\" XXX ref to section ...
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1206 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	1207 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	1208 .[
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1209 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1210 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1211 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	1212 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	1213 .Sw -[no]draftfolder ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1214 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1215 .Sw -draftmessage
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1216 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	1217 .Pn comp ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1218 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1219 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1220 .Pn dist ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1221 .Pn whatnow ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1222 and
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1223 .Pn send
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1224 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1225 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	1226 draft folders within one profile.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1227 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	1228 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	1229 .Sw -draft
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1230 switch of
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1231 .Pn anno ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1232 .Pn refile ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1233 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1234 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1235 was removed.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1236 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	1237 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	1238 (cf. Sec.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1239 .Cf draft-folder ).
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1240 Furthermore,
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1241 .Pn comp
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1242 no longer needs a
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1243 .Sw -file
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1244 switch as the draft folder facility together with the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1245 .Sw -form
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1246 switch are sufficient.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1247
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1248
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1249 .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	1250 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1251 .Pn anno
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1252 had the switches
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1253 .Sw -[no]inplace
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1254 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	1255 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	1256 The latter approach broke hard links.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1257 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	1258 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	1259 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1260 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	1261 .Sw -inplace
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1262 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	1263 .Ci c8195849d2e366c569271abb0f5f60f4ebf0b4d0 .
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1264 The
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1265 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1266 switches of
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1267 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1268 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1269 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1270 .Pn dist
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1271 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	1272 .Pn anno .
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1273 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1274 .Pn burst
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1275 also had
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1276 .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	1277 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	1278 With
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1279 .Sw -inplace ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1280 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	1281 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	1282 after this message, renumbering all following messages.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1283 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	1284 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	1285 Nonetheless, this behavior appeared less elegant than the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1286 .Sw -noinplace
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1287 behavior, which already had been the default.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1288 Nmh's
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1289 .Mp burst (1)
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1290 man page reads:
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1291 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1292 If
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1293 .Sw -noinplace
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1294 is given, each digest is preserved, no table
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1295 of contents is produced, and the messages contained within
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1296 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	1297 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	1298 .QE
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1299 .LP
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1300 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	1301 .Sw -inplace
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1302 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	1303 it caused.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1304 .Sw -noinplace
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1305 was chosen to be the definitive behavior.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1306 .Ci 68a686adeb39223a5e1ad35e4a24890ec053679d
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 "Forms and Format Strings
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1310 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1311 Historically, the tools that had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1312 .Sw -form
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1313 switches to supply a form file had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1314 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1315 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	1316 on the command line directly.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1317 In consequence, the following two lines equaled:
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1318 .VS
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1319 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	1320 scan -format "`cat /path/to/scan.mailx`"
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1321 VE
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1322 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1323 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1324 switches were dropped in favor for extending the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1325 .Sw -form
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1326 switches
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1327 .Ci f51956be123db66b00138f80464d06f030dbb88d .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1328 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	1329 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	1330 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	1331 Thus, now the following two lines equal:
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1332 .VS
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1333 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	1334 scan -form "=`cat /path/to/scan.mailx`"
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1335 VE
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1336 This rework removed the prefix collision between
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1337 .Sw -form
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1338 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1339 .Sw -format .
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1340 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	1341 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1342 The different meaning of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1343 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1344 for
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1345 .Pn forw
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1346 and
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1347 .Pn repl
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1348 was removed in mmh.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1349 .Pn forw
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1350 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	1351 .Sw -[no]format
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1352 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1353 For
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1354 .Pn repl ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1355 the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1356 .Sw -[no]format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1357 switches were reworked to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1358 .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	1359 switches
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1360 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1361 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1362 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1363 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1364 .Pn send
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1365 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1366 .Pn post ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1367 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	1368 .Ci f3cb7cde0e6f10451b6848678d95860d512224b9 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1369 Eventually, the ambiguity of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1370 .Sw -format
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1371 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	1372
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1373
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1374 .U3 "MIME Tools
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1375 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1376 The MIME tools, which once were part of
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1377 .Pn mhn
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1378 (whatever that stood for),
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1379 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	1380 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1381 .Sw -[no]realsize
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1382 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1383 .Pn mhbuild
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1384 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1385 .Pn mhlist
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1386 were removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1387 .Ci 8d8f1c3abc586c005c904e52c4adbfe694d2201c .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1388 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	1389 .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	1390 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	1391 ``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	1392 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	1393 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1394 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1395 .Sw -[no]check
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1396 switches were removed together with the support for
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1397 .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	1398 header fields [RFC\\|1864]
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1399 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1400 .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	1401 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda .
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 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1404 .Sw -[no]ebcdicsafe
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1405 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1406 .Sw -[no]rfc934mode
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1407 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1408 .Pn mhbuild
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1409 were removed because they are considered obsolete
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1410 .Ci 01a3480928da485b4d6109d36d751dfa71799d58
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1411 .Ci 3363e2624dce0eb8164cf8b3f1ab385c8ff72e88 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1412 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1413 Content caching of external MIME parts, activated with the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1414 .Sw -rcache
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1415 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1416 .Sw -wcache
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1417 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	1418 .Ci d1fefd9f614e4dc3cda16da6c69133c1b2005269 .
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1419 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	1420 for them appears to be unnecessary.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1421 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1422 In pre-MIME times,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1423 .Pn mhl
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1424 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	1425 Therefore,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1426 .Pn mhl
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1427 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	1428 switches from 21 to 6
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1429 .Ci 350ad6d3542a07639213cf2a4fe524e829c1e7b6
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1430 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1431
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1432
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1433
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1434
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1435 .U3 "Header Printing
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1436 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1437 .Pn folder 's
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1438 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	1439 displaying the header line makes little sense.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1440 Hence, the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1441 .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	1442 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	1443 .Ci 601cc73d1fa05ce96faa728f036d6c51b91701c7 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1444 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1445 In
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1446 .Pn mhlist ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1447 the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1448 .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	1449 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	1450 .Ci b24f96523aaf60e44e04a3ffb1d22e69a13a602f .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1451 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	1452 is not self-explaining.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1453 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1454 .Pn scan
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1455 also had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1456 .Sw -[no]header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1457 switches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1458 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	1459 format strings made it impossible to display column headings.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1460 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	1461 As this information can be perfectly generated with
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1462 .Pn folder
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1463 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1464 .Pn date ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1465 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	1466 .Ci c477dc5d1d03fa6d9a8ab3dd3508c63cbddc044e .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1467 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1468 By removing all
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1469 .Sw -header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1470 switches, the collision with
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1471 .Sw -help
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1472 on the first two letters was resolved.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1473 Currently,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1474 .Sw -h
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1475 evaluates to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1476 .Sw -help
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1477 for all tools of mmh.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1478
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1479
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1480 .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	1481 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1482 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1483 .Sw -noedit
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1484 switch of
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1485 .Pn comp ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1486 .Pn repl ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1487 .Pn forw ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1488 .Pn dist ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1489 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1490 .Pn whatnow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1491 was removed and replaced by specifying
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1492 .Sw -editor
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1493 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	1494 .Ci 75fca31a5b9d5c1a99c74ab14c94438d8852fba9 .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1495 (Specifying
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1496 .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	1497 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	1498 .P
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1499 The more important change is the removal of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1500 .Sw -nowhatnowproc
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1501 switch
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1502 .Ci ee4f43cf2ef0084ec698e4e87159a94c01940622 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1503 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	1504 as explained in nmh's man page for
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1505 .Mp comp (1):
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1506 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1507 The
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1508 .Sw -editor
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1509 .Ar editor
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1510 switch indicates the editor to use for
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1511 the initial edit. Upon exiting from the editor,
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1512 .Pn comp
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1513 will invoke the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1514 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1515 program. See
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1516 .Mp whatnow (1)
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1517 for a discussion of available options.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1518 The invocation of this program can be
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1519 inhibited by using the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1520 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1521 switch. (In truth of fact, it is the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1522 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1523 program which starts the initial edit.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1524 Hence,
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1525 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1526 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	1527 .QE
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1528 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1529 Effectively, the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1530 .Sw -nowhatnowproc
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1531 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	1532 As
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1533 .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	1534 does the same, the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1535 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1536 switch was removed for being redundant.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1537
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1538
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1539
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1540 .U3 "Various
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1541 .BU
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1542 With the removal of MMDF maildrop format support,
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1543 .Pn packf
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1544 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1545 .Pn rcvpack
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1546 no longer needed their
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1547 .Sw -mbox
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1548 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1549 .Sw -mmdf
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1550 switches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1551 The behavior of
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1552 .Sw -mbox
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1553 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	1554 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0 .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	1555 Further rework in both tools made the
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1556 .Sw -file
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1557 switch unnecessary
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1558 .Ci ca1023716d4c2ab890696f3e41fa0d94267a940e .
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1559
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1560 .BU
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1561 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	1562 .Pn scan 's
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1563 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1564 .Pn mhl 's
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1565 .Sw -[no]clear
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1566 switches
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1567 .Ci e57b17343dcb3ff373ef4dd089fbe778f0c7c270
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1568 .Ci 943765e7ac5693ae177fd8d2b5a2440e53ce816e ).
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1569 Neither does
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1570 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1571 ring the bell (\c
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1572 .Sw -[no]bell
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1573 .Ci e11983f44e59d8de236affa5b0d0d3067c192e24 )
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1574 nor does it page the output itself (\c
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1575 .Sw -length
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1576 .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ).
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1577 .\" XXX Ref
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1578 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	1579 .Sw -[no]moreproc
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1580 command line switches for
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1581 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1582 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1583 .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	1584 .Pn mhshow
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1585 .Ci 39e87a75b5c2d3572ec72e717720b44af291e88a .
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1586
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1587 .BU
96 12348d620245 Spell checking. markus schnalke <meillo@marmaro.de> parents: 95 diff changeset	1588 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	1589 .Sw -version
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1590 switch was renamed to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1591 .Sw -Version
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1592 (with capital `V')
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1593 .Ci 32b2354dbaf4bf934936eb5b102a4a3d2fdd209a .
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1594 Every program has the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1595 .Sw -version
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1596 switch but its first three letters collided with the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1597 .Sw -verbose
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1598 switch, present in many programs.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1599 The rename solved this problem once for all.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1600 Although this rename breaks a basic interface, having the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1601 .Sw -V
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1602 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	1603
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1604 .BU
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1605 .Sw -[no]preserve
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1606 of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1607 .Pn refile
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1608 was removed
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1609 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1610 because what use was it anyway?
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	1611 Quoting nmh's man page
165 ea6eec1722d1 Improvement by Boris Kraut. markus schnalke <meillo@marmaro.de> parents: 164 diff changeset	1612 .Mp refile (1):
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1613 .QS
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1614 Normally when a message is refiled, for each destination
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1615 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	1616 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	1617 .Sw -preserv
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1618 [sic!] switch will override this message renaming, and try
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1619 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	1620 particular folder occurs when using the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1621 .Sw -preserve
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1622 switch, then
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1623 .Pn refile
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1624 will use the next available message number which
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1625 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	1626 .QE
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1627
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1628 .BU
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1629 The removal of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1630 .Sw -[no]reverse
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1631 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1632 .Pn scan
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1633 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1634 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	1635 This is supported by the comments
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1636 ``\-[no]reverse under #ifdef BERK (I really HATE this)''
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1637 by Rose and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1638 ``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	1639 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	1640 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	1641 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	1642
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1643
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1644
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1645
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1646
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1647
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1648
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	1649 .\" --------------------------------------------------------------
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1650 .H1 "Modernizing
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1651 .P
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1652 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	1653 increasingly extended.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	1654 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	1655 existing behavior.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1656 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	1657 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	1658 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	1659 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	1660 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	1661 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	1662 .Cf code-style .
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1663
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1664
212 9317d789cef9 Various improvements and rework. markus schnalke <meillo@marmaro.de> parents: 200 diff changeset	1665 .H2 "Code Relics
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1666 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1667 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	1668 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	1669 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	1670 functionality that I considered ancient.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1671 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	1672 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	1673 .P
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1674 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	1675 do the work:
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1676 .[
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1677 paul vixie edginess nmh-workers
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 .QS
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1680 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	1681 discuss whether to keep using vfork, just note in [sic!] passing, [...]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1682 we don't need a separate branch for removing vmh
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1683 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	1684 or depending on pure ansi/posix ``libc''.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1685 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1686 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	1687 should just be modern. [...]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1688 let's push forward, aggressively.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1689 .QE
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1690 .LP
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1691 I did so already in the months before.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1692 I pushed forward.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1693 .\" XXX semicolon ?
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1694 I simply dropped the cruft.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1695 .P
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1696 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	1697 careful thinking, but whether having had contact with this particular
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1698 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	1699 I explained my reasons in the commit messages
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1700 in the version control system.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1701 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	1702 if I have missed an important aspect.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1703 I was quick in dropping parts.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	1704 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	1705 Mmh is experimental work; it requires tough decisions.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1706 .\" XXX ``exp. work'' schon oft gesagt
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1707
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1708
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1709 .U3 "Process Forking
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	1710 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1711 Being a tool chest, MH creates many processes.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1712 In earlier times
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1713 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1714 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	1715 to be completely duplicated at once.
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	1716 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	1717 case wherein the image is replaced by a call to
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1718 .Fu exec()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1719 right after having forked the child process.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1720 The
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1721 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1722 system call was invented to speed up this particular case.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1723 It completely omits the duplication of the image.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1724 On old systems this resulted in significant speed ups.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1725 Therefore MH used
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1726 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1727 whenever possible.
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1728 .P
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1729 Modern memory management units support copy-on-write semantics, which make
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1730 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1731 almost as fast as
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1732 .Fu vfork() .
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1733 The man page of
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1734 .Mp vfork (2)
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1735 in FreeBSD 8.0 states:
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1736 .QS
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1737 This system call will be eliminated when proper system sharing mechanisms
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1738 are implemented. Users should not depend on the memory sharing semantics
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1739 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	1740 .QE
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1741 .LP
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1742 Vixie supports the removal with the note that ``the last
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1743 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	1744 Eunice. that was 1987''.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1745 .[
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1746 nmh-workers vixie edginess
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1747 .]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1748 I replaced all calls to
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1749 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1750 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	1751 .Fu fork()
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1752 .Ci 40821f5c1316e9205a08375e7075909cc9968e7d .
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1753 .P
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1754 Related to the costs of
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1755 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1756 is the probability of its success.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1757 In the eighties, on heavy loaded systems, calls to
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1758 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1759 were prone to failure.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1760 Hence, many of the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1761 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1762 calls in the code were wrapped into loops to retry the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1763 .Fu fork()
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1764 several times, to increase the chances to succeed eventually.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1765 On modern systems, a failing
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1766 .Fu fork()
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1767 call is unusual.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1768 Hence, in the rare case when
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1769 .Fu fork()
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1770 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	1771 .Ci 5fbf37ee68e018998ada61eeab73e035b26834b6 .
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1772
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1773
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1774 .U3 "Header Fields
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1775 .BU
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1776 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1777 .Hd Encrypted
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1778 header field was introduced by RFC\\|822,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1779 but already marked as legacy in RFC\\|2822.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1780 Today, OpenPGP provides the basis for standardized exchange of encrypted
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1781 messages [RFC\\|4880, RFC\\|3156].
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1782 Hence, the support for
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1783 .Hd Encrypted
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1784 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	1785 .Ci 064527f7b57ab050e5af13e15ad99aeeab125857 .
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1786 .BU
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1787 The native support for
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1788 .Hd Face
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1789 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	1790 .Ci 8e5be81f784682822f5e868c1bf3c8624682bd23 .
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1791 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	1792 .Hd X-Face
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1793 header field in its intent,
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1794 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	1795 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	1796 it contains the hostname and UDP port where the image
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1797 date can be retrieved.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1798 There is even a third Face system,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1799 which is the successor of
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1800 .Hd X-Face ,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1801 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	1802 .Hd Face
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1803 header field name.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1804 It was invented in 2005 and supports colored PNG images.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1805 None of the Face systems described here is popular today.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1806 Hence, mmh has no direct support for them.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1807 .BU
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1808 .Id content-md5
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1809 The
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1810 .Hd Content-MD5
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1811 header field was introduced by RFC\\|1864.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1812 It provides detection of data corruption during the transfer.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1813 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	1814 [RFC\\|1864].
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1815 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	1816 end-to-end relationship is the use of digital signatures.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1817 .\" XXX (RFCs FIXME).
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1818 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	1819 the transmission.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1820 The TCP includes a checksum field therefore.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1821 These two approaches in combinations render the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1822 .Hd Content-MD5
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1823 header field superfluous.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1824 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	1825 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	1826 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1827 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	1828 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1829 contains a
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1830 .Hd Content-MD5
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1831 header field.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1832 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	1833 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	1834 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda ,
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1835 removed the last place where MD5 computation was needed.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1836 Hence, the MD5 code could be removed as well.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1837 Over 500 lines of code vanished by this one change.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1838
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1839
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1840 .U3 "MMDF maildrop support
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1841 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1842 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	1843 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	1844 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	1845 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	1846 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	1847 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	1848 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1849 The simplifications within the code were moderate.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1850 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	1851 But also, switches of
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1852 .Pn packf
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1853 and
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1854 .Pn rcvpack
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1855 could be removed
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1856 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0 .
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1857 In the message parsing function
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1858 .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	1859 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	1860 .Ci 684ec30d81e1223a282764452f4902ed4ad1c754 .
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1861 Further code structure simplifications may be possible there,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1862 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	1863 I have not worked on them yet because
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1864 .Fu m_getfld()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1865 is heavily optimized and thus dangerous to touch.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1866 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	1867 too high.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1868
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1869
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1870 .U3 "Prompter's Control Keys
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1871 .P
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1872 The program
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1873 .Pn prompter
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1874 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	1875 When used as
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1876 .Cl "comp -editor prompter" ,
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1877 the resulting behavior is similar to
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1878 .Pn mailx .
51 49cf68506b5d Spell checking. markus schnalke <meillo@marmaro.de> parents: 49 diff changeset	1879 Apparently,
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1880 .Pn prompter
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	1881 had not been touched lately.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1882 Otherwise it's hardly explainable why it
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1883 still offered the switches
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1884 .Sw -erase
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1885 .Ar chr
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1886 and
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1887 .Sw -kill
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1888 .Ar chr
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1889 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	1890 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	1891 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	1892 with the standard tool
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1893 .Pn stty .
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1894 The switches are removed now
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1895 .Ci 0bd9750710cdbab80cfb4036dd87af20afe1552f .
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1896
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1897
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1898 .U3 "Hardcopy Terminal Support
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1899 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1900 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	1901 hardcopy terminal.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1902 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	1903 .Ci b7764c4a6b71d37918a97594d866258f154017ca .
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1904 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1905 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	1906 program (\c
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1907 .Pn mhl )
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1908 and the terminal.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1909 In nmh, this could have been ensured statically with the
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1910 .Sw -nomoreproc
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1911 at the command line, too.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	1912 In mmh, setting the profile entry
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1913 .Pe Pager
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1914 or the environment variable
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1915 .Ev PAGER
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1916 to
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1917 .Pn cat
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1918 is sufficient.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1919
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1920
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1921
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1922
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1923 .H2 "Attachments
22 99409e4546d2 Wrote about the removal of tools. markus schnalke <meillo@marmaro.de> parents: 21 diff changeset	1924 .P
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1925 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	1926 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	1927 requirements for having attachments, they do not mention the term.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1928 Instead of attachments, MIME talks about ``multi-part message bodies''
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1929 [RFC\\|2045], a more general concept.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1930 Multi-part messages are messages
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1931 ``in which one or more different
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1932 sets of data are combined in a single body''
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1933 [RFC\\|2046].
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1934 MIME keeps its descriptions generic;
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1935 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	1936 Today, one usage model is prevalent: attachments.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1937 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	1938 attached to it.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1939 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	1940 and parts of arbitrary type following.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1941 .P
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1942 MH's MIME support is a direct implementation of the RFCs.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1943 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	1944 in MH's implementation.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1945 .\" XXX rewrite ``no idea''.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1946 As a result,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1947 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	1948 But users do not need all the MIME features,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1949 they want convenient attachment handling.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1950
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1951
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1952 .U3 "Composing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1953 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1954 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	1955 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	1956 .Ci 7480dbc14bc90f2d872d434205c0784704213252 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1957 In the file
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1958 .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	1959 he described his motivation to do so:
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1960 .QS
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1961 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	1962 handing [sic!], the interface to this functionality is pretty obtuse.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1963 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	1964 .Pn mhbuild
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1965 composition files!
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1966 .QE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1967 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1968 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	1969 In the same document:
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1970 .QS
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1971 These changes simplify the task of managing attachments on draft files.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1972 They allow attachments to be added, listed, and deleted.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1973 MIME messages are automatically created when drafts with attachments
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1974 are sent.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1975 .QE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1976 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1977 Unfortunately, the attachment system, like every new facilities in nmh,
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1978 was inactive by default.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1979 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1980 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	1981 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	1982 mailing list because of great opposition in the nmh community.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1983 .[
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1984 nmh-workers attachment proposal
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1985 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	1986 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	1987 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1 .
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1988 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	1989 Instead of command line switches, the
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1990 .Pe Attachment-Header
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1991 profile entry is used to specify
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1992 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	1993 It is pre-defined to
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1994 .Hd Attach .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1995 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1996 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	1997 .VS
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1998 To: bob
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1999 Subject: The file you wanted
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2000 Attach: /path/to/the/file-bob-wanted
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2001 --------
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2002 Here it is.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2003 VE
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2004 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	2005 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	2006 non-interactively with
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2007 .Pn anno :
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2008 .VS
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2009 anno -append -nodate -component Attach -text /path/to/attachment
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2010 VE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2011 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	2012 .Pn send .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2013 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	2014 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	2015 attachment headers.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2016 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	2017 is not accessible) the original draft is not changed.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2018 .P
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2019 The attachment system handles the forwarding of messages, too.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	2020 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	2021 like in
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2022 .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	2023 the given messages in the specified folder will be attached.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2024 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	2025 .Pn forw
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2026 .Ci f41f04cf4ceca7355232cf7413e59afafccc9550 .
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2027 .P
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2028 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	2029 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	2030 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	2031 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	2032 This was necessary whenever the draft contained non-ASCII characters.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2033 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	2034 Therefore, the
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2035 .Pe automimeproc
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2036 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	2037 automatically each time.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2038 Unfortunately, this approach conflicted with the attachment system
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2039 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	2040 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	2041 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	2042 WhatNow prompt and
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2043 .Pe automimeproc
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2044 must not be set in the profile.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2045 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	2046 not caught.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2047 All in all, the solution was complex and irritating.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2048 My patch from December 2010
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2049 .[
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2050 nmh-workers attachment proposal
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2051 .]
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2052 would have simplified the situation.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2053 .P
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2054 Mmh's current solution is even more elaborate.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2055 Any necessary MIMEification is done automatically.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2056 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	2057 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	2058 attachment header or non-ASCII text is present.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	2059 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	2060 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	2061 .\" XXX REF ?
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2062 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	2063 .P
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2064 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	2065 compositions directly, the full power of
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2066 .Pn mhbuild
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2067 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	2068 Given no attachment headers are included, users can create
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2069 .Pn mhbuild
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2070 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	2071 Then, at the WhatNow prompt, they can invoke
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2072 .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	2073 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	2074 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	2075 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	2076 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2077 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	2078 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	2079 This case was simplified.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2080
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2081
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2082 .U3 "MIME Type Guessing
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2083 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2084 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	2085 .Pn mhbuild
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2086 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	2087 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	2088 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	2089 This is a difficult task.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2090 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	2091 partly intelligent work.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2092 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	2093 forces him to do partly mechanical work.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2094 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	2095 content.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2096 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	2097 .Ci 3baec236a39c5c89a9bda8dbd988d643a21decc6 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2098 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2099 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	2100 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	2101 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	2102 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	2103 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	2104 Mmh implements this approach in the
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2105 .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	2106 script
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2107 .Ci 4b5944268ea0da7bb30598a27857304758ea9b44 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2108 .P
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2109 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	2110 .Pn file .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2111 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	2112 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	2113 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	2114 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	2115 Nevertheless, modern versions of GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2116 .Pn file ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2117 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	2118 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	2119 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	2120 it solves the difficult problem well.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2121 On systems where GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2122 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2123 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	2124 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	2125 .VS
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2126 Mime-Type-Query: file -b --mime
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2127 VE
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2128 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2129 Other versions of
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2130 .Pn file
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2131 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	2132 The diversity among
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2133 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2134 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	2135 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2136 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	2137 for a specific file.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2138 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	2139 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	2140 I consider both cases impractical.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2141 The existing solution should be sufficient.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2142 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	2143 .Pn mhbuild
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2144 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	2145
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2146
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2147 .U3 "Storing Attachments
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2148 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2149 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	2150 .Pn mhstore .
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2151 The program has two operation modes,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2152 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2153 and
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2154 .Sw -noauto .
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2155 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	2156 MIME part's meta information, if available.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2157 This naming information is usually available for modern attachments.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2158 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	2159 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2160 would have been specified.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2161 In the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2162 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2163 mode, the parts are processed according to rules, defined by
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2164 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2165 profile entries.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2166 These rules define generic filename templates for storing
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2167 or commands to post-process the contents in arbitrary ways.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2168 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	2169 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	2170 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2171 The
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2172 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2173 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	2174 in contrast to the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2175 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2176 mode.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2177 In mmh,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2178 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2179 is not dangerous anymore.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2180 Two changes were necessary:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2181 .LI 1
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2182 Any directory path is removed from the proposed filename.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2183 Thus, the files are always stored in the expected directory.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2184 .Ci 41b6eadbcecf63c9a66aa5e582011987494abefb
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2185 .LI 2
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2186 Tar files are not extracted automatically any more.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2187 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	2188 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2189 .P
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2190 In mmh, the result of
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2191 .Cl "mhstore -auto
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	2192 can be foreseen from the output of
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2193 .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	2194 Although the
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2195 .Sw -noauto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2196 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	2197 .Sw -auto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2198 is safe now.
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2199 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	2200 is intuitive.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2201 Hence,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2202 .Sw -auto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2203 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	2204 .Ci 3410b680416c49a7617491af38bc1929855a331d .
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2205 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2206 Files are stored into the directory given by the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2207 .Pe Nmh-Storage
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2208 profile entry, if set, or
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2209 into the current working directory, otherwise.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2210 Storing to different directories is only possible with
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2211 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2212 profile entries.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2213 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2214 Still existing files get overwritten silently in both modes.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2215 This can be considered a bug.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2216 Yet, each other behavior has its draw-backs, too.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2217 Refusing to replace files requires adding a
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2218 .Sw -force
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2219 switch.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2220 Users will likely need to invoke
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2221 .Pn mhstore
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2222 a second time with
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2223 .Sw -force .
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2224 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	2225 This requires interaction, which I like to avoid if possible.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2226 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	2227 For now, the behavior remains as it is.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2228 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2229 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	2230 .Pn mhstore 's
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2231 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2232 mode.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2233 Instead of storing message/rfc822 parts as files to disk,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2234 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	2235 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	2236 automatically reassembled beforehand.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2237 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	2238 anymore.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2239 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	2240 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	2241 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32 .
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2242 .\" XXX mention somewhere else too: (The profile entry `nmh-access-ftp'
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2243 .\" and sbr/ruserpass.c for reading ~/.netrc are gone now.)
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2244 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	2245 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	2246 dangerous part of the
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2247 .Sw -auto
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2248 mode
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2249 .Ci 94c80042eae3383c812d9552089953f9846b1bb6 .
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2250
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2251
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2252
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2253 .U3 "Showing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2254 .P
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2255 The program
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2256 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2257 was written to display MIME messages.
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2258 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	2259 Nmh's
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2260 .Pn mhshow
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2261 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	2262 to the user.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2263 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	2264 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	2265 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	2266 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	2267 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	2268 information on how to display the individual parts.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2269 I adjusted
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2270 .Pn mhshow 's
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2271 behavior to the modern view on the topic.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2272 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2273 (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	2274 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2275 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	2276 and is no longer part of mmh.
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2277 .\" XXX ref to other section
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2278 Although
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2279 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2280 was renamed to
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2281 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2282 in mmh, this section uses the name
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2283 .Pn mhshow ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2284 in order to avoid confusion.)
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2285 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2286 In mmh, the basic idea is that
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2287 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2288 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	2289 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2290 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2291 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	2292 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	2293 .Ci a4197ea6ffc5c1550e8b52d5a654bcaaaee04a4e .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2294 In consequence,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2295 .Pn mhl
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2296 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	2297 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70 .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2298 With
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2299 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2300 replacing the original
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2301 .Pn show ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2302 the output of
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2303 .Pn mhl
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2304 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	2305 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2306 Hence,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2307 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2308 does not need to invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2309 The one and only job of
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2310 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2311 is to format messages or parts of them.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2312 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	2313 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2314 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2315 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	2316 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	2317 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	2318 .Pe mhshow-show-*
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2319 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	2320 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	2321 .ig \"XXX
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2322 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2323 profile entries can be used to display MIME parts in a specific way.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2324 to display them in the terminal.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2325 ..
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2326 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	2327 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	2328 is ignored.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2329 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	2330 .Ci d0581ba306a7299113a346f9b4c46ce97bc4cef6 .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2331 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	2332 .Sw -serialonly
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2333 switch of
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2334 .Pn mhshow .
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	2335 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	2336 the `\fL%e\fP' escape in
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2337 .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	2338 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	2339 .Ci a20d405db09b7ccca74d3e8c57550883da49e1ae .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2340 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2341 Other kinds of attachments are ignored.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2342 With
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2343 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2344 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	2345 the message.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2346 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	2347 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2348 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	2349 to the native charset.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2350 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2351 .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	2352 profile entries were needed.
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2353 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	2354 text through the
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2355 .Pn iconv
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2356 command, if necessary
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2357 .Ci 2433122c20baccb10b70b49c04c6b0497b5b3b60 .
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2358 Custom
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2359 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2360 rules for textual content might need a
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2361 .Cl "iconv -f %c %f \|
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2362 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	2363 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2364 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	2365 has improved, it is not consistent enough.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2366 Further work needs to be done and
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2367 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	2368 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	2369 correctly without the need to configure anything.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2370
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2371
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2372 .ig
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2373
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2374 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2375 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	2376 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	2377 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	2378 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	2379 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	2380 it!
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2381 (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	2382 ~/.netrc are gone now.)
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2383 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2384
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2385 ..
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2386
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2387
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2388
166 f102dcc06bb9 s/digital cryptography/signing and encryption/ markus schnalke <meillo@marmaro.de> parents: 165 diff changeset	2389 .H2 "Signing and Encrypting
22 99409e4546d2 Wrote about the removal of tools. markus schnalke <meillo@marmaro.de> parents: 21 diff changeset	2390 .P
166 f102dcc06bb9 s/digital cryptography/signing and encryption/ markus schnalke <meillo@marmaro.de> parents: 165 diff changeset	2391 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	2392 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	2393 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	2394 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	2395 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	2396 out-of-the-box.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2397 Therefore, Neil Rickert's
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2398 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2399 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2400 .Pn mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2401 scripts
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2402 .[
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2403 neil rickert mhsign mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2404 .]
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2405 were included
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2406 .Ci f45cdc98117a84f071759462c7ae212f4bc5ab2e
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2407 .Ci 58cf09aa36e9f7f352a127158bbf1c5678bc6ed8 .
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2408 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	2409 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	2410 Additionally, no licensing difficulties appeared
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2411 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	2412 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2413 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2414 handles the signing and encrypting part.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2415 It comprises about 250 lines of shell code and interfaces between
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2416 .Pn gnupg "
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2417 .[
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2418 gnupg website
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2419 .]
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2420 and the MH system.
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2421 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	2422 .Pn send
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2423 invokes
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2424 .Pn mhsign
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2425 automatically
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2426 .Ci c7b5e1df086bcc37ff40163ee67571f076cf6683 .
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2427 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	2428 If a draft contains the
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2429 .Hd Sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2430 header field,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2431 .Pn send
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2432 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	2433 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	2434 .Pe Pgpkey
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2435 profile entry.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2436 .Pn send
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2437 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	2438 but by invoking
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2439 .Pn mhsign
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2440 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	2441 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	2442 .Hd Enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2443 header field.
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2444 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	2445 in a file called
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2446 .Fn pgpkeys ,
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2447 which contains exceptions and overrides.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2448 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	2449 .Pn mhsign
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2450 will refuse to encrypt it.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2451 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	2452 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	2453 approach.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2454 .P
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2455 .Pn mhpgp
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2456 is the companion to
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2457 .Pn mhsign .
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2458 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	2459 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	2460 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	2461 Currently,
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2462 .Pn mhpgp
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2463 needs to be invoked manually.
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2464 The integration into
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2465 .Pn show
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2466 and
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2467 .Pn mhstore
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2468 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	2469 is planned but not yet realized.
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2470 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2471 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	2472 Hence they needed to be adjust
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2473 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	2474 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	2475 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	2476 .P
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2477 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	2478 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	2479 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	2480 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	2481 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	2482 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	2483 .Sw -[no]sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2484 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2485 .Sw -[no]enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2486 switches to
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2487 .Pn send ,
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2488 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	2489 A profile entry:
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2490 .VS
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2491 send: -sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2492 VE
177 3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2493 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	2494 With the present approach, a
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2495 .Hd Send
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2496 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	2497 to achieve the same result.
3d7db5c7965d Finished the section on signing and encryption. markus schnalke <meillo@marmaro.de> parents: 173 diff changeset	2498 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	2499 template files clean.
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2500
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2501
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2502
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2503
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2504 .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	2505 .P
14 55ec590cfa07 Wrote about the draft folder. markus schnalke <meillo@marmaro.de> parents: 12 diff changeset	2506
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2507 .U3 "Draft Folder
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2508 .Id draft-folder
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2509 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2510 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	2511 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	2512 .Fn draft
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2513 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	2514 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	2515 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	2516 the user had to decide among:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2517 .LI 1
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2518 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	2519 .LI 2
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2520 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	2521 .LI 3
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2522 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	2523 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2524 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	2525 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	2526 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	2527 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	2528 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	2529 help anything.
131 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 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	2532 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	2533 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	2534 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	2535 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	2536 out-of-the-box.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2537 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	2538 .Mp mh-draft (5)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2539 to better document the feature.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2540 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2541 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	2542 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	2543 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	2544 complex cases.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2545 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	2546 it tries to solve.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2547 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	2548 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	2549 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	2550 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	2551 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	2552 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	2553 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	2554 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2555 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	2556 default name.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2557 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	2558 .Fn +drafts ,
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2559 for obvious reasons.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2560 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	2561 .Sw -draftfolder
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2562 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2563 .Sw -draftmessage
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2564 could be removed.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2565 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	2566 new concept.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2567 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	2568 approaches.
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2569 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	2570 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	2571 .Sw -draft
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2572 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	2573 special.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2574 It became indistinguishable to operating on any other message.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2575 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2576 .P
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2577 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	2578 .Ci 2d48b455c303a807041c35e4248955f8bec59eeb .
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2579 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	2580 Refiling drafts is without difference to refiling other messages.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2581 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	2582 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	2583 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2584 still has
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2585 .Sw -[no]use
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2586 for switching between two modes:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2587 .LI 1
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2588 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	2589 .Sw -use .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2590 .LI 2
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2591 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	2592 with
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2593 .Sw -nouse ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2594 the default.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2595 .LP
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2596 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	2597 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2598 is deterministic.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2599 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2600 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2601 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	2602 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	2603 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	2604 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	2605 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	2606 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2607 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	2608 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2609 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	2610 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	2611 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	2612 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	2613 but applies them.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2614 .Cl "scan +drafts" ,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2615 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	2616 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2617 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	2618 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	2619 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	2620 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	2621 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	2622 it was important.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2623
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2624
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2625 .U3 "Trash Folder
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2626 .Id trash-folder
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2627 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2628 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	2629 Historically, a message was ``deleted'' by prepending a specific
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	2630 \fIbackup prefix\fP, usually the comma character,
4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	2631 to the file name.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2632 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	2633 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	2634 Although files remained in the file system,
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2635 the messages were no longer visible in MH.
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2636 To truly delete them, a maintenance job was needed.
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2637 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	2638 For instance:
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2639 .VS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2640 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	2641 VE
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2642 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	2643 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	2644 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	2645 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	2646 message
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2647 .Fn 6 ,
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2648 became file
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2649 .Fn ,6 .
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2650 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	2651 the number one above the highest existing message number.
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2652 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	2653 .Fn 6 ,
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2654 reusing the number.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2655 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	2656 then the backup of the former message becomes overwritten.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2657 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	2658 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	2659 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	2660 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	2661 ``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	2662 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	2663 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	2664 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	2665 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	2666 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	2667 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2668 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	2669 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	2670 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	2671 .Pn find ,
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2672 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	2673 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	2674 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2675 The profile entry
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2676 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2677 (previously named
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2678 .Pe Delete-Prog )
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2679 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	2680 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	2681 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	2682 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	2683 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	2684 Nmh's man page
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2685 .Mp rmm (1)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2686 proposes to set the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2687 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2688 to
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2689 .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	2690 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	2691 .Fn +d
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2692 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	2693 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	2694 .Cl "rm `mhpath +d all`
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2695 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	2696 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2697 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	2698 .LI 1
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2699 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	2700 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	2701 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	2702 .LI 2
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2703 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	2704 .LI 3
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2705 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	2706 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	2707 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	2708 .Pn refile
f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	2709 can restore deleted messages.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2710 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	2711 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	2712 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2713 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	2714 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	2715 Hence,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2716 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2717 calls
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2718 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2719 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	2720 .Fn +trash
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2721 by default.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2722 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	2723 .Cl "rmm -unlink +trash a" ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2724 where the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2725 .Sw -unlink
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2726 switch causes the files to be unlinked.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2727 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2728 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2729 .P
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2730 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	2731 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	2732 The relationship between
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2733 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2734 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2735 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2736 was inverted.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2737 In mmh,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2738 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2739 invokes
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2740 .Pn refile .
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2741 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	2742 Yet, the relationship is simpler now.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2743 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	2744 .Mp refile (1),
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2745 can no longer occur:
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2746 .QS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2747 Since
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2748 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2749 uses your
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2750 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2751 to delete the message, the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2752 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2753 must NOT call
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2754 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2755 without specifying
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2756 .Sw -normmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2757 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	2758 .QE
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2759 .LP
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2760 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2761 either unlinks a message with
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2762 .Fu unlink()
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2763 or invokes
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2764 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2765 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	2766 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2767 does not invoke any tools.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2768 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2769 By generalizing the message removal in the way that it became covered
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2770 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	2771
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2772
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2773
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2774
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2775
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2776 .H2 "Modern Defaults
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2777 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2778 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	2779 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	2780 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	2781 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	2782 But what are old versions?
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2783 Still, the highly useful draft folder facility has not been activated
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2784 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	2785 .[
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2786 rose romine real work
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2787 .]
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2788 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	2789 .P
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2790 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	2791 a profile before they can access the modern features.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2792 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	2793 for modern emailing.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2794 The point is not the customization of the setup,
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2795 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	2796 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	2797 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	2798 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	2799 to discover the available but inactive features.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2800 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	2801 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	2802 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	2803 documentation.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2804 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	2805 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	2806 just work.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2807 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	2808 and I am a software developer,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2809 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	2810 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	2811 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	2812 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	2813 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	2814 before they truly used the system,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2815 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	2816 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	2817 we developers should spare them further inconveniences.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2818 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2819 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	2820 because the code base will collect more and more compatibility code.
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	2821 Sticking to the compatibility code means remaining limited;
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2822 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	2823 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	2824 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	2825 gather bugs by not being constantly tested.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2826 Also, the increased code size and the greater number of conditions
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2827 increase the maintenance costs.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2828 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	2829 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	2830 important.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2831 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	2832 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	2833 Its importance originates from personal reasons rather.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2834 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	2835 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	2836 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	2837 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	2838 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	2839 But the future lies in new users.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2840 In consequence, mmh invites new users by providing a convenient
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2841 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	2842 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2843 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	2844 approaches are removed or only accessible in a manual way.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2845 New default features include:
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2846 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2847 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	2848 .Hd Attach )
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2849 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1 .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2850 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2851 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	2852 .Fn +drafts )
f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2853 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2854 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2855 The unseen sequence (`u')
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2856 .Ci c2360569e1d8d3678e294eb7c1354cb8bf7501c1
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2857 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	2858 .Ci db74c2bd004b2dc9bf8086a6d8bf773ac051f3cc .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2859 .BU
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2860 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	2861 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6 .
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2862 .BU
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2863 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	2864 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1 .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	2865 .LP
217 f3f65376bef9 A big bunch of corrections in 2.1 and 2.2. markus schnalke <meillo@marmaro.de> parents: 212 diff changeset	2866 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	2867 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	2868 Again, Paul Vixie's supports the direction I took:
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2869 ``the `main branch' should just be modern''.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2870 .[
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2871 paul vixie edginess nmh-workers
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2872 .]
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2873
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2874
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2875
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2876
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2877
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2878 .\" --------------------------------------------------------------
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2879 .H1 "Styling
16 81f703140554 Wrote about the trash folder. markus schnalke <meillo@marmaro.de> parents: 14 diff changeset	2880 .P
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2881 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	2882 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	2883 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2884 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	2885 .], p. x]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2886 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2887 Chapter 1 discusses programming style.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2888 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	2889 to cover it first.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2890 .QE
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	2891 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	2892 to improve on style.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2893 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	2894
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2895
127 4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2896
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2897
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2898 .H2 "Code Style
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2899 .Id code-style
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2900 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2901 .U3 "Indentation Style
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2902 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2903 Indentation styles are the holy cow of programming.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2904 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	2905 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2906 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	2907 .], p. 10]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2908 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2909 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	2910 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	2911 application.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2912 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	2913 time arguing.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2914 .QE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2915 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2916 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	2917 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	2918 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	2919 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	2920 one tab, one level.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2921 Tab characters provide flexible visual appearance because developers
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2922 can adjust their width as prefered.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2923 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	2924 tabs and spaces.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2925 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	2926 appearance:
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2927 .LI 1
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2928 Leading whitespace must consist of tabs only.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2929 .LI 2
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2930 All other whitespace should be spaces.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2931 .LP
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2932 Although reformatting existing code should be avoided, I did it.
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	2933 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	2934 .Ci a485ed478abbd599d8c9aab48934e7a26733ecb1
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2935
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2936 .U3 "Comments
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2937 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2938 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	2939 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2940 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	2941 .], p. 23]
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2942 Following the advice, I removed unnecessary comments.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2943 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	2944 .Ci 426543622b377fc5d091455cba685e114b6df674 :
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2945 .VS
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2946 context_replace(curfolder, folder); /* update current folder */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2947 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	2948 seq_save(mp); /* synchronize message sequences */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2949 folder_free(mp); /* free folder/message structure */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2950 context_save(); /* save the context file */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2951
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2952 [...]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2953
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2954 int c; /* current character */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2955 char cp; / miscellaneous character pointer */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2956
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2957 [...]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2958
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2959 /* NUL-terminate the field */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2960 *cp = '\0';
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2961 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2962 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2963 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	2964 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	2965 obvious from the context.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2966
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2967
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2968 .U3 "Names
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2969 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2970 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	2971 ``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	2972 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2973 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	2974 .], p. 4]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2975 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	2976 .Fu check_charset()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2977 to
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2978 .Fu is_native_charset()
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2979 .Ci 8d77b48284c58c135a6b2787e721597346ab056d .
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2980 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	2981 .[ [
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	2982 kernighan pike practice of programming
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	2983 .], p. 4]
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2984 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	2985 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	2986 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	2987 .VS
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2988 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	2989 VE
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2990 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	2991 are different.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2992 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2993 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	2994 .VS
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2995 m_unknown(in); /* the MAGIC invocation... */
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2996 VE
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2997 Renaming the obscure
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2998 .Fu m_unknown()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	2999 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	3000 .Ci 611d68d19204d7cbf5bd585391249cb5bafca846 .
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3001 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3002 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	3003 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	3004 ``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	3005 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3006 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	3007 .], p. 19]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3008 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3009 The argument
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3010 .CW outnum
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3011 of the function
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3012 .Fu scan()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3013 in
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3014 .Fn uip/scansbr.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3015 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	3016 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	3017 This led to obscure code.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3018 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	3019 the hidden information:
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3020 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3021 int incing = (outnum > 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3022 int ismbox = (outnum != 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3023 VE
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3024 The readable names are thus used in conditions;
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3025 the variable
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3026 .CW outnum
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3027 is used only to extract ordinary message numbers
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3028 .Ci b8b075c77be7794f3ae9ff0e8cedb12b48fd139f .
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3029 .P
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3030 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	3031 logic of related code parts became apparent.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3032 The implementation was simplified.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3033 This possibility to improve had been invisible before
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3034 .Ci aa60b0ab5e804f8befa890c0a6df0e3143ce0723 .
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3035 .P
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3036 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	3037 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	3038 .CW outnum :
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3039 .VS
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3040 #define SCN_MBOX (-1)
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3041 #define SCN_FOLD 0
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3042 VE
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3043 The two variables were updated thereafter as well:
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3044 .VS
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3045 int incing = (outnum != SCN_MBOX && outnum != SCN_FOLD);
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3046 int scanfolder = (outnum == SCN_FOLD);
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3047 VE
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3048 Furthermore,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3049 .CW ismbox
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3050 was replaced by
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3051 .CW scanfolder
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3052 because that matched better to the program logic.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3053 .Ci 7ffb36d28e517a6f3a10272056fc127592ab1c19
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3054
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3055
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3056
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3057
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3058 .H2 "Structural Rework
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3059 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3060 Although the stylistic changes described already improve the
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3061 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	3062 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	3063 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	3064 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	3065 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3066 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	3067 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	3068 .[ [
eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	3069 kernighan pike practice of programming
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3070 .], p. 28].
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3071 Following are two examples of structural rework that demonstrate
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	3072 why style is important in the first place.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	3073
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	3074
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	3075 .U3 "Rework of \f(CWanno\fP
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3076 .P
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3077 Until 2002,
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3078 .Pn anno
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3079 had six functional command line switches:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3080 .Sw -component
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3081 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3082 .Sw -text ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3083 each with an argument,
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3084 and the two pairs of flags,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3085 .Sw -[no]date
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3086 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3087 .Sw -[no]inplace .
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3088 Then Jon Steinhart introduced his attachment system.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3089 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	3090 .Pn anno .
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3091 He added five more switches:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3092 .Sw -draft ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3093 .Sw -list ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3094 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3095 .Sw -append ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3096 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3097 .Sw -number ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3098 the last one taking an argument
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3099 .Ci 7480dbc14bc90f2d872d434205c0784704213252 .
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3100 Later,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3101 .Sw -[no]preserve
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3102 was added as well
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3103 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f .
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3104 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	3105 .Mp anno (1)
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3106 read:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3107 .VS
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3108 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	3109 [-date \| -nodate] [-draft] [-append] [-list] [-delete]
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3110 [-number [f(CInumfP\|fPallfP]] [-preserve \| -nopreserve] [-version]
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3111 [-help] [-text f(CIbodyfP]
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3112 VE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3113 .LP
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3114 The implementation followed the same structure.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3115 Problems became visible when
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3116 .Cl "anno -list -number 42
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3117 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	3118 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3119 .Cl "anno -list -number l:5
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	3120 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	3121 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	3122 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	3123 There, the correct use of
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3124 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3125 was defined as being
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3126 .Cl "[-number [num\|all]]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3127 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	3128 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3129 read:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3130 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3131 The
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3132 .Sw -list
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3133 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	3134 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	3135 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	3136 .Sw -number
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3137 option is also used.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3138 .QE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3139 .LP
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3140 The problem was manifold.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3141 Semantically, the argument to the
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3142 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3143 switch is only necessary in combination with
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3144 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3145 but not with
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3146 .Sw -list .
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3147 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	3148 If the argument was missing or non-numeric,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3149 .Pn anno
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3150 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	3151 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	3152 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3153 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	3154 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	3155 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	3156 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	3157 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	3158 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3159 Steinhart had added the new
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3160 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3161 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3162 .Sw -delete
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3163 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	3164 they are of structural different type.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3165 Semantically,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3166 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3167 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3168 .Sw -delete
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3169 introduce operation modes.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3170 Historically,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3171 .Pn anno
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3172 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	3173 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	3174 listing and deleting header fields.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3175 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	3176 fundamental change.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3177 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	3178 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	3179 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	3180 .Pn anno
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3181 and its documentation
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3182 .Ci d54c8db8bdf01e8381890f7729bc0ef4a055ea11 .
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3183 .P
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3184 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	3185 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	3186 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3187 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	3188 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	3189 [...]
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3190 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3191 delete = 0;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3192 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3193 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3194 list = 1;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3195 continue;
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3196 VE
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3197 .LP
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3198 which was replaced by:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3199 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3200 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	3201 [...]
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3202 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3203 mode = MODE_DEL;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3204 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3205 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3206 mode = MODE_LIST;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3207 continue;
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3208 VE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3209 .LP
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3210 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	3211 it is easier to understand as well.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3212 The same applies to the documentation.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3213 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	3214 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	3215 .VS
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3216 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	3217 [-append] [-date \| -nodate] [-preserve \| -nopreserve]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3218 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3219
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3220 anno -delete [+folder] [msgs] [-component fPfieldfP] [-text
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3221 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	3222 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3223
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3224 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	3225 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3226 VE
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3227
16 81f703140554 Wrote about the trash folder. markus schnalke <meillo@marmaro.de> parents: 14 diff changeset	3228
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	3229
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3230 .U3 "Path Conversion
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3231 .P
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3232 Four kinds of path names can appear in MH:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3233 .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	3234 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	3235 .Fn /etc/passwd .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3236 .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	3237 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	3238 .Fn ./foo/bar .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3239 .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	3240 Absolute MH folder paths, like
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3241 .Fn +projects/mmh .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3242 .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	3243 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	3244 .Fn @subfolder .
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3245 .LP
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3246 Relative MH folder paths, are hardly documented
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3247 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	3248 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	3249 .Fn @ ',
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3250 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	3251 .Fn . '.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3252 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3253 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	3254 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	3255 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	3256 .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	3257 (``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	3258 .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	3259 (``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	3260 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	3261 than two comments, which described obvious information.
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3262 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	3263 semantics:
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3264 .LI 1
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3265 .CW "char path(char , int);
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3266 .LI 2
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3267 .CW "char pluspath(char );
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3268 .LI 3
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3269 .CW "char m_mailpath(char );
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3270 .LI 4
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3271 .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	3272 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3273 My investigations provided the following descriptions:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3274 .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	3275 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	3276 .Fu path()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3277 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	3278 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	3279 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	3280 Folder paths are converted to absolute folder paths.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3281 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	3282 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	3283 The result is a pointer to newly allocated memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3284 .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	3285 .Fu pluspath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3286 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	3287 .Fu path() ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3288 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	3289 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	3290 An empty string parameter causes a buffer overflow.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3291 .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	3292 .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	3293 converts directory paths to absolute directory paths.
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3294 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	3295 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	3296 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	3297 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	3298 returned as a pointer to newly allocated memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3299 .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	3300 .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	3301 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	3302 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	3303 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	3304 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	3305 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	3306 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	3307 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	3308 static memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3309 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3310 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	3311 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	3312 kinds of path names.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3313 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	3314 .Fu m_mailpath() ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3315 which was named
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3316 .CW folder ,
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3317 although
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3318 .Fu m_mailpath()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3319 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	3320 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3321 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	3322 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	3323 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	3324 \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	3325 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	3326 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	3327 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	3328 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	3329 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	3330 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	3331 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	3332 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	3333 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	3334 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	3335 current message.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3336 .Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3337 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	3338 .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	3339 .Fu expandfol()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3340 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	3341 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	3342 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	3343 The result is a pointer to static memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3344 .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	3345 .Fu expanddir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3346 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	3347 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	3348 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	3349 The result is a pointer to static memory.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3350 .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	3351 .Fu toabsdir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3352 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	3353 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	3354 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	3355 path name.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3356 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	3357 .P
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3358 .\" XXX ueberfluessig?
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3359 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	3360 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	3361 same type.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3362 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	3363 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	3364 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	3365 The file
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3366 .Fn sbr/path.c
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3367 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	3368 .Fn sbr/m_maildir.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3369 was removed.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3370 .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	3371 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3372 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	3373 .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	3374 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3375 .Fu getdeffol()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3376 and
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3377 .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	3378 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3379 .Fu getcurfol() ,
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3380 which only wraps
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3381 .Fu expandfol(""@"")
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3382 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	3383 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	3384 .Fn sbr/getfolder.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3385 into
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3386 .Fn sbr/path.c
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3387 as well.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3388 .Ci d39e2c447b0d163a5a63f480b23d06edb7a73aa0
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3389 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3390 The related function
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3391 .Fu etcpath()
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3392 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	3393 .Fn sbr/path.c ,
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3394 too
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3395 .Ci b4c29794c12099556151d93a860ee51badae2e35 .
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3396 Previously, it had been located in
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3397 .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	3398 .P
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3399 Now,
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3400 .Fn sbr/path.c
219 8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3401 contains all path handling code.
8c537982d718 Further improvements of the discussion chapter. markus schnalke <meillo@marmaro.de> parents: 217 diff changeset	3402 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	3403 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	3404
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3405
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3406
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3407
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3408 .H2 "Profile Reading
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3409 .P
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3410 The MH profile contains the configuration for the user-specific MH setup.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3411 MH tools read the profile right after starting up,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3412 as it contains the location of the user's mail storage
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3413 and similar settings that influence the whole setup.
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	3414 Furthermore, the profile contains the default switches for the tools,
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3415 hence, it must be read before the command line switches are processed.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3416 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3417 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	3418 Among them were
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3419 .Pn post /\c
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3420 .Pn spost ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3421 .Pn mhmail ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3422 and
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3423 .Pn slocal .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3424 The reason why these tools ignored the profile were not clearly stated.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3425 During the discussion on the nmh-workers mailing list,
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	3426 David Levine posted an explanation, quoting John Romine:
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3427 .[
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3428 nmh-workers levine post profile
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3429 .]
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3430 .QS
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3431 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	3432 agrees and provides an example that convinces me:
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3433 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3434 My take on this is that
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3435 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3436 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	3437 .Fn .mh_profile
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3438 (only front-end UI programs read the profile).
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3439 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3440 For example, there can be contexts where
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3441 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3442 is called by a helper program (like `\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3443 .Pn mhmail ')
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3444 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	3445 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	3446 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3447 My suggestion would be to have
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3448 .Pn send
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3449 pass a (hidden) `\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3450 .Sw -fileproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3451 .Ar proc '
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3452 option to
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3453 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3454 if needed.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3455 You could also
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3456 use an environment variable (I think
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3457 .Pn send /\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3458 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3459 do this).
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3460 .QE
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3461 I think that's the way to go.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3462 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	3463 not an environment variable.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3464 .QE
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3465 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3466 To solve the problem of
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3467 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3468 not honoring the
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3469 .Pe fileproc
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3470 profile entry,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3471 the community roughly agreed that a switch
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3472 .Sw -fileproc
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3473 should be added to
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3474 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3475 to be able to pass a different fileproc.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3476 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	3477 the problem; it only removes a single symptom.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3478 The problem is that
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3479 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3480 does not behave as expected.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3481 But all programs should behave as expected.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3482 Clear and simple concepts are a precondition for this.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3483 Hence, the real solution is having all MH tools read the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3484 .P
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3485 The problem has a further aspect.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3486 It mainly originates in
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3487 .Pn mhmail .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3488 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3489 was intended to be a replacement for
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3490 .Pn mailx
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3491 on systems with MH installations.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3492 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3493 should have been able to use just like
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3494 .Pn mailx ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3495 but sending the message via MH's
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3496 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3497 instead of
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3498 .Pn sendmail .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3499 Using
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3500 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3501 should not be influenced by the question whether the user had
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3502 MH set up for himself or not.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3503 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3504 did not read the profile as this requests the user to set up MH
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3505 if not done yet.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3506 As
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3507 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3508 used
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3509 .Pn post ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3510 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3511 could not read the profile neither.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3512 This is the reason why
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3513 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3514 does not read the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3515 This is the reason for the actual problem.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3516 It was not much of a problem because
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3517 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3518 was not intended to be used by users directly.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3519 .Pn send
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3520 is the interactive front-end to
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3521 .Pn post .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3522 .Pn send
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3523 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	3524 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3525 \(en an awkward solution.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3526 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3527 The important insight is that
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3528 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3529 is no true MH tool.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3530 The concepts broke because this outlandish tool was treated as any other
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3531 MH tool.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3532 Instead it should have been treated accordingly to its foreign style.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3533 The solution is not to prevent the tools reading the profile but
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3534 to instruct them reading a different profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3535 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3536 could have set up a well-defined profile and caused all MH tools
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3537 in the session to use it by exporting an environment variable.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3538 With this approach, no special cases would have been introduced,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3539 no surprises would have been caused.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3540 By writing a clean-profile-wrapper, the concept could have been
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3541 generalized orthogonally to the whole MH tool chest.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3542 Then Rose's motivation behind the decision that
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3543 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3544 ignores the profile, as quoted by Jeffrey Honig,
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	3545 would have become possible:
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3546 .[
197 05a243dffaca Added refs to the Preface; splitted the bib. markus schnalke <meillo@marmaro.de> parents: 187 diff changeset	3547 nmh-workers honig post profile
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3548 .]
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3549 .QS
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3550 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	3551 what the man page says.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3552 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	3553 .QE
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3554 .LP
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3555 Yet, I consider this explanation shortsighted.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3556 We should rather regard theses two cases as just two different MH setups,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3557 based on two different profiles.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3558 Mapping such problems on the concepts of switching between different
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3559 profiles, solves them once for all.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3560 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3561 In mmh, the wish to have
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3562 .Pn mhmail
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3563 as a replacement for
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3564 .Pn mailx
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3565 is considered obsolete.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3566 Mmh's
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3567 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3568 does no longer cover this use-case.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3569 Currently,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3570 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3571 is in a transition state.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3572 .Ci 32d4f9daaa70519be3072479232ff7be0500d009
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3573 It may become a front-end to
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3574 .Pn comp ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3575 which provides an interface more convenient in some cases.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3576 In this case,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3577 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3578 will become an ordinary MH tool, reading the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3579 If, however, this idea will not convince, then
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3580 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3581 will be removed.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3582 .P
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3583 Every program in the mmh tool chest reads the profile.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3584 The only exception is
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3585 .Pn slocal ,
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3586 which is not considered part of the mmh tool chest.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3587 This MDA is only distributed with mmh, currently.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3588 Mmh has no
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3589 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3590 program, but
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3591 .Pn spost ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3592 which now reads the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3593 .Ci 3e017a7abbdf69bf0dff7a4073275961eda1ded8
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3594 With this change,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3595 .Pn send
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3596 and
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3597 .Pn spost
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3598 can be considered to be merged.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3599 .Pn spost
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	3600 is only invoked directly by the to-be-changed
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3601 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3602 implementation and by
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3603 .Pn rcvdist ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3604 which will require rework.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3605 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3606 The
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3607 .Fu context_foil()
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3608 function to pretend to have read an empty profile was removed.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3609 .Ci 68af8da96bea87a5541988870130b6209ce396f6
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3610 All mmh tools read the profile.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3611
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3612
127 4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	3613
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3614 .H2 "Standard Libraries
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	3615 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3616 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	3617 Hence, MH included own implementations of functions
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3618 that are standardized and thus widely available today,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3619 but were not back then.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3620 Today, twenty years after the POSIX and ANSI C were published,
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3621 developers can expect systems to comply with these standards.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3622 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	3623 can and should be dropped.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3624 Kernighan and Pike advise: ``Use standard libraries.''
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3625 .[ [
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3626 kernighan pike practice of programming
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3627 .], p. 196]
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3628 Actually, MH had followed this advice in history,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3629 but it had not adjusted to the changes in this field.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3630 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3631 .Fu snprintf()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3632 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	3633 almost everywhere because of its high usefulness.
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3634 The project's own implementation of
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3635 .Fu snprintf()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3636 was dropped in March 2012 in favor for using the one of the
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3637 standard library.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3638 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3639 Such decisions limit the portability of mmh
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3640 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	3641 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	3642 .P
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3643 .\" XXX kuerzen und mit dem naechsten Absatz vereinen
731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3644 I am still in my twenties and my C and Unix experience comprises
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3645 only half a dozen years.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3646 Hence, I need to learn about the history in retrospective.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3647 I have not used those ancient constructs myself.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3648 I have not suffered from their incompatibilities.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3649 I have not longed for standardization.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3650 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	3651 were well established already.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3652 I have only read a lot of books about the (good) old times.
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3653 This puts me in a difficult position when working with old code.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3654 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	3655 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	3656 heart from their own experience.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3657 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3658 Being aware of the situation, I rather let people with more historic
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3659 experience replace ancient code constructs with standardized ones.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3660 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	3661 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	3662 also removing the conditionals compilation of now standardized features.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3663 Ken Hornstein and David Levine had their part in the work, too.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3664 Often, I only needed to pull over changes from nmh into mmh.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3665 These changes include many commits; these are among them:
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3666 .Ci 768b5edd9623b7238e12ec8dfc409b82a1ed9e2d
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3667 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	3668 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3669 During my own work, I tidied up the \fIMH standard library\fP,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3670 .Fn libmh.a ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3671 which is located in the
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3672 .Fn sbr
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3673 (``subroutines'') directory in the source tree.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3674 The MH library includes functions that mmh tools usually need.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3675 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	3676 and folder handling, but as well
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3677 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	3678 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	3679 functions of the standard library.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3680 .P
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3681 I have replaced the
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3682 .Fu atooi()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3683 function with calls to
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3684 .Fu strtoul()
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	3685 with the third parameter, the base, set to eight.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3686 .Fu strtoul()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3687 is part of C89 and thus considered safe to use.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3688 .Ci c490c51b3c0f8871b6953bd0c74551404f840a74
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3689 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3690 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	3691 .Fu memmove()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3692 and
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3693 .Fu strerror() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3694 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	3695 to support SunOS 4.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3696 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	3697 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	3698 put a load on mmh.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3699 .Ci b067ff5c465a5d243ce5a19e562085a9a1a97215
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3700 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3701 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3702 .Fu copy()
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3703 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	3704 parameter two.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3705 In contrast to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3706 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3707 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	3708 The code was adjusted to replace
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3709 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3710 with
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3711 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3712 except within
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3713 .Fu concat() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3714 where
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3715 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3716 was more convenient.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3717 Therefore, the definition of
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3718 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3719 was moved into the source file of
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3720 .Fu concat()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3721 and its visibility is now limited to it.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3722 .Ci 552fd7253e5ee9e554c5c7a8248a6322aa4363bb
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	3723 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3724 The function
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3725 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3726 had been a generalized version of
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3727 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3728 with minor differences.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3729 As all calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3730 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3731 had the slash (`/') as delimiter anyway,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3732 replacing
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3733 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3734 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	3735 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3736 became desirable.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3737 Unfortunately, many of the 54 calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3738 .Fu r1bindex()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3739 depended on a special behavior,
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3740 which differed from the POSIX specification for
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3741 .Fu basename() .
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3742 Hence,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3743 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3744 was kept but renamed to
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3745 .Fu mhbasename() ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3746 fixing the delimiter to the slash.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3747 .Ci 240013872c392fe644bd4f79382d9f5314b4ea60
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3748 For possible uses of
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3749 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3750 with a different delimiter,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3751 the ANSI C function
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3752 .Fu strrchr()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3753 provides the core functionality.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3754 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3755 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3756 .Fu ssequal()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3757 function \(en apparently for ``substring equal'' \(en
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3758 was renamed to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3759 .Fu isprefix() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3760 because this is what it actually checks.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3761 .Ci c20b4fa14515c7ab388ce35411d89a7a92300711
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3762 Its source file had included the following comments, no joke.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3763 .VS
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3764 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3765 * THIS CODE DOES NOT WORK AS ADVERTISED.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3766 * 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	3767 * 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	3768 * 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	3769 * should be kept if it's sufficient.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3770 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3771
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3772 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3773 * 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	3774 * 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	3775 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3776 VE
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3777 Two months later, it was completely removed by replacing it with
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3778 .Fu strncmp() .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3779 .Ci b0b1dd37ff515578cf7cba51625189eb34a196cb
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3780
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3781
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3782
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3783
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3784
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3785 .H2 "User Data Locations
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3786 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3787 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	3788 The profile is a file named
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3789 .Fn \&.mh_profile
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3790 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3791 It contains the static configuration.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3792 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	3793 .Pe Path .
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3794 The MH directory contains the mail storage and is the first
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3795 place to search for personal forms, scan formats, and similar
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3796 configuration files.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3797 The location of the MH directory can be chosen freely by the user.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3798 The default and usual name is a directory named
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3799 .Fn Mail
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3800 in the home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3801 .P
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	3802 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	3803 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	3804 configuration file.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3805 Why else should the mail storage and the configuration files be intermixed?
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3806 They are different kinds of data:
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3807 The data to be operated on and the configuration to change how
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3808 tools operate.
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3809 .\" XXX bad ... inapropriate?
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3810 Splitting the configuration between the profile and the MH directory
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3811 is bad.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3812 Merging the mail storage and the configuration in one directory is bad
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3813 as well.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3814 As the mail storage and the configuration were not separated sensibly
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3815 in the first place, I did it now.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3816 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3817 Personal mmh data is grouped by type, resulting in two distinct parts:
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3818 the mail storage and the configuration.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3819 In mmh, the mail storage directory still contains all the messages,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3820 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	3821 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	3822 located there.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3823 Therefore, the directory is no longer called the user's \fIMH directory\fP
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3824 but his \fImail storage\fP.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3825 Its location is still user-chosen, with the default name
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3826 .Fn Mail ,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3827 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3828 In mmh, the configuration is grouped together in
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3829 the hidden directory
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3830 .Fn \&.mmh
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3831 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3832 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	3833 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	3834 .Fn profile .
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3835 The location of the profile is no longer fixed to
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3836 .Fn $HOME/.mh_profile
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3837 but to
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3838 .Fn $HOME/.mmh/profile .
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3839 Having both the file
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3840 .Fn $HOME/.mh_profile
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3841 and the configuration directory
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3842 .Fn $HOME/.mmh
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3843 appeared to be inconsistent.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3844 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	3845 Unix users.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3846 .Ci 7030d7edb099bff36ded7548bb5380f7acab4f9b
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3847 .P
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3848 MH allows users to have multiple MH setups.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3849 Therefore, it is necessary to select a different profile.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3850 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	3851 personal MH setup.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3852 In nmh, the environment variable
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3853 .Ev MH
200 c299ed65d015 Spell checked. markus schnalke <meillo@marmaro.de> parents: 199 diff changeset	3854 could be used to specify a different profile.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3855 To operate in the same MH setup with a separate context,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3856 the
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3857 .Ev MHCONTEXT
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3858 environment variable could be used.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3859 This allows having own current folders and current messages in
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3860 each terminal, for instance.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3861 In mmh, three environment variables are used.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3862 .Ev MMH
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3863 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	3864 .Fn .mmh ).
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3865 .Ev MMHP
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3866 and
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3867 .Ev MMHC
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3868 override the paths to the profile and context files, respectively.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3869 This approach allows the set of personal configuration files to be chosen
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3870 independently from the profile, context, and mail storage.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	3871 .Ci 7030d7edb099bff36ded7548bb5380f7acab4f9b
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3872 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3873 The separation of the files by type is sensible and convenient.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3874 The new approach has no functional disadvantages,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3875 as every setup I can imagine can be implemented with both approaches,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3876 possibly even easier with the new approach.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3877 The main achievement of the change is the clear and sensible split
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3878 between mail storage and configuration.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3879
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3880
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3881
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3882
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3883
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3884 .H2 "Modularization
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3885 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3886 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	3887 .Fn uip
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3888 (``user interface programs'') directory.
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3889 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	3890 For example,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3891 .Pn rmm
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3892 is built from
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3893 .Fn uip/rmm.c .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3894 Some source files are used for multiple programs.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3895 For example
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3896 .Fn uip/scansbr.c
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	3897 is used for both
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3898 .Pn scan
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3899 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3900 .Pn inc .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3901 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	3902 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	3903 32 programs depended on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3904 17 programs depended on one source file only.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3905 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	3906 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	3907 18 programs depend on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3908 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	3909 (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	3910 as well as shell scripts and multiple names for the same program.)
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3911 .\" XXX graph
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3912 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3913 Splitting the source code of a large program into multiple files can
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3914 increase the readability of its source code.
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3915 .\" XXX however?
731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3916 Most of the mmh tools are simple and straight-forward programs.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3917 With the exception of the MIME handling tools,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3918 .Pn pick
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	3919 is the largest tool.
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	3920 It contains 1\\|037 lines of source code, excluding the MH library.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3921 Only the MIME handling tools (\c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3922 .Pn mhbuild ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3923 .Pn mhstore ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3924 .Pn show ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3925 etc.)
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3926 are larger.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3927 Splitting programs with less than 1\\|000 lines of code into multiple
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3928 source files seldom leads to better readability.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3929 For such tools, splitting makes sense
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3930 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	3931 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	3932 for including it in the MH library
b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	3933 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	3934 .Fn uip/packsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3935 for instance, provides the core program logic for the
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3936 .Pn packf
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3937 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3938 .Pn rcvpack
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3939 programs.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3940 .Fn uip/packf.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3941 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3942 .Fn uip/rcvpack.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3943 mainly wrap the core function appropriately.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3944 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	3945 As another example,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3946 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3947 provides termcap support, which requires linking with a termcap or
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3948 curses library.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3949 Including
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3950 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3951 into the MH library would require every program to be linked with
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3952 termcap or curses, although only few of the programs require it.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3953 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3954 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	3955 into multiple source files improves the readability.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3956 The program
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3957 .Pn mhstore ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3958 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	3959 lines of code in summary.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3960 The main code file
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3961 .Fn uip/mhstore.c
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3962 consists of 800 lines; the other 1\\|700 lines of code are reused in
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3963 other MIME handling tools.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3964 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	3965 a MH-MIME library, as a companion to the MH standard library.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3966 This is left open for the future.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3967 .P
169 f4ffe121a0a2 Applied excellent suggestions and corrections by Kate. markus schnalke <meillo@marmaro.de> parents: 168 diff changeset	3968 The work already accomplished focussed on the non-MIME tools.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3969 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	3970 This eases the understanding of the code base.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3971 In nmh,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3972 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3973 was built from six source files:
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3974 .Fn comp.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3975 .Fn whatnowproc.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3976 .Fn whatnowsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3977 .Fn sendsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3978 .Fn annosbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3979 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3980 .Fn distsbr.c .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3981 In mmh, it builds from only two:
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3982 .Fn comp.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3983 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3984 .Fn whatnowproc.c .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3985 In nmh's
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3986 .Pn comp ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3987 the core function of
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3988 .Pn whatnow ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3989 .Pn send ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3990 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3991 .Pn anno
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3992 were compiled into
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3993 .Pn comp .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3994 This saved the need to execute these programs with
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3995 .Fu fork()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3996 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3997 .Fu exec() ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3998 two expensive system calls.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	3999 Whereas this approach improved the time performance,
346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	4000 it interwove the source code.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4001 Core functionalities were not encapsulated into programs but into
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4002 function, which were then wrapped by programs.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4003 For example,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4004 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4005 included the function
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4006 .Fu annotate() .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4007 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	4008 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4009 and called
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4010 .Fu annotate() .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4011 Because the function
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4012 .Fu annotate()
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4013 was used like the tool
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4014 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4015 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	4016 When another pair of command line switches was added to
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4017 .Pn anno ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4018 a rather ugly hack was implemented to avoid adding another parameter
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4019 to the function.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4020 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4021 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4022 Separation simplifies the understanding of program code
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4023 because the area influenced by any particular statement is smaller.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4024 The separating on the program-level is more strict than the separation
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4025 on the function level.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4026 In mmh, the relevant code of
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4027 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4028 comprises the two files
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4029 .Fn uip/comp.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4030 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4031 .Fn uip/whatnowproc.c ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4032 together 210 lines of code.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4033 In nmh,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4034 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4035 comprises six files with 2\\|450 lines.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4036 Not all of the code in these six files was actually used by
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4037 .Pn comp ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4038 but the code reader needed to read all of the code first to know which
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4039 parts were used.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4040 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4041 As I have read a lot in the code base during the last two years,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4042 I learned about the easy and the difficult parts.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	4043 Code is easy to understand if the influenced code area is small
346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	4044 and its boundaries are strictly defined.
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	4045 Furthermore, the code needs to solve the problem in a straight-forward way.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4046 .P
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4047 .\" XXX move this paragraph somewhere else?
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4048 Reading
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4049 .Pn rmm 's
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4050 source code in
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4051 .Fn uip/rmm.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4052 is my recommendation for a beginner's entry point into the code base of nmh.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4053 The reasons are that the task of
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4054 .Pn rmm
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4055 is straight forward and it consists of one small source code file only,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4056 yet its source includes code constructs typical for MH tools.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4057 With the introduction of the trash folder in mmh,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4058 .Pn rmm
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4059 became a bit more complex, because it invokes
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4060 .Pn refile .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4061 Still, it is a good example for a simple tool with clear sources.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4062 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4063 Understanding
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4064 .Pn comp
180 731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	4065 .\" XXX kate fragen: more vs. as much
731e747a805b Applied corrections by Lydi. markus schnalke <meillo@marmaro.de> parents: 179 diff changeset	4066 requires to read 210 lines of code in mmh, but ten times more in nmh.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4067 Due to the aforementioned hack in
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4068 .Pn anno
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4069 to save the additional parameter, information passed through the program's
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4070 source base in obscure ways.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4071 Thus, understanding
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4072 .Pn comp ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4073 required understanding the inner workings of
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4074 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4075 first.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4076 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	4077 to be examined.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4078 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	4079 have avoided obscure programming techniques.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4080 By separating the tools on the program-level, the boundaries are
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4081 clearly visible and technically enforced.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4082 The interfaces are calls to
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4083 .Fu exec()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4084 rather than arbitrary function calls.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4085 .P
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4086 But the real problem is another:
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4087 Nmh violates the golden ``one tool, one job'' rule of the Unix philosophy.
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	4088 .\" XXX ref
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4089 Understanding
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4090 .Pn comp
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4091 requires understanding
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4092 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4093 and
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4094 .Fn uip/sendsbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4095 because
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4096 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4097 does annotate and send messages.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4098 In nmh, there surely exists the tool
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4099 .Pn send ,
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	4100 which does mainly send messages.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4101 But
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4102 .Pn comp
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4103 and
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4104 .Pn repl
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4105 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4106 .Pn forw
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4107 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4108 .Pn dist
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4109 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4110 .Pn whatnow
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4111 and
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4112 .Pn viamail ,
179 b59201e345e5 Applied further corrections by Aaron. markus schnalke <meillo@marmaro.de> parents: 178 diff changeset	4113 they all (!) have the same message sending function included, as well.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4114 In result,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4115 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4116 sends messages without using
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4117 .Pn send .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4118 The situation is the same as if
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4119 .Pn grep
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4120 would page without
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4121 .Pn more
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4122 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	4123 .P
173 4c7db172fb59 Various corrections and improvements. markus schnalke <meillo@marmaro.de> parents: 171 diff changeset	4124 The clear separation on the surface \(en the tool chest approach \(en
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4125 is violated on the level below.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4126 This violation is for the sake of time performance.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4127 On systems where
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4128 .Fu fork()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4129 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4130 .Fu exec()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4131 are expensive, the quicker response might be noticable.
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	4132 In the old times, sacrificing readability and conceptional beauty for
3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	4133 speed might even have been a must to prevent MH from being unusably slow.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4134 Whatever the reasons had been, today they are gone.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4135 No longer should we sacrifice readability or conceptional beauty.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4136 No longer should we violate the Unix philosophy's ``one tool, one job''
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4137 guideline.
181 eb6eeb10afd5 Various stuff: Checked quotes, s/further more/furthermore/, etc markus schnalke <meillo@marmaro.de> parents: 180 diff changeset	4138 .\" XXX ref
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4139 No longer should we keep speed improvements that became unnecessary.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4140 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4141 Therefore, mmh's
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4142 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4143 does no longer send messages.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4144 In mmh, different jobs are divided among separate programs that
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4145 invoke each other as needed.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4146 In consequence,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4147 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4148 invokes
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4149 .Pn whatnow
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4150 which thereafter invokes
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4151 .Pn send .
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4152 .Ci 3df5ab3c116e6d4a2fb4bb5cc9dfc5f781825815
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4153 .Ci c73c00bfccd22ec77e9593f47462aeca4a8cd9c0
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4154 The clear separation on the surface is maintained on the level below.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4155 Human users and the tools use the same interface \(en
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4156 annotations, for example, are made by invoking
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4157 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4158 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	4159 .Ci 469a4163c2a1a43731d412eaa5d9cae7d670c48b
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4160 .Ci aed384169af5204b8002d06e7a22f89197963d2d
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4161 .Ci 3caf9e298a8861729ca8b8a84f57022b6f3ea742
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4162 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	4163 the decrease of
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4164 .Fn uip/*sbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4165 files confirm the improvement.
168 277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4166 .Ci 9e6d91313f01c96b4058d6bf419a8ca9a207bc33
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4167 .ci 81744a46ac9f845d6c2b9908074d269275178d2e
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4168 .Ci f0f858069d21111f0dbea510044593f89c9b0829
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4169 .Ci 0503a6e9be34f24858b55b555a5c948182b9f24b
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4170 .Ci 27826f9353e0f0b04590b7d0f8f83e60462b90f0
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4171 .Ci d1da1f94ce62160aebb30df4063ccbc53768656b
277eeb5ba223 Applied suggestions by Lydi. markus schnalke <meillo@marmaro.de> parents: 166 diff changeset	4172 .Ci c42222869e318fff5dec395eca3e776db3075455
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4173 .P
145 3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4174 .\" XXX move this paragraph up somewhere
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4175 One disadvantage needs to be taken with this change:
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4176 The compiler can no longer check the integrity of the interfaces.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4177 By changing the command line interfaces of tools, it is
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4178 the developer's job to adjust the invocations of these tools as well.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4179 As this is a manual task and regression tests, which could detect such
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	4180 problems, are not available yet, it is prone to errors.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4181 These errors will not be detected at compile time but at run time.
171 346ff7e201f5 Applied suggestions by Boris. markus schnalke <meillo@marmaro.de> parents: 169 diff changeset	4182 Installing regression tests is a pending task.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4183 In the best case, a uniform way of invoking tools from other tools
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4184 can be developed to allow automated testing at compile time.
145 3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4185
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4186
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4187 .ig
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4188 XXX consider writing about mhl vs. mhlproc
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4189
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4190 sbr/showfile.c
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4191
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4192 23 /*
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4193 24 ** If you have your lproc listed as "mhl",
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4194 25 ** then really invoked the mhlproc instead
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4195 26 ** (which is usually mhl anyway).
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4196 27 */
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4197
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4198 Sat Nov 24 19:09:14 1984 /mtr (agent: Marshall Rose) <uci@udel-dewey>
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4199
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4200 sbr/showfile.c: if lproc is "mhl", use mhlproc for consistency
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4201 (Actually, user should use "lproc: show", "showproc: mhl".)
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4202 ..

Mercurial > docs > master

annotate discussion.roff @ 219:8c537982d718