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