Return to burst.me CVS log

Up to [CSRG BSD Unix] / 43BSDReno / share / doc / usd / 08.mh

Annotation of 43BSDReno/share/doc/usd/08.mh/burst.me, revision 1.1.1.1

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

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