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

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