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

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