diplodocus.org Git - nmh/blob - man/mhlist.man

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