home *** CD-ROM | disk | FTP | other *** search
/ Crawly Crypt Collection 1 / crawlyvol1.bin / bbs / filebbs / filebbs.doc next >
Text File  |  1990-12-30  |  9KB  |  224 lines
  1.                              FileBBS
  2.  
  3.                  Version 0.2, 30th December 1990
  4.  
  5. 1. What does it do?
  6.  
  7.    FileBBS  reads  in  FoReM or ///Turbo  board  *.DIR  files  and 
  8.    FILES.BBS  files  as  used  by other  types  of  BBS  (such  as 
  9.    QuickBBS),  combines them, removes missing files, sorts them by 
  10.    date and writes out new .DIR and FILES.BBS files.
  11.  
  12.    Some uses that this might have are:
  13.     - Keep  your file areas sorted by date so that new  users  see 
  14.       the new files first.
  15.     - Use  FidoNet FileEcho's using either Hatch and STick or  the 
  16.       FileEcho built into the ACS software.
  17.     - Use the same directories for QuickBBS and ///Turbo.
  18.     - Add  new  files  by  appending them  to  FILES.BBS  in  your 
  19.       favorite text editor, instead of the clumsy ///Turbo sysop's 
  20.       menu.
  21.     - Create human readable listings of the file areas.
  22.  
  23. 2. Usage
  24.  
  25.    FileBBS  was  designed to be run from batch  files.   Thus  all 
  26.    options are given on the command line.  Usage is:
  27.       FileBBS [-options] [dirnames...]
  28.  
  29.    Dirnames is a list of directories that you want processing, for 
  30.    example D:\BBS\GAMES.   You may put a trailing backslash at the 
  31.    end  if you want and you may put as many pathnames as you  like 
  32.    up to the maximum command line length imposed by the CLI.
  33.  
  34.    Options are:
  35.       -V : Verbose mode
  36.       -D : Debug mode
  37.    If  you  use  any of these two settings then  they  must  occur 
  38.    before other command line options.  The default quiet mode will 
  39.    be adequate for most people.
  40.  
  41.       -F : Process all the directories in FILEECHO.BBS.  This file 
  42.            is  used by the FileEcho processor built  into  Come_In 
  43.            (part  of the ACS software).   FileEcho.BBS must be  in 
  44.            the current directory.
  45.       -S : Process the directories specified in  STICK.CTL.   This 
  46.            file is used by Hatch and STick.   STick.CTL must be in 
  47.            the current directory.
  48.       -T : Process  all of FoReM or ///Turbo board's  directories.  
  49.            FOREM.OPT   or  TURBO.OPT  must  be  in   the   current 
  50.            directory.   CONFIG.DAT must also be aronud  somewhere, 
  51.            either  in  the current directory or the  optional  DAT 
  52.            directory.    FileBBS   will  also  have  a  look   for 
  53.            PROMPT.TXT to obtain the SysOp's name.
  54.       -Q : Process  all  the directories specified  in  QuickBBS's 
  55.            FLSEARCH.CTL file.
  56.  
  57.    Normally you would use only one of these options.   For example 
  58.    when importing mail you might run it as:
  59.       FileBBS -S
  60.    Or perhaps in your daily maintenance you will run it as:
  61.       FileBBS -T
  62.    Or perhaps you have manually created a new FILES.BBS,  then you 
  63.    would run it as:
  64.       FileBBS D:\BBS\FILEAREA
  65.  
  66.  
  67. 3. How it works in more detail
  68.  
  69.    For  each  directory that FileBBS is asked to process  it  will 
  70.    firstly check that it hasn't already processed it this run  and 
  71.    then read in the .DIR file if there is one.
  72.  
  73.    FILES.BBS  is then read if it is present.   Any filenames  that 
  74.    were  not already included in the .DIR file will be  added  in, 
  75.    with  the  description  being taken from  FILES.BBS  and  other 
  76.    fields such as uploader, date, etc, being made up as best as it 
  77.    can be guessed.  The Area Tags specified with STick or FileEcho 
  78.    will  be used for the Application type.   The uploader will  be 
  79.    STick,  FileEcho,  SysOp or the SysOp's name.     All files are 
  80.    added in at level 32767 to prevent files arriving via  FileEcho 
  81.    and  being added wihout you having a chance to check them  out, 
  82.    so  you will have to either use ///Turbo's sysop shell or  Bill 
  83.    Day's  File editor to lower the access  levels.   The  uploaded 
  84.    date  will  be today's date rather than the  file's  datestamp.  
  85.    The filesize will be the true size of the actual file.
  86.  
  87.    The files are sorted by date as they are read in.
  88.  
  89.    The .DIR file is rewritten.   It is written to a temporary file 
  90.    first (with a .TMP extension) and only if this is succesful  is 
  91.    the old one removed and the temporary file renamed.
  92.  
  93.    FILES.BBS  is  then  written  out.   It  will  have  a  heading 
  94.    containing a description of the file area,  worked out the best 
  95.    way it can followed by all the files newest ones first.
  96.  
  97. 4. File formats
  98.  
  99.    FILES.BBS:
  100.       This is an Ascii file.  Each line has the format:
  101.          FILENAME description
  102.       Any  line  not  beginning with a  character  normally  in  a 
  103.       filename (e.g.  +) is treated as a comment.  The description 
  104.       may be quite long,  but should be included all on one  line.  
  105.       Not all editors will let you do this.
  106.  
  107.       e.g.
  108.       +-------------------------------------------+
  109.       | Atari Demo's area                         |
  110.       +-------------------------------------------+
  111.       MEGADEMO.LZH  Yet another scrolly text and rasters demo
  112.       GIGADEMO.LZH  Over one billion colours on screen at once
  113.       RASTERS.LZH   Incredible demo by the Raster crew
  114.  
  115.    STICK.CTL:
  116.       Control file used by Hatch and Stick.   FileBBS looks at any 
  117.       line  beginning with the word "AREA" with the format:
  118.          Area path tag
  119.       e.g.
  120.        AREA E:\BBS\DEMOS\ ST_DEMO
  121.        1:234/56 FRED H * 
  122.        Local desc ST Demo's
  123.  
  124.    FILEECHO.BBS
  125.       This  is  very similar to STick.CTL,  in fact  FileBBS  uses 
  126.       exactly the same function to process it.
  127.  
  128.       e.g.
  129.        Area e:\bbs\demos\            ST_DEMO
  130.        1:234/567.8 HIO 
  131.  
  132.    FLSEARCH.CTL
  133.       This is used by QuickBBS to specify file areas.   Each  line 
  134.       has the format:
  135.          path security description
  136.  
  137.       e.g.
  138.        e:\bbs\demos  10  Atari ST Demos
  139.        e:\bbs\games  10  Atari ST FreeWare Games
  140.  
  141. 5. Other programs useful with this program
  142.  
  143.    Hatch and STick is programmed by Joop Koopman of 2:281/202,  it 
  144.    will  process  *.TIC  files used by  FidoNet  File  Echos.   It 
  145.    is  compatible with BinkleyTerm or The Box and QuickBBS  format 
  146.    message areas.
  147.  
  148.    The  ACS  (Area Cleaner Software) is a shareware  set  of  mail 
  149.    processing  software  by  Roland  Bohn  of  2:507/203,    using 
  150.    BinkleyTerm  and QuickBBS format message  areas.   Come_In  the 
  151.    mail tosser has FileFix and FileEcho built into it.
  152.  
  153.    QuickBBS is a shareware Bulletin board system programmed by Jon 
  154.    Webb (DeltaVision system) of 282/301.2.
  155.  
  156. 6. What it doesn't do, but could be worth doing sometime
  157.  
  158.    Check  for  new  files  and  automatically  add  them  (without 
  159.    descriptions).
  160.  
  161.    Check for file existence and file size for all files.  This was 
  162.    actually implemented at one stage,  but was far too slow  doing 
  163.    it on a file by file basis as the .DIR file was loaded.   If it 
  164.    is  to  be done quickly it will have to be done as  a  seperate 
  165.    phase.  Perhaps in a cleanup phase before rewriting.
  166.  
  167.    Check for file dates and automatically update for new  versions 
  168.    of programs
  169.  
  170.    Work  out whether to take descriptions from FILES.BBS or  *.DIR 
  171.    files instead of assuming that .DIR descriptions.
  172.  
  173.    Word wrap descriptions when putting into .DIR directory.
  174.  
  175.    Encode  other information such as uploader into  the  FILES.BBS 
  176.    description.
  177.  
  178.    Provide  an  interactive  mode,  where it  would  stop  at  any 
  179.    ambiguities (e.g.  FILES.BBS and .DIR descriptions differ)  and 
  180.    ask the user what to do.
  181.  
  182.    Make the download level for new files configurable.
  183.  
  184. 7. Credits
  185.  
  186.    FileBBS was created by Steven W Green.
  187.  
  188.    Copyright (C) 1990, Steven W Green, All rights reserved.
  189.  
  190.    FileBBS  may  be  freely  copied  and  distributed  under   the 
  191.    following conditions:
  192.       1. No charge is made for except for small handling costs  or 
  193.          normal on-line costs.
  194.       2. All files are included including the documentation, in an 
  195.          unmodified   form.    They   may  be   repackaged   using 
  196.          alternative archive formats providing that this does  not 
  197.          alter the resultant files in any way.
  198.       3. It  is not included with any commercial software  package 
  199.          without the permission of Steven W Green.
  200.  
  201.    This  software  is used entirely at the  users  own  risk.   No 
  202.    liability for any damage will be held by the author.
  203.  
  204.    Bug  reports and suggestions are welcomed.   Please include  as 
  205.    much  neccessary information as possible with any bug  reports.  
  206.    Try to narrow it down if possible.
  207.  
  208.    Steven Green,
  209.    My Little Phoney BBS, +44-865-773277, V32/HST
  210.    FidoNet 2:252/25
  211.    FNET 1004
  212.    NeST 90:1004/0
  213.    Voice: +44-865-748631
  214.    Post: 78a Church Way, Iffley, Oxford, OX4 4EF, ENGLAND.
  215.  
  216. 8. Update History
  217.  
  218.    0.1: 8th December
  219.       Initial release
  220.    0.2: 30th December
  221.       Added  wordwrap  when putting a long  files.bbs  description 
  222.       into the .DIR file.
  223.  
  224.