git.marmaro.de Git - mmh/blob - docs/historical/mh-6.8.5/conf/doc/RCS/burst.rf,v

   1 head     1.5;
   2 branch   ;
   3 access   ;
   4 symbols  ;
   5 locks    ; strict;
   6 comment  @@;
   7
   8
   9 1.5
  10 date     90.04.05.15.12.10;  author sources;  state Exp;
  11 branches ;
  12 next     1.4;
  13
  14 1.4
  15 date     90.03.22.11.31.00;  author sources;  state Exp;
  16 branches ;
  17 next     1.3;
  18
  19 1.3
  20 date     90.03.20.19.41.36;  author sources;  state Exp;
  21 branches ;
  22 next     1.2;
  23
  24 1.2
  25 date     90.03.20.17.35.54;  author sources;  state Exp;
  26 branches ;
  27 next     1.1;
  28
  29 1.1
  30 date     90.03.20.17.20.43;  author sources;  state Exp;
  31 branches ;
  32 next     ;
  33
  34
  35 desc
  36 @@
  37
  38
  39 1.5
  40 log
  41 @add ID
  42 @
  43 text
  44 @.\"    @@(MHWARNING)
  45 .\" @@(#)$Id:$
  46 .SC BURST 1
  47 .NA
  48 burst \- explode digests into messages
  49 .SY
  50 burst
  51 \%[+folder] \%[msgs]
  52 \%[\-inplace] \%[\-noinplace]
  53 \%[\-quiet] \%[\-noquiet]
  54 \%[\-verbose] \%[\-noverbose]
  55 \%[\-help]
  56 .DE
  57 \fIBurst\fR considers the specified messages in the named folder to be
  58 Internet digests, and explodes them in that folder.
  59
  60 If `\-inplace' is given,
  61 each digest is replaced by the \*(lqtable of contents\*(rq for the digest
  62 (the original digest is removed).
  63 \fIBurst\fR then renumbers all of the messages following the digest in the
  64 folder to make room for each of the messages contained within the digest.
  65 These messages are placed immediately after the digest.
  66
  67 If `\-noinplace' is given,
  68 each digest is preserved,
  69 no table of contents is produced,
  70 and the messages contained within the digest are placed at the end of
  71 the folder.
  72 Other messages are not tampered with in any way.
  73
  74 The `\-quiet' switch directs \fIburst\fR to be silent about reporting
  75 messages that are not in digest format.
  76
  77 The `\-verbose' switch directs \fIburst\fR to tell the user the general
  78 actions that it is taking to explode the digest.
  79
  80 It turns out that \fIburst\fR works equally well on forwarded messages and
  81 blind\-carbon\-copies as on Internet digests,
  82 provided that the former two were generated by \fIforw\fR or \fIsend\fR.
  83 .Fi
  84 ^$HOME/\&.mh\(ruprofile~^The user profile
  85 .Pr
  86 ^Path:~^To determine the user's MH directory
  87 .Ps
  88 ^Current\-Folder:~^To find the default current folder
  89 .Ps
  90 ^Msg\-Protect:~^To set mode when creating a new message
  91 .Sa
  92 \fIProposed Standard for Message Encapsulation\fR (aka RFC\-934),
  93 .br
  94 inc(1), msh(1), pack(1)
  95 .De
  96 `+folder' defaults to the current folder
  97 .Ds
  98 `msgs' defaults to cur
  99 .Ds
 100 `\-noinplace'
 101 .Ds
 102 `\-noquiet'
 103 .Ds
 104 `\-noverbose'
 105 .Co
 106 If a folder is given, it will become the current folder.
 107 If `\-inplace' is given,
 108 then the first message burst becomes the current message.
 109 This leaves the context ready for a \fIshow\fR of the table of contents
 110 of the digest, and a \fInext\fR to see the first message of the digest.
 111 If `\-noinplace' is given,
 112 then the first message extracted from the first digest burst becomes the
 113 current message.
 114 This leaves the context in a similar, but not identical,
 115 state to the context achieved when using `\-inplace'.
 116 .Bu
 117 The \fIburst\fR program enforces a limit on the number of messages which may
 118 be \fIburst\fR from a single message.
 119 This number is on the order of 1000 messages.
 120 There is usually no limit on the number of messages which may reside in the
 121 folder after the \fIburst\fRing.
 122
 123 Although \fIburst\fR uses a sophisticated algorithm to determine where one
 124 encapsulated message ends and another begins,
 125 not all digestifying programs use an encapsulation algorithm.
 126 In degenerate cases,
 127 this usually results in \fIburst\fR finding an encapsulation boundary
 128 prematurely and splitting a single encapsulated message into two or more
 129 messages.
 130 These erroneous digestifying programs should be fixed.
 131
 132 Furthermore,
 133 any text which appears after the last encapsulated message is not placed
 134 in a seperate message by \fIburst\fR.
 135 In the case of digestified messages,
 136 this text is usally an \*(lqEnd of digest\*(rq string.
 137 As a result of this possibly un\-friendly behavior on the part of \fIburst\fR,
 138 note that when the `\-inplace' option is used,
 139 this trailing information is lost.
 140 In practice,
 141 this is not a problem since correspondents usually place remarks in text
 142 prior to the first encapsulated message,
 143 and this information is not lost.
 144 .En
 145 @
 146
 147
 148 1.4
 149 log
 150 @put things back, do .NA stuff another way
 151 @
 152 text
 153 @d2 1
 154 @
 155
 156
 157 1.3
 158 log
 159 @typo
 160 @
 161 text
 162 @d2 2
 163 a3 2
 164 .TH BURST 1 @@(MHCENTERFOOT) @@(MHLEFTFOOT)
 165 .SH .NA
 166 d5 1
 167 a5 1
 168 .SH .SY
 169 @
 170
 171
 172 1.2
 173 log
 174 @fixup for makewhatis
 175 @
 176 text
 177 @d2 1
 178 a2 1
 179 .TH BURST 1 [mh.6] MH
 180 @
 181
 182
 183 1.1
 184 log
 185 @Initial revision
 186 @
 187 text
 188 @d2 2
 189 a3 2
 190 .SC BURST 1
 191 .NA
 192 d5 1
 193 a5 1
 194 .SY
 195 @