home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / thesrc15.zip / overview < prev    next >
Text File  |  1993-08-15  |  4KB  |  91 lines
  1. /*man-start*********************************************************************
  2.                       THE - The Hessling Editor
  3.  
  4. OVERVIEW
  5. ========
  6.  
  7. THE is a text editor that uses both command line commands and key bindings
  8. to operate. It is intended to be similar to the VM/CMS System Product 
  9. Editor, XEDIT and to Mansfield Software's, KEDIT.
  10.  
  11. The screen display consists of several windows:
  12.    - a main body window which displays the contents of the file being
  13.      editted,
  14.    - a command line from which commands may be issued,
  15.    - an optional prefix window which shows line numbers and from
  16.      which prefix commands can be issued
  17.    - an id window which displays the file name, row/col etc. for the
  18.      current file and
  19.    - a status line which indicates global status info like number of files
  20.      being editted, time etc.
  21.  
  22. An important distinction must be made between what is called the current
  23. line and the focus line. The focus line is that line in the main body in
  24. which the cursor is displayed. All commands bound to function keys use the
  25. focus line as the initial line from which to begin executing the command.
  26. Commands issued from the command line use the current line as the starting
  27. line for execution of commands. The current line is the line in the main
  28. body that is highlighted; by default line 7.
  29.  
  30. To move between the command line and the main body the 'tabcmd' command is
  31. used. By default it is bound to the Home key (on PCs), the Do key
  32. (on vt220s) and F12 (on xterms). If you prefer the XEDIT feel for arrow
  33. keys, issue the 'set CMDArrow TAB TAB TAB' command from the command line.
  34.  
  35. To determine what keys are bound to what commands, type 'show' followed 
  36. by Return on the command line, then follow the directions displayed.
  37. Key bindings may be changed for the current session by using the 'define'
  38. command.
  39.  
  40. PROFILE FILE
  41. ============
  42.  
  43. Various session defaults may be changed on startup for an individual by
  44. using a profile file. This file contains various commands that set the
  45. current environment, including key bindings. This profile file can also be
  46. used to process commands in batch mode. For example, to change all
  47. occurrences of 'alligator' to 'crocodile' in the file file.ext in batch
  48. mode, a profile file (prf.prf) with the following commands would be used:
  49.  
  50.      'c/alligator/crocodile/ * *'
  51.      'file'
  52.  
  53. and the command
  54.  
  55.      the -p prf.prf file.ext
  56.  
  57. would be issued.
  58.  
  59. This changes the first string enclosed in delimiters (either /,\ or @) to
  60. the second string for every line (*) starting at the current line
  61. (0 initially) changing each occurrence on a line (*).
  62. Maybe you only want to change a string after the first line that contains
  63. the string 'donkey', but only change the second occurrence of that string.
  64. The profile commands would then be:
  65.  
  66.      '/donkey/'
  67.      'c/alligator/crocodile/ * 1 2'
  68.      'file'
  69.  
  70. The change command uses a 'target' specification as its first parameter
  71. after the string details. A target can be a number of lines, an absolute
  72. line number or a string.
  73. Number of line targets consist of either a positive integer, for
  74. referencing lines toward the end of the file, negative for referencing
  75. toward the start of the file or '*', which is all the remaining lines in
  76. the file or '-*' which is all lines toward the start of the file.
  77. An absolute line number in the form of ':n' is the line number in a file,
  78. starting with line number 1.
  79. A target is any string within the allowable target delimiters.
  80.  
  81. For more information on default key bindings see the *.hlp files. Detailed
  82. documentation of each command is present in each of the comm*.c files.
  83.  
  84. --------------------------------------------------------------------------
  85.  
  86.  
  87. ========================================================================
  88. COMMAND REFERENCE
  89. ========================================================================
  90. **man-end**********************************************************************/
  91.