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