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