home *** CD-ROM | disk | FTP | other *** search
/ Share Gallery 1 / share_gal_1.zip / share_gal_1 / CO / CO015.ZIP / SLBBS31B.ZIP / QUICK.DOC < prev    next >
Text File  |  1989-04-26  |  16KB  |  317 lines
  1.  
  2.                 -------------------------------------------
  3.                      SEARCHLIGHT BULLETIN BOARD SYSTEM
  4.                       QUICK INSTALLATION INSTRUCTIONS
  5.                               by Frank LaRosa
  6.  
  7.                  (c) Copyright 1987,88 Searchlight Software
  8.  
  9.                 -------------[ Version 1.30 ]--------------
  10.  
  11.  
  12. THE FOLLOWING INSTRUCTIONS are intended as a guide for experienced users of 
  13. both MSDOS and BBS software.  The full documentation for Searchlight BBS is 
  14. contained in the file SLBBS.DOC.  Use these instructions only if you're in a 
  15. hurry to get your BBS up and running; consult the full manual for further 
  16. information.
  17.  
  18.  
  19.  
  20. (1) Files List
  21.  
  22.   To begin the installation process, you need the following files:
  23.  
  24.   CONFIG.EXE  - Configuration/initialization program
  25.   SLBBS.EXE   - Startup program/doors manager
  26.   LOGIN.EXE   - Login/new user program
  27.   BBS.EXE     - Searchlight BBS main program
  28.   FILES.EXE   - Searchlight Files system
  29.   SYSOP.EXE   - Searchlight Sysop program
  30.   
  31. In addition, the file TEXT.ZIP, containing the online help files, will be 
  32. needed if online help is desired, although omitting the online help files is 
  33. not an error.
  34.  
  35.  
  36.  
  37. (2) Installation
  38.  
  39.   Begin by creating a directory on your hard disk for Searchlight BBS; usually 
  40. this directory is simply called BBS, although you may call it anything you 
  41. like.  Make your BBS directory active and copy the above six files into it.
  42.  
  43.  
  44.  
  45. (3) File Setup
  46.  
  47.   The program CONFIG.EXE must be run first.  It creates the BBS's main data 
  48. files and lets you configure your communications and other system options.  
  49. Just type CONFIG and press RETURN.  CONFIG says,
  50.  
  51.   Searchlight BBS data files cannot be found.
  52.   Do you wish to create them in the current directory (Y/N)?
  53.  
  54. Type 'Y' to proceed.  CONFIG creates six data files, as follows:
  55.  
  56.   CONFIG.BBS   - SLBBS configuration info
  57.   USER.BBS     - User file
  58.   MESSAGE.BBS  - Message file
  59.   INDEX.BBS    - Subboard file
  60.   LOG.BBS      - Call log file
  61.   QUOTES.BBS   - Quotes file
  62.  
  63. These six files are used and maintained by the BBS system; these are the only 
  64. six data files you need to run Searchlight BBS.  Of these six files, only 
  65. USER.BBS and MESSAGE.BBS grow dynamically as more users and messages are added 
  66. to the system.  The remaining files are static in length.
  67.  
  68.  
  69.  
  70. (4) Configuration
  71.  
  72.   Continuing with the CONFIG program, you should now see a menu with the items 
  73. General Setup, Communications Setup, and Screen Colors Setup.  Select each 
  74. section and edit the fields as desired.  Here is a brief rundown of the CONFIG 
  75. options found in each section:
  76.  
  77.   (A) General Setup
  78.   This section contains 19 fields for configuring your system's name, access
  79.   levels assigned to new and validated users, path and file names, etc.  The
  80.   most important item in this list is TEXT FILE PATH.  This field defines the
  81.   path to the directory where SLBBS will look for its online help files, user
  82.   defined text files (such as the login screen), custom menus, etc.  Type a 
  83.   pathname here, such as "C:\BBS\TEXT", and be sure to create the directory
  84.   with the MKDIR command after exiting CONFIG.
  85.     The Program Path option lets you define the path where Searchlight's 
  86.   EXE files will be found.  If left blank, the path defaults to the current 
  87.   directory.  If nonblank, it can be used to allow you to place your 
  88.   program files on a different drive (ie. RAMdisk) for faster access.  
  89.     Consult the SLBBS main manual for a description of the other items.
  90.  
  91.   (B) Communications Setup
  92.   These options configure your COMM port, modem speeds, and modem init 
  93.   strings.  For the two init strings, use the ! character to generate a 
  94.   carriage return, and ~ (tilde) to generate a 1/2 second pause.  Remote Init 
  95.   String is trans-mitted to the modem each time the BBS resets itself for 
  96.   another call.  Local Init String is issued during a local login; it 
  97.   typically contains the string "ATH1!" to make the phone busy while the SYSOP 
  98.   logs in.  
  99.     Searchlight uses interrupt-driven input AND it will use interrupt-driven 
  100.   output if the "Output Buffering Factor" is set to a nonzero value.  IF YOU
  101.   EXPERIENCE PROBLEMS with modem I/O, try setting your Output Buffering Factor
  102.   to zero.  Some RS232 adapters or internal modems do not work reliably with
  103.   output buffering.
  104.     The BBS waits for an "OK" message from the modem after issuing init 
  105.   strings.  If no OK message is received, a warning message is printed.  
  106.   Please consult the main manual for further information.  
  107.     The "Direct Video" option found in this section lets you specify whether 
  108.   direct writes or BIOS calls will be used for screen output. Select BIOS mode
  109.   if running Searchlight in a multitasking, windowed environment; use Direct 
  110.   otherwise.
  111.  
  112.   (C) Screen Colors Setup
  113.   These fields define screen colors used by the program on color CRT's.  If 
  114.   your CRT is monochrome, the colors selected will not affect you, but they
  115.   will affect those users selecting the Color ANSI mode when logging in.
  116.   Colors are expressed as numeric values from 0 to 15; the numbers correspond
  117.   to screen colors as follows:
  118.  
  119.     (Dark Colors)          (Light Colors)
  120.      0: Black               8: Dark Gray
  121.      1: Blue                9: Light Blue
  122.      2: Green              10: Light Green 
  123.      3: Cyan               11: Light Cyan
  124.      4: Red                12: Light Red
  125.      5: Magenta            13: Light Magenta
  126.      6: Brown              14: Yellow
  127.      7: Light Gray         15: White
  128.  
  129.  
  130.  
  131. (5) Running Searchlight BBS
  132.  
  133.   After exiting CONFIG, you are ready to run SEARCHLIGHT BBS.  Simply type 
  134. SLBBS on the command line and press RETURN.  You must be positioned in the 
  135. "current" directory containing the six BBS data files to run Searchlight; 
  136. otherwise, an error message will result.
  137.   SLBBS.EXE is the startup file which will invoke the main program, BBS.EXE, 
  138. login program, and other programs automatically.  Always run SLBBS, rather than
  139. BBS.EXE or LOGIN.EXE, when starting Searchlight.  You can exit Searchlight BBS
  140. and return to DOS at any time by pressing ALT-X.  You can log in to the system
  141. locally by pressing the spacebar or RETURN key.  Other "hot keys" are described
  142. in detail in the main manual.
  143.   To log in, type the RETURN key, select [C]olor or [M]onochrome graphics, and 
  144. enter SYSOP in response to the "Enter Your Name" prompt.  SYSOP is a default 
  145. account created automatically by the initilization program.  Although most 
  146. SLBBS operators use the SYSOP account, you can create other accounts for your-
  147. self as neccesary.  BE SURE TO ASSIGN A PASSWORD to your SYSOP account with 
  148. the OPTIONS command; otherwise, other users will be able to gain access to 
  149. your system.
  150.  
  151.  
  152.  
  153. (6) Text Directory Setup
  154.   
  155.   The pathname specified as the "Text File Path" (item #13 on the General 
  156. Configuration Menu) determines where Searchlight will look for certain text 
  157. files, including online HELP files, menus, ANSI screens, etc.  If you left this 
  158. field blank earlier, create a directory named TEXT and enter its pathname into 
  159. the Text File Path.  Install the Searchlight online HELP files by unpacking the 
  160. file TEXT.ZIP into this directory (or, if you did not receive your HELP files 
  161. in archive form, copy all files with *.MH, *.SH, *.FH and *.TXT extensions into 
  162. your text directory).
  163.   Other files in the TEXT directory are files you create with a text editor or 
  164. ANSI type editor.  Text files have the extension .TXT if the file is a general 
  165. text file for all users, or .ANS if the file contains ANSI sequences.  You can 
  166. create seperate versions of a file for ANSI and non-ANSI users; for example, 
  167. if you have the files LOGIN.TXT and LOGIN.ANS, the TXT file is displayed when 
  168. a user selecting non-ANSI graphics mode logs in, and the ANS file is used when 
  169. an ANSI user logs in.  If you want to use one file for both, name it LOGIN.TXT.
  170.  
  171. Here are the files you can create.  All are optional.
  172.  
  173.   LOGIN.TXT/ANS   : Title screen, displayed with each login
  174.   LOGOFF.TXT/ANS  : Ending screen, displayed at logoff
  175.   NEWUSER.TXT/ANS : File displayed once for each new user
  176.   MMENU.TXT/ANS   : File to replace the main HELP menu
  177.   FMENU.TXT/ANS   : File to replace the files system HELP menu
  178.   SMENU.TXT/ANS   : File to replace the sysop HELP menu
  179.  
  180.   SUBA.TXT/ANS    : Subboard message files, displayed once each time a user
  181.   SUBB.TXT/ANS    :   accesses the indicated subboard.
  182.      ...          :
  183.   SUBX.TXT/ANS    :
  184.  
  185. In addition, the online HELP files (files ending in .MH, .FH, and .SH) are 
  186. ordinary text files and may be edited if desired.
  187.  
  188.  
  189.  
  190. (7) Files and Doors Setup
  191.  
  192.   To use the FILE transfer system and the DOORS system, you first need to 
  193. create two files, FILEDIR.DEF and DOORS.DEF.  These files should be present 
  194. in the BBS's main working directory (same directory as the BBS data files).
  195. These files must follow a strict format.  Please consult the main manual 
  196. for complete details; check the table of contents under "Files System" and 
  197. "Doors System".
  198.  
  199.  
  200.  
  201. (8) General Information
  202.  
  203.   Some general information and oft-overlooked points of interest:
  204.  
  205. Abort Key: At any time, the ^C key aborts messages, listings, or other 
  206.   output in progress.  It is quite responsive in comparison to much other
  207.   BBS software; use this key often.
  208.  
  209. Access Levels: Access levels go from 0 to 255.  In general, access levels 
  210.   do not have any "absolute" significance, but are relative to the minimum
  211.   access levels you set up on subboards, file directories, and DOORS.  The
  212.   exceptions are access level 255, defining the SYSOP who has ultimate 
  213.   access to all functions, and 254, defining a Co-SYSOP who has access to
  214.   most features except things like changing his/her own access level, etc.
  215.  
  216. Help Files: Read the online help files if you want a fast overview of the
  217.   system without reading the manual.  Just select a command on the main 
  218.   menu and type the '?' key.  Press 'H', then RETURN, for a help menu.
  219.  
  220. Text Editor: Searchlight BBS's full screen, WordStar(TM) compatible text 
  221.   editor works with most terminal software supporting the ANSI or VT100 
  222.   terminal codes. A three-way setup switch (accessable via the Options 
  223.   command) lets you configure the editor's level of ANSI support. In the 
  224.   "Full" ANSI mode, the editor requires a robust ANSI terminal at the remote
  225.   end to work correctly. "Generic" mode is a relaxed ANSI mode, requiring
  226.   less support from the remote terminal but more modem I/O. "ProComm" mode
  227.   is provided as a special mode for ProComm(TM) users.
  228.      * FLASH * Telix 3.0 has been tested and found to work very well with 
  229.   Searchlight when vt102 mode is selected within Telix. The only bug found,
  230.   with Searchlight configured for "Full" ansi mode, was in Telix's
  231.   implementation of the insert-character function. However, since ProComm 
  232.   doesn't support that either, Telix works perfectly in Searchlight's 
  233.   ProComm mode.  
  234.   
  235. Doors: The Searchlight BBS Doors System is much more powerful than DOORS 
  236.   systems provided by other BBS software.  Rather than simply redirecting 
  237.   output to the serial device, Searchlight completely replaces the BIOS INT 
  238.   10 function, allowing ANY software that uses the BIOS to run as a door.
  239.   Cursor positioning, window clearing, color/attribute changes, etc. are 
  240.   supported by translation into appropriate ANSI terminal sequences.  On 
  241.   the input side, F-Keys, cursor keys, and other special keys are trans- 
  242.   lated from ANSI sequences to IBM extended keyboard codes.  What this 
  243.   means is that you can run not only line oriented programs, but many full 
  244.   screen programs as Doors.  The best way to see if a program will run as a 
  245.   Door is to simply try it; make sure you use an ANSI compatible terminal 
  246.   and run in ANSI mode if the door program uses full-screen features.  
  247.  
  248. ShareWare vs. Extended Version: This ShareWare version of Searchlight BBS 
  249.   is NOT a stripped-down or modified version of our Extended Version.  It
  250.   is a powerful, flexible program in its own right.  We offer the Extended
  251.   Version as an advanced Searchlight BBS offering more features and more
  252.   flexibility to those who need it.  If you are unsure, you can use this
  253.   version now and upgrade later.  Please consult the READ.ME file contained
  254.   in this package for complete details and order forms.
  255.  
  256.  
  257.  
  258. (9) Technical Comments
  259.  
  260.   Finally, here is some information for the technically oriented.
  261.  
  262. Language: Searchlight BBS is written in Turbo Pascal.  Versions starting 
  263.   with 1.30 are compiled with Turbo 5.0 and are distributed as .EXE files.
  264.   Earlier versions were compiled with Turbo 3.0 and included .COM, .CHN, 
  265.   and overlay (.000, .001, etc) files.
  266.  
  267. User File: Searchlight's user file (USER.BBS) is implemented as a binary 
  268.   tree. The tree is not maintained as a balanced or AVL tree, but it may be 
  269.   balanced on demand with the BALANCE function on the Extended Sysop Menu.
  270.   Deleted records are maintained internally on a free record list, and 
  271.   reused automatically; when no free records exist, the file is expanded.
  272.  
  273. Message File: Searchlight BBS maintains messages as linked lists of data 
  274.   blocks in the MESSAGE.BBS data file.  Messages do not occupy fixed 
  275.   amounts of storage but allocate as many blocks as is needed for the 
  276.   message.  Deleted message blocks are maintained in a free block list, and
  277.   reused automatically.  MESSAGE.BBS contains text of all messages, mail, 
  278.   and bulletins on the system.
  279.     Message texts are compressed before being stored according to one or
  280.   both of two simple compression algorithms.  Compression reduces the size
  281.   of the message file 10-15%.
  282.     User mailboxes are implemented as linked lists of messages; thus, there
  283.   is no limit on the number of messages that may be in a user's mailbox.
  284.  
  285.   Both the USER and MESSAGE files are totally self-maintaining; no 
  286.   "packing" type operations need be performed.  Deleted file space is 
  287.   automatically and efficiently reused.  
  288.  
  289. Directory Files: Each .DIR file is stored as a binary tree with an extra 
  290.   set or pointers forming a chronological list.  Thus, all single file 
  291.   references, alphabetical file lists, and NEW message scans are extremely 
  292.   efficient; only wild-card searches require the entire file to be 
  293.   processed.  
  294.  
  295.  
  296. Limitations: The following values apply ONLY to ShareWare versions of 
  297.   Searchlight BBS, and are subject to change in future versions:
  298.  
  299.   Subboards: The number of message subboards is fixed at 24.
  300.  
  301.   Messages: The maximum number of messages that may be posted on any 
  302.     subboad is 290. In Extended Versions, this has been increased to 480.
  303.  
  304.   Message File: The message file is subject to an upper limit of approx-
  305.     imately 3.1 megabytes.  Searchlight BBS will return an "out of disk
  306.     space" message if this limit is reached (this represents thousands of
  307.     messages). The size limit is doubled to 6.2mb with Extended Version.
  308.  
  309.   File Directories: The maximum number of entries in each FILEx.DEF file
  310.     is 26.  However, you can have up to 24 seperate FILEx.DEF files,
  311.     giving you thousands of file system options.
  312.  
  313.   Doors: For readability only, it is suggested that each DOORSx.DEF file 
  314.     contain less than 20 entries.  You can chain DOOR menus and you can 
  315.     have seperate DOOR listings for each subboard.
  316.  
  317.