home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / maxcid03.lzh / MAXCID.DOC < prev    next >
Text File  |  1994-06-22  |  12KB  |  249 lines
  1.  
  2.  
  3.  
  4.         ┌──────────────────┬───────────────────┬────────────────────┐
  5.        ╟┘                  │ MAXimus Caller ID │                    └╢
  6.        ║                   └┐    0.3  Beta    ┌┘                     ║
  7.        ║                    └─────────────────┘                      ║
  8.        ║            Copyright, 1994 All Rights Reserved              ║
  9.        ║                                                             ║
  10.        ║                 Written by:  Louis LePage                   ║
  11.        ║                    The Woodbine/2 BBS                       ║
  12.        ║                      (519) 254-2023                         ║
  13.        ║                   19.2ZyXEL/v.32b/v.42b                     ║
  14.        ║                                                             ║
  15.        ║            InterNet: lepage@server.uwindsor.ca              ║
  16.        ║                   Fido Net: 1:246/66                        ║
  17.        ║                   WB/2-Net: 107:701/1                       ║
  18.        ║                   IBM Net:  40:6482/11                      ║
  19.        ║                   GlobeNet: 51:2105/15                      ║
  20.        ╟┐                                                           ┌╢
  21.         └───────────────────────────────────────────────────────────┘
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.      I. Introduction
  32.      ~~~~~~~~~~~~~~~
  33.  
  34.         Max Caller ID is a useful utility which will allow a BBS to use
  35.         the caller identification information for a faster and less time
  36.         consuming login.  There are many options which will be added to
  37.         the program in time.  There is an OS/2 compiled and a DOS compiled
  38.         version included.  My intent was to get a working copy out, and then
  39.         add all the little x-tras after, as you will see below.
  40.  
  41.         This utility can also be used to log incoming calls, as well as the
  42.         time they were made, for personal security reasons.  The program is
  43.         not dependent upon Maximus, or any particular front end mailer.  For
  44.         the time being, this program only utilizes the user.bbs (user data
  45.         file) structure for retreiving caller information.
  46.  
  47.  
  48.      II. Warranty ;-)
  49.      ~~~~~~~~~~~~~~~~
  50.  
  51.         This software package has been designed during the spare time
  52.         of the author, and mostly in the _wee_ hours of the night.  I
  53.         reserve the right to make any sudden changes in later revisions
  54.         of this sofware.  The author is NOT obligated to fix any problems
  55.         caused by, or associated with MaxCID.  The author is not
  56.         responsible for any damage this program may cause, or for any
  57.         defectiveness this software may show.  If you do not like this
  58.         software, do not use it.  Any user takes upon a responsibility
  59.         to back up any system files which may be at risk by using this
  60.         program.  I do use this software on my system, and have no
  61.         problems whatsoever.  This does not imply, however, that the
  62.         software is perfected.
  63.  
  64.         You may NOT sell this program for profit.  Charges for media
  65.         upon which the program is transported are understandable.  You
  66.         may NOT use this program in a professional environment unless
  67.         obtaining permission from the author and/or purchasing a site
  68.         license.
  69.  
  70.         This program may only be distributed in it's entirity.  All
  71.         files must be included in any distribution manner.  You may
  72.         rearchive the program to suit your distributive needs, but
  73.         this is not recommended.
  74.  
  75.         In any case excluded in the forementioned, the author and the
  76.         Woodbine/2 BBS may not be held responsible for any damage this
  77.         sofware may cause.
  78.  
  79.  
  80.      III. Requirements
  81.      ~~~~~~~~~~~~~~~~~
  82.  
  83.         The following items are required to successfully run MaxCID:
  84.           - Caller Display feature (purchased from your local
  85.                 phone company)
  86.           - Caller ID capable modem (must return a CID string to
  87.                 your front end mailer)
  88.           - Front End Mailer capable of recording the caller id info
  89.                 to a log file
  90.           - Maximus (if you wish to take advantage of the user.bbs file)
  91.           - An OS/2 system or a Dos shell.  (OS/2 and Dos executables!)
  92.           - Patience!
  93.  
  94.  
  95.      IV. Quick Installation
  96.      ~~~~~~~~~~~~~~~~~~~~~~
  97.  
  98.         1) Place the files in an appropriate directory.
  99.         2) Edit the maxcid.cfg file.
  100.         3) Test the program out with a
  101.         4) Backup any related User Data files, logs, etc.
  102.         5) Create an information file, telling the users any important
  103.            info they should know.  This is an ideal place to explain how
  104.            the APW_KeyToggle and the AutoPassword feature works.
  105.  
  106.         *** NOTE: Beta Testing! **************************************
  107.        *                                                              *
  108.        *  If you wish to beta test this software, you are required    *
  109.        *  to obtain a FREE registration number.  You may register     *
  110.        *  for FREE by calling The Woodbine/2 BBS (info below) and     *
  111.        *  going into the Woodbine Developed software menu (in the     *
  112.        *  main menu) and Select 'R'egister Alpha test.  You may       *
  113.        *  leave a comment to the SysOp regarding any suggestions.     *
  114.        *                                                              *
  115.         **************************************************************
  116.  
  117.         File Names:
  118.           maxcid.doc      This document file.
  119.           maxcid.cfg      Configuration file.
  120.           maxcid.exe      Dos compiled version of MaxCID.
  121.           maxcidp.exe     OS/2 compiled version of MaxCID.
  122.           maxcid.fon      Sample phone number screen/alias list.
  123.           file_id.diz     Short description of the program.
  124.  
  125.  
  126.  
  127.      V. Future Developments
  128.      ~~~~~~~~~~~~~~~~~~~~~~
  129.  
  130.         Here is a list of a few ideas which I would like to have some
  131.         opinions on:
  132.  
  133.         - Thourough Documentation (very soon).
  134.         - Time Chart *.bbs bulletin option.
  135.         - Last Callers *.bbs bulletin option.
  136.         - Support for other User data file formats. (please suggest!).
  137.         - Quick and Easy Installation program.
  138.         - On-Line help file.
  139.         - Auto user validate/upgrade option (access level and keys)
  140.  
  141.  
  142.      VI. History
  143.      ~~~~~~~~~~~
  144.  
  145.         04/26/94
  146.             ■ First alpha distribution (basic program)
  147.             ■ Made first documentation files.  Very small.
  148.  
  149.         *** 04/26/94 [v0.01] Released - Alpha version 0.01
  150.  
  151.         05/07/94
  152.             ■ Implemented a faster log scanner to obtain the Caller ID
  153.               string and number.  Now, blocks are read from the end of
  154.               the file forward.  MaxCID will no longer allow a user to
  155.               log in on a previously identified number, even if the
  156.               front end doesn't log the current number.  MAX_BACK
  157.               prevents this loophole from occuring.
  158.  
  159.         05/08/94
  160.             ■ Added HEX Caller ID format for Rockwell chip compatibility.
  161.             ■ MaxCID now recognizes an 'Out of Area' string and aborts
  162.               scanning of the user.bbs file.
  163.             ■ MaxCID now recognizes a 'Privacy' string and aborts scanning
  164.               of the user.bbs file.
  165.  
  166.         05/09/94
  167.             ■ Fixed and improved caller number error checking.  If an error
  168.               occurs or an unrecognized string is found, user.bbs scan is
  169.               aborted.  Then, a manual login will carry on.
  170.             ■ Added NOPASS_KEY to allow users to disable the autopassword
  171.               sequence.  The autopassword now checks to see if more than
  172.               one user have the same phone number.  If so, then the
  173.               autopassword will be disabled.  If only one user matches
  174.               the phone number, then the autopassword will be enabled.
  175.  
  176.         *** 05/09/94 [v0.2] Released - Alpha version 0.2
  177.  
  178.         05/09/94
  179.             ■ Fixed the Private number detection for Hex format modems.
  180.               This now scans for a seperate string which does not need
  181.               to be preceeded by CID_STRING in the log file.
  182.             ■ Multiple users with the same phone number now get logged.
  183.               The first user logged will have a date/time stamp.  Each
  184.               additional user found will follow on a new line, with no
  185.               date/time stamp.
  186.  
  187.         05/31/94
  188.             ■ Converted the config keyword scanning to a dynamic list
  189.               which allows keywords to be removed or added easily.
  190.  
  191.         06/05/94
  192.             ■ Config file keywords are no longer case sensitive.
  193.             ■ Added the Caller Screen and Alias phone number features.
  194.  
  195.         06/21/94
  196.             ■ Config file keywords now accept [yes, no, true, false, on,
  197.               off, 1, 0] and are not case sensitive.
  198.             ■ Fixed the bug with NoPass_Key.  (The pointer was still
  199.               hardcoded, after I changed the rest to dynamic).
  200.             ■ NoPass_Key has been changed to APW_KeyToggle.  This will
  201.               now toggle the operation of AutoPassword if the first
  202.               character of the user password matches the APW_KeyToggle.
  203.             ■ When more than one phone number is matched in the user
  204.               data file, the caller with the most number of calls will
  205.               be used as the login name.  The AutoPassword is forced off.
  206.               When two users have the same number of previous calls, the
  207.               first of these users will be used as the login name.
  208.             ■ The keyword ForceList has been added to prevent any users
  209.               who are not in the PhoneList from entering the system.
  210.               This is for use with a "private" bbs system.
  211.  
  212.         *** 06/22/94 [v0.3] Released - Beta version 0.3
  213.  
  214.  
  215.  
  216.      VII. Donations & Registration
  217.      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  218.         This is a shareware program.  You are allowed to test this
  219.         software for a trial period of 30 days.  If at this time, you
  220.         like the software, and wish to keep it, you must register.
  221.  
  222.         All programs take a lot of time to successfully meet the needs
  223.         of the market.  I have written this program in my *spare* time
  224.         and would like to ask that you take the time to make a donation
  225.         of  $10.  Upon registering this software, you are deemed the right
  226.         to make your suggestions to the developer.  All suggestions will
  227.         be looked over, and hopefully implemented.  The more donations
  228.         I receive, the more functional this software will become.
  229.  
  230.  
  231.      VIII. About the Author
  232.      ~~~~~~~~~~~~~~~~~~~~~~
  233.  
  234.  ┌────────────────────────────────────────────────────────────────────┐
  235.  │For further information, contact me in person at:                   │
  236.  │      Louis LePage                                                  │
  237.  │      #405 - 2225 University Ave. W.                                │
  238.  │      Windsor, ON, Canada                                           │
  239.  │      N9B 1E6                                                       │
  240.  │                                                                    │
  241.  │      The Woodbine/2 BBS - 1-519-254-2023, (19.2 ZyXEL v.32b/v.42b) │
  242.  │      Fido: 1:246/66                                                │
  243.  │      Woodbine/2 Net: 107:701/2  (WHQ)                              │
  244.  │      IBM-Net: 40:6482/11                                           │
  245.  │      OS2-Net: Soon                                                 │
  246.  │      InterNet: lepage@server.uwindsor.ca                           │
  247.  └────────────────────────────────────────────────────────────────────┘
  248.  
  249.