Boldly Go Collection

home *** CD-ROM | disk | FTP | other *** search

/ Boldly Go Collection / version40.iso / TS / 05B / TMOD900.ZIP / TMODEM.DOC < prev next >

Wrap

Text File | 1992-03-17 | 36KB | 928 lines

Tmodem Rev 9.00 Copyright (c) 1988, 89, 90, 91, 92 By International TeleCommunications ALL RIGHTS RESERVED Table of Contents i Tmodem Command Line Switches .............................. Page 2 /F ................................................... Page 2 /R ................................................... Page 3 /U ................................................... Page 3 /S ................................................... Page 4 @ ............................................... Page 4 /K ................................................... Page 5 /N ................................................... Page 5 /P ................................................... Page 6 /V ................................................... Page 6 /B ................................................... Page 6 Locked Dte/Bbs Programs .............................. Page 7 /X ................................................... Page 7 /A ................................................... Page 7 Phase Shifting ....................................... Page 8 Required Switches .................................... Page 8 Your Receive Batch File .............................. Page 8 Send Batch File ...................................... Page 9 Error Levels .............................................. Page 9 Debug Messages ............................................ Page 9 Bbs/Terminal Programs ..................................... Page 9 Installing Tmodem On A Bbs ................................ Page 10 Installing Tmodem On A Terminal Package ................... Page 10 Terminal Interface Examples ............................... Page 12 Telix ................................................ Page 12 Locked Serial Ports And Telix ................... Page 13 Qmodem ............................................... Page 13 Qt 2000 .............................................. Page 14 Bbs Examples .............................................. Page 14 Limited Shareware. ........................................ Page 14 Features That Will Not Work. ......................... Page 14 Batch Transfers ............................... Page 14 Registering Tmodem ........................................ Page 15 $15.00 Registration .................................. Page 15 $25.00 Registration .................................. Page 15 Upgrades ............................................. Page 15 Tmodem License ............................................ Page 15 Tmodem Technical Reference Manual Page 1 LIMITED WARRANTY This products provided "as is" without warranty of any kind. The entire risk as to the results and performance of the program is assumed by you. Should the program prove defective, you (and not International TeleCommunications ) assume the entire cost of all necessary servicing, repair or correction. Further, International TeleCommunications does not warrant, guarantee, or make representations regarding the use of, or the results of the use of this program in terms of correctness, accuracy, reliability, currentness, or otherwise; and you rely on the program and its results solely at your own risk. International TeleCommunications cannot accept responsibility for system damage, loss of profit, or any other special, incidental, or consequential damage resulting from the use or inability to use this product. International TeleCommunications DOES warrant to the original licensee of a REGISTERED product that the program disk(s) on which the program is recorded be free from defects in materials and workmanship under normal use and service for a period of ninety (90) days from the date of delivery as evidenced by a copy of your receipt. International TeleCommunications' entire liability and your exclusive remedy shall be replacement of the disk not meeting International TeleCommunications Limited Warranty. DISTRIBUTION POLICY AND COPYRIGHT COPYRIGHT Despite the method of marketing, Tmodem is not in the public domain. It is the proprietary property of International TeleCommunications. All rights are reserved. Copying, duplicating, selling or otherwise distributing this product except as expressly permitted in the TEST-DRIVE Distribution Policy below is a violation of the Law. However, we grant you the right, in fact encourage you to make and distribute as many copies of this TEST-DRIVE version as you wish, using any acceptable medium of exchange, with the following provisions: Tmodem Technical Reference Manual Page 2 -- TEST-DRIVE Distribution Policy -- 1. Please feel free to distribute this TEST-DRIVE version as often as you like, to any interested parties. 2. Please do not distribute the program without all of its original related files, addendum files, and documentation. 3. Please obtain our written permission prior to distribution with any "Bundled" software packages. 4. Please do not accept payment for the program; a copying fee of $10.00 per diskette may be charged when distributed by a non-profit user-group. 5. Please do not alter the program or documentation in any manner. 6. NOTE - Individuals, groups, vendors, or other software distribution companies which market diskettes containing the TEST-DRIVE programs for profit must obtain written permission from International TeleCommunications prior to distribution. Tmodem Command Line Switches Each switch must be preceded by either a forward slash '/' or a dash '-'. F Slow Computer. R Receive File. U Place incoming files in this directory K Keep aborted transfers N Node Number caller is on. P Com Port to use. B Connect Baud Rate X Redefine Log S Send File(s). A Calibrate Serial Port. C Cancel Error/Suggestion Screens. V PMS Screening Engaged. /F 9600 bps and higher Slow Computer If you have a high speed modem you MUST have a 16550 Uart. Attempting to run at high speeds without one will result in errors. You might sneak by without a 16550 if you have a fast 286, 386, or 486. A good way to check is by watching your transfers. If you are under an error correcting connect, then you should almost NEVER get an error reported by ANY transfer protocol. Tmodem Technical Reference Manual Page 3 Getting errors reported (by ANY transfer protocol) while under MNP or ARQ can only mean. 1. The protocol goofed (Tmodem doesn't goof). 2. You may have another application interfering with serial interrupts. 3. You have hardware problems. 4. You do not have a 16550 Uart. Since you are using Tmodem, you can rule out one. If you have a 16550 installed, then you can rule out number four and that leaves you with two or three. If you have a multi-tasker or a network and a 16550 then the network and/or multi-tasker is stealing to much time and the 16550 fifo's are being over run. If you have a 16550 and NOTHING else that may interfere with the serial interrupts, then you more than likely have hardware problems. If it is option 4, buy one and install it. 16550 uarts cost about $20.00 and are WELL worth it. Unless you have hardware problems, I can HELP you by kicking in RTS flow control. This does slow down transfers, but it is better to slow them DOWN than experience errors. If you have to, add /F to the command line. But only use it if you HAVE to and only until you fix the CAUSE of the problem. /R Receive Files When I encounter this switch, I will go directly to receive files mode. You MUST make sure that /R is the very last switch used. If it is not, then you will be missing important command line switches. /U Place inbound files in this directory You can direct Tmodem to place inbound files in a specific directory by using the /U command. Tmodem Technical Reference Manual Page 4 I will verify the directory you specified, so make sure it is a VALID directory. You cannot use Drive designators or ROOT directories with the /U switch. For instance, /UC: or /UC:\. C: and C:\ aren't listed in the FAT and I cannot validate them. Make sure you do NOT use a trailing backslash with the /U path, I'll ADD a backslash when I concate the file name with the path you specified. E.g., d:\uploads\ is NOT valid, it should be d:\uploads . Here is a sample of a GOOD /U setting: /UC:\TELIX\UPLOADS /S Send These Files When I find the /S, I will immediately begin sending. YOU should make sure that you have listed ALL the OTHER commands before using the /S. Make sure you place ONE blank space between the /S switch and the first filename. Place one blank space between ADDITIONAL files names, if you have specified more than one. You may include a drive and path with the file names. E.g., c:\uploads\file1.exe is a valid file name. You can use the DOS wild card characters '?' and '*'. I will expand those characters to match any file in that directory. I do not place limits on the number of files that can FOLLOW /S, but DOS DOES! DOS restricts the number of characters you can place on a command line to 128. DOS also limits you to nine batch parameter symbols, %1 through %9. @ If the file name begins with the AT sign, '@', I'll assume you mean to USE the file as a "SEND" control file. e.g. @D:\OSIRIS\SEND2.CTL Since DOS forces me to work with 128 and nine batch variables, using @ to send file names is the preferred method of passing the names. Tmodem Technical Reference Manual Page 5 The information following @ is the full drive, path, and file name of a TEXT file. I do not place restrictions on the number of files that you can have listed and you can include the full drive, path, along with name of the file. You can include DOS wild card characters, '?' and '*'. E.g., C:\PCboard\Tlx310a.exe is valid. E.g., C:\Telix\*.arj is valid. Each line in the file must contain only ONE filename and has to end with the DOS CR/LF sequence. Sample Send Control File: C:\DRIVERS\MPT110.ZIP C:\DRIVERS\TMOD610.ARJ C:\DRIVERS\ZMOD*.* /K Keep Aborted Transfers If you drop carrier or time out, I will delete the aborted file. If you're using Tmodem with a TERMINAL program, then you will WANT to keep the file. Adding /K to your Tmodem command line tells ME you want to keep aborted transfers. NOTE: I will not keep aborted files if you abort using the ESC key, even if you DO use /K. /N Node Number If you're running OSIRIS SE, you can include /Nx on the command line. E.g., /N1 /N2 /N3 . . . /N255 Add /N*N to your protocol command lines. I'll display the callers name, city, and state at the bottom of the screen, useful when you walk into the room and WONDER who is currently downloading what. Tmodem Technical Reference Manual Page 6 /P Com Port You have to tell me which serial port your caller is ON by including /Px on the command line. E.g., /P1 /P2 /P3 . . . /P8 If you aren't running Osiris, you can only use P1, P2, P3, or P4. If you are using Osiris, you can use /P5 though /P8. /V Engage PMS Screening This can ONLY be used on an OSIRIS system. This tells me to allow Osiris to monitor the serial port with its ANTI-PMS screening system. PMS is a method of taking over a computer remotely and Osiris has an internal proprietary screening system to prevent that. Btw, PMS works with any BBS program. If you wake up some morning and discover your BBS sub-directory missing or your entire harddrive seems to have been erased, then it is likely that you've been invaded by someone using PMS. PMS does NOT require Tmodem to work. PMS uses the SERIAL port and ANY program that DEALS with the serial port: games, protocols, BBS programs etc. /B Connect Baud Rate You have to provide the TRUE CONNECT RATE, most of the time this is the same as your SERIAL baud rate. e.g. /B1200 /B2400 /B9600 If you have a high speed modem with a FIXED serial rate, the CONNECT rate may not always be the same, but that doesn't change anything. You still must pass the TRUE connect rate and not the SERIAL rate. If your terminal program isn't capably of passing the CONNECT rate then HARD CODE 0 in as the /B parameter. E.g., /B0 I will PROMPT you for the CONNECT rate. Tmodem Technical Reference Manual Page 7 Locked DTE/BBS programs You'll need to define an environment variable called COMx=BaudRate. Replace x with the serial port number and BaudRate with the LOCKED baud rate. e.g. COM1=19200 Do NOT add blank spaces or comma's. Make sure you use Upper Case. You can do that in the AUTOEXEC.BAT file or in the BATCH file you use to CALL Tmodem. e.g. cls Echo Loading Tmodem SET COM2=38400 Tmodem -B%1 -P%2 -R echo Transfer Complete. Exit Tmodem can support up to 115,000 baud using a combination of COMx and /B. /X Redefine the Log I will write a TRANSFER log called Tmodem.Log in the current directory. If I find OSIRIS= defined in the environment, I will write the log in that directory. /X allows you to DEFINE a NEW name and location, e.g., /XC:\TELIX\TRANS.LOG /A Calibrate Serial Port Older IBMs have problems dealing with high speed modems and LOCKED DTE rates. Normally this doesn't cause problem, but since Tmodem customizes the way it sends, it does. /A tells me to calibrate the serial port and if it is off, figure the deviations into the send algorithm. One side effect is the detection of inaccurate command line switches, some of them. If you have trouble getting Tmodem to work, TRY adding this switch. Tmodem Technical Reference Manual Page 8 Phase Shifting This happens when the SENDER and the RECEIVER come up with different ALGORITHMS, one or both have inaccurate command line settings. If this happens, Tmodem will place the message "Error RT6000: Phase Shifting!" on the screen. If Phase Shifting is detected, Tmodem will use a "BEST GUESS" algorithm. "BEST GUESS" means the transfer WILL take place, but you only have a 50/50 chance of achieving maximum thoughput. If it guesses wrong, you'll end up with thoughput about equal to Ymodem-G, so do yourself a favor and fix the problem. Required Switches Each Tmodem installation will require TWO switches. It does not matter what type of BBS/Terminal program you're going to use. It does not matter if it is SEND or RECEIVE. /Bxxxxx and /Px You should replace xxxxx in the /B with the correct CONNECT rate or 0. Replace the x in /P with the correct COM port. /B9600 /P2 (Connect Rate 9600, COM 2) /B2400 /P1 (Connect Rate 2400, COM 1) It is not important WHERE you place the switches, as long as they are NOT the LAST switch used. Your Receive Batch File Your Receive Batch file will require only one additional switch, /R. It MUST be the very last switch on the command line. The MINIMUM command line for receiving would be: Tmodem /B2400 /P1 /R 2400 and 1 can be supplied by DOS batch variables, e.g. Tmodem /B%1 /P%2 /R Tmodem Technical Reference Manual Page 9 Other optional switches, /U . . . /K etc., must be included BEFORE the /R switch. Send Batch File Your "SEND" batch file only "requires" ONE additional switch, /S. The MINIMUM command line for sending a file: /B2400 /P2 /S FILENAME#1 FILENAME#2 FILENAME#3 or /B2400 /P2 /S @CTRL_NAME 2400, 2, FILENAME#1, FILENAME#2, FILENAME#3, etc. may be supplied by DOS batch variables. E.g., Tmodem /B%1 /P%2 /S %3 %4 %5 %6 %7 %8 %9 Error Levels I will exit, following the transfer, with an error level of 0 or 1. Zero, 0, indicates a successful transfer and one, 1, indicates an error. Debug Messages Tmodem will display several ERROR messages when missing important or required command line switches. I.e., Missing or Illegal Baud Rate. Reference The Section(s) of this document that deal with that particular command line setting. BBS/Terminal Programs I use a very basic command line setup which should allow Tmodem to be used by almost any program. I do NOT expect that it will work with EVERYTHING. If you are using something that it will just flat not work with then send it to me. You can upload it or mail it and I will attempt to find out why. Tmodem Technical Reference Manual Page 10 Installing Tmodem on A BBS Make sure you read the Tmodem.doc file at least twice and write down all the command line switches, even if you don't think you'll need them all. It will lowers the chance that you may overlook that one little switch that will make Tmodem work with your software. One Pcboard sysop complained that Tmodem just dropped the uploads in the current directory, Pcboard required uploads be routed to a SPECIFIC directory, and he had to switch into the upload directory manually, in his batch file. Had he read the tmodem.doc file, he would have known that /U routes uploads and would have solved his problem. You should NEVER attempt to add TMODEM to your terminal software AND BBS simultaneously. You WILL need to have Tmodem installed and debugged, ALL baud rates, in your terminal package before attempting to installing it on your BBS. Find a BBS that has Tmodem installed, correctly, and test your terminal setup. Make sure you test at 2400 and at 9600, if you have a 9600 baud modem, by transferring files to and from the BBS. Make sure you have it tested both SEND and RECEIVE. If you do not know of a BBS that HAS Tmodem set up correctly, call 1-314-334-6359. Installing Tmodem on a Terminal Package First, READ your terminal program's documentation on HOW to install external programs. Know EXACTLY HOW and WHAT your terminal program passes in respects to command line arguments. Each terminal program does this a little differently, some VERSIONS of the same terminal program do it differently. Keeping in mind that Tmodem REQUIRES 3 switches. These two are ALWAYS used in BOTH batch files. /Bxxxx with xxxx being the CONNECT baud rate /Px with x being the COM Port Your 3rd REQUIRED switch will vary. Tmodem Technical Reference Manual Page 11 Your Receive batch file will use /R and your SEND batch file will use /S <Filename> <Filename> is the NAME of the file to Send. Your receive batch file should also include /K, keep aborted transfers. Most will be using DOS BATCH parameters to pass the information from your terminal program to Tmodem. E.g., Tmodem /K /B%1 /P%2 /R E.g., Tmodem /B%1 /P%2 /S %3 %4 %5 %6 %7 %8 %9 The number following the percent sign can, and will, vary depending on your software. It can vary depending on the version of your software, that's why I can't TELL you what to use for a specific program. There is an EASY method you can use to FIGURE all this out. Place the following line in both the SEND and RECEIVE batch files. Echo %1 %2 %3 %4 %5 %6 %7 %8 %9 pause Tmodem <your normal command line> The line beginning with "Echo" shows exactly WHAT your terminal program is passing and in which % variable. The BIGGEST single problem is passing the CONNECT baud rate to Tmodem when a 9600 baud modem is used. Some Terminal programs, Telix, were not written to handle smart protocols. They pass the SERIAL baud rate instead of the connect baud rate, which isn't acceptable. It is easy to debug this problem using the debugging example outlined earlier. If the %x variable you're using to pass the baud rate contains 9600, 19200, or 38400 when you call a 2400 baud system, your terminal program wasn't written to handle smart protocols. Some terminal programs (Qmodem) offer your TWO % variables for baud rate, one is the CONNECT rate and one is the SERIAL rate. The solution, hard code 0 as the /B parameter, I'll ASK you for the connect rate. Tmodem Technical Reference Manual Page 12 E.g., Tmodem /B0 /P%2 /R Letting me KNOW you're using a LOCKED serial port is another common problem. Be sure you set the COMx=LOCKRATE in your environment. You can do that by including one of the following in your autoexec.bat file, or on the line prior to calling Tmodem, in your "SEND" or "RECEIVE" batch files. Select one of the following that reflects your serial port and lock rate. SET COM1=9600 SET COM2=9600 SET COM3=9600 SET COM4=9600 SET COM1=19200 SET COM2=19200 SET COM3=19200 SET COM4=19200 SET COM1=38400 SET COM2=38400 SET COM3=38400 SET COM4=38400 If you place the SET command in your AUTOEXEC.BAT file, REBOOT your computer so it will take effect. Terminal Interface Examples Telix If you have a 300, 1200, or 2400 baud modem you'll need two batch files, one to send and one to receive. Tsend is for Sending file(s) and Trcv.bat is setup to RECEIVE files. Trcv.bat calls Tmodem: Tmodem -K -UC:\UPLOADS -B%1 -P%2 -R Notice the -UC:\UPLOADS This is an optional switch that directs all files received to a holding directory called C:\UPLOADS I.e., Tmodem -K -B%1 -P%2 -R Tsend.bat calls Tmodem: Tmodem -B%1 -P%2 -S %3 Tmodem Technical Reference Manual Page 13 Locked Serial Ports and Telix You'll need to add COMx=LOCK_RATE to trcv.bat and Tsend.bat. Assuming Com 2 is used and the lock rate is 19,200 baud. Trcv.bat: SET COM2=19200 Tmodem -K -UC:\UPLOADS -B%1 -P%2 -R Tsend.bat SET COM2=19200 Tmodem -B%1 -P%2 -S %3 If you're using Telix with a Fixed DTE rate, you have a problem. Telix always passes the SERIAL rate in the %1 variable. The fix is simply, but does require that you pay attention to the CONNECT message telix gives you. You will need to take Tsend and Trcv.bat and make a couple of small modifications. Trcv.bat calls Tmodem : Tmodem -K -UC:\UPLOADS -B0 -P%2 -R Notice that the %1 following the -B has been replaced with 0 (zero). This tells me that Telix cannot pass the TRUE connect rate and I'll open a small window in the middle of the screen displaying 4 connect rate options, select the one that is correct for the current session. You need to make the same modifications to the Tsend.bat file. Qmodem 300/1200/2400 Modems 9600 Baud Modem, running a FLOATING serial Port Qmodem External Download file for Tmodem. <TDN.BAT> Tmodem -B%3 -P%2 -K -R Exit Tmodem Technical Reference Manual Page 14 Qmodem External Upload file for Tmodem. <TUP.BAT> Tmodem -B%3 -P%2 -S %4 Exit 9600 Baud Modem, running a LOCKED Serial Port Qmodem External Download file for Tmodem. <TDN.BAT> Tmodem -A -B%3 -P%2 -K -R Exit Qmodem External Upload file for Tmodem. <TUP.BAT> Tmodem -A -B%3 -P%2 -S %4 Exit QT 2000 Protocol Definition Record Send : -B*B -P*P -S *F RCV : -K -B*B -P*P -R BBS Examples We're no longer including samples of other brand-x bbs programs. The examples that were submitted for varies BBS programs seem to only work only part of the time and varied from system to system and from software version to software version. This confused more people than it helped and my technically support division was bombarded with questions they had no way of answering. ************************************************************* I M P O R T A N T S O R E A D T H I S ! LIMITED SHAREWARE. Tmodem is LIMITED SHAREWARE, meaning you can try most of the features before you purchase it. Features that will not work. Batch Transfers: You cannot use Tmodem as a BATCH protocol in NON-REGISTERED MODE. **************************************************************** Tmodem Technical Reference Manual Page 15 Registering Tmodem ($15.00 you download Key) ($25.00 for Disk with Latest Version Mailed to You) Fill out the Order.Frm and Mail To : International TeleCommunications 555 North Spring, #39 Cape Girardeau Mo. 63701 $15.00 Registration You DOWNLOAD the Registered Tmodem from the BBS at 1-314-334- 6359. $25.00 Registration We will send you the registered Tmodem on a 5 1/2 360K diskette. Upgrades You can upgrade to a newer version of Tmodem for $5.00, download upgrade from BBS, or $10.00 and we'll mail the upgrade to you on a 5 1/4 diskette. Tmodem License Please Read Carefully WHEN you register Tmodem, you indicate your acceptance of these terms. 1. License Grant. International TeleCommunications will grant you a non-exclusive license to use one copy of Tmodem on a single computer or on a single terminal connect to a single computer. Neither concurrent use on two or more computers nor use in a local area network is authorized without advanced written consent of International TeleCommunications and the payment of additional license fees. 2. International TeleCommunications' Rights. You acknowledge and agree that Tmodem is a proprietary product of International TeleCommunications, protected under U.S copyright law, international treaty provisions, and trade secret laws of general applicability. You further acknowledge and agree that all rights, title, and interest in and to Tmodem are and shall remain with International TeleCommunications. Tmodem Technical Reference Manual Page 16 3. Other Restrictions. You may not lease or rent Tmodem. You may not disassemble, decompile, or reverse engineer Tmodem. 4. Tmodem is licensed "AS IS," and International TeleCommunications disclaims any and all warranties, whether express or implied, including (without limitation) any implied warranties of merchantablity or fitness for a particular purpose. 5. Limitation of Liability. International TeleCommunications' cumulative liability to you or any other party for any loss or damage resulting from any claims, demands, or actions arising out of or relating to this agreement shall not exceed the license fee paid to International TeleCommunications for the use of Tmodem. In no event shall International TeleCommunications be liable for any indirect, incidental, consequential, special, or exemplary damages or lost profits, even if International TeleCommunications has been advised of the possibility of such damages. Some states do not allow the limitation or exclusion of liability for incidental or consequential damages, so the above limitation or exclusion may not apply to you. 6. Governing Law. This license agreement shall be construed and governed in accordance with the laws of the State of Missouri. 7. Severability. Shall any term of this license agreement be declared void or unenforceable by any court of competent jurisdiction, such declaration shall have no effect on the remaining terms hereof.