home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 083.lha / HandShake / Handshake.doc < prev    next >
Text File  |  1986-11-20  |  24KB  |  529 lines
  1. HandShake V1.50a Summary of Features.
  2.  
  3. If you want to see how this version of Handshake has changed from the
  4. previous versions please refer to the Version History section at the end
  5. of this document.
  6.  
  7. WHAT IS IT?
  8.  
  9. Handshake is a Full featured VT52/100/102 terminal emulator for those
  10. people who really need it. I have taken great pains to support the full
  11. VT102 spec. (VT102 is a superset of VT100).
  12.  
  13. Feel free to use and distribute this program as you like, as long as it is
  14. not for commercial use. If you like it, use it and want to see it get
  15. better, please send a contribution of $25.00 to the address listed in the
  16. program's "About.." requester. Commercial users are urged to contact the
  17. author. Please do not alter or rename the distribution ARC file in any
  18. way if you pass it along or post it on a bulletin board. The current
  19. Handshake distribution ARC file is called HDSK150a.arc. This way people
  20. can tell what version of Handshake is on a BBS.
  21.  
  22. WHAT IS IT NOT?
  23.  
  24. Handshake doesn't try to be an all round, general purpose, modem program
  25. which supports a multitude of transfer protocols, a script language, etc.
  26. There are plenty of good programs out there which fulfill this need.
  27. Several Handshake users however claim they use it for all their
  28. communications and that handshake does more than many programs that make
  29. greater claims.
  30.  
  31. WHAT IS THIS DOCUMENT?
  32.  
  33. This document is a quick description of the features of Handshake paying
  34. particular attention to the less obvious aspects of Handshake so that an
  35. experienced user will be able to use the program. This document assumes
  36. that the user has experience with terminal programs and the Amiga.
  37. Especially the Intuition user interface ( Menus, requesters, etc. )
  38.  
  39. WHAT IS THIS DOCUMENT NOT?
  40.  
  41. This is not full Handshake documentation!! That will be coming at a later
  42. date. If you are not familiar with terminal programs or the Amiga user
  43. interface, find a friend who is and ask him/her to help you.
  44.  
  45. WHAT DO YOU NEED TO RUN HANDSHAKE?
  46.  
  47. An Amiga with 256K or more. Version 1.2 of Kickstart and Workbench.
  48. THIS PROGRAM WILL NOT WORK WITH VERSION 1.1 OR EARLIER OF AMIGADOS.
  49. Hardware to connect to the other computer. This may consist of only a cable
  50. if you are locally wired, or a cable and a modem if you are accessing the
  51. other computer over the telephone. This program does work with memory
  52. expanded beyond 512K.
  53.  
  54. WHY SHOULD YOU USE HANDSHAKE?
  55.  
  56. If you have a requirement for FULL VT100/102 compatability and have not
  57. been satisfied by other programs which only do half the job, this is
  58. probably the program you have been looking for!
  59.  
  60. Here is a list of some of the features that Handshake offers:
  61.  
  62.     - Full 24 line display with title bar enabled! No more turning the
  63.       title bar on and off to see all 24 lines.
  64.  
  65.     - Full VT52 support. Every VT100 has a VT52 inside of it. So does
  66.       Handshake -- right down to the VT52 graphics character set.
  67.  
  68.     - VT102 Edit mode. Local insert and deletes.
  69.  
  70.     - Smooth or Jump scrolling.
  71.  
  72.     - Block or Underline see through reverse video cursor. Blinking or
  73.       non-blinking
  74.  
  75.     - Full VT100 Special Graphics Character Set.
  76.  
  77.     - Full double height and double width characters.
  78.  
  79.     - 132 character per line mode. It may be necessary to run preferences
  80.       and use the screen centering gadget a little to the left in order to
  81.       see the last few columns in 132 column mode.
  82.  
  83.     - Double height and width characters in 132 column mode.
  84.  
  85.     - All character modes. Normal, Bold, Reverse video, Underline and
  86.       Blinking in any combination.
  87.  
  88.     - Full keyboard support. This includes VT52 mode. Handshake handles the
  89.       escape sequences to turn auto repeat on and off and lock the
  90.       keyboard. No more run away cursors while in EDT under VMS etc.
  91.  
  92.     - ASCII file transfer mode with user definable end-of-line translation
  93.       for both sending and receiving. No more carriage returns in your
  94.       received files (unless you want them).
  95.  
  96.     - XMODEM, XMODEM/CRC, YMODEM and YMODEM Batch protocols for binary
  97.       files transfers.
  98.  
  99.     - Six user definable function keys.
  100.     
  101.     - Dialing Support with a 20 Phone number Directory. Optional auto
  102.       redialing is available. System characteristics ( baud rate, data
  103.       bits, parity, stop bits ) can be specified in the dialing directory
  104.       entry. Auto redial can be specified in the directory entry. This
  105.       dialing mode is geared to Hayes compatible modems, although the user
  106.       can specify the dialing prefix ( ATDP or ATE0DT, etc. ).
  107.  
  108.     - Fast! Using a 95K text file captured from a VAX which was then sent
  109.       to Handshake from a local microcomputer, Handshake maintained a
  110.       throughput of 875 characters per second. This means that Handshake
  111.       can take characters as fast as your host can send them at 7200 baud,
  112.       and still look good at 9600. A real VT100 can't keep up at 9600
  113.       baud either. You can use the shareware BLITZFONTS program to get even
  114.       better performance.
  115.       
  116.     - Complete Workbench integration. Handshake can be started from the
  117.       Workbench. As you save parameter files, icons are created. These icons
  118.       can be used to invoke Handshake later with the same paremeters. You
  119.       can even specify a host to dial immediately when the icon is invoked.
  120.       This feature can be turned off if you prefer the CLI and do not want
  121.       .info files cluttering up your disk.
  122.  
  123. WHAT DO YOU NEED TO KNOW ABOUT HANDSHAKE TO USE IT NOW?
  124.  
  125. The follwing things about Handshake are not obvious so you should
  126. familiarize yourself with this section.
  127.  
  128.     * READ THIS NOTE.
  129.     * Handshake uses a 660 pixel wide screen instead of the usual 640 pixels.
  130.     * This means that the Handshake extends 20 pixels further to the right
  131.     * Than most screens. It may not be possible to seew the screen depth
  132.     * arrangement gadgets at the right of the title bar or the last 3 or 4
  133.     * columns of test in 132 column mode unless you run preferences and move
  134.     * the screen centering gadget a little to the left!!
  135.  
  136. Command line.
  137.  
  138.     Handshake can be invoked from the CLI. The general form of the command
  139.     line is illustrated below (parts in square brackets are optional):
  140.  
  141.     Handshake [-p parameter_file_name] [destination_name]
  142.  
  143.     The parameter file name is the parameter file to be used, if none is
  144.     specified the default file Handshake.parms is used.
  145.  
  146.     The destination name is the name of the remote computer to be dialed.
  147.     This name must be one that appears in dialing directory of the
  148.     parameter file being used and must be spelled exactly the same way it
  149.     is spelled in the dialing directory entry (Case of characters is not
  150.     significant).
  151.  
  152.     If the name in the dialing diretory entry ends in a '*' or the Auto
  153.     Redial menu selection is set in the parameter file, Handshake will keep
  154.     dialing the number until a connection is made. If the name in the
  155.     dialing directory entry ends in a '*', do not include the '*' on the
  156.     command line when specifying the destination name.
  157.  
  158.     If this dialing directory entry appeared in the default file
  159.     Handshake.parms:
  160.  
  161.     555-1234:1200,8,n,1 Fred's BBS*
  162.  
  163.     The following command line coule be used to call this BBS.
  164.  
  165.     Handshake "Fred's BBS"
  166.  
  167.     Note that the '"'s are necessary in this case because the name of the
  168.     BBS has a space in it.
  169.  
  170.     Here is another example.
  171.  
  172.     Handshake -p universities.parms UCLA
  173.  
  174.     This would dial the phone number associated with the descriptor UCLA
  175.     in the parameter file universities.parms
  176.  
  177.     For a complete description of dialing directory entries, see the
  178.     discussion later in this section
  179.  
  180. Workbench.
  181.  
  182.    Handshake can also be invoked from the Workbench. There is an icon which
  183.    looks like a terminal. Invoking this icon will cause Handshake to be
  184.    invoked with the parameters from Handshake.parms, or if this file does
  185.    not exist Handshake will use it's built in parameters.
  186.    
  187.    In the project menu there is an item "Create Icons". if you set this to
  188.    "Yes" Handshake will create a telephone icon every time that you save
  189.    the parameters. While Handshake is saving the parameters it will also
  190.    prompt you for a dialing descriptor which if specified will be used as
  191.    the initial dialing destination when the icon is invoked.
  192.    
  193.    CLI users will probably want to keep the "Create Icons" option set to
  194.    "No" so that their disks will not be cluttered with un-necessary .info
  195.    files.
  196.  
  197. Keyboard.
  198.  
  199.     VT100 Keys                Amiga Keys
  200.     ----------                ----------
  201.     Arrow keys                Arrow keys
  202.     F1 through F4             F1 through F4
  203.     Keypad 0 through 9        Keypad 0 through 9
  204.     Keypad .                  Keypad .
  205.     Keypad -                  Keypad -
  206.     Keypad ,                  Help key              ** Watch for this **
  207.     Keypad Enter              Keypad Enter
  208.  
  209.     The Back space and Del keys can be reversed with a menu option.
  210.  
  211. User Definable Function Keys.
  212.  
  213.     The function keys F5 through F10 are now user definable keys. There
  214.     is now a new menu item in the Porject menu, the "Function keys" item.
  215.     Selecting this option will cause the Function Key Edit Requester to
  216.     appear. Just type in the strings that you want the fucntion keys to
  217.     transmit. When you are finished, just select the ALL DONE gadget.
  218.     
  219.     There are two other gadgets on the Function Key Edit Requester. These
  220.     allow the user to specify which characters in the transmit strings should
  221.     be used to represent the carriage return and line feed keys. The default
  222.     values are the '~' for carriage return and '`' for line feed. Please
  223.     note that inorder to change these charcters it is necessary to delete the
  224.     character which appears in the gadget before typing in the new one.
  225.     
  226.     The function key definitions are saved along with the phone directory
  227.     and other options the the selected Handshake parameter file.
  228.  
  229. File Transfers.
  230.  
  231.     The "Receive/Transmit CR/LF as ..." menu options are only applicable to
  232.     the ASCII file transfer modes. These can be used to translate end of
  233.     line characters when sending to the other system. For instance, when
  234.     sending to a VAX which is receiving with the CREATE command, you
  235.     will want to send a carriage return to the  VAX at the end of each
  236.     line. Amiga text files have no carriage returns in them so lines are
  237.     terminated with line feed characters. By selecting the Transmit LF as
  238.     CR option Handshake will do the conversion for you.
  239.  
  240.     
  241.     As of version 1.30b you no longer have to terminate ASCII Receive
  242.     (capture) mode in order to do a binary file transfer. Handshake
  243.     will automatically suspend cpature mode while the transfer is taking
  244.     place and will restart it  when the transfer has completed.
  245.     
  246.     If you use the XMODEM, XMODEM/CRC or single file YMODEM binary file
  247.     transfer mode, be aware that the received file will probably have to
  248.     be truncated. This is because all files received by XMODEM are a
  249.     multiple of 128 bytes long. AmigaDos does not like these extra bytes.
  250.     There are several good public domain utilities available to strip
  251.     these bytes off the end of the file (TAILRID, for one). If you send
  252.     your files in ARC format then this is not a problem.
  253.  
  254.     Handshake also supports the YMODEM Batch protocol. Using this protocol
  255.     lets you transfer multiple files in one trnasfer. Frees the receiving
  256.     user from the necessity of having to enter the name of the file
  257.     being received, and results files that have the same length as the 
  258.     original file (N need to chop extra bytes off the end of hte file).
  259.     Handshake does however ask the receiving user to specify the directory
  260.     path into which the received files should be placed. This directory
  261.     path MUST end in a ":" or a "/". Some exapmles of valid directory
  262.     paths are:
  263.     
  264.        df0:
  265.        df1:source/
  266.        source/
  267.        :source/
  268.        vd0:source/headers/
  269.        RAM:download_files/
  270.        my_files:               /* In this case my_files must be a vilume
  271.                                   name or have been assigned with the
  272.                                   assign command.
  273.                                */
  274.     If you do not specify a directory path the files will be placed in the
  275.     current directory.
  276.     
  277.     When sending with YMODEM Batch protocol you can specify a file name as
  278.     usual, or use wildcards as well. Here are some sample YMODEM Batch
  279.     send file specifications:
  280.     
  281.        df0:source/my_file.c
  282.        ram:#?
  283.        df1:source/headers/#?.h
  284.        
  285.     You get the idea. YMODEM Batch will transfer all the specified files
  286.     to the receiver. It will send the file names, and the file lengths as
  287.     well.
  288.     
  289.     
  290.     Handshake now supports the KERMIT file transfer protocol. It is used in
  291.     mush the same way as the YMODEM protocol which also supports multiple
  292.     file transfers. There are two KERMIT modes. KERMIT Binary and KERMIT
  293.     Text. Kermit Binary requires you to be connected with the other computer
  294.     with 8 data bits. It will not work with a seven bit connection. Perhaps
  295.     I will put in the binary escaping feature for the next release. KERMIT
  296.     Binary does image transfers, the received or sent file is bit for bit
  297.     identical with the original. Kermit Text is used for text files, and
  298.     will work with either a 7 bit or 8 bit connection. It should be used
  299.     for text files only.
  300.     
  301.     For the binary transfers and for the ASCII Send, Handshake pops up
  302.     two windows, one in its own screen and one in the workbench screen.
  303.     These windows provide information on the progress of the transfer.
  304.     The one in the Handshake screen can be used to abort the transfer
  305.     just by clicking on the close gadget in the upper left hand corner.
  306.     The window in the Workbench screen is provided so that during a long
  307.     file transfer you can use your multi-tasking Amiga to do other things
  308.     and not have to keep flipping back to handshake to see if the transfer
  309.     has completed.
  310.     
  311.     If you have the Audio Bell option enabled, You will hear a rising
  312.     sequence of notes for a successfull file transfer, and a falling
  313.     sequence of notes for an unsuccessfull file transfer.
  314.  
  315.  
  316. Dialing the Phone.
  317.  
  318.     In order to dial a number from the dialing directory ( Menu option 
  319.     "Dial Phone" ), click using the mouse on the small square gadget
  320.     immediately to the left of the number that you want to dial. Clicking
  321.     on the text of the number allows you to edit the entry, but not to
  322.     dial it.
  323.  
  324.     The dialing directory is saved to disk whenever you save the parameters
  325.     It is possible to have several diailing directories by using different
  326.     parameter files.
  327.     
  328.     Whenever Handshake goes into auto-dialing mode, it pops up a pair of
  329.     windows much like in file transfer mode to keep you informed of progress.
  330.     See the description in the file transfer section above.
  331.     
  332.     If the Audio bell feature is enabled, you will hear a four note
  333.     sequence to indicate that the connection has been completed.
  334.  
  335. Format of dialing directory entries.
  336.  
  337.     A dialing directory entry has the following general format. The parts
  338.     in the square brackets are optional. The * at the end of the line is
  339.     used to indicate auto redialing.
  340.  
  341.     telephone_number[:baudrate[,data_bits[,parity[,stop_bits]]]] [desc][*]
  342.  
  343.     Below are some sample dialing directory entries:
  344.  
  345.     123-4567                                      Simplest case. Dial the
  346.                                                   number using the current
  347.                                                   serial parameters.
  348.  
  349.     123-4567 Joe's BBS                            Same as above with a
  350.                                                   description.
  351.  
  352.     123-4567 *                                    Both of these will dial
  353.     123-4567 Joe's BBS*                           Until the other system
  354.                                                   Answers.
  355.  
  356.     123-4567:1200                                 Call the number changing
  357.                                                   baud rate to 1200 if
  358.                                                   necessary.
  359.  
  360.     123-4567:1200,8,n,1 Joe's BBS*                A biggie. Call Joe's
  361.                                                   until it answers using
  362.                                                   1200 baud, 8 data bits,
  363.                                                   no parity and 1 stop
  364.                                                   bit.
  365.  
  366. Interlace.
  367.  
  368.     The Half screen interlace mode is intended to give you a full 24 line
  369.     VT100 Emulation in half a screen. This leaves you the other half to do
  370.     whatever you like, and still watch your terminal screen.
  371.  
  372.     The full screen interlace mode is useful in 132 column mode.
  373.     Readability of characters in interlaced mode may depend on your
  374.     selection of colors. (I find that black characters on a gray
  375.     background look just super ).
  376.  
  377.  
  378. WHAT PROBLEMS ARE THERE WITH HANDSHAKE?
  379.  
  380. Nothing that I currently Know of. However you may find that you can not see
  381. the last two or three columns of 132 column mode. If this happens to you,
  382. run Preferences and move the screen centering gadget to the left a bit.
  383. This should fix the problem.
  384.  
  385. WHO DO YOU CALL WITH PROBLEMS, SUGGESTIONS, MAKE CONTRIBUTIONS TO ETC?
  386.  
  387. Me!
  388.     Eric Haberfellner,
  389.     57 Marble Arch Crescent
  390.     Scarborough, Ontario
  391.     CANADA
  392.     M1R 1W8
  393.  
  394.     Phone (416) 757-1055 ( After Six P.M. EST please ).
  395.  
  396.     I am on BIX as ehaberfellner.
  397.  
  398.  
  399. HANDSHAKE VERSION HISTORY
  400.  
  401. Version 1.50a
  402.      - Added user definable function keys. keys F5 through F10 are now
  403.        available as user definable keys. See the documentation above.
  404.      - Kermit File transfer protocol added. See documentation above.
  405.      - Some characters were getting lost after file transfers. this is now
  406.        fixed.
  407.  
  408. Version 1.42a
  409.  
  410.      - Fixed the horrid "Beep forever" bug.
  411.      - Fixed the rename command in EXEC_ME for Handshake.rev.
  412.  
  413. Version 1.41a
  414.      - Fixed bug in YMODEM Batch protocol. It would work with another Amiga
  415.        running Handshake, but not with any other YMODEM Batch
  416.        imp[lementations.
  417.  
  418. Version 1.40a
  419.      - Fixed the horrible dialing bug which appeared in v1.30b. Boy am I
  420.        embarassed. Dialing would not work unless AUTO REDIAL was selected.
  421.      - AmigaDos requesters now appear in the Handshake screen instead of
  422.        popping the Workbench screen to the front. Big improvement.
  423.      - YMODEM and YMODEM Batch file transfer protocols are here. See the
  424.        File transfer section of this document and the Binary Protocol
  425.        item of the TRANSFER menu.
  426.      - Added a bell. Handshake now beeps upon receipt of a BEL character.
  427.        Handshake also now gived an audio indication of file transfer
  428.        completion and connection in auto redial mode. The user can
  429.        select audio bell, visual bell, both or none. See the new Bell Type
  430.        item in the TERMINAL menu.
  431.      - Added the VT100 Margin bell feature. See the new Margin Bell
  432.        item in the TERMINALcmenu.
  433.      - Added a blinking/non-blinking option for the cursor. If you are
  434.        using a parameter file from a previous version of Handshake,
  435.        the cursor will not blink initially. Go to the Cursor item of the
  436.        TERMINAL menu and select blinking. Now save your parameters. From
  437.        now on the cursor will blink again when you start Handshake.
  438.      - Speeded up CRC calculation for file transfers.
  439.      - Fixed a minor bug which caused XMODEM sends to always show 1 error
  440.        even there had not been one. This did not affect the transfer.
  441.      - Fixed a bug which sometimes caused inproper font selection after
  442.        going into VT52 mode and back out again.
  443.      - Fixed bug in UK Character set support.
  444.      - Speeded up CRC calculation for file transfers. I am now doing
  445.        bytewise instead of bitwise CRC calculation.
  446. Version 1.30b
  447.     - Replaced the abort requesters with windows. The windows are used to
  448.       provide progress  information about file transfers and auto-dialing
  449.       as well as serving as abort devices. To abort a file transfer or
  450.       auto-dialing just click on the close gadget of the window in the
  451.       handshake screen.
  452.     - The windows described above are also duplicated on the Workbench
  453.       screen. This is so that you can do other things while a large file
  454.       transfer is in progress and not have to keep flipping back to
  455.       Handshake to see if it is finished yet. Same for auto-dialing.
  456.     - Relinked with a "tiny" _main.o so that the lattice standard input/
  457.       output window no longer pops up in the workbench screen.
  458.     - Capture mode (ASCII Receive) can now remain active during binary
  459.       file transfers. Handshake will suspend it until the transfer is
  460.       over and then start it up again.
  461.     - Added XMODEM/CRC file transfer mode.
  462.  
  463. Version 1.21a
  464.     - Local echo mode did not work properly. This has been fixed.
  465.     - Reseting the terminal would sometimes leave a double cursor on the
  466.     - Screen. This has been fixed.
  467.     
  468. Version 1.20a
  469.  
  470.     - Improved Workbench interface. Handshake will now optionally create
  471.       create Telephone icons for saved parameter files. This allows the
  472.       user to select which paramter file to use from the Workbench. The
  473.       icons can also be created in such a way that Handshake will
  474.       automatically start dialing a specified number when it is invoked
  475.       with that icon.
  476.     - Fixed a bug which caused XMODEM transmits to sometimes hang.
  477.     - Changed autodialing support so that it now works with modems that
  478.       report status while they are dialing (Like the Volksmodem 1200).
  479.     - Dialing destinations which contained spaces on the command line did
  480.       not work, even when enclosed in quotes. This has been fixed.
  481.     - Selecting the Reset Terminal option from the menu or typing Amiga-V
  482.       would cause two cursors to appear on the screen. This has been fixed.
  483.  
  484. Version 1.10a
  485.  
  486.     - At last, a real 132 columns instead of 128.
  487.     - Added some intelligence to the routines that display the cursor. This
  488.       yielded a 35% performance improvement. Handshake now has an average
  489.       throughput of about 875 characters per second.
  490.     - Cleaned up parsing of command line parameters especially the dialing
  491.       directory entry.
  492.     - Put error checking into reading of parameter files. If the file does
  493.       not exist or is of the wrong size put up a requester advising the
  494.       user. If the default file Handshake.parms cannot be found do not
  495.       annoy the user with a requester (use the built in defaults).
  496.     - The command line dialing direcotry entry is now case insensitive.
  497.     - Added some register variables in several places. Handshake is now
  498.       about six percent faster because of this.
  499.     - Fixed a bug which caused the line attribute for the bottom line to
  500.       not be reset when the screen was cleared.
  501.     - Fixed a hideous bug which caused the input subtask to lock up
  502.       sometimes. This would appear to the user as a blank title bar. This
  503.       would only happen if the user interface task sent a "go to sleep"
  504.       message to the serial input task at the same instant that an IO
  505.       completed, therefore this was more likely to happen at higher baud
  506.       rates. Sorry about that one.
  507. Version 1.02a ( not released to the public at large ).
  508.     - Added command line parameters to specify parameter file to use, and
  509.       to allow the user to specify a remote computer to dial from the
  510.       command line.
  511.     - Added 20 second dialing timeout to the dial timeout menu.
  512.     - In order to abort redialing it was sometimes necessary to select the
  513.       abort requester more than once. This is now fixed.
  514.     - Moved File transfer and redialing abort requester to upper right
  515.       portion of screen.
  516.     - General cleanup of the file transfer code. Receiveing to disk is now
  517.       much faster. Transfer aborts now work porperly at high baud rates.
  518.  
  519. Version 1.01a
  520.     - Auto redialing added.
  521.     - Pulse/Dial menu option replaced with user definable dialing string.
  522.     - Added menu item to allow user to specify backspace & del key
  523.       operation.
  524.     - Fixed bug which caused menus to not be updated after a reset if
  525.       no parameter file was present.
  526.  
  527. Version 1.00a
  528.     - Handshake Unleashed on an unsuspecting public. An historic Moment!
  529.