BBS.DOC

17.4 KB 6c67aca1f97bef29…

  { BBS.DOC }
  Last Revised:  04/25/94

  This file contains information on running TranScan v5 with many
  specific BBSs.  This file is constantly changing as we add support
  for more BBSs.  The latest version of this file can be downloaded
  from SHAREWARE SERVICES BBS at 913-266-0781.  The filename is
  TS5BBS.ZIP.

  USING TRANSCAN WITH A BBS

    TranScan was originaly designed to work with the Wildcat v3+ BBS.
    From the beginning SysOps running other BBS software have requested
    that TranScan be written to work with their BBS software too.
    TranScan v4 began the task and TranScan v5 comes even closer to
    reaching that goal.

  CONFIGURATION

    Configuring TranScan to work with a BBS is extreemely easy.  Most
    of the options you need have been pre-set for you based on the 
    most popular configurations.  Based on your selection for "BBS"
    many of the appropriate options will be pre-selected.  

    On-line context sensitive help is available at every prompt.  I
    recommend you use the on-line help wherever possible.

  POST-UPLOAD (ON-LINE) & EVENT (OFF-LINE)

    With TranScan there are basically two different times when you can
    process files in a BBS environment.

    POST-UPLOAD (ON-LINE)
    ---------------------
    Post-Upload file processing is becomming more and more popular with
    many of the BBS software packages these days.  The BBS provides a
    DOS batch file or hook that is run immediately following the upload.
    The BBS usually passes the filename to the batch file as a batch
    environment variable or file list.  Many BBSs also pass node and
    port information to the batch file either thru a door drop file or 
    an environment variable.

    The BBS detects success or failure in one of several different ways.
    Some boards look for a particular file to determine success or
    failure.  Others look for an errorlevel.  Yet others expect the file
    to be moved or deleted if it fails.

    EVENT (OFF-LINE)
    ----------------
    Some BBS programs can delay part of the file processing to be done
    off-line.  For example re-compressing, converting, or processing
    GIF/JPG files.  If your BBS allows off-line processing you can
    use those "BBS Options" that refer to "Off-Line" processing. After
    TranScan completes the initial processing in the POST-UPLOAD
    process it will write the full filename and path to your TS5.LST
    file.  You should create an event to allow TranScan to complete
    processing (re-compressing, converting, processing GIF/JPGs).  The
    command line for this event is as follows:

      TS5 -L

    Some BBSs offer a batch file that is called between calls.  Many
    SysOps like to run "TS5 -L" in this batch file so that the files
    are uploaded off-line but immediately after the caller logs off.
    Other BBSs offer daily timed events.  TranScan can process the
    list in a timed event as well.  If TranScan does not detect the
    TS5.LST file it will simply exit.

  COMM OUTPUT

    TranScan can provide COMM output during the POST-UPLOAD process
    so that your on-line caller can watch TranScan test their upload.
    In some cases TranScan determines the port information directly 
    from the BBS through the use of a DOOR.SYS, PCBOARD.SYS, or
    similar file.  In other cases TranScan determines the port info
    from an environment variable or batch file variables (%1, %2, etc).

    The TranScan command line to display COMM output is as follows:

    /P<com>[,base][,irq][,RtsCts]
      com    = COMM port number
      base   = base address in hex (Must be preceeded with $)
      irq    = irq interupt
      RtsCts = Hardware Flow Control (T or F)

    For the DIGI board the command line is as follows:

    /P<com>,DIGI

    For the FOSSIL driver the command line is as follows:

    /P<com>,FOSSIL

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  GAP
  ~~~
  Last Revised: 03/27/94

     Features:
     ---------
       * ANSI Display to user
       * Imports File Descriptions
       * Convert Files On-Line

     UPCHECK.BAT
     -----------
     Create a new UPCHECK.BAT file as follows:

          TS5 %1 /P1

     Note: Use the proper paramaters for the /P switch based on the
     port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  GTPOWER
  ~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
       * ANSI Display to user

     GT_VSCAN.BAT
     ------------
     The following is an example GT_VSCAN.BAT file:

          IF TS5 /LC:\GTLOG\GT_RECV.LOG /P%2 /CNONE
          REM >C:\GTLOG\GT_RECV.LOG

     Note:  You may need to change the path of the /L switch to match
     your configuration.

     OFF-LINE PROCESSING
     -------------------

     Since many of TranScan's processing can be completed OFF-LINE you
     should add the following line to your GT_LOGOFF.BAT or one of your
     daily event files:

         TS5 -L

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  MAJOR
  ~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * Off-Line processing

     OFF-LINE PROCESSING
     -------------------
     You should run TranScan from a daily event as follows:

          TS5 C:\FILES\UPLOADS\*.* /D /CNONE

     Note:  Change the filepath to whatever path your uploads are located
     in.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  OBLIVION /2
  ~~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     MAINTAIN.BAT
     ------------
     The following is an example MAINTAIN.BAT

          TS5 %1 /P1

     Note: Use the proper paramaters for the /P switch based on the
     port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  PCBOARD v14.5 & 15+
  ~~~~~~~~~~~~~~~~~~~
  Last Revised: 04/25/94

     Features:
     ---------
       * ANSI & RIP Display to user
       * Imports File Descriptions
       * Writes Message to User

     PCBTEST.BAT
     -----------
     Create a PCBTEST.BAT file in the PCBoard home directory (where
     PCBOARD.DAT lives) as follows:

          TS5 %1 /%2,%3 /CNONE

     PCBOARD 14.5
     ------------
     It is extreemely important that you set the following before
     loading PCBoard:

          SET PCB=/SWAP

     PCBOARD 15+
     -----------
     It is exteemely important that you set the following switches
     in the PCBOARD Setup:

        B  File Transfers         : Verify Files Uploaded : Y

        D  Configuration Swithces : Swap Out During Shell : Y

     TS5.PPS & TS5.PPE
     -----------------
     You may modify the included PPS file as you wish.  The enclosed
     PPE file will send messages to the user after upload.  You must
     keep the PPE in the same directory as TS5.EXE.  You also need to
     put the files included in the MSG.ZIP file in this same directory.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  POWERBBS
  ~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     BATCH FILE
     ----------
     In the PowerBBS Configuration under "Test Files Setup" set the
     following:
       Test New Files: Y
       Specify the filename including path to the following batch file:

       TS5 %1 /P%4 /CNONE
       IF ERRORLEVEL 1 GOTO BAD
       IF ERRORLEVEL 0 GOTO END
       :BAD
       Copy %2 %3
       :END


     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  PRODOOR v3.4
  ~~~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     BATCH FILE
     ----------
          @ECHO OFF
          IF NOT EXIST %2\*.* GOTO END
          TS5 %2\*.* /P%3 /CNONE
          IF NOT EXIST %2 DEL %DSZLOG%
          :END

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  RBBS
  ~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * Off-Line Processing

     BATCH FILE
     ----------
     At this time RBBS does not leave enough memory available to run
     TranScan while a caller is on-line.  You should run TranScan from
     a daily event as follows:

          TS5 C:\FILES\UPLOADS\*.* /D /CNONE

     Note:  Change the filepath to whatever path your uploads are located
     in.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  RENEGADE
  ~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     BATCH FILE
     ----------
     The following is an example for your post upload batch file:

          TS5 %1 /P1 /CNONE

     Note: Use the proper paramaters for the /P switch based on the
     port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  REMOTE ACCESS v1+
  ~~~~~~~~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * Off-Line Processing

     BATCH FILE
     ----------
     Remote Access v1+ does not leave enough memory available to run
     TranScan while a caller is on-line.  You should run TranScan from
     a daily event as follows:

          TS5 C:\FILES\UPLOADS\*.* /D /CNONE

     Note:  Change the filepath to whatever path your uploads are located
     in.
     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  REMOTE ACCESS v2+
  ~~~~~~~~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     UPLOAD SCAN
     -----------
     The following command line should be added for your UPLOAD SCAN:

          <Drive:><Path>TS5.EXE @ /P1 /CNONE *M

     Note: The Drive, Path, and Extension must be included in order
     for TranScan to work.  Use the proper paramaters for the /P
     switch based on the port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  SEARCHLIGHT
  ~~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI & RIP Display to user

     UPLOAD AUTODOOR
     ---------------
     Set the Searchlight Autodoor to run TranScan as follows:

     1. Command................TS5 C:\BBS\UPLOADS.BBS\*.* /P1
     2. Directory path.........C:\BBS\UPLOADS.BBS\
     3. Communications support.NONE
     4. Abort method...........NONE
     5. Write protection.......NO
     6. Parameter file.........DOOR.SYS
     7. Pause after door.......NO

     Note: Use the proper paramaters for the /P switch based on the
     port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  SPITFIRE
  ~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     SFEXTUPA.BAT
     ------------
     Spitfire does not have a Post-Upload hook that allows testing
     files immediately after upload.  However, this processing can
     be done from the External Upload batch files.  The following
     is an example ZMODEM upload batch file for using TranScan
     during an External Upload:

          BRK OFF
          ECHO OFF
          CD\SF\EXTERNAL
          DSZ.COM %2 restrict rz
          TS5 /P%2 %3 %4 %5 %6 %7 %8 %9 /CNONE
          CD\SF
          BRK ON

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  SUPERBBS
  ~~~~~~~~
  Last Revised 03/27/94

     Features:
     ---------
        * ANSI Display to user

     SUPERBBS CONFIG
     ---------------
     You will need to change the following in your SuperBBS Configuration:
     VIRUS SCANNER COMMAND LINE : TS5.EXE %1 /P1 /CNONE
     VIRUS CHECK                : Yes
     UNPACK BEFORE SCANNING     : No
     VIRUS FOUND ERRORLEVEL     : 1

     Note: Use the proper paramaters for the /P switch based on the
     port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  SYNCHRONET
  ~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     SCANFILE.BAT
     ------------
     Create a SCANFILE.BAT file in your \EXEC directory as follows:

          TS5 %1 /P%2

     CONFIGURE SYNCHRONET
     --------------------
     Run SCFG.BAT and go to Configure, File Transfers, Testable files.
     Freate an entry for every file extension you will support (ZIP,
     LZH, ARJ, etc.)

     File Extension:      ZIP

     Command Line         %!SCANFILE.BAT %f %p

     Working String       Testing Upload with TranScan...

     SBBS.BAT
     --------
     Synchronet BBS does not SWAP out of memory during testing it SHELLS.
     You will need to download SHROOM (latest filename at time of
     writing was SHROM20A.ZIP).  Put SHROOM.COM in a directory in your
     path.  Ten Modify your SBBS.BAT file as follows:

     Old SBBS.BAT:

          ..\exec\sbbs %1 %2 %3 %4 %5

     New SBBS.BAT:

          SHROOM.COM ..\exec\sbbs %1 %2 %3 %4 %5

     SHROOM.COM is a TSR that waits for a SHELL to DOS and then SWAPS
     itself and the program loaded after it out of memory.  This gives
     TranScan more memory to operate under.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  TAG v2.5g
  ~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     POSTUL.BAT
     ----------
     Change your POSTUL.BAT file as follows:

          TS5 %4%5 /P%2 /CNONE

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  TRIBBS
  ~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
        * ANSI Display to user

     UPLOAD.BAT
     ----------
     The following is an example UPLOAD.BAT file for TriBBS:

          TS5 %1 /P1

     Note: Use the proper paramaters for the /P switch based on the
     port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  VBBS
  ~~~~
  Last Revised: 03/27/94

     Features:
     ---------
       * ANSI Display to user

     NEWUPLD.BAT
     -----------
     The following is an example NEWUPLD.BAT file:

          TS5 %1 /P1 /CNONE

     Note: Use the proper paramaters for the /P switch based on the
     port information you are using.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  WILDCAT-TD (v2.60)
  ~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------
       * Off-Line Processing

     EVENT BATCH FILE
     ----------------
     Wildcat-TD does not provide a Post-Upload process.  You should
     therefore run TranScan from a daily event as follows:

          TS5 C:\FILES\UPLOADS\*.* /D /CNONE

     Note:  Change the filepath to whatever path your uploads are located
     in.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  WILDCAT! v3+ (& WILDCAT! IM)
  ~~~~~~~~~~~~
  Last Revised: 03/27/94

     Features:
     ---------

       * ANSI & RIP Display to user
       * Updates File Database
       * Imports File Descriptions
       * Converts Files On-Line
       * Writes Messages to Users
       * Updates Activity Log
       * Adds Orphan Files

     SCANFILE.BAT
     ------------

     Create a SCANFILE.BAT file in the Wildcat home directory (where
     MAKEWILD.DAT lives) as follows:

         TS5 %1

     SCANFILE.RUN
     ------------

     Check each of your node directories (..\NODE1, ..\NODE2, etc.) for
     a SCANFILE.RUN file.  If one exists then delete it.  SCANFILE.RUN
     files are only necessary for those nodes using the AUTONODE feature
     of Wildcat.  In those cases and in those cases only the SCANFILE.RUN
     file should be as follows:

         CD\WC30\WCWORK\NODE1      REM (or NODE2, etc)
         TS5 %1

     MESSAGES TO USERS
     -----------------

     To activate TranScan's message feature you must copy the supplied
     *.IMP files to your message directory (usually C:\WC30\MSG). Be
     sure to edit these files to suit your taste.

     TranScan is designed to only send one Thank You message even on
     multiple uploads.  It will send a message if it encounters a
     problem and display the filename that caused the problem in the
     subject of those messages.

     OFF-LINE PROCESSING
     -------------------

     Since many of TranScan's processing can be completed OFF-LINE you
     should add the following line to your POSTCALL.BAT or one of your
     daily event files:

         TS5 -L

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}

  WWIV
  ~~~~
  Last Revised: 03/27/94

  Features:
  ---------
        * Off-Line Processing

     BATCH FILE
     ----------
     At this time WWIV does not leave enough memory available to run
     TranScan while a caller is on-line.  You should run TranScan from
     a daily event as follows:

          TS5 C:\FILES\UPLOADS\*.* /D /CNONE

     Note:  Change the filepath to whatever path your uploads are located
     in.

     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}
                              { END OF FILE }
     {-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-}