git.marmaro.de Git - mmh/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 .fc ^ ~
  63 .nf
  64 .ta \w'%etcdir%/ExtraBigFileName  'u
  65 ^$HOME/\&.mh\(ruprofile~^The user profile
  66 .fi
  67 .SH "PROFILE COMPONENTS"
  68 .fc ^ ~
  69 .nf
  70 .ta 2.4i
  71 .ta \w'ExtraBigProfileName  'u
  72 ^Path:~^To determine the user's nmh directory
  73 ^Current\-Folder:~^To find the default current folder
  74 ^Msg\-Protect:~^To set mode when creating a new message
  75 .fi
  76 .SH "SEE ALSO"
  77 .IR inc (1),
  78 .IR msh (1),
  79 .IR pack (1)
  80 .PP
  81 .I
  82 Proposed Standard for Message Encapsulation
  83 (RFC\-934)
  84 .SH DEFAULTS
  85 .nf
  86 .RB ` +folder "' defaults to the current folder"
  87 .RB ` msgs "' defaults to cur"
  88 .RB ` \-noinplace '
  89 .RB ` \-noquiet '
  90 .RB ` \-noverbose '
  91 .fi
  92 .SH CONTEXT
  93 If a folder is given, it will become the current folder.  If
  94 .B \-inplace
  95 is given, then the first message burst becomes the current message.
  96 This leaves the context ready for a
  97 .B show
  98 of the table of contents
  99 of the digest, and a
 100 .B next
 101 to see the first message of the digest. If
 102 .B \-noinplace
 103 is given, then the first message extracted from the
 104 first digest burst becomes the current message.  This leaves the context
 105 in a similar, but not identical, state to the context achieved when using
 106 .BR \-inplace .
 107 .SH BUGS
 108 The
 109 .B burst
 110 program enforces a limit on the number of messages which
 111 may be
 112 .B burst
 113 from a single message.  This number is on the order
 114 of 1000 messages.  There is usually no limit on the number of messages
 115 which may reside in the folder after the
 116 .BR burst ing.
 117 .PP
 118 Although
 119 .B burst
 120 uses a sophisticated algorithm to determine where
 121 one encapsulated message ends and another begins, not all digestifying
 122 programs use an encapsulation algorithm.  In degenerate cases, this
 123 usually results in
 124 .B burst
 125 finding an encapsulation boundary
 126 prematurely and splitting a single encapsulated message into two or
 127 more messages.  These erroneous digestifying programs should be fixed.
 128 .PP
 129 Furthermore, any text which appears after the last encapsulated message
 130 is not placed in a separate message by
 131 .BR burst .
 132 In the case of
 133 digestified messages, this text is usually an \*(lqEnd of digest\*(rq
 134 string.  As a result of this possibly un\-friendly behavior on the
 135 part of
 136 .BR burst ,
 137 note that when the
 138 .B \-inplace
 139 option is used,
 140 this trailing information is lost.  In practice, this is not a problem
 141 since correspondents usually place remarks in text prior to the first
 142 encapsulated message, and this information is not lost.