home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 1: Collection A / 17Bit_Collection_A.iso / files / 68.dms / 68.adf / Wombatterm.doc < prev    next >
Text File  |  2008-06-07  |  18KB  |  453 lines
  1. the Wombat Terminal Program (version 2)    22-mar-86
  2.  Copyright (C) 1986 by Dave warker
  3.  
  4.  
  5.  --- STUFF:
  6.  
  7.       Note that the correct file sizes for version 2 are:
  8.  
  9.   Wtp  32900 bytes
  10.   Wtp.info 938 bytes
  11.   FixWtpLoadV1 16932
  12.  
  13.  
  14.  
  15.  --- HELLO AGAIN!
  16.  
  17.       This is a quicky information file which explains, though briefly,
  18.  the features of the Wombat Terminal Program (Wtp).
  19.  
  20.  Some of the features of Wtp which may be of interest:
  21.  
  22.   - full 80 x 24 screen. A 25th display line is reserved for status info.
  23.     such as time of day and elapsed session time.
  24.  
  25.   - limited ANSI control sequence recognition. Supports enough to allow
  26.     use with VT-100 terminal option on Delphi and Compuserve. Next version
  27.     will support many more of the VT-100 functions.
  28.  
  29.   - Text file data capture and transmission. Options are provided to auto-
  30.     magically convert CR/LFs to LF on receive and LFs to CR/LF on transmit.
  31.     Another options allows stripping of all control characters except CR, LF
  32.     and TABs from incoming and outgoing text files.
  33.  
  34.   - XMODEM file transfer both text and binary files.  The options provided
  35.     for text file capture and transmission also apply for XMODEM text file
  36.     transfers.  CRC transfers are supported.
  37.  
  38.   - Phone dialing functions.
  39.  
  40.   - Load and save of current parameter settings. Optionally will auto-dial
  41.     when a new set of parameters are loaded.
  42.  
  43.   - Choice of visual, tone or speech bell.
  44.  
  45.   - other stuff.
  46.  
  47.  
  48.  --- STARTING UP 'WTP'.
  49.  
  50.       Wtp can be started from either the CLI or from the Workbench.  Sorry
  51.  about the grundgy looking ICON, anyone with real artistic ability, as
  52.  opposed to my autistic ability, who blows an hour or so desiging a nice
  53.  looking "Wombat on the telephone" will receive a pat on the back and
  54.  my eternal gratitude.
  55.  
  56.       From the Workbench you just double click the Wombat icon and Wtp
  57.  will load.  The current version does not save icons for the created
  58.  settings files so for now you will have to load the desired settings
  59.  after loading Wtp.
  60.  
  61.       From the CLI there is a single optional argument which should be
  62.  the name of a Wtp settings file created with the "Save settings" menu
  63.  selection.  If supplied then those settings will be in effect when Wtp
  64.  starts up.
  65.  
  66.       If no arguments are supplied then Wtp looks for a default settings
  67.  file named "default.wtp", first in the current directory, then in the
  68.  directory "SYS:wtp/".  The first file found is used.
  69.  
  70.       If no default settings file is found Wtp will use a reasonable set
  71.  of default values, reasonable for me that is.  If you don't like them
  72.  you should change the settings to match your preferences then save them
  73.  as "default.wtp" someplace.
  74.  
  75.       When Wtp finishes loading you should see a blank screen with a cursor
  76.  in the upper left corner and with the current time displayed on the bottom
  77.  (status) line and the elapsed session time, which will be 00:00 hours,
  78.  to the right.  If instead you see an alert box then Wtp could not start up
  79.  due to lack of some required resource.  The possible alerts are:
  80.  
  81.  
  82.      "Can't open window"
  83.   Wtp could not open the Intuition window to be used for it's
  84.   output. Probably due to a lack of memory.
  85.  
  86.      "Can't allocate cursor sprite"
  87.   The cursor used in Wtp is actually a hardware sprite. You may
  88.   get this error if some other application has grabbed up all
  89.   the available sprites.
  90.  
  91.      "Can't open timer port"
  92.      "Can't allocate timer request"
  93.      "Can't allocate serial Port"
  94.      "Can't allocate serial request"
  95.   There was insufficient memory to allocate the MsgPorts or
  96.   IORequests needed for serial or timer device operation.
  97.  
  98.      "Can't open timer"
  99.   Wtp uses the timer device to blink the cursor and to time the
  100.   XMODEM transfers.  This error indicates that the timer device
  101.   could not be opened. Since the timer is "ROM" resident it is
  102.   not likely that this error will occur.
  103.  
  104.      "Can't open serial device"
  105.   Probably caused because the "serial.device" file was not present
  106.   in the "DEVS:" directory of the current system disk or because some
  107.   other application has requested exclusive access to the serial port.
  108.  
  109.  
  110.       If you do not get an Alert you are up and running and should peruse
  111.  the menu options to inspect/change the settings as needed.
  112.  
  113.       Note that the session time is the elapsed time, in hours and minutes,
  114.  since you started the current call or since you reset it via the "reset
  115.  session time" menu option.  The current time is displayed in standard
  116.  Amiga 24 hour format.
  117.  
  118.  
  119.  
  120.  --- LEAVING 'WTP'.
  121.  
  122.       Just select 'quit' from the 'Stuff' menu. All system resources will
  123.  be returned to the OS and any open transfer files will be closed.
  124.  
  125.  
  126.  
  127.  --- ANSI CONTROL SEQUENCES SUPPORTED:
  128.  
  129.  The following control characters are supported:
  130.  
  131.  HEX NAME FUNCTION
  132.  
  133.   0D  CR  Carriage return, moves cursor to column 1 of current line.
  134.   0A  LF  Line feed. Moves cursor to same column of next line.
  135.   08  BS  Backspace, move cursor left one character.
  136.   07  BEL  Bell. What happens depends on current bell selection.
  137.   09  HT  Horizontal TAB. Moves cursor to next multiple of 8 column.
  138.   1B  ESC  Introduces ANSI CSI and DCS sequences defined below.
  139.   0B  VT  Vertical TAB, treated same as LF.
  140.   0C  FF  Form feed, treated same as LF.
  141.  
  142.  All other control characters, including rubouts (7F hex) are ignored for
  143.  display on screen.
  144.  
  145.  The following ANSI sequences are recognized:
  146.  (note that CSI = 'ESC [', and DCS = 'ESC P')
  147.  
  148.  SEQUENCE  FUNCTION
  149.  
  150.   CSI <row> ; <col> H  Position cursor. Row and/or column may be omitted.
  151.   CSI <row> ; <col> f  Same as previous.
  152.  
  153.   CSI <ext> J   Erase in screen. 'ext' values:
  154.      0 = erase cursor to end of screen
  155.      1 = erase start of screen to cursor
  156.      2 = erase entire screen
  157.  
  158.  All other CSI and DCS sequences are ignored.  Sorry but no new sequences
  159.  have been added in version 2.  I am planning to incorporate significant
  160.  VT-100 and VT52 compatibility in the next version but due to the time
  161.  it will probably involve I decided to release version 2 before starting
  162.  on that can of worms.
  163.  
  164.  
  165.  
  166.  --- MENU SELECTIONS:
  167.  
  168.  THE 'STUFF' MENU:
  169.  
  170.  
  171.  
  172.  "About Wtp.."
  173.       Just displays a little info 'bout me, Nothing fancy.
  174.  
  175.  "load settings"
  176.       Presents a requester where you can enter the name of a Wtp settings
  177.       file created with the next menu item and Wtp will change the current
  178.       settings to match those in the file.  Note that if 'auto-dial' is
  179.       enabled Wtp will attempt to dial the phone number after the settings
  180.       are loaded. Future versions will provide a "Mac"ish scrolling window
  181.       of available settings files.
  182.  
  183.       Note that you must convert settings files created with Wtp version 1
  184.       into files loadable with Wtp version 2 with the "FixWtpLoadV1" utility
  185.       provided.
  186.  
  187.  "save settings"
  188.       Presents a requester to specify the name of a file to which the
  189.       current settings will be written. Any name may be used but I suggest
  190.       that a ".wtp" be appended to it as future versions will auto-magically
  191.       display a list of all such files when 'loading' settings.
  192.  
  193.  "quit"
  194.       Amazingly enough just quits "Wtp" and returns to the CLI or Workbench.
  195.       Will close any open text capture or transmission files.
  196.  
  197.  
  198.  THE 'FILE' MENU:    (file transfer)
  199.  
  200.  "capture text to a file"
  201.       Allows you to open a new file to which all received characters will
  202.       be written.  Note that the "text transfer options" effect which
  203.       characters will be written to the file. Select this menu item again
  204.       to close the capture file.
  205.  
  206.  "send a text file"
  207.       Allows you to open an existing file and send it out the serial port.
  208.       Which characters are sent depends on the text transfer options.
  209.       Selecting this item again will cancel the text file send.
  210.  
  211.  "XMODEM (text) send"
  212.       Will transmit a text file using the XMODEM protocol. Note that the
  213.       "text transfer options" are applied to the data.  The bell is sounded
  214.       when the transfer has completed.  During the transfer the "File" menu
  215.       will contain an option which will allow canceling the transfer.
  216.       If CRC transfers are enabled then the transfer will take place using
  217.       CRC checksums if the receiver requests it. Any unused space in the
  218.       last XMODEM record will be filled with 0s. Also note that all XMODEM
  219.       transfers automatically force XON/XOFF handshake off and 8 data bits.
  220.  
  221.  "XMODEM (text) receive"
  222.       Receives a file using XMODEM protocol. Applies the "text transfer
  223.       options" to the received data. Note that the "strip control characters"
  224.       options will cause the extra 0s appended to the last record by the
  225.       XMODEM send function to be stripped.  Can be aborted via the "File"
  226.       menu.  If CRC transfers are enabled then Wtp will request a CRC transfer
  227.       and, provided that the sender supports CRC, the transfer will use CRC
  228.       checksums.
  229.  
  230.  "XMODEM (binary) send"
  231.  
  232.       Send a binary file using XMODEM protocol. File data is transferred
  233.       as is and is not effected by the "text transfer options".
  234.  
  235.  "XMODEM (binary) receive"
  236.       Receive a binary file using XMODEM protocol. Data is saved as
  237.       received and is not effected by the "text transfer options".
  238.  
  239.       I would like to add an Amiga specific XMODEM transfer option similar
  240.       to "MacBinary" and would like to hear ideas as to what people would
  241.       like to see in it.
  242.  
  243.  "Text transfer options..."
  244.       Allows changes several options which apply to text transfers:
  245.  
  246.       "LFs <---> LFs"
  247.       "LFs <---> CRs"
  248.       "LFs <---> CR/LFs"
  249.     One of these options must be checked and determines what happens
  250.     to received or transmitted line feeds during text transfers.
  251.  
  252.     The first option (LFs <---> LFs) passes them through unaltered
  253.     and might be used when transferring a file from a Unix system
  254.     or another Amiga.
  255.  
  256.     The second option (LFs <---> CRs) causes transmitted line feeds
  257.     to be changed into carriage returns and received carriage returns
  258.     to be changed into line feeds.  Normally used when sending a text
  259.     file, via "Send text file" option, to a computer as if you were
  260.     typing it by hand, ie: with a single carriage return at the end
  261.     of each line.
  262.  
  263.     The last option (LFs <---> CR/LFs) converts transmitted line
  264.     feeds into a carriage return and a line feed.  Received carriage
  265.     return and line feed pairs are changed into a single line feed.
  266.     This is the file transfer method you should use when receiving
  267.     text files from, or sending text files to DELPHI or COMPUSERVE.
  268.  
  269.       "strip control chars"
  270.     Causes any control characters other than CR, LF and TAB to be
  271.     thrown away on both send and receive. This includes NULs (0)
  272.     and DELs (7F hex).
  273.  
  274.  
  275.  "XMODEM transfer options..."
  276.      Allows changing of options which only apply to XMODEM transfers.
  277.  
  278.      "use CRC checksums"
  279.     When checked, allows use of CRC checksums during XMODEM
  280.     transfers.  CRC checksums add an insignificant amount of
  281.     overhead to the transfers while providing a much greater
  282.     degree of confidence that the transfer will be error free.
  283.     If the service or system you are connected to does not
  284.     support CRC transfers then Wtp will fall back to simple
  285.     checksums automatically.  You should only un-check this
  286.     option if you are certain that the other end of the transfer
  287.     does NOT support CRC.  Both DELPHI and COMPUSERVE support
  288.     CRC.
  289.  
  290.  
  291.  THE 'PORT' MENU:    (serial port settings)
  292.  
  293.  
  294.  "Baud rate"
  295.       Submenu allows changing the current transmission speed. You probably
  296.       need XON/XOFF handshaking for the higher speeds (9600 & 19200).
  297.  
  298.  "Character format"
  299.       Allows selection of the character size and parity mode. The default
  300.       setting is "7 data bits/space parity" which is the most common.
  301.       The character format you choose must match the format used by the
  302.       service or terminal program to which you are communicating.
  303.  
  304.  "Stop bits"
  305.       Can select 1 or 2 stop bits. Generally not important but provided
  306.       for completeness. Due to the method I was forced to use for generating
  307.       parity bits, you are stuck with 1 stop bit for all character formats
  308.       except "7 data bits/no parity".  This menu option may disappear in the
  309.       next version if no one yells that they need it.
  310.  
  311.  "XON/XOFF handshake"
  312.       A common handshaking method which sends a CONTROL-S when the receiver
  313.       is falling behind and a CONTROL-Q when it has caught up. This option
  314.       applies to both sent and received data but does NOT apply to XMODEM
  315.       transfers as CONTROL-S and CONTROL-Q are valid data characters. You
  316.       can leave this option on in any case and an XMODEM transfer will
  317.       internally turn it off for the duration of the transfer.
  318.  
  319.  
  320.  THE 'SCREEN' MENU:
  321.  
  322.  "cursor wrap at EOL"
  323.       When checked causes the cursor to wrap to the next line when it hits
  324.       the right edge of the screen. Will also cause the cursor to wrap to
  325.       the previous line when you backspace past the left screen edge.
  326.       If this option is off the cursor will be pinned to the left and right
  327.       screen edges. I found that turning cursor wrap off on Delphi prevents
  328.       problems with lines of exactly 80 characters (the VT-100 treats column
  329.  
  330.       80 specially so it does not have this problem.)
  331.  
  332.  "local echo"
  333.       When checked causes all data entered at the keyboard (and also send
  334.       from a text file) to be displayed on the screen. This normally only
  335.       usefull for talking terminal to terminal as Delphi's or Compuserve's
  336.       computers normally handle the echoing of keys. The normal setting
  337.       for this option is OFF.
  338.  
  339.  "CR --> CR/LF"
  340.       Displaying a carriage return normally just positions the cursor
  341.       to the first character of the CURRENT line.  Checkmarking this
  342.       option will force a carriage return to place the cursor at the
  343.       first character of the NEXT line.  This option should normally
  344.       be left unchecked unless you are calling another person who will
  345.       be typing to you through his terminal program (hopefully another
  346.       Amiga running Wtp!), in which case you should also checkmark the
  347.       "local echo" option so you can see what you are typing.
  348.  
  349.  "Cursor style..."
  350.       Allows selection of a box or underline cursor either blinking or
  351.       solid.  Note that the blinking cursor is now functional.  I will
  352.       provide a means of changing the cursor blink rate if the current
  353.       default rate is too obnoxious for you.
  354.  
  355.  "Bell type..."
  356.       Selects which type of bell to use.
  357.  
  358.       The 'visual' bell is the good ol' screen flash bell.
  359.  
  360.       The 'beep' bell generates a short tone.
  361.  
  362.       The 'speech' bell uses the narrator device to provide spoken
  363.       text for bell functions.  Note that the 'narrator.device' file
  364.       must be present in the "DEVS:" directory to use this option.
  365.  
  366.  "clear screen"
  367.       Clears the screen and homes the cursor. Provided as a convienience
  368.       feature.
  369.  
  370.  "reset session time"
  371.       Resets the session clock, which appears on the status line, back
  372.       to 00:00.  It will be automatically reset to 00:00 when you use
  373.       the Wtp dialer option.
  374.  
  375.  
  376.  THE 'DIALING' MENU:
  377.  
  378.  "(no title)"
  379.       This menu item displays the name you have assigned to the current
  380.       settings. Selecting this item allows you to change the name. If
  381.       a blank name is entered it is displayed as "(no title)". You can
  382.       use this to label the intended use for these settings like:
  383.       "Delphi via Uninet".
  384.  
  385.  "(no number)"
  386.       This item displays the current phone number string. This string
  387.       will be send to the (HAYES compatible) modem during dialing and
  388.       should be the actual phone number.  If no phone number has been
  389.       specified this item is displayed as "(no number)" and dialing
  390.  
  391.       functions are disabled.
  392.  
  393.  "auto-dial when loaded"
  394.       If this item is checked in a setting file then Wtp will automatically
  395.       dial the current phone number whenever the file is loaded. This
  396.       option is disabled if no phone number has been specified.
  397.  
  398.  "dial number now"
  399.       Initiates dialing of the current phone number. Will first hangup
  400.       the phone in case a call is already in progress and then will dial
  401.       the number.  Assumes the presence of a HAYES compatible external
  402.       modem on the serial port. The dialing string consists of:
  403.  
  404.   "ATDT <phone number string>"<CR>
  405.  
  406.       Note that this option will reset the session clock to 00:00.
  407.  
  408.  "hang up the phone"
  409.       Terminates the current phone call. Assumes a HAYES compatible
  410.  
  411.       modem on the serial port. The sequence sent is:
  412.  
  413.   <pause 3 seconds>
  414.   "+++"
  415.   <pause 3 seconds>
  416.   "ATH"<CR>
  417.   <pause 1 second>
  418.  
  419.  
  420.  --- NOTE TO VERSION 1 USERS CONVERTING "FixWtpLoadV1"
  421.  
  422.       Any settings files you've created with Wtp version 1 must be run
  423.  
  424.       through "FixWtpLoadV1" before you can load them with version 2.
  425.       This is a one time problem and future versions of Wtp will load
  426.       settings files created by older Wtp versions WITHOUT MODIFICATION.
  427.       The "FixWtpLoadV1" utility is invoked as follows (from the CLI):
  428.  
  429.   1> FixWtpLoadV1 <file> <file> ...
  430.  
  431.       Where <file> is the specification for a settings file created
  432.       with Wtp version 1. The "..." indicates that you can enter as
  433.       many file names as needed after the "FixWtpLoadV1" command,
  434.       for example:
  435.  
  436.   1> cd sys:wtp
  437.   1> FixWtpLoadV1 delphi.wtp compuserve.wtp
  438.  
  439.  
  440.  
  441.  --- THAT'S ALL FILK!
  442.  
  443.       Hopefully you have enough info to use and enjoy Wtp. If you have any
  444.       problems or suggestions for improvement just send me mail on Delphi
  445.       or Compuserve.  So long and lets make the Amiga the best machine
  446.       around!
  447.  
  448.       Dave Warker
  449.            Delphi: DAVEWARKER
  450.     Compuserve: 70406,626
  451.  
  452.  
  453.