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