home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / c / comlink / Manual / TermInstr
Text File  |  1993-11-07  |  35KB  |  801 lines
  1. ComLink Terminal Mode - Instructions
  2. ------------------------------------
  3.  
  4. Introduction
  5. ============
  6.  
  7. The ComLink program has a terminal mode which has been designed specifically
  8. for packet radio, it allows the user to directly communicate with the TNC
  9. (Terminal Node Controller) via the serial port. ComLink can also run special
  10. script programs, a separate manual describes this feature, you will find
  11. this is the "Script_Man" directory.
  12.  
  13. !ComLink has been carefully written to multi-task effectively. In particular
  14. ARM code is used to speed scrolling of received text. !ComLink is compatible
  15. with RISCOS version 2 and 3.
  16.  
  17. Terminal mode
  18. =============
  19.  
  20. The terminal mode operates under RISCOS within the desktop environment and
  21. is fully multitasking.
  22.  
  23. Facilities incorporated include:-
  24.  
  25.      * A split terminal window with separate tx and rx sections.
  26.      * A configurable number of lines for the rx window.
  27.      * Auto adjustment of rx line count to optimise memory use.
  28.      * 1 to 7 lines (user defined) for outgoing text (tx lines).
  29.      * Full cursor editing of all tx lines.
  30.      * 50 line scrollback facillity in the tx window.
  31.      * Edit and re-send of tx lines.
  32.      * Edit and send of lines from the rx window.
  33.      * Word/number/callsign 'grab' from the rx window.
  34.      * Auto-wrap option to automatically insert "Return" on tx.
  35.      * "Tx + rx" in view or "rx only" on pressing the mouse "Adjust" button.
  36.      * Auto adjustment Tx line count on pressing the mouse "Adjust" button.
  37.      * Programmable function keys with save/load/clear options.
  38.      * On screen "WimpKeys" to run scripts and send commands/text to TNC.
  39.      * Function/wimp key definitions fully editable within windows.
  40.      * Automatic control code insertion when editing function/wimp keys.
  41.      * System variables, such as sys$time, allowed in function/wimp keys.
  42.      * Mouse/icon based upload/download with simple "file dragging".
  43.      * Simultaneous file upload, download and rx buffer save.
  44.      * Optional appending of a fn key definition to end of upload files.
  45.      * Control code "filter" option on download files.
  46.      * Save buffer option to save all rx text in the terminal window.
  47.      * Suspend download option.
  48.      * Abort upload option.
  49.      * Append option, allows download data to be appended to existing files.
  50.      * File dragging to/from other RISCOS applications, eg !Edit.
  51.      * Data transfer statistics displays showing:-
  52.                                                   Spool file size.
  53.                                                   Upload file size.
  54.                                                   Percent sent.
  55.      * Connect alert via serial "Ring Indicator" line.
  56.      * A script can be executed automatically on running !ComLink.
  57.      * User definable colours for the terminal window.
  58.      * ARM code for speed and effective multi-tasking
  59.      * Single line scrolling to give a smoother scroll effect.
  60.  
  61. Getting up and running
  62. ======================
  63.  
  64. ComLink is installed on the icon bar by the usual method of double clicking
  65. on the !ComLink icon in the filer window, this will cause the ComLink icon
  66. to appear on the icon bar at the bottom of the screen.
  67.  
  68. Note that before you can use this terminal program you may need to change
  69. the serial control parameters, these can be viewed and changed with the
  70. "Config" option in the menu, this is described below.
  71.  
  72. The keyboard "Scroll Lock"  MUST be "off" for recieved text to appear in the
  73. terminal window.
  74.  
  75. Click the left (select) mouse button on the !ComLink icon on the icon bar to
  76. display the terminal window. This is described later.
  77.  
  78. Click the right (adjust) mouse button on the !ComLink icon on the icon bar to
  79. display the wimpkey window.
  80.  
  81.  
  82.                               The menu
  83.                               ========
  84.  
  85. Pressing the mouse menu (middle) button with the pointer over the ComLink
  86. icon on the icon bar will pop up a menu with the following options:-
  87.  
  88. Info     =>
  89. WimpKeys =>
  90. Fn Keys  =>
  91. Script   =>
  92. Config
  93. Quit
  94.  
  95.  
  96. Info
  97. ----
  98.  
  99.     Following the Info arrow will pop up the usual "About this program"
  100.     window. The only useful information here is the version number!
  101.  
  102.  
  103. WimpKeys
  104. --------
  105.  
  106.     Following the arrow will provide the following sub-menu:
  107.  
  108.       Display
  109.       Edit
  110.  
  111.     Selection of "Display" will pop up the WimpKey window. Wimpkeys are sort
  112.     of "on screen" function keys. There are two sets of keys in the window
  113.     which have different functions these consist of 8 yellow wimpkeys and 8
  114.     white ones, there are also some control icons.
  115.  
  116.     Selection of "Edit" displays the WimpKey edit window, this allows the
  117.     action and content of the WimpKeys to be defined.
  118.  
  119.     Wimpkeys provide a significant enhancement to the operation of !ComLink,
  120.     in particular, they make operation on "HF" a doddle!
  121.  
  122.     Further details can be found later on in these instructions.
  123.  
  124. Fn Keys
  125. -------
  126.  
  127.     Following the "Fn Keys" menu arrow pops up a sub_menu containing the
  128.     following options:
  129.  
  130.       All sets
  131.       Normal
  132.       Shift+Fn
  133.       Ctrl+Fn
  134.  
  135.     The "All sets" option pops up 3 stacked windows to allow the editing of
  136.     the red function (Fn) key definitions. Use the mouse to position the
  137.     cursor in the window to edit the chosen key.
  138.  
  139.     The remaining three options "Normal", "Shift+Fn" and "Ctrl+Fn" allows
  140.     individual function key edit windows to be popped up.
  141.  
  142.     The default key set is saved in the file Fkey within the ComLink
  143.     application, you may edit this by dragging to !Edit or by saving the new
  144.     definitions by selecting "Save" in any of the function key windows and
  145.     then dragging the file.
  146.  
  147.     Note the format of the file if you are going to use !Edit:-
  148.  
  149.       NFx: means normal fn key x
  150.       SFx: means shift + fn key x
  151.       CFx: means control + fn key x
  152.  
  153.     Not all the definitions need to be included in the file, in this case
  154.     only the ones included will be set up.
  155.  
  156.     The function key definitions can contain system variables in {}
  157.     brackets, eg {sys$time}, {sys$date}, {sys$year} etc. Make sure you get
  158.     the name of the system variable right, otherwise an error will be
  159.     generated! Control codes are automatically inserted as decimal numbers
  160.     in [] brackets, when you press the appropriate keys, eg [13] is the code
  161.     for "Return" and if you press Ctrl+C then [3] will be inserted.
  162.  
  163.     !ComLink provides four new system variables:-
  164.  
  165.     {real$time} which is a copy of time from the CMOS clock chip and not
  166.     from the software copy (which runs slow). The time will be in the format
  167.     "23:15:45".
  168.  
  169.     {full$date} the format is "Saturday 25th July 1992", so the {sys$date}
  170.     and {sys$year} variables can both be replaced by one variable.
  171.  
  172.     Further system variables which may be used are provided by the
  173.     !TimeUtils application within the !Comlink application itself. A help
  174.     file if included within !TimeUtils, this provides details of the
  175.     variables and how to customise the time and data formats.
  176.  
  177.    When a function key is pressed the system variable will be converted to
  178.    the appropriate text string. Control codes will show in the tx window in
  179.    brackets but will be sent correctly to the TNC as the code.
  180.  
  181.    !ComLink function key definitions have a special filetype &56D, double
  182.    clicking these files will automatically load them into ComLink, the key
  183.    definitions are then available for immediate use.
  184.  
  185.  
  186. Script
  187. ------
  188.  
  189.     Following this menu option leads to a sub-menu containing:
  190.  
  191.       Status
  192.       Run
  193.       Stop
  194.  
  195.     "Status" This option pops up a status window as part of the script
  196.     facility. This is described in "Script_Man" the script programming
  197.     manual.
  198.  
  199.     "Run" This option runs the default script called "SCRIPT" saved within
  200.     the !ComLink application.
  201.  
  202.     "Stop" Selecting this option, aborts any script that is currently being
  203.     run. This is described in "Script_Man", the script programming manual.
  204.  
  205.  
  206. Config
  207. ------
  208.  
  209.     Select this option to setup and save the program configuration, the
  210.     serial parameters must be setup to suit your system. The remaining ones
  211.     can be set to your own preferences. Changes to these parameters have an
  212.     immediate effect, excep