]> diplodocus.org Git - nmh/blobdiff - man/burst.man
getpass.c: Move interface to own file.
[nmh] / man / burst.man
index 3f14bdc47ffb97c26d99d69ca36eb1dd999e2c52..2012e9883bb29ab98b66f796e6dd34784ad6722c 100644 (file)
@@ -1,13 +1,15 @@
-.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 ]
@@ -15,38 +17,36 @@ burst \- explode digests into messages
 .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
+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
+switch can be used to enforce the use of MIME formatting.  The
 .B \-nomime
 switch will force
 .B burst
@@ -69,14 +69,14 @@ 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
 .TP 20
-$HOME/.mh\-profile
+$HOME/.mh_profile
 The user's profile.
 .SH "PROFILE COMPONENTS"
 .PD 0
@@ -92,7 +92,6 @@ To set mode when creating a new message.
 .PD
 .SH "SEE ALSO"
 .IR inc (1),
-.IR msh (1),
 .IR pack (1)
 .PP
 .I
@@ -124,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
@@ -133,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
@@ -157,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