Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / USBDOR45.ZIP / USBBSDOR.DOC < prev next >

Wrap

Text File | 1992-01-24 | 64.0 KB | 1,411 lines

------------------------------------------------------------------ | | | | | | | | | | | | | USBBSDOR Version 4.5 | | | | * Continuously updated and supported for over four years! * | | | | Search the USBBS National BBS Listings for Area Codes, | | States, Text, Modem types, Brand of BBS, & New listings. | | | | | | | | Works with virtually every brand of BBS software including: | | PCBoard 14.x, Wildcat!, RBBS, GAP, Spitfire, Remote Access, | | and any BBS software which uses a compatible PCBOARD.SYS, | | DOOR.SYS, DORINFO1.DEF, or SFDOORS.DAT information file. | | | | | | | | * * * COMPLETELY AUTOMATED MONTHLY MAINTENANCE * * * | | | | | | USBBSDOR Version 4.5 | | | | (C) Copyright 1987-1992 L. Brent Yandell All Rights Reserved | | | | Distributed by: | | | | Yandell Computer Services | | 12121 Little Road - Bldg. 303 - Suite 212 | | Hudson, FL 34667 | | | | DATA - (813) 842-8099 (HST) | | | | | | | | January 24, 1992 | | | | | | | | | | | ------------------------------------------------------------------ -------------------------------------------------------------------- USBBSDOR -------------------------------------------------------------------- TABLE OF CONTENTS Page ----------------- ---- INTRODUCTION ------------ 1.0 What is USBBSDOR 3 1.1 What's New 4 1.2 Upgrading from Previous Versions 4 PRELIMINARIES ------------- 2.0 A Word on Installing Doors 5 2.1 Obtaining the Current USBBS List 5 2.2 Required Files 5 INSTALLATION ------------ 3.0 Setting Up USBBSDOR.CNF 6-9 3.1 Setting Up Door Files to Call USBBSDOR 10 3.2 Setting Up PROTOCOL.DAT 11 3.3 Setting Up SEND.BAT 12 3.4 Setting Up and Modifying Text Files 13 RUNNING USBBSDOR ---------------- 4.0 Running USBBSDOR Locally 14 4.1 Notes on Automated Monthly Maintenance 14 4.2 Notes on Searching USBBS Lists 15 4.3 Notes on Downloading from USBBSDOR 15 4.4 Caller "Command Line" Search Information 16 4.5 On-Line Sysop Functions 16 4.6 Multi-nodes, Networks, Multi-taskers 16 QSUSBBS ------- 5.0 What is QSUSBBS (Quick-Search USBBS) 17 5.1 Restrictions On QSUSBBS Distribution 17 5.2 QSUSBBS Disclaimer 17 5.3 Personalizing Your Copy of QSUSBBS 18 MISCELLANEOUS ------------- 6.0 Where to Receive Assistance 19 6.1 Technical Notes 19 6.2 Log Entries 19 6.3 Error Messages 20 6.4 Disclaimer and Warranty 20 6.5 About the Author 20 6.6 Acknowledgments 20 6.7 Macro Chart 21 REGISTRATION ------------ 7.0 Registering USBBSDOR 22 -------------------------------------------------------------------- Page 3 USBBSDOR Page 3 -------------------------------------------------------------------- 1.0 What is USBBSDOR --------------------- USBBSDOR is a door program which allows the caller to access the USBBS National BBS List on-line. The caller may search the list for area codes, states, up to twenty characters of text, 9600 baud modem types, brand of BBS software, and new or changed listings in the list. If the Sysop desires, the caller may also download the list from within USBBSDOR. An optional security level may be attached to downloading. Searches may be conditional. Callers may specify where (area code, state, or entire list) to perform searches for Text, Modem, Brand of BBS, or New listings. Automated monthly Sysop maintenance! The Sysop simply places a new list each month in a specified location and USBBSDOR will know it is there and use it. No renaming! No re-configuring! No conversions! The same applies for the list's ZIP file if the Sysop enables downloading in USBBSDOR. USBBSDOR works with many types of BBS software, including PCBoard, Wildcat!, RBBS, GAP, Spitfire, Remote Access, and any software which uses door information files compatible with those BBS types. "Header" and "footer" information files from the list are created automatically! USBBSDOR checks to see if they exist each time it runs and creates them if not. If they do exist, USBBSDOR checks their dates and if the Sysop has installed a new list, USBBSDOR will create new information files automatically! Built-in local maintenance mode and configuration file editor with F1 pop-up help at each parameter for easy installation and testing. For callers in color mode, the list output is colorized "on-the-fly" for a nice effect. (H)elp is embedded in the Area code and State input prompts, in case a caller needs help determining an area code or state abbreviation. USBBSDOR is DESQview aware. Screen and keyboard I/O are limited to their assigned window. USBBSDOR gives back time slices while idling at input prompts. Text files (MENU, etc.) may contain PCBoard macros, Wildcat macros, or ANSI for color. Several USBBSDOR information @macros@ may be used in text files. USBBSDOR fully supports non-standard COM port operation. USBBSDOR runs at all baud rates and has been thoroughly tested with COM ports locked at 38400 baud. -------------------------------------------------------------------- Page 4 USBBSDOR Page 4 -------------------------------------------------------------------- 1.1 What's New --------------- Please refer to the enclosed HISTORY.TXT file for complete details of new additions and changes to this release of USBBSDOR. 1.2 Upgrading from Previous Versions ------------------------------------- * * * * * * ALL: ---------------- Use the new MENU, HELLO, HELPx, AREAx, STATE, MODEM, and BRAND files. These files contain PCBoard color macros. If you wish to use Wildcat macros or the Ascii\ANSI "two file - no macro" method, you may convert the above files with the enclosed USB-CONV.EXE program. Remove the old AREA.HLP, STATE.HLP, MODEM.HLP, and BRAND.HLP files. Wildcat 3.0 Sysops using BBS type #3 (generic DOOR.SYS) may switch to BBS type #4 (WC 3.0 mode) in the USBBSDOR.CNF configuration editor. This mode updates ACTIVITY.### files with caller activity in USBBSDOR (downloads, etc.). If using non-standard COM ports (COM ports other than 1 or 2) USBBSDOR now passes the SEND.BAT file the base address and IRQ for use with the DSZ "portx" option. See section 3.3 page 12 for more. See the section on PROTOCOL.DAT for modifying this file for Sysop selectable USBBSDOR status line placement during shelled protocol transfers (Top or Bottom of screen). * * * * * * If upgrading from USBBSDOR version 4.3: --------------------------------------------------- All of the above, plus: You should review sections of this manual concerning QSUSBBS. * * * * * * If upgrading from USBBSDOR versions 4.0 through 4.2: ---------------------------------------------------------------- All of the above, plus: In USBBSDOR's configuration file editor, set the "Set non-standard COM information" and "(F)ast-search area code or state" parameters. If upgrading from version 4.0, you will also need to set the "Add line separating each listing" parameter to your liking. F1 key help is available at all setup parameters to facilitate a quick upgrade. BYE and BYEG files are no longer used in USBBSDOR. * * * * * * If upgrading from USBBSDOR version 3.0 or earlier: -------------------------------------------------------------- USBBSDOR will need to be completely reinstalled. With the F1 key help at each local setup parameter it should take about 5 minutes! -------------------------------------------------------------------- Page 5 USBBSDOR Page 5 -------------------------------------------------------------------- 2.0 A Word on Installing Doors ------------------------------- The purpose of this documentation is to explain to you how to install the USBBSDOR program. It assumes that you have already read the manual which comes with your BBS software concerning doors and their use. It is not within the scope of this manual to cover door installation for each type of BBS which USBBSDOR is compatible with. 2.1 Obtaining the Current USBBS List ------------------------------------- The USBBS National BBS List is required. It is not possible for a USBBS list to be included within USBDOR45.ZIP, as the list is updated monthly. The newest USBBS list is always available on our system in the USBBS door. The "home" of the USBBS list is Robert Blacher's BBS and the number is 202-547-3037. The USBBS list follows a pattern for naming in the convention of USBBSxx.LST. The ZIP file which contains it follows this same pattern. The "xx" is the version number and increments monthly. As of this writing, the version is 92 (USBBS92.LST in USBBS92.ZIP) for 01/92. Using this method, you can determine the 2/92 list would be USBBS93.ZIP, etc. Use this method to locate the current version on the hundreds of systems where the USBBS list can usually be found. The author of USBBSDOR (the software) is not affiliated with the USBBS listings (the list), its authors, or its providers. Each USBBS list contains complete information regarding how, where, and to whom to make changes or additions to the USBBS list. 2.2 Required Files ------------------- The following files should be enclosed with USBDOR45.ZIP : QUICK.DOC - Quick and easy installation guide. USBBSDOR.EXE - The executable program file. USBBSDOR.DOC - This documentation file. USBSETUP.HLP - Help file for F1 help in local setup screen. USB-CONV.EXE - Convert default text files to Sysops choice. MENU - The door program's main menu. HELP, 2, 3 - Help files shown when a caller requests (H)elp. HELLO - A text file displayed when entering the door. AREA, 2, 3 - Help files for the Area Code prompt. STATE - Help file for the State prompt. MODEM - Help file for the Modem prompt. BRAND - Help file for Brand of software prompt. SEND.BAT - A single batch file for all external protocols. PROTOCOL.DAT - A configuration file for external protocols. QSUSBBS.EXE - Small, fast off-line USBBS list search & viewer. QSUSBBS.DOC - Documentation for QSUSBBS. QSREG.BAT - Use to personalize QSUSBBS (registered only). LOCAL.BAT - Batch file for USBBSDOR's local maintenance mode. HISTORY.TXT - Over four years of USBBSDOR! ORDER.FRM - Order form for registering USBBSDOR. There should be twenty-four files in USBDOR45.ZIP. All of the files should be dated 01-24-92. -------------------------------------------------------------------- Page 6 USBBSDOR Page 6 -------------------------------------------------------------------- 3.0 Setting Up USBBSDOR.CNF ---------------------------- Create a directory where USBBSDOR will reside. Extract the entire contents of USBDOR45.ZIP into this location. USBBSDOR uses a configuration file for certain door parameters. The default name is USBBSDOR.CNF, however you may designate any name for this file. USBBSDOR contains a built-in editor for this file. The first installation step is to properly configure this file for your system. You must enter USBBSDOR /L at your DOS prompt or use the enclosed LOCAL.BAT file (which is easier to remember) to invoke the door in its local maintenance mode. Select option #1 for "creating or modifying config files". You will then be prompted for a config file name. Simply hit enter to use the default USBBSDOR.CNF or enter a file name of your choice. You may use one configuration file for all nodes, unless you wish to enable certain features on some node's and not on others. You may use F1 to see the information below in a pop-up help window. * BBS software (door file) type ------------------------------- Please read this section carefully to avoid making incorrect assumptions about this parameter. 1) PCBoard 14.0 through 14.5 ONLY!. 2) PCBOARD.SYS Generic PCBOARD.SYS, Auntie (auntie.sys), etc. 3) DOOR.SYS Gap, other generic DOOR.SYS types. 4) DOOR.SYS Wildcat 3.0x ONLY. 5) DORINFOx.DEF RBBS and software which writes color mode as 2. 6) DORINFOx.DEF RA and software which writes color mode as 1. 7) SFDOORS.DAT Spitfire, etc. Selection #2 will allow entering an alternate file name. Press enter for the default file name displayed, or enter the name of the file your BBS software creates. For instance, Auntie Sysops would select #2, then enter AUNTIE.SYS. With the exception of #5 and #6, USBBSDOR only supports the original software's format for each information file. On multi-node systems which utilize DORINFOx.DEF (x = node #), USBBSDOR will select the appropriate file (DORINFO1 DORINFO2 etc.) based on the node number. * Name of this system --------------------- The name entered here is displayed at USBBSDOR's termination in the "Registered To:" message (registered copies only). The name used in this parameter MUST be identical to the name used when ordering a customized registration number for USBBSDOR. If registered, this name is also used when personalizing the QSUSBBS utility. Section 3.0 continues on the next page -------------------------------------------------------------------- Page 7 USBBSDOR Page 7 -------------------------------------------------------------------- 3.0 Setting Up USBBSDOR.CNF (continued) ---------------------------------------- * Idle keyboard time-out (minutes) ---------------------------------- Enter the number of minutes before a keyboard time-out occurs. USBBSDOR cycles back to the BBS should this happen. USBBSDOR will beep at the caller once every fifteen seconds during the last minute of the time-out period before returning the caller to the BBS. * Disable CTS signal checking ----------------------------- Always answer no to this question unless you know for a fact that disabling (answering yes) is best for your system. NEVER disable (answer yes) CTS when using a high speed or MNP modem. * Location of current USBBSxx.LST -------------------------------- Enter the location where you will be keeping the EXTRACTED USBBSxx.LST each month (xx = version). NEVER place a file name in this parameter. USBBSDOR looks for the newest USBBSxx.LST in this location each time it runs. This is also the location USBBSDOR will automatically extract a new list to (if your copy of USBBSDOR is registered) if a new list is detected in a new USBBSxx.ZIP file. See page 14 section 4.1. * Disable (D)ownload option --------------------------- USBBSDOR provides the caller a simple facility for downloading the the current USBBSxx.ZIP. When (D) is selected, USBBSDOR will choose the current USBBSxx.ZIP file and display its size and download time to the caller. The caller then chooses a transfer protocol. If QSUSBBS has been installed, the caller will be given a choice of downloading the USBBS list or QSUSBBS. If the caller has insufficient time remaining to transfer the file, the download will not be allowed. If you do not wish your callers to be able to download inside the door, answer Yes to disable downloading. * Security needed to Download ----------------------------- Enter the security level required for downloading. Some Sysops may want to allow new or non-subscribing callers access to the list, but not want them to be able to use USBBSDOR's download feature. This parameter facilitates this Sysop preference. USBBSDOR uses the caller's security level as it is provided in the BBS software's door information file (not available in generic PCBOARD.SYS mode #2). Section 3.0 continues on the next page -------------------------------------------------------------------- Page 8 USBBSDOR Page 8 -------------------------------------------------------------------- 3.0 Setting Up USBBSDOR.CNF (continued) ---------------------------------------- * Location of newest USBBSxx.ZIP -------------------------------- If you allow downloading, this parameter works in the same fashion as "Location of current USBBSxx.LST". Simply enter a location where the newest USBBSxx.ZIP (xx = version) will be located. USBBSDOR will will look for the newest USBBSxx.ZIP in this location whenever a caller requests a download. If you wish to allow the caller to download QSUSBBS.ZIP in USBBSDOR, the location entered here is also used for QSUSBBS.ZIP. Even if downloading is not desired, this parameter is also used if USBBSDOR is registered and you wish it to automatically detect and extract a new USBBS list to its appropriate location. See page 14, section 4.1 for a detailed explanation of this feature. * Disable `searching' message ----------------------------- When performing certain search functions on the USBBS list, USBBSDOR will display a "searching.." message between "finds". On faster systems, these "searching.." messages come and go so fast that they appear to be little glitches on the screen. After you have installed USBBSDOR, select CA as a state to display then observe between area codes as listings are displayed. Usually, only node's running on 8088's, slow drives, or extremely heavy network traffic will need this option enabled. * Line separating each listing ------------------------------ You may specify whether to put a dashed line, a solid line, or no line between each listing as it is displayed. Valid answers are (N)o lines, (D)ashed lines, or (S)olid lines. The dashes are ASCII 45 (hyphen) characters. The solids lines are ASCII 196 (box) characters. This option is strictly a "Sysop's preference" option. Section 3.0 continues on the next page -------------------------------------------------------------------- Page 9 USBBSDOR Page 9 -------------------------------------------------------------------- 3.0 Setting Up USBBSDOR.CNF (continued) ---------------------------------------- * Set non-Standard COM information ---------------------------------- If you are using COM 1 or 2, ignore this parameter. If COM ports other than 1 or 2 are used, the base address and IRQ of each non-standard port must be defined. Enter the base address in HEX for the appropriate ports in use. Enter the IRQ (1-7) for the appropriate ports in use. Allowing multiple ports to be defined in a single USBBSDOR.CNF file facilitates the need for only one configuration file for all nodes. When a COM port other than 1 or 2 is detected in the BBS door infor- mation file, the appropriate information is used for that port. Base address and IRQ settings for COM 1 and 2 cannot be changed. USBBSDOR does not support IRQ sharing in PS/2 machines. * (F)ast-search area code or state ---------------------------------- The Sysop may configure the (F)ast-search command to immediately display an Area code or State without any additional prompting from the caller. Simply enter a three digit area code, or two digit state code (Sysop's choice) at this parameter. Tip: If there are numerous listings in your area code, you may wish to enter just your area code. If you are in an area code where there are a limited number of listings in the USBBS list, you may wish to enter the state code. To disable the (F)ast-search command, simply leave this field blank. * USBBSDOR registration number ------------------------------ USBBSDOR is fully functional in unregistered copies except for the "automatic new list extraction" feature. Registration enables this feature. When USBBSDOR terminates, the message "Unregistered Copy" and a brief delay appears. A custom registration number will replace this with the name of your system and remove the brief delay. Registration also will allow you to personalize a copy of QSUSBBS with your BBS name and phone number (see the enclosed documentation and pages 17 and 18 for additional information). You may receive a customized registration number INSTANTLY by using a major charge card. See the enclosed file ORDER.FRM for details. -------------------------------------------------------------------- Page 10 USBBSDOR Page 10 -------------------------------------------------------------------- 3.1 Setting Up Door Files to Call USBBSDOR ------------------------------------------- The purpose of this section is to describe the command line calling parameters for USBBSDOR in a door (batch) file. You must refer to your BBS manual for complete instructions on installing doors with your BBS software. USBBSDOR has the ability to know the location where USBBSDOR.EXE has been executed. It is therefore unnecessary to change drives and directories in the door batch file used to call USBBSDOR. This is shown in method #1 below, using the location of USBBSDOR in-line. The naming conventions of door batch files varies greatly between different BBS systems. Some BBS systems allow the Sysop to call the door batch file anything they like (USBBS.BAT). Others might not even require the .BAT extension (USBBS). Other systems may have a pre-determined pattern for naming door batch files based on the door number on the system (DOOR1.BAT, etc.). Refer to your BBS manual for door batch file naming requirements. Sample door batch file (method #1): ----------------------------------- @echo off D:\USBBSDOR\USBBSDOR.EXE USBBSDOR.CNF C:\PCB board.bat | | | | | | The program Config file. Location where the BBS makes is called with this node's door info file. the location Location ONLY! in-line as shown. Sample door batch file (method #2): ----------------------------------- @echo off D: cd\usbbsdor USBBSDOR.EXE USBBSDOR.CNF C:\PCB D: | | cd\pcb | | board.bat Config file. --- Location where the BBS creates this door info file. Location ONLY! Multi-node DORINFOx.DEF type systems (RBBS) - place a %1 after the node's door information file location, so USBBSDOR will know which node is being used. USBBSDOR will work fine with either method shown above. Method #1 simply results in slightly faster loading and exiting of the door. Each example above ends with BOARD.BAT which should be replaced with the name of the batch file that runs your BBS. Your BBS software may or may not require this, especially if your BBS software has been set-up to "shell" to USBBSDOR. -------------------------------------------------------------------- Page 11 USBBSDOR Page 11 -------------------------------------------------------------------- 3.2 Setting Up PROTOCOL.DAT ---------------------------- If you allow downloading, you may wish to review the enclosed PROTOCOL.DAT file to see if it meets your needs. PROTOCOL.DAT is used to configure the designated "letter" for each type of protocol. USBBSDOR contains no internal protocols, and relies solely on external protocols such as DSZ for this function. Sample PROTOCOL.DAT ------------------- X,N,Xmodem,T C,N,Xmodem/CRC,T O,N,1K-Xmodem,T F,Y,1K-Xmodem/G,T Y,N,Ymodem,T G,Y,Ymodem-G,T Z,N,Zmodem,T There are 4 parameters on each line, each separated by a comma: Parameter #1 - the protocol letter choice. Parameter #2 - Y if error correction is required for this protocol, N or blank if not. Parameter #3 - short protocol description. Parameter #4 - B will force the USBBSDOR status line to appear at the bottom of the screen, a T or blank will make the USBBSDOR status line appear at the top of the screen during the protocol shell. Parameter #4 recommendations: For DSZ protocols use T (top). For GSZ protocols use B (bottom). Place SET GSZWINDOW=21 in each node's batch file which starts the BBS. For HS-Link use T (top). Example line in PROTOCOL.DAT (using DSZ): Z,N,Zmodem,T (using GSZ): Z,N,Zmodem,B Others: Use what works (looks) best for you. You may use any letter as a protocol except "V". The caller will have the opportunity at the protocol prompt to view the contents of the USBBSxx.ZIP file by selecting View. The ZIP view is internal to USBBSDOR. See the next section about setting up SEND.BAT. See page 15 section 4.3 for additional details about downloading. -------------------------------------------------------------------- Page 12 USBBSDOR Page 12 -------------------------------------------------------------------- 3.3 Setting Up SEND.BAT ------------------------ USBBSDOR uses a single batch file for all external protocols. It is not within the scope of this manual to provide instructions for setting up different types of protocols and all of their individual command line options. The enclosed SEND.BAT and PROTOCOL.DAT, along with the popular DSZ external protocol, should provide ample protocol coverage for the simple task of downloading the current USBBS list or QSUSBBS from USBBSDOR. If you wish to add or delete protocols, the information below might assist you. SEND.BAT is passed the following parameters from USBBSDOR: %1 (speed) %2 (port) %3 (filename) %4 (protocol letter used in USBBSDOR) %5 base address (hex) for com port (use with portx option). %6 IRQ for com port (use with portx option). An examination of SEND.BAT will demonstrate how the protocol letter is used to branch to the appropriate protocol command. If you are familiar with this type of batch file programming you may wish to modify it. If not, our best recommendation is to use it "as is". As mentioned previously the default configuration used with the popular DSZ protocol will provide ample coverage. IMPORTANT: If using GSZ (the graphical counterpart to DSZ) for any of the protocols, place the following SET command in the batch file used to start the BBS on each node: SET GSZWINDOW=21 Sysops using non-standard com ports may use one SEND.BAT for all nodes without the need for DSZPORT environment variables, etc. On non-standard nodes USBBSDOR will pass the base address and IRQ as defined for the com port in USBBSDOR.CNF. On standard nodes USBBSDOR will always pass 3f8,4 for COM1 and 2f8,3 for COM2. Example DSZ command line in SEND.BAT for non-standard COM ports: :Zmodem DSZ portx %5,%6 pB4096 sz -m %3 | (note comma) NOTE: The above paragraph applies only to those Sysops using COM ports other than 1 and 2 on their systems. See page 15 section 4.3 for additional details about downloading. -------------------------------------------------------------------- Page 13 USBBSDOR Page 13 -------------------------------------------------------------------- 3.4 Setting Up and Modifying Text Files ---------------------------------------- This section deals with the text display files USBBSDOR uses. These files are MENU, HELLO, HELPx, AREAx, STATE, MODEM, and BRAND. The files which come with USBBSDOR utilize the PCBoard color macro method instead of ANSI. This allows one file to be used instead of two files. USBBSDOR allows three different file types to accommodate different BBS systems. The examples below illustrate the MENU file but apply to all of the files listed above: Type #1 - PCBoard color macros. Using PCBoard color macros, both color & non-color versions of the file are in one file called MENU. Type #2 - Wildcat color macros. Using Wildcat color macros, both color & non-color versions of the file are in one file called MENU. Type #3 - Ascii and ANSI files. The non-color file is a regular Ascii text file called MENU. The color file is an ANSI file that is called MENUG. When ANSI is used in any of the above files, the "G" must be added to the file name. If you wish to modify the enclosed text files using a different method, use the USB-CONV.EXE program to convert the enclosed type #1 files to type #2 or type #3. USB-CONV.EXE will only convert the enclosed text files mentioned above. Important: When modifying ANSI files, TheDraw is recommended. When saving the file, if you wish the screen to clear you will need to select that option. When asked for the "Line Length" by TheDraw when saving a file, always answer NONE for best performance in USBBSDOR. Previously, some Sysops experienced difficulty when editing the multi-paged text files such as HELP and AREA. USBBSDOR now supports linking files together, by specifying a "next" filename in the file currently being displayed. This is done by placing a % (percent) in the LEFT-MOST (column #1) position on line #24 of the current file. The % must then IMMEDIATELY be followed by the file USBBSDOR is to display next, such as %HELP2. This allows the Sysop to edit each page easily and separately, especially those wishing to use the ANSI file method. It is recommended the %FILENAME be located on the 24th line of each file where it is being used, so the new file will begin immediately after a "More?" prompt appears. IMPORTANT: Regardless of the file type in use, do not designate the %FILENAME parameter while using a color ANSI or macro editor. These editors will place color instructions BEFORE the % on the line, thereby removing the % from the first position in the line. The %FILENAME must be added with a plain text editor AFTER saving the file with the color editor. Refer to the enclosed AREA? and HELP? files for examples of linking these long files together by making individual shorter files. Refer to page 21 section 6.7 for the macro chart. -------------------------------------------------------------------- Page 14 USBBSDOR Page 14 -------------------------------------------------------------------- 4.0 Running USBBSDOR Locally ----------------------------- Start USBBSDOR with /L (USBBSDOR /L) or the LOCAL.BAT file. Select option #2. You will be prompted for the configuration file to use, then you will be asked whether you would like to begin with color mode on or off. These selections allow you to see how USBBSDOR will appear to a caller on-line. USBBSDOR also works through the BBS in local mode and behaves in the same fashion as if a caller were on- line. When running USBBSDOR in local maintenance mode (/L), the name appearing on the status line will be (Local) SYSOP and will default to a time limit of 90 minutes. 4.1 Notes on Automated Monthly Maintenance ------------------------------------------- USBBSDOR automatically detects the presence of new USBBS lists and new USBBS zip files and acts accordingly. When USBBSDOR is run, it checks the "list location" the Sysop specified in the configuration file for the presence of USBBSxx.LST files. It determines which is the newest one and uses it for the caller's on-line session. Two files are needed by USBBSDOR for the "(E)xplain symbols" command and the "(I)nformation about list" command. These files contain information found at the beginning and end of USBBS lists. If these files do not exist, USBBSDOR automatically creates them from the list when it is run. If they do exist, USBBSDOR checks to see if a list has been installed which is NEWER than these two information files. If the list is newer, new information files are automatically created from the new list. When a caller selects (D)ownload, USBBSDOR checks the "USBBSxx.ZIP file" location the Sysop specified in the configuration file. It determines the newest USBBSxx.ZIP and presents it to the caller for downloading. To update the monthly list in registered copies of USBBSDOR, all the Sysop has to do is place the new USBBSxx.ZIP file where the door has been told it will be. USBBSDOR will determine the newest USBBSxx.ZIP file each time it runs. USBBSDOR will then look inside this newest ZIP and determine the date of the USBBSxx.LST file inside. If this date is NEWER than the current USBBSxx.LST, or if for some reason there is no "current" USBBSxx.LST, USBBSDOR will extract it and place it where you have indicated it should be in USBBSDOR.CNF. PKUNZIP.EXE must be available via a DOS path in order for this "automatic extraction" to work. If a new list is automatically extracted, USBBS.SYM and USBBS.INF (see above) will be created accordingly. Sysops who have not yet registered USBBSDOR will need to remember to extract the contents of the ZIP file to the location you have indicated for the list file in USBBSDOR.CNF. USBBSDOR will not perform this extraction for you if you have not registered USBBSDOR. -------------------------------------------------------------------- Page 15 USBBSDOR Page 15 -------------------------------------------------------------------- 4.2 Notes on Searching USBBS Lists ----------------------------------- USBBSDOR contains a file engine which permits extremely fast searches on unformatted (sequential text) files. On AT class or faster machines, end to end searches of USBBS lists are nearly instantaneous. Several methods of searching can be performed in the list. Area Code, States, 20 characters of Text, BBS brand, Modem types, and listings which are New or changed in the current list can be searched for. When performing searches for Text, Modems, Brands, or New, the caller may specify whether to search for them in an Area code, a State, or the Entire list. Commands may be parsed at the USBBSDOR command prompt, such as: A 813 Searches for area code 813 immediately. S FL Searches for FLorida immediately. M U 908 Searches for USR modems in area code 908 M H NJ Searches for 9600 Hayes modems in NJ M M E Searches for Microcom Modems in entire list Text, New, and BBS software may be searched this way also, except Text searches will not accept the last parameter (where to search), as it must be entered at the "where to search" prompt. 4.3 Notes on Downloading From USBBSDOR --------------------------------------- USBBSDOR does not contain a "display entire list" command. If the caller wants the entire list they may download it in compressed form rather than listing the entire contents, which saves a tremendous amount of on-line time. You must use a DSZ log compatible protocol in conjunction with the DSZLOG= environment setting in order for USBBSDOR to determine if a download was successful or not. If you use the default SEND.BAT and PROTOCOL.DAT, USBBSDOR will expect to find DSZ in the current directory or in a DOS path. If the environment setting DSZLOG= is being used, USBBSDOR will correctly place successful/aborted download information in a file called USBBSDOR.LOG. On PCBoard 14.x & Wildcat 3.0x systems USBBSDOR will write the download information to the node's caller file (activity log). All downloads from USBBSDOR are considered "free", as USBBSDOR does not write to any BBS software's USER files. If a caller does not have sufficient time remaining to download a file, the transfer will not be permitted. NOTE: It has been noted that some BBS packages which use DORINFOx.DEF as a door file place the locked DTE modem speed, not the callers connect rate, into the door file. In these cases, callers at speeds BELOW the locked DTE rate will be told the transfer time is shorter than it actually is. -------------------------------------------------------------------- Page 16 USBBSDOR Page 16 -------------------------------------------------------------------- 4.4 Caller "Command Line" Search Information --------------------------------------------- PCBoard software supports the passing of information by the caller to a door program. USBBSDOR takes advantage of this feature. For instance, if the door is named USBBS, and the caller enters USBBS NY at the PCBoard prompt, USBBSDOR will load and immediately begin searching for state NY and USBBS 813 would search for area code 813. Any valid USBBSDOR "stacked" command may also be entered, such as USBBS N 813 which immediately searches for (N)ew\changed listings in area code 813. USBBSDOR will always exit when the search has been completed if the door is started in this manner. This process is handled automatically by USBBSDOR and PCBoard. 4.5 On-line Sysop Functions ---------------------------- The following function keys may be used by the Sysop while a caller is on-line. To see these keys defined, enter ALT-H and they will be displayed in a portion of the status line. Only the keys which are valid with the type of BBS software USBBSDOR is running with will be displayed. F3 - Toggles printer on or off. This command is only valid when running USBBSDOR with PCBoard 14.x software. USBBSDOR follows this toggle from PCBoard and prints information such as downloads, carrier drops, and keyboard time-outs. F6 - If you have attached a security level to USBBSDOR's Download function and the caller does not have sufficient security to download, hitting F6 will allow the caller to download the file. This option does not appear in the status line when ALT-H is used as there is extremely little chance of this Sysop function being used in the USBBSDOR application. F7 - Certain user input errors will cause USBBSDOR to beep at them. The Sysop has the ability to toggle whether the host beeps also. This toggle is followed from BBS packages which use a PCBOARD.SYS or DOOR.SYS door file and accurately set this toggle. F8 - Will return the caller immediately to the BBS. F9 - Toggles the display on or off. USBBSDOR will follow the display toggle with all BBS software using a PCBOARD.SYS or DOOR.SYS file. F10 - This key will begin an on line chat session. Press ESCape to end the chat and return the caller to USBBSDOR. 4.6 Multi-nodes, Networks, Multi-taskers ----------------------------------------- USBBSDOR has been developed in a networked environment. All multi- node features have been tested on our own multi-node system. USBBSDOR's primary test facility is a twenty node system. USBBSDOR is DESQview aware. It is automatically detected, screen and keyboard I/O are "well behaved", and time slices are given back to other applications while USBBSDOR is idle at an input prompt. -------------------------------------------------------------------- Page 17 USBBSDOR Page 17 -------------------------------------------------------------------- 5.0 What is QSUSBBS (Quick-Search USBBS) ----------------------------------------- QSUSBBS is an "off-line" quick search program for the popular USBBS listings. It provides extremely fast area code, state, or text searches on the USBBS list. Sysops who have registered USBBSDOR may personalize a copy of QSUSBBS.EXE for distribution. QSUSBBS will display a message each time it is run which says: "This copy of QSUSBBS is compliments of:" NAME OF BBS & PHONE NUMBER If QSUSBBS has been distributed by a BBS which has not registered USBBSDOR, the contents above will be: [ UNREGISTERED BBS COPY ] This personalization is available as a FREE option to Sysops who have purchased a USBBSDOR registration number. A personalized copy of QSUSBBS cannot be purchased separately. QSUSBBS may be downloaded from USBBSDOR. If QSUSBBS.ZIP is located in the same location as specified for USBBSxx.ZIP files, the caller will be given a choice (by number) of which to download. 5.1 Restrictions on QSUSBBS Distribution ----------------------------------------- The files QSUSBBS.EXE and QSUSBBS.DOC may be distributed without the entire USBBSDOR package (USBDOR45.ZIP) among BBS systems as long as ONLY those TWO files remain together in the same compressed file. Under no circumstances may either or both of these files be distrib- uted with any other product or service, including any national BBS listing. Files including but not limited to BBS advertisements or BBS lists may NOT be packaged with QSUSBBS. The compressed file name for the two QSUSBBS files must be QSUSBBS plus the extension name name reflecting the compression type (QSUSBBS.ZIP). 5.2 QSUSBBS Disclaimer ----------------------- There are no warranties, expressed or implied, for QSUSBBS. Anyone who runs QSUSBBS on any computer assumes any and all liabilities for anything which may result as a consequence of running QSUSBBS. Under no circumstances shall Yandell Computer Services or the author of QSUSBBS be liable for any loss of profit or any other damages, including but not limited to special, incidental, consequential, or other damages, arising out of the use or inability to use QSUSBBS. -------------------------------------------------------------------- Page 18 USBBSDOR Page 18 -------------------------------------------------------------------- 5.3 Personalizing Your Copy of QSUSBBS --------------------------------------- * * * A great way to advertise your system! * * * The following files should be located with USBBSDOR.EXE: QSUSBBS.EXE QSUSBBS.DOC QSREG.BAT PKZIP.EXE must also be available via a DOS path. Run the QSREG.BAT file. 3 steps will AUTOMATICALLY be performed: Step #1 - You will be prompted for your system's telephone number. The QSUSBBS.EXE file will then be stamped with your BBS name (as it appears in USBBSDOR.CNF) and the phone number you just entered. This will appear on the screen each time QSUSBBS is started (as shown in section 5.0, page 17). Note: Step #1 will be skipped if USBBSDOR has not been registered. Step #2 - PKZIP.EXE will be used to create QSUSBBS.ZIP which will contain QSUSBBS.EXE and QSUSBBS.DOC. PKZIP.EXE must be accessible via a DOS path. Step #3 - QSUSBBS.ZIP will be copied to the location specified in the USBBSDOR.CNF configuration file for USBBSxx.ZIP download list files. QSUSBBS.ZIP must be located in that location so that it may be downloaded from USBBSDOR. QSUSBBS.ZIP will not be copied to this location if (A) The location is blank or NONE, or (B) the location is the same location as QSUSBBS.ZIP when created with USBBSDOR.EXE. If QSUSBBS.ZIP exists with USBBSxx.ZIP for download, USBBSDOR will allow the caller to choose between the two for downloading. If you wish, you may place QSUSBBS.ZIP in one of your regular BBS directories for download. The restrictions stated in section 5.1 on page 17 apply at all times. You may use other compression types for QSUSBBS.EXE and QSUSBBS.DOC in other areas of your system, however USBBSDOR itself will only recognize QSUSBBS.ZIP. QSUSBBS.DOC should be read for additional info regarding QSUSBBS. -------------------------------------------------------------------- Page 19 USBBSDOR Page 19 -------------------------------------------------------------------- 6.0 Where To Receive Assistance -------------------------------- Yandell Computer Services (YCS) provides the following technical assistance for USBBSDOR: 813-842-8099 The YCS Support System. Available to all BBS Sysops. INSTANT on-line credit card registration and support system for YCS Shareware. All nodes are 14400 (HST). On-line 7 days per week, 24 hours per day. 6.1 Technical Notes -------------------- Carrier is monitored by USBBSDOR. Should a caller drop carrier while using USBBSDOR, they will be returned to the BBS, which will detect the "no carrier" status and cycle appropriately. USBBSDOR uses approximately 128K of memory. USBBSDOR performs its own "ansi-detect request" to the callers communications program. If the caller supports ANSI sequences then USBBSDOR will use ANSI for special cursor movement, screen clearing, and prompting. USBBSDOR never changes the caller's screen color if the caller is in non-color mode (unless the caller requests color). If running in the PCBoard 14.x specific mode or Wildcat 3.0x specific mode, USBBSDOR uses the information in the respective door information files rather than performing its own ansi-detect request to the caller's communications program. 6.2 Log Entries ---------------- The following information is written to USBBSDOR.LOG: Completed downloads Aborted downloads Carrier drops Keyboard time-outs File access errors (Path not found) (Invalid drive) (File not found) On PCBoard 14.x and Wildcat 3.0x systems the following is written to the caller (activity) logs: The same entries in USBBSDOR.LOG Sysop chat active Sysop chat ended Successful downloads are also entered in the DOWNLOAD.TXT file on PCBoard 14.x systems. -------------------------------------------------------------------- Page 20 USBBSDOR Page 20 -------------------------------------------------------------------- 6.3 Error Messages ------------------- The only error messages which should ever be displayed by USBBSDOR are self-explanatory file access error messages (not found, invalid drive, invalid directory, etc.). * bad command or filename * This message will be echoed to the screen if DSZ (or the specified external protocol) could not be found during a download attempt. External protocols must reside in the directory with USBBSDOR or in a valid DOS path. 6.4 Disclaimer and Warranty ---------------------------- USBBSDOR is a shareware product. USBBSDOR may be uploaded to BBS systems provided copyright notices are not removed and no changes are made to the program. There are no warranties, expressed or implied, for unregistered copies of USBBSDOR. Sysops who install USBBSDOR assume any and all liabilities for anything which may result as a consequence of running USBBSDOR. For registered copies of USBBSDOR, Yandell Computer Services warrants that USBBSDOR will perform as described in this documentation. In the event USBBSDOR does not perform as specified, then Yandell Computer Services will elect to either fix USBBSDOR, or refund the amount paid, if notified within 30 days of registration. Under no circumstances shall Yandell Computer Services or the author of USBBSDOR be liable for any loss of profit or any other damages, including but not limited to special, incidental, consequential, or other damages, arising out of the use or inability to use USBBSDOR. 6.5 About the Author --------------------- L. Brent Yandell has been involved in telecommunications for five years, and has been updating and supporting USBBSDOR for over four years. Most PCBoard Sysops will be familiar our PCBFV, the popular on-line file viewer/extractor used in the PCBoard F V (File View) process. Also available is QReader, our on-line text display door with full screen reading capabilities such as PgUp, PgDn, Up arrow, Down arrow, left and right keys (for wide text), and full screen text finds. Also available is ChatBox for PCBoard, a split-screen Sysop\Caller chat and page door. 6.6 Acknowledgments -------------------- Appreciation and many thanks are in order for the following people: * Pete Olympia, Meade Frierson, and Robert Blacher for the continued existence of the Darwin National USBBS List. * Roy Timberman * Jim Brewer * Tim Yandell * All of the USBBSDOR beta testers. -------------------------------------------------------------------- Page 21 USBBSDOR Page 21 -------------------------------------------------------------------- 6.7 Macro Chart ---------------- USBBSDOR utilizes the color macro convention used in PCBoard 14.5x and Wildcat 3.0x. The color chart is enclosed below for other BBS system Sysops who wish to use color macros instead of ANSI. Background (first digit) Foreground (second digit) ----------------------- ------------------------- Black = 0 Black = 0 Blue = 1 Blue = 1 Green = 2 Green = 2 Cyan = 3 Cyan = 3 Red = 4 Red = 4 Magenta = 5 Magenta = 5 Yellow = 6 Yellow = 6 White = 7 White = 7 Background(Blinking Foreground) High Intensity(Bright Foreground) ------------------------------- --------------------------------- Black = 8 Black = 8 Blue = 9 Blue = 9 Green = A Green = A Cyan = B Cyan = B Red = C Red = C Magenta = D Magenta = D Yellow = E Yellow = E White = F White = F Examples: Bright White on Black background: @X0F (PCB) or @0F@ (WC) (0=black F=bright white) Bright Yellow on Red background: @X4E (PCB) or @4E@ (WC) (4=red E=yellow) Blinking Bright Red on Black background: @X8C (PCB) or @8C@ (WC) (8=black C=bright red) Other macros allowed (in any text file) @CLS@ clear screen @FIRST@ is the callers first name, (cased, i.e. Brent). @SYSDATE@ is the current date. @DATE@ is also the current date. @SYSTIME@ is the current time. @TIME@ is also the current time. @TIMELEFT@ is the minutes left for the caller. @LEFT@ is also the minutes left for the caller. @FILENAME@ is the NAME of the newest USBBSxx.LST (list) found. @FILEDATE@ is the DATE of the newest USBBSxx.LST (list) found. @ZIPNAME@ is the NAME of the newest USBBSxx.ZIP found. @F@ is the (F)ast-search parameter. -------------------------------------------------------------------- Page 22 USBBSDOR Page 22 -------------------------------------------------------------------- 7.0 Registering USBBSDOR ------------------------- USBBSDOR is not free software. USBBSDOR must be registered within 30 days of installation. USBBSDOR is fully functional in unregistered copies except for the "automatic new list extraction" feature. Registration enables this feature. When USBBSDOR terminates, the message "Unregistered Copy" and a brief delay appear. A custom registration number will replace this with the name of your system and remove the brief delay. Registration also enables personalization of the enclosed QSUSBBS off-line utility. You may receive a customized registration number INSTANTLY by using a major charge card. See the enclosed file ORDER.FRM for details.