home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / t2bbs501.zip / TIC2BBS.DOC < prev    next >
Text File  |  1994-09-13  |  10KB  |  233 lines
  1.                                         
  2.                                         
  3.                     Tic2BBS - Version 5.01 by Mark R. Evans
  4.                                         
  5.                       A BBS File System to .TIC Interface
  6.  
  7.                               For OS/2 and DOS
  8.                                         
  9.                                    Supports: 
  10.                              Remote Access v2.00.g1
  11.                                Maximus-CBCS v2.01
  12.                                 ACFiles v5.60.x
  13.  
  14.                                September 13, 1994
  15.  
  16.                       Copyright (c) 1993, 1994 Mark R. Evans
  17.                               All Rights Reserved
  18.  
  19.  
  20.  
  21.  1.0  Description
  22.  
  23.      Tic2BBS  provides a link between your BBS File System and your .tic
  24.      file processor.  It will  search  your  BBS configuration files and
  25.      your .tic processor config files  to  determine  which  .tic  areas
  26.      match up with your BBS File areas.
  27.      
  28.      Once installed,  Tic2BBS requires no maintenance!  You can add file
  29.      areas  to  both  your  BBS  and your .tic system,  and Tic2BBS will
  30.      always match the correct .tic area with the proper BBS file area.
  31.      
  32.      Tic2BBS is compatible with several BBS systems,  including Maximus,
  33.      Remote Access v2.0x, and ACFiles v5.60.  Tic2BBS is also compatible
  34.      with TICK and ALLFix tic processors.
  35.      
  36.      Tic2BBS is a simply, yet very useful program. I currently have over
  37.      150 .TIC echos, and over 200 BBS file areas.  Tic2BBS saves me both
  38.      time  and  hard  disk wear and tear by insuring only the areas that
  39.      recieve files via .tic are updated by the BBS file database program.
  40.      
  41.  1.1  License
  42.  
  43.      Permission granted  to  use  this  program,   and  distribute it to
  44.      others.  The original documentation and program must be distributed
  45.      in unmodified form. For information, contact the author at:
  46.      
  47.      FidoNet 1:382/90.0  or  Internet: mevans@ima.infomail.com
  48.  
  49.  
  50.  1.2  Warranty and Statement of Liability
  51.  
  52.      Tic2BBS does not carry any warranty of any kind,  including that of
  53.      fitness for any particular purpose.  You use Tic2BBS  at  your  own
  54.      risk.   If  it  causes  damage to your hard disk,  your life,  your
  55.      marriage, etc., you take full responsibility.  You acknowledge this
  56.      in full by using Tic2BBS.  Tic2BBS is not licensed for legal use in
  57.      any jurisdiction where local or  regional law renders this Warranty
  58.      and Statement of Liability invalid.
  59.  
  60.  1.3  Cost
  61.  
  62.      Tic2BBS is free.  Use it for free, distribute it for free.  You may
  63.      not charge any fee for distribution of Tic2BBS.
  64.      
  65.      Tic2BBS will always be  available  at  no  cost.   I  am  going  to
  66.      implement  a  registration  system,   simply  so I can see how many
  67.      people are using Tic2BBS,  so I will know if further development is
  68.      warranted.
  69.      
  70.      If you like Tic2BBS,  please  sent  me a netmail message telling me
  71.      what you like/dislike.
  72.  
  73.  2.0  Using Tic2BBS
  74.  
  75.      You must run Tic2BBS _BEFORE_ you run your .TIC processor.  Tic2BBS
  76.      will read the .tic files in your inbound directory and  create  the
  77.      batch/data  file  that  you  will call after your .TIC processor to
  78.      update your file systems  databases.   No command line switches are
  79.      required for Tic2BBS to run, but Tic2BBS does support the following
  80.      command line option:
  81.  
  82.      Usage: TIC2BBS  -c[config_file] -d
  83.  
  84.           -c FileName of Tic2BBS config file. Default is TIC2BBS.CFG. 
  85.           -d Show a dump of .tic areas and corresponding BBS areas.
  86.  
  87.      Tic2BBS does require a configuration file, where it determines what
  88.      type of BBS you have, what tic processor you are using, etc.  Below
  89.      are the valid config verbs:
  90.      
  91.  2.1  Configuration
  92.  
  93.      Tic2BBS does require a configuration file, where it determines what
  94.      type of BBS you  have,   what  tic  processor  you are using,  etc.
  95.      Tic2BBS will do a pretty good  job  of  finding  the  configuration
  96.      file,   it  will  first look in the current directory,  then in the
  97.      directory where TIC2BBS.EXE is located.  
  98.      
  99.      The configuration file contains statements that affect the behavior
  100.      of Tic2BBS.  Comments may  appear  anywhere  in the file,  anything
  101.      after a % or ; is considered to be a comment.
  102.      
  103.      The valid configuration options are:
  104.  
  105.      BBSTYPE     [ BBS Type ]
  106.      
  107.         Defines what type of BBS you are running.  Valid modifiers are:
  108.      
  109.              MAXIMUS                 ; Maximus v2.x
  110.              RA2                     ; RemoteAccess v2.x
  111.              ACFILES                 ; ACFiles v5.6
  112.  
  113.      FILEDATA    [ filename ]
  114.      
  115.          This is the full filename (including path) to your  BBS's  file
  116.          area configuration.  Valid filename are:
  117.                      
  118.              d:\bbs\acfiles\acfpath.ctl  ; ACFiles v5.6x
  119.              d:\bbs\max\area.dat         ; Maximus v2.x
  120.              d:\bbs\ra2\files.ra         ; RemoteAccess v2.x
  121.  
  122.      TICTYPE     [ TIC_PROCESSOR ]
  123.      
  124.          This defines which .tic processor you are using.  Valid options
  125.          are:
  126.      
  127.              AllFix              ; AllFix v4.16 or above
  128.              TICK                ; TICK v2.10 or above
  129.  
  130.      TICCFG      [ filename ]
  131.      
  132.          Full path/filename to your .tic processor configuration file.
  133.  
  134.              d:\bbs\tic\tic.cfg          ; For TICK.EXE
  135.              d:\bbs\allfix\fareas.fix    ; Allfix v4.16    
  136.                          
  137.      COMMAND             Command used to update your Files Database
  138.                  
  139.          FB.EXE          ; maximus
  140.          ACF_UTIL.EXE    ; ACFiles
  141.                          
  142.          DO NOT use a command for RemoteAccess v2.x See special note below.
  143.  
  144.      FILETOCREATE        Full path/filename of the batch file or data file
  145.                          to create.
  146.                          
  147.          If you specify a command, Tic2BBS will place the command in this
  148.          file, then append the area numbers that have received new files via
  149.          .tic. For example; If you are running Maximus-CBCS the you would
  150.          specify the following:
  151.                          
  152.          command         FB.EXE
  153.          filetocreate    UpdateF.Bat
  154.                          
  155.          Tic2BBS would create a batch file called UpdateF.bat and it would
  156.          contain the following:
  157.                          
  158.              FB.EXE 5 6 8 19
  159.                          
  160.  
  161.      INBOUND             Path where your .tic's are received
  162.      
  163.      LOGFILE             If specified, Tic2BBS will log all of it's 
  164.                          activity to this file. 
  165.                          
  166.  
  167.      SPECIAL NOTE FOR REMOTE ACCESS v2.x USERS
  168.      =============================================
  169.      
  170.      You do not need to specify a 'command' in the Tic2BBS.Cfg file. Just
  171.      let Tic2BBS create a data file that contains the area numbers that
  172.      received files via .tic. Then call the following command after your
  173.      process your .tic files:
  174.      
  175.          RAFILE IMPORT @NewFile.Dat /UReceived_via_Tic
  176.          
  177.      For this to work, you would need to specify
  178.      
  179.          filetocreate  NEWFILE.DAT 
  180.          
  181.      in your Tic2BBS.Cfg file.
  182.      
  183.      SUPPORT
  184.      -------
  185.      You may contact Mark Evans, the author of Tic2BBS, at FidoNet 1:382/90.
  186.      The author of TICK, AllFix and Maximus WILL NOT provide any support
  187.      for Tic2BBS.
  188.  
  189.      REVISION HISTORY
  190.      ----------------
  191.      v5.01 - Tic2BBS did not error out when it was unable to create
  192.              the command file.  Now it does better error checking 
  193.              and reports errors to the log file.
  194.  
  195.      v5.00 - Tic2BBS is now a 'bound' application, running in both
  196.              OS/2 and DOS operating systems.  
  197.              
  198.              Increased maximum number of tic areas to 1000.
  199.  
  200.      v4.00 - Added support for AllFix v4.16.  Now Tic2BBS can read
  201.              the FAREAS.FIX cfg file from AllFix to determine which
  202.              BBS areas have received new files.
  203.              
  204.              Also added support for ACFiles v5.60. Now Tic2BBS can read the
  205.              ACFPATH.CTL config file from ACFiles to determine which areas
  206.              have received new files via TICK. TIC2BBS is no longer just a
  207.              Maximus BBS utility, but can be used with any BBS system that
  208.              used ACFiles as it's file door.
  209.              
  210.              Also added support for RemoteAccess v2.00.g1. Now Tic2BBS can
  211.              read FILES.RA to determine which areas have received new files
  212.              via TICK.
  213.  
  214.      v3.01 - Fixed a small bug when no .tic files were found, Tic2BBS
  215.              would still write a batch file with NULL contents.  It
  216.              now writes an empty batch file with a comment showing 
  217.              that there was nothing to process.
  218.  
  219.              Added/improved some of the log messages.
  220.  
  221.              Added better errorlevels:
  222.  
  223.                 0       -       NO Error - No Files Processed
  224.                 1       -       Files Were Processed
  225.                 2       -       Maximum number of areas reached
  226.                 3       -       Unable to open AREA.DAT
  227.                 4       -       Unable to open TIC.CFG or FAREAS.FIX
  228.                 5       -       Command Line Error
  229.                 6       -       Out of memory        
  230.  
  231.      v3.00 - First public release - Maximus ONLY Support.
  232.      
  233.