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

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