home *** CD-ROM | disk | FTP | other *** search
/ Jason Aller Floppy Collection / 334.img / TMOD300.ZIP / TMODEM.DOC < prev    next >
Text File  |  1990-09-19  |  12KB  |  299 lines
  1.           Tmodem            Technical Reference Manual          Page 1
  2.  
  3.                                     Tmodem
  4.  
  5.          Tmodem's  derived  from  the  HTMS  protocol  Translink  with
  6.          special  modifications  so  that it'll  work  well  with  BBS
  7.          systems and Terminal programs.
  8.  
  9.          Tmodem   has  a built in communications manager  and  doesn't
  10.          need  any  type of fossil, in fact you should make  sure  you
  11.          turn  the  fossil  OFF if running it on a  BBS  that  uses  a
  12.          fossil.
  13.  
  14.          Tmodem requires a number of command line switches:
  15.                               -B, -P, {-R or -F}
  16.  
  17.          -B <Baud Rate>
  18.          -P <Port Number>
  19.          -L <Serial Lock Rate>
  20.          -R Receive files
  21.          -U  Drive:path,  directs that all files  received  should  be
  22.                           stored on this drive and in this  directory.
  23.                           This  switch  is primaryly  for  NON-OSIRIS,
  24.                           NON-QT  systems. Osiris takes care  of  this
  25.                           internally  and  this switch should  NOT  be
  26.                           used.
  27.  
  28.          Example: -U C:\uploads
  29.                   -U D:\files\temp
  30.                   -U D:
  31.  
  32.          Do NOT end the path with a backslash "\"
  33.  
  34.          Illegal -U settings would be C:\
  35.                                       C:\uploads\
  36.                                       D:\files\temp\
  37.  
  38.          -F <Filenames>
  39.          -K Keep interrupted transfers (Do not use if running on a BBS)
  40.          -N x, with x being the node number in use. For use on Osiris
  41.                CBIS  systems only.  Tmodem will show the name  of  the
  42.                caller as well as where he's from if this switch is used.
  43.  
  44.          -B,  supported baud rates 300 - 115,200 Baud.
  45.          -P,  Supported  Com  Ports, COM 1, COM  2, COM 3, and COM 4.
  46.          -L,  Supported Locked Baud Rates, 300 - 115200 Baud.
  47.          -F,  As  many as DOS allows. Full drive, path,  and  filename
  48.               supported.
  49.          -X,  Turns Tmodem.log OFF. The default is ON.
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.           Tmodem            Technical Reference Manual          Page 2
  57.  
  58.          -@ Filename, Filename is a text file listing out the names of
  59.                       the  files to send. The contents of filename  is
  60.                       one filename per line, unlimited number of lines.
  61.  
  62.                       e.g.
  63.  
  64.                       Tmodem.zip
  65.                       Zmodem.Zip
  66.                       OSE108?.ZIP
  67.                       C:\Osiris\Files\MISC\PK110.EXE
  68.  
  69.                       You use -@ in place of -F, do NOT intermix them!
  70.  
  71.                       Sample Command line
  72.  
  73.                       Tmodem -B 2400 -P 1 -@ C:\RyBBS\Send.Ctl
  74.  
  75.  
  76.  
  77.                    NOTE:   -R  or   -F  MUST  be  the   last
  78.                    parameter on the command line. As soon as
  79.                    Tmodem encounters either one of these two
  80.                    switches, it will begin to either Receive
  81.                    or Send.
  82.  
  83.          There must be one at least blank space between The switch and
  84.          the parameter..ie. -B<BLANK>2400
  85.  
  86.          The -L switch is only for those that do not have COMx= set in
  87.          the environment. If your running Osiris then Tmodem will  use
  88.          the COMx= automatically.
  89.  
  90.          Sample Osiris Command line (protocol control file)
  91.  
  92.          Send : -N *N -B *B -P *P -F *F
  93.          RCV  : -N *N -B *B -P *P -R
  94.  
  95.          QuickTerm (protocol control file definitions)
  96.  
  97.          Send : -B *B -P *P -F *F
  98.          RCV  : -K -B *B -P *P -R
  99.  
  100.                             Items to watch out for
  101.  
  102.          Tmodem  has it's own built in commucation driver.  Having  an
  103.          ACTIVE   fossil  may  cause  system  lockups,  sessions   not
  104.          starting,  and  other possiblities. Make sure  you  have  the
  105.          fossil turned off if your running one.
  106.  
  107.          Tmodem  uses  two  different types of  error  detection  when
  108.          sending  files.  At slow speeds, 3, 12, and 2400 bps  32  bit
  109.          CRCs  are used. At high speeds, 9600 and above, a  method
  110.          about as effective as 64 bit CRCs will be used.
  111.           Tmodem            Technical Reference Manual          Page 3
  112.  
  113.          Therefore  it  is very important that you  PASS  the  correct
  114.          CALLERS  baud  rate to avoid error  detection  mismatch.  For
  115.          instants,  if your locking the serial port at 19,200 and  you
  116.          have  a  2400 bps caller and pass 19200, your  side  will  be
  117.          using  extended  error detection and the other side  will  be
  118.          attempting the less effective 32 bit CRC error detection. The
  119.          result will be NO transfer.
  120.  
  121.          So, if your running a LOCKED Serial port, be sure to pass the
  122.          locked  rate  or  (better  method  and  desired)  is  to  set
  123.          COMx=LOCK_RATE in the environment with the DOS SET command.
  124.  
  125.          Assuming a 19,200 baud lock on COM 2: SET COM2=19200
  126.  
  127.          One  BBS program that we're aware of that  doesn't  correctly
  128.          pass  baud  rates (we've been told, but haven't  verfied)  is
  129.          WildCat.  It appears to pass the LOCKED baud rate instead  of
  130.          the TRUE connect rate.
  131.  
  132.          If  your  running Wildcat, you will need  to  setup  multiple
  133.          protocol selections and HARDCODE the baud rates in.
  134.  
  135.          Your other alternative is to switch to Osiris ;)
  136.  
  137.          Tmodem  is SHAREWARE. Your granted a limited license  to  TRY
  138.          this  program  for 14 days. At the end of 14  days  you  must
  139.          purchase Tmodem or you stop using it.
  140.  
  141.                     The price is 15 dollars (US Currency).
  142.  
  143.                                    Mail to :
  144.  
  145.                               Micro TECH Systems
  146.                              555 North Spring, #39
  147.                            Cape Girardeau Mo. 63701
  148.  
  149.                                Revision History
  150.  
  151.                                    Rev 3.00
  152.  
  153.          Fixed  bug in Transfer time computation routine that did  not
  154.          take into account 1200 baud modems.
  155.  
  156.          Added   support   for  Osiris's  Comport.Dat   file.   Allows
  157.          Tmodem.exe to use any one of the 8 definable serial ports.
  158.  
  159.          The detection of the COMPORT.DAT file is automatic.
  160.  
  161.  
  162.                                    Rev 2.50
  163.  
  164.          Support added for Effx.log, for Osiris SE systems only.
  165.  
  166.           Tmodem            Technical Reference Manual          Page 4
  167.  
  168.                                    Rev 2.40
  169.  
  170.          Added  -X  switch  to  allow the end user  to  turn  OFF  the
  171.          tmodem.log file.
  172.  
  173.                                    Rev 2.30
  174.  
  175.          Added  -@ filename to allow a text file to be used to  supply
  176.          file names in place of the -F command line switch.
  177.  
  178.  
  179.                                    Rev 2.20
  180.  
  181.          Added  -U  drive:path support which allows you  to  re-direct
  182.          files  that  your RECEIVING (-R) to another  drive  and  sub-
  183.          directory. This switch should NOT be used by Osiris!
  184.  
  185.          Placed error trap to avoid a possbile division by zero  error
  186.          on  files  smaller than 40 bytes. Highly unlikely  that  this
  187.          would have occured (the error, not a 40 byte file) but ...
  188.  
  189.          Added  serial support for COM ports 3 and 4. Please be  aware
  190.          that  there is NO standard settings for COM3 or COM4 and  can
  191.          vary depending on who made the serial card or internal modem.
  192.          We selected a comman setting found on the majority of  boards
  193.          WE looked at. So it MAY or MAY NOT work on your system.
  194.  
  195.  
  196.                                    Rev 2.10
  197.  
  198.          Added the ability to use DOS wildcard characters when SENDing
  199.          files.  In other words, -F filenames can consists of *  or  ?
  200.          characters.
  201.  
  202.          Valid filename examples:
  203.  
  204.          TestFile.Zip
  205.          Test?ile.ZIp
  206.          Test*.Zip
  207.          Testfile.*
  208.          C:\osiris\Test*.zip
  209.  
  210.          Added  extended CANCEL. You may cancel a transfer session  at
  211.          any  time.  This is NOT a file cancellation, it  cancels  the
  212.          entire session. Press ESC if you want to cancel the session.
  213.  
  214.          The cancellation will not happen immediately and in fact  may
  215.          take  4  or 5 seconds, depending on how much data is  in  the
  216.          transmit  buffer, the baud rate, and several  other  factors.
  217.  
  218.          We're  attempting  to keep trash, parts of the  file  already
  219.          on  the  way, from spilling over to  the  receivers  Terminal
  220.          screen or BBS screen.
  221.           Tmodem            Technical Reference Manual          Page 5
  222.                                    Rev 2.00
  223.  
  224.          Major  additions  to  the  display  screen  in  the  form  of
  225.          additional information about the transfer(s).
  226.  
  227.          The   estimated time  for a  transfer when sending   a   file
  228.          will   be off by 1 second because it will fall to the  update
  229.          screen section one  final time  even though  the receiver has
  230.          gotten the EOF ok.
  231.  
  232.          When receiving  the file,  the  estimated transfer  time  per
  233.          individual file should be within .5 seconds.
  234.  
  235.          Your  average  speed  indicator shows CPS counts   DURING the
  236.          transfer   and  the thoughput  rating  counter  will only  be
  237.          accurate   when receiving files because of the characters  in
  238.          the transmit buffer.
  239.  
  240.          When   transmitting  the  file,  these  two  counters    will
  241.          become  more  and  more accurate as  you  approach the end of
  242.          the  transfer.  Your TRUE thoughput rating will show   up  in
  243.          the   Batch  thoughput  window  following  the  end  of   the
  244.          transfer.
  245.  
  246.          There  are a number of second (time) displays. These will  be
  247.          accurate to within plus or minus one due to integer  rounding
  248.          errors.
  249.  
  250.          Version   2.00  is NOT backwards  compatible  with    earlier
  251.          version   of  Tmodem.  You may  want  to  keep   a   pre-2.00
  252.          version  on-line  until your users have  downloaded  the  new
  253.          version.  You  may  rename  either file to a  different  name
  254.          to keep the two apart.
  255.  
  256.          If  your running Tmodem on an Osiris CBIS and include the  -N
  257.          switch, the current caller to that node will be displayed  at
  258.          the bottom of the screen.
  259.  
  260.                                    Rev 1.10
  261.  
  262.          Had  a number of requests for some type of log  file.  Tmodem
  263.          now writes a  Tmodem.Log containing the baud rate,  filename,
  264.          file size, and percentage of throughput for the Transfer.
  265.  
  266.          If  its run with Osiris, the log will go in the  Osiris  Root
  267.          directory. Otherwise, it'll go in the default directory.
  268.  
  269.                                    Rev 1.03
  270.  
  271.          Increased    timers    for    start    of transfer, again.
  272.  
  273.          Fixed  a bug in the serial driver.  Seems it would leave  the
  274.          interrupt  latched high in  some cases on systems  that  used
  275.          8250 uarts.
  276.           Tmodem            Technical Reference Manual          Page 6
  277.  
  278.                                    Rev 1.02
  279.  
  280.          Fixed  slight bug in progress  bar  graph that allowed it  to
  281.          go over the end  under certain conditions.
  282.  
  283.          Added  automatic  detection and the use  of the   16550  Uart
  284.          Chip. Those with  16550's will  find  the driver  sending   6
  285.          times  faster  although  this will only  make   a  difference
  286.          on  SLOWER  computers.  A 8  Mzh XT can lock  at  38,400  and
  287.          actual DO  that speed using Tmodem.
  288.  
  289.                                    Rev 1.01
  290.  
  291.          Increased  timer for start  of  transfer. Those  running slow
  292.          XT's would  time  out before the transfer could be started.
  293.  
  294.          Added    Crtl-X  abort  feature.  A   send session   may   be
  295.          canceled   by   sending   5  control-X's.    This   is   only
  296.          effective  BEFORE   the  actual transfer  starts.   Once  the
  297.          transfer starts, it can not be  abort short of hanging up.
  298.  
  299.