home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / INTERNET / IAB101.ZIP / IAB.DOC < prev    next >
Text File  |  1993-11-14  |  11KB  |  289 lines
  1. ---------------------------------------------------------------------
  2.                          INTERNET ADDRESS BOOK
  3.  
  4.                           IAB.PPE version 1.01
  5.  
  6.                                  by
  7.  
  8.                             Michael Walter
  9.                           SQLCraft Software
  10.  
  11.                   Copyright (c)1993 SQLCraft Software
  12.                      All rights reserved.
  13. ---------------------------------------------------------------------
  14.  
  15.  OVERVIEW:
  16.  
  17.     Internet Address Book (IAB) is a PCBoard PPE program that will
  18.     allow your users to store and retrieve their personal list of
  19.     Internet E-mail addresses on-line.
  20.  
  21.     Once installed, users can pop-up their list of Internet E-mail
  22.     addresses from the Enter a Message "To:" prompt, select from the
  23.     list, and have their selection automatically populate the "To:"
  24.     field.  Never again will your users have to resort to referencing
  25.     printed lists of Internet IDs - ENTER THEM ONCE AND FORGET THEM!
  26.  
  27.     Users can set IAB to "Auto-Record Mode", which will automatically
  28.     store addresses entered at the "To:" message prompt into their
  29.     personal Address Books.  IAB will check all new Auto-Record
  30.     addresses to determine if that address already exists.  IAB's
  31.     Auto-Record feature is smart enough not to allow duplicates!
  32.  
  33.     IAB's sophisticated design allows your users to add new address
  34.     entries (either manually or in "Auto-Record" mode), Edit or Delete
  35.     entries, store descriptive text on each entry, Toggle the main list
  36.     view between Address and Description, and sort their list (by
  37.     either Address or Description).
  38.  
  39.  
  40.  CONTENTS:
  41.  
  42.     The following files are included in the IAB zip file:
  43.  
  44.          IAB.DOC        - Overview and Installation notes (this file!)
  45.      IAB.PPE        - The IAB PCBoard Program Executable
  46.      IAB.CNF        - A sample configuration file
  47.      IAB.HDR        - The address list header display file
  48.      IAB4E.PPE      - Alternate IAB Program (see IAB4E.DOC)
  49.      IAB4E.DOC      - Alternate IAB Program Documentation
  50.      WELCOME        - The initial program welcome screen
  51.      REGISTER.FRM   - IAB Registration Form
  52.          FILE_ID.DIZ    - Std format BBS file listing descriptive text
  53.  
  54.  
  55.  INSTALLATION (also see IAB4E.DOC before performing the install):
  56.  
  57.     There are a number of steps required to install IAB, but they are
  58.     fairly straight forward and should be easy enough to follow.
  59.  
  60.     First will briefly describe the steps in the procedure, then
  61.     we'll walk you through them one at a time in more detail:
  62.  
  63.     - First, you'll create a directory to hold the IAB files.
  64.  
  65.     - Second, you'll replace one of the standard PCBoard prompts
  66.       with the IAB program.  This will enable IAB to pop-up during
  67.       the entry of a "To:" address for an Internet-bound message.
  68.  
  69.     - Third, you'll add a command (or two) to PCBoard CMD.LST to
  70.       enable your users to access IAB even when they aren't
  71.       entering an Internet-bound message.
  72.  
  73.     - Forth, you'll edit the IAB.CNF configuration file to fit
  74.       your BBS.
  75.  
  76.     The following steps and examples should help you to quickly
  77.     setup IAB for your system.
  78.  
  79.     1) Create a directory to hold the IAB files.
  80.  
  81.             We use: R:\PCB\PPE\IAB
  82.  
  83.        Unzip IABxxx.ZIP into this directory.
  84.  
  85.  
  86.     2) Run MKPCBTXT on your PCBTEXT file and replace prompt #199
  87.        with:
  88.            !R:\PCB\PPE\IAB\IAB.PPE
  89.         +-------------+
  90.               |
  91.               +-------------- Your Directory name may vary
  92.  
  93.     3) Run PCBSETUP and add the following lines to your CMD.LST file:
  94.  
  95.         Command  Security  PPE/MNU File -or- Keystroke Replacement
  96.     =======  ========  =======================================
  97.      IAB        90     R:\PCB\PPE\IAB\IAB.PPE MAINT
  98.      IABS       90     R:\PCB\PPE\IAB\IAB.PPE STATUS
  99.  
  100.      Actually, the command names can be anything you want to be
  101.      (that is, anything PCBoard allows).  The Command names and
  102.      required security levels are what we use on Data-Base BBS
  103.      and are provided as an example.  We suggest you set your
  104.      security levels to whatever is required for access to
  105.      Internet E-mail conference (obviously, IAB won't be of
  106.      much use to your non-Internet-enabled users).
  107.  
  108.      Some explanation is order here to explain our "dual
  109.      command entry" above...
  110.  
  111.      IAB can be invoked in one of three "modes" depending on
  112.      what parameter(s) (if any) are passed on the IAB.PPE
  113.      command line.  IAB currently supports the following
  114.      "modes"...
  115.  
  116.  
  117.      a) No command line parameters
  118.  
  119.         IAB.PPE
  120.  
  121.         In this case, IAB will startup in Message Entry Mode
  122.         and display the "To: (<Enter>=list) ?" prompt.
  123.  
  124.         This replaces the "To: (Enter) = 'ALL'" standard prompt
  125.         in your Internet E-mail conference (only).  Your users
  126.         will still see the standard PCBoard "To:" prompt in your
  127.         other conferences (only your Internet E-mail conference
  128.         prompt will be customized - IAB active).
  129.  
  130.         This is the way you entered the IAB command line
  131.         into your PCBTEXT file (prompt #199) during step 2 above.
  132.  
  133.  
  134.      b) The Maintenance command line parameter
  135.  
  136.         IAB.PPE MAINT    (or simply: IAB.PPE M)
  137.  
  138.         Here, you are telling IAB that you want to startup
  139.         in List Maintenance Mode...you want to edit your
  140.         Internet Address Book without having to join the
  141.         Internet E-mail conference (and type "E").
  142.  
  143.         This mode also supports a second command line
  144.         parameter (active only for registered users)...
  145.  
  146.         IAB.PPE MAINT QUIET  (or simply: IAB.PPE M Q)
  147.  
  148.         which will startup IAB in maintenance mode but
  149.         completely skip the welcome screen and jump
  150.         immediately to the Address Book list display.
  151.  
  152.  
  153.      c) The Status command line parameter
  154.  
  155.         IAB.PPE STATUS  (or simply: IAB.PPE S)
  156.  
  157.         Sometimes you'll just want to check to see how many
  158.         entries are in your Address Book or whether you have
  159.         Auto-Record Mode turned on.  Starting IAB this way,
  160.         will display a brief status report to the screen
  161.         instead of actually opening the Address Book.
  162.  
  163.  
  164.      We choose to "bury" the command line parameters in our
  165.      CMD.LST (as in our example above) but you don't have to
  166.      do it that way.  You could just as easily make a single
  167.      entry to your CMD.LST file that doesn't pass any
  168.      parameters to IAB and leave that to your users.
  169.      However, we found the IAB/IABS dual entry approach
  170.      easier for our users.
  171.  
  172.  
  173.     4) Modify the enclosed IAB.CNF sample configuration file to
  174.        customize IAB for your system.
  175.  
  176.     Line 1: Michael Walter           Your FULL Name
  177.  
  178.     Line 2: Data-Base BBS            Your BBS Name
  179.  
  180.     Line 3: 000000                   Registration number
  181.                                      (leave the 0's until you register)
  182.  
  183.     Line 4: r:\pcb\ppe\iab\welcome   Welcome screen path\filename
  184.                      (file provided)
  185.  
  186.     Line 5: r:\pcb\ppe\iab\iab.hdr   Main Listing Header file
  187.                      path\filename  (file provided)
  188.  
  189.     Line 6: r:\pcb\ppe\iab\dat       Path (ONLY) for IAB to use for
  190.                      the data files it creates
  191.  
  192.     Line 7: 90                       Minimum security level for IAB use
  193.  
  194.     Line 8: 181                      Internet E-mail conference number
  195.  
  196.     Line 9: 1                        Flag to Toggle Caller Log Writing
  197.                                      (ON=1/off=0).  Registered users can
  198.                      turn off logging by setting this to 0
  199.  
  200.  
  201.  
  202. SHAREWARE
  203.  
  204.      You have 30 days to evaluate IAB, then you must register or
  205.      remove it.  You use IAB at your own risk. I will not be responsible
  206.      for lost data or any damage that the use or misuse of IAB may cause.
  207.      It's been thoroughly tested on my system and works flawlessly here
  208.      but I'm just covering all bases.  Our disclaimer and other
  209.      legalities follow:
  210.  
  211.  
  212.  DISCLAIMER:
  213.  
  214.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  215.       WITHOUT WARRANTY, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
  216.       ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  217.       PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH THE
  218.       CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  219.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  220.       OR BREACH OF ANY WARRANTY.
  221.  
  222.  
  223.  DISTRIBUTION:
  224.  
  225.     You may make this file available for downloading from your BBS or you
  226.     may upload it to any BBS of your choice, provided that you do not make
  227.     any changes to the contents of the archive (ZIP file). The archive and
  228.     its individual contents may not be used by any service that charges any
  229.     money whatsoever, without the express written permission of the author.
  230.  
  231.  
  232.  REGISTRATION:
  233.  
  234.     Registration grants you a license to use IAB on all nodes of the
  235.     one (1) BBS that it is being registered to. Licenses may not be
  236.     transferred.
  237.  
  238.     IAB registration is only $15.00  (NJ residents add 6% sales tax)
  239.  
  240.     Registration and placement of the registration number into the
  241.     IAB.CNF configuration file, replaces the "[UNREGISTERED]" portion of
  242.     the welcome screen display with your BBS System Name. Alternatively,
  243.     registered users can completely remove the welcome screen from program
  244.     startup (by using the "MAINT QUIET" command line parameters).
  245.  
  246.     Also (by default) IAB logs program entry, exit, and Auto-Record
  247.     Mode address additions to the Callers Log file.  Registered users
  248.     have the option of enabling or disabling IAB Caller Log file writes.
  249.  
  250.     To register your copy of IAB, please either fill out the registration
  251.     form (REGISTER.FRM) and mail, e-mail, or fax it back to us OR call
  252.     Data-Base BBS and register on-line with a credit card and instantly
  253.     receive your registration number.  Additional registration details
  254.     are included in the REGISTER.FRM file.
  255.  
  256.     Be sure to use the proper upper/lower case when filling in your name
  257.     and BBS name. They MUST EXACTLY MATCH the way you typed them in the
  258.     IAB.CNF configuration file.
  259.  
  260.  
  261.  SUPPORT:
  262.  
  263.     Remember, if you have any problems, questions or suggestions,
  264.     drop me a note on our support board...Data-Base BBS or via
  265.     Internet E-mail or RelayNet(tm) (RIME).
  266.  
  267.          Data-Base BBS - SysOp: Michael Walter
  268.  
  269.          Node 1: 908-735-2180 - Hayes 14.4   Public Access Node
  270.          Node 2: 908-735-2185 - Hayes 14.4   IAB Registered Users Only
  271.          Node 3: 908-735-2707 - USR DS       IAB Registered Users Only
  272.  
  273.     RIME: ->DATABASE or ->1251   INTERNET: sqlcraft@data-base.com
  274.  
  275.  
  276.  
  277.   HISTORY
  278.  
  279.     11-09-93 ■ Initial Release - IAB version 1.00
  280.     11-14-93 ■ Maint Release   - IAB version 1.01
  281.          - Added the IAB4E PPE and DOC files to the package.
  282.            These are used to run IAB as a PCBoard 'E'command 
  283.            replacement (in CMD.LST) instead of a prompt replacement
  284.          - Fixed a typo in the "MAINT QUIET" parameter
  285.  
  286.  
  287.  
  288.  
  289.