home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / the25.zip / thesrc251.zip / overview < prev    next >
Text File  |  1998-05-06  |  5KB  |  122 lines
  1. /*man-start*********************************************************************
  2.                       THE - The Hessling Editor
  3.                             Version 2.5
  4.  
  5. ========================================================================
  6. INTRODUCTION
  7. ========================================================================
  8.  
  9. THE is a text editor that uses both command line commands and key bindings
  10. to operate. It is intended to be similar to the VM/CMS System Product 
  11. Editor, XEDIT and to KEDIT from Mansfield Software.
  12.  
  13. THE was originally written to be used by people already familiar with the 
  14. above editors. For this reason, this document provides limited information 
  15. on using THE, and concentrates more on reference material, such as command
  16. syntax and configuration.
  17.  
  18. ========================================================================
  19. THE BASICS
  20. ========================================================================
  21.  
  22. The default screen displayed when THE starts consists of several areas:
  23.  
  24. - a window which displays the contents of the file being editted. This is
  25.   the <filearea>,
  26. - a <command line> from which commands may be issued,
  27. - a <prefix area> which shows line numbers and from which prefix commands
  28.   can be issued
  29. - an <idline> which displays the file name, row/col etc. for the current 
  30.   file and
  31. - a <status line> which indicates global status info like number of files
  32.   being editted, time etc.
  33.  
  34. When THE starts, the cursor is positioned on the <command line>. To move 
  35. between the <command line> and the <filearea>, the <CURSOR> HOME command is
  36. used. By default this command is bound to the HOME key (under DOS and OS/2),
  37. the DO key (on vt220s) and HOME (on xterms).
  38.  
  39. To execute commands from the <command line> simply type the command and
  40. press the ENTER (or RETURN) key.
  41.  
  42. To determine what keys are bound to what commands, execute the <SHOWKEY>
  43. command from the <command line>. As you press each key, THE will respond
  44. with the name of the key and any commands bound to that key.  To exit from
  45. the <SHOWKEY> command, press the spacebar.
  46.  
  47. Key bindings may be changed for the current session by using the <DEFINE>
  48. command.  To keep key bindings between sessions, the <DEFINE> commands can
  49. be placed in a <profile> file, which is executed each time THE starts. For
  50. more information on this, see the next section; PROFILE FILE.
  51.  
  52. It is possible to make THE look and behave more like either XEDIT or KEDIT.
  53. See the <SET COMPAT> command for further information.
  54.  
  55. As mentioned before, this document provides little tutorial information. For
  56. those users who have a <REXX> enabled version of THE, a self-running
  57. demonstration <macro> is supplied which will provide a better explanation of
  58. the capabilities of THE, than any documentation could.  To run this demonstration,
  59. start THE as follows:
  60.  
  61.      +------------------------------
  62.      the -p demo.the demo.txt
  63.      +------------------------------
  64.  
  65. ========================================================================
  66. PROFILE FILE
  67. ========================================================================
  68.  
  69. Various session defaults may be changed on startup for an individual by
  70. using a <profile> file. This file contains various commands that set the
  71. current environment, including key bindings. This <profile> file can also be
  72. used to process commands in batch mode. 
  73.  
  74. THE will always execute a default profile. Appendix 1 defines the name of
  75. the default profile on different platforms.
  76.  
  77. An example of a profile might be to change all occurrences of 'alligator' 
  78. to 'crocodile' in the file 'file.ext' in batch mode, a <profile> file; 
  79. 'prf.prf' with the following commands would be used:
  80.  
  81.      +------------------------------
  82.      'c/alligator/crocodile/ * *'
  83.      'file'
  84.      +------------------------------
  85.  
  86. and the command
  87.  
  88.      +------------------------------
  89.      the -b -p prf.prf file.ext
  90.      +------------------------------
  91.  
  92. would be issued.
  93.  
  94. This changes the first string enclosed in delimiters (generally any
  95. non-alphabetic character not in the string itself) to
  96. the second string for every line (*) starting at the current line
  97. (0 initially) changing each occurrence on a line (*).
  98.  
  99. Maybe you only want to change a string after the first line that contains
  100. the string 'donkey', but only change the second occurrence of that string.
  101. The profile commands would then be:
  102.  
  103.      +------------------------------
  104.      '/donkey/'
  105.      'c/alligator/crocodile/ * 1 2'
  106.      'file'
  107.      +------------------------------
  108.  
  109. The change command uses a <target> specification as its first parameter
  110. after the string details. A <target> can be a number of lines, an absolute
  111. line number, BLANK, ALL or a string.
  112.  
  113. Number of line targets consist of either a positive integer, for
  114. referencing lines toward the end of the file, negative for referencing
  115. toward the start of the file or '*', which is all the remaining lines in
  116. the file or '-*' which is all lines toward the start of the file.
  117.  
  118. An absolute line number in the form of ':n' is the line number in a file,
  119. starting with line number 1.
  120.  
  121. **man-end**********************************************************************/
  122.