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

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