diplodocus.org Git - nmh/blob - man/burst.man

   1 .TH BURST %manext1% "December 15, 2016" "%nmhversion%"
   2 .\"
   3 .\" %nmhwarning%
   4 .\"
   5 .SH NAME
   6 burst \- explode digests into messages
   7 .SH SYNOPSIS
   8 .HP 5
   9 .na
  10 .B burst
  11 .RB [ \-help ]
  12 .RB [ \-version ]
  13 .RI [ +folder ]
  14 .RI [ msgs ]
  15 .RB [ \-inplace " | " \-noinplace ]
  16 .RB [ \-mime " | " \-nomime ]
  17 .RB [ \-automime ]
  18 .RB [ \-quiet " | " \-noquiet ]
  19 .RB [ \-verbose " | " \-noverbose ]
  20 .ad
  21 .SH DESCRIPTION
  22 .B burst
  23 considers the specified messages in the named folder to be
  24 Internet digests, and explodes them in that folder.
  25 .PP
  26 If
  27 .B \-inplace
  28 is given, each digest is replaced by its \*(lqtable
  29 of contents\*(rq and the digest is removed.
  30 .B burst
  31 then renumbers the messages which follow the digest, in the folder,
  32 making room for each of the exploded messages, which are placed
  33 immediately after the \*(lqtable of contents\*(rq.
  34 .PP
  35 If
  36 .B \-noinplace
  37 is given, each digest is preserved, no table of contents
  38 is produced, and the exploded messages are placed at the end of the
  39 folder.  Other messages in the folder are not affected.
  40 .PP
  41 If
  42 .B \-automime
  43 is given,
  44 .B burst
  45 will try to determine if the message is formatted with MIME and contains MIME parts of
  46 type \*(lqmessage/rfc822\*(rq.  If it does, it will burst the message using MIME
  47 formatting rules.  The
  48 .B \-mime
  49 switch can be used to enforce the use of MIME formatting.  The
  50 .B \-nomime
  51 switch will force
  52 .B burst
  53 to use RFC 934 rules.
  54 .PP
  55 The
  56 .B \-quiet
  57 switch directs
  58 .B burst
  59 to be silent about reporting
  60 messages that are not in digest format.
  61 .PP
  62 The
  63 .B \-verbose
  64 switch directs
  65 .B burst
  66 to tell the user the general
  67 actions that it is taking to explode the digest.
  68 .PP
  69 It turns out that
  70 .B burst
  71 works equally well on forwarded messages
  72 and blind\-carbon\-copies as on Internet digests, provided
  73 that the former were generated by
  74 .B forw
  75 or
  76 .BR send .
  77 .SH FILES
  78 .TP 20
  79 $HOME/.mh_profile
  80 The user's profile.
  81 .SH "PROFILE COMPONENTS"
  82 .PD 0
  83 .TP 20
  84 Path:
  85 To determine the user's nmh directory.
  86 .TP
  87 Current\-Folder:
  88 To find the default current folder.
  89 .TP
  90 Msg\-Protect:
  91 To set mode when creating a new message.
  92 .PD
  93 .SH "SEE ALSO"
  94 .IR inc (1),
  95 .IR pack (1)
  96 .PP
  97 .I
  98 Proposed Standard for Message Encapsulation
  99 (RFC 934)
 100 .SH DEFAULTS
 101 .PD 0
 102 .TP 20
 103 +folder
 104 The current folder.
 105 .TP
 106 msgs
 107 The current message.
 108 .TP
 109 \-noinplace
 110 .TP
 111 \-automime
 112 .TP
 113 \-noquiet
 114 .TP
 115 \-noverbose
 116 .PD
 117 .SH CONTEXT
 118 If a folder is given, it will become the current folder.  If
 119 .B \-inplace
 120 is given, then the first message burst becomes the current message.
 121 This leaves the context ready for a
 122 .B show
 123 of the table of contents
 124 of the digest, and a
 125 .B next
 126 to see the first message of the digest.  If
 127 .B \-noinplace
 128 is given, then the first message extracted from the
 129 first digest burst becomes the current message.  This leaves the context
 130 in a similar, but not identical, state to the context achieved when using
 131 .BR \-inplace .
 132 .SH BUGS
 133 The
 134 .B burst
 135 program enforces a limit of approximately 1,000 on the number of
 136 messages which may be
 137 .B burst
 138 from a single message. There is usually no limit on the number of
 139 messages which may reside in the folder after the
 140 .BR burst ing.
 141 .PP
 142 Although
 143 .B burst
 144 uses a sophisticated algorithm to determine where
 145 one encapsulated message ends and another begins, not all digestifying
 146 programs use an encapsulation algorithm.  In degenerate cases, this
 147 usually results in
 148 .B burst
 149 finding an encapsulation boundary
 150 prematurely and splitting a single encapsulated message into two or
 151 more messages.  These erroneous digestifying programs should be fixed.
 152 .PP
 153 Furthermore, any text which appears after the last encapsulated message
 154 is not placed in a separate message by
 155 .BR burst .
 156 In the case of
 157 digestified messages, this text is usually an \*(lqEnd of digest\*(rq
 158 string.  As a result of this possibly unfriendly behavior on the
 159 part of
 160 .BR burst ,
 161 note that when the
 162 .B \-inplace
 163 option is used,
 164 this trailing information is lost.  In practice, this is not a problem
 165 since correspondents usually place remarks in text prior to the first
 166 encapsulated message, and this information is not lost.