X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/d1cb667bddf8d1c5c0721fc7ab642c22946baf1f..94187a80bd60baab4b9c4b949ad820d730578123:/man/burst.man diff --git a/man/burst.man b/man/burst.man index 4e2d0cc0..2012e988 100644 --- a/man/burst.man +++ b/man/burst.man @@ -1,40 +1,56 @@ -.TH BURST %manext1% "January 1, 2001" "%nmhversion%" -.\" +.TH BURST %manext1% 2013-02-08 "%nmhversion%" +. .\" %nmhwarning% -.\" +. .SH NAME -burst \- explode digests into messages +burst \- explode digests into nmh messages .SH SYNOPSIS .HP 5 .na .B burst +.RB [ \-help ] +.RB [ \-version ] .RI [ +folder ] .RI [ msgs ] .RB [ \-inplace " | " \-noinplace ] +.RB [ \-mime " | " \-nomime ] +.RB [ \-automime ] .RB [ \-quiet " | " \-noquiet ] .RB [ \-verbose " | " \-noverbose ] -.RB [ \-version ] -.RB [ \-help ] .ad .SH DESCRIPTION -.B Burst +.B burst considers the specified messages in the named folder to be Internet digests, and explodes them in that folder. .PP If .B \-inplace -is given, each digest is replaced by the \*(lqtable -of contents\*(rq for the digest (the original digest is removed). -.B Burst -then renumbers all of the messages following 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. +is given, each digest is replaced by its \*(lqtable +of contents\*(rq and the digest is removed. +.B burst +then renumbers the messages which follow the digest, in the folder, +making room for each of the exploded messages, which are placed +immediately after the \*(lqtable of contents\*(rq. .PP If .B \-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. +is produced, and the exploded messages are placed at the end of the +folder. Other messages in the folder are not affected. +.PP +If +.B \-automime +is given, +.B burst +will try to determine if the message is formatted with MIME and contains MIME parts of +type \*(lqmessage/rfc822\*(rq. If it does, it will burst the message using MIME +formatting rules. The +.B \-mime +switch can be used to enforce the use of MIME formatting. The +.B \-nomime +switch will force +.B burst +to use RFC 934 rules. .PP The .B \-quiet @@ -53,42 +69,51 @@ actions that it is taking to explode the digest. It turns out that .B burst works equally well on forwarded messages -and blind\-carbon\-copies as on Internet digests, provided that the -former two were generated by +and blind-carbon-copies as on Internet digests, provided +that the former were generated by .B forw or .BR send . .SH FILES -.fc ^ ~ -.nf -.ta \w'%etcdir%/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile -.fi +.TP 20 +$HOME/.mh_profile +The user's profile. .SH "PROFILE COMPONENTS" -.fc ^ ~ -.nf -.ta 2.4i -.ta \w'ExtraBigProfileName 'u -^Path:~^To determine the user's nmh directory -^Current\-Folder:~^To find the default current folder -^Msg\-Protect:~^To set mode when creating a new message -.fi +.PD 0 +.TP 20 +Path: +To determine the user's nmh directory. +.TP +Current\-Folder: +To find the default current folder. +.TP +Msg\-Protect: +To set mode when creating a new message. +.PD .SH "SEE ALSO" .IR inc (1), -.IR msh (1), .IR pack (1) .PP .I Proposed Standard for Message Encapsulation -(RFC\-934) +(RFC 934) .SH DEFAULTS -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` msgs "' defaults to cur" -.RB ` \-noinplace ' -.RB ` \-noquiet ' -.RB ` \-noverbose ' -.fi +.PD 0 +.TP 20 ++folder +The current folder. +.TP +msgs +The current message. +.TP +\-noinplace +.TP +\-automime +.TP +\-noquiet +.TP +\-noverbose +.PD .SH CONTEXT If a folder is given, it will become the current folder. If .B \-inplace @@ -98,7 +123,7 @@ This leaves the context ready for a of the table of contents of the digest, and a .B next -to see the first message of the digest. If +to see the first message of the digest. If .B \-noinplace is given, then the first message extracted from the first digest burst becomes the current message. This leaves the context @@ -107,12 +132,11 @@ in a similar, but not identical, state to the context achieved when using .SH BUGS The .B burst -program enforces a limit on the number of messages which -may be +program enforces a limit of approximately 1,000 on the number of +messages which may be .B burst -from a single message. This number 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 +from a single message. There is usually no limit on the number of +messages which may reside in the folder after the .BR burst ing. .PP Although @@ -131,7 +155,7 @@ is not placed in a separate message by .BR burst . In the case of digestified messages, this text is usually an \*(lqEnd of digest\*(rq -string. As a result of this possibly un\-friendly behavior on the +string. As a result of this possibly unfriendly behavior on the part of .BR burst , note that when the