0
|
1 .\" This file is automatically generated. Do not edit!
|
|
2 .\" @(#)$Id$
|
|
3 .SC BURST 1
|
|
4 .NA
|
|
5 burst \- explode digests into messages
|
|
6 .SY
|
|
7 burst
|
|
8 \%[+folder] \%[msgs]
|
|
9 \%[\-inplace] \%[\-noinplace]
|
|
10 \%[\-quiet] \%[\-noquiet]
|
|
11 \%[\-verbose] \%[\-noverbose]
|
|
12 \%[\-help]
|
|
13 .DE
|
|
14 \fIBurst\fR considers the specified messages in the named folder to be
|
|
15 Internet digests, and explodes them in that folder.
|
|
16
|
|
17 If `\-inplace' is given,
|
|
18 each digest is replaced by the \*(lqtable of contents\*(rq for the digest
|
|
19 (the original digest is removed).
|
|
20 \fIBurst\fR then renumbers all of the messages following the digest in the
|
|
21 folder to make room for each of the messages contained within the digest.
|
|
22 These messages are placed immediately after the digest.
|
|
23
|
|
24 If `\-noinplace' is given,
|
|
25 each digest is preserved,
|
|
26 no table of contents is produced,
|
|
27 and the messages contained within the digest are placed at the end of
|
|
28 the folder.
|
|
29 Other messages are not tampered with in any way.
|
|
30
|
|
31 The `\-quiet' switch directs \fIburst\fR to be silent about reporting
|
|
32 messages that are not in digest format.
|
|
33
|
|
34 The `\-verbose' switch directs \fIburst\fR to tell the user the general
|
|
35 actions that it is taking to explode the digest.
|
|
36
|
|
37 It turns out that \fIburst\fR works equally well on forwarded messages and
|
|
38 blind\-carbon\-copies as on Internet digests,
|
|
39 provided that the former two were generated by \fIforw\fR or \fIsend\fR.
|
|
40 .Fi
|
|
41 ^$HOME/\&.mh\(ruprofile~^The user profile
|
|
42 .Pr
|
|
43 ^Path:~^To determine the user's MH directory
|
|
44 .Ps
|
|
45 ^Current\-Folder:~^To find the default current folder
|
|
46 .Ps
|
|
47 ^Msg\-Protect:~^To set mode when creating a new message
|
|
48 .Sa
|
|
49 \fIProposed Standard for Message Encapsulation\fR (aka RFC\-934),
|
|
50 .br
|
|
51 inc(1), msh(1), pack(1)
|
|
52 .De
|
|
53 `+folder' defaults to the current folder
|
|
54 .Ds
|
|
55 `msgs' defaults to cur
|
|
56 .Ds
|
|
57 `\-noinplace'
|
|
58 .Ds
|
|
59 `\-noquiet'
|
|
60 .Ds
|
|
61 `\-noverbose'
|
|
62 .Co
|
|
63 If a folder is given, it will become the current folder.
|
|
64 If `\-inplace' is given,
|
|
65 then the first message burst becomes the current message.
|
|
66 This leaves the context ready for a \fIshow\fR of the table of contents
|
|
67 of the digest, and a \fInext\fR to see the first message of the digest.
|
|
68 If `\-noinplace' is given,
|
|
69 then the first message extracted from the first digest burst becomes the
|
|
70 current message.
|
|
71 This leaves the context in a similar, but not identical,
|
|
72 state to the context achieved when using `\-inplace'.
|
|
73 .Bu
|
|
74 The \fIburst\fR program enforces a limit on the number of messages which may
|
|
75 be \fIburst\fR from a single message.
|
|
76 This number is on the order of 1000 messages.
|
|
77 There is usually no limit on the number of messages which may reside in the
|
|
78 folder after the \fIburst\fRing.
|
|
79
|
|
80 Although \fIburst\fR uses a sophisticated algorithm to determine where one
|
|
81 encapsulated message ends and another begins,
|
|
82 not all digestifying programs use an encapsulation algorithm.
|
|
83 In degenerate cases,
|
|
84 this usually results in \fIburst\fR finding an encapsulation boundary
|
|
85 prematurely and splitting a single encapsulated message into two or more
|
|
86 messages.
|
|
87 These erroneous digestifying programs should be fixed.
|
|
88
|
|
89 Furthermore,
|
|
90 any text which appears after the last encapsulated message is not placed
|
|
91 in a seperate message by \fIburst\fR.
|
|
92 In the case of digestified messages,
|
|
93 this text is usally an \*(lqEnd of digest\*(rq string.
|
|
94 As a result of this possibly un\-friendly behavior on the part of \fIburst\fR,
|
|
95 note that when the `\-inplace' option is used,
|
|
96 this trailing information is lost.
|
|
97 In practice,
|
|
98 this is not a problem since correspondents usually place remarks in text
|
|
99 prior to the first encapsulated message,
|
|
100 and this information is not lost.
|
|
101 .En
|