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