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

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