BBS
Quick Set-Up
For TranScan v5+
Copyright 1994 by Craig E. Dunstan
ALL RIGHTS RESERVED! BBS Quick Set-Up
For TranScan v5+
Last Updated: 02/27/96
This document contains information on running TranScan v5 with many specific
BBSs. This document is constantly changing as we add support for more BBSs.
The latest version can be downloaded from SHAREWARE SERVICES BBS at
913-232-5586. 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.
Context sensitive help is available at every prompt. I recommend you use the
manual or 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 through 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, etc). The command line for this
event is as follows:
<drive:><path>TS5.EXE /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
processed 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 DOOR DROP file. In other
cases TranScan determines the port info from an environment variable or batch
file variable (%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: 05/16/94
Features:
* ANSI and RIP Display to user
* Imports File Descriptions
* Convert Files On-Line
UPCHECK.BAT
Create a new UPCHECK.BAT file as follows:
<drive:><path>TS5.EXE %1 /P<com>
Note: Use the proper parameters for the /P<com> 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:
<drive:><path>TS5.EXE /LC:\GTLOG /P%2 /CNONE
ECHO >C:\GTLOG\GT_RECV.LOG
Note: You need to change the path of the /L switch to match your configuration.
MAJOR
Last Revised: 03/27/94
Features:
* Off-Line processing only
OFF-LINE PROCESSING
You should run TranScan from a daily event as follows:
<drive:><path>TS5.EXE <uploadpath>\*.* /D /CNONE
Note: The uploadpath is whatever path your uploads are located in.
OBLIVION /2
Last Revised: 05/16/94
Features:
* ANSI Display to user
MAINTAIN.BAT
The following is an example MAINTAIN.BAT:
<drive:><path>TS5.EXE %1 /P<com>
Note: Use the proper parameters for the /P<com> switch based on the port
information you are using.
PCBOARD v14.5 & 15
Last Revised: 05/16/94
Features:
* ANSI & RIP Display to user
* Imports File Descriptions
* Writes Message to User
* On-Line File Converting (15.2+ only)
PCBTEST.BAT
Create a PCBTEST.BAT file in the PCBOARD node home directory as follows:
<drive:><path>TS5.EXE %1 /%2,%3 /CNONE
Note: /CNONE is not necessary if using PCBoard 15.1+.
PCBOARD 14.5
It is extreemely important that you set the following before loading PCBoard:
SET PCB=/SWAP
PCBOARD 15+
It is extreemely important that you set the following switches in the PCBOARD
Setup:
B File Transfers : Verify Files Uploaded : Y
D Configuration Switches : 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 and the *.IMP
files in the same directory as TS5.EXE.
POWER BBS
Last Revised: 05/16/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:
<drive:><path>TS5.EXE %1 /P%4 /CNONE
IF ERRORLEVEL 1 GOTO BAD
IF ERRORLEVEL 2 GOTO END
:BAD
COPY %2 %3
:END
PRODOOR
Last Revised: 03/27/94
Features:
* ANSI Display to user
BATCH FILE
@ECHO OFF
IF NOT EXIST %2\*.* GOTO END
<drive:><path>TS5.EXE %2\*.* /P%3 /CNONE
: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:
<drive:><path>TS5.EXE <uploadpath>\*.* /D /CNONE
Note: Change the uploadpath to whatever path your uploads are located in.
REMOTE ACCESS v1+
Last Revised: 03/27/94
Features:
* Off-Line Processing
BATCH FILE
Remote Access v1+ does not provide for running TranScan while a caller is on-
line. You should run TranScan from a daily event as follows:
<drive:><path>TS5.EXE <uploadpath>\*.* /D /CNONE
Note: Change the uploadpath to whatever path your uploads are located in.
REMOTE ACCESS v2+
Last Revised: 05/16/94
Features:
* ANSI Display to user
UPLOAD SCAN
The following command line should be added for your UPLOAD SCAN:
<drive:><path>TS5.EXE @ /P<com> /CNONE *M
Note: The drive, path, and extension MUST be included in order for TranScan
to work. Use the proper parameters for the /P<com> switch based on the port
information you are using.
RENEGADE
Last Revised: 05/16/1994
Features:
* ANSI Display to user
BATCH FILE
The following is an example for your post upload batch file:
<drive:><path>TS5.EXE %1 /P<com> /CNONE
Note: Use the proper parameters for the /P<com> switch based on the port
information you are using.
SEARCHLIGHT
Last Revised: 07/03/1995
Features:
* ANSI & RIP Display to user
UPLOAD AUTODOOR
Set the Searchlight Autodoor to run TranScan as follows:
1. Command....................<drive:><path>TS5.EXE <uploadpath>\*.* /P<com>
2. Directory path.............< blank or . >
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 parameters for the /P<com> switch based on the port
information you are using. The Directory path should be blank or have a
simple dot.
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
<drive:><path>TS5.EXE /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:
<drive:><path>TS5.EXE %1 /P<com> /CNONE
VIRUS CHECK: Yes
UNPACK BEFORE SCANNING: No
VIRUS FOUND ERRORLEVEL: 1
Note: Use the proper parameters for the /P<com> 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:
<drive:><path>TS5.EXE %1 /P%2
CONFIGURE SYNCHRONET
Run SCFG.BAT and go to Configure, File Transfers, Testable files. Create 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. Then
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
Last Revised: 03/27/94
Features:
* ANSI Display to user
POSTUL.BAT
Change your POSTUL.BAT as follows:
<drive:><path>TS5.EXE %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:
<drive:><path>TS5.EXE %1 /P<com>
Note: Use the proper paramaters for the /P<com> 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:
<drive:><path>TS5.EXE %1 /P<com> /CNONE
Note: Use the proper paramaters for the /P<com> switch based on the port
information you are using.
WILDCAT-TD (v2.60)
Last Revised: 03/27/94
Features:
* Off-Line Processing only
EVENT BATCH FILE
Wildcat-TD (v2.60) does not provide a Post-Upload process. You should
therefore run TranScan from a daily event as follows:
<drive:><path>TS5.EXE <uploadpath>\*.* /D /CNONE
Note: Change the <uploadpath> 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:
<drive:><path>TS5.EXE %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 run file should be
as follows:
CD\WC30\WCWORK\NODE1 REM (or NODE2, etc)
<drive:><path>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 you daily event files:
<drive:><path>TS5.EXE /L
WILDCAT! v4.01
Last Revised: 12/09/94
Features:
* ANSI & RIP Display to user
* Updates File Database
* Imports File Descriptions
* Converts Files Off-Line
* Writes Messages to Users
* Updates Activity Log
* Adds Orphan Files
TranScan v5.10 fully supports Wildcat v4.01. It processes files
on or off-line, imports FILE_ID.DIZ or DESC.SDI files, GIF comments
and resolutions, and sends messages to the caller. It displays
ASCII, ANSI, or RIP based on the caller's selection.
Installing TranScan with Wildcat v4.01 is incredibly simple if you
follow these guidelines:
1. Let TranScan create all batch files for you. You should NOT
have a FILEDESC.BAT file (no RUN files either). You SHOULD
have a SCANFILE.BAT file (no RUN files) and it should say:
<drive:><path>TS5.EXE %1
2. Your POSTCALL.BAT should include the line:
<drive:><path>TS5.EXE /L
3. In TranScan's BBS Set-Up make sure you select Wildcat v4+,
DOOR.SYS, and that your "Main BBS Config. file" is correct.
The "Drop File Path" MUST be left BLANK!
4. For the messages to work properly you MUST copy the *.IMP
files (that were in the MSG.ZIP file) to your MSG directory.
If you have never used the Wildcat *.IMP feature I strongly
suggest you read page 223 of your Wildcat v4 manual. This is
one of the best features in Wildcat (and it's been there for
years, too).
Upgrading TranScan from Wildcat v4.00 to v4.01 is incredibly
simple too if you follow these guidelines:
1. Delete your FILEDESC.BAT. You no longer need it!
2. Delete your SCANFILE.BAT and change it to the following:
<drive:><path>TS5.EXE %1
3. You no longer need to convert OFF-LINE so you can change
this at the "Default Compressor" and "GIF/JPG Set-Up screens.
WILDCAT! v4.00
Last Revised: 09/06/94
Features:
* ANSI & RIP Display to user
* Updates File Database
* Imports File Descriptions
* Converts Files Off-Line
* Writes Messages to Users
* Updates Activity Log
* Adds Orphan Files
Installing TranScan with Wildcat v4 is incredibly simple if you
follow these guidelines:
1. Let TranScan create all batch files for you. You should
have a FILEDESC.BAT file (no RUN files) and it should say:
if exist %1 <drive:><path>TS5.EXE %1
You should have a SCANFILE.BAT file (no RUN files) and it
should say:
if exist FILEDESC.BAD ren FILEDESC.BAD SCANFILE.BAD
2. Your POSTCALL.BAT should include the line:
<drive:><path>\TS5.EXE /L
3. In TranScan's BBS set-up make sure you select Wildcat v4+,
DOOR.SYS, and that your "Main BBS Config. file" is correct.
The "Drop File Path" MUST be left BLANK!
4. If you want TranScan to import GIF comments or GIF resolutions
you MUST do this OFF-LINE. So make sure you have the following
BBS Option checked:
[X] JPG to GIF, GIF to JPG, or GIFLite Offline.
5. If you prefer the way TranScan formats descriptions you must
do some type of processing offline. I recommed running a
secondary scanner. This will force TranScan to again uncompress
the file reading the FILE_ID.DIZ or DESC.SDI file and then
formatting it and importing it into Wildcat. To run a secondary
scanner go to TranScan's configuration, select "Scanner Set-Up"
and mark one of the scanners as follows:
[X] Secondary Off-Line Scanner
A "2" should appear next to the scanner's name.
6. For the messages to work properly you MUST copy the *.IMP files
(that were in the MSG.ZIP file) to your MSG directory. If you
have never used the Wildcat *.IMP feature I strongly suggest you
read page 223 of your Wildcat v4 manual. This is one of the
best features in Wildcat (and it's been there for years, too).
7. We still recommend that you Compress / Convert Off-Line.
To do this go to TranScan's configuration and select "Default
Compressor Set-Up" and mark the following option:
[X] Compress / Convert Off-Line
8. It is NOT necessary to do ALL processing OFF-LINE. In fact you
MUST do SOME processing ON-LINE in order for Wildcat to be able
to import the FILE_ID.DIZ or DESC.SDI files. Therefore, we
recommend that you DO NOT set the "Min. Sec. for processing
ALL OffLine" below "9999" at the BBS Set-Up. If you decide to
process all files OFF-LINE by setting this to "0" we recommend
that you delete the FILEDESC.BAD file and run TranScan from
the SCANFILE.BAT instead.
After extensive testing we have the following observations about
Wildcat v4+:
1. You CAN run TranScan in the SCANFILE.BAT and it will successfully
update the file database but Wildcat WILL return the short and
long descriptions to their original state UNLESS the filename
changes. For this reason we recommend running TranScan in the
FILEDESC.BAT.
2. Page 384 of MSI's Wildcat! v4 SysOp Guide refers numerous times
to a DESCFILE.BAT file. This is a typo! It should be
FILEDESC.BAT. If you use TranScan in the FILEDESC.BAT it will
not be necessary to use their example using PKUNZIP.
3. Are tired of seeing the following message?
"No description left by YOUR NAME, press I for information."
This message was NOT left by TranScan! This message is left
by Wildcat and can be changed by changing the Wildcat prompts
#1234 and #1235. What should you change them to? I recommend
leaving them blank.
4. If you use TranScan's "Min. Sec. for processing ALL OffLine"
by setting it to "0" then I recommend that you do not use the
FILEDESC.BAT but run TranScan in your SCANFILE.BAT as follows:
if exist %1 <drive:><path>TS5.EXE %1
This will keep the user from being prompted for each description
that we know won't be found because TranScan didn't run to
create it.
5. There is at least one know case where Wildcat v4 does not pass
a filename to the FILEDESC.BAT or SCANFILE.BAT. This is why
we recommend adding "if exist %1" to the line immediately
preceeding the "<drive:><path>TS5.EXE %1". Failing to do so
may cause TranScan to start in menu mode and stay that way until
you press <Esc>.
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:
<drive:><path>TS5.EXE <uploadpath>\*.* /D /CNONE
Note: Change the <uploadpath> to whatever path your uploads are located in.