home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / q_asc110 / qstart.txt < prev    next >
Text File  |  1990-03-02  |  15KB  |  342 lines
  1.  
  2.  
  3.  
  4.  :::::             .                    //
  5. ::   ::                       ::       //   ::                   ::
  6. ::   ::  ::  ::  :::    ::::  :: ::   //    :::    :::::  ::::   :::
  7. :: : ::  ::  ::   ::   ::     ::::   /////  ::    ::  ::  :: ::  ::
  8.  :::::    ::::   ::::   ::::  :: ::    //    :::   :::::  ::      :::
  9. ----:---------------------------------//------------------------1.00ß
  10.                                      //                         
  11.  
  12.      The front-end interface for QuickBBS ST and related utilities
  13.  
  14.  
  15.                            TABLE OF CONTENTS
  16.                            =================
  17.  
  18.                1. General..............................3
  19.                2. Installation.........................4
  20.                3. Operation............................6
  21.                4. Terminal.............................8
  22.                A. Error Levels........................10
  23.  
  24.                               1 - GENERAL
  25.                               ===========
  26.  
  27. QuickStart  is  the  part  of QuickBBS   ST   which  handles  all  modem 
  28. initialisation,  answering the phone and looking for a caller.  It  also 
  29. provides  a  shell for the QuickBBS utilities and a terminal  with  dial 
  30. directory, VT-52 and Ansi graphics, uploading and downloading. It is, in 
  31. fact, a sort of mailer without the FidoNet capabilities.  You'll be able 
  32. to see the status of your BBS at a glance with QuickStart installed.
  33.  
  34. For The-Box and Binkley sysops:  because QuickStart knows nothing  about 
  35. FidoNet,  it  can  only be used when Quick is running as  a  stand-alone 
  36. package,  but  if  you like you can run  QuickStart  during  non-mailing 
  37. hours, and use it as a terminal/shell of course. If QuickStart detects a 
  38. FidoNet mailer at the other end, it will drop the carrier.
  39.  
  40. The  QuickStart  program  consists of two  main  files:  QSTART.PRG  and 
  41. QSTART.OVL.  QSTART.PRG  is  only  a tiny  little  program  which  loads 
  42. QUICKBBS.PRG  and  QSTART.OVL in turn,  depending on  error  levels.  An 
  43. example:       
  44.  
  45.      1) QSTART.PRG is loaded.
  46.      2) QSTART.PRG loads QSTART.OVL
  47.      3) QSTART.OVL waits for a caller etc.
  48.      4) A 1200 bps call is received
  49.      5) QSTART.OVL exits with errorlevel 12 (for 1200 bps)
  50.      6) QSTART.PRG  detects the errorlevel and starts up QUICKBBS.PRG  at 
  51.         1200 bps.
  52.      7) QuickBBS logs on the user etc.
  53.      8) User logs off, QuickBBS exits with errorlevel 0
  54.      9) QSTART.PRG detects the errorlevel and goes back to step 2.
  55.  
  56. This  way the maximum of memory is available for QUICKBBS.PRG,  and  you 
  57. won't need a batch file.  If you want DO want to run QuickStart using  a 
  58. command  line  interpreter and batch file you can rename  QSTART.OVL  to 
  59. QSTART.PRG  and  do  the  errorlevel  checking  yourself.   A  list   of 
  60. errorlevels can be found in Appendix A.
  61.  
  62. At present the extended events in QuickStart and QuickBBS are not  fully 
  63. supported, so the event window will be empty.
  64.  
  65.                             2 - INSTALLATION
  66.                             ================
  67.  
  68. Installing QuickStart is easy.  Just place QSTART.PRG and QSTART.OVL  in 
  69. the  same directory as QUICKBBS.PRG.  QuickStart assumes that  you  have 
  70. QConfig, UserEdit and such in the same directory too.
  71.  
  72. Now, start up QConfig (v1.20 or newer), and select option 6:
  73.  
  74.      Term Init Str..... ATZ|~ATS0=0M1X3|     (1)
  75.      Dial String....... ATDT                 (2)
  76.      Default TimeOut...  30 seconds          (3)
  77.      Default Pause.....  10 seconds          (4)
  78.      No Connect 1...... NO CARRIER           (5)
  79.      No Connect 2...... BUSY
  80.      No Connect 3...... NO DIALTONE
  81.      Zmodem AutoDl..... Yes                  (6)
  82.      Log Level......... 1                    (7)
  83.  
  84. (1)  This  is the command which is sent to the modem when  the  terminal 
  85.      mode is entered. See the main QuickBBS ST documentation for special 
  86.      characters.
  87.  
  88. (2)  This  is the command which makes your modem dial out.  It  will  be 
  89.      followed by the number to dial and a carriage return.
  90.  
  91. (3)  This  is  the 'default' maximum time between dialing a  number  and 
  92.      establishing  a connection.  If this time is  exceeded,  QuickStart 
  93.      will toggle DTR to make the modem hang up.
  94.  
  95. (4)  When dialing a number QuickStart will wait before trying to redial. 
  96.      The default pause can be specified here. Enter 0 for no pause.
  97.  
  98. (5)  When  one of these strings is received from the  modem,  QuickStart 
  99.      will assume the dialing failed. 
  100.  
  101. (6)  QuickStart has a feature called Zmodem Auto Download. When switched 
  102.      on  the first few bytes of a Zmodem packet header will trigger  the 
  103.      Zmodem  download  driver.  The toggle in QConfig is  the  'default' 
  104.      status when the terminal is started.
  105.  
  106. (7)  The  Log Level controls the amount of information  QuickStart  (NOT 
  107.      QuickBBS!) puts in the log file.  Each logged line starts with  one 
  108.      of the following characters:
  109.  
  110.         ~      (not important)
  111.         +      (good)
  112.         -      (not so good)
  113.         ?      (strange situation encountered)
  114.         !      (hard error!)
  115.  
  116.      Depending on the log level,  these lines will be written to the log 
  117.      file SYSTEM.LOG. The log levels are:
  118.  
  119.           0  will log ALL lines
  120.           1  will log lines starting with !, ?, -, +
  121.           2  will log lines starting with !, ?, -
  122.           3  will log lines starting with !
  123.  
  124.      Log level 0 will require a lot of disk space,  level 3 hardly  any. 
  125.      This will NOT affect the logging which QuickBBS does.
  126.  
  127. Of  course the other options in QConfig should be filled in  before  you 
  128. attempt   to  run  QuickStart  or  QuickBBS.   Refer  to  the   QuickBBS 
  129. documentation.
  130.  
  131. A  file  called  WAITKEYS.BBS (located in the CONF\  directory)  can  be 
  132. created  to assign values to the function keys.  This file has the  same 
  133. format as any other 'function key file':
  134.  
  135.      1:C:\COMMS\FLASH\FLASH.PRG
  136.      2:D:\EDIT\TEMPUS.PRG D:\QBBS\SYSTEM.LOG
  137.  
  138. In the above example,  pressing f1 while in unattended mode (not in  the 
  139. terminal)  will load FLASH.PRG in the given  directory.  Parameters  can 
  140. also be passed, like in line 2.
  141.  
  142. A second function key file called TERMKEYS.BBS is also used, and defines 
  143. the function keys used in the terminal mode.
  144.  
  145. When a caller is connected he/she will see the lines...
  146.  
  147.      + QuickStart v1.00, Copyright 1989 by J. Webb, DeltaVision Systems.
  148.      + Press <Escape> to start the BBS...
  149.  
  150. After  the  user has pressed the Escape key QuickBBS  is  loaded.  If  a 
  151. FidoNet compatible mailer is detected on the other side,  the carrier is 
  152. dropped.
  153.  
  154. Next QuickStart looks for and sends the file BANNER.ASC in the  textfile 
  155. directory.  There are NO control codes recognised by QuickStart. If this 
  156. file doesn't exist:
  157.  
  158.      + Starting the BBS now! Just a sec...
  159.  
  160. will be sent instead.
  161.  
  162.                              3 - OPERATION
  163.                              =============
  164.  
  165. When  you run QSTART.PRG you will see that the main  screen  (unattended 
  166. mode) is divided into four main areas:
  167.  
  168.      The  top-left  box is called the activity window and  contains  the 
  169.      last  few log lines.  Depending on your log level,  some  of  these 
  170.      lines will also be placed in the log file.
  171.  
  172.      The  top-right box is called the status window.  This contains  the 
  173.      current  status of QuickStart,  the number of  calls  (rings),  the 
  174.      number of actually connected users,  the number of messages left to 
  175.      YOU  and the number of times you were paged.  The current  time  is 
  176.      also displayed.
  177.  
  178.      The bottom-left box is the last user window. Once you've had a call 
  179.      it  will display the last few users on your system,  together  with 
  180.      the time of connection and log-off, and whether that user left mail 
  181.      for you or tried to page you.
  182.  
  183.      The  bottom-right  box  will  contain  information  concerning  the 
  184.      current and next events,  but is at present left blank because  the 
  185.      extended events are not yet implemented.
  186.  
  187. The  top line of the screen contains a little menu.  The highlighted  or 
  188. coloured  characters represent the key which you should press to  access 
  189. that option. They are:
  190.  
  191.      Local     Starts QUICKBBS.PRG in local mode.
  192.      Terminal  Enters the terminal.
  193.      Users     Starts up USEREDIT.PRG for editting users.
  194.      Config    Starts  up  QCONFIG.PRG for editting  the  configuration. 
  195.                After  completion QuickStart will ask whether  it  should 
  196.                re-read the configuration file.
  197.      Boards    Starts  up MCONFIG.PRG for editting the configuration  of 
  198.                your message boards.
  199.      Events    Starts up ECONFIG.PRG for changing the event setup. After 
  200.                completion QuickStart will ask whether it should  re-read 
  201.                the event file.
  202.      Menus     Starts up MENUEDIT.PRG for editting your menu files.
  203.      Dos       Starts  up  the  command line  interpreter  specified  in 
  204.                QConfig.  Function  keys in CONF\DOSKEYS.BBS  are  loaded 
  205.                first.
  206.      Quit      Quit to GEM (or to whatever started QuickStart).
  207.  
  208. The keys displayed are not the only keys which can be used to access the 
  209. options. Alt-J, for instance, also shells to DOS.
  210.  
  211. Before starting any of the utilities, executing function key programs or 
  212. quitting  to  Gem,  the reset string will be sent to  the  modem.  After 
  213. return to unattended mode the modem is initialised again.  When entering 
  214. terminal  mode  the terminal init string is sent instead  of  the  reset 
  215. string.
  216.  
  217. Some other keys are available in unattended mode too:
  218.  
  219.      -  The HELP key displays a list of all available keys,
  220.      -  The  four items (calls,  connects,  messages and yells)  can  be 
  221.         reset  to  zero  by pressing Clr/Home,
  222.      -  The P key will toggle printer logging on and off.  This key will 
  223.         also  toggle  the printing in QuickBBS,  as it is saved  in  the 
  224.         SYSINFO.BBS  file.  Likewise,  pressing Alt-P in  QuickBBS  will 
  225.         toggle the printer logging in both QuickStart and QuickBBS.
  226.      -  The I key can be used to manually initialise the modem.
  227.  
  228. While in unattended mode the screen saver is active.  It will blank  the 
  229. screen after the time stated in QConfig.  Move the mouse or press a  key 
  230. (e.g. space or shift) to get the screen back. As soon as any activity is 
  231. detected (a caller or an event) the screen is restored too.
  232.  
  233. While  QuickStart is waiting for something to happen it will  initialise 
  234. the modem every 5 minutes 'just for fun'.
  235.  
  236.                            4 - TERMINAL MODE
  237.                            =================
  238.  
  239. By  pressing the T key in unattended mode the terminal is  started.  The 
  240. terminal init string is sent to the modem first.
  241.  
  242. The terminal is a fairly simple, but nevertheless handy one. It features 
  243. VT-52  and Ansi graphics modes,  built-in PC font,  dial directory  with 
  244. redial,  upload and download with Xmodem,  Xmodem 1K,  Windowed  Xmodem, 
  245. Ymodem and Zmodem, filename recognition and more...
  246.  
  247. At  the  bottom of the screen you'll see the status bar.  From  left  to 
  248. right it contains:
  249.  
  250.      -  The current baudrate,
  251.      -  CD (Carrier Detect) or NC (No Carrier),
  252.      -  STf (ST Font) or PCf (PC Font),
  253.      -  VT-52 or Ansi graphics,
  254.      -  The Zmodem AutoDL status,
  255.      -  A message section.
  256.  
  257. The available keys in the terminal mode are...
  258.  
  259.      UNDO      Returns to unattended mode,
  260.      HELP      Shows a list of available keys,
  261.      Alt-R     Receive file(s),                   (1)
  262.      Alt-S     Send file(s),                      (1)
  263.      Alt-B     Change Baudrate,
  264.      Alt-D     Dial directory,                    (2)
  265.      Alt-C     Clear screen,
  266.      Alt-J     Jump to DOS,                       (3)
  267.      Alt-H     Hangup (drop DTR),
  268.      Alt-F     Toggle ST or PC fonts,             (4)
  269.      Alt-G     Toggle VT-52 or Ansi graphics,     (5)
  270.      Alt-U     Log the 'other end' into the BBS,  (6)
  271.      Alt-V     View file,                         (7)
  272.      Alt-Z     Toggle Zmodem AutoDL.
  273.  
  274. (1)  A menu with available download/upload protocols will be  displayed. 
  275.      When receiving using a non-batch protocol,  QuickStart will attempt 
  276.      to guess the filename. After completion of the transfer a beep will 
  277.      sound.   There  are  different  beeps  for  completed  and  aborted 
  278.      transfers.
  279.  
  280. (2)  Alt-D calls up the dial directory. Each entry in this directory can 
  281.      be selected using the cursor keys.  The entries contain,  from left 
  282.      to right:
  283.  
  284.      -  BBS name,
  285.      -  Phone number,
  286.      -  Baudrate,
  287.      -  Timeout,
  288.      -  Default protocol,
  289.      -  Graphics mode,
  290.      -  Font,
  291.      -  Zmodem AutoDL or Normal.
  292.  
  293.      The number of redials can be set by pressing R. The pause, the time 
  294.      between redial attempts, can be set with the P key. Pressing S will 
  295.      save  any changes you've made to the dial directory,  which can  be 
  296.      accomplished with E. This will bring up an edit screen.
  297.  
  298.      Press  Escape  to abort dialing or Enter to  dial  the  highlighted 
  299.      number.  If  you  dial a number the settings of that BBS  are  made 
  300.      active (font, graphics mode etc).
  301.  
  302. (3)  Alt-J works like the Dos option in unattended mode,  and calls  the 
  303.      command  line interpreter specified in QConfig.  Note:  it  doesn't 
  304.      HAVE to be a CLI, you could put NeoDesk or something in here if you 
  305.      want.
  306.  
  307. (4)  The PC font will not show when Turbo-ST v1.4 or older is installed.
  308.  
  309. (5)  Ansi  in  QuickStart  is about the same as  what  is  supported  by 
  310.      QuickBBS ST itself.  It is far from perfect, but provides the basic 
  311.      components for controlling the screen.  It should NOT be used  with 
  312.      full screen editors like QuickEd,  otherwise you probably won't  be 
  313.      able  to get out...  Refer to QANSI.DOC for supported  Ansi  escape 
  314.      sequences. 
  315.  
  316. (6)  Say you are in the terminal mode when a user calls in.  You  answer 
  317.      the  phone  manually and find out that you'd like the user  to  log 
  318.      into  the  BBS.  Instead of making  him/her  call  back,  establish 
  319.      connection  (if  it was a voice call) with ATA  or  whatever  makes 
  320.      your modem answer the phone,  press Alt-B to set the baudrate,  and 
  321.      then Alt-U. This will log the user into the BBS. When the user logs 
  322.      off QuickStart will enter unattended mode, not terminal mode.
  323.  
  324. (7)  The  view-file  option  will display the selected  file  using  the 
  325.      current graphics mode and font.
  326.  
  327.                         APPENDIX A - ERRORLEVELS
  328.                         ========================
  329.  
  330. When QuickStart (QSTART.OVL) exits the following errorlevels are  passed 
  331. back to the calling program:
  332.  
  333.       0 - Go Offline,
  334.       1 - Start BBS in Local Mode,
  335.       2 - System Error,
  336.       3 - Start BBS for 300 bps user,
  337.      12 - Start BBS for 1200 bps user,
  338.      24 - Start BBS for 2400 bps user.
  339.  
  340. Any other errorlevels should be treated as program errors.
  341.  
  342.