home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 28 / amigaformatcd28.iso / -seriously_amiga- / archivers / mpackppc / src / readme.dos < prev    next >
Text File  |  1998-04-27  |  12KB  |  289 lines
  1.                     mpack/munpack version 1.5 for dos
  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 compatibility with older forms
  6. of transferring binary files, the munpack program can also decode
  7. messages in split-uuencoded format.  The Macintosh version can also
  8. decode messages in split-BinHex format.
  9.  
  10. Versions are included for unix, pc, os2, mac, amiga and archimedes
  11. systems.  The canonical FTP site for this software is
  12. ftp.andrew.cmu.edu:pub/mpack/
  13.  
  14. This MIME implementation is intended to be as simple and portable as
  15. possible.  For a slightly more sophisticated MIME implementation, see
  16. the program MetaMail, available via anonymous FTP to
  17. thumper.bellcore.com, in directory pub/nsb
  18.  
  19.  
  20. Decoding MIME messages:
  21.  
  22. To decode a MIME message, first save it to a text file.  If possible,
  23. save it with all headers included.  Munpack can decode some MIME files
  24. when the headers are missing or incomplete, other files it cannot
  25. decode without having the information in the headers.  In general,
  26. messages which have a statement at the beginning that they are in MIME
  27. format can be decoded without the headers.  Messages which have been
  28. split into multiple parts generally require all headers in order to be
  29. reassembled and decoded.
  30.  
  31. Some LAN-based mail systems and some mail providers (including America
  32. Online, as of the writing of this document) place the mail headers at
  33. the bottom of the message, instead of at the top of the message.  If
  34. you are having problems decoding a MIME message on such a system, you
  35. need to convert the mail back into the standard format by removing the
  36. system's nonstandard headers and moving the standard Internet headers
  37. to the top of the message (separated from the message body with a
  38. blank line).
  39.  
  40. There must be exactly one message per file.  Munpack cannot deal with
  41. multiple messages in a single file, to decode things correctly it must
  42. know when one message ends and the next one begins.
  43.  
  44. To decode a message, run the command:
  45.  
  46.     munpack file
  47.  
  48. where "file" is the name of the file containing the message.  More than
  49. one filename may be specified, munpack will try to decode the message in
  50. each file.  For more information on ways to run munpack, see the section
  51. "Using munpack" below.
  52.  
  53.  
  54. Reporting bugs:
  55.  
  56. Bugs and comments should be reported to mpack-bugs@andrew.cmu.edu.
  57. When reporting bugs or other problems, please include the following
  58. information:
  59.  
  60.   * The version number of Mpack
  61.   * The platform (Unix, PC, OS/2, Mac, Amiga, Archimedes)
  62.   * The EXACT output of any unsuccessful attempts.
  63.   * If having a problem decoding, the first couple of lines
  64.     of the input file.
  65.  
  66.  
  67. Compilation:
  68.  
  69. Using mpack:
  70.  
  71. Mpack is used to encode a file into one or more MIME format messages.
  72. The program is invoked with:
  73.  
  74.     mpack [options] -o outputfile file
  75.  
  76. Where "[options]" is one or more optional switches described below.
  77. "-o outputfile" is also described below. "file" is the name of the
  78. file to encode.
  79. The possible options are:
  80.  
  81.      -s subject
  82.           Set the Subject header field to Subject.   By default,
  83.           mpack will prompt for the contents of the subject
  84.           header.
  85.  
  86.      -d descriptionfile
  87.           Include the contents of the file descriptionfile in an
  88.           introductory section at the beginning of the first
  89.           generated message.
  90.  
  91.      -m maxsize
  92.           Split the message (if necessary) into partial messages,
  93.           each not exceeding maxsize characters.  The default
  94.           limit is the value of the SPLITSIZE environment 
  95.       variable, or no limit if the environment variable
  96.           does not exist.  Specifying a maxsize of 0 means there
  97.           is no limit to the size of the generated message.
  98.  
  99.      -c content-type
  100.           Label the included file as being of MIME type
  101.           content-type, which must be a subtype of application,
  102.           audio, image, or video.  If this switch is not given,
  103.           mpack examines the file to determine its type.
  104.  
  105.      -o outputfile
  106.           Write the generated message to the file outputfile.  If
  107.           the message has to be split, the partial messages will
  108.           instead be written to the files outputfile.01,
  109.           outputfile.02, etc.
  110.  
  111. The environment variables which control mpack's behavior are:
  112.  
  113.      SPLITSIZE
  114.           Default value of the -m switch.  Default "0".
  115.  
  116.  
  117. Using munpack:
  118.  
  119. Munpack is used to decode one or more messages in MIME or
  120. split-uuencoded format and extract the embedded files.  The program is
  121. invoked with:
  122.  
  123.     munpack [options] filename...
  124.  
  125. which reads the messages in the files "filename...".  Munpack may also
  126. be invoked with just:
  127.  
  128.     munpack [options]
  129.  
  130. which reads a message from the standard input.
  131.  
  132. If the message suggests a file name to use for the imbedded part, that
  133. name is cleaned of potential problem characters and used for the
  134. output file.  If the suggested filename includes subdirectories, they
  135. will be created as necessary.  If the message does not suggest a file
  136. name, the names "part1", "part2", etc are used in sequence.
  137.  
  138. If the imbedded part was preceded with textual information, that
  139. information is also written to a file. The file is named the same as
  140. the imbedded part, with any filename extension replaced with
  141. ".desc"
  142.  
  143. The possible options are:
  144.  
  145.      -f
  146.           Forces the overwriting of existing files.  If a message
  147.           suggests a file name of an existing file, the file will be
  148.  
  149.      -t
  150.       Also unpack the text parts of multipart messages to files.
  151.       By default, text parts that do not have a filename parameter
  152.       do not get unpacked.
  153.  
  154.      -q
  155.           Be quiet--suppress messages about saving partial messages.
  156.  
  157.      -C directory
  158.           Change the current directory to "directory" before reading
  159.           any files.  This is useful when invoking munpack
  160.           from a mail or news reader.
  161.  
  162. The environment variables which control munpack's behavior are:
  163.  
  164.  
  165. Acknowledgements:
  166.  
  167. Written by John G. Myers, jgm+@cmu.edu
  168.  
  169. The mac version was written by Christopher J. Newman, chrisn+@cmu.edu
  170.  
  171. The amiga port was done by Mike W. Meyer, mwm@contessa.phone.net and
  172. Peter Simons, simons@peti.GUN.de
  173.  
  174. The os2 port was done by Jochen Friedrich, jochen@audio.pfalz.de
  175.  
  176. The archimedes port was done by Olly Betts, olly@mantis.co.uk
  177.  
  178. Send all bug reports to mpack-bugs@andrew.cmu.edu 
  179.  
  180. Thanks to Nathaniel Borenstein for testing early versions of mpack and
  181. for making many helpful suggestions.
  182.  
  183.  
  184. PGP signature:
  185.  
  186. Starting with version 1.5, all official mpack distributions are PGP
  187. signed by "John Gardiner Myers <jgm+@cmu.edu>".  The PGP signatures
  188. are detached from the distributions themselves, in files with the
  189. ".asc" filename extension.  If the location where you obtained mpack
  190. does not include the PGP signature, or if the signature is not valid
  191. for the distribution, please complain to the maintainer of the
  192. relevant distribution site.
  193.  
  194. A valid PGP signature indicates that the distribution is the one that
  195. I put together; it specifically does not indicate any warranty of any
  196. kind on the software.  The Unix and DOS versions were done by myself,
  197. the DOS binaries were checked for viruses using an up-to-date virus
  198. checker.  The Macintosh version was done by a colleague I have reason
  199. to trust.  All other versions were done and compiled by people I have
  200. had no personal contact with.
  201.  
  202. My PGP public key follows:
  203.  
  204. -----BEGIN PGP PUBLIC KEY BLOCK-----
  205. Version: 2.6.1
  206.  
  207. mQBtAi5Sd2AAAAEDANBa5/iCcCUkCsDtSpWIKfwEhqAFOoIE61j7Q/Q+mdU4V/BK
  208. ttboCOk9ZDtGKYhMFvH31I7bAECruV1GIa/awbfI0EMfZwQ+U0YhOUScXfm2ARIv
  209. XotV0HJqmwnIWCbPjQAFEbQiSm9obiBHYXJkaW5lciBNeWVycyA8amdtK0BjbXUu
  210. ZWR1PokAlQMFEC77TI7FLUdtDb+QbQEBhMcD/1gmEtykw84iYmo9TjlCg8hfzqJs
  211. /TvRlUKoNF3oGG7M9h4zmP1AwL75B2/k3UnD39LsTc15J4ZWbH/VwVWPT73rRBwD
  212. hGS33ep1JAP1koB3f1RIjZ3jrRSbdVt45W2l1A+aAPP8oHs7Uf+eSINx7DA6THuu
  213. W14BeJyVu9acBKuriQCVAgUQLvs8nVsjC0SkKFUJAQHbFwP9Gzb+p3z73o6p4A9k
  214. 5xqwr8WpmTBMFITM6p9gLe//RlR3Mh2u6/rYZEPJ73wpokHi3ArEICCG2+58IZpt
  215. WTV0FUPoXZz1bZ+N45yGCPEw2Ibgr6AWHvQzUeIDICWS4D/IPN73QUfifRHQmEeb
  216. 3N7YIr63XoACun8oZZrM6OhVfIGJAJUDBRAu5r4dhxvAWY8bGaUBAdipA/4zxuYA
  217. A/C34f4M+3Ta/F3yY8ooxboLyYiqej0i5uK4w51XjJeRoS6c49hi8m5yw8SQ1VmQ
  218. Suk3pTHSYuE9hermX6ET7tMp5sGB1oIy/1zyoxZfLCbWj2UPHUsVJsMagAn3HbF0
  219. UHZMkCj4WothYNSrMfCnswoWjDKQxVIDVKLkpokAlAMFEC7woYNnNYxubw4jcQEB
  220. qQMD9RDnxCyCHatULx+/KUrJLIYaayZe1D/C2VC0QzzdmxHkcAcc5tjuD1S7igJW
  221. +9hftwlf4EJx1NCSjhteNk57W7bcrLEdi4PInwFNXAuiCUzhLvoBRXQbHEuhM39f
  222. hjATkSTIBX9OrwwSJS2IvuuEaZGy1PJSuCqHg88paZlPRYaJAFUDBRAu59rLqn0S
  223. 2IICPJ0BAYo8AgDCDXoqwVsLKofrHFvVc2/S2MHLtNFhWLmep5D26Uk1uKy6E6vw
  224. pFxjbmr41rPepxYdR32218yIYqEG5RQRcjdOiQCVAwUQLuf5rjJyiM5s7VOJAQHv
  225. UwQArtoqCX1Y9u21KuPP439P5Xcg2MexhAmnYD7JP0d5rHcvp0LYfUsOFAZKpRwl
  226. eLqvzkVnUjVR3X3ehmTQdRNRV6o9LVMXYQmMpoZUQlmR/+ilsNjflhKPwx3PpvYT
  227. AGDMv8QlALKc3gN8wJCxq9iW8DHbTWmoYFDiK74FwbDRjDWJAJUDBRAu5rwCRBVw
  228. zUZrQokBAR5pBADAm/0bxhJMfNGT1/d7eaaGWzo0DZ21UulyPzGGQKhvqT2OqFxJ
  229. ulUL+EYyxeKC7GxkcX7cICcQBNTRt9Ul0ooCT/szGneYeUnotp4dWRRxk8e09kjf
  230. +mLo5imR9OI1cUpjo8AJCpFvp/p6GRlS0WhCzdyD4dYsK3pDL3WCsOfD5YkAlQMF
  231. EC7oAXVJt7YjNP0hXQEBMoQD/R2IYpH9EluRureUWg6Oi3uZlMM6gCTz/cWhjNKC
  232. nwbP5VG/J0TqPIGq7VI6ORM9PwfN5CElYNAHhyetSPdH51+jdPY7g80bMvV1QH5U
  233. DtDOD7zjKo4ZcyRu6d7pz14o5yoRiU2bwFa2obcqFBA077j3sVYHU5Rie6ZZWnSU
  234. /ovHiQCVAwUQLuf9K5DwvktRSrLVAQE4IwP/d/j2hNOdHTdH/fs4DuKF2ATDmeIP
  235. vZzxVD2PpyRVfUTd5cypOnPdw0kBhMMTSHo33A+WR5zy+ZosDpg9a/qJwGmnSB7z
  236. puwGMnBGXQZs8CtcqvqMGlyeMLihJa6pLc6KA29mI8XvgtUiBQa5jm7Ga6Aor4K8
  237. zetpHCP8sbgb7D+JAJUDBRAu5rxv+8I/jbEzFDkBAbDoBACa3YIC2hSK00lQhSo7
  238. GvgldN6YjDs0zAnYoiT55z1vi06etQSx0c0jad6+CX4ctK4g3fUZuw6SIbGkk8tU
  239. Rq1Vl3pHertzbY6VIOt+zTXwlMaH+Jv/wP/FJBI3VkGpRvjWNTtAxaXBAV5va5wd
  240. mcj9JtfpVR77CnHNSSMnRqZsFIkAlQMFEC7m1plfgDcY2g7cgQEBxFkEAJehxpIS
  241. EXxr7AyrkyMH7FylxSf2kiVTRko5hmPm30i7q3d4Bxx6qSItERTykvPy4EhWfUG5
  242. 4OMyD68cIX4ovK4cJ4YK+ZiF8OyDjEVX5E1oXdoc7DQb9eIlEnB7B7orDNYVKxJh
  243. In+IVYmvb4MalsPb7kCik7yplZ6Eu507AD3GiQCVAwUQLua8MH0RF3HCK4zZAQE1
  244. 2AP/TlPe1fVdsgR8z87Mtjp5AyxskKLCH1D/CA8kz19kjmO/aQzP0GxZInX6YvUv
  245. 5Ct7Fk3hjdY6PsnK4Vuykeny00nheQRdL/rkjIXZ4fRpPGPDXJwIhdL4tG8Yh+U2
  246. +PWwg3wy96C2AePDgMz7zpRMF6N5Kc/JJ1zV5DaZu7Wk3jmJAJUDBRAu5sNxq/8H
  247. tEbzIS0BAQxlA/4nbmzbeSKFRwGHe62FydmBE3icDvNYNKGO7+oQQRxayF8ZnYjj
  248. bz6UiL9HZmDa0flSURaXuZTCzo+N2TDr5PbCLb2Nvs8bBFps+rcBfsXtv66LZn4k
  249. ukan9MwUS02PK7L/cV3jURzpjead/vqkh7jYVlwB/Wg1c0aVkHt0F7XiRYkAlQMF
  250. EC7mv4WE37rmLVJ+MQEB0JsD/0ow7V3u78AOEj+FJAH182V03EFk+4YYpyHF1DHA
  251. cCWJoCQ9DrcQ+mnMd73hs4AsF5NRXQXpbI7ocZADOG7kqcTAyedX6xHUisYl08Pv
  252. vPlTRCQkgSRNAF1U2MWq8C7mI/LuyLvsSoFedQlaqi5J0Xm5x2IJzm1p3ukre3Sq
  253. 4CQCiQCVAgUQLlKInRNhgovrPB7dAQGF2wP/ZhaTYW2M8zTPAmCIgeZqHJeMWic+
  254. bGeiCB9ICvcQV0dsBXm/26YXwCXnOVoryY5ToCpj5d2zmvAPBTBOx8GrnAPCOHoH
  255. tumQn5ODeRXhyc+jcSKbk/1jAEteEyJJ+KBTVnJ5LymI3Ayv1aWUmdvJhLGavxl9
  256. Wi3bjI/bpV0eE+g=
  257. =pCCQ
  258. -----END PGP PUBLIC KEY BLOCK-----
  259.  
  260. Legalese:
  261.  
  262. (C) Copyright 1993,1994 by Carnegie Mellon University
  263. All Rights Reserved.
  264.  
  265. Permission to use, copy, modify, distribute, and sell this software
  266. and its documentation for any purpose is hereby granted without fee,
  267. provided that the above copyright notice appear in all copies and that
  268. both that copyright notice and this permission notice appear in
  269. supporting documentation, and that the name of Carnegie Mellon
  270. University not be used in advertising or publicity pertaining to
  271. distribution of the software without specific, written prior
  272. permission.  Carnegie Mellon University makes no representations about
  273. the suitability of this software for any purpose.  It is provided "as
  274. is" without express or implied warranty.
  275.  
  276. CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  277. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  278. AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  279. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  280. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  281. AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  282. OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  283. SOFTWARE.
  284.  
  285. Portions of this software are derived from code written by Bell
  286. Communications Research, Inc. (Bellcore) and by RSA Data Security,
  287. Inc. and bear similar copyrights and disclaimers of warranty.
  288.  
  289.