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

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