comparison discussion.roff @ 154:63e885fb48ba

Converted some internal references to the new macros.
author markus schnalke <meillo@marmaro.de>
date Fri, 06 Jul 2012 15:59:04 +0200
parents 3361e53dfcd6
children 75f20c925999
comparison
equal deleted inserted replaced
153:f3db51746c2c 154:63e885fb48ba
53 This is clearly the user interface \(en the MUA. 53 This is clearly the user interface \(en the MUA.
54 Peripheral parts should be removed to streamline mmh for the MUA task. 54 Peripheral parts should be removed to streamline mmh for the MUA task.
55 55
56 56
57 .H2 "Mail Transfer Facilities 57 .H2 "Mail Transfer Facilities
58 .Id mail-transfer-facilities
58 .P 59 .P
59 In contrast to nmh, which also provides mail submission and mail retrieval 60 In contrast to nmh, which also provides mail submission and mail retrieval
60 agents, mmh is a MUA only. 61 agents, mmh is a MUA only.
61 This general difference initiated the development of mmh. 62 This general difference initiated the development of mmh.
62 Removing the mail transfer facilities had been the first work task 63 Removing the mail transfer facilities had been the first work task
390 provides rule-based processing of messages, like filing them into 391 provides rule-based processing of messages, like filing them into
391 different folders, which is otherwise not available in mmh. 392 different folders, which is otherwise not available in mmh.
392 Although 393 Although
393 .Pn slocal 394 .Pn slocal
394 does neither pull in dependencies nor does it include a separate 395 does neither pull in dependencies nor does it include a separate
395 technical area (cf. Sec. XXX), still, 396 technical area (cf. Sec.
397 .Cf mail-transfer-facilities ),
398 still,
396 it accounts for about 1\|000 lines of code that need to be maintained. 399 it accounts for about 1\|000 lines of code that need to be maintained.
397 As 400 As
398 .Pn slocal 401 .Pn slocal
399 is almost self-standing, it should be split off into a separate project. 402 is almost self-standing, it should be split off into a separate project.
400 This would cut the strong connection between the MUA mmh and the MDA 403 This would cut the strong connection between the MUA mmh and the MDA
424 is unrelated to the rest of the project. 427 is unrelated to the rest of the project.
425 428
426 429
427 430
428 .H2 "Displaying Messages 431 .H2 "Displaying Messages
432 .id mhshow
429 .P 433 .P
430 Since the very beginning, already in the first concept paper, 434 Since the very beginning, already in the first concept paper,
431 .Pn show 435 .Pn show
432 had been MH's message display program. 436 had been MH's message display program.
433 .Pn show 437 .Pn show
542 To prepare for the transition, 546 To prepare for the transition,
543 .Pn mhshow 547 .Pn mhshow
544 was reworked to behave more like 548 was reworked to behave more like
545 .Pn show 549 .Pn show
546 first. 550 first.
547 (cf. Sec. XXX) 551 (cf. Sec.
552 .Cf mhshow )
548 Once the tools behaved more alike, the replacing appeared to be 553 Once the tools behaved more alike, the replacing appeared to be
549 even more natural. 554 even more natural.
550 Today, mmh's new 555 Today, mmh's new
551 .Pn show 556 .Pn show
552 became the one single message display program again, with the difference 557 became the one single message display program again, with the difference
683 Profile entries are the common method to change mmh's behavior. 688 Profile entries are the common method to change mmh's behavior.
684 This change did not remove the choice but moved it to a location where 689 This change did not remove the choice but moved it to a location where
685 it suited better. 690 it suited better.
686 .P 691 .P
687 Eventually, however, the new trash folder concept 692 Eventually, however, the new trash folder concept
688 .Cf "Sec. XXX 693 (cf. Sec.
694 .Cf trash-folder )
689 obsoleted the concept of the backup prefix completely. 695 obsoleted the concept of the backup prefix completely.
690 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173 696 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
691 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5 697 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
692 698
693 699
1041 At the time of writing, no more than 7 visible switches and 1 hidden switch 1047 At the time of writing, no more than 7 visible switches and 1 hidden switch
1042 have remained in mmh's 1048 have remained in mmh's
1043 .Pn send . 1049 .Pn send .
1044 (These numbers include two generic switches, help and version.) 1050 (These numbers include two generic switches, help and version.)
1045 .P 1051 .P
1046 Fig. XXX 1052 The figure displays the number of switches for each of the tools
1047 .\" XXX Ref 1053 that is available in both, nmh and mmh.
1048 displays the number of switches for each of the tools that is available
1049 in both, nmh and mmh.
1050 The tools are sorted by the number of switches they had in nmh. 1054 The tools are sorted by the number of switches they had in nmh.
1051 Visible and hidden switches were counted, 1055 Visible and hidden switches were counted,
1052 but not the generic help and version switches. 1056 but not the generic help and version switches.
1053 Whereas in the beginning of the project, the average tool had 11 switches, 1057 Whereas in the beginning of the project, the average tool had 11 switches,
1054 now it has no more than 5 \(en only half as many. 1058 now it has no more than 5 \(en only half as many.
1112 and 1116 and
1113 .Pn send 1117 .Pn send
1114 was removed. 1118 was removed.
1115 The special-casing of `the' draft message became irrelevant after 1119 The special-casing of `the' draft message became irrelevant after
1116 the rework of the draft system. 1120 the rework of the draft system.
1117 (See Sec. XXX.) 1121 (df. Sec.
1122 .Cf draft-folder )
1118 Equally, 1123 Equally,
1119 .Pn comp 1124 .Pn comp
1120 lost its 1125 lost its
1121 .Sw -file 1126 .Sw -file
1122 switch. 1127 switch.
1276 header fields. 1281 header fields.
1277 .[ 1282 .[
1278 rfc 1864 1283 rfc 1864
1279 .] 1284 .]
1280 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda 1285 .Ci 31dc797eb5178970d68962ca8939da3fd9a8efda
1281 (See Sec. XXX) 1286 (cf. Sec.
1287 .Cf content-md5 )
1282 .P 1288 .P
1283 The 1289 The
1284 .Sw -[no]ebcdicsafe 1290 .Sw -[no]ebcdicsafe
1285 and 1291 and
1286 .Sw -[no]rfc934mode 1292 .Sw -[no]rfc934mode
1418 .Sw -mbox 1424 .Sw -mbox
1419 and 1425 and
1420 .Sw -mmdf 1426 .Sw -mmdf
1421 switches. 1427 switches.
1422 .Sw -mbox 1428 .Sw -mbox
1423 is the sole behavior now. 1429 is the sole behavior now.
1424 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0 1430 .Ci 3916ab66ad5d183705ac12357621ea8661afd3c0
1425 In the same go, 1431 In the same go,
1426 .Pn packf 1432 .Pn packf
1427 and 1433 and
1428 .Pn rcvpack 1434 .Pn rcvpack
1429 were reworked (see Sec. XXX) and their 1435 were reworked and their
1430 .Sw -file 1436 .Sw -file
1431 switch became unnecessary. 1437 switch became unnecessary.
1432 .Ci ca1023716d4c2ab890696f3e41fa0d94267a940e 1438 .Ci ca1023716d4c2ab890696f3e41fa0d94267a940e
1433 1439
1434 .BU 1440 .BU
1564 Relicts from several decades have gathered in the code base, 1570 Relicts from several decades have gathered in the code base,
1565 but seldom obsolete features were dropped. 1571 but seldom obsolete features were dropped.
1566 This section describes the removing of old code 1572 This section describes the removing of old code
1567 and the modernizing of the default setup. 1573 and the modernizing of the default setup.
1568 It focuses on the functional aspect only; 1574 It focuses on the functional aspect only;
1569 the non-functional aspects of code style are discussed in 1575 the non-functional aspects of code style are discussed in Sec.
1570 .\" FIXME REF 1576 .Cf code-style .
1571 Sec. XXX.
1572 1577
1573 1578
1574 .H2 "Code Relicts 1579 .H2 "Code Relicts
1575 .P 1580 .P
1576 My position to drop obsolete functions of mmh, in order to remove old code, 1581 My position to drop obsolete functions of mmh, in order to remove old code,
1709 header field. 1714 header field.
1710 It was invented in 2005 and supports colored PNG images. 1715 It was invented in 2005 and supports colored PNG images.
1711 None of the Face systems described here is popular today. 1716 None of the Face systems described here is popular today.
1712 Hence, mmh has no direct support for them. 1717 Hence, mmh has no direct support for them.
1713 .BU 1718 .BU
1719 .Id content-md5
1714 The 1720 The
1715 .Hd Content-MD5 1721 .Hd Content-MD5
1716 header field was introduced by RFC\|1864. 1722 header field was introduced by RFC\|1864.
1717 It provides detection of data corruption during the transfer. 1723 It provides detection of data corruption during the transfer.
1718 But it can not ensure verbatim end-to-end delivery of the contents 1724 But it can not ensure verbatim end-to-end delivery of the contents
2303 2309
2304 .H2 "Draft and Trash Folder 2310 .H2 "Draft and Trash Folder
2305 .P 2311 .P
2306 2312
2307 .U3 "Draft Folder 2313 .U3 "Draft Folder
2314 .Id draft-folder
2308 .P 2315 .P
2309 In the beginning, MH had the concept of a draft message. 2316 In the beginning, MH had the concept of a draft message.
2310 This is the file 2317 This is the file
2311 .Fn draft 2318 .Fn draft
2312 in the MH directory, which is treated special. 2319 in the MH directory, which is treated special.
2414 Although my part in the draft handling improvement was small, 2421 Although my part in the draft handling improvement was small,
2415 it was an important one. 2422 it was an important one.
2416 2423
2417 2424
2418 .U3 "Trash Folder 2425 .U3 "Trash Folder
2426 .Id trash-folder
2419 .P 2427 .P
2420 Similar to the situation for drafts is the situation for removed messages. 2428 Similar to the situation for drafts is the situation for removed messages.
2421 Historically, a message was ``deleted'' by prepending a specific 2429 Historically, a message was ``deleted'' by prepending a specific
2422 \fIbackup prefix\fP, usually the comma character, 2430 \fIbackup prefix\fP, usually the comma character,
2423 to the file name. 2431 to the file name.
2687 2695
2688 2696
2689 2697
2690 2698
2691 .H2 "Code Style 2699 .H2 "Code Style
2700 .Id code-style
2692 .P 2701 .P
2693 .U3 "Indentation Style 2702 .U3 "Indentation Style
2694 .P 2703 .P
2695 Indentation styles are the holy cow of programmers. 2704 Indentation styles are the holy cow of programmers.
2696 Again Kernighan and Pike: 2705 Again Kernighan and Pike: