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

   1 .\"
   2 .\" %nmhwarning%
   3 .\" $Id$
   4 .\"
   5 .\" include the -mh macro file
   6 .so %etcdir%/tmac.h
   7 .\"
   8 .TH MHLIST %manext1% MH.6.8 [%nmhversion%]
   9 .SH NAME
  10 mhlist \- list information about MIME messages
  11 .SH SYNOPSIS
  12 .in +.5i
  13 .ti -.5i
  14 mhlist \%[+folder] \%[msgs] \%[\-file file]
  15 .br
  16 \%[\-part number]... \%[\-type content]...
  17 .br
  18 \%[\-headers] \%[\-noheaders]
  19 \%[\-realsize] \%[\-norealsize]
  20 .br
  21 \%[\-rcache policy] \%[\-wcache policy]
  22 \%[\-check] \%[\-nocheck]
  23 .br
  24 \%[\-verbose] \%[\-noverbose]
  25 \%[\-version]
  26 \%[\-help]
  27 .in -.5i
  28
  29 .SH DESCRIPTION
  30 The \fImhlist\fR command allows you to list information (essentially
  31 a table of contents) about the various parts of a collection of
  32 MIME (multi-media) messages.
  33
  34 \fImhlist\fR manipulates MIME (multi-media messages) as specified
  35 in RFC\-2045 thru RFC\-2049.
  36
  37 The `\-headers' switch indicates that a one-line banner should be
  38 displayed above the listing.
  39
  40 The `\-realsize' switch tells \fImhlist\fR to evaluate the
  41 \*(lqnative\*(rq (decoded) format of each content prior to listing.
  42 This provides an accurate count at the expense of a small delay.
  43
  44 If the `\-verbose' switch is present, then the listing will show
  45 any \*(lqextra\*(rq information that is present in the message,
  46 such as comments in the Content-Type header.
  47
  48 The option `\-file\ file' directs \fImhlist\fR to use the specified
  49 file as the source message, rather than a message from a folder.
  50 If you specify this file as \*(lq-\*(rq, then \fImhlist\fR will
  51 accept the source message on the standard input.  Note that the
  52 file, or input from standard input should be a validly formatted
  53 message, just like any other \fInmh\fR message.  It should \fBNOT\fR
  54 be in mail drop format (to convert a file in mail drop format to
  55 a folder of \fInmh\fR messages, see \fIinc\fR\0(1)).
  56
  57 By default, \fImhlist\fR will list information about the entire
  58 message (all of its parts).  By using the `\-part' and `\-type'
  59 switches, you may limit the scope of this command to particular
  60 subparts (of a multipart content) and/or particular content types.
  61
  62 A part specification consists of a series of numbers separated by dots.
  63 For example, in a multipart content containing three parts, these
  64 would be named as 1, 2, and 3, respectively.  If part 2 was also a
  65 multipart content containing two parts, these would be named as 2.1 and
  66 2.2, respectively.  Note that the `\-part' switch is effective for only
  67 messages containing a multipart content.  If a message has some other
  68 kind of content, or if the part is itself another multipart content, the
  69 `\-part' switch will not prevent the content from being acted upon.
  70
  71 A content specification consists of a content type and a subtype.
  72 The initial list of \*(lqstandard\*(rq content types and subtypes can
  73 be found in RFC\-2046.
  74 .ne 18
  75 A list of commonly used contents is briefly reproduced here:
  76 .sp
  77 .nf
  78 .in +.5i
  79 .ta \w'application  'u
  80 Type    Subtypes
  81 ----    --------
  82 text    plain, enriched
  83 multipart       mixed, alternative, digest, parallel
  84 message rfc822, partial, external-body
  85 application     octet-stream, postscript
  86 image   jpeg, gif, png
  87 audio   basic
  88 video   mpeg
  89 .re
  90 .in -.5i
  91 .fi
  92 .sp
  93 A legal MIME message must contain a subtype specification.
  94 .PP
  95 To specify a content, regardless of its subtype, just use the
  96 name of the content, e.g., \*(lqaudio\*(rq.  To specify a specific
  97 subtype, separate the two with a slash, e.g., \*(lqaudio/basic\*(rq.
  98 Note that regardless of the values given to the `\-type' switch, a
  99 multipart content (of any subtype listed above) is always acted upon.
 100 Further note that if the `\-type' switch is used, and it is desirable to
 101 act on a message/external-body content, then the `\-type' switch must
 102 be used twice: once for message/external-body and once for the content
 103 externally referenced.
 104
 105 .Uh "Checking the Contents"
 106 The `\-check' switch tells \fImhlist\fR to check each content for an
 107 integrity checksum.  If a content has such a checksum (specified as a
 108 Content-MD5 header field), then \fImhlist\fR will attempt to verify the
 109 integrity of the content.
 110 .Fi
 111 ^$HOME/\&.mh\(ruprofile~^The user profile
 112 .Pr
 113 ^Path:~^To determine the user's nmh directory
 114 .Ps
 115 ^Current\-Folder:~^To find the default current folder
 116 .Sa
 117 mhbuild(1), mhshow(1), mhstore(1), sendfiles(1)
 118 .br
 119 RFC\-2045:
 120 .br
 121    \fIMultipurpose Internet Mail Extensions (MIME) Part One:
 122 .br
 123    Format of Internet Message Bodies\fR,
 124 .br
 125 RFC\-2046:
 126 .br
 127    \fIMultipurpose Internet Mail Extensions (MIME) Part Two:
 128 .br
 129    Media Types\fR,
 130 .br
 131 RFC\-2047:
 132 .br
 133    \fIMultipurpose Internet Mail Extensions (MIME) Part Three:
 134 .br
 135    Message Header Extensions for Non-ASCII Text\fR,
 136 .br
 137 RFC\-2048:
 138 .br
 139    \fIMultipurpose Internet Mail Extensions (MIME) Part Four:
 140 .br
 141    Registration Procedures\fR,
 142 .br
 143 RFC\-2049:
 144 .br
 145    \fIMultipurpose Internet Mail Extensions (MIME) Part Five:
 146 .br
 147    Conformance Criteria and Examples\fR.
 148 .De
 149 `+folder' defaults to the current folder
 150 .Ds
 151 `msgs' defaults to cur
 152 .Ds
 153 `\-nocheck'
 154 .Ds
 155 `\-headers'
 156 .Ds
 157 `\-realsize'
 158 .Ds
 159 `\-rcache ask'
 160 .Ds
 161 `\-wcache ask'
 162 .Ds
 163 `\-noverbose'
 164 .Co
 165 If a folder is given, it will become the current folder.  The last
 166 message selected will become the current message.
 167 .En