docs/master: discussion.roff comparison

comparison discussion.roff @ 227:157c92fc1597

Further improvements.

author	markus schnalke <meillo@marmaro.de>
date	Sun, 15 Jul 2012 23:44:15 +0200
parents	27c28990b844
children	a1468cf505fd

comparison

equal deleted inserted replaced

-:27c28990b844
+:157c92fc1597
 but introduces dependencies on external projects.
 Programs have the smallest interfaces and provide the best separation,
 but possibly limit the information exchange.
 External libraries are more strongly connected than external programs,
 thus information can be exchanged in a more flexible manner.
-Adding code to a project increases maintenance work.
+Obviously, adding code to a project increases the maintenance work.
 As implementing complex functions in the project itself adds
 a lot of code, this should be avoided if possible.
 Thus, the dependencies only change in their character,
 not in their existence.
 In mmh, library dependencies on
 .H2 "Displaying Messages
 .Id mhshow
 .P
 Since the very beginning, already in the first concept paper,
+.[
+original memo rand mh shapiro gaines
+.]
 .Pn show
 had been MH's message display program.
 .Pn show
 mapped message numbers and sequences to files and invoked
 .Pn mhl
 I have reduced the number of project-specific configure options from
 15 to 3.
 .U3 "Mail Transfer Facilities
 .P
-With the removal of the mail transfer facilities 5 configure
+With the removal of the mail transfer facilities (cf. Sec.
-options vanished:
+.Cf mail-transfer-facilities )
+five configure options vanished:
 .P
 The switches
 .Sw --with-tls
 and
 .Sw --with-cyrus-sasl
 had activated the support for transfer encryption and authentication.
-.\" XXX cf
-.\" XXX gruende kurz wiederholen
 They are not needed anymore.
 .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
 .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
 .P
-.\" XXX cf
-.\" XXX ``For the same reason ...''
 The configure switch
 .Sw --enable-pop
-activated the message retrieval facility.
+had activated the message retrieval facility.
 Whereas the code area that had been conditionally compiled in
 for TLS and SASL support was small,
 the conditionally compiled code area for POP support was much larger.
 The code base had only changed slightly on toggling TLS or SASL
 support but it had changed much on toggling POP support.
 code, but there the changes are minor and can yet be overviewed.
 Still, conditional compilation of a code base creates variations
 of the original program.
 More variations require more testing and maintenance work.
 .P
-Two other options only specified default configuration values:
+Two other options had only specified default configuration values:
 .Sw --with-mts
 defined the default transport service
 .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226 .
 With
 .Sw --with-smtpservers
-default SMTP servers could be specified
+default SMTP servers could be set
 .Ci 128545e06224233b7e91fc4c83f8830252fe16c9 .
 Both of them became irrelevant when the SMTP transport service was removed.
 In mmh, all messages are handed over to
 .Pn sendmail
 for transportation.
 .Ci 8edc5aaf86f9f77124664f6801bc6c6cdf258173
 .Ci ca0b3e830b86700d9e5e31b1784de2bdcaf58fc5
 .U3 "Editor and Pager
+.Id editor-pager
 .P
 The two configure options
 .CW --with-editor=EDITOR
 .CW --with-pager=PAGER
 were used to specify the default editor and pager at configure time.
 .H2 "Command Line Switches
 .P
