home *** CD-ROM | disk | FTP | other *** search
/ The Fred Fish Collection 1.5 / ffcollection-1-5-1992-11.iso / ff_disks / 200-299 / ff291.lzh / GMC / english.docs / GMC.Doc < prev    next >
Text File  |  1989-12-12  |  8KB  |  268 lines
  1.  
  2.  
  3.                               -- GMC V4.0 --
  4.  
  5.  
  6.                Console Handler with command line editing and
  7.                            function key support
  8.  
  9.  
  10.  
  11.       GMC is an extension of the CON and the NEWCON handler respective-
  12.       ly. Compared  with NEWCON, GMC provides the  following additional
  13.       features:
  14.  
  15.          -  Extended command line editing
  16.  
  17.          -  Function key assignment in four levels
  18.  
  19.          -  Extended command line history
  20.  
  21.          -  Online help for functions of the handler
  22.  
  23.          -  Iconify function
  24.  
  25.  
  26.       These additional features and other differences are descripted in
  27.       the paragraphs below.
  28.  
  29.  
  30.  
  31.          Command line editing
  32.  
  33.  
  34.       Command line editing is supported by the following functions:
  35.  
  36.  
  37.          1. Delete functions:
  38.  
  39.             -  Delete character in front of the cursor (1)
  40.                Backspace
  41.  
  42.             -  Delete character under the the cursor (2)
  43.                Del
  44.  
  45.             -  Delete from cursor position to start of word (3)
  46.                Ctrl-Backspace
  47.  
  48.             -  Delete from cursor position to end of word (4)
  49.                Ctrl-Del
  50.  
  51.             -  Delete from cursor position to start of line (5)
  52.                Shift-Backspace
  53.  
  54.             -  Delete from cursor position to end of line (6)
  55.                Shift-Del
  56.  
  57.             -  Delete line (7)
  58.                Alt-Backspace, Alt-Del
  59.  
  60.  
  61.          2. Cursor movement:
  62.  
  63.             -  Character left/right (1/2)
  64.                <-- / -->
  65.  
  66.             -  Word left/right (3/4)
  67.                Ctrl <-- / -->
  68.  
  69.             -  Start/End of line (5/6)
  70.                Shift <-- / -->
  71.  
  72.  
  73.          3. Insert/Overstrike mode:
  74.  
  75.             The default mode (insert)  can be toggled only for the cur-
  76.             rent line or durable.  Toggle for the  current line is made
  77.             by  Ctrl-A. After  RETURN is pressed the  old mode is acti-
  78.             vated. To change the mode durable one must type
  79.  
  80.                set ins:<n>
  81.  
  82.             <n> = 1 stands for insert mode and <n> = 0 for overstrike.
  83.  
  84.  
  85.       In word movement and word delete, words are not only separated by
  86.       spaces but also by ':' '/' and '.'.  With this feature quick edi-
  87.       ting of pathnames is possible.
  88.  
  89.       The above listed  line edit functions  can be assign to different
  90.       keys. The list above is only the  default assignment. The numbers
  91.       in brackets refer to the belonging functions.
  92.  
  93.       The Backspace (bs), the Del (del), and  the cursor keys (cu_left/
  94.       cu_right) are set by the following statement:
  95.  
  96.          set <k><x>:<n>
  97.  
  98.       <k> is the abreviation of the key, <x> the key that must be pres-
  99.       sed at the same time:
  100.  
  101.          no key:    <x> = ''
  102.          Shift key: <x> = 's'
  103.          Ctrl key:  <x> = 'c'
  104.          Alt key:   <x> = 'a'
  105.  
  106.       <n> is the number of the function that shall be executed.
  107.  
  108.       Additional information of the set function see next paragraph.
  109.  
  110.  
  111.  
  112.          Function key assignment
  113.  
  114.  
  115.       All function keys can be assigned in four  levels (alone, or with
  116.       pressed Shift, Ctrl, or  Alt key).  The function keys can be  set
  117.       directly via the the keyboard or by write commands in the window.
  118.       For both methods the syntax is the same:
  119.  
  120.          set <x>f<n>:<string>
  121.  
  122.       <x> is  the key that  must be pressed at  the same time  with the
  123.       function key to  recall <string>.  <n> is the number of the func-
  124.       tion key.  If the last two  characters in  <string> are "\n"  the
  125.       line will be  execute immediately  when the function key is pres-
  126.       sed. Otherwise <string> will  be inserted in the  current command
  127.       line  independantly of the  insert/overstrike mode.  A ';' as the
  128.       last character  in <string> is  ignored when the  function key is
  129.       set. The  function keys can be set  separately by "echo"  or as a
  130.       whole  by "typing" a file  which  contains the  settings. The set
  131.       command will be  extracted from the  input or output  stream. The
  132.       function keys can be  switched on with "set fkeys:1" and off with
  133.       "set fkeys:0".  The settings  are not  touched by  switching  the
  134.       function keys on or off. By setting of one, the function keys are
  135.       automatically switched on.
  136.  
  137.  
  138.  
  139.          Command line history
  140.  
  141.  
  142.       All commands are  stored (up to 63 lines)  and can be recalled in
  143.       different  ways. The last typed line is stored at the end  of the
  144.       list. If the list is too long, the line at  the start of the list
  145.       is shifted out.
  146.  
  147.          -  With "cursor up/down"  the list will be  shown in direction
  148.             start/end of the list.
  149.  
  150.          -  With  Shift-"cursor up" the  list will be searched  through
  151.             line-wise on basis of the partial line as a  pattern given-
  152.             in up to this point in time.
  153.  
  154.          -  With Shift-"cursor down" a jump  behind the end of the list
  155.             will be performed .
  156.  
  157.          -  With !<n> the command with the number <n> (number since the
  158.             handler was started) will be recalled.
  159.  
  160.  
  161.  
  162.          Online help functions
  163.  
  164.  
  165.       The help key (alone of together with  Shift, Ctrl,  or Alt) shows
  166.       four different helps:
  167.  
  168.          -  Help
  169.  
  170.             Display of the functions  of the cursor keys, Backspace and
  171.             Del key, the command  line recall by  number, and the addi-
  172.             tional help functions.
  173.  
  174.  
  175.          -  Shift-Help
  176.  
  177.             Display of the  first characters  of the function key  set-
  178.             tings.
  179.  
  180.  
  181.          -  Ctrl-Help
  182.  
  183.             Output of information how to  set function keys and insert/
  184.             overstrike mode.
  185.  
  186.  
  187.          -  Alt-Help
  188.  
  189.             Display of the  command line history with numbers. The out-
  190.             put can be stopped  and continued  by pressing  any key. It
  191.             can be breaked by pressing RETURN.
  192.  
  193.  
  194.  
  195.       Like the function keys,  it is also possible  to switch the  help
  196.       key on or off:
  197.  
  198.          set help:1     Help key on
  199.  
  200.          set help:0     Help key off
  201.  
  202.  
  203.  
  204.          Iconify function
  205.  
  206.  
  207.       The Iconify function can be assigned to any function key:
  208.  
  209.          set <x>f<n>:ICONIFY     <x> and <n> see function keys
  210.  
  211.  
  212.       The Iconify  function clears the current  command line and is exe-
  213.       cuted  immediately.  The produced  small  window  can  be  shifted
  214.       around and  brought back to its old size by a double click. If the
  215.       window is in the  reduced size, no input and  output is  possible.
  216.       This means a task that  wants to make IO is waiting for the double
  217.       click. The keyword ICONIFY must be given in capitals.
  218.  
  219.  
  220.  
  221.          Others
  222.  
  223.  
  224.       The tabulator, the ESCAPE any Ctrl keys except Ctrl-A, Ctrl-C..F,
  225.       Ctrl-H, Ctrl-M, and Ctrl-\ have no function  and won't be sent to
  226.       the CLI or Shell.
  227.  
  228.       In RAW mode all keystrokes will be trnasmitted without any trans-
  229.       lation. In CON mode the four "Report" messages from the console.
  230.       device will also be passed through.
  231.  
  232.  
  233.  
  234.          Installation
  235.  
  236.  
  237.       "Mount GMC:" installs the handler.  Therefor the MountList in the
  238.       directory DEVS: must contain the entry listed below.  GMC-Handler
  239.       must be copied to  the directory L:.  "Mount GMC:" should  be in-
  240.       cluded in  the startup-sequence.  There are  several ways to  use
  241.       GMC: instead of CON:  or NEWCON:. NewCLI, NewShell, or AShell can
  242.       be patched  or GMC: must be  given on  start  (NewShell GMC:xxx).
  243.       Another possibility  is to replace GMC:  by NEWCON:  and  install
  244.       GMC: as NEWCON:. Then the patch or the window  specifications can
  245.       be omitted. The last possibility is to remove CON: by the the ARP
  246.       command "Assign CON: remove" and the installation of GMC: as CON:
  247.       with the  PD program "AssignDev CON: GMC:.  GMC: must  be mounted
  248.       already.
  249.  
  250.  
  251.  
  252.          MountList entry for GMC
  253.  
  254.  
  255.       GMC:
  256.                Handler = L:GMC-Handler
  257.                StackSize = 1500
  258.                Priority = 5
  259.                GlobVec = -1
  260.       #
  261.  
  262.  
  263.  
  264.          Acknowledgement
  265.  
  266.  
  267.       Special thanks to Volker Rudolph for tests and suggestions.
  268.