home *** CD-ROM | disk | FTP | other *** search
/ DP Tool Club 17 / CD_ASCQ_17_101194.iso / vrac / mpack14.zip / MPACK.DOC < prev    next >
Text File  |  1994-05-31  |  11KB  |  275 lines
  1.               mpack/munpack version 1.4
  2.  
  3. Mpack and munpack are utilities for encoding and decoding
  4. (respectively) binary files in MIME (Multipurpose Internet Mail
  5. Extensions) format mail messages.  For compabibility with older forms
  6. of transferring binary files, the munpack program can also decode
  7. messages in split-uuencoded format.  The mac version can also decode
  8. messages in split-BinHex format.
  9.  
  10. Versions are included for unix, pc, mac and amiga systems.  The
  11. canonical FTP site for this software is ftp.andrew.cmu.edu:pub/mpack/
  12.  
  13. This MIME implementation is intended to be as simple and portable as
  14. possible.  For a slightly more sophisticated MIME implementation, see
  15. the program MetaMail, available via anonymous FTP to
  16. thumper.bellcore.com, in directory pub/nsb
  17.  
  18.  
  19. Compilation:
  20.  
  21. [unix version]
  22.  
  23. If compiling on SunOS, SVR4, SCO Unix, or an ancient BSD without the
  24. strchr() function, edit the Makefile and uncomment the relevant lines.
  25.  
  26. Compile with the "make" command. Install with 
  27. "make install DESTDIR=/installation/path".  The default value of
  28. DESTDIR is "/usr/local", which installs the programs in /usr/local/bin
  29. and the man pages in /usr/local/man/man1.
  30.  
  31. [pc version]
  32.  
  33. The pc sources have been compiled with Microsoft C version 7.0. 
  34.  
  35. [amiga version]
  36.  
  37. The amiga sources have been compiled with SAS/C version 6.3. To compile
  38. with SAS/C, use the command "smake".
  39.  
  40. [mac version]
  41.  
  42. Mpack was compiled with THINK C 6.0 with the 4-byte int option turned
  43. on (and the ANSI-small library compiled with the 4-byte int option)
  44. and prototype enforcement turned off.  Included with this distribution
  45. should be the files "macproj.hqx" which is a BinHex4 version of the
  46. THINK C 6.0 project file, and "macrsrc.hqx" which is a BinHex4 version
  47. of the resources file.
  48.  
  49. If you wish to compile this with a different version of the THINK C
  50. compiler, you must turn on 4-byte ints when compiling the ANSI library
  51. and the source code.  If you wish to use MPW or some other compiler
  52. you will probably have to add additional #include statements for the
  53. appropriate Macintosh interface headers.
  54.  
  55.  
  56. Using the mac version:
  57.  
  58. See the "Help..." menu item in the application.
  59.  
  60.  
  61. Using mpack: [unix, pc and amiga versions]
  62.  
  63. Mpack is used to encode a file in one or more MIME format messages.
  64. The program is invoked with:
  65.  
  66.     mpack [options] -o outputfile file
  67.  
  68. Where "[options]" is one or more optional switches described below.
  69. "file" is the name of the file to encode and "-o outputfile" is
  70. described below.
  71.  
  72. The unix version may also be invoked with either:
  73.  
  74.     mpack [options] file address...
  75.  
  76. or
  77.  
  78.     mpack [options] -n newsgroups file
  79.  
  80. Where "address..." is one or more e-mail address to mail the resulting
  81. messages to and "newsgroups" is a comma-separated list of newsgroups
  82. to post the resulting messages to.
  83.  
  84. The amiga version may be invoked identically to the Unix version.
  85. There is extra flexibility in the options and addresses.  Use "mpack
  86. ?" for a list of options; a second "?" will print more information.
  87. AmigaDOS 2.0 or later is required to run mpack.
  88.  
  89. The possible options are:
  90.  
  91.      -s subject
  92.           Set the Subject header field to Subject.   By default,
  93.           mpack will prompt for the contents of the subject
  94.           header.
  95.  
  96.      -d descriptionfile
  97.           Include the contents of the file descriptionfile in an
  98.           introductory section at the beginning of the first
  99.           generated message.
  100.  
  101.      -m maxsize
  102.           Split the message (if necessary) into partial messages,
  103.           each not exceeding maxsize characters.  The default
  104.           limit is the value of the SPLITSIZE environment 
  105.       variable, or no limit if the environment variable
  106.           does not exist.  Specifying a maxsize of 0 means there
  107.           is no limit to the size of the generated message.
  108.  
  109.      -c content-type
  110.           Label the included file as being of MIME type
  111.           content-type, which must be a subtype of application,
  112.           audio, image, or video.  If this switch is not given,
  113.           mpack examines the file to determine its type.
  114.  
  115.      -o outputfile
  116.           Write the generated message to the file outputfile.  If
  117.           the message has to be split, the partial messages will
  118.           instead be written to the files outputfile.01,
  119.           outputfile.02, etc.
  120.  
  121.  
  122. The environment variables which control mpack's behavior are:
  123.  
  124.      SPLITSIZE
  125.           Default value of the -m switch.  Default "0".
  126.  
  127.      TMPDIR        [unix version only]
  128.       Directory to store temporary files.  Default "/tmp".
  129.  
  130.      HOSTNAME      [pc and amiga versions only]
  131.           Fully qualified domain name to use in generated message-ids.
  132.       Default "random-pc" or "random-maiga".
  133.  
  134.      DOMAINNAME    [amiga version only]
  135.           If $HOSTNAME does not have a '.' in it, this is appended to
  136.           $HOSTNAME to get the domain to use. Default is
  137.           "random-domain".
  138.  
  139.      POSTNEWS       [amiga version only]
  140.       Command to use to post news. Compatible with Dillon UUCP usage.
  141.  
  142.      SENDMAIL       [amiga version only]
  143.       Command to use to send mail. Compatible with Dillon UUCP usage.
  144.        
  145.  
  146. Using munpack:
  147.  
  148. Mpack is used to decode one or more messages in MIME or
  149. split-uuencoded format and extract the embedded files.  The program is
  150. invoked with:
  151.  
  152.     munpack [options] filename...
  153.  
  154. which reads the messages in the files "filename...".  The pc version
  155. does accept wildcards.  Munpack may also be invoked with just:
  156.  
  157.     munpack [options]
  158.  
  159. which reads a message from the standard input.
  160.  
  161. The amiga version does not accept wildcards. Under AmigaDOS prior to
  162. 2.0, only filenames are allowed. Under AmigaDOS 2.0 or later, the Unix
  163. options are supported, with extra flexibility. Use "munpack ?" for a
  164. list of options; a second "?" will print more information.
  165.  
  166. If the message suggests a file name to use for the imbedded part, that
  167. name is cleaned of potential problem characters and used for the
  168. output file.  If the suggested filename includes subdirectories, they
  169. will be created as necessary.  If the message does not suggest a file
  170. name, the names "part01", "part02", etc are used in sequence.
  171.  
  172. If the imbedded part was preceded with textual information, that
  173. information is also written to a file. The file is named the same as
  174. the imbedded part, with any filename extension replaced with ".desc"
  175. on the unix version or with ".dsc" on the pc version.
  176.  
  177. The possible options are:
  178.  
  179.      -f
  180.           Forces the overwriting of existing files.  If a message
  181.           suggests a file name of an existing file, the file will be
  182.           overwritten.  Without this flag, the unix version appends
  183.           ".1", ".2", etc to find a nonexistent file.  Without this
  184.           flag, the pc version replaces any filename extension with
  185.           ".1", ".2", etc to find a nonexistent file.
  186.  
  187.      -t
  188.       Also unpack the text parts of multipart messages to files.
  189.       By default, text parts that do not have a filename parameter
  190.       do not get unpacked.
  191.  
  192.      -q
  193.           Be quiet--suppress messages about saving partial messages.
  194.  
  195.      -C directory
  196.           Change the current directory to "directory" before reading
  197.           any files.  This is useful when invoking munpack
  198.           from a mail or news reader.
  199.  
  200. The environment variables which control munpack's behavior are:
  201.  
  202.      TMPDIR    [unix version]
  203.           Root of directory to store partial messages awaiting 
  204.           reassembly.  Default is "/tmp".   Partial messages are
  205.       stored in subdirectories of $TMPDIR/message-parts-$USER/
  206.  
  207.      TMP    [pc version]
  208.           Root of directory to store partial messages awaiting
  209.           reassembly.  Default is "\tmp".  Partial messages are
  210.           stored in subdirectories of $TMP/parts/
  211.  
  212.      METAMAIL_P_DIR [amiga version only]
  213.           Root of directory to store partial messages awaiting 
  214.           reassembly.  Default is "t:".   Partial messages are
  215.       stored in subdirectories of METAMAIL_P_DIR.
  216.  
  217.      USER, USERNAME [amiga version only]
  218.      Subdirectory of METMAIL_P_DIR where mime parts are stored. USER
  219.      is checked first, then USERNAME. Default "anonymous".
  220.           
  221.  
  222. Special note on environment variables in the amiga version. If the
  223. shared library netsupport.library is available, it will be used to get
  224. the value of the environment variables. This allows them to be set in
  225. uulib:config file instead of in the environment. If this library not
  226. present, then a warning that the library was not found is printed. You
  227. may ignore this warning.
  228.  
  229. Acknowledgements:
  230.  
  231. Written by John G. Myers, jgm+@cmu.edu
  232. The mac version was written by Christopher J. Newman, chrisn+@cmu.edu
  233. The amiga port was done by Mike W. Meyer, mwm@contessa.phone.net.
  234.  
  235. Thanks to Nathaniel Borenstein for testing early versions of mpack and
  236. for making many helpful suggestions.
  237.  
  238.  
  239. Reporting bugs:
  240.  
  241. Bugs and comments should be reported to jgm+@cmu.edu.  Please include
  242. the version number and the platform in the report.
  243.  
  244.  
  245. Legalese:
  246.  
  247. (C) Copyright 1993 by John G. Myers and Christopher J. Newman
  248. All Rights Reserved.
  249.  
  250. Permission to use, copy, modify, distribute, and sell this software
  251. and its documentation for any purpose is hereby granted without fee,
  252. provided that the above copyright notice appear in all copies and that
  253. both that copyright notice and this permission notice appear in
  254. supporting documentation, and that the name of John G. Myers or
  255. Christopher J. Newman not be used in advertising or publicity
  256. pertaining to distribution of the software without specific, written
  257. prior permission.  John G.  Myers and Christopher J. Newman make no
  258. representations about the suitability of this software for any
  259. purpose.  It is provided "as is" without express or implied warranty.
  260.  
  261. JOHN G. MYERS AND CHRISTOPHER J. NEWMAN DISCLAIM ALL WARRANTIES WITH
  262. REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF
  263. MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL JOHN G. MYERS OR
  264. CHRISTOPHER J. NEWMAN BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  265. CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  266. USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  267. OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  268. PERFORMANCE OF THIS SOFTWARE.
  269.  
  270.  
  271. Portions of this software are derived from code written by Bell
  272. Communications Research, Inc. (Bellcore) and by RSA Data Security,
  273. Inc. and bear similar copyrights and disclaimers of warranty.
  274.  
  275.