-The command line switches of MH tools follow a style similar to
+The command line switches of MH tools are similar in style to the
-the X Window System style.
+switches in the X Window System.
-The switches consist of a single dash (`\fL-\fP') followed by a word.
+They consist of a single dash (`\fL-\fP') followed by a word.
 For example
 .Cl -truncate .
 To ease typing, the word can be abbreviated, given the remaining
 prefix is unambiguous.
 If no other switch starts with the letter `t', then any of
 .U3 "Draft Folder Facility
 .P
 A change early in the project was the complete transition from
 the single draft message to the draft folder facility
-.Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
+.Ci 337338b404931f06f0db2119c9e145e8ca5a9860
-.\" XXX ref to section ...
+(cf. Sec.
+.Cf draft-folder ).
 The draft folder facility was introduced in the mid-eighties, when
 Rose and Romine called it a ``relatively new feature''.
 .[
 rose romine real work
 .]
 was removed.
 The special treatment of \fIthe\fP draft message became irrelevant after
 the rework of the draft system
 (cf. Sec.
 .Cf draft-folder ).
-Furthermore,
-.Pn comp
-no longer needs a
-.Sw -file
-switch as the draft folder facility together with the
-.Sw -form
-switch are sufficient.
 .U3 "In Place Editing
 .P
 .Pn anno
 .Sw -[no]bell
 .Ci e11983f44e59d8de236affa5b0d0d3067c192e24 )
 nor does it page the output itself (\c
 .Sw -length
 .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ).
-.\" XXX Ref
 Generally, the pager to use is no longer specified with the
 .Sw -[no]moreproc
 command line switches for
 .Pn mhl
 and
 header field was introduced by RFC\|1864.
 It provides detection of data corruption during the transfer.
 But it can not ensure verbatim end-to-end delivery of the contents
 [RFC\|1864].
 The proper approach to verify content integrity in an
-end-to-end relationship is the use of digital signatures.
+end-to-end relationship is the use of digital signatures [RFC\|4880].
-.\" XXX (RFCs FIXME).
 On the other hand, transfer protocols should detect corruption during
 the transmission.
 The TCP includes a checksum field therefore.
 These two approaches in combinations render the
 .Hd Content-MD5
 There is no `mime' command at the WhatNow prompt anymore.
 The draft will be converted automatically to MIME when either an
 attachment header or non-ASCII text is present.
 Furthermore, the hash character (`\fL#\fP') is not special any more
 at line beginnings in the draft message.
-.\" XXX REF ?
 Users need not concern themselves with the whole topic at all.
 .P
 Although the new approach does not anymore support arbitrary MIME
 compositions directly, the full power of
 .Pn mhbuild
 .Ci 94c80042eae3383c812d9552089953f9846b1bb6 .
 .U3 "Showing MIME Messages
+.Id showing-mime-msgs
 .P
 The program
 .Pn mhshow
 was written to display MIME messages.
 It implemented the conceptional view of the MIME RFCs.
 behavior to the modern view on the topic.
 .P
 One should note that this section completely ignores the original
 .Pn show
 program, because it was not capable to display MIME messages
-and is no longer part of mmh.
+and is no longer part of mmh
-.\" XXX ref to other section
+(cf. Sec.
+.Cf mhshow ).
 Although
 .Pn mhshow
 was renamed to
 .Pn show
 in mmh, this section uses the name
 .Pn mhl
 is to format messages or parts of them.
 The only place in mmh, where a pager is invoked is
 .Pn mhshow .
 .P
-In the intended setup, only text content is be displayed,
+Only text content is displayed.
-in a single pager session.
+Other kinds of attachments are ignored.
 Non-text content needs to be converted to text by appropriate
 .Pe mhshow-show-*
 profile entries before, if this is possible and wanted.
 A common example for this are PDF files.
-In mmh, MIME parts are always displayed serially.
+.P
+MIME parts are always displayed serially.
 The request to display the MIME type `multipart/parallel' in parallel
 is ignored.
 It is simply treated as `multipart/mixed'
 .Ci d0581ba306a7299113a346f9b4c46ce97bc4cef6 .
 This was already possible to requested with the, now removed,
 As MIME parts are always processed exclusively, i.e. serially,
 the `\fL%e\fP' escape in
 .Pe mhshow-show-*
 profile entries became useless and was thus removed
 .Ci a20d405db09b7ccca74d3e8c57550883da49e1ae .
-.P
-Other kinds of attachments are ignored.
-With
-.Pe mhshow-show-*
-profile entries for them, they can be displayed serially along
-the message.
 For parallel display, the attachments need to be stored to disk first.
 .P
 To display text content in foreign charsets, they need to be converted
 to the native charset.
 Therefore,
 could not be used with MH folder arguments.
 .P
 I clarified the path name conversion by complete rework.
 First of all, the terminology needed to be defined.
 A path name is either in the Unix domain, then it is called
-\fIdirectory path\fP (\fIdirpath\fP for short) or it is in the MH domain,
+\fIdirectory path\fP or it is in the MH domain,
-then it is called \fIfolder path\fP (\fIfolpath\fP for short).
+then it is called \fIfolder path\fP.
 The two terms need to be used with strict distinction.
-Often a clear terminology indicates that the problem is understood.
 Second, I exploited the concept of path type indicators.
 By requiring every path name to start with a distinct type identifier,
 the conversion between the types could be fully automated.
-This allows the tools to accept paths of any type from the user.
+This allows the tools to accept path names of any type from the user.
 Therefore, it was necessary to require relative directory paths to be
 prefixed with a dot character.
 In consequence, the dot character could no longer be an alias for the
-current message.
+current message
-.Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01
+.Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01 .
 Third, I created three new functions to replace the previous mess:
 .LI 1
 .Fu expandfol()
 converts folder paths to absolute folder paths.
 Directory paths are simply passed through.

Mercurial > docs > master

comparison discussion.roff @ 227:157c92fc1597