home *** CD-ROM | disk | FTP | other *** search
/ The Pier Shareware 6 / The_Pier_Shareware_Number_6_(The_Pier_Exchange)_(1995).iso / 035 / mlp.zip / README < prev   
Text File  |  1994-09-08  |  10KB  |  242 lines
  1. MLP - Mailing List Processor for OS/2 Version 0.6                  
  2. ==========================================================================
  3.  
  4. Edition: first
  5. Date:    September 1, 1994
  6. Author:  Jivko Koltchev         <jivko@netcom.com>
  7. **************************************************************************
  8.  
  9.  
  10.  
  11. THIS DOCUMENT will help you understand what MLP is and how to make it
  12.               work for you.
  13.  
  14.               Please read this document before you ever try MLP to avoid
  15.               any problems and possible damages to your system.
  16.  
  17.  
  18. NOTICES 
  19.  
  20.               MLP is FREEWARE but that does not mean that you are allowed 
  21.               to do everything you want with it.
  22.  
  23.               COPYRIGHT 1994 by Jivko Koltchev All Rights Reserved.  
  24.  
  25.               Publication of this document or MLP software in any form
  26.               is expressly prohibited without the explicit permission of 
  27.               the author. Any distribution of this program must include 
  28.               both program and documentation without any modifications.
  29.               This program is available for you to use free of charge while
  30.               commercial sale or re-sale of this program is allowed only 
  31.               with the approval of the author.
  32.  
  33. DISCLAIMER:   No warranties or guarantees are expressed or implied. The
  34.               author assumes no liability for any damage or loss whatsoever 
  35.               that may occur while this program is being used. The author
  36.               is under no obligation whatsoever to provide support of any
  37.               kind.
  38.  
  39. **************************************************************************
  40.  
  41. 1. History
  42.  
  43.    Since I could not find OS/2 based mailing list processor for a very long
  44.    time and I needed one a lot I decided that I may as well put one together.
  45.    Porting an existing one was not very acceptable idea because of the format
  46.    in which IBM's TCP/IP package stores the incoming e-mail.
  47.    
  48.    I have been using this list processor for several mounts now without
  49.    significant problem and hope you will be able to set it up and use it
  50.    as well.
  51.  
  52. 2. Requirements
  53.  
  54.    MLP requires OS/2 2.x and IBM TCP/IP (It should work fine with version
  55.    1.2.1 though I am currently using it with 2.0)
  56.  
  57. 3. Installation
  58.  
  59.    It is very simple to install and configure MLP. Here are the few steps
  60.    you will have to follow:
  61.  
  62.    a) create directory for you list processor (let it be MLP)
  63.    b) copy mlp.exe in that directory.
  64.    c) you are all set. MLP is already installed on your system. You may
  65.       want to include your MLP directory in your PATH environment though
  66.       I do not recommend it.
  67.  
  68.    NOTE: I assume you already have the IBM's TCP/IP package installed and
  69.          configured to receive and send E-mail messages.
  70.  
  71. 4. Configuration
  72.  
  73.    There isn't much you will have to configure except the names of the
  74.    mailing lists you would like to have available and few standard messages
  75.    for every single one of the lists. (There is no mistake here. MLP can
  76.    support multiple mailing lists on the same machine)
  77.  
  78.  
  79.    a) Mailing lists' names
  80.  
  81.       Create a ASCII text file named mlist.cf in your MLP directory with
  82.       you favorite text editor and enter the names of the lists you
  83.       would like to have available one per line. Here is an example:
  84.  
  85.       # Top of file
  86.       # The following is ListNameOne
  87.       ListNameOne
  88.       # The following is ListNameTwo
  89.       ListNameTwo
  90.  
  91.       # Bottom of file
  92.  
  93.       Lines beginning with '#' as first character will be ignored.
  94.       Blank lines will be ignored
  95.       The lists' names may not contain spaces
  96.       The lists' names may not have more than 29 characters (should be plenty)
  97.  
  98.    b) Dedicated directories.
  99.  
  100.       For every mailing list you will have to create 'home' directory. That
  101.       directory should carry the name of the list and be located in the MLP
  102.       directory. MLP will be using that 'home' directory to store temporary
  103.       messages and will keep them there as long as needed.
  104.  
  105.    c) Subscribe greetings
  106.  
  107.       Every mailing list should have a special file name 'subscribe' which
  108.       MLP will mail back automatically to every new member. The 'subscribe'
  109.       file should be located in the 'home' directory of the corresponding
  110.       mailing list.
  111.  
  112.    c) Unsubscribe message
  113.  
  114.       Every mailing list should have a special file name 'unsubscribe' which
  115.       MLP will mail back automatically to every member indicating termination
  116.       of his or her membership. The 'unsubscribe' file should be located in 
  117.       the 'home' directory of the corresponding mailing list.
  118.  
  119. 5. How to run the program?
  120.  
  121.    MLP can be started without any arguments. It will automatically locate
  122.    your sendmail.cf file (using the ETC variable) and find out where your
  123.    InBox resides. Thus MLP will be able to monitor all the incoming mail
  124.    and process it almost immediately.
  125.  
  126.    If you do not want MLP to monitor your InBox but and other folder instead
  127.    you can run MLP and as a first parameter specify the name of the folder's
  128.    index file. One may want to do it this way if one wants to monitor the
  129.    messages posted on the list and remove some of them from time to time. If
  130.    this is the case than you will have to move the messages from you InBox to
  131.    the specified to MLP folder so that MLP will be able to process the 
  132.    messages.
  133.  
  134.    As a second argument to MLP you may specify a log file in which MLP
  135.    will save most of the message id otherwise displays on the screen.
  136.  
  137.    I know it is annoying to not have switches for the arguments and have
  138.    to remember their position but...So if you want to have MLP save 
  139.    information to a log file and in the same time figure out by itself where
  140.    your InBox index is you should use the following command line:
  141.  
  142.         MLP . mlp.log
  143.             ^------------The dot here tells MLP to ignore that argument
  144.  
  145.    Most probably you would like to have MLP start automatically every time
  146.    you restart your system. The best place to do this is not your STARTUP.CMD
  147.    file because this way MLP will be started before the TCP/IP has been
  148.    initialized and if there are messages to be posted MLP will start doing
  149.    it right away. (MLP uses sendmail.exe to send its messages so it doesn't
  150.    really care if the network is up or not. Perhaps I should change that but
  151.    it will be in one of the future release.) So the best place to start MLP
  152.    is at the end of your TCPSTART.CMD file including the following few lines:
  153.  
  154.         drive:
  155.         cd \MLP
  156.         MLP . mlp.log
  157.  
  158.    I am sure you will find much better ways to do it but the above is 
  159.    something that should work.
  160.  
  161. 5. How to stop the program?
  162.  
  163.    Hit <Esc> to kill the process.
  164.  
  165. 7. How does it work at all?
  166.  
  167.    a) Form the users' prospective
  168.  
  169.         - to subscribe a user will have to send e-mail to 
  170.           mailing_list@your.host with subject 'subscribe' (one word only)
  171.           In confirmation the user will receive you 'subscribe' file.
  172.  
  173.         - to unsubscribe a user will have to send e-mail to
  174.           mailing_list@your.host with subject 'unsubscribe' (one word only)
  175.           In confirmation the user will receive you 'unsubscribe' file.
  176.  
  177.         - to receive some help the user will have to send e-mail to
  178.           mailing_list@your.host with subject 'help' (one word only)
  179.           In result the user will receive your 'help' file.
  180.  
  181.         - to post messages to all the subscribers a user will have to
  182.           send e-mail to mailing_list@your.host with any subject but
  183.           'subscribe', 'unsubscribe' or 'help'
  184.  
  185.    b) From your prospective
  186.  
  187.         - there will be a special data base file "musers" created in the
  188.           MLP directory. This file is very important. Make sure you do not
  189.           delete it by mistake.
  190.  
  191.           Because of the way the data is stored in musers you may notice
  192.           that it doesn't change its size after some users have unsubscribed.
  193.           That is OK. MLP will not rewrite the file but will try to make
  194.           use of the available empty space the next time someone subscribes
  195.           to any list.
  196.  
  197.           Unfortunately there is no utility that currently allows you to edit
  198.           the msusers file. It will become available soon, especially if
  199.           there is some interest. I personally manage the list in a very
  200.           simple way (I have done it not more than 5 time up till now) by
  201.           sending fake e-mail to the list I need.
  202.  
  203.           In case the data base file gets corrupted (It can happen if you
  204.           reset your computer without stopping the MLP process) the next time
  205.           you run MLP it will try to restore the musers file and work with
  206.           it. If you overwrite portions of that file, MLP may not be able
  207.           to restore it properly.
  208.  
  209.         - when a message cannot be sent to its recipient MLP will keep trying
  210.           every hour to deliver the message for about 72 hours. At the end
  211.           the message will be discarded and the recipient removed from the
  212.           mailing list.
  213.  
  214. 8. Support
  215.  
  216.    Send e-mail to Jivko@netcom.com and I will be glad to help as much as 
  217.    I can. Any comments and suggestions are welcome. I hope I will be able
  218.    to allocate enough time to support this product in the future although
  219.    I do not expect a lot of interest towards it.
  220.  
  221. 9. Known problems
  222.  
  223.    - It may not be a good idea to subscribe to any of the mailing lists from
  224.      the machine on which you are running MLP. Somehow sendmail doesn't 
  225.      always behave very nicely when sending E-mail to itself. I have an idea
  226.      what the problem might be an will hopefully fix it in the next release.
  227.  
  228. 10.The latest version
  229.  
  230.    Send E-mail to jivko@netcom.com and I will be happy to mail the latest 
  231.    version of MLP back to you. If you also indicate in your e-mail that you
  232.    would like to receive future release by e-mail I will add you to the list
  233.    of people I will be e-mailing every new release.
  234.  
  235. 11.The money
  236.  
  237.    Feel free to contribute whatever you can without being obliged to do so.
  238.    Be warned however that I will not accept contributions exceeding the amount 
  239.    of $1000 per site without strong motivation on your side.
  240.  
  241. ENJOY
  242.