X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/b36e2ab7892cdf30a8b33d02e00af70398013b5d..b0aa8cdb1c264e42d4931ca24968689c73381278:/man/burst.man diff --git a/man/burst.man b/man/burst.man index 85370927..88bd2d18 100644 --- a/man/burst.man +++ b/man/burst.man @@ -1,22 +1,25 @@ +.TH BURST %manext1% "April 18, 2014" "%nmhversion%" .\" .\" %nmhwarning% -.\" $Id$ .\" -.TH BURST %manext1% "%nmhdate%" MH.6.8 [%nmhversion%] .SH NAME burst \- explode digests into 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 @@ -24,7 +27,7 @@ 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 +.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. @@ -35,6 +38,20 @@ 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. .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 switch directs @@ -57,35 +74,46 @@ former two were generated by .B forw or .BR send . - .SH FILES -.fc ^ ~ -.nf -.ta \w'/usr/local/nmh/etc/ExtraBigFileName 'u -^$HOME/\&.mh\(ruprofile~^The user profile - +.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 - +.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" -inc(1), msh(1), pack(1), -.I "Proposed Standard for Message Encapsulation" -(RFC\-934) - -.SH "DEFAULTS" -.nf -.RB ` +folder "' defaults to the current folder" -.RB ` msgs "' defaults to cur" -.RB ` \-noinplace ' -.RB ` \-noquiet ' -.RB ` \-noverbose ' - +.IR inc (1), +.IR pack (1) +.PP +.I +Proposed Standard for Message Encapsulation +(RFC 934) +.SH DEFAULTS +.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 @@ -95,13 +123,12 @@ 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 in a similar, but not identical, state to the context achieved when using .BR \-inplace . - .SH BUGS The .B burst