home *** CD-ROM | disk | FTP | other *** search
/ GEMini Atari / GEMini_Atari_CD-ROM_Walnut_Creek_December_1993.iso / files / bbs / turbobbs / bbs100.doc < prev    next >
Text File  |  1985-08-23  |  18KB  |  397 lines
  1.         Turbo BBS Version 1.00 - System Operator Notes - Page 1
  2.  
  3.  
  4.         1 - Features:
  5.  
  6.           - Self-contained Message and Files system written in Pascal;
  7.           - Program not operating system dependent;
  8.           - Information files editable with WordStar;
  9.           - Variable Terminal width with word-wrap;
  10.           - User profile (password, terminal parameters) kept on file;
  11.           - Real-time clock time stamping of files and messages;
  12.           - Private and public messages supported;
  13.           - Variable access levels available;
  14.           - File and message sub-sections for easier user access;
  15.           - All uploaded files stamped with name of contributor;
  16.           - Number of accesses of each file recorded;
  17.           - XMODEM protocol (CRC & checksum) fully supported;
  18.           - Calls logged with sign-on and sign-off times;
  19.           - Comments to System Operator (Sysop) file;
  20.           - Directly drives serial port hardware.
  21.  
  22.         2 - System files:  The following files are included in the  Turbo 
  23.         BBS package:
  24.  
  25.         * Required to compile the program: BBS.PAS
  26.                                            IO.INC
  27.                                            CLOCK.INC
  28.                                            MAILSYS.INC
  29.                                            FILESYS.INC
  30.  
  31.         All the above files must be on the logged drive when compiling!
  32.         The BBS program should be compiled to a .COM file.
  33.  
  34.         * Required on the default drive to run the compiled BBS program:
  35.  
  36.           BBS.COM (obviously);
  37.  
  38.           MESSAGES.BBS - the system message table:  contains records  for 
  39.         each message giving user numbers of sender and receiver, subject, 
  40.         time stamp,  message and section number, and whether the receiver 
  41.         has  read  the message or not.  This table is loaded into  a  RAM 
  42.         buffer  whenever the system is active (ie.  caller on-line),  and 
  43.         restored to disk at sign-off.
  44.  
  45.           FILES.BBS - the table of files available on-line. Each file has 
  46.         a record noting name,  size,  contributor, access count, section, 
  47.         and whether the file is private or public.
  48.  
  49.           LOG.BBS - Call Log, holding Caller, time on and time off info.
  50.  
  51.           COMMENTS.BBS - Contains comments to Sysop, includes caller name 
  52.         and time stamp.
  53.  
  54.           IDS.BBS  - Contains registered user  names,  passwords,  access 
  55.         levels,  terminal  parameters,  last call date and  high  message 
  56.         number.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.         Turbo BBS Version 1.00 - System Operator Notes - Page 2
  68.  
  69.  
  70.         The  following text files containing on-line user information are 
  71.         also expected on the default drive:
  72.  
  73.           WELCOME.TXT  - The pre-sign-on user welcome file.  Should  give 
  74.         details about the system's features, hours, and policies, as well 
  75.         as  any news about new system features.  Newest bulletins  should 
  76.         occur  first in a file so frequent users do not have to read long 
  77.         stretches of familiar information to get the new stuff. This file 
  78.         is also listed by the W (Welcome) command.
  79.  
  80.           BBSHELP.TXT  - The  on-line Help file,  containing  the  system 
  81.         commands and user hints. Also should list the subcommands for the 
  82.         commands that support them.  This file is listed by the H  (Help) 
  83.         command.
  84.  
  85.           BBSLIST.TXT - Contains a list of other remote access systems of 
  86.         interest. Listed by the O (Other systems) command.
  87.  
  88.           SYSINFO.TXT - Gives information about the equipment running the 
  89.         BBS,  and  general  information about the BBS.  Listed by  the  Y 
  90.         (sYstem information) command.
  91.  
  92.           MESS0001.TXT  - The message table contains a permanent  message 
  93.         number 1, which contains specific help for the message system.
  94.  
  95.  
  96.              All messages are stored in individual text files,  using the 
  97.         file  name MESSxxxx.TXT,  where xxxx is the message  number.  All 
  98.          .TXT files are expected on the default drive. They can be edited 
  99.         using WordStar,  in the Document mode.  The BBS program is set up 
  100.         to ignore the WordStar "soft" carriage returns and line feeds, so 
  101.         the  word  wrap output driver of the BBS can format the  file  to 
  102.         suit  the user's terminal.
  103.  
  104.              Messages stored by the BBS editor can be in two formats: one 
  105.         contains  "hard"  carriage returns so special formatting used  in 
  106.         message entry is preserved (P subcommand in E command). The other 
  107.         contains  NO carriage returns,  which are inserted by the  output 
  108.         routine as needed. Editing a message created by the latter option 
  109.         with WordStar will show the entire message as a single  line:  ^B 
  110.         will  fix  this by inserting soft carriage returns which the  BBS 
  111.         will ignore.
  112.  
  113.              The  top of the include file MAILSYS.INC defines a  constant 
  114.         called  "maxmess,"  which defines the maximum number of  messages 
  115.         that  can  be held at one time on the  system.  The  distribution 
  116.         version sets this at 52,  which corresponds to the maximum number 
  117.         of  files available on a Kaypro 2 disk (64) minus the  number  of 
  118.         support  files on the default drive.  This limit can be increased 
  119.         if a larger directory is available, but remember that the message 
  120.         table is buffered in RAM and so each message uses 43 bytes.
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.         Turbo BBS Version 1.00 - System Operator Notes - Page 3
  134.  
  135.  
  136.         3 - Installing the BBS on your system
  137.  
  138.              The  machine specific codes is contained in the include file 
  139.         IO.INC.  All system serial I/O is routed through these  routines. 
  140.         The  procedures  and  functions that will need  changing  (unless 
  141.         you're running a Kaypro 4-84 or modified 2-84) are flagged by the 
  142.         string  "(*  Machine Dependent *)" for easy  spotting.  There  is 
  143.         another  routine,  called "clearmodem" which is marked "(*  Modem 
  144.         Dependent *)".  The distribution version was written for a  Rixon 
  145.         212A Intelligent Modem.
  146.  
  147.              To properly install the BBS,  it is necessary to know how to 
  148.         properly  program  and  control  the  serial  port.   Since  most 
  149.         operating  system drivers to not allow access to reading the  CTS 
  150.         (Clear To Send) line, this is necessary... It is unreasonable for 
  151.         the BBS to be expected to capture and comprehend the "NO CARRIER" 
  152.         or equivalent string from a smart modem.  In particular, you must 
  153.         know how to read the CTS line,  control the RTS line,  detect the 
  154.         input buffer full signal, and the output buffer empty line. Also, 
  155.         remember  the  character  data send and  character  data  receive 
  156.         functions!  To allow XMODEM transfers,  it is necessary to set up 
  157.         for 8 bits, no parity, and one stop bit.
  158.  
  159.              Since  the system expects to use the CTS line as  a  carrier 
  160.         detect  line,  it will be necessary to ensure that the modem does 
  161.         send  a  suitably readable signal for  this  purpose.  The  Rixon 
  162.         initialization  string does this.  On Hayes Smartmodems,  this is 
  163.         controlled by a switch that must be set so the CTS line  reflects 
  164.         an  on-line  status.  The  DSR or DCD  lines,  if  available  and 
  165.         satisfactory,  can  be  used:  just  read that line  in  the  cts 
  166.         function  in  IO.INC.
  167.  
  168.              The  modem should also disconnect when the system lowers the 
  169.         DTR   (Data  Terminal  Ready  - RS-232  pin  20)  line  for   400 
  170.         milliseconds.  If this feature is not available, another reliable 
  171.         disconnect method must be found and implemented in the  procedure 
  172.         hangup  in IO.INC.  The DTR line is also lowered when the BBS has 
  173.         been   accessed  locally  to  inhibit  the  modem's   auto-answer 
  174.         function.  The  procedures setlocal and clearlocal (IO.INC)  will 
  175.         require editing if this feature is not supported by your modem.
  176.  
  177.              If  your system has a real-time clock,  the routines in  the 
  178.         include file CLOCK.INC must be adapted to use it. Once again, the 
  179.         distribution  file uses the Kaypro 4-84 clock.  The  Kaypro  2-84 
  180.         normally omits this, but the CPU board has the necessary hardware 
  181.         to  implement it with the addition of a few parts.  If the system 
  182.         lacks a real-time clock, the clock-related features can be turned 
  183.         off  by setting the constant "clockin" to FALSE at the  beginning 
  184.         of the BBS.PAS file.
  185.  
  186.              The  special  interest  sections  feature  of  the  BBS   is 
  187.         currently  limited to 9 sections,  numbered 1-9.  If sections are 
  188.         not  wanted,  set  the  "sectsin" constant at  the  beginning  of 
  189.         BBS.PAS to FALSE.  The Section names are defined at the beginning 
  190.         of  MAILSYS.INC.  Future  updates of the Turbo BBS will  offer  a 
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.         Turbo BBS Version 1.00 - System Operator Notes - Page 4
  200.  
  201.  
  202.         larger  number  of  available  sections,   with  either  password 
  203.         protection   or  individual  user  access  flags  for   protected 
  204.         sections. It is possible to not use sections in the BBS at first, 
  205.         then  implement  them later,  since all files and messages  in  a 
  206.         system  without  sections  are  placed  in  section  1  (Default: 
  207.         General).
  208.  
  209.              If  your  system  lacks sufficient memory  to  run  the  BBS 
  210.         program as distributed, it will be necessary to overlay the files 
  211.         system with the message entry editor. This is done by putting the 
  212.         word  "overlay"  immediately before the procedure declaration  of 
  213.         the  enter routine (near the end of MAILSYS.INC) and the  filesys 
  214.         routine (the file FILESYS.INC).
  215.  
  216.         That is, change          procedure enter;
  217.                      to          overlay procedure enter;
  218.  
  219.              and change          procedure filesys;
  220.                      to          overlay procedure filesys;
  221.  
  222.         For  this to work properly,  it is absolutely necessary to  avoid 
  223.         putting  any  new procedure/function declarations at the  end  of 
  224.         MAILSYS.INC,   the  beginning  of  FILESYS.INC,  or  between  {$I 
  225.         MAILSYS.INC} and {$I FILESYS.INC} in BBS.PAS!
  226.         (Note that using overlays will create 2 more files on the default 
  227.         drive: adjust the maximum number of messages as required.)
  228.  
  229.              The  number  of files in the file system is limited  by  the 
  230.         fact  that  the  directory  table is  buffered  in  RAM.  In  the 
  231.         distribution version,  a limit of 40 is set due to the fact  that 
  232.         the  Kaypro  2's disks have a mere 191K capacity (All  "freeware" 
  233.         contributions go to the Hard Disk fund). To expand the number, it 
  234.         is  necessary to change the filetab array declaration and  change 
  235.         the  number in the procedure newfile.  Future versions  will  set 
  236.         this  limit  with  a  compilation  constant.  Each  file  in  the 
  237.         directory  uses  39 bytes of memory.  Future versions will  allow 
  238.         large  directory  files  to be read directly from  disk  (at  the 
  239.         expense  of operation speed).  (Please remember that the BBS  was 
  240.         NOT originally written for distribution!) The BBS puts all  files 
  241.         on the "B:" drive. To change this, you must change the following:
  242.  
  243.              procedure addfile;
  244.              procedure newfile;  <-- "B:" occurs twice!
  245.              function legaltab.
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.         Turbo BBS Version 1.00 - System Operator Notes - Page 5
  266.  
  267.  
  268.         4 - Running the system
  269.  
  270.              Once  BBS.COM  has been compiled successfully,  it  must  be 
  271.         placed  on the default drives with the .TXT and .BBS files listed 
  272.         previously in this document.  The first thing the program  should 
  273.         do  when  run is initialize the modem.  If the modem  echoes  the 
  274.         initialization  string,  the display will show the echo mixed  in 
  275.         with the outgoing string. This is disconcerting, but harmless.
  276.  
  277.              The  file "IDS.BBS" contains two pre-declared  names,  which 
  278.         are SYSOP and BOB MAXWELL (I couldn't resist).  The usernames and 
  279.         passwords  are  always  mapped to capitals by the  BBS  to  avoid 
  280.         errors.  SYSOP's  password is set to TURBO.  To sign on  locally, 
  281.         press  the  'ESC' key on the host keyboard when the "Waiting  for 
  282.         call..."  string appears.  You can then sign on and test out  the 
  283.         system.  The  first  thing  to  do is  change  your  password  to 
  284.         something VERY secure by using the P command: the system supports 
  285.         certain  features for Sysops that are best not made available  to 
  286.         the general public.
  287.  
  288.              The BBS main program supports two commands not listed in the 
  289.         menus. They are "!" and "@". "!" is the printer switch: if a user 
  290.         with level 5 (Sysop) access uses this command,  system output  is 
  291.         also sent to the lst:  device,  until another "!" is entered. "@" 
  292.         is  the  comments file reader and ID access  editor.  First,  the 
  293.         system comments file is displayed.  Next,  a "Kill (Y/N)?" prompt 
  294.         appears,  allowing  the sysop to delete  the  file.  Lastly,  the 
  295.         system will ask for a user name:  if it is in the userlist,  that 
  296.         user's  current access level will be displayed,  and you will  be 
  297.         prompted  for  a new user level (pressing only RETURN  leaves  it 
  298.         unchanged).  The system will loop through the Name/Access prompts 
  299.         until a non-existent user name is entered,  whereupon the command 
  300.         ends.
  301.  
  302.              Several commands contain Sysop extensions:  the L (call Log) 
  303.         command  gives  a "Kill (Y/N)?" prompt to level 5  users.  The  U 
  304.         (User  list)  command shows the access level of  each  user.  The 
  305.         R  (message  Read) function prompts "Delete  (Y/N)?"  after  each 
  306.         message read. Furthermore, all messages are visible to the Sysop.
  307.  
  308.              The  file  system  also contains extensions for  the  Sysop. 
  309.         These are the I,  R and K commands.  I is used to Install a  file 
  310.         that  is on the files disk but not in the BBS directory,  so  the 
  311.         Sysop  can  "upload"  files by just copying them onto  the  Files 
  312.         disk. R releases a file: the public flag in the directory becomes 
  313.         "true".  All uploaded/installed files are initially private,  and 
  314.         do  not  appear on the BBS directory to anyone  without  level  5 
  315.         access.  Level  3 users have the ability to access private  files 
  316.         provided  they  know the file name.  Any files on the files  disk 
  317.         that are not in the BBS directory are totally  unaccessable,  but 
  318.         cannot  be  overwritten.  The K command deletes a file  from  the 
  319.         directory table, and erases the file.
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.         Turbo BBS Version 1.00 - System Operator Notes - Page 6
  332.  
  333.  
  334.         5 - General Information
  335.  
  336.              This  software and its associated documentation and  support 
  337.         files are released to the public domain by the author.  It is not 
  338.         to  be  distributed  commercially or re-sold for  profit  without 
  339.         prior  permission from the author.  If you feel the  software  is 
  340.         well-suited  to your purposes,  and would like to be informed  of 
  341.         any updates or new versions, please send $30 to:
  342.  
  343.                        Robert H. Maxwell,
  344.                        201-2275 West 7th Avenue,
  345.                        Vancouver, B.C.  CANADA
  346.                        V6K 1Y3
  347.  
  348.         This contribution entitles you to support,  error correction, and 
  349.         updates.  Customization  of the code for specific purposes is not 
  350.         included,  but can be made available at extra cost.  It would  be 
  351.         appreciated if the specifics of the system you plan to run (phone 
  352.         number,  hours,  baud  rates,  etc.) were also included,  so  any 
  353.         improvements  YOU  make can be observed and possibly included  in 
  354.         updates.  Also,  a  compilation of systems using this BBS will be 
  355.         maintained on the Vancouver Turbo BBS from this information.
  356.  
  357.              The  original Turbo BBS is on-line in Vancouver 24  hours  a 
  358.         day  at  300 or 1200 baud at (604) 738-7811.  If the BBS  is  not 
  359.         available,  another  computer  is usually on-line to  report  the 
  360.         reason for the unavailability and when the BBS will  return.
  361.  
  362.              For  fastest  response  to  questions  or  problems,  it  is 
  363.         recommended  you  use  the  Vancouver  BBS.  Slower  response  is 
  364.         available  through CompuServe's Borland SIG,  where the  author's 
  365.         PPN is 70206,174. The use of voice calls is not appreciated until 
  366.         the details have been arranged.
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394.  
  395.  
  396.  
  397. əəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəəə