BSD 4_4_Lite1 development
[unix-history] / usr / src / contrib / mh-6.8.3a / doc / burst.man
BURST(1) BSD Reference Manual BURST(1)
N\bNA\bAM\bME\bE
burst - explode digests into messages
S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
burst [+folder] [msgs] [-inplace] [-noinplace] [-quiet]
[-noquiet] [-verbose] [-noverbose] [-help]
D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
_\bB_\bu_\br_\bs_\bt considers the specified messages in the named folder
to be Internet digests, and explodes them in that folder.
If `-inplace' is given, each digest is replaced by the
"table of contents" for the digest (the original digest is
removed). _\bB_\bu_\br_\bs_\bt then renumbers all of the messages fol-
lowing the digest in the folder to make room for each of
the messages contained within the digest. These messages
are placed immediately after the digest.
If `-noinplace' is given, each digest is preserved, no
table of contents is produced, and the messages contained
within the digest are placed at the end of the folder.
Other messages are not tampered with in any way.
The `-quiet' switch directs _\bb_\bu_\br_\bs_\bt to be silent about
reporting messages that are not in digest format.
The `-verbose' switch directs _\bb_\bu_\br_\bs_\bt to tell the user the
general actions that it is taking to explode the digest.
It turns out that _\bb_\bu_\br_\bs_\bt works equally well on forwarded
messages and blind-carbon-copies as on Internet digests,
provided that the former two were generated by _\bf_\bo_\br_\bw or
_\bs_\be_\bn_\bd.
F\bFI\bIL\bLE\bES\bS
$HOME/.mh_profile The user profile
P\bPR\bRO\bOF\bFI\bIL\bLE\bE C\bCO\bOM\bMP\bPO\bON\bNE\bEN\bNT\bTS\bS
Path: To determine the user's MH directory
Current-Folder: To find the default current folder
Msg-Protect: To set mode when creating a new message
S\bSE\bEE\bE A\bAL\bLS\bSO\bO
_\bP_\br_\bo_\bp_\bo_\bs_\be_\bd _\bS_\bt_\ba_\bn_\bd_\ba_\br_\bd _\bf_\bo_\br _\bM_\be_\bs_\bs_\ba_\bg_\be _\bE_\bn_\bc_\ba_\bp_\bs_\bu_\bl_\ba_\bt_\bi_\bo_\bn (aka RFC-934),
inc(1), msh(1), pack(1)
D\bDE\bEF\bFA\bAU\bUL\bLT\bTS\bS
`+folder' defaults to the current folder
`msgs' defaults to cur
`-noinplace'
`-noquiet'
[mh.6] MH.6.8 1
BURST(1) BSD Reference Manual BURST(1)
`-noverbose'
C\bCO\bON\bNT\bTE\bEX\bXT\bT
If a folder is given, it will become the current folder.
If `-inplace' is given, then the first message burst
becomes the current message. This leaves the context
ready for a _\bs_\bh_\bo_\bw of the table of contents of the digest,
and a _\bn_\be_\bx_\bt to see the first message of the digest. If
`-noinplace' is given, then the first message extracted
from the first digest burst becomes the current message.
This leaves the context in a similar, but not identical,
state to the context achieved when using `-inplace'.
B\bBU\bUG\bGS\bS
The _\bb_\bu_\br_\bs_\bt program enforces a limit on the number of mes-
sages which may be _\bb_\bu_\br_\bs_\bt from a single message. This num-
ber is on the order of 1000 messages. There is usually no
limit on the number of messages which may reside in the
folder after the _\bb_\bu_\br_\bs_\bting.
Although _\bb_\bu_\br_\bs_\bt uses a sophisticated algorithm to determine
where one encapsulated message ends and another begins,
not all digestifying programs use an encapsulation algo-
rithm. In degenerate cases, this usually results in _\bb_\bu_\br_\bs_\bt
finding an encapsulation boundary prematurely and split-
ting a single encapsulated message into two or more mes-
sages. These erroneous digestifying programs should be
fixed.
Furthermore, any text which appears after the last encap-
sulated message is not placed in a seperate message by
_\bb_\bu_\br_\bs_\bt. In the case of digestified messages, this text is
usally an "End of digest" string. As a result of this
possibly un-friendly behavior on the part of _\bb_\bu_\br_\bs_\bt, note
that when the `-inplace' option is used, this trailing
information is lost. In practice, this is not a problem
since correspondents usually place remarks in text prior
to the first encapsulated message, and this information is
not lost.
[mh.6] MH.6.8 2