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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH BURST %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 burst \- explode digests into messages
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 burst
  15 \%[+folder] \%[msgs]
  16 \%[\-inplace] \%[\-noinplace]
  17 \%[\-quiet]
  18 .br
  19 \%[\-noquiet]
  20 \%[\-verbose] \%[\-noverbose]
  21 \%[\-version]
  22 \%[\-help]
  23 .in -.5i
  24 .SH DESCRIPTION
  25 \fIBurst\fR considers the specified messages in the named folder to be
  26 Internet digests, and explodes them in that folder.
  27
  28 If `\-inplace' is given, each digest is replaced by the \*(lqtable
  29 of contents\*(rq for the digest (the original digest is removed).
  30 \fIBurst\fR 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
  34 If `\-noinplace' 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
  38 The `\-quiet' switch directs \fIburst\fR to be silent about reporting
  39 messages that are not in digest format.
  40
  41 The `\-verbose' switch directs \fIburst\fR to tell the user the general
  42 actions that it is taking to explode the digest.
  43
  44 It turns out that \fIburst\fR works equally well on forwarded messages
  45 and blind\-carbon\-copies as on Internet digests, provided that the
  46 former two were generated by \fIforw\fR or \fIsend\fR.
  47 .Fi
  48 ^$HOME/\&.mh\(ruprofile~^The user profile
  49 .Pr
  50 ^Path:~^To determine the user's nmh directory
  51 .Ps
  52 ^Current\-Folder:~^To find the default current folder
  53 .Ps
  54 ^Msg\-Protect:~^To set mode when creating a new message
  55 .Sa
  56 \fIProposed Standard for Message Encapsulation\fR (RFC\-934),
  57 .br
  58 inc(1), msh(1), pack(1)
  59 .De
  60 `+folder' defaults to the current folder
  61 .Ds
  62 `msgs' defaults to cur
  63 .Ds
  64 `\-noinplace'
  65 .Ds
  66 `\-noquiet'
  67 .Ds
  68 `\-noverbose'
  69 .Co
  70 If a folder is given, it will become the current folder.  If `\-inplace'
  71 is given, then the first message burst becomes the current message.
  72 This leaves the context ready for a \fIshow\fR of the table of contents
  73 of the digest, and a \fInext\fR to see the first message of the digest.
  74 If `\-noinplace' is given, then the first message extracted from the
  75 first digest burst becomes the current message.  This leaves the context
  76 in a similar, but not identical, state to the context achieved when using
  77 `\-inplace'.
  78 .Bu
  79 The \fIburst\fR program enforces a limit on the number of messages which
  80 may be \fIburst\fR from a single message.  This number is on the order
  81 of 1000 messages.  There is usually no limit on the number of messages
  82 which may reside in the folder after the \fIburst\fRing.
  83
  84 Although \fIburst\fR uses a sophisticated algorithm to determine where
  85 one encapsulated message ends and another begins, not all digestifying
  86 programs use an encapsulation algorithm.  In degenerate cases, this
  87 usually results in \fIburst\fR finding an encapsulation boundary
  88 prematurely and splitting a single encapsulated message into two or
  89 more messages.  These erroneous digestifying programs should be fixed.
  90
  91 Furthermore, any text which appears after the last encapsulated message
  92 is not placed in a separate message by \fIburst\fR.  In the case of
  93 digestified messages, this text is usually an \*(lqEnd of digest\*(rq
  94 string.  As a result of this possibly un\-friendly behavior on the
  95 part of \fIburst\fR, note that when the `\-inplace' option is used,
  96 this trailing information is lost.  In practice, this is not a problem
  97 since correspondents usually place remarks in text prior to the first
  98 encapsulated message, and this information is not lost.
  99 .En