docs/master: discussion.roff annotate

annotate discussion.roff @ 164:5c01017be420

Reacted to suggestions by Aaron Mueller.

author	markus schnalke <meillo@marmaro.de>
date	Mon, 09 Jul 2012 23:42:59 +0200
parents	8b411125645d
children	ea6eec1722d1

rev	line source
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1 .H0 "Discussion
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2 .P
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	3 This main chapter discusses the practical work done in the mmh project.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	4 It is structured along the goals to achieve.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	5 The concrete work done
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	6 is described in the examples of how the general goals were achieved.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	7 The discussion compares the current version of mmh with the state of
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	8 nmh just before the mmh project started, i.e. Fall 2011.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	9 Current changes of nmh will be mentioned only as side notes.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	10 .\" XXX where do I discuss the parallel development of nmh?
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	11
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	12
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	13
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	14 .\" --------------------------------------------------------------
125 0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/ markus schnalke <meillo@marmaro.de> parents: 124 diff changeset	15 .H1 "Streamlining
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	16
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	17 .P
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	18 MH had been considered an all-in-one system for mail handling.
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	19 The community around nmh has a similar understanding.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	20 In fundamental difference, mmh shall be a MUA only.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	21 I believe that the development of all-in-one mail systems is obsolete.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	22 Today, email is too complex to be fully covered by single projects.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	23 Such a project won't 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	24 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	25 which then can be combined to form a complete system.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	26 Excellent implementations for the various aspects of email exist already.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	27 Just to name three examples: Postfix is a specialized MTA,
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	28 .\" XXX homepages verlinken
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	29 Procmail is a specialized MDA, and Fetchmail is a specialized MRA.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	30 I believe that it is best to use such specialized tools instead of
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	31 providing the same function again as a side-component in the project.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	32 .\" XXX mail agent picture here
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	33 .P
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	34 Doing something well, requires to focus on a small set of specific aspects.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	35 Under the assumption that focused development produces better results
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	36 in the particular area, specialized projects will be superior
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	37 in their field of focus.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	38 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	39 or modular \(en will never be the best choice in any of the fields.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	40 Even in providing the best consistent all-in-one system they are likely
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	41 to be beaten by projects that focus only on integrating existing mail
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	42 components to a homogeneous system.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	43 .P
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	44 The limiting resource in Free Software community development
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	45 is usually man power.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	46 If the development power is spread over a large development area,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	47 it becomes even more difficult to compete with the specialists in the
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	48 various fields.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	49 The concrete situation for MH-based mail systems is even tougher,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	50 given the small and aged community, including both developers and users,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	51 it has.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	52 .P
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	53 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	54 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	55 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	56 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	57
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	58
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	59 .H2 "Mail Transfer Facilities
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	60 .Id mail-transfer-facilities
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	61 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	62 In contrast to nmh, which also provides mail submission and mail retrieval
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	63 agents, mmh is a MUA only.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	64 This general difference initiated the development of mmh.
66 4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	65 Removing the mail transfer facilities had been the first work task
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	66 in the mmh project.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	67 .P
105 9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	68 Focusing on one mail agent role only is motivated by Eric Allman's
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	69 experience with Sendmail.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	70 He identified the limitation of Sendmail to the MTA task as one reason for
105 9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	71 its success:
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	72 .[ [
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	73 costales sendmail
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	74 .], p. xviii]
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	75 .QS
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	76 Second, I limited myself to the routing function \(en
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	77 I wouldn't write user agents or delivery back-ends.
105 9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	78 This was a departure of the dominant through of the time,
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	79 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	80 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	81 .QE
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	82 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	83 In nmh, the Mail Submission Agent (MSA) is called
105 9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	84 \fIMessage Transfer Service\fP (MTS).
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	85 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	86 .Pn post
9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	87 command, established network connections and spoke SMTP to submit
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	88 messages to be relayed to the outside world.
105 9ff356d84c57 Added reference to Allman to the text; added missing reference to ML. markus schnalke <meillo@marmaro.de> parents: 104 diff changeset	89 The changes in email demanded changes in this part of nmh too.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	90 Encryption and authentication for network connections
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	91 needed to be supported, hence TLS and SASL were introduced into nmh.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	92 This added complexity to nmh without improving it in its core functions.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	93 Also, keeping up with recent developments in the field of
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	94 mail transfer requires development power and specialists.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	95 In mmh this whole facility was simply cut off.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	96 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	97 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	98 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	99 Instead, mmh depends on an external MSA.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	100 The only outgoing interface available to mmh is the
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	101 .Pn sendmail
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	102 command, which almost any MSA provides.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	103 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	104 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	105 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	106 over to the MSA.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	107 For example, a wrapper script for qmail would be:
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	108 .VS
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	109 #!/bin/sh
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	110 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	111 VE
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	112 The requirement to parse the recipient addresses out of the message header
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	113 is likely to be removed in the future.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	114 Then mmh would give the recipient addresses as command line arguments.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	115 This appears to be the better interface.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	116 .\" XXX implement it
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	117 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	118 To retrieve mail, the
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	119 .Pn inc
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	120 command acted as Mail Retrieval Agent (MRA).
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	121 It established network connections
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	122 and spoke POP3 to retrieve mail from remote servers.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	123 As with mail submission, the network connections required encryption and
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	124 authentication, thus TLS and SASL were added.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	125 Support for message retrieval through IMAP will become necessary
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	126 to be added soon, too, and likewise for any other changes in mail transfer.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	127 Not so for mmh because it has dropped the support for retrieving mail
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	128 from remote locations.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	129 .Ci ab7b48411962d26439f92f35ed084d3d6275459c
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	130 Instead, it depends on an external tool to cover this task.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	131 In mmh, two paths exist for messages to enter mmh's mail storage:
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	132 (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	133 .Pn inc
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	134 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	135 .Pn rcvstore
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	136 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	137 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	138 With the removal of the MSA and MRA, mmh converted from an all-in-one
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	139 mail system to being a MUA only.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	140 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	141 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	142 an external MRA is required to retrieve mail from remote machines.
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	143 There exist excellent implementations of such software,
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	144 which likely are superior than the internal version.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	145 Additionally, the best suiting programs can be freely chosen.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	146 .P
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	147 As it had already been possible to use an external MSA or MRA,
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	148 why not keep the internal version for convenience?
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	149 .\" XXX ueberleitung
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	150 The question whether there is sense in having a fall-back pager in all
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	151 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	152 .Pn more
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	153 or
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	154 .Pn less
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	155 aren't available, appears to be ridiculous.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	156 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	157 and not necessarily available but still the concept of orthogonal
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	158 design holds: ``Write programs that do one thing and do it well.''
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	159 .[
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	160 mcilroy unix phil
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	161 p. 53
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	162 .]
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	163 .[
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	164 mcilroy bstj foreword
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	165 .]
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	166 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	167 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	168 In other words:
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	169 Develop projects that focus on one thing and do it well.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	170 Projects grown complex should be split for the same reasons programs
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	171 grown complex should be split.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	172 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	173 separate projects then they should be separated.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	174 This is the case here, in my opinion.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	175 The RFCs propose this separation by clearly distinguishing the different
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	176 mail handling tasks.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	177 .[
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	178 rfc 821
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	179 .]
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	180 The small interfaces between the mail agents support the separation.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	181 .P
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	182 In the beginning, email had been small and simple.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	183 At that time,
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	184 .Pn /bin/mail
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	185 had covered anything there was to email and still had been small
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	186 and simple.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	187 Later, the essential complexity of email increased.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	188 (Essential complexity is the complexity defined by the problem itself.\0
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	189 .[[
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	190 brooks no silver bullet
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	191 .]])
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	192 Email systems reacted to this change: They grew.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	193 RFCs started to introduce the concept of mail agents to separate the
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	194 various tasks because they became more extensive and new tasks appeared.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	195 As the mail systems grew even more, parts were split off.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	196 In nmh, for instance, the POP server, which was included in the original
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	197 MH, was removed.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	198 Now is the time to go one step further and split off the MSA and MRA, too.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	199 Not only does this decrease the code size of the project,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	200 but, more important, it unburdens mmh of the whole field of
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	201 message transfer with all its implications for the project.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	202 There is no more need to concern with changes in network transfer.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	203 This independence is received by depending on an external program
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	204 that covers the field.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	205 Today, this is a reasonable exchange.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	206 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	207 .\" XXX ueberleitung ???
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	208 Functionality can be added in three different ways:
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	209 .BU
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	210 Implementing the function originally in the project.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	211 .BU
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	212 Depending on a library that provides the function.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	213 .BU
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	214 Depending on a program that provides the function.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	215 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	216 .\" XXX Rework sentence
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	217 While adding the function originally to the project increases the
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	218 code size most and requires most maintenance and development work,
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	219 it makes the project most independent of other software.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	220 Using libraries or external programs require less maintenance work
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	221 but introduces dependencies on external software.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	222 Programs have the smallest interfaces and provide the best separation
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	223 but possibly limit the information exchange.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	224 External libraries are stronger connected than external programs,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	225 thus information can be exchanged more flexible.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	226 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	227 .\" XXX ref
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	228 Implementing complex functions in the project itself adds
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	229 a lot of code.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	230 This should be avoided if possible.
66 4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	231 Hence, the dependencies only change in kind, not in their existence.
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	232 In mmh, library dependencies on
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	233 .Pn libsasl2
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	234 and
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	235 .Pn libcrypto /\c
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	236 .Pn libssl
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	237 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	238 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	239 dependencies.
66 4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	240 Besides program dependencies providing the stronger separation
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	241 and being more flexible, they also allowed
4c9f4d05d90e Rework and extension of text from yesterday. markus schnalke <meillo@marmaro.de> parents: 63 diff changeset	242 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	243 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	244 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	245 losing functionality is a convincing argument.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	246 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	247 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	248 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	249 Users of MH should not have problems to set up an external MSA and MRA.
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	250 Also, the popular MSAs and MRAs have large communities and a lot
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	251 of documentation available.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	252 Choices for MSAs range from full-featured MTAs like
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	253 .\" XXX refs
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	254 .I Postfix
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	255 over mid-size MTAs like
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	256 .I masqmail
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	257 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	258 .I dma
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	259 to small forwarders like
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	260 .I ssmtp
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	261 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	262 .I nullmailer .
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	263 Choices for MRAs include
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	264 .I fetchmail ,
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	265 .I getmail ,
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	266 .I mpop
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	267 and
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	268 .I fdm .
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	269
6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	270
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	271 .H2 "Non-MUA Tools
60 6a92e0208de0 Wrote about the removal of the mail transfer facilities. markus schnalke <meillo@marmaro.de> parents: 58 diff changeset	272 .P
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	273 One goal of mmh is to remove the tools that are not part of the MUA's task.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	274 Further more, any tools that don't improve the MUA's job significantly
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	275 should be removed.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	276 Loosely related and rarely used tools distract from the lean appearance.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	277 They require maintenance work without adding much to the core task.
125 0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/ markus schnalke <meillo@marmaro.de> parents: 124 diff changeset	278 By removing these tools, the project shall become more streamlined
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	279 and focused.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	280 In mmh the following tools are not available anymore:
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	281 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	282 .Pn conflict
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	283 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	284 .Ci 8b235097cbd11d728c07b966cf131aa7133ce5a9
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	285 because it is a mail system maintenance tool that is not MUA-related.
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	286 It even checked
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	287 .Fn /etc/passwd
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	288 and
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	289 .Fn /etc/group
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	290 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	291 A tool like
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	292 .Pn conflict
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	293 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	294 .\" XXX historic reasons?
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	295 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	296 .Pn rcvtty
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	297 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	298 .Ci 14767c94b3827be7c867196467ed7aea5f6f49b0
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	299 because its use case of writing to the user's terminal
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	300 on receival of mail is obsolete.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	301 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	302 .Ev MAILPATH
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	303 variable or graphical notifications are technically more appealing.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	304 Writing directly to terminals is hardly ever wanted today.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	305 If though one wants to have it this way, the standard tool
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	306 .Pn write
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	307 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	308 .VS
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	309 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	310 VE
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	311 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	312 .Pn viamail
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	313 .\" XXX was macht viamail
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	314 was removed
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	315 .Ci eda72d6a7a7c20ff123043fb7f19c509ea01f932
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	316 when the new attachment system was activated, because
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	317 .Pn forw
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	318 could then cover the task itself.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	319 The program
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	320 .Pn sendfiles
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	321 was rewritten as a shell script wrapper around
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	322 .Pn forw .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	323 .Ci 0e82199cf3c991a173e0ac8aa776efdb3ded61e6
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	324 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	325 .Pn msgchk
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	326 .\" XXX was macht msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	327 was removed
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	328 .Ci bb9360ead7eb7a3fedcce2eeedfc660014e41dbe ,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	329 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	330 A call to
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	331 .Pn msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	332 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	333 .VS
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	334 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	335 VE
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	336 It did distinguish between old and new mail, but
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	337 this detail information can be retrieved with
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	338 .Pn stat (1),
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	339 too.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	340 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	341 in a similar way, if truly necessary.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	342 As mmh's
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	343 .Pn inc
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	344 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	345 and thus no data transfers over slow networks are involved,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	346 there's hardly any need to check for new mail before incorporating it.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	347 .BU
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	348 .Pn msh
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	349 was removed
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	350 .Ci 916690191222433a6923a4be54b0d8f6ac01bd02
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	351 because the tool was in conflict with the philosophy of MH.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	352 It provided an interactive shell to access the features of MH,
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	353 but it wasn't just a shell tailored to the needs of mail handling.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	354 Instead it was one large program that had several MH tools built in.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	355 This conflicts with the major feature of MH of being a tool chest.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	356 .Pn msh 's
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	357 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	358 be popular.
24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	359 .P
24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	360 Removing
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	361 .Pn msh ,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	362 together with the truly archaic code relicts
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	363 .Pn vmh
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 .Pn wmh ,
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	366 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	367 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	368 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	369 for the same functionality is an advantage.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	370 Less code means less bugs and less maintenance work.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	371 As
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	372 .Pn rcvtty
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	373 and
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	374 .Pn msgchk
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	375 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	376 why should one keep them?
125 0e102cec0c73 s/stream-line/streamline/; s/motorbike/motorcycle/ markus schnalke <meillo@marmaro.de> parents: 124 diff changeset	377 Removing them streamlines mmh.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	378 .Pn viamail 's
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	379 use case is now partly obsolete and partly covered by
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	380 .Pn forw ,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	381 hence there's no reason to still maintain it.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	382 .Pn conflict
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	383 is not related to the mail client, and
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	384 .Pn msh
abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	385 conflicts with the basic concept of MH.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	386 Theses two tools might still be useful, but they should not be part of mmh.
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	387 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	388 Finally, there's
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	389 .Pn slocal .
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	390 .Pn slocal
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	391 is an MDA and thus not directly MUA-related.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	392 It should be removed from mmh, because including it conflicts with
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	393 the idea that mmh is a MUA only.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	394 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	395 should rather become a separate project.
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	396 However,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	397 .Pn slocal
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	398 provides rule-based processing of messages, like filing them into
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	399 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	400 Although
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	401 .Pn slocal
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	402 does neither pull 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	403 technical area (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	404 .Cf mail-transfer-facilities ),
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	405 still,
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	406 it accounts for about 1\\|000 lines of code that need to be maintained.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	407 As
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	408 .Pn slocal
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	409 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	410 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	411 .Pn slocal .
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	412 For anyone not using MH,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	413 .Pn slocal
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	414 would become yet another independent MDA, like
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	415 .I procmail .
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	416 Then
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	417 .Pn slocal
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	418 could be installed without the complete MH system.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	419 Likewise, mmh users could decide to use
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	420 .I procmail
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	421 without having a second, unused MDA,
7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	422 .Pn slocal ,
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	423 installed.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	424 That appears to be conceptionally the best solution.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	425 Yet,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	426 .Pn slocal
87 7d5b180de542 All kinds of rework plus new refs. markus schnalke <meillo@marmaro.de> parents: 85 diff changeset	427 is not split off.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	428 I defer the decision over
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	429 .Pn slocal
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	430 in need for deeper investigation.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	431 In the meanwhile, it remains part of mmh.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	432 However, its continued existence is not significant because
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	433 .Pn slocal
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	434 is unrelated to the rest of the project.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	435
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	436
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	437
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	438 .H2 "Displaying Messages
155 75f20c925999 Fixed macro typo; and added typo fix found by Boris. markus schnalke <meillo@marmaro.de> parents: 154 diff changeset	439 .Id mhshow
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	440 .P
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	441 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	442 .\" XXX ref!!!
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	443 .Pn show
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	444 had been MH's message display program.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	445 .Pn show
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	446 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	447 .Pn mhl
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	448 to have the files formatted.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	449 With MIME, this approach wasn't sufficient anymore.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	450 MIME messages can consist of multiple parts. Some parts are not
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	451 directly displayable and text content might be encoded in
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	452 foreign charsets.
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	453 .Pn show 's
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	454 understanding of messages and
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	455 .Pn mhl 's
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	456 display capabilities couldn't cope with the task any longer.
62 24aabbfe5794 Minor rework of larger text areas. markus schnalke <meillo@marmaro.de> parents: 60 diff changeset	457 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	458 Instead of extending these tools, additional tools were written from
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	459 scratch and added to the MH tool chest.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	460 Doing so is encouraged by the tool chest approach.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	461 Modular design is a great advantage for extending a system,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	462 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	463 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	464 .Pn mhn .
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	465 The command
82 ff4537327162 Mayor rework: Replaced .DS with .VS, a better verbatim environment. markus schnalke <meillo@marmaro.de> parents: 78 diff changeset	466 .Cl "mhn -show 42
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	467 would show the MIME message numbered 42.
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	468 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	469 the split of
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	470 .Pn mhn
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	471 into a set of specialized tools, which together covered the
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	472 multiple aspects of MIME.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	473 One of them was
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	474 .Pn mhshow ,
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	475 which replaced
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	476 .Cl "mhn -show" .
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	477 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	478 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	479 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	480 .Pn show
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	481 and
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	482 .Pn mhshow .
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	483 To ease the life of users,
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	484 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	485 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	486 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	487 if displaying the message would be beyond
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	488 .Pn show 's
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	489 abilities.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	490 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	491 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	492 (possibly through
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	493 .Pn next
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	494 or
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	495 .Pn prev )
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	496 and get the message printed with either
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	497 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	498 or
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	499 .Pn mhshow ,
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	500 whatever was more appropriate.
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	501 .P
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	502 Having two similar tools for essentially the same task is redundant.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	503 Usually,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	504 users wouldn't distinguish between
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	505 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	506 and
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	507 .Pn mhshow
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	508 in their daily mail reading.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	509 Having two separate display programs was therefore mainly unnecessary
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	510 from a user's point of view.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	511 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	512 to ensure that the programs behaved in a similar way,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	513 because they were used like a single tool.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	514 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	515 .P
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	516 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	517 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	518 As
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	519 .Pn mhshow
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	520 had already been able to display non-MIME messages, it appeared natural
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	521 to drop
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	522 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	523 in favor of using
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	524 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	525 exclusively.
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	526 .Ci 4c1efddfd499300c7e74263e57d8aa137e84c853
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	527 Removing
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	528 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	529 is no loss in function, because functionally
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	530 .Pn mhshow
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	531 covers it completely.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	532 The old behavior of
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	533 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	534 can still be emulated with the simple command line:
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	535 .VS
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	536 mhl `mhpath c`
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	537 VE
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	538 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	539 For convenience,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	540 .Pn mhshow
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	541 was renamed to
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	542 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	543 after
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	544 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	545 was gone.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	546 It is clear that such a rename may confuse future developers when
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	547 trying to understand the history.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	548 Nevertheless, I consider the convenience on the user's side,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	549 to call
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	550 .Pn show
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	551 when they want a message to be displayed, to outweigh the inconvenience
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	552 on the developer's side when understanding the project history.
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	553 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	554 To prepare for the transition,
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	555 .Pn mhshow
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	556 was reworked to behave more like
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	557 .Pn show
f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	558 first.
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	559 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	560 .Cf mhshow )
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	561 .\" XXX code commits?
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	562 Once the tools behaved more alike, the replacing appeared to be
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	563 even more natural.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	564 Today, mmh's new
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	565 .Pn show
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	566 has become the one single message display program once more,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	567 with the difference
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	568 that today it handles MIME messages as well as non-MIME messages.
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	569 The outcome of the transition is one program less to maintain,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	570 no second display program for users to deal with,
30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	571 and less system complexity.
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	572 .P
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	573 Still, removing the old
69 f80ced4e749b Wrote more about the show-mhshow merge. markus schnalke <meillo@marmaro.de> parents: 66 diff changeset	574 .Pn show
88 30830e3b9e98 Further rework. markus schnalke <meillo@marmaro.de> parents: 87 diff changeset	575 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	576 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	577 .Pn show ,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	578 .\" XXX
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	579 however there is no alternative;
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	580 supporting MIME demands higher essential complexity.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	581
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	582 .ig
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	583 XXX
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	584 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	585
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	586 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	587 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	588 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	589 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	590 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	591 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	592 .Ci 70b2643e0da8485174480c644ad9785c84f5bff4
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	593 ..
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	594
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	595
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	596
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	597
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	598 .H2 "Configure Options
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	599 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	600 Customization is a double-edged sword.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	601 It allows better suiting setups, but not for free.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	602 There is the cost of code complexity to be able to customize.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	603 There is the cost of less tested setups, because there are
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	604 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	605 Additionally, there is the cost of choice itself.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	606 The code complexity directly affects the developers.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	607 Less tested code affects both, users and developers.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	608 The problem of choice affects the users, for once by having to choose,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	609 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	610 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	611 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	612 I have reduced the number of project-specific configure options from
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	613 fifteen to three.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	614
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	615 .U3 "Mail Transfer Facilities
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	616 .P
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	617 With the removal of the mail transfer facilities five configure
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	618 options vanished:
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	619 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	620 The switches
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	621 .Sw --with-tls
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	622 and
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	623 .Sw --with-cyrus-sasl
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	624 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	625 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	626 .\" XXX gruende kurz wiederholen
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	627 This is not needed anymore.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	628 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	629 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	630 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	631 .\" XXX cf
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	632 .\" XXX ``For the same reason ...''
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	633 The configure switch
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	634 .Sw --enable-pop
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	635 activated the message retrieval facility.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	636 The code area that would be conditionally compiled in for TLS and SASL
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	637 support had been small.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	638 The conditionally compiled code area for POP support had been much larger.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	639 Whereas the code base changes would only slightly change on toggling
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	640 TLS or SASL support, it changed much on toggling POP support.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	641 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	642 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	643 one that needed to be tested.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	644 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	645 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	646 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	647 of the original program.
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	648 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	649 .P
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	650 Two other options only specified default configuration values:
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	651 .Sw --with-mts
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	652 defined the default transport service.
85 fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	653 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226
fb0d1b4c8fb1 Extended the text about mail transfer configure options. markus schnalke <meillo@marmaro.de> parents: 84 diff changeset	654 With
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	655 .Sw --with-smtpservers
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	656 default SMTP servers could be specified.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	657 .Ci 128545e06224233b7e91fc4c83f8830252fe16c9
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	658 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	659 .\" XXX code ref
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	660 In mmh, all messages are handed over to
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	661 .Pn sendmail
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	662 for transportation.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	663
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	664
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	665 .U3 "Backup Prefix
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	666 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	667 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	668 filenames to tag them as deleted.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	669 By default it had been the comma character `\f(CW,\fP'.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	670 .\" XXX Zeitlich ordnen
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	671 In July 2000, Kimmo Suominen introduced
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	672 the configure option
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	673 .Sw --with-hash-backup
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	674 to change the default to the hash symbol `\f(CW#\fP'.
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	675 The choice was probably personal preference, because first, the
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	676 option was named
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	677 .Sw --with-backup-prefix.
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	678 and had the prefix symbol as argument.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	679 But giving the hash symbol as argument caused too many problems
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	680 for Autoconf,
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	681 thus the option was limited to use the hash symbol as the default prefix.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	682 This supports the assumption, that the choice for the hash was
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	683 personal preference only.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	684 Being related or not, words that start with the hash symbol
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	685 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	686 Thus, the command line
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	687 .Cl "rm #13 #15
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	688 calls
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	689 .Pn rm
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	690 without arguments because the first hash symbol starts the comment
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	691 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	692 To delete the backup files,
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	693 .Cl "rm ./#13 ./#15"
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	694 needs to be used.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	695 Using the hash as backup prefix can be seen as a precaution against
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	696 data loss.
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	697 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	698 First, I removed the configure option but added the profile entry
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	699 .Pe backup-prefix ,
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	700 which allows to specify an arbitrary string as backup prefix.
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	701 .Ci 6c40d481d661d532dd527eaf34cebb6d3f8ed086
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	702 Profile entries are the common method to change mmh's behavior.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	703 This change did not remove the choice but moved it to a location where
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	704 it suited better.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	705 .P
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	706 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	707 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	708 .Cf trash-folder )
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	709 removed the need for the backup prefix completely.
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	710 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	711 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	712
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	713
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	714 .U3 "Editor and Pager
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	715 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	716 The two configure options
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	717 .CW --with-editor=EDITOR
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	718 .CW --with-pager=PAGER
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	719 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	720 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	721 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	722 different systems.
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	723 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	724 The programs
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	725 .Pn vi
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	726 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	727 .Pn more
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	728 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	729 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	730 (The specifications for
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	731 .Pn vi
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	732 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	733 .Pn more
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	734 appeared in
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	735 .[
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	736 posix 1987
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	737 .]
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	738 and,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	739 .[
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	740 posix 1992
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	741 .]
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	742 respectively.)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	743 As a first step, these two tools were hard-coded as defaults.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	744 .Ci 5d43a99db70c12a673028c7758c20cbe3e13ef5f
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	745 Not changed were the
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	746 .Pe editor
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	747 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	748 .Pe moreproc
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	749 profile entries, which allowed the user to override the system defaults.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	750 Later, the concept was reworked to respect the standard environment
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	751 variables
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	752 .Ev VISUAL
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	753 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	754 .Ev PAGER
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	755 if they are set.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	756 Today, mmh determines the editor to use in the following order,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	757 taking the first available and non-empty item:
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	758 .IP (1)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	759 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	760 .Ev MMHEDITOR
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	761 .IP (2)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	762 Profile entry
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	763 .Pe Editor
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	764 .IP (3)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	765 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	766 .Ev VISUAL
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	767 .IP (4)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	768 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	769 .Ev EDITOR
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	770 .IP (5)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	771 Command
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	772 .Pn vi .
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	773 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	774 .Ci f85f4b7ae62e3d05a945dcd46ead51f0a2a89a9b
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	775 .P
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	776 The pager to use is determined in a similar order,
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	777 also taking the first available and non-empty item:
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	778 .IP (1)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	779 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	780 .Ev MMHPAGER
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	781 .IP (2)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	782 Profile entry
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	783 .Pe Pager
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	784 (replaces
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	785 .Pe moreproc )
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	786 .IP (3)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	787 Environment variable
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	788 .Ev PAGER
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	789 .IP (4)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	790 Command
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	791 .Pn more .
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	792 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	793 .Ci 0c4214ea2aec6497d0d67b436bbee9bc1d225f1e
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	794 .P
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	795 By respecting the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	796 .Ev VISUAL /\c
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	797 .Ev EDITOR
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	798 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	799 .Ev PAGER
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	800 environment variables,
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	801 the new behavior confirms better to the common style on Unix systems.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	802 Additionally, the new approach is more uniform and clearer to users.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	803
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	804
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	805 .U3 "ndbm
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	806 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	807 .Pn slocal
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	808 used to depend on
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	809 .I ndbm ,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	810 a database library.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	811 The database is used to store the `\fLMessage-ID\fP's of all
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	812 messages delivered.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	813 This enables
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	814 .Pn slocal
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	815 to suppress delivering the same message to the same user twice.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	816 (This features was enabled by the
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	817 .Sw -suppressdup
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	818 switch.)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	819 .P
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	820 A variety of versions of the database library exist.
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	821 .[
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	822 wolter unix incompat notes dbm
64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	823 .]
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	824 Complicated autoconf code was needed to detect them correctly.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	825 Further more, the configure switches
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	826 .Sw --with-ndbm=ARG
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	827 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	828 .Sw --with-ndbmheader=ARG
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	829 were added to help with difficult setups that would
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	830 not be detected automatically or correctly.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	831 .P
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	832 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	833 .Pn slocal ,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	834 the dependency on
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	835 .I ndbm
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	836 vanished and 120 lines of complex autoconf code could be saved.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	837 .Ci ecd6d6a20cb7a1507e3a20d6c4cb3a1cf14c6bbf
89 83bfb4dbf59f Spellchecked. markus schnalke <meillo@marmaro.de> parents: 88 diff changeset	838 The change removed functionality too, but that is minor to the
78 64f177ca2af1 Text rework. markus schnalke <meillo@marmaro.de> parents: 76 diff changeset	839 improvement by dropping the dependency and the complex autoconf code.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	840 .\" 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	841
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	842 .U3 "mh-e Support
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	843 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	844 The configure option
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	845 .Sw --disable-mhe
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	846 was removed when the mh-e support was reworked.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	847 Mh-e is the Emacs front-end to MH.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	848 It requires MH to provide minor additional functions.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	849 The
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	850 .Sw --disable-mhe
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	851 configure option could switch these extensions off.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	852 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	853 only the
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	854 .Sw -build
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	855 switches of
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	856 .Pn forw
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	857 and
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	858 .Pn repl
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	859 are left to be mh-e extensions.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	860 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	861 In consequence, the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	862 .Sw --disable-mhe
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	863 configure option was removed
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	864 .Ci a7ce7b4a580d77b6c2c4d980812beb589aa4c643
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	865 Removing the option removed a second code setup that would have
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	866 needed to be tested.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	867 .\" XXX datum?
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	868 This change was first done in nmh and thereafter merged into mmh.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	869 .P
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	870 The interface changes in mmh require mh-e to be adjusted in order
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	871 to be able to use mmh as back-end.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	872 This will require minor changes to mh-e, but removing the
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	873 .Sw -build
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	874 switches would require more rework.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	875
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	876 .U3 "Masquerading
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	877 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	878 The configure option
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	879 .Sw --enable-masquerade
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	880 could take up to three arguments:
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	881 `draft_from', `mmailid', and `username_extension'.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	882 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	883 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	884 .Pn post
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	885 command, which provided an MSA.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	886 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	887 this field anymore.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	888 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	889 .P
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	890 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	891 .I mmailid
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	892 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	893 available in the original MH.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	894 It provided a
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	895 .I username
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	896 to
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	897 .I fakeusername
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	898 mapping, based on the password file's GECOS field.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	899 The man page
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	900 .Mp mh-tailor(5)
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	901 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	902 .QS
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	903 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	904 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	905 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	906 `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	907 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	908 ``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	909 .QE
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	910 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	911 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	912 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	913 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	914 does the reverse mapping for incoming mail (aliasing), too.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	915 Further more, masquerading set up there is readily available for all
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	916 mail software on the system.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	917 Hence, mmailid masquerading was removed.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	918 .Ci 0836c8000ccb34b59410ef1c15b1b7feac70ce5f
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	919 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	920 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	921 .I username_extension
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	922 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	923 specified by the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	924 .Ev USERNAME_EXTENSION
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	925 environment variable, to it.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	926 This provided support for the
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	927 .I user-extension
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	928 feature of qmail and the similar
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	929 .I "plussed user
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	930 processing of sendmail.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	931 The decision to remove this username_extension masquerading was
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	932 motivated by the fact that
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	933 .Pn spost
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	934 hadn't supported it already.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	935 .Ci 2abae0bfd0ad5bf898461e50aa4b466d641f23d9
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	936 Username extensions are possible in mmh, but less convenient to use.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	937 .\" XXX covered by next paragraph
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	938 .\" XXX format file %(getenv USERNAME_EXTENSION)
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	939 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	940 The
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	941 .I draft_from
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	942 masquerading type instructed
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	943 .Pn post
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	944 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	945 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	946 header field as SMTP envelope sender.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	947 Sender addresses could be replaced completely.
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	948 .Ci b14ea6073f77b4359aaf3fddd0e105989db9
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	949 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	950 with technical differences.
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	951 As mmh does not transfer messages itself, the local MTA has final control
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	952 over the sender's address. Any masquerading mmh introduces may be reverted
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	953 by the MTA.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	954 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	955 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	956 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	957 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	958 header field and thereby propose
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	959 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	960 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	961 address for use as envelope sender address.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	962 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	963 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	964 message header (\c
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	965 .Pn sendmail 's
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	966 .Sw -t
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	967 switch).
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	968 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	969 .Hd From
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	970 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	971 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	972
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	973 .U3 "Remaining Options
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	974 .P
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	975 Two configure options remain in mmh.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	976 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	977 .Sw --with-locking=[dot\|fcntl\|flock\|lockf] .
76 2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	978 The idea of removing all methods except the portable dot locking
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	979 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	980 requires deeper technical investigation into the topic.
2e61e0004a8f Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 74 diff changeset	981 The other option,
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	982 .Sw --enable-debug ,
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	983 compiles the programs with debugging symbols and does not strip them.
cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	984 This option is likely to stay.
72 bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	985
bae9273b5802 Wrote about configure options (not finished yet). markus schnalke <meillo@marmaro.de> parents: 69 diff changeset	986
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	987
63 abbaca05ee8e More text. markus schnalke <meillo@marmaro.de> parents: 62 diff changeset	988
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	989 .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	990 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	991 The command line switches of MH tools follow the X Window style.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	992 They are words, introduced by a single dash.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	993 For example:
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	994 .Cl "-truncate" .
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	995 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	996 .Sw -help ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	997 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	998 .Sw -Version
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	999 (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	1000 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1001 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	1002 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	1003 In most cases, doing something in exactly one way is too limiting.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1004 If there is basically one task to accomplish, but it should be done
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1005 in various ways, switches are a good approach to alter the behavior
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1006 of a program.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1007 Changing the behavior of programs provides flexibility and customization
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1008 to users, but at the same time it complicates the code, documentation and
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1009 usage of the program.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1010 .\" XXX: Ref
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1011 Therefore, the number of switches should be kept small.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1012 A small set of well-chosen switches does no harm.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1013 But usually, the number of switches increases over time.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1014 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	1015 problem of MH:
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1016 .[ [
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1017 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1018 .], p. 12]
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1019 .QS
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1020 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	1021 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	1022 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	1023 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	1024 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	1025 .QP
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1026 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	1027 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	1028 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	1029 .QE
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1030 .P
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1031 Being reluctant to adding new switches \(en or `options',
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1032 as Rose and Romine call them \(en is one part of a counter-action,
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1033 the other part is removing hardly used switches.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1034 Nmh's tools had lots of switches already implemented,
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1035 hence, cleaning up by removing some of them was the more important part
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1036 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	1037 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	1038 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	1039 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	1040 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	1041 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	1042 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	1043 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	1044 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	1045 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	1046 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	1047 ``[...]
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1048 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1049 will no doubt acquire an endless number of switches in the years to come.''
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1050 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	1051 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	1052 but this is not practical.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1053 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	1054 them strictly.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1055 Nevertheless, removing obsolete switches still is an effective approach
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1056 to deal with the problem.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1057 Working on an experimental branch without an established user base,
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1058 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	1059 functions.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1060 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1061 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	1062 .Pn send .
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1063 In nmh, they increased up to 32 visible and 12 hidden ones.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1064 At the time of writing, no more than 7 visible switches and 1 hidden switch
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1065 have remained in mmh's
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1066 .Pn send .
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1067 (These numbers include two generic switches, help and version.)
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1068 .P
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1069 The figure displays the number of switches for each of the tools
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1070 that is available in both nmh and mmh.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1071 The tools are sorted by the number of switches they had in nmh.
6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1072 Visible and hidden switches were counted,
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1073 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	1074 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	1075 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	1076 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	1077 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	1078 has 4 now.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1079 The total number of functional switches in mmh dropped from 465
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1080 to 234.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1081
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1082 .KS
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1083 .in 1c
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1084 .so input/switches.grap
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1085 .KE
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1086
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1087 .P
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1088 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	1089 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	1090 Sometimes, however, the work flow was the other way:
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1091 I looked through the
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1092 .Mp mh-chart (7)
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1093 man page to identify the tools with apparently too many switches.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1094 Then considering the value of each of the switches by examining
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1095 the tool's man page and source code, aided by recherche and testing.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1096 This way, the removal of functions was suggested by the aim to reduce
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1097 the number of switches per command.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1098
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1099
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1100 .U3 "Draft Folder Facility
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1101 .P
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1102 A change early in the project was the complete transition from
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1103 the single draft message to the draft folder facility.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1104 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1105 .\" XXX ref to section ...
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1106 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	1107 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	1108 .[
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1109 rose romine real work
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1110 .]
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1111 Since then, the facility had existed but was inactive by default.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1112 The default activation and the related rework of the tools made it
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1113 possible to remove the
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1114 .Sw -[no]draftfolder ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1115 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1116 .Sw -draftmessage
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1117 switches from
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1118 .Pn comp ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1119 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1120 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1121 .Pn dist ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1122 .Pn whatnow ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1123 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1124 .Pn send .
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1125 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1126 The only flexibility removed with this change is having multiple
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1127 draft folders within one profile.
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1128 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	1129 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	1130 .Sw -draft
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1131 switch of
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1132 .Pn anno ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1133 .Pn refile ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1134 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1135 .Pn send
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1136 was removed.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1137 The special treatment of \fIthe\fP draft message became irrelevant after
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1138 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	1139 (cf. Sec.
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1140 .Cf draft-folder )
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1141 Furthermore,
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1142 .Pn comp
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1143 no longer needs a
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1144 .Sw -file
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1145 switch as the draft folder facility together with the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1146 .Sw -form
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1147 switch are sufficient.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1148
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1149
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1150 .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	1151 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1152 .Pn anno
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1153 had the switches
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1154 .Sw -[no]inplace
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1155 to either annotate the message in place and thus preserve hard links,
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1156 or annotate a copy to replace the original message, breaking hard links.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1157 Following the assumption that linked messages should truly be the
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1158 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	1159 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1160 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	1161 .Sw -inplace
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1162 was made the only behavior.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1163 .Ci c8195849d2e366c569271abb0f5f60f4ebf0b4d0
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1164 The
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1165 .Sw -[no]inplace
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1166 switches of
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1167 .Pn repl ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1168 .Pn forw ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1169 and
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1170 .Pn dist
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1171 could be removed, too, as they were simply passed through to
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1172 .Pn anno .
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1173 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1174 .Pn burst
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1175 also had
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1176 .Sw -[no]inplace
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1177 switches, but with different meaning.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1178 With
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1179 .Sw -inplace ,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1180 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	1181 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	1182 after this message, renumbering all following messages.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1183 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	1184 in practice, it usually consists of an end-of-digest marker only.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1185 Nontheless, this behavior appeared less elegant than the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1186 .Sw -noinplace
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1187 behavior, which already had been the default.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1188 Nmh's
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1189 .Mp burst (1)
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1190 man page reads:
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1191 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1192 If
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1193 .Sw -noinplace
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1194 is given, each digest is preserved, no table
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1195 of contents is produced, and the messages contained within
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1196 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	1197 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	1198 .QE
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1199 .LP
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1200 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	1201 .Sw -inplace
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1202 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	1203 it caused.
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1204 .Sw -noinplace
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1205 was chosen to be the definitive behavior.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1206 .Ci 68a686adeb39223a5e1ad35e4a24890ec053679d
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1207
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1208
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1209 .U3 "Forms and Format Strings
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1210 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1211 Historically, the tools that had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1212 .Sw -form
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1213 switches to supply a form file had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1214 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1215 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	1216 on the command line directly.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1217 In consequence, the following two lines equaled:
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1218 .VS
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1219 scan -form scan.mailx
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1220 scan -format "`cat .../scan.mailx`"
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1221 VE
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1222 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1223 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1224 switches were dropped in favor for extending the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1225 .Sw -form
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1226 switches.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1227 .Ci f51956be123db66b00138f80464d06f030dbb88d
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1228 If their argument starts with an equal sign (`='),
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1229 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	1230 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	1231 Thus, now the following two lines equal:
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1232 .VS
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1233 scan -form scan.mailx
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1234 scan -form "=`cat .../scan.mailx`"
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1235 VE
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1236 This rework removed the prefix collision between
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1237 .Sw -form
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1238 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1239 .Sw -format .
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1240 Now, typing
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1241 .Sw -fo
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1242 suffices to specify form or format string.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1243 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1244 The different meaning of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1245 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1246 for
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1247 .Pn repl
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1248 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1249 .Pn forw
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1250 was removed in mmh.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1251 .Pn forw
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1252 was completely switched to MIME-type forwarding, thus removing the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1253 .Sw -[no]format .
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1254 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1255 For
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1256 .Pn repl ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1257 the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1258 .Sw -[no]format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1259 switches were reworked to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1260 .Sw -[no]filter
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1261 switches.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1262 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1263 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1264 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1265 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1266 .Pn send
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1267 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1268 .Pn post ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1269 which had a third meaning,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1270 were removed likewise.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1271 .Ci f3cb7cde0e6f10451b6848678d95860d512224b9
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1272 Eventually, the ambiguity of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1273 .Sw -format
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1274 switches was resolved by not anymore having any such switch in mmh.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1275
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1276
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1277 .U3 "MIME Tools
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1278 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1279 The MIME tools, which were once part of
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1280 .Pn mhn
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1281 .\" XXX
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1282 (whatever that stood for),
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1283 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	1284 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1285 .Sw -[no]realsize
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1286 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1287 .Pn mhbuild
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1288 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1289 .Pn mhlist
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1290 were removed, doing real size calculations always now
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1291 .Ci 8d8f1c3abc586c005c904e52c4adbfe694d2201c ,
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1292 as nmh's
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1293 .Mp mhbuild (1)
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1294 man page states
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1295 ``This provides an accurate count at the expense of a small delay.''
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1296 This small delay is not noticable on modern systems.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1297 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1298 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1299 .Sw -[no]check
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1300 switches were removed together with the support for
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1301 .Hd Content-MD5
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1302 header fields.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1303 .[
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1304 rfc 1864
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1305 .]
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1306 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1307 (cf. Sec.
63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1308 .Cf content-md5 )
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1309 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1310 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1311 .Sw -[no]ebcdicsafe
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1312 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1313 .Sw -[no]rfc934mode
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1314 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1315 .Pn mhbuild
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1316 were removed because they are considered obsolete.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1317 .Ci 01a3480928da485b4d6109d36d751dfa71799d58
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1318 .Ci 3363e2624dce0eb8164cf8b3f1ab385c8ff72e88
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1319 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1320 Content caching of external MIME parts, activated with the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1321 .Sw -rcache
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1322 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1323 .Sw -wcache
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1324 switches was completely removed.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1325 .Ci d1fefd9f614e4dc3cda16da6c69133c1b2005269
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1326 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	1327 for them appears to be unnecessary.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1328 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1329 In pre-MIME times,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1330 .Pn mhl
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1331 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	1332 Therefore,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1333 .Pn mhl
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1334 could be simplified to a large extend, reducing the number of its
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1335 switches from 21 to 6.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1336 .Ci 350ad6d3542a07639213cf2a4fe524e829c1e7b6
29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1337 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1338
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1339
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1340
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1341
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1342 .U3 "Header Printing
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1343 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1344 .Pn folder 's
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1345 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	1346 displaying the header line makes little sense.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1347 Hence, the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1348 .Sw -[no]header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1349 switch was removed and headers are never printed.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1350 .Ci 601cc73d1fa05ce96faa728f036d6c51b91701c7
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1351 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1352 In
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1353 .Pn mhlist ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1354 the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1355 .Sw -[no]header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1356 switches were removed, too.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1357 .Ci b24f96523aaf60e44e04a3ffb1d22e69a13a602f
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1358 But in this case headers are always printed,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1359 because the output is not self-explaining.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1360 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1361 .Pn scan
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1362 also had
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1363 .Sw -[no]header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1364 switches.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1365 Printing the header had been sensible until the introduction of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1366 format strings made it impossible to display the column headings.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1367 Only the folder name and the current date remained to be printed.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1368 As this information can be perfectly retrieved by
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1369 .Pn folder
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1370 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1371 .Pn date ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1372 consequently, the switches were removed.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1373 .Ci c477dc5d1d03fa6d9a8ab3dd3508c63cbddc044e
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1374 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1375 By removing all
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1376 .Sw -header
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1377 switches, the collision with
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1378 .Sw -help
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1379 on the first two letters was resolved.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1380 Currently,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1381 .Sw -h
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1382 evaluates to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1383 .Sw -help
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1384 for all tools of mmh.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1385
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1386
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1387 .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	1388 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1389 The
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1390 .Sw -noedit
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1391 switch of
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1392 .Pn comp ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1393 .Pn repl ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1394 .Pn forw ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1395 .Pn dist ,
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1396 and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1397 .Pn whatnow
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1398 was removed, but it can now be replaced by specifying
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1399 .Sw -editor
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1400 with an empty argument.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1401 .Ci 75fca31a5b9d5c1a99c74ab14c94438d8852fba9
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1402 (Specifying
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1403 .Cl "-editor /bin/true
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1404 is nearly the same, only differing by the previous editor being set.)
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1405 .P
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1406 The more important change is the removal of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1407 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1408 switch.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1409 .Ci ee4f43cf2ef0084ec698e4e87159a94c01940622
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1410 This switch had introduced an awkward behavior, as explained in nmh's
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1411 man page for
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1412 .Mp comp (1):
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1413 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1414 The
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1415 .Sw -editor
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1416 .Ar editor
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1417 switch indicates the editor to use for
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1418 the initial edit. Upon exiting from the editor,
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1419 .Pn comp
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1420 will invoke the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1421 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1422 program. See
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1423 .Mp whatnow (1)
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1424 for a discussion of available options.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1425 The invocation of this program can be
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1426 inhibited by using the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1427 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1428 switch. (In truth of fact, it is the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1429 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1430 program which starts the initial edit.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1431 Hence,
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1432 .Sw -nowhatnowproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1433 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	1434 .QE
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1435 .P
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1436 Effectively, the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1437 .Sw -nowhatnowproc
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1438 switch creates only a draft message.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1439 As
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1440 .Cl "-whatnowproc /bin/true
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1441 causes the same behavior, the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1442 .Sw -nowhatnowproc
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1443 switch was removed for being redundant.
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1444 Likely, the
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1445 .Sw -nowhatnowproc
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1446 switch was intended to be used by front-ends.
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1447
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1448
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1449
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1450 .U3 "Various
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1451 .BU
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1452 With the removal of MMDF maildrop format support,
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1453 .Pn packf
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1454 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1455 .Pn rcvpack
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1456 no longer needed their
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1457 .Sw -mbox
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1458 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1459 .Sw -mmdf
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1460 switches.
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1461 .Sw -mbox
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1462 is the sole behavior now.
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1463 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1464 In the same go,
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1465 .Pn packf
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1466 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1467 .Pn rcvpack
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1468 were reworked and their
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1469 .Sw -file
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1470 switch became unnecessary.
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1471 .Ci ca1023716d4c2ab890696f3e41fa0d94267a940e
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1472
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1473 .BU
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1474 Mmh's tools will no longer clear the screen (\c
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1475 .Pn scan 's
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1476 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1477 .Pn mhl 's
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1478 .Sw -[no]clear
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1479 switches
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1480 .Ci e57b17343dcb3ff373ef4dd089fbe778f0c7c270
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1481 .Ci 943765e7ac5693ae177fd8d2b5a2440e53ce816e ).
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1482 Neither will
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1483 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1484 ring the bell (\c
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1485 .Sw -[no]bell
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1486 .Ci e11983f44e59d8de236affa5b0d0d3067c192e24 )
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1487 nor page the output itself (\c
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1488 .Sw -length
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1489 .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ).
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1490 .\" XXX Ref
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1491 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	1492 .Sw -[no]moreproc
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1493 command line switches for
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1494 .Pn mhl
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1495 and
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1496 .Pn show /\c
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1497 .Pn mhshow .
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1498 .Ci 39e87a75b5c2d3572ec72e717720b44af291e88a
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1499
b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1500 .BU
96 12348d620245 Spell checking. markus schnalke <meillo@marmaro.de> parents: 95 diff changeset	1501 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	1502 .Sw -version
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1503 switch was renamed to
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1504 .Sw -Version
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1505 (with capital `V').
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1506 .Ci 32b2354dbaf4bf934936eb5b102a4a3d2fdd209a
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1507 Every program has the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1508 .Sw -version
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1509 switch but its first three letters collided with the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1510 .Sw -verbose
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1511 switch, present in many programs.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1512 The rename solved this problem once for all.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1513 Although this rename breaks a basic interface, having the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1514 .Sw -V
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1515 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	1516
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1517 .BU
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1518 .Sw -[no]preserve
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1519 of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1520 .Pn refile
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1521 was removed because what use was it anyway?
98 d894191d7a33 style: Changed the block quote approach. New QS and QE. markus schnalke <meillo@marmaro.de> parents: 97 diff changeset	1522 .QS
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1523 Normally when a message is refiled, for each destination
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1524 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	1525 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	1526 .Sw -preserv
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1527 [sic!] switch will override this message renaming, and try
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1528 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	1529 particular folder occurs when using the
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1530 .Sw -preserve
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1531 switch, then
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1532 .Pn refile
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1533 will use the next available message number which
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1534 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	1535 .QE
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1536
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1537 .BU
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1538 The removal of the
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1539 .Sw -[no]reverse
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1540 switches of
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1541 .Pn scan
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1542 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1543 is a bug fix, supported by the comments
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1544 ``\-[no]reverse under #ifdef BERK (I really HATE this)''
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1545 by Rose and
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1546 ``Lists messages in reverse order with the `\-reverse' switch.
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1547 This should be considered a bug.'' by Romine in the documentation.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1548 .\" XXX Ref: welche datei genau.
97 29a7454fcded Added references to commits. markus schnalke <meillo@marmaro.de> parents: 96 diff changeset	1549 The question remains why neither Rose and Romine had fixed this
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1550 bug in the eighties when they wrote these comments nor has anyone
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1551 thereafter.
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1552
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1553
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1554 .ig
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1555
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1556 forw: [no]dashstuffing(mhl)
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1557
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1558 mhshow: [no]pause [no]serialonly
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1559
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1560 mhmail: resent queued
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1561 inc: snoop, (pop)
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1562
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1563 mhl: [no]faceproc folder sleep
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1564 [no]dashstuffing(forw) digest list volume number issue number
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1565
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1566 prompter: [no]doteof
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1567
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1568 refile: [no]preserve [no]unlink [no]rmmproc
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1569
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1570 send: [no]forward [no]mime [no]msgid
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1571 [no]push split [no]unique (sasl) width snoop [no]dashstuffing
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1572 attach attachformat
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1573 whatnow: (noedit) attach
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1574
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1575 slocal: [no]suppressdups
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1576
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1577 spost: [no]filter [no]backup width [no]push idanno
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1578 [no]check(whom) whom(whom)
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1579
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1580 whom: ???
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1581
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1582 ..
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1583
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1584
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1585 .ig
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1586
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1587 .P
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1588 In the best case, all switches are unambiguous on the first character,
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1589 or on the three-letter prefix for the `no' variants.
96 12348d620245 Spell checking. markus schnalke <meillo@marmaro.de> parents: 95 diff changeset	1590 Reducing switch prefix collisions, shortens the necessary prefix length
93 093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1591 the user must type.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1592 Having less switches helps best.
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1593
093ccf39a45e Write text about removal of switches; Included the grap figure. markus schnalke <meillo@marmaro.de> parents: 89 diff changeset	1594 ..
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1595
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1596
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1597 .\" XXX: whatnow prompt commands
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1598
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1599
95 edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1600
edac7e46a9f2 More text about switches. markus schnalke <meillo@marmaro.de> parents: 93 diff changeset	1601
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	1602 .\" --------------------------------------------------------------
74 cefaa856d431 A lot of new text about configure switches. markus schnalke <meillo@marmaro.de> parents: 72 diff changeset	1603 .H1 "Modernizing
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1604 .P
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1605 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	1606 increasingly extended.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	1607 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	1608 existing behavior.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	1609 Relicts from several decades have gathered in the code base,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	1610 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	1611 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	1612 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	1613 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	1614 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	1615 .Cf code-style .
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1616
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1617
100 6ae7dc4a3a02 Included changes proposed by Lydi. markus schnalke <meillo@marmaro.de> parents: 98 diff changeset	1618 .H2 "Code Relicts
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1619 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1620 My position regarding the removal of obsolete functions of mmh,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1621 .\" XXX ``in order to remove old code,''
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1622 is much more revolutional than the nmh community appreciates.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1623 Working on an experimental version, I was quickly able to drop
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1624 functionality I considered ancient.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1625 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	1626 Without the need to justify my decisions, I was able to rush forward.
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1627 In December 2011, Paul Vixie motivated the nmh developers to just
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1628 .\" XXX ugs
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1629 do the work:
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1630 .[
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1631 paul vixie edginess nmh-workers
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1632 .]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1633 .QS
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1634 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	1635 discuss whether to keep using vfork, just note in [sic!] passing, [...]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1636 we don't need a separate branch for removing vmh
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1637 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	1638 or depending on pure ansi/posix ``libc''.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1639 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	1640 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	1641 should just be modern. [...]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1642 let's push forward, aggressively.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1643 .QE
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1644 .LP
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1645 I did so already in the months before.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1646 I pushed forward.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1647 .\" XXX semicolon ?
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1648 I simply dropped the cruft.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1649 .P
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1650 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	1651 careful thinking, but whether having had contact with this particular
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1652 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	1653 I explained my reasons in the commit messages
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1654 in the version control system.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1655 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	1656 if I have missed an important aspect.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1657 I was quick in dropping parts.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1658 I rather re-included falsely dropped parts than going at a slower pace.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1659 Mmh is experimental work; it required tough decisions.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1660 .\" 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	1661
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1662
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1663 .U3 "Forking
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	1664 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1665 Being a tool chest, MH creates many processes.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1666 In earlier times
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1667 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1668 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	1669 to be completely duplicated at once.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1670 This expensive work was especially unnecessary in the commonly occuring
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1671 case wherein the image is replaced by a call to
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1672 .Fu exec()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1673 right after having forked the child process.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1674 The
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1675 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1676 system call was invented to speed up this particular case.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1677 It completely omits the duplication of the image.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1678 On old systems this resulted in significant speed ups.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1679 Therefore MH used
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1680 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1681 whenever possible.
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1682 .P
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1683 Modern memory management units support copy-on-write semantics, which make
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1684 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1685 almost as fast as
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1686 .Fu vfork() .
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1687 The man page of
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1688 .Mp vfork (2)
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1689 in FreeBSD 8.0 states:
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1690 .QS
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1691 This system call will be eliminated when proper system sharing mechanisms
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1692 are implemented. Users should not depend on the memory sharing semantics
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1693 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	1694 .QE
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1695 .LP
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1696 Vixie supports the removal with the note that ``the last
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1697 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	1698 Eunice. that was 1987''.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1699 .[
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1700 nmh-workers vixie edginess
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1701 .]
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1702 I replaced all calls to
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1703 .Fu vfork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1704 with calls to
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1705 .Fu fork() .
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1706 .Ci 40821f5c1316e9205a08375e7075909cc9968e7d
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1707 .P
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1708 Related to the costs of
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1709 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1710 is the probability of its success.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1711 In the eighties, on heavy loaded systems, calls to
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1712 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1713 were prone to failure.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1714 Hence, many of the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1715 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1716 calls in the code were wrapped into loops to retry the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1717 .Fu fork()
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1718 several times, to increase the chances to succeed, eventually.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1719 On modern systems, a failing
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1720 .Fu fork()
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1721 call is unusual.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1722 Hence, in the rare case when
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1723 .Fu fork()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1724 fails, mmh programs simply abort.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1725 .Ci 5fbf37ee68e018998ada61eeab73e035b26834b6
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1726
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1727
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1728 .U3 "Header Fields
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1729 .BU
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1730 The
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1731 .Hd Encrypted
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1732 header field was introduced by RFC\\|822,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1733 but already marked as legacy in RFC\\|2822.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1734 Today, OpenPGP provides the basis for standardized exchange of encrypted
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1735 messages [RFC\\|4880, RFC\\|3156].
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1736 Hence, the support for
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1737 .Hd Encrypted
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1738 header fields is removed in mmh.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1739 .Ci 064527f7b57ab050e5af13e15ad99aeeab125857
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1740 .BU
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1741 The native support for
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1742 .Hd Face
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1743 header fields has been removed, as well.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1744 .Ci 8e5be81f784682822f5e868c1bf3c8624682bd23
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1745 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	1746 .Hd X-Face
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1747 header field in its intent,
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1748 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	1749 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	1750 it contains the hostname and UDP port where the image
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1751 date can be retrieved.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1752 There is even a third Face system,
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1753 which is the successor of
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1754 .Hd X-Face ,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1755 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	1756 .Hd Face
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1757 header field.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1758 It was invented in 2005 and supports colored PNG images.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1759 None of the Face systems described here is popular today.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1760 Hence, mmh has no direct support for them.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1761 .BU
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	1762 .Id content-md5
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1763 The
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1764 .Hd Content-MD5
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1765 header field was introduced by RFC\\|1864.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1766 It provides detection of data corruption during the transfer.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1767 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	1768 [RFC\\|1864].
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1769 The proper approach to verify content integrity in an
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1770 end-to-end relationship is the use of digital cryptography.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1771 .\" XXX (RFCs FIXME).
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1772 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	1773 the transmission.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1774 The TCP includes a checksum field therefore.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1775 These two approaches in combinations render the
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1776 .Hd Content-MD5
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1777 header field superfluous.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1778 Not a single one out of 4\\|200 messages from two decades
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1779 in an nmh-workers mailing list archive contains a
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1780 .Hd Content-MD5
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1781 header field.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1782 Neither did any of the 60\\|000 messages in my personal mail storage.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1783 Removing the support for this header field,
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1784 removed the last place where MD5 computation was needed.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1785 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1786 Hence, the MD5 code could be removed as well.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1787 Over 500 lines of code vanished by this one change.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1788
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1789
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1790 .U3 "MMDF maildrop support
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1791 .P
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1792 This type of format is conceptionally similar to the mbox format,
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	1793 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	1794 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	1795 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	1796 whereas the MMDF maildrop format is now forgotten.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1797 By dropping the MMDF maildrop format support,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1798 mbox became the only packed mailbox format supported in mmh.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1799 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1800 The simplifications within the code were moderate.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1801 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	1802 But also, switches of
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1803 .Pn packf
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1804 and
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1805 .Pn rcvpack
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1806 could be removed.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1807 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1808 In the message parsing function
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1809 .Fn sbr/m_getfld.c ,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1810 knowledge of MMDF packed mail boxes was removed.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1811 .Ci 684ec30d81e1223a282764452f4902ed4ad1c754
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1812 Further code structure simplifications may be possible there,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1813 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	1814 I have not worked on them yet because
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1815 .Fu m_getfld()
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1816 is heavily optimized and thus dangerous to touch.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1817 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	1818 too high.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1819
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1820
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1821 .U3 "Prompter's Control Keys
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1822 .P
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1823 The program
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1824 .Pn prompter
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1825 queries the user to fill in a message form.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1826 When used by
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1827 .Pn comp
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1828 as
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1829 .Cl "comp -editor prompter" ,
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1830 the resulting behavior is similar to
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1831 .Pn mailx .
51 49cf68506b5d Spell checking. markus schnalke <meillo@marmaro.de> parents: 49 diff changeset	1832 Apparently,
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1833 .Pn prompter
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1834 hadn't been touched lately.
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1835 Otherwise it's hardly explainable why it
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1836 still offered the switches
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1837 .Sw -erase
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1838 .Ar chr
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1839 and
84 c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1840 .Sw -kill
c35ec2b7de5d style: New macros .Ar (argument) and .Hd (header field) markus schnalke <meillo@marmaro.de> parents: 82 diff changeset	1841 .Ar chr
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1842 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	1843 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	1844 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	1845 with the standard tool
7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1846 .Pn stty .
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1847 The switches are removed now
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1848 .Ci 0bd9750710cdbab80cfb4036dd87af20afe1552f .
20 7a100c80fa91 Some new text (show/mhshow; prompter). markus schnalke <meillo@marmaro.de> parents: 19 diff changeset	1849
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1850
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1851 .U3 "Hardcopy Terminal Support
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1852 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1853 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	1854 hardcopy terminal.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1855 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	1856 .Ci b7764c4a6b71d37918a97594d866258f154017ca .
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1857 .P
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1858 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	1859 program (\c
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1860 .Pn mhl )
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1861 and the terminal.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1862 In nmh, this could have been ensured statically with the
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1863 .Sw -nomoreproc
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1864 at the command line, too.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	1865 In mmh, setting the profile entry
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1866 .Pe Pager
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1867 or the environment variable
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1868 .Ev PAGER
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1869 to
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1870 .Pn cat
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1871 is sufficient.
104 2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1872
2818ca27d24c Various text rework. markus schnalke <meillo@marmaro.de> parents: 102 diff changeset	1873
21 bb8a8be49024 Wrote about Face support and vfork(). markus schnalke <meillo@marmaro.de> parents: 20 diff changeset	1874
12 7ca384d68edc Wrote some text for removal of old code. markus schnalke <meillo@marmaro.de> parents: 0 diff changeset	1875
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	1876 .H2 "Attachments
22 99409e4546d2 Wrote about the removal of tools. markus schnalke <meillo@marmaro.de> parents: 21 diff changeset	1877 .P
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1878 The mind model of email attachments is unrelated to MIME.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1879 Although the MIME RFCs (2045 through 2049) define the technical
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1880 requirements for having attachments, they do not mention the word
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1881 ``attachment''.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1882 Instead of attachments, MIME talks about ``multi-part message bodies''
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1883 [RFC\\|2045], a more general concept.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1884 Multi-part messages are messages
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1885 ``in which one or more different
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1886 sets of data are combined in a single body''
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1887 [RFC\\|2046].
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1888 MIME keeps its descriptions generic;
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1889 it does not imply specific usage models.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1890 One usage model became prevalent: attachments.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1891 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	1892 attached to it.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1893 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	1894 and parts of arbitrary type following.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1895 .P
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1896 MH's MIME support is a direct implementation of the RFCs.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1897 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	1898 in MH's implementation.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1899 .\" XXX rewrite ``no idea''.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1900 As a result,
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1901 MH had all the MIME features but no idea of attachments.
109 2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1902 But users don't need all the MIME features,
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1903 they want convenient attachment handling.
2b094b8fb422 Rework of existing text. markus schnalke <meillo@marmaro.de> parents: 108 diff changeset	1904
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1905
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1906 .U3 "Composing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1907 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1908 In order to improve the situation on the message composing side,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1909 Jon Steinhart had added an attachment system to nmh in 2002.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1910 .Ci 7480dbc14bc90f2d872d434205c0784704213252
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1911 In the file
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1912 .Fn docs/README-ATTACHMENTS ,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1913 he described his motivation to do so as such:
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1914 .QS
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1915 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	1916 handing [sic!], the interface to this functionality is pretty obtuse.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1917 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	1918 .Pn mhbuild
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1919 composition files!
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1920 .QE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1921 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1922 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	1923 In the same document:
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1924 .QS
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1925 These changes simplify the task of managing attachments on draft files.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1926 They allow attachments to be added, listed, and deleted.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1927 MIME messages are automatically created when drafts with attachments
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1928 are sent.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1929 .QE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1930 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1931 Unfortunately, the attachment system,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1932 like any new facilities in nmh,
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1933 was inactive by default.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1934 .P
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1935 During my work in Argentina, I tried to improve the attachment system.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1936 But, because of great opposition in the nmh community,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1937 my patch died as a proposal on the mailing list, after long discussions.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1938 .[
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1939 nmh-workers attachment proposal
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1940 .]
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	1941 In January 2012, I extended the patch and applied it to mmh.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1942 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1943 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	1944 Instead of command line switches, the
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1945 .Pe Attachment-Header
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1946 profile entry is used to specify
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1947 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	1948 It is pre-defined to
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1949 .Hd Attach .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1950 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1951 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	1952 .VS
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1953 To: bob
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1954 Subject: The file you wanted
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1955 Attach: /path/to/the/file-bob-wanted
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1956 --------
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1957 Here it is.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1958 VE
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1959 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	1960 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	1961 non-interactively with
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1962 .Pn anno :
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1963 .VS
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1964 anno -append -nodate -component Attach -text /path/to/attachment
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1965 VE
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1966 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	1967 .Pn send .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1968 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	1969 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	1970 attachment headers.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1971 If the MIMEification fails, for instance because the file to attach
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1972 is not accessible, the original draft is not changed.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1973 .P
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1974 The attachment system handles the forwarding of messages, too.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1975 If the attachment header value starts with a plus character (`+'),
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1976 like in
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1977 .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	1978 the given messages in the specified folder will be attached.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1979 This allowed to simplify
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1980 .Pn forw .
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1981 .Ci f41f04cf4ceca7355232cf7413e59afafccc9550
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1982 .P
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1983 Closely related to attachments is non-ASCII text content,
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1984 because it requires MIME too.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1985 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	1986 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	1987 This was necessary whenever the draft contained non-ASCII characters.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1988 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	1989 Therefore, the
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1990 .Pe automimeproc
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1991 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	1992 automatically each time.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	1993 Unfortunately, this approach conflicted with attachment system
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1994 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	1995 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	1996 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	1997 WhatNow prompt and
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	1998 .Pe automimeproc
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	1999 must not be set in the profile.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2000 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	2001 not caught.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2002 All in all, the solution was complex and irritating.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2003 My patch from December 2010 would have simplified the situation.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2004 .P
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2005 Mmh's current solution is even more elaborate.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2006 Any necessary MIMEification is done automatically.
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2007 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	2008 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	2009 attachment header or non-ASCII text is present.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2010 Furthermore, the hash character (`#') is not special any more
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2011 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	2012 .\" XXX REF ?
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2013 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	2014 .P
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2015 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	2016 compositions directly, the full power of
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2017 .Pn mhbuild
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2018 can still be accessed.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2019 Given no attachment headers are included, the user can create
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2020 .Pn mhbuild
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2021 composition drafts like in nmh.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2022 Then, at the WhatNow prompt, he needs to invoke
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2023 .Cl "edit mhbuild
e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2024 to convert it to MIME.
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	2025 Because the resulting draft does neither contain non-ASCII characters
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2026 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	2027 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2028 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	2029 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	2030 This case was simplified.
101 e8e6adb14beb Wrote about attachments. markus schnalke <meillo@marmaro.de> parents: 100 diff changeset	2031
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2032
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2033 .U3 "MIME Type Guessing
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2034 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2035 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	2036 .Pn mhbuild
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2037 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	2038 The user provides the appropriate MIME types for files to include.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2039 The attachment system needs to find out the correct MIME type itself.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2040 This is a difficult task, yet it spares the user irritating work.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2041 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	2042 partly intelligent work.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2043 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	2044 forces him to do partly mechanical work.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2045 Letting the computer do the work, can lead to bad choices for difficult
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2046 content.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2047 For mmh, the latter option was chosen.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2048 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2049 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	2050 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	2051 for the common cases.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2052 Mmh implements this approach in the
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2053 .Pn print-mimetype
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2054 script.
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2055 .Ci 4b5944268ea0da7bb30598a27857304758ea9b44
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2056 Using it is the default choice.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2057 .P
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2058 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	2059 .Pn file .
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2060 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	2061 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	2062 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	2063 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	2064 It varies much.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2065 Nevertheless, modern versions of GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2066 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2067 which is prevalent on the popular GNU/Linux systems,
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2068 provide MIME type output in machine-readable form.
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2069 Although this solution is highly system-dependent,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2070 it solves the difficult problem well.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2071 On systems where GNU
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2072 .Pn file ,
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2073 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	2074 One needs to specify the following profile entry to do so:
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2075 .Ci 3baec236a39c5c89a9bda8dbd988d643a21decc6
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2076 .VS
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2077 Mime-Type-Query: file -b --mime
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2078 VE
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2079 .LP
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2080 Other versions of
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2081 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2082 might possibly be usable with wrapper scripts to reformat the output.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2083 The diversity among
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2084 .Pn file
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2085 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	2086 .P
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2087 If no MIME type can be determined, text content gets sent as
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2088 `text/plain' and anything else under the generic fall-back type
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2089 `application/octet-stream'.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2090 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	2091 for a specific file.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2092 To do so, either the user would need to know in advance for which file
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2093 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	2094 I consider both cases impractical.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2095 The existing solution should be sufficient.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2096 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	2097 .Pn mhbuild
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2098 composition drafts and ignore the attachment system.
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2099
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2100
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2101 .U3 "Storing Attachments
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2102 .P
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2103 Extracting MIME parts of a message and storing them to disk is done by
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2104 .Pn mhstore .
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2105 The program has two operation modes,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2106 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2107 and
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2108 .Sw -noauto .
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2109 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	2110 MIME part's meta information, if available.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2111 This naming information is usually available for modern attachments.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2112 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	2113 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2114 would have been specified.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2115 In the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2116 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2117 mode, the parts are processed according to rules, defined by
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2118 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2119 profile entries.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2120 These rules define generic filename templates for storing
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2121 or commands to post-process the contents in arbitrary ways.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2122 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	2123 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	2124 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2125 The
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2126 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2127 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	2128 in contrast to the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2129 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2130 mode.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2131 In mmh,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2132 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2133 is not dangerous anymore.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2134 Two changes were necessary:
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2135 .BU
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2136 Any directory path is removed from the proposed filename.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2137 Thus, the files are always stored in the expected directory.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2138 .Ci 41b6eadbcecf63c9a66aa5e582011987494abefb
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2139 .BU
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2140 Tar files are not extracted automatically any more.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2141 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	2142 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2143 .LP
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2144 Now, the outcome of mmh's
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2145 .Cl "mhstore -auto
110 4c0f13b1e0e8 Spellchecked. markus schnalke <meillo@marmaro.de> parents: 109 diff changeset	2146 can be foreseen from the output of
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2147 .Cl "mhlist -verbose" .
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2148 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2149 The
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2150 .Sw -noauto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2151 mode is seen to be more powerful but less convenient.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2152 On the other hand,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2153 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2154 is safe now and
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2155 storing attachments under their original name is intuitive.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2156 Hence,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2157 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2158 serves better as the default option.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2159 .Ci 3410b680416c49a7617491af38bc1929855a331d
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2160 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2161 Files are stored into the directory given by the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2162 .Pe Nmh-Storage
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2163 profile entry, if set, or
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2164 into the current working directory, otherwise.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2165 Storing to different directories is only possible with
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2166 .Pe mhstore-store-*
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2167 profile entries.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2168 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2169 Still, in both modes, existing files get overwritten silently.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2170 This can be considered a bug.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2171 Yet, each other behavior has its draw-backs, too.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2172 Refusing to replace files requires adding a
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2173 .Sw -force
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2174 option.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2175 Users will likely need to invoke
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2176 .Pn mhstore
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2177 a second time with
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2178 .Sw -force .
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2179 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	2180 This requires interaction, which I like to avoid if possible.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2181 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	2182 For now, the behavior remains as it is.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2183 .P
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2184 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	2185 .Pn mhstore 's
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2186 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2187 mode.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2188 Instead of storing message/rfc822 parts as files to disk,
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2189 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	2190 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	2191 automatically reassembled beforehand.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2192 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	2193 anymore.
8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2194 Instead, information on how to retrieve them is output.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2195 Not supporting this rare case saved nearly one thousand lines of code.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2196 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2197 .\" 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	2198 .\" and sbr/ruserpass.c for reading ~/.netrc are gone now.)
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2199 `application/octet-stream; type=tar' is not special anymore.
108 dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2200 Automatically extracting such MIME parts had been the dangerous part
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2201 of the
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2202 .Sw -auto
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2203 mode.
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2204 .Ci 94c80042eae3383c812d9552089953f9846b1bb6
dd5620bf8659 Wrote about storing attachments. markus schnalke <meillo@marmaro.de> parents: 107 diff changeset	2205
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2206
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2207
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2208 .U3 "Showing MIME Messages
a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2209 .P
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2210 The program
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2211 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2212 had been written to display MIME messages.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2213 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	2214 Nmh's
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2215 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2216 handled each MIME part independently, presenting them separately
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2217 to the user.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2218 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	2219 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	2220 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	2221 plus possibly attachments.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2222 They are not any more seen to be arbitrary MIME hierarchies with
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2223 information on how to display the individual parts.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2224 I adjusted
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2225 .Pn mhshow 's
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2226 behavior to the modern view on the topic.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2227 .P
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2228 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	2229 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2230 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	2231 and is no longer part of mmh.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2232 Although
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2233 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2234 was renamed to
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2235 .Pn show
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2236 in mmh, this section uses the name
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2237 .Pn mhshow ,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2238 in order to avoid confusion.
159 8b411125645d Corrections and improvements by Kate, Phil, Matou, Michi, Lydi. markus schnalke <meillo@marmaro.de> parents: 157 diff changeset	2239 .\" XXX ref to other section
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2240 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2241 In mmh, the basic idea is that
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2242 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2243 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	2244 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2245 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2246 invokes a pager session for all its output,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2247 whenever it prints to a terminal.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2248 .Ci a4197ea6ffc5c1550e8b52d5a654bcaaaee04a4e
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2249 In consequence,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2250 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2251 does no more invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2252 .Ci 0e46503be3c855bddaeae3843e1b659279c35d70
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2253 With
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2254 .Pn mhshow
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2255 replacing the original
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2256 .Pn show ,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2257 output from
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2258 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2259 does not go to the terminal directly, but through
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2260 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2261 Hence,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2262 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2263 does not need to invoke a pager.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2264 The one and only job of
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2265 .Pn mhl
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2266 is to format messages or parts of them.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2267 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	2268 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2269 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2270 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2271 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	2272 For instance, PDF and Postscript files could be converted to plain text
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2273 to display them in the terminal.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2274 In mmh, the displaying of MIME parts will always be done serially.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2275 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	2276 is ignored.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2277 It is simply treated as `multipart/mixed'.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2278 .Ci d0581ba306a7299113a346f9b4c46ce97bc4cef6
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2279 This could already be requested with the, now removed,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2280 .Sw -serialonly
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2281 switch of
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2282 .Pn mhshow .
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2283 As MIME parts are always processed exclusively , i.e. serially,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2284 the `%e' escape in
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2285 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2286 profile entries became useless and was thus removed.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2287 .Ci a20d405db09b7ccca74d3e8c57550883da49e1ae
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2288 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2289 In the intended setup, only text content would be displayed.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2290 Non-text content would be converted to text by appropriate
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2291 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2292 profile entries before, if possible and wanted.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2293 All output would be displayed in a single pager session.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2294 Other kinds of attachments are ignored.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2295 With
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2296 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2297 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	2298 the message.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2299 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	2300 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2301 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	2302 to the native charset.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2303 Therefore,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2304 .Pe mhshow-charset-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2305 profile entries used to be needed.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2306 In mmh, the conversion is done automatically by piping the text through
114 92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2307 the
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2308 .Pn iconv
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2309 command, if necessary.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2310 .Ci 2433122c20baccb10b70b49c04c6b0497b5b3b60
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2311 Custom
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2312 .Pe mhshow-show-*
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2313 rules for textual content might need a
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2314 .Cl "iconv -f %c %f \|
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2315 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	2316 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2317 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	2318 has improved, it is not consistent enough.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2319 Further work needs to be done and
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2320 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	2321 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	2322 correctly without the need to configure anything.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2323
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2324
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2325 .ig
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2326
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2327 .P
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2328 mhshow/mhstore: Removed support for retrieving message/external-body parts.
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2329 These tools won't download the contents automatically anymore. Instead,
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2330 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	2331 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	2332 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	2333 it!
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2334 (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	2335 ~/.netrc are gone now.)
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2336 .Ci 55e1d8c654ee0f7c45b9361ce34617983b454c32
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2337
92cbd3fa1c40 Wrote text about displaying mime messages. markus schnalke <meillo@marmaro.de> parents: 112 diff changeset	2338 ..
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2339
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2340
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2341
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2342 .H2 "Digital Cryptography
22 99409e4546d2 Wrote about the removal of tools. markus schnalke <meillo@marmaro.de> parents: 21 diff changeset	2343 .P
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2344 Nmh offers no direct support for digital cryptography,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2345 i.e. digital signatures and message encryption.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2346 This functionality needed to be added through third-party software.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2347 In mmh, the functionality should be included because digital
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2348 cryptography is a part of modern email and likely used by users of mmh.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2349 A fresh mmh installation should support signing and encrypting
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2350 out-of-the-box.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2351 Therefore, Neil Rickert's
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2352 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2353 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2354 .Pn mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2355 scripts
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2356 .[
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2357 neil rickert mhsign mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2358 .]
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2359 were included into mmh.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2360 The scripts fit well into the mmh, because they are lightweight and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2361 of style similar to the existing tools.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2362 Additionally, no licensing difficulties appeared,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2363 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	2364 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2365 The scripts were written for nmh, hence I needed to adjust them according
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2366 to the differences of mmh.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2367 For instance, I removed the use of the backup prefix and dropped support
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2368 for old PGP features.
112 4e6a9ae1b53c Added a bit of text on modern defaults; plus added code refs. markus schnalke <meillo@marmaro.de> parents: 110 diff changeset	2369 .P
157 0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2370 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2371 handles the signing and encrypting part.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2372 It comprises about 250 lines of shell code and interfaces between
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2373 .Pn gnupg
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2374 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2375 the MH system.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2376 It was meant to be invoked at the WhatNow prompt, but in mmh,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2377 .Pn send
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2378 does the job automatically.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2379 Special header fields were introduced to request the action.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2380 If a draft contains the
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2381 .Hd Sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2382 header field,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2383 .Pn send
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2384 will sign it.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2385 The key to be used is either chosen automatically or specified by the
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2386 .Pe Pgpkey
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2387 profile entry.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2388 .Pn send
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2389 always signes messages using the PGP/MIME standard, \" REF XXX
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2390 but by manually invoking
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2391 .Pn mhsign ,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2392 old-style non-MIME signatures can be created as well.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2393 To sign an outgoing message, the draft needs to contain a
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2394 .Hd Enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2395 header field.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2396 Public keys of all recipients are taken from the gnupg keyring or
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2397 from an overrides files, called
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2398 .Fn pgpkeys .
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2399 Unless public keys are found for all recipients,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2400 .Pn send
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2401 will refuse to encrypt and send it.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2402 Currently, messages with hidden (BCC) recipients can not be encrypted.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2403 This corner-case requires a more complex solution.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2404 Covering it is left to do.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2405 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2406 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	2407 most recent features in mmh.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2408 Feedback from users and the experience I will gather myself
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2409 will direct the further development of the facility.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2410 It is worthwhile to consider adding
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2411 .Sw -[no]sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2412 and
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2413 .Sw -[no]enc
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2414 switches to
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2415 .Pn send ,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2416 to override the corresponding header fields.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2417 The profile entry:
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2418 .VS
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2419 send: -sign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2420 VE
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2421 .LP
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2422 would then activate signing of all outgoing messages.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2423 With the present approach, the line
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2424 .VS
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2425 Send:
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2426 VE
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2427 .LP
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2428 needs to be added to all message forms to achieve the same result.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2429 Yet, the integration of
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2430 .Pn mhsign
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2431 into mmh is too recent to have enough experience to decide this
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2432 question now.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2433 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2434 .Pn mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2435 is the contrary part to
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2436 .Pn mhsign .
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2437 It verifies signatures and decrypts messages.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2438 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2439 FIXME: Add it to mmh first, then write about it here.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2440 .P
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2441 The integration of
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2442 .Pn mhpgp
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2443 into
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2444 .Pn show ,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2445 to automatically verify signatures and decrypt messages as needed,
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2446 is a task left open.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2447 .Pn show 's
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2448 current structure does not allow such an integration on basis of
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2449 the existing code.
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2450 Extensive programming work is required. ... FIXME
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2451
0cce17978f0a Wrote about signing and encrypting. Not finished yet. markus schnalke <meillo@marmaro.de> parents: 155 diff changeset	2452
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2453
814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	2454
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	2455
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2456 .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	2457 .P
14 55ec590cfa07 Wrote about the draft folder. markus schnalke <meillo@marmaro.de> parents: 12 diff changeset	2458
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2459 .U3 "Draft Folder
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2460 .Id draft-folder
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2461 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2462 In the beginning, MH had the concept of a draft message.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2463 This is the file
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2464 .Fn draft
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2465 in the MH directory, which is treated special.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2466 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	2467 As the draft file was one particular file, only one draft could be
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2468 managed at any time.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2469 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	2470 the user had to decide among:
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2471 .BU
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2472 Use the old draft to finish and send it before starting with a new one.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2473 .BU
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2474 Discard the old draft, replacing it with the new one.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2475 .BU
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2476 Preserve the old draft by refiling it to a folder.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2477 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2478 This was, it was only possible to work in alternation on multiple drafts.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2479 Therefore, the current draft needed to be refiled to a folder and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2480 another one re-using for editing.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2481 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	2482 The usual approach of switching to a different MH context did not
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2483 change anything.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2484 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2485 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	2486 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	2487 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	2488 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	2489 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	2490 out-of-the-box.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2491 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	2492 .Mp mh-draft (5)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2493 to better document the feature.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2494 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2495 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	2496 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	2497 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	2498 complex cases.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2499 The concept of the draft message is too limited for the problem.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2500 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	2501 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	2502 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	2503 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	2504 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	2505 Tools do not need special switches to work on the draft message.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2506 Hence corner-cases were removed.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2507 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2508 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	2509 default name.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2510 I chose the name
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2511 .Fn +drafts
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2512 for obvious reasons.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2513 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	2514 .Sw -draftfolder
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2515 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2516 .Sw -draftmessage
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2517 could be removed.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2518 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	2519 new concept.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2520 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	2521 approaches.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2522 By fully switching to the draft folder, the tools could be simplified
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2523 by dropping the awkward draft message handling code.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2524 .Sw -draft
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2525 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	2526 special.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2527 It became indistinguishable to operating on any other message.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2528 There is no more need to query the user for draft handling.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2529 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	2530 Refiling drafts is without difference to refiling other messages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2531 All these special cases are gone.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2532 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	2533 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2534 still has
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2535 .Sw -[no]use
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2536 for switching between two modes:
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2537 .BU
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2538 .Sw -use :
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2539 Modify an existing draft.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2540 .BU
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2541 .Sw -nouse :
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2542 Compose a new draft, possibly taking some existing message as a form.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2543 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2544 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	2545 .Pn comp
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2546 is deterministic.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2547 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2548 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2549 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	2550 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	2551 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	2552 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	2553 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	2554 .Pn send
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2555 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	2556 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2557 Dropping the draft message concept in favor for the draft folder concept,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2558 removed special cases with regular cases.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2559 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	2560 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	2561 but applies them.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2562 .Cl "scan +drafts" ,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2563 for instance, is a truly natural request.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2564 Most of the work was already done by Rose in the eighties.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2565 The original improvement of mmh is dropping the old draft message approach
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2566 and thus simplifying the tools, the documentation and the system as a whole.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2567 Although my part in the draft handling improvement was small,
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2568 it was an important one.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2569
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2570
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2571 .U3 "Trash Folder
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2572 .Id trash-folder
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2573 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2574 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	2575 Historically, a message was ``deleted'' by prepending a specific
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2576 \fIbackup prefix\fP, usually the comma character, to the file name.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2577 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	2578 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	2579 Although files remained in the file system,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2580 the messages were no more visible in MH.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2581 To truly delete them, a maintenance job is needed.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2582 Usually a cron job is installed to delete them after a grace time.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2583 For instance:
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2584 .VS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2585 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	2586 VE
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2587 In such a setup, the original message can be restored
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2588 within the grace time interval by stripping the
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2589 backup prefix from the file name.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2590 But the user can not rely on this statement.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2591 If the last message of a folder with six messages (1-6) is removed,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2592 message
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2593 .Fn 6 ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2594 becomes file
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2595 .Fn ,6 .
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2596 If then a new message enters the same folder, it will be given
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2597 the number one higher than the highest message.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2598 In this case the message is named
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2599 .Fn 6
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2600 then.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2601 If this message is removed as well,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2602 then the backup of the former message gets overwritten.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2603 Hence, the ability to restore removed messages does not only depend on
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2604 the ``sweeping cron job'' but also on the removing of further messages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2605 It is undesirable to have such obscure and complex mechanisms.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2606 The user should be given a small set of clear assertions.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2607 ``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	2608 is such a clear assertion.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2609 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	2610 same folder is removed before.'' the statement becomes complex.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2611 A user will hardly be able to keep track of any removal to know
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2612 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	2613 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	2614 The consequences of further removals are not obvious.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2615 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2616 Further more, the backup files are scattered within the whole mail storage.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2617 This complicates managing them.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2618 It is possible with the help of
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2619 .Pn find ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2620 but everything would be more convenient
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2621 if the deleted messages would be collected in one place.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2622 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2623 The profile entry
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2624 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2625 (previously named
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2626 .Pe Delete-Prog )
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2627 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	2628 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	2629 the specified messages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2630 This would override the default action, described above.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2631 Refiling the to-be-removed files to a garbage folder is the usual example.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2632 Nmh's man page
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2633 .Mp rmm (1)
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2634 proposes to set the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2635 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2636 to
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2637 .Cl "refile +d
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2638 to move messages to the garbage folder,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2639 .Fn +d ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2640 instead of renaming them with the backup prefix.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2641 The man page proposes additionally the expunge command
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2642 .Cl "rm `mhpath +d all`
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2643 to empty the garbage folder.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2644 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2645 Removing messages in such a way has advantages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2646 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	2647 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	2648 Existing and removed messages are thus separated more strictly.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2649 No backup files are silently overwritten.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2650 But most important is the ability to keep removed messages in the MH domain.
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2651 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	2652 Deleted messages can be displayed like any other messages.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2653 Restoring a deleted messages can be done with
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2654 .Pn refile .
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2655 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	2656 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	2657 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2658 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	2659 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	2660 Hence,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2661 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2662 calls
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2663 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2664 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	2665 .Fn +trash
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2666 by default.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2667 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	2668 .Cl "rmm -unlink +trash a" ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2669 where the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2670 .Sw -unlink
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2671 switch causes the files to be unlinked.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2672 .P
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2673 Dropping the legacy approach and completely converting to the new approach
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2674 simplified the code base.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2675 The relationship between
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2676 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2677 and
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2678 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2679 was inverted.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2680 In mmh,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2681 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2682 invokes
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2683 .Pn refile ,
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2684 which used to be the other way round.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2685 Yet, the relationship is simpler now.
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2686 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	2687 .Mp refile (1),
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	2688 can no longer occur:
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2689 .QS
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2690 Since
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2691 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2692 uses your
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2693 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2694 to delete the message, the
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2695 .Pe rmmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2696 must NOT call
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2697 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2698 without specifying
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2699 .Sw -normmproc
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2700 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	2701 .QE
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2702 .LP
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2703 .Pn rmm
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2704 either unlinks a message with
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2705 .Fu unlink()
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2706 or invokes
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2707 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2708 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	2709 .Pn refile
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2710 does not invoke any tools.
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2711 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2712 By generalizing the message removal in the way that it became covered
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2713 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	2714
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2715
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2716
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2717
7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2718
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2719 .H2 "Modern Defaults
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2720 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2721 Nmh has a bunch of convenience-improving features inactive by default,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2722 although one can expect every new user wanting to have them active.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2723 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	2724 with old versions.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2725 But what is the definition for old versions?
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2726 Still, the highly useful draft folder facility has not been activated
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2727 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	2728 .[
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2729 rose romine real work
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2730 .]
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2731 The community seems not to care.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2732 This is one of several examples that require new users to first build up
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2733 a profile before they can access the modern features of nmh.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2734 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	2735 for modern emailing.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2736 The point is not the customization of the setup,
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2737 but the need to activate generally useful facilities.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2738 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2739 Yet, the real problem lies less in enabling the features, as this is
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2740 straight forward as soon as one knows what he wants.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2741 The real problem is that new users need deep insights into the project
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2742 before they find out what they are missing and that nmh actually
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2743 provides it already, it just was not activated.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2744 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	2745 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	2746 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	2747 documentation.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2748 If I would have installed nmh from source back then, I could agree.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2749 Yet, I had used a prepackaged version and had expected that it would
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2750 just work.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2751 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	2752 and I am a software developer,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2753 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	2754 How can we expect users to be even more advanced than me,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2755 just to allow them use MH in a convenient and modern way?
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2756 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	2757 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	2758 before they truly used the system,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2759 although they had been motivated in the beginning.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2760 They suffer hard enough to get used to the toolchest approach,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2761 we should spare them further inconveniences.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2762 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2763 Maintaining compatibility for its own sake is bad,
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2764 because the code base collects more and more compatibility code.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2765 Sticking to the compatiblity code means remaining limited;
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2766 not using it renders it unnecessary.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2767 Keeping unused alternative in the code is a bad choice as they likely
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2768 gather bugs, by not being well tested.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2769 Also, the increased code size and the greater number of conditions
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2770 increase the maintenance costs.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2771 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	2772 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	2773 important.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2774 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	2775 Hence, compatibility is hardly important for technical reasons.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2776 Its importance originates rather from personal reasons.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2777 Nmh's user base is small and old.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2778 Changing the interfaces would cause inconvenience to long-term users of MH.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2779 It would force them to change their many years old MH configurations.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2780 I do understand this aspect, but it keeps new users from using MH.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2781 By sticking to the old users, new users are kept away.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2782 Yet, the future lies in new users.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2783 Hence, mmh invites new users by providing a convenient and modern setup,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2784 readily usable out-of-the-box.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2785 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2786 In mmh, all modern features are active by default and many previous
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2787 approaches are removed or only accessible in manual ways.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2788 New default features include:
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2789 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2790 The attachment system (\c
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2791 .Hd Attach ).
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2792 .Ci 8ff284ff9167eff8f5349481529332d59ed913b1
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2793 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2794 The draft folder facility (\c
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2795 .Fn +drafts ).
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2796 .Ci 337338b404931f06f0db2119c9e145e8ca5a9860
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2797 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2798 The unseen sequence (`u')
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2799 .Ci c2360569e1d8d3678e294eb7c1354cb8bf7501c1
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2800 and the sequence negation prefix (`!').
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2801 .Ci db74c2bd004b2dc9bf8086a6d8bf773ac051f3cc
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2802 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2803 Quoting the original message in the reply.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2804 .Ci 67411b1f95d6ec987b4c732459e1ba8a8ac192c6
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2805 .BU
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2806 Forwarding messages using MIME.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2807 .Ci 6e271608b7b9c23771523f88d23a4d3593010cf1
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2808 .P
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2809 In consequence, a setup with a profile that defines only the path to the
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2810 mail storage, is already convenient to use.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2811 Again, Paul Vixie's ``edginess'' appeal supports the direction I took:
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2812 ``the `main branch' should just be modern''.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2813 .[
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2814 paul vixie edginess nmh-workers
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2815 .]
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2816
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2817
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2818
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2819
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2820
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2821 .\" --------------------------------------------------------------
131 7c741bc8f719 Reorganized: Converted 4-parted discussion into 3-parted discussion. markus schnalke <meillo@marmaro.de> parents: 130 diff changeset	2822 .H1 "Styling
16 81f703140554 Wrote about the trash folder. markus schnalke <meillo@marmaro.de> parents: 14 diff changeset	2823 .P
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2824 Kernighan and Pike have emphasized the importance of style in the
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2825 preface of their book:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2826 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2827 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	2828 .], p. x]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2829 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2830 Chapter 1 discusses programming style.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2831 Good style is so important to good programming that we have chose
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2832 to cover it first.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2833 .QE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2834 This section covers changes in mmh that were motivated by the desire
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2835 to improve on style.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2836 Many of them follow the rules given in the quoted book.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2837 .[
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2838 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	2839 .]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2840
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2841
127 4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2842
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2843
4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	2844 .H2 "Code Style
154 63e885fb48ba Converted some internal references to the new macros. markus schnalke <meillo@marmaro.de> parents: 145 diff changeset	2845 .Id code-style
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2846 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2847 .U3 "Indentation Style
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2848 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2849 Indentation styles are the holy cow of programmers.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2850 Again Kernighan and Pike:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2851 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2852 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	2853 .], p. 10]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2854 .QS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2855 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	2856 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	2857 application.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2858 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	2859 time arguing.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2860 .QE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2861 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2862 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	2863 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	2864 For instance the indentation with tab characters only.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2865 Tab characters directly map to the nesting level \(en
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2866 one tab, one level.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2867 Tab characters are flexible because developers can adjust them to
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2868 whatever width they like to have.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2869 There is no more need to run
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2870 .Pn unexpand
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2871 or
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2872 .Pn entab
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2873 programs to ensure the correct mixture of leading tabs and spaces.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2874 The simple rules are: (1) Leading whitespace must consist of tabs only.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2875 (2) Any other whitespace should consist of spaces.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2876 These two rules ensure the integrity of the visual appearance.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2877 Although reformatting existing code should be avoided, I did it.
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2878 I did not waste time arguing; I just reformated the code.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2879 .Ci a485ed478abbd599d8c9aab48934e7a26733ecb1
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2880
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2881 .U3 "Comments
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2882 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2883 Section 1.6 of
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2884 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2885 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	2886 .], p. 23]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2887 demands: ``Don't belabor the obvious.''
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	2888 Hence, I simply removed all the comments in the following code excerpt:
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2889 .VS
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2890 context_replace(curfolder, folder); /* update current folder */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2891 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	2892 seq_save(mp); /* synchronize message sequences */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2893 folder_free(mp); /* free folder/message structure */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2894 context_save(); /* save the context file */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2895
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2896 [...]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2897
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2898 int c; /* current character */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2899 char cp; / miscellaneous character pointer */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2900
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2901 [...]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2902
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2903 /* NUL-terminate the field */
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2904 *cp = '\0';
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2905 VE
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2906 .Ci 426543622b377fc5d091455cba685e114b6df674
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2907 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2908 The program code explains enough itself, already.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2909
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2910
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2911 .U3 "Names
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2912 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2913 Kernighan and Pike suggest:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2914 ``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	2915 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2916 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	2917 .], p. 4]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2918 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	2919 .Fu check_charset()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2920 to
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2921 .Fu is_native_charset() .
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2922 .Ci 8d77b48284c58c135a6b2787e721597346ab056d
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2923 The same change fixed a violation of ``Be accurate'' as well.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2924 The code did not match the expectation the function suggested,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2925 as it, for whatever reason, only compared the first ten characters
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2926 of the charset name.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2927 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2928 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	2929 .VS
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2930 m_unknown(in); /* the MAGIC invocation... */
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2931 VE
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2932 Renaming the obscure
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2933 .Fu m_unknown()
145 3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	2934 function was a delightful event, although it made the code less funny.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2935 .Ci 611d68d19204d7cbf5bd585391249cb5bafca846
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2936 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2937 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	2938 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	2939 ``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	2940 .[ [
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2941 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	2942 .], p. 19]
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2943 One such change was naming the type of input \(en mbox or mail folder \(en
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2944 to be scanned:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2945 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2946 #define SCN_MBOX (-1)
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2947 #define SCN_FOLD 0
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2948 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2949 .Ci 7ffb36d28e517a6f3a10272056fc127592ab1c19
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2950 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2951 The argument
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2952 .Ar outnum
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2953 of the function
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2954 .Fu scan()
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2955 in
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2956 .Fn uip/scansbr.c
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2957 defines the number of the message to be created.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2958 If no message is to be created, the argument is misused to transport
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2959 program logic.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2960 This lead to obscure code.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2961 I improved the clarity of the code by introducing two variables:
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2962 .VS
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2963 int incing = (outnum > 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2964 int ismbox = (outnum != 0);
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2965 VE
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2966 They cover the magic values and are used for conditions.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2967 The variable
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2968 .Ar outnum
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2969 is only used when it holds an ordinary message number.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2970 .Ci b8b075c77be7794f3ae9ff0e8cedb12b48fd139f
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2971 The clarity improvement of the change showed detours in the program logic
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2972 of related code parts.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2973 Having the new variables with descriptive names, a more
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	2974 straight forward implementation became apparent.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2975 Before the clarification was done,
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2976 the possibility to improve had not be seen.
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2977 .Ci aa60b0ab5e804f8befa890c0a6df0e3143ce0723
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2978
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2979
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2980
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2981 .H2 "Structural Rework
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	2982 .P
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2983 Although the stylistic changes described up to here improve the
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2984 readability of the source code, all of them are changes ``in the small''.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2985 Structural changes affect a much larger area.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2986 They are more difficult to do but lead to larger improvements,
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2987 especially as they influence the outer shape of the tools as well.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2988 .P
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2989 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	2990 Kernighan and Pike ask: ``But why worry about style?''
136 470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2991 Following are two examples of structural rework that show
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2992 why style is important in the first place.
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2993
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2994
470d5db0c06c Minor rework. markus schnalke <meillo@marmaro.de> parents: 134 diff changeset	2995 .U3 "Rework of \f(CWanno\fP
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2996 .P
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2997 Until 2002,
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	2998 .Pn anno
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	2999 had six functional command line switches,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3000 .Sw -component
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3001 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3002 .Sw -text ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3003 which took an argument each,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3004 and the two pairs of flags,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3005 .Sw -[no]date
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3006 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3007 .Sw -[no]inplace.,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3008 .Sw -component
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3009 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3010 .Sw -text ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3011 which took an argument each,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3012 and the two pairs of flags,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3013 .Sw -[no]date
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3014 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3015 .Sw -[no]inplace .
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3016 Then Jon Steinhart introduced his attachment system.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3017 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	3018 .Pn anno .
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3019 He added five more switches:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3020 .Sw -draft ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3021 .Sw -list ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3022 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3023 .Sw -append ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3024 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3025 .Sw -number ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3026 the last one taking an argument.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3027 .Ci 7480dbc14bc90f2d872d434205c0784704213252
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3028 Later,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3029 .Sw -[no]preserve
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3030 was added.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3031 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3032 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	3033 .Mp anno (1)
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3034 read:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3035 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3036 anno [+folder] [msgs] [-component field] [-inplace \| -noinplace]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3037 [-date \| -nodate] [-draft] [-append] [-list] [-delete]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3038 [-number [num\|all]] [-preserve \| -nopreserve] [-version]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3039 [-help] [-text body]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3040 VE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3041 .LP
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3042 The implementation followed the same structure.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3043 Problems became visible when
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3044 .Cl "anno -list -number 42
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3045 worked on the current message instead on message number 42,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3046 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3047 .Cl "anno -list -number l:5
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	3048 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	3049 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	3050 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	3051 There, the correct use of
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3052 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3053 was defined as being
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3054 .Cl "[-number [num\|all]]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3055 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	3056 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3057 read:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3058 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3059 The
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3060 .Sw -list
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3061 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	3062 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	3063 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	3064 .Sw -number
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3065 option is also used.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3066 .QE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3067 .LP
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3068 The problem was manifold.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3069 The code required a numeric argument to the
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3070 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3071 switch.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3072 If it was missing or non-numeric,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3073 .Pn anno
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3074 aborted with an error message that had an off-by-one error,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3075 printing the switch one before the failing one.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3076 Semantically, the argument to the
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3077 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3078 switch is only necessary in combination with
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3079 .Sw -delete ,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3080 but not with
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3081 .Sw -list .
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3082 In the former case it is even necessary.
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3083 .P
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3084 Trying to fix these problems on the surface would not have solved it truly.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3085 The problems discovered originate from a discrepance between the semantic
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3086 structure of the problem and the structure implemented in the program.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3087 Such structural differences can not be cured on the surface.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3088 They need to be solved by adjusting the structure of the implementation
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3089 to the structure of the problem.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3090 .P
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3091 In 2002, the new switches
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3092 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3093 and
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 were added in the same way, the
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3096 .Sw -number
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3097 switch for instance had been added.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3098 Yet, they are of structural different type.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3099 Semantically,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3100 .Sw -list
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3101 and
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3102 .Sw -delete
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3103 introduce modes of operation.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3104 Historically,
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3105 .Pn anno
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3106 had only one operation mode: adding header fields.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3107 With the extension, it got two moder modes:
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3108 listing and deleting header fields.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3109 The structure of the code changes did not pay respect to this
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3110 fundamental change to
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3111 .Pn anno 's
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3112 behavior.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3113 Neither the implementation nor the documentation did clearly
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3114 define them as being exclusive modes of operation.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3115 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	3116 .Pn anno
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3117 and its documentation.
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3118 .Ci d54c8db8bdf01e8381890f7729bc0ef4a055ea11
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3119 .P
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3120 The difference is visible in both, the code and the documentation.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3121 The following code excerpt:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3122 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3123 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	3124 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	3125 [...]
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3126 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3127 delete = 0;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3128 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3129 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3130 list = 1;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3131 continue;
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3132 VE
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3133 .LP
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3134 was replaced by:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3135 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3136 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	3137 [...]
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3138 case DELETESW: /* delete annotations */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3139 mode = MODE_DEL;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3140 continue;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3141 case LISTSW: /* produce a listing */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3142 mode = MODE_LIST;
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3143 continue;
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3144 VE
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3145 .LP
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3146 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	3147 it is easier to understand as well.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3148 The same applies to the documentation.
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3149 The man page was completely reorganized to propagate the same structure.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3150 This is visible in the Synopsis section:
120 e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3151 .VS
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3152 anno [+folder] [msgs] [-component field] [-text body]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3153 [-append] [-date \| -nodate] [-preserve \| -nopreserve]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3154 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3155
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3156 anno -delete [+folder] [msgs] [-component field] [-text
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3157 body] [-number num \| all ] [-preserve \| -nopreserve]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3158 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3159
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3160 anno -list [+folder] [msgs] [-component field] [-number]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3161 [-Version] [-help]
e49780100ffb Wrote about the rework of anno(1). markus schnalke <meillo@marmaro.de> parents: 118 diff changeset	3162 VE
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3163 .\" XXX think about explaining the -preserve rework?
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3164
16 81f703140554 Wrote about the trash folder. markus schnalke <meillo@marmaro.de> parents: 14 diff changeset	3165
0 dc2bfef4cda7 Initial commit: Basic structure, macros and fonts. markus schnalke <meillo@marmaro.de> parents: diff changeset	3166
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3167 .U3 "Path Conversion
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3168 .P
134 edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3169 Four kinds of path names can appear in MH:
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3170 .IP (1)
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3171 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	3172 .Fn /etc/passwd .
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3173 .IP (2)
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3174 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	3175 .Fn ./foo/bar .
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3176 .IP (3)
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3177 Absolute MH folder paths, like
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3178 .Fn +friends/phil .
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3179 .IP (4)
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3180 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	3181 .Fn @subfolder .
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3182 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3183 The last type, relative MH folder paths, are hardly documented.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3184 Nonetheless, they are useful for large mail storages.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3185 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	3186 .Fn @ ',
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3187 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	3188 .Fn . '.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3189 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3190 To allow MH tools to understand all four notations,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3191 they need to convert between them.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3192 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	3193 .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	3194 (``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	3195 .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	3196 (``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	3197 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	3198 than two comments, which described obvious information.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3199 The function signatures were neither explaining:
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3200 .VS
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3201 char path(char , int);
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3202 char pluspath(char );
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3203 char m_mailpath(char );
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3204 char m_maildir(char );
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3205 VE
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3206 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3207 My investigation provides the following description:
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3208 .BU
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3209 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	3210 .Fu path()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3211 defines the type of path given as first parameter.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3212 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	3213 Folder paths are converted to absolute folder paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3214 Folder paths must not include a leading `@' character.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3215 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	3216 The result is a pointer to newly allocated memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3217 .BU
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3218 .Fu pluspath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3219 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	3220 .Fu path() ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3221 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	3222 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	3223 An empty string parameter causes a buffer overflow.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3224 .BU
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3225 .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	3226 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	3227 The characters `+' or `@' at the beginning of the path name are
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3228 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	3229 Hence, this function can not be used for folder paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3230 In any case, the result is an absolute directory path.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3231 The result is a pointer to newly allocated memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3232 .BU
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3233 .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	3234 returns the parameter unchanged if it is an absolute directory path
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3235 or begins with the entry `.' or `..'.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3236 All other strings are prepended with the current working directory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3237 Hence, this functions can not be used for folder paths.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3238 The result is either an absolute directory path or a relative
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3239 directory path, starting with a dot.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3240 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	3241 static memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3242 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3243 The situation was obscure, irritating, error-prone, and non-orthogonal.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3244 No clear terminology was used to name the different kinds of path names.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3245 The first argument of
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3246 .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	3247 for instance, was named
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3248 .Ar folder ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3249 though
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3250 .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	3251 can not be used for MH folders.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	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 I reworked the path name conversion completely, introducing clarity.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3254 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	3255 A path name is either in the Unix domain, then it is called
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3256 \fIdirectory path\fP, `dirpath' for short, or it is in the MH domain,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3257 then it is called \fIfolder path\fP, `folpath' for short.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3258 The two terms need to be used with strict distinction.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3259 Having a clear terminology is often an indicator of having understood
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3260 the problem itself.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3261 Second, I exploited the concept of path type indicators.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3262 By requesting every path name to start with a clear type identifier,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3263 conversion between the types can be fully automated.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3264 Thus the tools can accept paths of any type from the user.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3265 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	3266 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	3267 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	3268 current message.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3269 .Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3270 Third, I created three new functions to replace the previous mess:
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3271 .BU
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3272 .Fu expandfol()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3273 converts folder paths to absolute folder paths,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3274 without the leading plus character.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3275 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	3276 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	3277 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	3278 .BU
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3279 .Fu expanddir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3280 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	3281 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	3282 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	3283 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	3284 .BU
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3285 .Fu toabsdir()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3286 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	3287 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	3288 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	3289 path name.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3290 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	3291 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3292 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	3293 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	3294 same type.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3295 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	3296 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	3297 All of the functions return pointers to static memory.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3298 All three functions are implemented in
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3299 .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	3300 .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	3301 is removed.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3302 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3303 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	3304 .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	3305 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3306 .Fu getdeffol()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3307 and
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3308 .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	3309 with
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3310 .Fu getcurfol() ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3311 which is only a convenience wrapper for
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3312 .Fu expandfol("@") .
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3313 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	3314 .Fn sbr/getfolder.c
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3315 to
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3316 .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	3317 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3318 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	3319 .Fu etcpath()
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3320 was moved to
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3321 .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	3322 too.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3323 Previously, it had been located in
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3324 .Fn config/config.c ,
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3325 for whatever reasons.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3326 .P
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3327 .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	3328 now contains all path handling code.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3329 Only 173 lines of code were needed to replace the previous 252 lines.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3330 The readability of the code is highly improved.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3331 Additionally, each of the six exported and one static functions
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3332 is introduced by an explaining comment.
edf46861132b Wrote about path conversion; Dropped the idea to write about scan listings markus schnalke <meillo@marmaro.de> parents: 133 diff changeset	3333 .Ci d39e2c447b0d163a5a63f480b23d06edb7a73aa0
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3334
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3335
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3336
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3337
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3338 .H2 "Profile Reading
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3339 .P
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3340 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	3341 MH tools read the profile right after starting up,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3342 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	3343 and similar settings that influence the whole setup.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3344 Further more, the profile contains the default switches for the tools,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3345 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	3346 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3347 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	3348 Among them were
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3349 .Pn post /\c
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3350 .Pn spost ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3351 .Pn mhmail ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3352 and
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3353 .Pn slocal .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3354 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	3355 During the discussion on the nmh-workers mailing list,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3356 .[
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3357 nmh-workers levine post profile
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3358 .]
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3359 David Levine posted an explanation, quoting John Romine:
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3360 .QS
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3361 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	3362 agrees and provides an example that convinces me:
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3363 .QS
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3364 My take on this is that
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3365 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3366 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	3367 .Fn .mh_profile
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3368 (only front-end UI programs read the profile).
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3369 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3370 For example, there can be contexts where
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3371 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3372 is called by a helper program (like `\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3373 .Pn mhmail ')
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3374 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	3375 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	3376 .QP
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3377 My suggestion would be to have
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3378 .Pn send
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3379 pass a (hidden) `\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3380 .Sw -fileproc
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3381 .Ar proc '
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3382 option to
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3383 .Pn post
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3384 if needed.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3385 You could also
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3386 use an environment variable (I think
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3387 .Pn send /\c
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3388 .Pn whatnow
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3389 do this).
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3390 .QE
164 5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3391 I think that's the way to go.
5c01017be420 Reacted to suggestions by Aaron Mueller. markus schnalke <meillo@marmaro.de> parents: 159 diff changeset	3392 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	3393 not an environment variable.
138 cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3394 .QE
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3395 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3396 To solve the problem of
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3397 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3398 not honoring the
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3399 .Pe fileproc
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3400 profile entry,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3401 the community roughly agreed that a switch
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3402 .Sw -fileproc
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3403 should be added to
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3404 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3405 to be able to pass a different fileproc.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3406 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	3407 the problem; it only removes a single symptom.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3408 The problem is that
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3409 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3410 does not behave as expected.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3411 But all programs should behave as expected.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3412 Clear and simple concepts are a precondition for this.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3413 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	3414 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3415 Yet, the problem has a further aspect.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3416 It mainly originates in
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3417 .Pn mhmail .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3418 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3419 was intended to be a replacement for
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3420 .Pn mailx
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3421 on systems with MH installations.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3422 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3423 should have been able to use just like
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3424 .Pn mailx ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3425 but sending the message via MH's
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3426 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3427 instead of
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3428 .Pn sendmail .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3429 Using
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3430 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3431 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	3432 MH set up for himself or not.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3433 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3434 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	3435 if not done yet.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3436 As
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3437 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3438 used
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3439 .Pn post ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3440 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3441 could not read the profile neither.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3442 This is the reason why
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3443 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3444 does not read the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3445 This is the reason for the actual problem.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3446 It was not much of a problem because
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3447 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3448 was not intended to be used by users directly.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3449 .Pn send
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3450 is the interactive front-end to
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3451 .Pn post .
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3452 .Pn send
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3453 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	3454 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3455 \(en an awkward solution.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3456 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3457 The important insight is that
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3458 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3459 is no true MH tool.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3460 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	3461 MH tool.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3462 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	3463 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	3464 to instruct them reading a different profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3465 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3466 could have set up a well-defined profile and caused all MH tools
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3467 in the session use it by exporting an environment variable.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3468 With this approach, no special cases would have been introduced,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3469 no surprises would have been caused.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3470 By writing a clean-profile-wrapper, the concept could have been
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3471 generalized orthogonally to the whole MH toolchest.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3472 Then Rose's motivation behind the decision that
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3473 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3474 ignores the profile, as quoted by Jeffrey Honig,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3475 .[
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3476 nmh-workers post profile
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3477 .]
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3478 would have become possible:
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3479 .QS
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3480 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	3481 what the man page says.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3482 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	3483 .QE
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3484 .LP
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3485 Yet, I consider this explanation short-sighted.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3486 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	3487 based on two different profiles.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3488 Mapping such problems on the concepts of switching between different
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3489 profiles, solves them once for all.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3490 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3491 In mmh, the wish to have
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 as as replacement for
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 is considered obsolete.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3496 Mmh's
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3497 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3498 does no longer cover this use-case.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3499 Currently,
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 is in a transition state.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3502 .Ci 32d4f9daaa70519be3072479232ff7be0500d009
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3503 It may become a front-end to
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3504 .Pn comp ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3505 which provides an interface more convenient in some cases.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3506 In this case,
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 will become an ordinary MH tool, reading the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3509 If, however, this idea will not convince, then
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3510 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3511 will be removed.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3512 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3513 Every program in the mmh toolchest reads the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3514 The only exception is
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3515 .Pn slocal ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3516 which is not considered part of the mmh toolchest.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3517 This MDA is only distributed with mmh, currently.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3518 Mmh has no
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3519 .Pn post
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3520 program, but
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3521 .Pn spost ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3522 which now reads the profile.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3523 .Ci 3e017a7abbdf69bf0dff7a4073275961eda1ded8
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3524 With this change,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3525 .Pn send
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3526 and
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3527 .Pn spost
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3528 can be considered to be merged.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3529 Direct invocations of
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3530 .Pn spost
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3531 are only done by the to-be-changed
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3532 .Pn mhmail
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3533 implementation and by
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3534 .Pn rcvdist ,
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3535 which will require rework.
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3536 .P
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3537 The
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3538 .Fu context_foil()
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3539 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	3540 .Ci 68af8da96bea87a5541988870130b6209ce396f6
cc35686f359e Wrote about profile reading. markus schnalke <meillo@marmaro.de> parents: 136 diff changeset	3541 All mmh tools read the profile.
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3542
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3543
127 4a9a97d9d6b5 Exchanged the section titles `Style' and `Code Style'. markus schnalke <meillo@marmaro.de> parents: 126 diff changeset	3544
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3545 .H2 "Standard Libraries
58 814c33b96d89 Restructured the content in ch03. markus schnalke <meillo@marmaro.de> parents: 51 diff changeset	3546 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3547 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	3548 Hence, MH included own implementations of functions
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3549 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	3550 but were not back then.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3551 Today, twenty years after the POSIX and ANSI C were published,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3552 developers can expect system to comply with these standards.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3553 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	3554 can and should be dropped.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3555 Kernighan and Pike advise: ``Use standard libraries.''
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3556 .[ [
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3557 kernighan pike practice of programming
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3558 .], p. 196]
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3559 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	3560 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	3561 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3562 .Fu snprintf()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3563 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	3564 almost everywhere because of its high usefulness.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3565 In project's own implementation of
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3566 .Fu snprintf()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3567 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	3568 standard library.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3569 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3570 Such decisions limit the portability of mmh
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3571 if systems don't support these standardized and widespread functions.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3572 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	3573 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3574 I am not yet thirty years old and my C and Unix experience comprises
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3575 only half a dozen years.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3576 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	3577 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	3578 I have not suffered from their incompatibilities.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3579 I have not longed for standardization.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3580 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	3581 were well established already.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3582 I have only read a lot of books about the (good) old times.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3583 This puts me in a difficult positions when working with old code.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3584 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	3585 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	3586 heart from their own experience.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3587 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3588 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	3589 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	3590 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	3591 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	3592 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	3593 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	3594 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	3595 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	3596 .Ci 768b5edd9623b7238e12ec8dfc409b82a1ed9e2d
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3597 .Ci 0052f1024deb0a0a2fc2e5bacf93d45a5a9c9b32 .
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	3598 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3599 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	3600 .Fn libmh.a ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3601 which is located in the
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3602 .Fn sbr
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3603 (``subroutines'') directory in the source tree.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3604 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	3605 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	3606 and folder handling, but as well
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3607 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	3608 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	3609 functions of the standard library.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3610 .P
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3611 I have replaced the
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3612 .Fu atooi()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3613 function with calls to
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3614 .Fu strtoul()
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	3615 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	3616 .Fu strtoul()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3617 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	3618 .Ci c490c51b3c0f8871b6953bd0c74551404f840a74
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3619 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3620 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	3621 .Fu memmove()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3622 and
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3623 .Fu strerror() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3624 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	3625 to support SunOS 4.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3626 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	3627 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	3628 put a load on mmh.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3629 .Ci b067ff5c465a5d243ce5a19e562085a9a1a97215
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3630 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3631 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3632 .Fu copy()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3633 function copies the string in argument one to the location in two.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3634 In contrast to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3635 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3636 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	3637 The code was adjusted to replace
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3638 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3639 with
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3640 .Fu strcpy() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3641 except within
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3642 .Fu concat() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3643 where
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3644 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3645 was more convenient.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3646 Therefore, the definition of
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3647 .Fu copy()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3648 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	3649 .Fu concat()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3650 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	3651 .Ci 552fd7253e5ee9e554c5c7a8248a6322aa4363bb
102 a782488c85f5 More text about attachments mainly, plus some rearrangements. markus schnalke <meillo@marmaro.de> parents: 101 diff changeset	3652 .P
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3653 The function
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3654 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3655 had been a generalized version of
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3656 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3657 with minor differences.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3658 As all calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3659 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3660 had the slash (`/') as delimiter anyway,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3661 replacing
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3662 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3663 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	3664 .Fu basename()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3665 became desirable.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3666 Unfortunately, many of the 54 calls to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3667 .Fu r1bindex()
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3668 depended on a special behavior,
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3669 which differed from the POSIX specification for
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3670 .Fu basename() .
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3671 Hence,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3672 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3673 was kept but renamed to
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3674 .Fu mhbasename() ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3675 fixing the delimiter to the slash.
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3676 .Ci 240013872c392fe644bd4f79382d9f5314b4ea60
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3677 For possible uses of
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3678 .Fu r1bindex()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3679 with a different delimiter,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3680 the ANSI C function
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3681 .Fu strrchr()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3682 provides the core functionality.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3683 .P
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3684 The
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3685 .Fu ssequal()
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3686 function \(en apparently for ``substring equal'' \(en
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3687 was renamed to
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3688 .Fu isprefix() ,
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3689 because this is what it actually checks.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3690 .Ci c20b4fa14515c7ab388ce35411d89a7a92300711
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3691 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	3692 .VS
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3693 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3694 * THIS CODE DOES NOT WORK AS ADVERTISED.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3695 * 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	3696 * 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	3697 * 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	3698 * should be kept if it's sufficient.
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3699 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3700
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3701 /*
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3702 * 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	3703 * 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	3704 */
edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3705 VE
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3706 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	3707 .Fu strncmp() .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3708 .Ci b0b1dd37ff515578cf7cba51625189eb34a196cb
121 edbc6e1dc636 New text on Standard Libraries plus spellchecking. markus schnalke <meillo@marmaro.de> parents: 120 diff changeset	3709
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3710
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3711
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3712
133 02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3713
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3714 .H2 "User Data Locations
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3715 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3716 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	3717 The profile is a file named
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3718 .Fn \&.mh_profile
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3719 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3720 It contains the static configuration.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3721 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	3722 .Pe Path .
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3723 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	3724 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	3725 configuration files.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3726 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	3727 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	3728 .Fn Mail
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3729 in the home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3730 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3731 The way MH data is splitted between profile and MH directory is a legacy.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3732 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	3733 configuration file.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3734 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	3735 They are different kinds of data:
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3736 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	3737 tools operate.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3738 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	3739 is bad.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3740 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	3741 as well.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3742 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	3743 in the first place, I did it now.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3744 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3745 Personal mmh data is grouped by type, resulting in two distinct parts:
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3746 The mail storage and the configuration.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3747 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	3748 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	3749 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	3750 located there.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3751 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	3752 but his \fImail storage\fP.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3753 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	3754 .Fn Mail ,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3755 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3756 In mmh, the configuration is grouped together in
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3757 the hidden directory
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3758 .Fn \&.mmh
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3759 in the user's home directory.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3760 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	3761 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	3762 .Fn profile .
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3763 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	3764 .Fn $HOME/.mh_profile
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3765 but to
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3766 .Fn $HOME/.mmh/profile .
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3767 Having both, the file
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3768 .Fn $HOME/.mh_profile
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3769 and the configuration directory
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3770 .Fn $HOME/.mmh
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3771 appeared to be inconsistent.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3772 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	3773 Unix users.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3774 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3775 MH allows users to have multiiple MH setups.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3776 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	3777 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	3778 personal MH setup.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3779 In nmh, the environment variable
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3780 .Ev MH
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3781 could be used to specifiy a different profile.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3782 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	3783 the
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3784 .Ev MHCONTEXT
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3785 environment variable could be used.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3786 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	3787 each terminal, for instance.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3788 In mmh, three environment variables are used.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3789 .Ev MMH
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3790 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	3791 .Fn .mmh ).
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3792 .Ev MMHP
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3793 and
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3794 .Ev MMHC
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3795 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	3796 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	3797 independently from the profile, context, and mail storage.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3798 .P
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3799 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	3800 The new approach has no functional disadvantages,
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3801 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	3802 possibly even easier with the new approach.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3803 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	3804 between mail storage and configuration.
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3805
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3806
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3807
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3808
02660c14f6a8 Further re-ordering of the sections. markus schnalke <meillo@marmaro.de> parents: 131 diff changeset	3809
118 48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3810 .H2 "Modularization
48e28eaee6f9 Wrote intro to Modernizing and new text about Code Style. markus schnalke <meillo@marmaro.de> parents: 116 diff changeset	3811 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3812 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	3813 .Fn uip
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3814 (``user interface programs'') directory.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3815 Each tools has a source file with the same name.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3816 For example,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3817 .Pn rmm
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3818 is built from
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3819 .Fn uip/rmm.c .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3820 Some source files are used for multiple programs.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3821 For example
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3822 .Fn uip/scansbr.c
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3823 is used for both,
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3824 .Pn scan
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3825 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3826 .Pn inc .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3827 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	3828 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	3829 32 programs depended on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3830 17 programs depended on one source file only.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3831 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	3832 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	3833 18 programs depend on multiple source files;
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3834 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	3835 (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	3836 as well as shell scripts and multiple names for the same program.)
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3837 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3838 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	3839 increase the readability of its source code.
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	3840 Most of the mmh tools, however, are simple and straight-forward programs.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3841 With the exception of the MIME handling tools,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3842 .Pn pick
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3843 is the largest tools.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3844 It contains 1\\|037 lines of source code (measured with
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3845 .Pn sloccount ), excluding the MH library.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3846 Only the MIME handling tools (\c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3847 .Pn mhbuild ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3848 .Pn mhstore ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3849 .Pn show ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3850 etc.)
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3851 are larger.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3852 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	3853 source files seldom leads to better readability.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3854 For such tools, splitting makes sense
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3855 when parts of the code are reused in other programs,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3856 and the reused code fragment is not general enough
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3857 for including it in the MH library,
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	3858 or, if the code has dependencies on a library that only few programs need.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3859 .Fn uip/packsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3860 for instance, provides the core program logic for the
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3861 .Pn packf
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3862 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3863 .Pn rcvpack
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3864 programs.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3865 .Fn uip/packf.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3866 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3867 .Fn uip/rcvpack.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3868 mainly wrap the core function appropriately.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3869 No other tools use the folder packing functions.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3870 As another example,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3871 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3872 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	3873 curses library.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3874 Including
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3875 .Fn uip/termsbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3876 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	3877 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	3878 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3879 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	3880 into multiple source files improves the readability.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3881 The program
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3882 .Pn mhstore ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3883 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	3884 lines of code in summary.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3885 The main code file
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3886 .Fn uip/mhstore.c
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3887 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	3888 other MIME handling tools.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3889 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	3890 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	3891 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	3892 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3893 The work already done, focussed on the non-MIME tools.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3894 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	3895 This eases the understanding of the code base.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3896 In nmh,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3897 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3898 was built from six source files:
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3899 .Fn comp.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3900 .Fn whatnowproc.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3901 .Fn whatnowsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3902 .Fn sendsbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3903 .Fn annosbr.c ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3904 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3905 .Fn distsbr.c .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3906 In mmh, it builds from only two:
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3907 .Fn comp.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3908 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3909 .Fn whatnowproc.c .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3910 In nmh's
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3911 .Pn comp ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3912 the core function of
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3913 .Pn whatnow ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3914 .Pn send ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3915 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3916 .Pn anno
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3917 were compiled into
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3918 .Pn comp .
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3919 This saved the need to execute these programs with
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3920 .Fu fork()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3921 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3922 .Fu exec() ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3923 two expensive system calls.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3924 Whereis this approach improved the time performance,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3925 it interweaved the source code.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3926 Core functionalities were not encapsulated into programs but into
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3927 function, which were then wrapped by programs.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3928 For example,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3929 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3930 included the function
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3931 .Fu annotate() .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3932 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	3933 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3934 and called
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3935 .Fu annotate() .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3936 Because the function
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3937 .Fu annotate()
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3938 was used like the tool
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3939 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3940 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	3941 When another pair of command line switches was added to
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3942 .Pn anno ,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3943 a rather ugly hack was implemented to avoid adding another parameter
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3944 to the function.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3945 .Ci d9b1d57351d104d7ec1a5621f090657dcce8cb7f
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3946 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3947 Separation simplifies the understanding of program code
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3948 because the area influenced by any particular statement is smaller.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3949 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	3950 on the function level.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3951 In mmh, the relevant code of
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3952 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3953 comprises the two files
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3954 .Fn uip/comp.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3955 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3956 .Fn uip/whatnowproc.c ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3957 together 210 lines of code.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3958 In nmh,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3959 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3960 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	3961 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	3962 .Pn comp ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3963 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	3964 parts were used.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3965 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3966 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	3967 I learned about the easy and the difficult parts.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3968 Code is easy to understand if:
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3969 .BU
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	3970 The influenced code area is small.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3971 .BU
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	3972 The boundaries are strictly defined.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3973 .BU
139 b7b81ae9c9d8 Removed and moved some paragraphs. markus schnalke <meillo@marmaro.de> parents: 138 diff changeset	3974 The code is written straight-forward.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3975 .P
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3976 .\" XXX move this paragraph somewhere else?
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3977 Reading
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3978 .Pn rmm 's
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3979 source code in
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3980 .Fn uip/rmm.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3981 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	3982 The reasons are that the task of
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3983 .Pn rmm
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3984 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	3985 yet its source includes code constructs typical for MH tools.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3986 With the introduction of the trash folder in mmh,
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3987 .Pn rmm
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3988 became a bit more complex, because it invokes
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3989 .Pn refile .
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3990 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	3991 .P
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3992 Understanding
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3993 .Pn comp
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3994 requires to read 210 lines of code in mmh, but ten times as much in nmh.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3995 Due to the aforementioned hack in
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3996 .Pn anno
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3997 to save the additional parameter, information passed through the program's
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	3998 source base in obscure ways.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	3999 Thus, understanding
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4000 .Pn comp ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4001 required understanding the inner workings of
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4002 .Fn uip/annosbr.c
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4003 first.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4004 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	4005 to be examined.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4006 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	4007 have avoided obscure programming techniques.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4008 By separating the tools on the program-level, the boundaries are
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4009 clearly visible and technically enforced.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4010 The interfaces are calls to
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4011 .Fu exec()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4012 rather than arbitrary function calls.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4013 .P
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4014 But the real problem is another:
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4015 Nmh violates the golden ``one tool, one job'' rule of the Unix philosophy.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4016 Understanding
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4017 .Pn comp
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4018 requires understanding
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4019 .Fn uip/annosbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4020 and
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4021 .Fn uip/sendsbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4022 because
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4023 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4024 does annotate and send messages.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4025 In nmh, there surely exists the tool
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4026 .Pn send ,
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4027 which does (almost) only send messages.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4028 But
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4029 .Pn comp
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4030 and
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4031 .Pn repl
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4032 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4033 .Pn forw
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4034 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4035 .Pn dist
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4036 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4037 .Pn whatnow
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4038 and
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4039 .Pn viamail ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4040 they all (!) have the same message sending function included, too.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4041 In result,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4042 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4043 sends messages without using
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4044 .Pn send .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4045 The situation is the same as if
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4046 .Pn grep
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4047 would page without
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4048 .Pn more
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4049 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	4050 .P
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4051 The clear separation on the surface \(en the toolchest approach \(en
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4052 is violated on the level below.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4053 This violation is for the sake of time performance.
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4054 On systems where
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4055 .Fu fork()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4056 and
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4057 .Fu exec()
c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4058 are expensive, the quicker response might be noticable.
124 3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	4059 In the old times, sacrificing readability and conceptional beauty for
3d30fd938aa9 Spellchecking. markus schnalke <meillo@marmaro.de> parents: 123 diff changeset	4060 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	4061 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	4062 No longer should we sacrifice readability or conceptional beauty.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4063 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	4064 guideline.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4065 No longer should we keep speed improvements that became unnecessary.
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4066 .P
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4067 Therefore, mmh's
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4068 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4069 does no longer send messages.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4070 In mmh, different jobs are divided among separate programs that
122 c234656329e0 Wrote about modularization. markus schnalke <meillo@marmaro.de> parents: 121 diff changeset	4071 invoke each other as needed.
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4072 In consequence,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4073 .Pn comp
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4074 invokes
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4075 .Pn whatnow
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4076 which thereafter invokes
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4077 .Pn send .
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4078 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	4079 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	4080 annotations, for example, are made by invoking
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4081 .Pn anno ,
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4082 no matter if requested by programs or by human beings.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4083 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	4084 the decrease of
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4085 .Fn uip/*sbr.c
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4086 files confirm the improvement.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4087 .P
145 3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4088 .\" XXX move this paragraph up somewhere
123 740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4089 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	4090 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	4091 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	4092 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	4093 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	4094 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	4095 These errors will not be detected at compile time but at run time.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4096 Installing regression tests is a task left to do.
740f4128dea7 Reworked and extended the text about Modularization. markus schnalke <meillo@marmaro.de> parents: 122 diff changeset	4097 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	4098 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	4099
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4100
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4101 .ig
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4102 XXX consider writing about mhl vs. mhlproc
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4103
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4104 sbr/showfile.c
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4105
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4106 23 /*
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4107 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	4108 25 ** then really invoked the mhlproc instead
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4109 26 ** (which is usually mhl anyway).
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4110 27 */
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4111
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4112 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	4113
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4114 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	4115 (Actually, user should use "lproc: show", "showproc: mhl".)
3361e53dfcd6 Added comments and a source quote. markus schnalke <meillo@marmaro.de> parents: 139 diff changeset	4116 ..

Mercurial > docs > master

annotate discussion.roff @ 164:5c01017be420