tools/mpack-1.6/unixunpk.man

ec6cf3b09d Ed H*0001 .TH MUNPACK 1
                0002 .SH NAME
                0003 munpack \- unpack messages in MIME or split-uuencode format
                0004 .SH SYNOPSIS
                0005 .B munpack
                0006 [
                0007 .B \-f
                0008 ]
                0009 [
                0010 .B \-q
                0011 ]
                0012 [
                0013 .B \-t
                0014 ]
                0015 [
                0016 .B \-C
                0017 .I directory
                0018 ]
                0019 [
                0020 .I "filename \&..."
                0021 ]
                0022 .SH DESCRIPTION
                0023 The
                0024 .I munpack
                0025 program reads each RFC-822 message
                0026 .I filename
                0027 and writes all non-text MIME parts or split-uuencoded files as files.
                0028 If no filename argument is given,
                0029 .B munpack
                0030 reads from standard input.
                0031 .LP
                0032 If the message suggests a file name to use for the imbedded part, that
                0033 name is cleaned of potential problem characters and used for the
                0034 output file.  If the suggested filename includes subdirectories, they
                0035 will be created as necessary.
                0036 If the message does not suggest a file name, the names
                0037 "part1", "part2", etc are used in sequence.
                0038 .LP
                0039 If the imbedded part was preceded with textual information, that
                0040 information is also written to a file.  The file is named the same as
                0041 the imbedded part, with any filename extension replaced with ".desc".
                0042 .SH OPTIONS
                0043 .TP
                0044 .B \-f
                0045 Force overwriting of existing files.  If a message suggests a file
                0046 name of an existing file, the file will be overwritten.  Without this
                0047 flag,
                0048 .B
                0049 munpack
                0050 appends ".1", ".2", etc to find a nonexistent file.
                0051 .TP
                0052 .B \-q
e768bd1221 Jean*0053 Be quiet.  Suppresses messages about saving partial messages and about
ec6cf3b09d Ed H*0054 messages with no interesting information.
                0055 .TP
                0056 .B \-t
                0057 Also write the text MIME parts of multipart messages as files.  By
                0058 default, text parts that do not have a filename parameter do not get
                0059 unpacked.  This option effectively disables the ".desc" file feature
                0060 for MIME messages.
                0061 .TP
                0062 .BI \-C " directory"
                0063 Change the current directory to
                0064 .I directory
                0065 before reading any files.  This is useful when invoking
                0066 .B munpack
                0067 from a mail or news reader.
                0068 .SH "DECODING MIME"
                0069 .LP
                0070 To decode a MIME message, first save it to a text file.  If possible,
                0071 save it with all headers included.
                0072 .I Munpack
                0073 can decode some MIME files
                0074 when the headers are missing or incomplete, other files it cannot
                0075 decode without having the information in the headers.  In general,
                0076 messages which have a statement at the beginning that they are in MIME
                0077 format can be decoded without the headers.  Messages which have been
                0078 split into multiple parts generally require all headers in order to be
                0079 reassembled and decoded.
                0080 .LP
                0081 Some LAN-based mail systems and some mail providers (including America
                0082 Online, as of the writing of this document) place the mail headers at
                0083 the bottom of the message, instead of at the top of the message.  If
                0084 you are having problems decoding a MIME message on such a system, you
                0085 need to convert the mail back into the standard format by removing the
                0086 system's nonstandard headers and moving the standard Internet headers
                0087 at the top of the message (separated from the message body with a
                0088 blank line).
                0089 .LP
                0090 There must be exactly one message per file.
                0091 .I Munpack
                0092 cannot deal with
                0093 multiple messages in a single file, to decode things correctly it must
                0094 know when one message ends and the next one begins.
                0095 .LP
                0096 To decode a message, run the command:
                0097 .IP
                0098 .IB munpack " file"
                0099 .LP
                0100 where "file" is the name of the file containing the message.  More than
                0101 one filename may be specified,
                0102 .I munpack
                0103 will try to decode the message in
                0104 each file.  For more information on ways to run
                0105 .IR munpack ,
                0106 see the section "OPTIONS" above.
                0107 .SH ENVIRONMENT
                0108 .TP
                0109 .B TMPDIR
e768bd1221 Jean*0110 Directory to store temporary files.  Default is /var/tmp.
ec6cf3b09d Ed H*0111 .SH FILES
                0112 .TP
                0113 .B $TMPDIR/m-prts-$USER/
                0114 Directory used to store partial messages awaiting reassembly.