home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 8 Other / 08-Other.zip / CLE_OS2.ZIP / CLE.TXT < prev    next >
Text File  |  1988-06-26  |  12KB  |  345 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                       CLE
  22.  
  23.                                   Users' Guide
  24.  
  25.  
  26.  
  27.                           Peter Coates and Associates
  28.                                    Whincroft
  29.                             Upper Colquhoun Street
  30.                                   Helensburgh
  31.                                     G84 9AQ
  32.  
  33.                                 1801 Rainbow Av
  34.                                     Laramie
  35.                                     WY 82070
  36.                                      U S A
  37.  
  38.  
  39.                                Telephone Number
  40.  
  41.                                 (+44) 436 78764
  42.  
  43.                                 CLE Users Guide
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                    Contents
  62.  
  63.  
  64.  
  65.                Introduction                               Page 1
  66.  
  67.                Keystrokes                                 Page 2
  68.  
  69.                Modes                                      Page 2
  70.  
  71.                More About History                         Page 2
  72.  
  73.                Line Length, Tabs and Control Characters   Page 3
  74.  
  75.                Examples                                   Page 3
  76.  
  77.                Installation                               Page 4
  78.  
  79.  
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.         CLE is Shareware.    That is,  there is  no obligation  to pay
  89.         anything for it.  On the other hand, if you use it and find it
  90.         useful  you  might  feel better  if  you made  a contribution.
  91.         Rather  like   supporting   your  Public  Television  station. 
  92.         A contribution of $40 or £25 is suggested.
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.                                       -i-
  104.  
  105.                                 CLE Users Guide
  106.  
  107.  
  108.  
  109.         Introduction
  110.  
  111.                CLE  (Command Line Editor for OS/2) is utility for OS/2
  112.         which allows  more natural recall  and editing of command than
  113.         using the indigenous F1 - F6 key stroke editing.
  114.                The way  command line  editing  works  with CLE is more
  115.         like the way you edit  a document using DisplayWrite or  other
  116.         word  processor.    The   keystrokes  used   are   Left Arrow,
  117.         Right Arrow, Ctl Left Arrow, Ctl Right Arrow, Home, End,  Ins,
  118.         Del, Backspace, Ctl End, Esc.
  119.                CLE   remembers  a  substantial   number  of   previous
  120.         commands, the exact number depending on how long they are, but
  121.         typically dozens, and you can recall and see them by scrolling
  122.         up or  down through  them using  the Up Arrow  and  Down Arrow
  123.         keys.  It  is  even possible  to  recall commands  by  initial
  124.         letter.  Pressing F1  followed by  a letter  recalls the  most
  125.         recent command issued  that started with  that letter.   CLEOS
  126.         remains in  History mode,  indicated by  a full-block  cursor,
  127.         until F2  is  pressed  or  until  CLE  can't  find  a  command
  128.         starting with  the character  given.  Thus  the sequence  F1 d
  129.         recalls the last  command starting with  d.  Pressing d  again
  130.         recalls the one before that, and so on.
  131.                The other  function  keys F3  to  F12, and  the  shift,
  132.         control and Alt  function keys  can have  strings assigned  to
  133.         them so that pressing F3, for instance, could be equivalent to
  134.         typing "dir/w *.doc".
  135.  
  136.         Invoking CLE
  137.  
  138.                CLE is invoked by typing the command
  139.                       [C:\] cle fn="string" ...
  140.         where fn  is the  name of  a function  key and  string is  the
  141.         string it is to  represent.  Fn may  be any of  f3 to f12  for
  142.         function keys 3 to 12, s1 to s12 for shift F1 to shift F12, c1
  143.         to c12 for control F1 to control F12, or a1 to a12 for  alt F1
  144.         to alt f12.   Case  is not  significant  in the  name  of  the
  145.         function key.  That is f4 is equivalent to F4.  The string  to
  146.         go behind the function  key may be up  to 15 characters  long,
  147.         and may  contain spaces  and  tabs.  If  the string  does  not
  148.         contain spaces  or  tabs, then  it  need not  be  enclosed  in
  149.         quotes.
  150.                The strings represented by function keys may be  added,
  151.         changed or removed at any time  after CLE  has been invoked by
  152.         reissuing the  CLE command  with new  parameters.  To  stop  a
  153.         function key  representing  a  string simply  specify  a  zero
  154.         length string.   For  example  the  following  command  causes
  155.         further uses of F5 to have no effect:
  156.                       [C:\] cle F5=
  157.                The assignment of strings to function keys is global to
  158.         all sessions which are using CLE.
  159.                CLE cannot be  removed from a  session without  closing
  160.         the session using the EXIT command and restarting it using the
  161.         Program Selector.
  162.  
  163.  
  164.                                       -1-
  165.  
  166.                                 CLE Users Guide
  167.  
  168.  
  169.  
  170.         Keystrokes
  171.         Cursor movement commands
  172.         ■      Left Arrow moves the cursor left one character position
  173.                without deleting.
  174.         ■      Right Arrow  moves  the  cursor  right  one   character
  175.                position.
  176.         ■      Ctl Left Arrow moves the cursor  left to the  beginning
  177.                of the previous word.
  178.         ■      Ctl Right Arrow  moves  the   cursor  forward  to   the
  179.                beginning of the next word.
  180.         ■      Home moves the cursor to beginning of the command line.
  181.         ■      End moves the cursor to the end of the command line.
  182.  
  183.         Editing Commands
  184.         ■      Insert puts you in insert mode if you are currently  in
  185.                replace mode and vice versa.  Insert mode is  indicated
  186.                by a half-block  cursor, replace mode  by an  underline
  187.                cursor.
  188.         ■      Back Space deletes the previous character, that is  the
  189.                character immediately to the left of the cursor.
  190.         ■      Delete deletes the character the cursor is on.
  191.         ■      Ctl End deletes all text to the right of the cursor.
  192.         ■      Esc deletes the whole of the current input line.
  193.  
  194.         History Commands
  195.         ■      Up Arrow scroll up one command.
  196.         ■      Down Arrow scroll down one command.
  197.         ■      F1 enters  history mode  to recall  by initial  letter.
  198.                History mode is indicated by a full-block cursor,
  199.         ■      F2 reverts to normal editing mode.
  200.  
  201.         Modes
  202.  
  203.         ■      Replace mode is indicated  by an underline cursor.   In
  204.                replace mode a character  typed replaces the  character
  205.                under the cursor.
  206.         ■      Insert mode is  indicated by a  half-block cursor.   In
  207.                insert mode characters typed push existing text to  the
  208.                right to make room for the new characters.
  209.         ■      History mode is indicated  by a full-block cursor.   In
  210.                history mode  characters  typed  are  used  as  initial
  211.                letters to search for commands in the history.
  212.  
  213.         More About History
  214.                CLE does not only remember the command  history for the
  215.         command line processor, but also will remember  lines typed in
  216.         for other programs.  Any program that accepts lines of text as
  217.         input,  as opposed to single  characters,  will gain from this
  218.         history facility.  Programs which  read single characters  and
  219.         act    on    them    straight    away    will    not     gain.
  220.         What-you-see-is-what-you-get (WYSIWYG)  word  processors  will
  221.         not gain.  The program histories will not be recalled when  in
  222.         the command prompt as the remembered command lines are  tagged
  223.         with a program identifier.
  224.  
  225.                                       -2-
  226.  
  227.                                 CLE Users Guide
  228.  
  229.  
  230.  
  231.         Line Length, Tabs and Control Characters
  232.                A command line can be up to 127 characters long.   This
  233.         can include  tabs  and  other control  characters.   Tabs  are
  234.         expanded to  display  as spaces,  but  are treated  as  single
  235.         characters for editing purposes.  Other control characters are
  236.         displayed as  a  pair of  characters,  for instance  Ctl B  is
  237.         displayed as ^B.  Again this is treated as a single  character
  238.         for editing.   As input  lines can  be 255  characters long  a
  239.         single input line  can take  up several  screen lines.   Input
  240.         lines are wrapped around at the edge of the screen.  The  best
  241.         thing to  do is  to ignore  the line  wrapping as  it  doesn't
  242.         affect the  content of  the command.   The editing  keystrokes
  243.         such as Left Arrow,  Right Arrow, Backspace,  etc. work  quite
  244.         happily over the edge of the screen.
  245.  
  246.         Examples
  247.                Suppose you want to see the directory information for a
  248.         file named media.pln.  To get this information you could  type
  249.         the following command:
  250.                       [C:\] dir media.pln
  251.         This command (dir media.pln) is  also saved as the last  entry
  252.         in the command history.   If you want  to repeat the  command,
  253.         just press two keys: Up Arrow and Enter.
  254.         CLEOS displays the  repeated command  on the  screen when  you
  255.         press Up Arrow as shown below
  256.  
  257.                       [C:\] dir media.pln_
  258.         Note that  the  underline  is your  cursor.   When  you  press
  259.         Up Arrow,  CLE  copies the  last entry in  the history to  the
  260.         command line; pressing  Enter then sends  the command line  to
  261.         the command processor for execution,  and makes a new  history
  262.         entry.
  263.                If  you  want  to  display  information  about  a  file
  264.         media.tpl, you can use the history.  Press Up Arrow as  before
  265.         to copy the history  entry to the command  line.  You can  now
  266.         edit the line:
  267.         Press Backspace
  268.                       [C:\] dir media.pl_
  269.         Press Back Arrow
  270.                       [C:\] dir media.p_l
  271.         Press Back Arrow
  272.                       [C:\] dir media._pl
  273.         Press Ins
  274.                       Note that the cursor is a half block
  275.                       [C:\] dir media.■pl
  276.         Press t
  277.                       [C:\] dir media.t■pl
  278.         Now you can press Enter to run the command.  The command  line
  279.         (dir media.tpl) is now the last entry in the history.
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.                                       -3-
  287.  
  288.                                 CLE Users Guide
  289.  
  290.  
  291.  
  292.                Now, assume that you want to run the following command:
  293.                       [C:\] type media.tpl
  294.         To do this, you want to recall the last history entry and edit
  295.         it again:
  296.         Press Up Arrow
  297.                       [C:\] dir media.tpl_
  298.         Press Home
  299.                       [C:\] _dir media.tpl
  300.         Press t y p
  301.                       [C:\] typ_media.tpl
  302.         Press Ins e
  303.                       [C:\] type■media.tpl
  304.         Then press Enter to run the command.
  305.  
  306.  
  307.         Installation
  308.                CLE  consists of two files,   CLE.EXE  and  CLEDIT.DLL.
  309.         CLE.EXE need to be put  into a directory  on your  search path
  310.         (see the PATH  command).    CLEDIT.DLL must be on your libpath
  311.         (see the LIBPATH statement in CONFIG.SYS).
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334.  
  335.  
  336.  
  337.  
  338.  
  339.  
  340.  
  341.  
  342.  
  343.  
  344.                                       -4-
  345.