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

   1 .TH BURST %manext1% "April 18, 2014" "%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 .RI [ +folder ]
  12 .RI [ msgs ]
  13 .RB [ \-inplace " | " \-noinplace ]
  14 .RB [ \-mime " | " \-nomime ]
  15 .RB [ \-automime ]
  16 .RB [ \-quiet " | " \-noquiet ]
  17 .RB [ \-verbose " | " \-noverbose ]
  18 .RB [ \-version ]
  19 .RB [ \-help ]
  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 the \*(lqtable
  29 of contents\*(rq for the digest (the original digest is removed).
  30 .B Burst
  31 then renumbers all of the messages following the digest in the
  32 folder to make room for each of the messages contained within the digest.
  33 These messages are placed immediately after the digest.
  34 .PP
  35 If
  36 .B \-noinplace
  37 is given, each digest is preserved, no table of contents
  38 is produced, and the messages contained within the digest are placed at
  39 the end of the folder.  Other messages are not tampered with in any way.
  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 that the
  73 former two 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 on the number of messages which
 136 may be
 137 .B burst
 138 from a single message.  This number is on the order
 139 of 1000 messages.  There is usually no limit on the number of messages
 140 which may reside in the folder after the
 141 .BR burst ing.
 142 .PP
 143 Although
 144 .B burst
 145 uses a sophisticated algorithm to determine where
 146 one encapsulated message ends and another begins, not all digestifying
 147 programs use an encapsulation algorithm.  In degenerate cases, this
 148 usually results in
 149 .B burst
 150 finding an encapsulation boundary
 151 prematurely and splitting a single encapsulated message into two or
 152 more messages.  These erroneous digestifying programs should be fixed.
 153 .PP
 154 Furthermore, any text which appears after the last encapsulated message
 155 is not placed in a separate message by
 156 .BR burst .
 157 In the case of
 158 digestified messages, this text is usually an \*(lqEnd of digest\*(rq
 159 string.  As a result of this possibly un\-friendly behavior on the
 160 part of
 161 .BR burst ,
 162 note that when the
 163 .B \-inplace
 164 option is used,
 165 this trailing information is lost.  In practice, this is not a problem
 166 since correspondents usually place remarks in text prior to the first
 167 encapsulated message, and this information is not lost.