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

   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 [ \-verbose " | " \-noverbose ]
  14 .RB [ \-version ]
  15 .RB [ \-help ]
  16 .ad
  17 .SH DESCRIPTION
  18 .B Burst
  19 considers the specified messages in the named folder to be
  20 Internet digests, and explodes them in that folder.
  21 .PP
  22 The messages contained within the digest are placed at the end of the folder.
  23 The digest is preserved.
  24 No other messages are tampered with in any way.
  25 .PP
  26 The
  27 .B \-verbose
  28 switch directs
  29 .B burst
  30 to tell the user the general
  31 actions that it is taking to explode the digest.
  32 .PP
  33 It turns out that
  34 .B burst
  35 works equally well on forwarded messages
  36 and blind\-carbon\-copies as on Internet digests, provided that they
  37 use RFC 934 message encapsulation.
  38 .PP
  39 To extract messages encapsulated with MIME, use
  40 .BR mhstore (1).
  41
  42 .SH FILES
  43 .fc ^ ~
  44 .nf
  45 .ta \w'%etcdir%/ExtraBigFileName  'u
  46 ^$HOME/.mmh/profile~^The user profile
  47 .fi
  48
  49 .SH "PROFILE COMPONENTS"
  50 .fc ^ ~
  51 .nf
  52 .ta 2.4i
  53 .ta \w'ExtraBigProfileName  'u
  54 ^Path:~^To determine the user's mail storage
  55 ^Current\-Folder:~^To find the default current folder
  56 ^Msg\-Protect:~^To set mode when creating a new message
  57 .fi
  58
  59 .SH "SEE ALSO"
  60 mhstore(1),
  61 .I "Proposed Standard for Message Encapsulation"
  62 (RFC\-934)
  63
  64 .SH DEFAULTS
  65 .nf
  66 .RB ` +folder "' defaults to the current folder"
  67 .RB ` msgs "' defaults to cur"
  68 .RB ` \-noverbose '
  69 .fi
  70
  71 .SH CONTEXT
  72 If a folder is given, it will become the current folder.
  73 The first message extracted from the
  74 first digest burst becomes the current message.
  75
  76 .SH BUGS
  77 The
  78 .B burst
  79 program enforces a limit on the number of messages which
  80 may be
  81 .B burst
  82 from a single message.  This number is on the order
  83 of 1000 messages.  There is usually no limit on the number of messages
  84 which may reside in the folder after the
  85 .BR burst ing.
  86 .PP
  87 Although
  88 .B burst
  89 uses a sophisticated algorithm to determine where
  90 one encapsulated message ends and another begins, not all digestifying
  91 programs use an encapsulation algorithm.  In degenerate cases, this
  92 usually results in
  93 .B burst
  94 finding an encapsulation boundary
  95 prematurely and splitting a single encapsulated message into two or
  96 more messages.  These erroneous digestifying programs should be fixed.
  97 .PP
  98 Any text which appears after the last encapsulated message
  99 is not placed in a separate message by
 100 .BR burst .
 101 In the case of
 102 digestified messages, this text is usually an \*(lqEnd of digest\*(rq
 103 string.