home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / popc221h.zip / README.OS2 < prev   
Text File  |  1995-06-08  |  13KB  |  241 lines
  1. ==============================================================================
  2.                                    PopCliD
  3.                           popclient daemon for OS/2
  4. ==============================================================================
  5.  
  6.                             Copyright 1993,1994 by
  7.                      Carl Harris, Jr. (ceharris@mal.com)
  8.                              All rights reserved
  9.  
  10.                         OS/2 port by Claudio Fahey
  11.                         claudio@uclink.berkeley.edu                       
  12.  
  13.                      Claudio Fahey's REXX code hacked by
  14.                        Clark Gaylord (cgaylord@vt.edu)
  15.  
  16.     PopCliD.cmd and associated files and documentation are copyright 1994,
  17.     1995 by Claudio Fahey and Clark Gaylord, except where other copyrights
  18.     supercede.
  19.  
  20. |   NEW IN THIS RELEASE:
  21. |   - the process id of PopCliD is written to a file (%TMP%\PopCliD.pid)
  22. |   - can play a sound file on new mail or errors
  23.  
  24.     This package contains two REXX programs to integrate the POP client
  25.     (popclient.exe) with LaMail, Ultimedia Mail/2 Server, and Elm.  This
  26.     client only receives mail from a POP server.  It does not send mail
  27.     through a POP server.  To send mail, you continue to use sendmail.  Some
  28.     POP servers will also allow you to send mail using Dave Bolen's LamPOP.
  29.     There are a few other mailers that will work in LaMail's fashion,
  30.     including Chance Guerin's CMAIL.  Since CMAIL uses LaMail folders, it can
  31.     be used with popclient with little work.  This version of popclient now
  32.     supports Elm as well.  Elm is a very popular unix mail program ported to
  33.     OS/2 by Kai Uwe Rommel.
  34.  
  35.     To install this POP client, unzip popclient.exe, PopCliD.cmd, and, if you
  36.     are using LaMail-type mailer, LAMAILER.CMD.  You may want these in your
  37.     path, though if you set up an icon to receive your mail, this won't be
  38.     necessary.  The main command is PopCliD.cmd.  The purpose of PopCliD is to
  39.     set up a time-delay loop to retrieve your mail.  PopCliD calls
  40.     popclient.exe, which either calls LAMAILER.CMD, UMAILER.EXE, or
  41.     FILTER.EXE, depending on your mail system.
  42.  
  43.     I've also included PMPOPUP.EXE; I recommend putting it with your favorite
  44.     utilities in your path.  Note that PMPOPUP has nothing itself to do with
  45.     popclient; I just use it as a poor-man's biff.  The biff only works with
  46.     LAMAILER, though the PMPOPUP error messages still work.  I'd like to get
  47.     it working with elm.  PMPOPUP is anonymous-ware; it comes without docs.
  48.  
  49. |   Also included in this release is PS.EXE, a unix ps clone.  I can't find
  50. |   where I got it from.  It is probably a gnu utility; if so, it is covered
  51. |   by the Gnu Public License, and I have to tell you have it is free to
  52. |   distribute and source code is availble wherever Free Software Foundation
  53. |   products are found.
  54.  
  55.     PopCliD now provides support for *all* command-line parameters of popcient
  56.     via the '-o' parameter.  This allows the user to specify a POP2 server or
  57.     to keep the mail on the server, among other possible features.
  58.  
  59. |   In order to make it more usable by other programs, I write the process
  60. |   ID of the PopCliD session to a file.  This file is PopCliD.pid in the
  61. |   system %TMP% directory.
  62.  
  63. |   To do this, we use ps.exe, pipe and parse the result, and spit it out.
  64. |   Then, if you need to kill PopCliD (e.g., from another REXX program), you
  65. |   read this file to get the PID to kill.  This can keep you from having 
  66. |   multiple copies of PopCliD running.  Since there is only one system file, 
  67. |   it is not multi-user friendly.  If anyone needs multi-user PIDs, we can
  68. |   work on that.
  69.  
  70. |   To get sound, you either specify -s YES on the command-line or set the
  71. |   POPSOUND environment variable to YES.  To get a sound file to play on new
  72. |   mail, use -n NewMailSoundFileName or set NEWMAILSOUNDFILE; to get a sound
  73. |   file to play on error, use -e ErrorSoundFileName or ERRORSOUNDFILE.  If
  74. |   you do not specify either of these, but you request sound, you get beeps.
  75.  
  76.     PopCliD requires certain information in order to get your mail.  At the
  77.     least, you have to tell it the POP host name, your login name, and your
  78.     password.  PopCliD will accept this information from the command line or
  79.     can take it from environment variables.
  80.  
  81.     Usage:
  82. |   popclid -h pophost -l loginname -p password
  83. |               [-d delay] [-b inbasket] [-m L|U|E] [-u user] [-s YES|NO]
  84. |               [-n newmailsoundfile] [-e errorsoundfile] [-o otherargs]
  85.  
  86. |   where, L|U|E indicates LaMail (default), Ultimail, or Elm, and -s is for
  87. |   sound.
  88.  
  89.     ENVIRONMENT VARIABLES:
  90.         POPHOST   -- pophost
  91.         POPUSER   -- loginname
  92.         POPPASS   -- password
  93.         POPDELAY  -- delay, defaults to 0, i.e., retrieve mail once only
  94.         INBASKET  -- inbasket, defaults to current directory.
  95.                      This should be SERVER''s inbox for UltiMail Lite,
  96.                      inbasket for LaMail, and mailbox file for Elm.
  97.         MDA_PROG  -- mailer (LaMail, Ultimail, or Elm); only first letter
  98.                      significant.  Defaults to LaMail.  
  99.         POPUPBIFF -- Set equal to YES if you want PMPOPUP to tell you 
  100.                      mail has arrived.  No corresponding command line 
  101.                      arg.
  102.         USER      -- Ultimail inbasket, defaults to root.  Not needed for
  103.                      LaMail or Elm use.
  104. |       POPSOUND  -- YES or NO depending on whether you want sound.
  105. |       NEWMAILSOUNDFILE
  106. |       ERRORSOUNDFILE -- Sound files that play when you have new mail or on
  107. |                    errors.  If POPSOUND=YES and these are not defined, you
  108. |                    get beeps.
  109.  
  110.     Command-line args take precedence over environment variables.
  111.  
  112.     The -o parameter requires special note.  First, -o *must* be the last
  113.     parameter; everything after it is put on the popclient command line before
  114.     the POP server hostname.  If you want to specify POP2, you say '-o -2'; to
  115.     keep mail on the server, '-o -k'.  Note that popclient itself has a '-o'
  116.     parameter; to use this, you use two -o's (i.e. '-o -o unix.mbox.name').
  117.     The first one tells PopCliD to pass the second to popclient.  Beyond -o -2
  118.     and -o -k, your use of -o is considered "creative" and you are on your
  119.     own.  It does put a lot of power at your disposal, though.
  120.  
  121.     You also need the emx run-time DLLs.  You can get these from
  122.     ftp-os2.nmsu.edu:/os2/2_x/unix/emx09a/emxrt.zip.  Of course, you need IBM
  123.     TCP/IP 2.0 or OS/2 Warp with Internet Access Kit.
  124.    
  125.     To make PopCliD more SLIP/PPP friendly, I've added some primitive
  126.     error-checking code, along with the popups and beeps.  If popclient
  127.     returns errors on ten successive attempts, PopCliD ends.
  128.  
  129.     The original popclient code can be downloaded by FTP from ftp.mal.com.
  130.     For modifications to the source code, see PATCHES.OS2.
  131.  
  132.     Feel free to send comments, bug reports, or suggestions related to this
  133.     OS/2 port.  Comments about the port of popclient itself should be
  134.     addressed to Claudio.
  135.  
  136.     I want to thank Claudio Fahey and Carl Harris for the work they have done
  137.     on this, and to Dave Bolen for LamPOP, the original POP interface to
  138.     LaMail (and the original SLIP driver).  Also, I believe
  139.     J.Poltorak@bradford.ac.uk is responsible for some of the REXX (at least
  140.     that's what Claudio says in lamailer.cmd), so thanks to him too.  Mike
  141.     Baum (baum@micf.nist.gov) noticed the potentially non-unique file names
  142.     and suggested a repair.  I've chosen a different method, but his solution
  143.     is also included as a comment.  He also noticed the problem with long From
  144.     and Subject fields, and suggested the solution to that.  Thanks to Modem
  145.     Biker (mdmbkr@qnet.com) for reviewing the docs and code, and for working
  146.     on the elm piece of the puzzle.  Thanks to Kerry Flint
  147.     (kerryfli@terminus.intermind.net) for noticing some minor errors and
  148. |   suggesting filter as Elm's MDA, with fix code.  Kudos to Rick Wilkerson
  149. |   (rickw@umr.edu) for working on sound.
  150.  
  151.  
  152.     I had been thinking of writing something like this, but was always either
  153.     too lazy or busy.  When Claudio's port came along, it provided the
  154.     necessary motivation to put a little time in to polish an already
  155.     excellent product.
  156.  
  157.   LEGAL STUFF:
  158.     These programs are distributed "as is" and no warantee is expressed or
  159.     implied.  None of the above authors accept any responsibility for the use
  160.     of these programs.  They are distributed strictly on a "use at your own
  161.     risk" basis.  You may distribute these programs freely, provided none of
  162.     the copyright notices are changed, proper attribution is given to the
  163.     authors, all documentation is included, and any changes you make are
  164.     clearly documented.  It is generally considered polite to notify the
  165.     authors of freeware when you find a nice use for their products.  This 
  166.     notice may not be exhaustive of all copyright information for this package
  167.     of software.
  168.  
  169.   COPYRIGHTS:
  170.     The original popclient C source and documentation is copyright 1993,
  171.     1994 by Carl Harris, Jr.; the port of the C code to OS/2 and the
  172.     first REXX interface was by Claudio Fahey, 1994; the REXX programs
  173.     were updated by Clark Gaylord, 1995.  These authors reserve all
  174.     rights to their respective contributions.  There may be other copyrights I
  175.     am not aware of.
  176.  
  177. HISTORY:
  178.     2.21:   9/94    Claudio Fahey ported popclient and released REXX
  179.                     programs to interface with LaMail and UltiMail.
  180.  
  181.     2.21a:  3/95    Clark Gaylord hacked Claudio's REXX programs so that
  182.                     users can define everything from environment variables
  183.                     or command line.  Also added popup support and poor 
  184.                     man's biff.  README.OS2 rewritten accordingly.
  185.  
  186.     2.21b:  3/25/95 Better documented Ultimail interface; allow USER
  187.                     environment variable to be set on command line.
  188.                     Closed security hole in pmpopup command by escaping
  189.                     '&', et al.  Guaranteed (virtually) unique file names 
  190.                     of incoming messages while retaining most of time
  191.                     information. (This version did not make general
  192.                     availability.)
  193.  
  194.     2.21c:  4/8/95  Fixed the long from: and subject: lines per Mike Baum
  195.                     and updated documentation.
  196.  
  197.     2.21d:  5/26/95 Added Elm support.  Clarified some of the docs.
  198.  
  199.     2.21e:  5/27/95 Added Elm filter support.  Now uses filter as Elm MDA.
  200.                     Removed hard-coded popclient.exe so it works correctly
  201.                     on FAT systems.
  202.  
  203.     2.21f:  5/31/95 Added BIFF-type feature for all users, not just LaMail.
  204.  
  205.     2.21g:  5/31/95 Took out hard-coded path to LaMailer.cmd (oops) ... it had
  206.                     been there since release (a) ... I'm just going to have 
  207.                     to find myself some new betatesters. :-)
  208.  
  209. |   2.21h:  6/8/95  Write process ID to a file for use by other programs.
  210. |                   MMPM sound support.
  211.  
  212.   SUPPORT:
  213.     Carl Harris maintains popclient mailing lists pop-announce@mal.com and
  214.     pop-bugs@mal.com; to subscribe to pop-announce, send mail to
  215.     majordomo@mal.com containing the line 'subscribe pop-announce'.  Carl is
  216.     currently developing popclient 3.0.  He has said that any OS/2 subscribers
  217.     will also be forwarded to Claudio and/or myself; we're working on the
  218.     logistics of that, but I guess I'm the de facto point man for the OS/2ers.
  219.  
  220.     I have a list of people I know about that I send notices to, and I
  221.     encourage you to send me a note if you use the OS/2 port of popclient,
  222.     regardless of whether you wish to be on Carl's list.  Currently, I do not
  223.     have a formal mailing list; I just use a simple mailing list when someone
  224.     contacts me I add them to the list.  If response justifies it, I'll turn
  225.     it into a full-fledged mailing list.  I make no claims of support, nor
  226.     guarantees to usefulness.  I expect all users to understand they use these
  227.     programs on an "at your own risk" basis.  However, I will do what I can to
  228.     help with any problems you encounter.  Currently this work is strictly
  229.     volunteer; I do not have any clients underwriting this work.  If you want
  230.     to guarantee support, I will happily discuss service contracts with you.
  231.  
  232.     I'd also happily consider statistical consulting, SAS programming, and
  233.     other statistical work, since that's actually what I do.  :-)
  234.  
  235.     Clark Gaylord
  236.     Gaylord Consulting
  237.     P.O. Box 603
  238.     Blacksburg, Va 24063
  239.     cgaylord@vt.edu
  240. |   8 June 1995
  241.