home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / bbs / bbs10.arc / BBS.DOC next >
Text File  |  1988-07-10  |  9KB  |  181 lines
  1.  
  2.                                 BBS.DOC
  3.                                 7/9/1988
  4.  
  5.  
  6.            Welcome  to  BBS.BAS a small  but  efficient  GW-BASIC 
  7.      program  which will allow you to maintain a database of  the 
  8.      file directories of the bbs systems you normally check into.  
  9.      It will also allow you make off-line searches of all or  any 
  10.      one of the bbs system's files.
  11.  
  12.                           History of BBS.BAS
  13.           Several  months ago I became very frustrated trying  to 
  14.      find  a file which I was looking for among the 20 or so  bbs 
  15.      systems  in my local area.  I only had two options,  looking 
  16.      through the paper listings or going on-line and looking with 
  17.      the  -where is- function of the bbs.  Neither of these  were 
  18.      very  efficient so I tried to set up a data base file  using 
  19.      one of the shareware data base programs.  This did not  work 
  20.      very well either because of the many different formats  used 
  21.      by  my local bbs systems.  This left me only  one  option... 
  22.      write my own program.
  23.           I  decided to write the program in GW-BASIC because  it 
  24.      is  a language easily understood by most programmers.   This 
  25.      will  make it easy for anyone to modify the program to  suit
  26.      their  own needs.  You are free to make any changes  to  the 
  27.      program  because  I  am releasing  this  program  as  PUBLIC 
  28.      DOMAIN.
  29.  
  30.                             Using BBS.BAS
  31.           To use BBS.BAS place the program in a sub-directory  of 
  32.      it's  own.  The program will create several files  with  the 
  33.      extension .BBS which are the data base files for the various 
  34.      bbs  systems.  It will also create a file named  BBSLIST.BBS 
  35.      which is the master index of bbs system files.  These  files 
  36.      must reside in the same directory as the main program.
  37.           The  program  is distributed in ASCII  format  to  make 
  38.      listing  and modification easier but this makes the  program 
  39.      load  much  slower.   To  speed up  the  loading  process  I 
  40.      recommend  that you first rename the program to BBS.TXT  and 
  41.      then  run  GW-BASIC.  After the GW-BASIC  prompt  type  LOAD 
  42.      "BBS.TXT",  then when program is loaded type SAVE  "BBS"  to 
  43.      save  the program in tokenized format.  Then for normal  use 
  44.      of the program type GW-BASIC BBS to start the program.
  45.  
  46.                          Program Options Menu
  47.           After  starting the program the first screen  you  will 
  48.      see is the title and Options Menu.
  49.  
  50.      The options are:
  51.           (1)  Search for String.
  52.           (2)  Add new BBS file to the data base.
  53.           (3)  Update existing BBS data base.
  54.           (4)  Delete BBS data base from list.
  55.           (5)  Send list of files to printer.
  56.           (6)  Quit and exit to DOS.
  57.                         Description of options
  58.  
  59.      (1)  Search for String:  This option will search one or  all 
  60.      of the data bases for a user defined string.  First BBS will 
  61.      display  a  list of the available directory data  bases  and 
  62.      will ask which one to search.  Enter the number or  [RETURN] 
  63.      for  a  search of all.  Then BBS will request  a  string  to 
  64.      search  for. To see all records in a file enter "." .   Then 
  65.      BBS  will ask if the output should be sent to the screen  or 
  66.      to  the  printer.  If sent to the screen  the  listing  will 
  67.      pause  when the screen is full and when all records  of  the 
  68.      current  data  base  have been searched.   If  sent  to  the 
  69.      printer the matching records will be printed but the  output 
  70.      will  not  pause until all data bases  have  been  searched.  
  71.      Only  data  bases  which  have a  matching  record  will  be 
  72.      displayed or printed.
  73.  
  74.  
  75.      (2)  Add new BBS file to the data base:  This is the  option 
  76.      which allows you to add new bbs systems to the data base.
  77.           In  order for the program to process the  catalog  info 
  78.      from the bbs system you must first capture the bbs  system's 
  79.      listing  to an ASCII file.  See you  communications  program 
  80.      literature for details on how to capture text.  
  81.  
  82.      NOTE:  This program will only work on systems using the  one 
  83.      line per file format  E.g. -
  84.  
  85.      DUMMY.ARC     12337  06-03-88  This program looks  busy.
  86.  
  87.           Then  you need to strip the file of any text  which  is 
  88.      not  a file entry (See above.)  The file must  contain  only 
  89.      file info. I suggest that you use the name of the bbs system 
  90.      as the file name and the extension of ".CAT" but this is not 
  91.      mandatory.
  92.           When the file is ready, run BBS and select option  (2).  
  93.      The  program  will prompt you for the name of the  file  you 
  94.      just  prepared. Enter the filename and extension.  Next  BBS 
  95.      will  ask  you for the name of the bbs system  the  file  is 
  96.      from.  The default name is the filename used on the  catalog 
  97.      file.  Press  [RETURN] to accept that or enter a  valid  DOS  
  98.      filename (no extension).
  99.           Next, BBS will display a "ruler" across the top of  the
  100.      screen  and  will display the first five  entries  from  the 
  101.      file. The ruler looks like this. -
  102.  
  103.      12345678901234567890123456789012345678901234567890123456789
  104.      DUMMY.ARC     12337  06-03-88  This program looks  busy.
  105.      GAMES.ARC    231900  04-23-88  Collection of basic games.
  106.      MUSIC.ARC     56223  06-11-87  Plays several songs.
  107.  
  108.  
  109.           After displaying the "ruler", the program will ask  you 
  110.      to enter column, description.
  111.           What the program wants is a description of the  various 
  112.      fields of data in the ASCII file. E.g. - Filename,Bytes,Date 
  113.      and Description.  It also needs to know what column to start 
  114.      these descriptions at.
  115.  
  116.      NOTE: MAXIMUM number of fields allowed is four (4).
  117.  
  118.           To enter the description of a field, use the ruler line 
  119.      to determine the starting column.  Column 1 is the left most 
  120.      position and column 79 is the right most column.  Enter  the 
  121.      column number then "," and a description of that field which 
  122.      is not longer than the field itself. E.G.- 1,Filename.   You 
  123.      must enter the fields from lowest (Left) to highest (Right). 
  124.      After entering the last description, enter "79," to tell the 
  125.      program you are finished.  This info will be stored and will 
  126.      be displayed when you search through the file.
  127.           After the final entry BBS will read the ASCII file  and 
  128.      convert it to records. During the conversion, all lower case 
  129.      letters  will be changed to upper case. The reason for  this 
  130.      is  Basic's search function is case sensitive. I decided  to 
  131.      do  this  at  conversion time rather  than  at  search  time 
  132.      because  the conversion to upper case takes a long time  and 
  133.      really slows down the search.
  134.  
  135.      NOTE: The conversion process will take several minutes for a 
  136.            long file so be patient.
  137.  
  138.           After  conversion,  BBS  will ask you if  you  want  to 
  139.      delete the ASCII file.  Normally you should delete the  file 
  140.      as it is no longer needed and takes up disk space.
  141.  
  142.  
  143.      (3)  Update existing BBS data base:   This option will allow 
  144.      you  to add new files to one of the databases.  All  of  the 
  145.      file preparation rules of option 2 apply to an update  file. 
  146.      I normally use the extension ".UPD" for update files.
  147.           When  you select option 3, BBS will display a  list  of 
  148.      all of the data bases and will ask you to select the  number 
  149.      of the one you wish to have updated.  Then you will be asked 
  150.      to enter the filename and extension of your update file.  If 
  151.      the  file  exists, it will be converted in the same  way  as 
  152.      option 2. After conversion you will be asked if you wish  to 
  153.      delete the ASCII file.      (4)   Delete BBS data base from list:  This option  normally 
  154.      is  used when the bbs service does not have a  "what's  new" 
  155.      function  to  allow  you  to  update  the  data  base.   The 
  156.      procedure  in this case is to delete the old data  base  and 
  157.      then  proceed  to reinstall the updated  file  listing  with 
  158.      option 2.
  159.           This  option is also useful for deleting data bases  of 
  160.      bbs systems you no longer use or that have shut down.
  161.  
  162.      (5)  Send list of files to printer:  This option is included 
  163.      to provide a way for you to have a hard copy list of the bbs 
  164.      systems in the data base.
  165.  
  166.      (6)  Quit  and  exit to DOS:  This option  provides  for  an 
  167.      orderly shut down of the program and insures that no data is 
  168.      lost.   If you use ^C to exit the program there is a  chance 
  169.      that you will lose some of the data in you data base files.
  170.  
  171.  
  172.           I  provide no warranty, either express or implied,  for 
  173.      the use of this program.  The only stipulation which I would 
  174.      like you to follow is if you modify the program and then re-
  175.      release the archive is that you include a document describing
  176.      the changes you made so that others can follow your  changes 
  177.      too.
  178.  
  179.           Good luck and enjoy!
  180.  
  181.