home *** CD-ROM | disk | FTP | other *** search
/ RISC DISC 1 / RISC_DISC_1.iso / pd_share / utilities / zap / !Zap / 3rdParty / UtilsHelp < prev    next >
Encoding:
Text File  |  1994-03-18  |  3.8 KB  |  129 lines
  1.  
  2. This is the ReadMe file for ZapUtils 0.03
  3.  
  4.     © Paul Moore (04-Jan-1994)
  5.  
  6. This is a module providing a number of extra commands for Zap. It requires Zap
  7. 1.00 or later.
  8.  
  9. The distribution conditions of ZapUtils are the same as those for Zap, with
  10. one exception; you do not need my permission to copy ZapUtils if you have
  11. Dominic Symes' permission to copy Zap.  Thus, ZapUtils is freeware and those
  12. wishing to distribute it on a cover disk need only contact Dom for
  13. permission.
  14.  
  15. You should distribute ZapUtils in both source and executable form.
  16.  
  17.  
  18. Installation
  19. ============
  20.  
  21. 1. Check your version of Zap is >= 1.00 (in the Info box).
  22. 2. Copy the ZapUtils module into the !Zap directory.
  23. 3. Add the line
  24.     RMLoad <Zap$Dir>.ZapUtils
  25.    after the line
  26.        RMLoad <Zap$Dir>.ZapBasic
  27.    in the !Zap.!Run file, if it is not already present.
  28. 4. Restart your copy of Zap.
  29.  
  30.  
  31. The Commands
  32. ============
  33.  
  34. Note: All the word commands use a different definition of a "word" than the
  35. one used by Zap's standard SLEFT and SRIGHT commands. Because of this, I
  36. have supplied new commands BW and FW to replace the Zap defaults. If you
  37. use this module, you may wish to amend your default Keys file to use the
  38. FW and BW commands instead of SRIGHT and SLEFT.
  39.  
  40. For this module, a "word" is defined as any continuous set of letters,
  41. numbers, or underscore characters. This matches an identifier in many
  42. programming languages (notably C) and is fairly intuitive (to me, at least!)
  43.  
  44. In a future release of this module, I intend to add commands to alter the
  45. set of characters which make up a "word".
  46.  
  47.  
  48. WINLEFT n, WINRIGHT n, WINUP n, WINDOWN n
  49. -----------------------------------------
  50.  
  51. These commands move the current Zap window on screen, by the amount specified
  52. (in OS units). The intention is that a keymap could be used to temporarily make
  53. the cursor keys move the window round, eg
  54.  
  55.      cA     &001     KEYMAP 5
  56.      LEFT   &5018C   WINLEFT 40:KEYMAP 5
  57.      RIGHT  &5018D   WINRIGHT 40:KEYMAP 5
  58.      DOWN   &5018E   WINDOWN 40:KEYMAP 5
  59.      UP     &5018F   WINUP 40:KEYMAP 5
  60.  
  61.  
  62. FW, BW
  63. ------
  64.  
  65. Move the cursor forward and backward one word.
  66.  
  67.  
  68. DELWORDLEFT, DELWORDRIGHT
  69. -------------------------
  70.  
  71. Delete one word, to the left or to the right.
  72.  
  73.  
  74. FILTERSEL "str"
  75. ---------------
  76.  
  77. This command takes the selected area of the current file, and feeds it to the
  78. standard input of the command "str". The selection is replaced by the standard
  79. output.
  80.  
  81. C-style redirection is used (ie, command <standard_in >standard_out), so only
  82. filter programs written in languages using the Shared C Library are likely to
  83. work.
  84. Error messages are ignored.
  85. <Wimp$ScrapDir> is used for temporary files (called Zap-In and Zap-Out).
  86.  
  87. As an example, to sort the selected area, use FILTERSEL "sort", assuming you
  88. have a suitable sort program available.
  89.  
  90.  
  91. SEARCHWORD n
  92. ------------
  93.  
  94. Search for the word at the cursor. The exact effect depends on the parameter n.
  95.  
  96.     n=0     Search to buffer
  97.     n=+1    Search forward from the current cursor position (ie, next match)
  98.     n=-1    Search backward from the current cursor position (ie, previous match)
  99.     n=+2    Search forward from the start of the buffer (ie, first occurrence)
  100.     n=-2    Search forward from the start of the buffer (ie, last occurrence)
  101.  
  102. All searches wrap at the end of the buffer, just like Zap's standard search routine
  103. (because that's what we use!)
  104.  
  105.  
  106. To Do
  107. =====
  108.  
  109. Add commands to change the set of 'word characters'.
  110. Filter selection to check return code.
  111. Filter selection bug - "out of memory" message on error.
  112. Ctrl-U n SEARCHWORD 2 to search for the nth occurrence.
  113. Searchword may be confused by macros defined on letters.
  114. Escape/Cancel handling when in window move mode (needs a new Zap service call).
  115.  
  116.  
  117. Version History
  118. ===============
  119.  
  120. 0.01
  121. 0.02
  122.  
  123. Unreleased development versions
  124.  
  125. 0.03
  126.  
  127. First release version.
  128. Word move, delete, search, window move, filter selection.
  129.