docs/master

changeset 227:157c92fc1597

Further improvements.
author markus schnalke <meillo@marmaro.de>
date Sun, 15 Jul 2012 23:44:15 +0200
parents 27c28990b844
children a1468cf505fd
files discussion.roff intro.roff refs.roff web.bib
diffstat 4 files changed, 63 insertions(+), 49 deletions(-) [+]
line diff
     1.1 --- a/discussion.roff	Sun Jul 15 21:57:51 2012 +0200
     1.2 +++ b/discussion.roff	Sun Jul 15 23:44:15 2012 +0200
     1.3 @@ -263,7 +263,7 @@
     1.4  but possibly limit the information exchange.
     1.5  External libraries are more strongly connected than external programs,
     1.6  thus information can be exchanged in a more flexible manner.
     1.7 -Adding code to a project increases maintenance work.
     1.8 +Obviously, adding code to a project increases the maintenance work.
     1.9  As implementing complex functions in the project itself adds
    1.10  a lot of code, this should be avoided if possible.
    1.11  Thus, the dependencies only change in their character,
    1.12 @@ -458,6 +458,9 @@
    1.13  .Id mhshow
    1.14  .P
    1.15  Since the very beginning, already in the first concept paper,
    1.16 +.[
    1.17 +original memo rand mh shapiro gaines
    1.18 +.]
    1.19  .Pn show
    1.20  had been MH's message display program.
    1.21  .Pn show
    1.22 @@ -627,25 +630,22 @@
    1.23  
    1.24  .U3 "Mail Transfer Facilities
    1.25  .P
    1.26 -With the removal of the mail transfer facilities 5 configure
    1.27 -options vanished:
    1.28 +With the removal of the mail transfer facilities (cf. Sec.
    1.29 +.Cf mail-transfer-facilities )
    1.30 +five configure options vanished:
    1.31  .P
    1.32  The switches
    1.33  .Sw --with-tls
    1.34  and
    1.35  .Sw --with-cyrus-sasl
    1.36  had activated the support for transfer encryption and authentication.
    1.37 -.\" XXX cf
    1.38 -.\" XXX gruende kurz wiederholen
    1.39  They are not needed anymore.
    1.40  .Ci fecd5d34f65597a4dfa16aeabea7d74b191532c3
    1.41  .Ci 156d35f6425bea4c1ed3c4c79783dc613379c65b
    1.42  .P
    1.43 -.\" XXX cf
    1.44 -.\" XXX ``For the same reason ...''
    1.45  The configure switch
    1.46  .Sw --enable-pop
    1.47 -activated the message retrieval facility.
    1.48 +had activated the message retrieval facility.
    1.49  Whereas the code area that had been conditionally compiled in
    1.50  for TLS and SASL support was small,
    1.51  the conditionally compiled code area for POP support was much larger.
    1.52 @@ -660,13 +660,13 @@
    1.53  of the original program.
    1.54  More variations require more testing and maintenance work.
    1.55  .P
    1.56 -Two other options only specified default configuration values:
    1.57 +Two other options had only specified default configuration values:
    1.58  .Sw --with-mts
    1.59  defined the default transport service
    1.60  .Ci f6aa95b724fd8c791164abe7ee5468bf5c34f226 .
    1.61  With
    1.62  .Sw --with-smtpservers
    1.63 -default SMTP servers could be specified
    1.64 +default SMTP servers could be set
    1.65  .Ci 128545e06224233b7e91fc4c83f8830252fe16c9 .
    1.66  Both of them became irrelevant when the SMTP transport service was removed.
    1.67  In mmh, all messages are handed over to
    1.68 @@ -714,6 +714,7 @@
    1.69  
    1.70  
    1.71  .U3 "Editor and Pager
    1.72 +.Id editor-pager
    1.73  .P
    1.74  The two configure options
    1.75  .CW --with-editor=EDITOR
    1.76 @@ -993,9 +994,9 @@
    1.77  
    1.78  .H2 "Command Line Switches
    1.79  .P
    1.80 -The command line switches of MH tools follow a style similar to
    1.81 -the X Window System style.
    1.82 -The switches consist of a single dash (`\fL-\fP') followed by a word.
    1.83 +The command line switches of MH tools are similar in style to the
    1.84 +switches in the X Window System.
    1.85 +They consist of a single dash (`\fL-\fP') followed by a word.
    1.86  For example
    1.87  .Cl -truncate .
    1.88  To ease typing, the word can be abbreviated, given the remaining
    1.89 @@ -1136,8 +1137,9 @@
    1.90  .P
    1.91  A change early in the project was the complete transition from
    1.92  the single draft message to the draft folder facility
    1.93 -.Ci 337338b404931f06f0db2119c9e145e8ca5a9860 .
    1.94 -.\" XXX ref to section ...
    1.95 +.Ci 337338b404931f06f0db2119c9e145e8ca5a9860
    1.96 +(cf. Sec.
    1.97 +.Cf draft-folder ).
    1.98  The draft folder facility was introduced in the mid-eighties, when
    1.99  Rose and Romine called it a ``relatively new feature''.
   1.100  .[
   1.101 @@ -1172,13 +1174,6 @@
   1.102  the rework of the draft system
   1.103  (cf. Sec.
   1.104  .Cf draft-folder ).
   1.105 -Furthermore,
   1.106 -.Pn comp
   1.107 -no longer needs a
   1.108 -.Sw -file
   1.109 -switch as the draft folder facility together with the
   1.110 -.Sw -form
   1.111 -switch are sufficient.
   1.112  
   1.113  
   1.114  .U3 "In Place Editing
   1.115 @@ -1509,7 +1504,6 @@
   1.116  nor does it page the output itself (\c
   1.117  .Sw -length
   1.118  .Ci 5b9d883db0318ed2b84bb82dee880d7381f99188 ).
   1.119 -.\" XXX Ref
   1.120  Generally, the pager to use is no longer specified with the
   1.121  .Sw -[no]moreproc
   1.122  command line switches for
   1.123 @@ -1746,8 +1740,7 @@
   1.124  But it can not ensure verbatim end-to-end delivery of the contents
   1.125  [RFC\|1864].
   1.126  The proper approach to verify content integrity in an
   1.127 -end-to-end relationship is the use of digital signatures.
   1.128 -.\" XXX (RFCs FIXME).
   1.129 +end-to-end relationship is the use of digital signatures [RFC\|4880].
   1.130  On the other hand, transfer protocols should detect corruption during
   1.131  the transmission.
   1.132  The TCP includes a checksum field therefore.
   1.133 @@ -1990,7 +1983,6 @@
   1.134  attachment header or non-ASCII text is present.
   1.135  Furthermore, the hash character (`\fL#\fP') is not special any more
   1.136  at line beginnings in the draft message.
   1.137 -.\" XXX REF ?
   1.138  Users need not concern themselves with the whole topic at all.
   1.139  .P
   1.140  Although the new approach does not anymore support arbitrary MIME
   1.141 @@ -2181,6 +2173,7 @@
   1.142  
   1.143  
   1.144  .U3 "Showing MIME Messages
   1.145 +.Id showing-mime-msgs
   1.146  .P
   1.147  The program
   1.148  .Pn mhshow
   1.149 @@ -2203,8 +2196,9 @@
   1.150  One should note that this section completely ignores the original
   1.151  .Pn show
   1.152  program, because it was not capable to display MIME messages
   1.153 -and is no longer part of mmh.
   1.154 -.\" XXX ref to other section
   1.155 +and is no longer part of mmh
   1.156 +(cf. Sec.
   1.157 +.Cf mhshow ).
   1.158  Although
   1.159  .Pn mhshow
   1.160  was renamed to
   1.161 @@ -2242,13 +2236,14 @@
   1.162  The only place in mmh, where a pager is invoked is
   1.163  .Pn mhshow .
   1.164  .P
   1.165 -In the intended setup, only text content is be displayed,
   1.166 -in a single pager session.
   1.167 +Only text content is displayed.
   1.168 +Other kinds of attachments are ignored.
   1.169  Non-text content needs to be converted to text by appropriate
   1.170  .Pe mhshow-show-*
   1.171  profile entries before, if this is possible and wanted.
   1.172  A common example for this are PDF files.
   1.173 -In mmh, MIME parts are always displayed serially.
   1.174 +.P
   1.175 +MIME parts are always displayed serially.
   1.176  The request to display the MIME type `multipart/parallel' in parallel
   1.177  is ignored.
   1.178  It is simply treated as `multipart/mixed'
   1.179 @@ -2262,12 +2257,6 @@
   1.180  .Pe mhshow-show-*
   1.181  profile entries became useless and was thus removed
   1.182  .Ci a20d405db09b7ccca74d3e8c57550883da49e1ae .
   1.183 -.P
   1.184 -Other kinds of attachments are ignored.
   1.185 -With
   1.186 -.Pe mhshow-show-*
   1.187 -profile entries for them, they can be displayed serially along
   1.188 -the message.
   1.189  For parallel display, the attachments need to be stored to disk first.
   1.190  .P
   1.191  To display text content in foreign charsets, they need to be converted
   1.192 @@ -3243,19 +3232,18 @@
   1.193  I clarified the path name conversion by complete rework.
   1.194  First of all, the terminology needed to be defined.
   1.195  A path name is either in the Unix domain, then it is called
   1.196 -\fIdirectory path\fP (\fIdirpath\fP for short) or it is in the MH domain,
   1.197 -then it is called \fIfolder path\fP (\fIfolpath\fP for short).
   1.198 +\fIdirectory path\fP or it is in the MH domain,
   1.199 +then it is called \fIfolder path\fP.
   1.200  The two terms need to be used with strict distinction.
   1.201 -Often a clear terminology indicates that the problem is understood.
   1.202  Second, I exploited the concept of path type indicators.
   1.203  By requiring every path name to start with a distinct type identifier,
   1.204  the conversion between the types could be fully automated.
   1.205 -This allows the tools to accept paths of any type from the user.
   1.206 +This allows the tools to accept path names of any type from the user.
   1.207  Therefore, it was necessary to require relative directory paths to be
   1.208  prefixed with a dot character.
   1.209  In consequence, the dot character could no longer be an alias for the
   1.210 -current message.
   1.211 -.Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01
   1.212 +current message
   1.213 +.Ci cff0e16925e7edbd25b8b9d6d4fbdf03e0e60c01 .
   1.214  Third, I created three new functions to replace the previous mess:
   1.215  .LI 1
   1.216  .Fu expandfol()
     2.1 --- a/intro.roff	Sun Jul 15 21:57:51 2012 +0200
     2.2 +++ b/intro.roff	Sun Jul 15 23:44:15 2012 +0200
     2.3 @@ -3,15 +3,17 @@
     2.4  .Id introduction
     2.5  
     2.6  .P
     2.7 -MH is a set of mail handling tools with a common concept, similar to
     2.8 -the Unix tool chest, which is a set of file handling tools with a common
     2.9 -concept. \fInmh\fP is the currently most popular implementation of an
    2.10 +MH is a set of mail handling tools with a common concept.
    2.11 +It is similar to the Unix tool chest, which is a set of file
    2.12 +handling tools with a common concept.
    2.13 +\fInmh\fP is the currently most popular implementation of an
    2.14  MH-like mail handling system.
    2.15  This thesis describes an experimental version of nmh, named \fImmh\fP.
    2.16  .P
    2.17  This chapter introduces MH, its history, concepts and how it is used.
    2.18  It describes nmh's code base and community to give the reader
    2.19 -a better understanding of the state of mmh when it started off.
    2.20 +a better understanding of the project's condition at the time when
    2.21 +mmh started off.
    2.22  Furthermore, this chapter outlines the mmh project itself,
    2.23  describing the motivation for it and its goals.
    2.24  
    2.25 @@ -271,8 +273,15 @@
    2.26  This project model was inspired by \fIdwm\fP,
    2.27  which is Anselm Garbe's personal window manager \(en
    2.28  targeted to satisfy Garbe's personal needs whenever conflicts appear.
    2.29 -Dwm has retained its lean elegance and its focused character, whereas
    2.30 -its community-driven predecessor \fIwmii\fP had grown fat over time.
    2.31 +Dwm has retained its lean elegance and its focused character,
    2.32 +.[
    2.33 +dwm ohloh
    2.34 +.]
    2.35 +whereas its community-driven predecessor \fIwmii\fP had grown
    2.36 +fat over time.
    2.37 +.[
    2.38 +wmii ohloh
    2.39 +.]
    2.40  The development of mmh should remain focused.
    2.41  
    2.42  
    2.43 @@ -285,6 +294,9 @@
    2.44  on top of the tool chest quickly and without internal knowledge.
    2.45  Additionally, tool chests are easier to maintain than monolithic
    2.46  programs.
    2.47 +.[ [
    2.48 +gancarz unix phil
    2.49 +.], p. 14]
    2.50  MH-like email tool chests should be kept alive as they fill a market
    2.51  niche by providing conceptional elegance and unique scripting qualities.
    2.52  Mmh tries to create a modern and convenient entry point to MH-like
     3.1 --- a/refs.roff	Sun Jul 15 21:57:51 2012 +0200
     3.2 +++ b/refs.roff	Sun Jul 15 23:44:15 2012 +0200
     3.3 @@ -17,6 +17,10 @@
     3.4  .I "Standard for the Format of ARPA Internet Text Messages",
     3.5  August 1982.
     3.6  
     3.7 +.IP RFC\|934
     3.8 +.I "Proposed Standard for Message Encapsulation",
     3.9 +January 1985.
    3.10 +
    3.11  .IP RFC\|1864
    3.12  .I "The Content-MD5 Header Field",
    3.13  October 1995.
     4.1 --- a/web.bib	Sun Jul 15 21:57:51 2012 +0200
     4.2 +++ b/web.bib	Sun Jul 15 23:44:15 2012 +0200
     4.3 @@ -38,3 +38,13 @@
     4.4  %T History of MH
     4.5  %O \fU http://rand-mh.sourceforge.net/book/overall/hiofmh.html
     4.6  %K website
     4.7 +
     4.8 +%L web:\|sloc-dwm
     4.9 +%T dwm: Lines of Code Through Time
    4.10 +%I Ohloh
    4.11 +%O \fU http://\:www.ohloh.net/\:p/\:dwm/\:analyses/\:latest/\:languages_summary
    4.12 +
    4.13 +%L web:\|sloc-wmii
    4.14 +%T wmii: Lines of Code Through Time
    4.15 +%I Ohloh
    4.16 +%O \fU http://\:www.ohloh.net/\:p/\:wmii/\:analyses/\:latest/\:languages_summary