home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / m / mpack / !Mpack / !Munpack / ReadMe152 < prev   
Text File  |  1996-10-17  |  16KB  |  387 lines
  1. mpack/munpack 1.5.2 public beta (beta 4)
  2.  
  3. This is a public beta release.  It would be a full release except that I've
  4. recently been sent the development sources for the next cross-platform
  5. version.  So I've tidied up the loose ends in this version and released it
  6. "unofficially".  Please reports any bugs/comments, as othwerwise they are
  7. likely to be present in the next official release.
  8.  
  9. The current Wimp interface to !Mpack is very crude.  The development sources
  10. have a new, more flexible library for creating MIME messages, so (provided
  11. I have time) !Mpack's GUI should be greatly improved.
  12.  
  13. If you prefer to use command line tools, you'll find the executables mpack
  14. and munpack inside !Mpack and !Munpack respectively.  These work pretty
  15. much as they used to -- I've added a "-w" switch to each which if specified
  16. starts up the wimp frontend.
  17.  
  18. Changes since 1.5.2 beta 3:
  19.  
  20. * !Munpack and !Mpack now respond to Message_DataSave so files dragged from
  21.   other apps get processed (rather than ignored).
  22.  
  23. Changes since 1.5.2 beta 2:
  24.  
  25. * Added dialog box to !Munpack to allow options to be changed during run, and
  26.   also menu options to load/save choices.
  27.  
  28. * Added code to create unpack directory if it doesn't exist (one level only
  29.   at present).
  30.  
  31. * Added wimp interface to mpack.  Currently it's lacking in many ways --
  32.   output filename is fixed, message subject is fixed, etc.
  33.  
  34. * Mpack now uses RISC OS filetype in helping choose a MIME "Content-Type:".
  35.  
  36. * Code to create store directory for multiparts now chooses DOSFS-friendly
  37.   names.
  38.  
  39. * "^" is more carefully checked for in output filenames.  Before it couldn't
  40.   be sneaked in to produce output in a higher level directory, but in some
  41.   circumstances it could get into leafnames producing illegal filenames.
  42.  
  43. * File-suffix counter is now reset after each file (change copied back from
  44.   development sources for next cross-platform release).
  45.  
  46. * Warning box given if application with !Boot is unpacked.
  47.  
  48. Changes since 1.5.2 beta 1:
  49.  
  50. * Fixed munpack bug: unpacking a !Marcel directory structure, then a normal
  51.   attachment gave error due to internal state not being reset.
  52.  
  53. * Tidied up error reporting.
  54.  
  55. Changes since 1.5:
  56.  
  57. * Wimp front-end to munpack.  Quick help:  drag message to icon to decode,
  58.   click SELECT on icon to view munpack scrap directory.  !Munpack.munpack
  59.   can still be used in command line mode if you want.
  60.  
  61. * Rewritten to not use UnixLib, which means the executables are noticeably 
  62.   smaller and probably a bit faster.
  63.  
  64. * Fixed a number of filename handling bugs (e.g. FOO.GIF would only unpack
  65.   as file GIF in directory FOO before).  Should truncate names if necessary,
  66.   but shouldn't if the filing system supports long names (or if LongFiles
  67.   or similar is running).
  68.  
  69. * Added auto-filetyping by extension and/or content-type.
  70.  
  71. Bug reports and other comments are greatly appreciated.
  72.  
  73. Olly
  74.  
  75. P.S. Here's the readme from 1.5 which is still mostly correct:
  76. ===========================================================================
  77.  
  78.                  mpack/munpack version 1.5 for archimedes
  79.  
  80. Mpack and munpack are utilities for encoding and decoding
  81. (respectively) binary files in MIME (Multipurpose Internet Mail
  82. Extensions) format mail messages.  For compatibility with older forms
  83. of transferring binary files, the munpack program can also decode
  84. messages in split-uuencoded format.  The Macintosh version can also
  85. decode messages in split-BinHex format.
  86.  
  87. The Archimedes port interworks with Marcel (ANT's RISC OS MIME-compliant
  88. MUA) to preserve filetypes, timestamps and access permissions.  munpack
  89. should correctly unpack any Marcel message.  At present, mpack doesn't
  90. include the filetype, etc. information.  This may be implemented in a
  91. future release.
  92.  
  93. Versions are included for unix, pc, os2, mac, amiga and archimedes
  94. systems.  The canonical FTP site for this software is
  95. ftp.andrew.cmu.edu:pub/mpack/
  96.  
  97. This MIME implementation is intended to be as simple and portable as
  98. possible.  For a slightly more sophisticated MIME implementation, see
  99. the program MetaMail, available via anonymous FTP to
  100. thumper.bellcore.com, in directory pub/nsb
  101.  
  102.  
  103. Decoding MIME messages:
  104.  
  105. To decode a MIME message, first save it to a text file.  If possible,
  106. save it with all headers included.  Munpack can decode some MIME files
  107. when the headers are missing or incomplete, other files it cannot
  108. decode without having the information in the headers.  In general,
  109. messages which have a statement at the beginning that they are in MIME
  110. format can be decoded without the headers.  Messages which have been
  111. split into multiple parts generally require all headers in order to be
  112. reassembled and decoded.
  113.  
  114. Some LAN-based mail systems and some mail providers (including America
  115. Online, as of the writing of this document) place the mail headers at
  116. the bottom of the message, instead of at the top of the message.  If
  117. you are having problems decoding a MIME message on such a system, you
  118. need to convert the mail back into the standard format by removing the
  119. system's nonstandard headers and moving the standard Internet headers
  120. to the top of the message (separated from the message body with a
  121. blank line).
  122.  
  123. There must be exactly one message per file.  Munpack cannot deal with
  124. multiple messages in a single file, to decode things correctly it must
  125. know when one message ends and the next one begins.
  126.  
  127. To decode a message, run the command:
  128.  
  129.     munpack file
  130.  
  131. where "file" is the name of the file containing the message.  More than
  132. one filename may be specified, munpack will try to decode the message in
  133. each file.  For more information on ways to run munpack, see the section
  134. "Using munpack" below.
  135.  
  136.  
  137. Reporting bugs:
  138.  
  139. Bugs and comments should be reported to mpack-bugs@andrew.cmu.edu.
  140. When reporting bugs or other problems, please include the following
  141. information:
  142.  
  143.   * The version number of Mpack
  144.   * The platform (Unix, PC, OS/2, Mac, Amiga, Archimedes)
  145.   * The EXACT output of any unsuccessful attempts.
  146.   * If having a problem decoding, the first couple of lines
  147.     of the input file.
  148.  
  149.  
  150. Compilation:
  151.  
  152. The RISC OS sources have been compiled with Acorn C version 4.0 and
  153. UnixLib 3.6e (ftp-able from micros.hensa.ac.uk).
  154.  
  155. Using mpack:
  156.  
  157. Mpack is used to encode a file into one or more MIME format messages.
  158. The program is invoked with:
  159.  
  160.     mpack [options] -o outputfile file
  161.  
  162. Where "[options]" is one or more optional switches described below.
  163. "-o outputfile" is also described below. "file" is the name of the
  164. file to encode.
  165. The possible options are:
  166.  
  167.      -s subject
  168.           Set the Subject header field to Subject.   By default,
  169.           mpack will prompt for the contents of the subject
  170.           header.
  171.  
  172.      -d descriptionfile
  173.           Include the contents of the file descriptionfile in an
  174.           introductory section at the beginning of the first
  175.           generated message.
  176.  
  177.      -m maxsize
  178.           Split the message (if necessary) into partial messages,
  179.           each not exceeding maxsize characters.  The default
  180.           limit is the value of the SPLITSIZE environment 
  181.       variable, or no limit if the environment variable
  182.           does not exist.  Specifying a maxsize of 0 means there
  183.           is no limit to the size of the generated message.
  184.  
  185.      -c content-type
  186.           Label the included file as being of MIME type
  187.           content-type, which must be a subtype of application,
  188.           audio, image, or video.  If this switch is not given,
  189.           mpack examines the file to determine its type.
  190.  
  191.      -o outputfile
  192.           Write the generated message to the file outputfile.  If
  193.           the message has to be split, the partial messages will
  194.           instead be written to the files outputfile/01,
  195.           outputfile/02, etc.
  196.  
  197. The environment variables which control mpack's behavior are:
  198.  
  199.      SPLITSIZE
  200.           Default value of the -m switch.  Default "0".
  201.  
  202.      HOSTNAME
  203.           Fully qualified domain name to use in generated message-ids.
  204.       Default "random-arc".
  205.  
  206.  
  207. Using munpack:
  208.  
  209. Munpack is used to decode one or more messages in MIME or
  210. split-uuencoded format and extract the embedded files.  The program is
  211. invoked with:
  212.  
  213.     munpack [options] filename...
  214.  
  215. which reads the m