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