home *** CD-ROM | disk | FTP | other *** search
/ rtsi.com / 2014.01.www.rtsi.com.tar / www.rtsi.com / OS9 / OSK / TELECOM / tterm_68k.lzh / tterm.doc < prev    next >
Text File  |  1996-03-10  |  10KB  |  247 lines
  1.  Tterm - a simple terminal program for OS9 and OS9000
  2.          by Ed Gresick and Stephen Carville
  3.          From Mark Griffith's original code
  4.  
  5.     This is a basic terminal program providing
  6.  
  7.     Simple Dialer
  8.     XModem, XModem-1K, YModem (Batch) transfer
  9.     Compuserve B+
  10.  
  11.  Setup.
  12.  
  13.     This program and all of it's attendants were written entirely in Ultra-C 
  14.     so if you don't have the 'csl' and 'fpu' modules installed you will need 
  15.     to get them.  See the readme file for details and availability.  
  16.  
  17.     Before using Tterm, run the program 'tsu'.  This will check to be certain 
  18.     that all the necessary directories and files are available and create 
  19.     them if needed.  This version of Tterm requires that names and numbers be 
  20.     added to the dialer file manually with a text editor.  See the section 
  21.     titled "Dialer File Setup" for details.  
  22.  
  23.     This program reads the MODEM environment variable for the port the modem 
  24.     is attached to.  This may be over-ridden by the "-t[=]<port>" option but 
  25.     there is no default - either MODEM or -t must be specified.
  26.     
  27.     X and Y transfer services are provided by a companion program called 
  28.     "xyt" which has been designed to work with Tterm.  This program must be 
  29.     in the current CMDS directory or in a PATH directory to use Tterm's built 
  30.     in transfer abilities.
  31.     
  32.  Command Summary
  33.     
  34.  The original Sterm command syntax has been abandoned if favor of Function 
  35.  keys:  
  36.  
  37.     F1   Show This Message
  38.     F2   Capture On/Off
  39.     F3   Change Directory
  40.     F4   Quit
  41.     F5   Ascii Transmit
  42.     F6   Transfer A File
  43.     F7   Set Transfer File
  44.     F8   Set Transfer List
  45.     F9   Dial Directory
  46.     F10  Execute a Shell
  47.     F11  Echo ON/OFF
  48.     F12  High Bit Filter On/Off
  49.  
  50.  
  51.  Show Help - [F1]
  52.  
  53.     Shows the help box with a brief summary of the commands available, modem 
  54.     port and the current baud rate.
  55.  
  56.  Capture ON/OFF - [F2]
  57.  
  58.     This toggles the capture-to-file on or off.  When on, everything echoed 
  59.     to the screen is also captured to the designated file. 
  60.  
  61.  Change Directory - [F3]
  62.  
  63.     Changes the working directory Tterm reads files from or writes files to.
  64.     
  65.  Quit - [F4]
  66.  
  67.     Quits Tterm after prompting with "Are You Sure?".
  68.     
  69.  Transmit a file - [F5]
  70.  
  71.     Prompts for a file name and transmits it verbatim.  There is a slight 
  72.     delay at the end of each line to allow the remote machine to echo back.  
  73.     This is intended to transmit Ascii files but will send non-ascii 
  74.     characters.  This last can cause unpredictable results at the remote 
  75.     end.  
  76.     
  77.  File transfers - [F6]
  78.    
  79.     This command initiates file transfer.  You are prompted as to whether you 
  80.     want to <S>end or <R>eceive.  If no file or list of files had been 
  81.     selected with the Esc F or Esc L commands the <S>end will return an 
  82.     error.  The transfer software will automatically negotiate the protocol 
  83.     so no further selection on your part is needed.  
  84.     
  85.  Set Transfer File - [F7]
  86.  
  87.     This is used for single file transfers to another machine.  At the 
  88.     prompt, enter the name of the file to send.  Tterm checks to be certain 
  89.     the file exists and is accessible before continuing.  Wild cards are not 
  90.     permitted so if several files need to be transfered use Esc L instead.
  91.  
  92.  Set Transfer List - [F8]
  93.     
  94.     Sometime you will need to upload several files one right after the other. 
  95.     This is know as a batch transfer and this command tells Tterm that the 
  96.     filename entered is a list of the files to send - one file per line.  
  97.     Tterm checks the list to be sure that all the requested files exist and 
  98.     are accessible.  If all the files are valid the list is accepted, if there 
  99.     are no valid files the list is rejected and if some are valid and others 
  100.     are not you are given the option of accepting the list anyway.  Invalid 
  101.     or inaccessible files will be rejected by Tterm's transfer software.
  102.  
  103.  Dial Directory - [F9]
  104.  
  105.     This command open the dialer file containing your specific hosts and 
  106.     phone numbers and presents you with a list.  You are prompted for a host 
  107.     to dial.  See the section below called "Dialer File Setup" for details on 
  108.     the format. 
  109.  
  110.     
  111.  Echo ON/OFF - [F11]
  112.  
  113.     Toggles local Echo (Duplex) on or off.  Most systems echo every character 
  114.     received back to the sender in interactive mode so this command is rarely 
  115.     needed.
  116.  
  117.  Execute Shell Command - [F10]
  118.  
  119.     Allows a shell command to be executed from within Tterm.  If a blank line 
  120.     is entered, an interactive shell is activated.  Use "logout" or the Esc 
  121.     key to return to Tterm.
  122.     
  123.     Tterm releases all control of the modem port during this operation so 
  124.     alternate transfer software can be initiated from this command.
  125.     
  126.  High Bit Filter ON/OFF - [F12]
  127.  
  128.     Toggles the high bith filtering on and off for BBS systems that send 
  129.     8-bit characters
  130.  
  131.  
  132.  Dialer File Setup
  133.  
  134.     To add or edit entries in your dialer file chd to /dd/USR/TTERM and load 
  135.     the file into a text editor.  The file name is constucted using your 
  136.     login name as stored in the USER environment variable and adding the five 
  137.     characters ".dial".  If your user name is "joatamon" then your dialer 
  138.     file would be called "joatamon.dial".  If USER is not defined, the name 
  139.     "generic.dial" is used.
  140.     
  141.     Each entry consistes of at least three lines.  The first is the entry you 
  142.     want to appear in the menu.  The second is the dialing string to send to 
  143.     the modem - usually atdt<phone number> but the exact syntax will depend 
  144.     on your individual modem.  Each of these first two lines is limited to 32 
  145.     characters.  The last line in each entry must be two backslashs ("//") 
  146.     and every entry must have this terminator.  Anything between the second 
  147.     line and this terminator is ignored in this version of Tterm but later 
  148.     versions may make use of information in these lines.  An example file 
  149.     might look like:  
  150.     
  151.         Delphi (via SprintNet)
  152.         atdt 331-6611
  153.         //
  154.         Delphi (via MCINet)
  155.         atdt 1 909 860 2881
  156.         //
  157.         Skeptics BBS
  158.         atdt 335-9601
  159.         //
  160.  
  161.  Termcap Usage.
  162.     
  163.     This program requires that you have a termcap entry for the terminal type 
  164.     specified in the TERM environment variable.  The clear screen (cl), 
  165.     cursor motion (cm), standout on (so) and standout off (se) are required.  
  166.     The pad character (pc), backspace (bc) and cursor up (up), are needed 
  167.     for certain terminals so are also checked for but are not required.
  168.     
  169.     The following keys are required:
  170.         k1 - k9     function keys F1 thru f9
  171.         k0          function key F10
  172.         F1, F2      function keys F11 and F12
  173.         ku          Up Arrow Key
  174.         kd          Down Arrow Key
  175.         kl          Left Arrow Key
  176.         kr          Right Arrow Key
  177.     
  178.     If your terminal can support special graphics characters, they can be 
  179.     designated with the "ac=" capability.  If this capacity is missing or not 
  180.     complete, then a default ascii set is used.  The mapping is based on the 
  181.     double line graphic characters used on most IBM machines but since many 
  182.     implementation of termcap will not accept eight bit characters the high 
  183.     bit is cleared.  This is a list of the characters used by this program:  
  184.     
  185.         vertical bar        \072  (':' is a terminator in termcap)
  186.         horizontal bar      M
  187.         upper left corner   I
  188.         upper right corner  ;   
  189.         lower left corner   H
  190.         lower right corner  <
  191.     
  192.     Each entry in ac= is actually two characters, the first is the "standard" 
  193.     value, the second is the equivilent on the terminal the entry is for. 
  194.     Following is the appropriate entry for a machine that supports the 
  195.     standard IBM double line graphics: 
  196.     
  197.     :ac=\072\072;;<<HHIIMM:\
  198.     
  199.  Transfer List Format
  200.    
  201.     The transfer list designated by the F7 command is simply a list 
  202.     of files to be sent using the X or Y protocol.  One file or pathname is 
  203.     on each line:
  204.     
  205.     /dd/C/TELECOM/tterm_src.lzh
  206.     /dd/GAMES/Chess_data
  207.     /dd/ETC/ecetera
  208.     
  209.  Transfer Log
  210.     
  211.     Each user of Tterm will find in the /dd/USR/TTERM directory a file called 
  212.     <user name>.xyt containing a cumulative list of files transferred using 
  213.     the X or Y protocol under his account.  This file is automatically 
  214.     created by Tterm and contains the name of any files sent or recieved 
  215.     using the F6 command, date and starting time of transfer, total bytes 
  216.     transferred and approximate bits/second.  This version of Tterm does not 
  217.     log B+ transfers.  
  218.     
  219.     This file can become quite large if a lot of files are transferred so 
  220.     periodic editing is advised.
  221.     
  222.  Acknowledgments:
  223.  
  224.     Mark Griffith, whose Sterm served as the original inspiration to write 
  225.     this program.  Tim Kientzle for his description of the X and Y protocols 
  226.     in Dr. Dobbs Journal.  Ed Gresick for his help in getting the OS9000 
  227.     version of this program to work, testing the B+ protocol and for 
  228.     pointing out those little errors...  
  229.  
  230.  Obligatory Legal Stuff
  231.     
  232.     This version (2.XX) may be freely distributed as long as this 
  233.     documentation and all other files listed in "readme" are included.  
  234.     
  235.  This program is brought to you by:
  236.  
  237.     Stephen Carville
  238.     P.O. Box 822 
  239.     Glendora, CA 91740 USA
  240.     (818) 914-2511
  241.     pagan@delphi.com
  242.  
  243.     Custom modification to this or any other of my programs is available.  
  244.     Contact me at the above phone number or E-mail address for further 
  245.     information.  
  246.  
  247.