home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / BBS / GUEST221.ZIP / GUEST.DOC < prev    next >
Text File  |  1995-05-28  |  22KB  |  509 lines
  1.  
  2.  
  3.                     ****************************************
  4.                            ATLANTIS SOFTWARE PRESENTS
  5.                     ****************************************
  6.  
  7.                               THE GUEST REGISTRY
  8.  
  9.                                  Version 2.21
  10.  
  11.                       Copyright 1994-1995   By Jimmy Rose
  12.                     ****************************************
  13.  
  14.  
  15.  
  16.  
  17.                       SHAREWARE NOTICE
  18.                        ________________
  19.  
  20.     The Guest Registry is being distributed as shareware. If you
  21.     enjoy this program please register it. Whenever you find any
  22.     shareware Program that you like and find useful, please consider
  23.     registering. This will help encourage future developement of
  24.     other useful programs and also ensure that your favorites will
  25.     be supported and enhanced.
  26.  
  27.  
  28.                             REGISTERED VERSION INFO
  29.                             _______________________
  30.  
  31.         The Guest Registry requires a registration number to operate in
  32.         registered mode. When you register this program you will receive
  33.         a registration number that is unique to you. No two numbers are
  34.         the same. Place your personal registration number on the second
  35.         line of the sysop.cfg file.
  36.         If you have registered this program then your name will
  37.         appear on the opening screen.
  38.  
  39.     The Guest Registry is a copyrighted program!
  40.  
  41.  
  42.  
  43.                                 INTRODUCTION
  44.                                 ____________
  45.  
  46.         This is the ORIGINAL AND BEST Guest Registry Program!
  47.         This program is written entirely in C++ for maximum efficiency.
  48.  
  49.         The Guest Registry is a very popular door for all major BBS's.
  50.         It may be configured as a Main Menu item on many boards.
  51.         Guests (users) can enter information about themselves and view
  52.         other guest profiles.
  53.  
  54.         Includes information such as hobbies, favorite books and movies,
  55.         marital status, dating availability, children, pets, and much more.
  56.         All questions are optional, and guests may edit personal stats at
  57.         any time.
  58.  
  59.  
  60.  
  61.  
  62.                            REGISTRATION & SUPPORT
  63.                            ______________________
  64.  
  65.         The Guest Registry will be supported indefinately. The latest
  66.         shareware version will always be available for download from
  67.         The Prophecy BBS (513) 423-2336, FidoNet 1:110/950.
  68.         It is a free download on your first call.
  69.     For registration information see the file "order.txt".
  70.         Atlantis Software products are also available as free downloads
  71.         from various support and distribution sites, please read the
  72.         support.doc file for a site near you.
  73.  
  74.     Please see the "Notes" section at the end of this file for
  75.     additional information on obtaining assistance.
  76.  
  77.         If you have any comments, suggestions, or features you'd like
  78.         to see added to The Guest Registry, please write or send E-mail.
  79.         I want to hear your ideas. All questions as will be answered as
  80.         quickly as possible. The Shareware version supports 20 guests.
  81.         The registered version will support an unlimited number.
  82.  
  83.  
  84.  
  85.                                 REQUIREMENTS
  86.                                 ____________
  87.  
  88.         You need an IBM compatible computer and a BBS. The Guest
  89.         Registry will work with TriBBS, Wildcat, PC Board, Spitfire,
  90.         Synchronet, RBBS, WWIV, Gap, Renegade, Remote Access, KBBS,
  91.         and other BBS's that can run one of these doors.
  92.         It is assumed that you are familiar with your BBS software
  93.         and have installed other doors. If not, step by step instructions
  94.         are provided for some systems. This program may also be run in
  95.         local mode without a BBS (see below).
  96.  
  97.  
  98.                                 INSTALLATION
  99.                                 ____________
  100.  
  101.         If you're upgrading from a previous version, read "upgrade.doc".
  102.  
  103.         Create a directory for The Guest Registry. Preferably in your
  104.         BBS directory. You can name it whatever you want. For example,
  105.         if you want to create a directory called "guest" in your BBS
  106.         directory, from the Dos prompt type "cd c:\bbs", then type
  107.         "md guest". Don't type the quotation marks.
  108.         This assumes your BBS is on your c: drive. If it's on another
  109.         drive, substitute the appropriate letter.
  110.  
  111.         After you create the directory, unzip the archive contents
  112.         into it. Next you'll need to create a configuration file or modify
  113.         the "guest.cfg" file included with the archive. This is an ascii
  114.         text file that can be created or edited with any text editor.
  115.         The configuration file MUST be in the same directory as The
  116.         Guest Registry. It has the following format:
  117.  
  118.                 Line 1:  Door data type (see below)
  119.                 Line 2:  Path to Door data file (dropfile)
  120.                 Line 3:  BBS name
  121.                 Line 4:  Sysop's name
  122.                 Line 5:  Locked baud rate
  123.  
  124.         Line 1 is the Door data file type and can be any of the following
  125.         TRIBBS for TriBBS                    ; TRIBBS.SYS
  126.         PCB    for PC Board                  ; PCBOARD.DAT, PCBOARD.SYS
  127.         GAP    for Gap                       ; DOOR.SYS
  128.         SF     for Spitfire                  ; SFDOORS.DAT
  129.         RBBS   for RBBS                      ; DORINF0#.DEF
  130.         WC     for Wildcat                   ; CALLINFO.BBS
  131.         GAP    for Wildcat**                 ; DOOR.SYS
  132.         WWIV   for WWIV                      ; ????????.???
  133.  
  134.         * Note that TriBBS can run doors with any of the configuration
  135.           dropfiles above. Remote Access may use either GAP or RBBS.
  136.           Other BBS packages may work with multiple dropfiles, but
  137.           make sure you choose only one.
  138.           On some systems you may need to copy door.sys into your Guest
  139.           Registry directory.
  140.        **Wildcat 4.0 and later should configure their system to use
  141.           the "small" door.sys setting. Run MakeWild and change the
  142.           setting from the door configuration screen.
  143.           A text file for additional help with Wildcat is available
  144.           from The Prophecy BBS if you need further assistance. You
  145.           may also call the Atlantis Wildcat support site listed in
  146.           the "support.doc" file.
  147.  
  148.         The other lines should be self-explainatory. Here's a sample
  149.         config file:
  150.  
  151.                 TRIBBS
  152.                 c:\tribbs\
  153.                 The Prophecy
  154.                 Jimmy Rose
  155.                 38400
  156.  
  157.         This would configure The Guest Registry to run on a TriBBS
  158.         system. It assumes the BBS is in the "tribbs" directory. Other
  159.         Sample configuration files can be found at the end of this file.
  160.  
  161.         Next you must edit the sysop.cfg file for your system.
  162.  
  163.                           SYSOP.CFG INSTRUCTIONS
  164.                           ----------------------
  165.         This configuration file MUST be present and MUST be named
  166.         "sysop.cfg". The file is seven lines and the format
  167.         is as follows:
  168.  
  169.         Line 1 is the name of the person this program is registered to.
  170.         Line 2 is your registration number, or 0 if unregistered.
  171.         Line 3 is the Sysop security level for accessing the Sysop Editor.
  172.         Line 4 is one character, either A if your BBS uses Alias's
  173.                or R if your BBS uses Real names. Use capital letters.
  174.         Line 5 # of Color used for column 1 when displaying names.
  175.         Line 6 # of Color used for column 2 when displaying names.
  176.         Line 7 # of Color used for column 3 when displaying names.
  177.  
  178.                 Color codes for lines 5-7
  179.                         1 Blue
  180.                         2 Green
  181.                         3 Cyan
  182.                         4 Red
  183.                         5 Purple
  184.                         6 Brown
  185.                         7 Grey
  186.                         8 Dark Grey
  187.                         9 Light Blue
  188.                        10 Light Green
  189.                        11 Light Cyan
  190.                        12 Light Red
  191.                        13 Light Purple
  192.                        14 Yellow
  193.                        15 White
  194.  
  195.         All seven lines should be present and there must not be any blank
  196.         lines. The fourth line provides improved compatibility with BBS's
  197.         that do not use alias's. Please note that if your BBS uses alias's
  198.         and you have been using a previous version of this program, you
  199.         should not change to using real names. If lines 5-7 are left blank
  200.         default colors will be used.
  201.  
  202.         Here is a sample sysop.cfg file from The Prophecy
  203.         -------------------------------------------------
  204.         Jimmy Rose
  205.         12345678
  206.         200
  207.         A
  208.         12
  209.         11
  210.         9
  211.  
  212.         The last step is to create a batch file to call the door. Each
  213.         BBS is different, so it's assumed you know how to create one
  214.         for your system. Here's a sample batch file for TriBBS:
  215.  
  216.                 cd c:\tribbs\guest
  217.                 gr sample.cfg
  218.                 cd c:\tribbs
  219.                 board
  220.  
  221.         The first line changes to the directory where The Guest Registry
  222.         is located.
  223.         The second line calls the door followed by the configuration file.
  224.         You MUST include the name of the configuration file, although you
  225.         can name it anything you like.
  226.         The third and fourth lines return you to the board.
  227.         Each system will be a little different, the one line that will
  228.         be same for every batch file is the second one.
  229.         Finally, edit your bbs files to display the door name and call
  230.         the batch file when selected. You're on your own here!
  231.  
  232.         The Guest Registery can easily be run from your Main Menu on
  233.         systems with extendable menus. It is recommended you do run
  234.         the program from the Main Menu if your system supports this.
  235.  
  236.         To set up The Guest Registry as a Main Menu item on a Tribbs
  237.         system, name the above batch file "mainj", then edit your
  238.         main.mnu file to call the batch file by adding the following
  239.         line:
  240.         J,J,Guest Registry,20
  241.  
  242.         This will call up The Guest Registry whenever the letter J is
  243.         selected from the Main Menu. You may use any availabe letter
  244.         that you like, just substitute the letter you want to use for
  245.         the letter J in all instances above, including the batch file.
  246.         The number at the end of the line is the minumum security level
  247.         a user must have to be able use The Guest Registry. Adjust this
  248.         to your liking.
  249.  
  250.  
  251.                               OPENING SCREENS
  252.                               ---------------
  253.  
  254.         The Guest Registry contains two opening screens that may be
  255.         edited with any ansi editor. They are called "welcome1.ans"
  256.         and "welcome2.ans". You may use them to customize the program
  257.         to your bbs, or theme if you have one. The first screen will
  258.         print a copyright notice at the bottom of the screen. The second
  259.         screen is optional and may be deleted if desired. For best results
  260.         you should save the ansi's with 19 lines or less.
  261.  
  262.  
  263.  
  264.                                  OPERATION
  265.                                  _________
  266.  
  267.         The Guest Registry may be run locally if you wish. If you want
  268.         to run the door without going through the BBS, make the directory
  269.         where the program is stored the current directory. From the Dos
  270.         prompt type "gr sample.cfg local". You will prompted to enter a
  271.         user name. Whatever name you type in will be used for your Alias.
  272.  
  273.         When The Guest Registry loads you will see a list of commands.
  274.         Here are the Main Menu commands:
  275.  
  276.         R - Register As A Guest:
  277.             This command lets you enter your personal information
  278.             into the registry. You will be asked a series of questions
  279.             for which you will type in your answer. If you don't want
  280.             to answer a paticular question, just hit enter and it will
  281.             be left blank.
  282.             If you are already registered, you can't register again.
  283.             select "E" instead.
  284.  
  285.         S - Search For Guest:
  286.             Asks you to enter a name. If the name is a registered
  287.             guest, the info for that guest is displayed.
  288.             The search is not case-sensitive and you may type in a
  289.             partial name to search for.
  290.  
  291.         V - View Guest List:
  292.             Displays a list of all registered guests and displays
  293.             registry for guest that you select.
  294.  
  295.         B - Browse Summaries:
  296.             Displays all users and their summary, one screen full
  297.             at a time.
  298.  
  299.         I - Instructions:
  300.             Shows ansi information screen. This screen is named
  301.             help.ans and may be customized by the Sysop.
  302.  
  303.         E - Edit Personal Info:
  304.             Let's you make changes to your personal registry file.
  305.  
  306.         Z - Sysop Editor:
  307.             Accesses the Sysop editing utilities. Only someone with
  308.             Sysop access can see this. For details on the editor,
  309.             see below.
  310.  
  311.         Q - Quit and Reurn to the BBS:
  312.             Does just what it says.
  313.  
  314.  
  315.                                SYSOP EDITOR
  316.                                ------------
  317.  
  318.         G - Guest Editor:
  319.             You will be shown the guest list and asked to select a guest
  320.             number. You will then be taken to the edit screen where you
  321.             may change any data that a guest has entered.
  322.  
  323.         T - Question Editor:
  324.             You will see a list of the headings for each question listed
  325.             on the screen. Choose the question number you wish to change.
  326.             You will be prompted to enter a new heading, then a new quest-
  327.             ion. The current question will be displayed for reference.
  328.             Pressing "enter" without typing in anything will keep the
  329.             current heading or question.
  330.  
  331.             Please note that if you change a question, everyone who has
  332.             entered an answer for that question will have a wrong answer
  333.             for the new question. Therefore when you enter a new question
  334.             you will be asked if you want to clear all answers for that
  335.             question. If you answer yes, every guest's record will be
  336.             erased for that question only.
  337.  
  338.             Obviously you will want clear the answers for a new question
  339.             if it is an entirely different question. If you just re-word
  340.             the original question, then there is no need to clear the
  341.             answers.
  342.  
  343.         D - Delete Guest:
  344.             Asks for guest number, then deletes this persons registry.
  345.             CAUTION! Once it is deleted, the only way to get it back is
  346.             to have the user fill it out again.
  347.  
  348.         N - Change Name or Alias:
  349.             This allows the Sysop to change someone's name or alias. It
  350.             is very useful if a user changes his name or alias after they
  351.             have already filled out The Guest Registry. If they do that,
  352.             then they will not be able to edit their personal info until
  353.             the Sysop changes it inside The Guest Registry.
  354.  
  355.  
  356.                             SPECIAL FUNCTIONS
  357.                             -----------------
  358.         While the door is running the following keys have special functions:
  359.  
  360.         [F6]    Subtracts 5 minutes from callers time.
  361.         [F7]    Adds 5 minutes to callers time.
  362.         [F9]    Quits the door and returns caller to BBS.
  363.         [F10]   Enters split screen chat mode.
  364.         [HOME]  Shows what the special keys do.
  365.         Alt+D   Drop to DOS.
  366.  
  367.         Please note that time added or subtracted is not returned to the
  368.         BBS, the time is for the door only.
  369.         The "TIME ON" in the status line is the time the caller has been
  370.         in the door. If a caller runs out of time while in the door, he/she
  371.         will be returned to the BBS before being logged off.
  372.  
  373.  
  374.                                HINTS & TIPS
  375.                                ------------
  376.  
  377.         Whenever possible The Guest Registry should be configured to run
  378.         from your Main Menu.
  379.         In the beginning ecourage everyone to register. Post a news item
  380.         to let users know what it is. For some reason people are reluctant
  381.         to enter their info if their are very few names listed.
  382.         However, once more people register, they seem more than willing. I
  383.         ask that all new users please fill out the registry and whenever I
  384.         chat with someone, I ask them if they would mind filling it out if
  385.         they haven't already done so. They always respond with something
  386.         like "sure"! Sysops seem to have a lot of power.  :)
  387.         Let people know when you add different questions, so they can go
  388.         in and respond to the new questions.
  389.  
  390.         Common Problems & Questions:
  391.  
  392.         "It looks fine on the sysop end, but users only see garbage on the
  393.         screen when they enter the door".
  394.         This is always a configuration error. If your serial port is locked,
  395.         change the last line in The Guest Registry configuratiion file the
  396.         rate at which you lock your serial port. If the serial port is not
  397.         locked, the setting MUST be 0.
  398.         Also, make sure your RTS/CTS flow control is on in your node config.
  399.  
  400.         "It runs fine, but it's not in color".
  401.         Try using a different drop file.
  402.  
  403.         "Users fill out The Guest Registry but their name isn't shown on
  404.         the display screen".
  405.         Unfortunately some boards do not properly read the dropfile when
  406.         alias's aren't used. This should be taken care of with version 2.0.
  407.  
  408.         "I'm using Wildcat 4.0+ and it just won't work."
  409.         It is possible to get the program running by using the
  410.         GAP setting.  You will need to set up this program using a
  411.         "small" door.sys and possibly copy your door.sys into the
  412.         working directory. For additional support contact the official
  413.         Wildcat support site listed in the "support.doc" file.
  414.  
  415.         "Everyone has access to the Sysop editor!"
  416.         You do not have the Sysop security level set correctly in
  417.         the "sysop.cfg" file. Make the appropriate change.
  418.  
  419.  
  420.                          SAMPLE CONFIGURATION FILES
  421.                          --------------------------
  422.         ________________________________________
  423.         Spitfire.cfg:
  424.  
  425.                 SF
  426.                 c:\spitfire\
  427.                 The Haven
  428.                 Eric Carr
  429.                 0
  430.         ________________________________________
  431.         pcboard.cfg:
  432.  
  433.                 PCB
  434.                 c:\pcbbs\
  435.                 Consultant's BBS
  436.                 Joe Comm
  437.                 14400
  438.         ________________________________________
  439.         wildcat.cfg:
  440.  
  441.                 GAP
  442.                 c:\bbs\node1\
  443.                 Dragons Liar
  444.                 The Wraith
  445.                 38400
  446.         ________________________________________
  447.         gap.cfg
  448.  
  449.                 GAP
  450.                 c:\bbs\
  451.                 Salt Lake BBS
  452.                 Martha Mormon
  453.                 9600
  454.         ________________________________________
  455.  
  456.  
  457.                                     NOTES
  458.                                     _____
  459.  
  460.         IMPORTANT! The program data is contained in the files "guest.usr"
  461.         and "userx", where x is the users registry number.
  462.         DO NOT attempt to modify these files! It is a good idea to make
  463.         a backup copy of these file at least once a week. If the files
  464.         become corrupted or are lost due to hard drive failure, or
  465.         human error, then all callers who already entered info will
  466.         have to do so again.
  467.  
  468.         Future plans include internal mail capabilities, a logon utility
  469.         to remind those who havn't registered their info, improved search
  470.         functions and a matchmaker option for finding friends with
  471.         similar interests.
  472.  
  473.         The Guest Registry was programmed by myself because I wanted
  474.         this feature on The Prohecy BBS and could not find anything
  475.         else suitable for the IBM. It is an extremely popular feature
  476.         on other platforms.
  477.  
  478.         This program was written in C++ using Borland Turbo C++ and the
  479.         Tdoor library (c) by Mark Goodwin.
  480.  
  481.         If you have any questions, comments, or suggetions please write
  482.         to:
  483.  
  484.                 Jimmy Rose
  485.                 2000 Linden ave.
  486.                 Middletown, OH 45044-4435
  487.                 USA
  488.  
  489.         Or call the Home of Atlantis Software:
  490.         The Prophecy BBS (513) 423-2336
  491.         24 hours a day. Fido 1:110/950
  492.  
  493.         Voice support is available to REGISTERED users.
  494.  
  495.         Please refer to the file "SUPPORT.DOC" for a complete listing
  496.         of support sites.
  497.  
  498.         If you do have a problem and call or write, please be prepared
  499.         to provide the following information:
  500.         > Guest Registry version number.
  501.         > BBS Software & version number.
  502.         > Serial port used? (locked?, rate?).
  503.         > Does your BBS use Alias's or Real Names?
  504.         > A copy of the batch files used, incuding cfg files.
  505.         > Any thing else "specific" to your problem.
  506. *****************************************************************************
  507.            THANKS FOR USING THE GUEST REGISTRY!
  508. *****************************************************************************
  509.