home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / Amiga / Workbench / Archivers / mpackPPC.lha / mpackPPC / src / README.amiga < prev    next >
Text File  |  1998-04-08  |  14KB  |  344 lines

  1.                    mpack/munpack version 1.5 for amiga
  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. The amiga sources have been compiled with SAS/C version 6.3. To compile
  70. with SAS/C, use the command "smake".
  71.  
  72. Using mpack:
  73.  
  74. Mpack is used to encode a file into one or more MIME format messages.
  75. The program is invoked with:
  76.  
  77.     mpack [options] -o outputfile file
  78.  
  79. or 
  80.  
  81.     mpack [options] file address...
  82.  
  83. or
  84.  
  85.     mpack [options] -n newsgroups file
  86.  
  87. Where "[options]" is one or more optional switches described below.
  88. "-o outputfile" is also described below. "file" is the name of the
  89. file to encode, "address..." is one or more e-mail address to mail the
  90. resulting messages to and "newsgroups" is a comma-separated list of
  91. newsgroups to post the resulting messages to.
  92.  
  93. There is extra flexibility in the options and addresses.  Use "mpack
  94. ?" for a list of options; a second "?" will print more information.
  95. AmigaDOS 2.0 or later is required to run mpack.
  96.  
  97. The possible options are:
  98.  
  99.      -s subject
  100.           Set the Subject header field to Subject.   By default,
  101.           mpack will prompt for the contents of the subject
  102.           header.
  103.  
  104.      -d descriptionfile
  105.           Include the contents of the file descriptionfile in an
  106.           introductory section at the beginning of the first
  107.           generated message.
  108.  
  109.      -m maxsize
  110.           Split the message (if necessary) into partial messages,
  111.           each not exceeding maxsize characters.  The default
  112.           limit is the value of the SPLITSIZE environment 
  113.       variable, or no limit if the environment variable
  114.           does not exist.  Specifying a maxsize of 0 means there
  115.           is no limit to the size of the generated message.
  116.  
  117.      -c content-type
  118.           Label the included file as being of MIME type
  119.           content-type, which must be a subtype of application,
  120.           audio, image, or video.  If this switch is not given,
  121.           mpack examines the file to determine its type.
  122.  
  123.      -o outputfile
  124.           Write the generated message to the file outputfile.  If
  125.           the message has to be split, the partial messages will
  126.           instead be written to the files outputfile.01,
  127.           outputfile.02, etc.
  128.  
  129. The environment variables which control mpack's behavior are:
  130.  
  131.      SPLITSIZE
  132.           Default value of the -m switch.  Default "0".
  133.  
  134.      HOSTNAME
  135.           Fully qualified domain name to use in generated message-ids.
  136.       Default "random-pc" or "random-amiga".
  137.  
  138.      DOMAINNAME
  139.           If $HOSTNAME does not have a '.' in it, this is appended to
  140.           $HOSTNAME to get the domain to use. Default is
  141.           "random-domain".
  142.  
  143.      POSTNEWS
  144.       Command to use to post news. Compatible with Dillon UUCP usage.
  145.  
  146.      SENDMAIL
  147.       Command to use to send mail. Compatible with Dillon UUCP usage.
  148.  
  149.  
  150. Using munpack:
  151.  
  152. Munpack is used to decode one or more messages in MIME or
  153. split-uuencoded format and extract the embedded files.  The program is
  154. invoked with:
  155.  
  156.     munpack [options] filename...
  157.  
  158. which reads the messages in the files "filename...".  Munpack may also
  159. be invoked with just:
  160.  
  161.     munpack [options]
  162.  
  163. which reads a message from the standard input.
  164.  
  165. Munpack does not accept wildcards.  Under AmigaDOS prior to 2.0, only
  166. filenames are allowed.  Under AmigaDOS 2.0 or later, the options
  167. described later are supported, with extra flexibility.  Use 
  168. "munpack ?" for a list of options; a second "?" will print more
  169. information.
  170.  
  171. If the message suggests a file name to use for the imbedded part, that
  172. name is cleaned of potential problem characters and used for the
  173. output file.  If the suggested filename includes subdirectories, they
  174. will be created as necessary.  If the message does not suggest a file
  175. name, the names "part1", "part2", etc are used in sequence.
  176.  
  177. If the imbedded part was preceded with textual information, that
  178. information is also written to a file. The file is named the same as
  179. the imbedded part, with any filename extension replaced with
  180. ".desc"
  181.  
  182. The possible options are:
  183.  
  184.      -f
  185.           Forces the overwriting of existing files.  If a message
  186.           suggests a file name of an existing file, the file will be
  187.           overwritten.  Without this flag, munpack appends ".1", ".2",
  188.           etc to find a nonexistent file.
  189.  
  190.      -t
  191.       Also unpack the text parts of multipart messages to files.
  192.       By default, text parts that do not have a filename parameter
  193.       do not get unpacked.
  194.  
  195.      -q
  196.           Be quiet--suppress messages about saving partial messages.
  197.  
  198.      -C directory
  199.           Change the current directory to "directory" before reading
  200.           any files.  This is useful when invoking munpack
  201.           from a mail or news reader.
  202.  
  203. The environment variables which control munpack's behavior are:
  204.  
  205.      METAMAIL_P_DIR [amiga version only]
  206.           Root of directory to store partial messages awaiting 
  207.           reassembly.  Default is "t:".   Partial messages are
  208.       stored in subdirectories of METAMAIL_P_DIR.
  209.  
  210.      USER, USERNAME
  211.      Subdirectory of METMAIL_P_DIR where mime parts are stored. USER
  212.      is checked first, then USERNAME. Default "anonymous".
  213.  
  214. If the shared library netsupport.library is available, it will be used
  215. to get the value of the environment variables. This allows them to be
  216. set in uulib:config file instead of in the environment. If this
  217. library not present, then a warning that the library was not found is
  218. printed. You may ignore this warning.
  219.  
  220. Acknowledgements:
  221.  
  222. Written by John G. Myers, jgm+@cmu.edu
  223.  
  224. The mac version was written by Christopher J. Newman, chrisn+@cmu.edu
  225.  
  226. The amiga port was done by Mike W. Meyer, mwm@contessa.phone.net and
  227. Peter Simons, simons@peti.GUN.de
  228.  
  229. The os2 port was done by Jochen Friedrich, jochen@audio.pfalz.de
  230.  
  231. The archimedes port was done by Olly Betts, olly@mantis.co.uk
  232.  
  233. Send all bug reports to mpack-bugs@andrew.cmu.edu 
  234.  
  235. Thanks to Nathaniel Borenstein for testing early versions of mpack and
  236. for making many helpful suggestions.
  237.  
  238.  
  239. PGP signature:
  240.  
  241. Starting with version 1.5, all official mpack distributions are PGP
  242. signed by "John Gardiner Myers <jgm+@cmu.edu>".  The PGP signatures
  243. are detached from the distributions themselves, in files with the
  244. ".asc" filename extension.  If the location where you obtained mpack
  245. does not include the PGP signature, or if the signature is not valid
  246. for the distribution, please complain to the maintainer of the
  247. relevant distribution site.
  248.  
  249. A valid PGP signature indicates that the distribution is the one that
  250. I put together; it specifically does not indicate any warranty of any
  251. kind on the software.  The Unix and DOS versions were done by myself,
  252. the DOS binaries were checked for viruses using an up-to-date virus
  253. checker.  The Macintosh version was done by a colleague I have reason
  254. to trust.  All other versions were done and compiled by people I have
  255. had no personal contact with.
  256.  
  257. My PGP public key follows:
  258.  
  259. -----BEGIN PGP PUBLIC KEY BLOCK-----
  260. Version: 2.6.1
  261.  
  262. mQBtAi5Sd2AAAAEDANBa5/iCcCUkCsDtSpWIKfwEhqAFOoIE61j7Q/Q+mdU4V/BK
  263. ttboCOk9ZDtGKYhMFvH31I7bAECruV1GIa/awbfI0EMfZwQ+U0YhOUScXfm2ARIv
  264. XotV0HJqmwnIWCbPjQAFEbQiSm9obiBHYXJkaW5lciBNeWVycyA8amdtK0BjbXUu
  265. ZWR1PokAlQMFEC77TI7FLUdtDb+QbQEBhMcD/1gmEtykw84iYmo9TjlCg8hfzqJs
  266. /TvRlUKoNF3oGG7M9h4zmP1AwL75B2/k3UnD39LsTc15J4ZWbH/VwVWPT73rRBwD
  267. hGS33ep1JAP1koB3f1RIjZ3jrRSbdVt45W2l1A+aAPP8oHs7Uf+eSINx7DA6THuu
  268. W14BeJyVu9acBKuriQCVAgUQLvs8nVsjC0SkKFUJAQHbFwP9Gzb+p3z73o6p4A9k
  269. 5xqwr8WpmTBMFITM6p9gLe//RlR3Mh2u6/rYZEPJ73wpokHi3ArEICCG2+58IZpt
  270. WTV0FUPoXZz1bZ+N45yGCPEw2Ibgr6AWHvQzUeIDICWS4D/IPN73QUfifRHQmEeb
  271. 3N7YIr63XoACun8oZZrM6OhVfIGJAJUDBRAu5r4dhxvAWY8bGaUBAdipA/4zxuYA
  272. A/C34f4M+3Ta/F3yY8ooxboLyYiqej0i5uK4w51XjJeRoS6c49hi8m5yw8SQ1VmQ
  273. Suk3pTHSYuE9hermX6ET7tMp5sGB1oIy/1zyoxZfLCbWj2UPHUsVJsMagAn3HbF0
  274. UHZMkCj4WothYNSrMfCnswoWjDKQxVIDVKLkpokAlAMFEC7woYNnNYxubw4jcQEB
  275. qQMD9RDnxCyCHatULx+/KUrJLIYaayZe1D/C2VC0QzzdmxHkcAcc5tjuD1S7igJW
  276. +9hftwlf4EJx1NCSjhteNk57W7bcrLEdi4PInwFNXAuiCUzhLvoBRXQbHEuhM39f
  277. hjATkSTIBX9OrwwSJS2IvuuEaZGy1PJSuCqHg88paZlPRYaJAFUDBRAu59rLqn0S
  278. 2IICPJ0BAYo8AgDCDXoqwVsLKofrHFvVc2/S2MHLtNFhWLmep5D26Uk1uKy6E6vw
  279. pFxjbmr41rPepxYdR32218yIYqEG5RQRcjdOiQCVAwUQLuf5rjJyiM5s7VOJAQHv
  280. UwQArtoqCX1Y9u21KuPP439P5Xcg2MexhAmnYD7JP0d5rHcvp0LYfUsOFAZKpRwl
  281. eLqvzkVnUjVR3X3ehmTQdRNRV6o9LVMXYQmMpoZUQlmR/+ilsNjflhKPwx3PpvYT
  282. AGDMv8QlALKc3gN8wJCxq9iW8DHbTWmoYFDiK74FwbDRjDWJAJUDBRAu5rwCRBVw
  283. zUZrQokBAR5pBADAm/0bxhJMfNGT1/d7eaaGWzo0DZ21UulyPzGGQKhvqT2OqFxJ
  284. ulUL+EYyxeKC7GxkcX7cICcQBNTRt9Ul0ooCT/szGneYeUnotp4dWRRxk8e09kjf
  285. +mLo5imR9OI1cUpjo8AJCpFvp/p6GRlS0WhCzdyD4dYsK3pDL3WCsOfD5YkAlQMF
  286. EC7oAXVJt7YjNP0hXQEBMoQD/R2IYpH9EluRureUWg6Oi3uZlMM6gCTz/cWhjNKC
  287. nwbP5VG/J0TqPIGq7VI6ORM9PwfN5CElYNAHhyetSPdH51+jdPY7g80bMvV1QH5U
  288. DtDOD7zjKo4ZcyRu6d7pz14o5yoRiU2bwFa2obcqFBA077j3sVYHU5Rie6ZZWnSU
  289. /ovHiQCVAwUQLuf9K5DwvktRSrLVAQE4IwP/d/j2hNOdHTdH/fs4DuKF2ATDmeIP
  290. vZzxVD2PpyRVfUTd5cypOnPdw0kBhMMTSHo33A+WR5zy+ZosDpg9a/qJwGmnSB7z
  291. puwGMnBGXQZs8CtcqvqMGlyeMLihJa6pLc6KA29mI8XvgtUiBQa5jm7Ga6Aor4K8
  292. zetpHCP8sbgb7D+JAJUDBRAu5rxv+8I/jbEzFDkBAbDoBACa3YIC2hSK00lQhSo7
  293. GvgldN6YjDs0zAnYoiT55z1vi06etQSx0c0jad6+CX4ctK4g3fUZuw6SIbGkk8tU
  294. Rq1Vl3pHertzbY6VIOt+zTXwlMaH+Jv/wP/FJBI3VkGpRvjWNTtAxaXBAV5va5wd
  295. mcj9JtfpVR77CnHNSSMnRqZsFIkAlQMFEC7m1plfgDcY2g7cgQEBxFkEAJehxpIS
  296. EXxr7AyrkyMH7FylxSf2kiVTRko5hmPm30i7q3d4Bxx6qSItERTykvPy4EhWfUG5
  297. 4OMyD68cIX4ovK4cJ4YK+ZiF8OyDjEVX5E1oXdoc7DQb9eIlEnB7B7orDNYVKxJh
  298. In+IVYmvb4MalsPb7kCik7yplZ6Eu507AD3GiQCVAwUQLua8MH0RF3HCK4zZAQE1
  299. 2AP/TlPe1fVdsgR8z87Mtjp5AyxskKLCH1D/CA8kz19kjmO/aQzP0GxZInX6YvUv
  300. 5Ct7Fk3hjdY6PsnK4Vuykeny00nheQRdL/rkjIXZ4fRpPGPDXJwIhdL4tG8Yh+U2
  301. +PWwg3wy96C2AePDgMz7zpRMF6N5Kc/JJ1zV5DaZu7Wk3jmJAJUDBRAu5sNxq/8H
  302. tEbzIS0BAQxlA/4nbmzbeSKFRwGHe62FydmBE3icDvNYNKGO7+oQQRxayF8ZnYjj
  303. bz6UiL9HZmDa0flSURaXuZTCzo+N2TDr5PbCLb2Nvs8bBFps+rcBfsXtv66LZn4k
  304. ukan9MwUS02PK7L/cV3jURzpjead/vqkh7jYVlwB/Wg1c0aVkHt0F7XiRYkAlQMF
  305. EC7mv4WE37rmLVJ+MQEB0JsD/0ow7V3u78AOEj+FJAH182V03EFk+4YYpyHF1DHA
  306. cCWJoCQ9DrcQ+mnMd73hs4AsF5NRXQXpbI7ocZADOG7kqcTAyedX6xHUisYl08Pv
  307. vPlTRCQkgSRNAF1U2MWq8C7mI/LuyLvsSoFedQlaqi5J0Xm5x2IJzm1p3ukre3Sq
  308. 4CQCiQCVAgUQLlKInRNhgovrPB7dAQGF2wP/ZhaTYW2M8zTPAmCIgeZqHJeMWic+
  309. bGeiCB9ICvcQV0dsBXm/26YXwCXnOVoryY5ToCpj5d2zmvAPBTBOx8GrnAPCOHoH
  310. tumQn5ODeRXhyc+jcSKbk/1jAEteEyJJ+KBTVnJ5LymI3Ayv1aWUmdvJhLGavxl9
  311. Wi3bjI/bpV0eE+g=
  312. =pCCQ
  313. -----END PGP PUBLIC KEY BLOCK-----
  314.  
  315. Legalese:
  316.  
  317. (C) Copyright 1993,1994 by Carnegie Mellon University
  318. All Rights Reserved.
  319.  
  320. Permission to use, copy, modify, distribute, and sell this software
  321. and its documentation for any purpose is hereby granted without fee,
  322. provided that the above copyright notice appear in all copies and that
  323. both that copyright notice and this permission notice appear in
  324. supporting documentation, and that the name of Carnegie Mellon
  325. University not be used in advertising or publicity pertaining to
  326. distribution of the software without specific, written prior
  327. permission.  Carnegie Mellon University makes no representations about
  328. the suitability of this software for any purpose.  It is provided "as
  329. is" without express or implied warranty.
  330.  
  331. CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
  332. THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
  333. AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
  334. FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  335. WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
  336. AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
  337. OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
  338. SOFTWARE.
  339.  
  340. Portions of this software are derived from code written by Bell
  341. Communications Research, Inc. (Bellcore) and by RSA Data Security,
  342. Inc. and bear similar copyrights and disclaimers of warranty.
  343.  
  344.