docs/master

changeset 82:ff4537327162

Mayor rework: Replaced .DS with .VS, a better verbatim environment. VS is no Keep. By translating characters in the typewriter fonts, we don't need to escape the minus, backtick and single quote characters.
author markus schnalke <meillo@marmaro.de>
date Wed, 06 Jun 2012 17:58:09 +0200
parents 5fb821ed6f3c
children 99ab58dc891f
files ch01.roff ch03.roff style
diffstat 3 files changed, 75 insertions(+), 42 deletions(-) [+]
line diff
     1.1 --- a/ch01.roff	Wed Jun 06 14:53:16 2012 +0200
     1.2 +++ b/ch01.roff	Wed Jun 06 17:58:09 2012 +0200
     1.3 @@ -128,42 +128,42 @@
     1.4  Following is an example mail handling session.
     1.5  It uses mmh but is mostly compatible with nmh and old MH.
     1.6  Details might vary but the look'n'feel is the same.
     1.7 -.DS
     1.8 -$ \f(CBinc\fP
     1.9 +.VS
    1.10 +$ f(CBincfP
    1.11  Incorporating new mail into inbox...
    1.12 -	
    1.13 +
    1.14     1+ 2012-05-16 11:16  meillo@dream.home  Hello
    1.15     2  2012-05-16 11:17  meillo@dream.home  book
    1.16 -	
    1.17 -$ \f(CBshow\fP
    1.18 +
    1.19 +$ f(CBshowfP
    1.20  Date:    Wed, 16 May 2012 11:16:00 +0200
    1.21  To:      meillo
    1.22  From:    <meillo@dream.home.schnalke.org>
    1.23  Subject: Hello
    1.24 -	
    1.25 +
    1.26  part       text/plain                  13
    1.27  mmh is great
    1.28 -	
    1.29 -$ \f(CBnext\fP
    1.30 +
    1.31 +$ f(CBnextfP
    1.32  Date:    Wed, 16 May 2012 11:17:24 +0200
    1.33  To:      meillo
    1.34  From:    <meillo@dream.home.schnalke.org>
    1.35  Subject: book
    1.36 -	
    1.37 +
    1.38  part       text/plain                  79
    1.39  Hello meillo,
    1.40 -	
    1.41 +
    1.42  have a look at the ``Daemon book''. You need to read that!
    1.43 -	
    1.44 +
    1.45  foo
    1.46 -	
    1.47 -$ \f(CBrmm 1\fP
    1.48 -	
    1.49 -$ \f(CBscan\fP
    1.50 +
    1.51 +$ f(CBrmm 1fP
    1.52 +
    1.53 +$ f(CBscanfP
    1.54     2+ 2012-05-16 11:17  meillo@dream.home  book
    1.55 -	
    1.56 +
    1.57  $
    1.58 -.DE
    1.59 +VE
    1.60  
    1.61  
    1.62  .H1 "nmh: Code and Community
     2.1 --- a/ch03.roff	Wed Jun 06 14:53:16 2012 +0200
     2.2 +++ b/ch03.roff	Wed Jun 06 17:58:09 2012 +0200
     2.3 @@ -223,9 +223,9 @@
     2.4  If though one wants to have it this way, the standard tool
     2.5  .Pn write
     2.6  can be used in a way similar to:
     2.7 -.DS
     2.8 +.VS
     2.9  scan -file - | write `id -un`
    2.10 -.DE
    2.11 +VE
    2.12  .BU
    2.13  .Pn viamail
    2.14  was removed when the new attachment system was activated, because
    2.15 @@ -244,9 +244,9 @@
    2.16  A call to
    2.17  .Pn msgchk
    2.18  provided hardly more information than
    2.19 -.DS
    2.20 +.VS
    2.21  ls -l /var/mail/meillo
    2.22 -.DE
    2.23 +VE
    2.24  though it distinguished between old and new mail.
    2.25  This detail information and can be retrieved with
    2.26  .Pn stat (1),
    2.27 @@ -370,7 +370,7 @@
    2.28  First, the new MIME features were added in form of the single program
    2.29  .Pn mhn .
    2.30  The command
    2.31 -.Cl "mhn \-show 42
    2.32 +.Cl "mhn -show 42
    2.33  would show the MIME message numbered 42.
    2.34  With the 1.0 release of nmh in February 1999, Richard Coleman finished
    2.35  the split of
    2.36 @@ -379,7 +379,7 @@
    2.37  multiple aspects of MIME. One of these resulting tools was
    2.38  .Pn mhshow ,
    2.39  which replaced the
    2.40 -.Cl "mhn \-show
    2.41 +.Cl "mhn -show
    2.42  call.
    2.43  It was capable to display a MIME message appropriately.
    2.44  .P
    2.45 @@ -920,7 +920,7 @@
    2.46  .Pn mhl )
    2.47  and the terminal. This could have been ensured with
    2.48  the
    2.49 -.Sw \-nomoreproc
    2.50 +.Sw -nomoreproc
    2.51  at the command line statically, too.
    2.52  
    2.53  .U2 "Removed support for header fields
    2.54 @@ -971,18 +971,18 @@
    2.55  queries the user to fill in a message form. When used by
    2.56  .Pn comp
    2.57  as:
    2.58 -.DS
    2.59 -comp \-editor prompter
    2.60 -.DE
    2.61 +.VS
    2.62 +comp -editor prompter
    2.63 +VE
    2.64  the resulting behavior is similar to
    2.65  .Pn mailx .
    2.66  Apparently,
    2.67  .Pn prompter
    2.68  hadn't been touched lately. Otherwise it's hardly explainable why it
    2.69  still offered the switches
    2.70 -.Sn \-erase \fUchr\fP
    2.71 +.Sw "-erase \f(CIchr\fP
    2.72  and
    2.73 -.Sn \-kill \fUchr\fP
    2.74 +.Sw "-kill \f(CIchr\fP
    2.75  to name the characters for command line editing.
    2.76  The times when this had been necessary are long time gone.
    2.77  Today these things work out-of-the-box, and if not, are configured
    2.78 @@ -1225,19 +1225,19 @@
    2.79  the name
    2.80  .Fn +drafts .
    2.81  This made the
    2.82 -.Sw \-draftfolder
    2.83 +.Sw -draftfolder
    2.84  and
    2.85 -.Sw \-draftmessage
    2.86 +.Sw -draftmessage
    2.87  switches useless, and I could remove them.
    2.88  The more difficult but also the part that showed the real improvement,
    2.89  was updating the tools to the new concept.
    2.90 -.Sw \-draft
    2.91 +.Sw -draft
    2.92  switches could
    2.93  be dropped, as operating on a draft message became indistinguishable to
    2.94  operating on any other message for the tools.
    2.95  .Pn comp
    2.96  still has its
    2.97 -.Sw \-use
    2.98 +.Sw -use
    2.99  switch for switching between its two modes: (1) Compose a new
   2.100  draft, possibly by taking some existing message as a form. (2) Modify
   2.101  an existing draft. In either case, the behavior of
   2.102 @@ -1268,9 +1268,9 @@
   2.103  are treated as messages. The removed messages remained as files in the
   2.104  same directory and needed some maintenance job to truly delete them after
   2.105  some grace time. Usually, by running a command similar to
   2.106 -.DS
   2.107 -find /home/user/Mail \-ctime +7 \-name ',*' | xargs rm
   2.108 -.DE
   2.109 +.VS
   2.110 +find /home/user/Mail -ctime +7 -name ',*' | xargs rm
   2.111 +VE
   2.112  in a cron job. Within the grace time interval
   2.113  the original message could be restored by stripping the
   2.114  the backup prefix from the file name. If however, the last message of
   2.115 @@ -1335,9 +1335,9 @@
   2.116  by default). Messages
   2.117  there can be operated on like on any other message in the storage.
   2.118  The sweep clean, one can use
   2.119 -.Cl "rmm \-unlink +trash a" ,
   2.120 +.Cl "rmm -unlink +trash a" ,
   2.121  where the
   2.122 -.Sw \-unlink
   2.123 +.Sw -unlink
   2.124  switch causes the files to be truly unliked instead
   2.125  of moved to the trash folder.
   2.126  
     3.1 --- a/style	Wed Jun 06 14:53:16 2012 +0200
     3.2 +++ b/style	Wed Jun 06 17:58:09 2012 +0200
     3.3 @@ -17,10 +17,10 @@
     3.4  .fp 0 CI TerminusMediumItalic-4.36 ttf
     3.5  .fp 0 CB TerminusBold-4.36 ttf
     3.6  .fp 0 L TerminusMedium-4.36 ttf
     3.7 -.ftr CW -\-
     3.8 -.ftr CI -\-
     3.9 -.ftr CB -\-
    3.10 -.ftr L -\-
    3.11 +.ftr CW -\-`\`'\'
    3.12 +.ftr CI -\-`\`'\'
    3.13 +.ftr CB -\-`\`'\'
    3.14 +.ftr L -\-`\`'\'
    3.15  .fp 0 SC LinLibertine_R otf
    3.16  .feature SC +onum +smcp
    3.17  .fp 0 IC LinLibertine_RI otf
    3.18 @@ -280,6 +280,39 @@
    3.19  .ta T 8n
    3.20  ..
    3.21  
    3.22 +.	\" VS - verbatim text start (\\ -> ^G; ' -> disabled; . -> ^B)
    3.23 +.de VS
    3.24 +.br
    3.25 +.ne 4
    3.26 +.sp \n(DDu
    3.27 +.if t .in +.5i
    3.28 +.if n .in +8n
    3.29 +.nf
    3.30 +.ft CW
    3.31 +.\" ps -1
    3.32 +.ta T 8n
    3.33 +.\" set up verbatim environment
    3.34 +\.blm
    3.35 +\.ec 
    3.36 +\.c2 ""
    3.37 +\.cc 
    3.38 +..
    3.39 +
    3.40 +.	\" VE - verbatim text end  (NOTE: Needs to be called as ^BVE !)
    3.41 +.de VE
    3.42 +\" restore the special characters
    3.43 +cc
    3.44 +.c2
    3.45 +.ec
    3.46 +.blm __
    3.47 +.if t .in -.5i
    3.48 +.if n .in -8n
    3.49 +.sp \n(DDu
    3.50 +.ft P
    3.51 +.fi
    3.52 +.TA
    3.53 +..
    3.54 +
    3.55  .	\" FA - XXX somehow related to footnotes?
    3.56  .am FA
    3.57  .ps 8