git.marmaro.de Git - mmh/blob - man/burst.man

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