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