home *** CD-ROM | disk | FTP | other *** search
/ The AGA Experience 2 / agavol2.iso / software / utilities / comms / metamail-2.3a / readme.amiga < prev    next >
Text File  |  1992-06-28  |  13KB  |  338 lines
  1. Johan Widén                                     28-Jun-1992
  2. Hugingatan 20
  3. S-195 52  MÄRSTA
  4. Sweden
  5.  
  6. Tel: +46 8 59 120 120, fax +46 8 59 127 761
  7. Email: jw@jwdata.se
  8.  
  9.  
  10. This is a port of metamail version 2.3a to the Commodore Amiga. The current
  11. version has only been tested with Amiga OS 2.0, but there should not be any
  12. problems with 1.3. See the file CHANGES for differences between this version
  13. and the previous.
  14.  
  15. Ported programs: ezview, mailto, metamail, mmencode, richtext, splitmail.
  16.  
  17. This archive contains only the binaries. The sources can be found on
  18.     thumper.bellcore.com:pub/nsb
  19.   this directory is mirrored on
  20.     ftp.funet.fi:pub/unix/mail/metamail
  21. The metamail sources are also available via mailserver.  If you send mail to
  22.     mailserver@thumper.bellcore.com
  23. with a subject of
  24.     metamail-sources
  25. you will get back the mm.tar.Z file in MIME format.
  26. If you don't already have a previous generation of MIME software at your site,
  27. make the subject
  28.     metamail-sources-uu
  29. and you will get the sources uuencoded instead.
  30.  
  31. MIME and related standards are described in RFC's 1341-1345.
  32.  
  33.  
  34. Other files that you need
  35. =========================
  36.  
  37. The programs expect to find configuration information in
  38.     the environment
  39.   or in
  40.     S:UUConfig
  41.   or in
  42.     UULIB:Config                (Take a look at UULIB/Config.sample)
  43.  
  44. metamail and mailto relies on a configuration file called
  45.     UULIB:mailcap
  46. A sample mailcap file can be found in UULIB/mailcap
  47.  
  48. metamail and mailto provide the multimedia capability by calling other
  49. programs. These programs are speified in UULIB:mailcap. Most of these
  50. programs are not provided here. You will have to get them some other way.
  51. You will for instance need a program that can display pictures encoded
  52. in the GIF format. I will give suggestions for such programs but many others
  53. will work fine or better.
  54.  
  55.     uulib:seq
  56. A file used by Dillon UUCP to keep a unique sequence number. This file is
  57. expected to exist and contain a number.
  58.  
  59.  
  60. Integration with a normal mail program
  61. ======================================
  62.  
  63. I have changed AmigaElm-1.13 to use metamail to show MIME mail that
  64. can not be handled by Elm itself. I have also put in commands to call
  65. mailto when replying to a message.
  66.  
  67. The diffs are included here in the file Elm113Diffs.lha.
  68.  
  69.  
  70. The files in the man directory
  71. ==============================
  72.  
  73. The source code distribution contains manual pages in troff format. I have
  74. formatted the manuals and included them in the man directory. Note that
  75. some of the manual pages do *not* have a corresponding command in the
  76. bin directory. I have nevertheless included them for your convenience.
  77.  
  78. Environment variables and configuration file info uses by metamail
  79. ==================================================================
  80.  
  81.     Note: the metamail program creates several environment variables with
  82.     names starting with MM_. As the environment under Amiga OS 1.3 is global
  83.     (and no specialcasing has been done for OS 2.0) and stays around after a
  84.     program exits, the setting of some of these variables may affect later
  85.     executions of metamail. If metamail behaves strangely, then take a look at
  86.     how the environment variables env:MM_* are set.
  87.  
  88.     This is normally not a problem, but may occur when one tries out various
  89.     options to metamail.
  90.  
  91.     COLUMNS                     (environment variable)
  92.     -------
  93.         Used by richtect when deciding how to break lines. (default 80)
  94.  
  95.     domain name
  96.     -----------
  97.         Searched for in the configuration files as entry
  98.             DomainName
  99.  
  100.     EDITOR                      (environment variable)
  101.     ------
  102.         The editor used by mailto for the ~e command.
  103.  
  104.     KEYHEADS                    (environment variable)
  105.     --------
  106.         See the metamail manual page.
  107.  
  108.     LINES                       (environment variable)
  109.     -----
  110.         Used by richtext when paging the output. (default 23)
  111.  
  112.     MAILCAPS                    (environment variable)
  113.     --------
  114.         What mailcap files are to be searched. (default uulib:mailcap)
  115.  
  116.     mail editor
  117.     -----------
  118.         Searched for in the configuration files as entry
  119.             MailEditor
  120.         if the environment variables VISUAL or EDITOR are not set.
  121.  
  122.     METAMAIL_P_DIR              (environment variable)
  123.     --------------
  124.         Directory for storing message fragments of type message/partial.
  125.         (default T:message-parts)
  126.  
  127.     MM_CHARSET                  (environment variable)
  128.     ----------
  129.         The character set used when composing mail with mailto.
  130.         (default us-ascii)
  131.  
  132.     MM_*                        (environment variable)
  133.     ----
  134.         See the metamail manual page.
  135.  
  136.     node name
  137.     ---------
  138.         Searched for in the configuration files as entry
  139.             NodeName
  140.  
  141.     PAGER                       (environment variable)
  142.     -----
  143.         Used by mailto to display online help. (default more)
  144.  
  145.     sendmail
  146.     --------
  147.         The program that splitmail invokes when sending mail.
  148.         Searched for in the configuration files as entry
  149.             Sendmail
  150.         (default Sendmail)
  151.  
  152.     SPLITSIZE                   (environment variable)
  153.     ---------
  154.         See the mailto manual page.
  155.  
  156.     TERMINAL_CMD                (environment variable)
  157.     ------------
  158.         See the metamail manual page.
  159.  
  160.     VISUAL                      (environment variable)
  161.     ------
  162.         The editor used by mailto for the ~v command.
  163.  
  164.     user name
  165.     ---------
  166.         This is first looked for in environment variables USERNAME and USER.
  167.         If not found there then the configuration files are searched for
  168.             UserName
  169.  
  170.  
  171. Suggestions for programs to use with metamail and mailto
  172. ========================================================
  173.  
  174. Here are some suggestions of what you can use. If you know of something better
  175. I would like to hear about it so that I can improve the mailcap file in later
  176. releases.
  177.  
  178. audio/basic
  179. -----------
  180.     To play I call a script, playUlawSound, that is provided in AmigaSrc. The
  181.     script calls the programs
  182.         SoundZAP        converts from ulaw audio format to 8SVX audio format
  183.         AGMSPlaySound   plays 8SVX audio format
  184.     SoundZAP and AGMSPlaySound are available from many ftp hosts.
  185.  
  186.     To compose (convert actually) an audio fragment I call svxToUlaw. This
  187.     program is provided in AmigaSrc. The program calls the program
  188.         as2ss           converts from 8SVX audio format to ulaw audio format
  189.     as2ss comes from an archive called iff2ulaw.lha. This is available from
  190.     several ftp hosts. However, I had to modify the source, and as there seems
  191.     to be no redistribution restriction I provide the modified iff2ulaw in
  192.     AmigaSrc.
  193.  
  194. image/gif
  195. ---------
  196.     To show a GIF picture I call the program
  197.         GIF_view
  198.     This program is available as archive GIF_view4.lha from several ftp hosts.
  199.  
  200.     To compose (convert actually) a GIF picture I call ilbmToGIF. This program
  201.     is provided in AmigaSrc. The program calls the program
  202.         fbcat
  203.     fbcat is part of the Fuzzy PixMap image manipulation archive. It is
  204.     available on Fish disk 334. There are other program that can be used
  205.     for conversion from IFF ILBM to GIF, for instance: AmigaJPEG_v2.lzh.
  206.     The pbmplus (PBM/PGM/PPM) library, usually called pbm+.lzh, available
  207.     from several ftp hosts has two tools that can be used: ilbmtoppm and
  208.     ppmtogif.
  209.  
  210. image/jpeg
  211. ----------
  212.     To show a JPEG picture I call the script
  213.         showJPEG
  214.     This script in turn calls djpeg, ppmtoilbm and Mostra.
  215.         djpeg           convert from JPEG to PPM
  216.         ppmtoilbm       convert from PPM (or PBM, PBM) to IFF ILBM.
  217.         Mostra          show an IFF ILBM
  218.     djpeg is part of the archive AmigaJPEG_v2.lzh, which is available on
  219.     several ftp hosts.
  220.     ppmtoilbm is part of the pbmplus (PBM/PGM/PPM) library available from
  221.     pc.usl.edu.
  222.     Mostra is available from several ftp hosts. Use whatever viewer suits you.
  223.  
  224. image/pbm
  225. ---------
  226.     To show a PBM picture I call the script
  227.         showPBM
  228.     This script in turn calls ppmtoilbm and Mostra.
  229.         ppmtoilbm       convert from PPM (or PBM, PBM) to IFF ILBM.
  230.         Mostra          show an IFF ILBM
  231.     ppmtoilbm is part of the pbmplus (PBM/PGM/PPM) library, usually called
  232.     pbm+.lzh, which is available from several ftp hosts.
  233.     Mostra is available from several ftp hosts. Use whatever viewer suits you.
  234.  
  235.     The ppmtoilbm program can be excruciatingly slow. I have modified
  236.     ppmtoilbm into the program pnmtoilbm. This program is several times faster
  237.     (up to nine times faster) than ppmtoilbm, for bitmaps and graymaps.
  238.     I have passed the sources on to the Jef Poskanzer and also to Ingo Wilken
  239.     (who supports PBM on the Amiga). If you are interested in the binary or
  240.     the source and can't find it some other way, drop me a line.
  241.         BMS:Pub/pnmtoilbm.lha
  242.     is available via BMS (part of Matt Dillons UUCP distribution) from node
  243.         jwdata.se
  244.  
  245. image/pgm
  246. ---------
  247.     To show a PGM picture I call the script
  248.         showPGM
  249.     This script in turn calls ppmtoilbm and Mostra.
  250.         ppmtoilbm       convert from PPM (or PGM, PBM) to IFF ILBM.
  251.         Mostra          show an IFF ILBM
  252.     ppmtoilbm is part of the pbmplus (PBM/PGM/PPM) library, usually called
  253.     pbm+.lzh, which is available from several ftp hosts.
  254.     Mostra is available from several ftp hosts. Use whatever viewer suits you.
  255.  
  256. image/x-xbitmap
  257. ---------------
  258.     To show an X bitmap I call xbmtopbm, ppmtoilbm, fakePipe and Mostra.
  259.     fakePipe is provided in AmigaSrc.
  260.         xbmtopbm        convert from X11 or X10 bitmap to PBM.
  261.         ppmtoilbm       convert from PPM (or PBM) to IFF ILBM.
  262.         Mostra          show an IFF ILBM
  263.     xbmtopbm and ppmtoilbm are part of the pbmplus (PBM/PGM/PPM) library,
  264.     usually called pbm+.lzh, which is available from several ftp hosts.
  265.     Mostra is available from several ftp hosts. Use whatever viewer suits you.
  266.  
  267. image/x-xwd
  268. -----------
  269.     To show a color X11 or X10 window dump I call the script
  270.         showXWD
  271.     This script in turn calls xwdtoppm, ppmtoilbm and Mostra.
  272.         xwdtopnm        convert from X11 or X10 window dump to PBM, PGM or PPM.
  273.         ppmtoilbm       convert from PPM (or PBM) to IFF ILBM.
  274.         Mostra          show an IFF ILBM
  275.     xwdtopnm and ppmtoilbm are part of the pbmplus (PBM/PGM/PPM) library,
  276.     usually called pbm+.lzh, which is available from several ftp hosts.
  277.     Mostra is available from several ftp hosts. Use whatever viewer suits you.
  278.  
  279.     The script runs one program at a time. This uses less memory than running
  280.     a pipeline. Both xwdtopnm and ppmtoilbm can be quite memory hungry, so this
  281.     is an important consideration.
  282.  
  283. message/partial
  284. ---------------
  285.     The mailtransport system usually sets a limit on the size of messages.
  286.     MIME therefore provides a mechanism for automatic fragmentation and
  287.     reassembly of large messages. Message fragments have type mmessage/partial.
  288.     Reassembly is handled by the program showpartial provided in AmigaSrc.
  289.     Message fragments avaiting reassembly are stored in the directory given
  290.     by the environment variable.
  291.         METAMAIL_P_DIR
  292.  
  293. text/plain
  294. ----------
  295.     To show plain text I call Leggi or Less.
  296.         Leggi           show a text file.
  297.         Less            show a text file.
  298.     Leggi is available on fish disk 669.
  299.     Less is available on fish disk 511. This worked fine under OS 1.3, but I have
  300.     had some troubles with it under OS 2.0 (a wild pointer in the option parsing?).
  301.     Use whatever text displayer you are happy with.
  302.  
  303. text/richtext
  304. -------------
  305.     To show richtext I call the richtext program, which is provided, and then
  306.     I pipe the output from richtext to Leggi or Less.
  307.         Leggi           show a text file.
  308.         Less            show a text file.
  309.     Leggi is available on fish disk 669.
  310.     Less is available on fish disk 511. Use a text viewer that can handle
  311.     ANSI escape sequences for bold, underline etc.
  312.  
  313. application/postscript
  314. ----------------------
  315.     Note: passing received mail to a PostScript previewer is a gigantic
  316.     security hole. You are setting yourself up for say, a virus attack.
  317.  
  318.     To show PostScript I call the post PostScript previewer. A much safer
  319.     thing to do is to send the PostScript to a PostScript printer.
  320.         Post            show a PostScript file.
  321.     Post is available from many ftp hosts.
  322.  
  323.  
  324. Compiler requirements
  325. =====================
  326.  
  327. I have used DICE. Changes for use with other compilers should be small.
  328.  
  329. DICE supports dynamic stack allocation. This means that the programs will not
  330. run out of stack even if the user has set a fairly small stack. If you
  331. recompile with a compiler that does not support dynamic stack allocation you
  332. may have to require a larger stack setting.
  333.  
  334. I have used functions from the library provided with Dillon UUCP-1.15D. So,
  335. you need that library. If you do not have a working popen() or mktemp() you
  336. can use the ones I provide in AmigaSrc/UUCP-1.15D. Note that UUCP-1.15D does
  337. not come with a working popen().
  338.