annotate doc/burst.me @ 0:bce86c4163a3

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