Return to burst.rf CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / mh / conf / doc

Annotation of 43BSD/contrib/mh/conf/doc/burst.rf, revision 1.1

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

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.