home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / CLIPPER / MISC / MAX130.ZIP / MAXEDIT.DOC < prev    next >
Encoding:
Text File  |  1988-10-30  |  11.1 KB  |  266 lines
  1.  
  2.         MaxEdit Version 1.20 - Reference Manual
  3.  
  4.  
  5. Alt Key Sequences:    Description:
  6.  
  7. A - Allocate Region    Open window, prompts for location and attributes
  8. B - Buffer Text        Copy marked text (or entire window) to buffer
  9. C - Cut Text        Copy and delete marked text (or entire window)
  10. D - Delete Line        Delete the current line and scroll text up
  11. E - Erase Region    Clear the contents of the current window
  12. F - File Mode        Toggle between file and command mode
  13. G - Goto Line        Prompt for line and position to it
  14. H -             Undefined
  15. I - Insert Line        Create a new line and scroll text down
  16. J - Join Line        Join the next line with the current line
  17. K - Split Line        Split text following cursor onto a new line
  18. L - Clear Background    Clear screen of all windows except current window
  19. M - Toggle Mark        Set block for subsequent copy (Alt-B) or cut (Alt-C)
  20. N - Next Region        Move cursor to next window and refresh in verify mode
  21. O - Overflow Mode    Allow old text to be discarded as new text is added
  22. P - Paste Buffer    Paste buffer created using copy (Alt-B) or cut (Alt-C)
  23. Q -             Undefined
  24. R - Read File        Prompt for filename and options and read into window
  25. S - Status Mode        Toggle status line on bottom row of screen
  26. T - Truncate Line    Truncate to end of line from current cursor position
  27. U - Unallocate Region    Close window (Prompts for confirmation in file mode)
  28. V - Verify Mode        Enable or disable refresh when selecting windows
  29. W - Write File        Prompt for filename and options and write window
  30. X - Search        Search for text optionally using ? and * wildcards
  31. Y - Replace        Search for and replace text with prompting
  32. Z - Zap         Clear to EOF (Prompts for confirmation in file mode)
  33. - - Wrap Mode        Toggle truncate/wrap when max line length is reached
  34. = - Resize Window    Resize and/or reposition the current window
  35.  
  36. Other Key Sequences
  37.  
  38. Up             Line up, scroll at top
  39. Down            Line down, scroll at bottom if not at end of file
  40. Left            Column to left, scroll horizontally if necessary
  41. Right            Column to right, scroll horizontally if necessary
  42. Ctl-Left        Word to left
  43. Ctl-Right        Word to right
  44. Home             Beginning of current line
  45. End            End of current line
  46. Ctl-Home        Beginning of file
  47. Ctl-End            End of file
  48. Tab            One tabstop right
  49. Shift-Tab         One tabstop left
  50. Delete             Delete one character
  51. PgUp            Scroll up 1/2 page
  52. PgDn            Scroll down 1/2 page
  53. Insert            Toggle insert/overtype
  54. Ctl-PrtSc        Refresh screen
  55. Shift-PrtSc        Print screen
  56.  
  57.  
  58. Function Keys
  59.  
  60. The function keys send a command function reference when pressed. The
  61. function reference is based on the name of the function key. The function
  62. reference sent by the key can be used to invoke a Max function by creating
  63. a user defined function with the function key name. For example, if you
  64. want F5 to print "hello" every time it is pressed, enter the following:
  65.  
  66.     define (
  67.         f5 (
  68.         print ("hello")
  69.         )
  70.     )
  71.  
  72. Now pressing F5 causes MaxEdit to return "f5()" to Max, just as if you
  73. had typed it yourself in the command window. The f5 is interpreted by 
  74. Max as a function name and the corresponding function is executed.
  75.  
  76. The function keys may also be shifted, controlled and alted. The keys 
  77. return the following sequences:
  78.  
  79.     Keys:                Returns:
  80.  
  81.     F1 through F10            f1() - f10()
  82.  
  83.     Shifted F1 through F10        shift-f1() through shift-f10()
  84.  
  85.     Controlled F1 through F10    ctrl-f1() through ctrl-f10()
  86.  
  87.     Alted F1 through F10        alt-f1() through alt-f10()
  88.  
  89.  
  90. The following functions are defined in the window.max initialization
  91. file:
  92.  
  93.     f1()    Translate and interpret contents of function definition
  94.         window.
  95.  
  96.     f2()    Suspend from Max to the operating system. When you want
  97.         to return from the operating system to Max type exit.
  98.  
  99.     f3()    Print in the command entry window a directory of all
  100.         user defined functions.
  101.  
  102.     f6()    Clear all user defined functions and preprocessor
  103.         definitions entered since the last call to tset.
  104.  
  105.     f10()    Quit from Max.
  106.  
  107. You may redefined them by modifying window.max.
  108.  
  109.  
  110. Windows
  111.  
  112. The MaxEdit interactive environment lets you issue commands in one window
  113. while you edit a file in another. MaxEdit supports any number of
  114. tiled (adjacent) or piled (overlapping) windows. Switch between windows by
  115. using the Next (alt-n) command. Windows are automatically refreshed as
  116. they are entered. Refreshing may be turned off by disabling the verify
  117. feature (alt-v). You may open a new window by allocating (alt-a) it, or
  118. close an existing window by unallocating (alt-u) it.
  119.  
  120. To enter a command in the command window, type the command and press
  121. enter. All text to the left of the carriage return when enter is pressed is
  122. sent to the Max command interpreter. This is always true in command windows
  123. (for file windows, see File Mode below). To reenter text on a previous
  124. line, use the arrow keys to move the cursor back to the line and to
  125. the right of the text you want to send. Press enter. The command will
  126. be re-sent without your having to retype it.
  127.  
  128. To open a new window, use either the "window (WOpen)" function from Max
  129. or use the MaxEdit window allocate command (Alt-A). The window allocate
  130. command allows you to define the location of the new window by specifying
  131. first the upper left corner and then the lower right corner. The arrow 
  132. keys, tab, backtab, home, end, page up and page down may be used to
  133. position the cursor. Enter ESC if you decide that you do not want to
  134. open the window. You may change the defaults for the window
  135. while it is prompting you to enter a corner location. The following
  136. values may be changed by entering the letter:
  137.  
  138.     a - video attributes as described under "window." These are
  139.         decimal values (hex 0x70 = dec 112, hex 0x07 = dec 7).
  140.  
  141.     b - border style as described under "window." These are in
  142.         the range 1 to 8.
  143.  
  144.     l - line length in bytes (characters). This is the maximum
  145.         length of a line in the window.
  146.  
  147.     s - total buffer size in bytes (characters). This is the total
  148.         number of characters that may be entered in the window.
  149.  
  150.  
  151. Temporary Files
  152.  
  153. MaxEdit uses a temporary file for the cut/copy/paste operations. The name
  154. of the file is window.tmp and it is deleted when MaxEdit terminates. If
  155. you have a ramdisk or would like the file put in a specific directory
  156. you may specify the disk or pathname of the directory using the TMP
  157. environment variable. If you do not specify a directory, the temporary
  158. file will be placed in the current directory.
  159.  
  160. For example, to put the window.tmp file in C:\TMP, use the following
  161. command under DOS:
  162.  
  163.     SET TMP=C:\TMP
  164.  
  165.  
  166. Read and Write
  167.  
  168. You may read a file into the current window using the read (alt-r)
  169. command. A popup window is displayed where you can enter the name of
  170. the file you with to read. Several options may be selected by specifying
  171. a hyphen and the option character before the filename. Options for read
  172. are:
  173.  
  174.     c    clear window before reading file
  175.     d    display file as it is read
  176.     t    read from temporary file (used for cut/copy/paste)
  177.  
  178. The contents of a window may be written to disk using the write command. 
  179. The same popup window is used to get the name of file to write. To reenter
  180. a the name of file you previously specified, use the arrow and end
  181. keys to position to the end of the line containing the filename. Be sure
  182. there are no conflicting options on the same line, because they will
  183. be re-sent too. Options may be specified for writing by preceding the
  184. filename with a hyphen and the option character. Options for write are:
  185.  
  186.     a    append to file (default is to truncate)
  187.     c    cut text after writing it
  188.     t    write to temporary file (used for cut/copy/paste)
  189.  
  190. The read command expands tab characters in the file to MaxEdit tabstops.
  191. You may cancel the read or write operation by entering ESC instead of a
  192. filename.
  193.  
  194.  
  195. Search and Replace
  196.  
  197. The MaxEdit search function accepts the ? and * wildcards. Specify ? to
  198. match any single character and * to match zero or more characters. If the
  199. characters ? and * are in the text you wish to search for, then precede
  200. them with a backslash (\) escape character. The newline character (\n)
  201. may also be used in searches and replacements but it should not be used
  202. as the first character of a search string because it gives undesirable
  203. results. 
  204.  
  205. The replace command prompts first for a search string and then for a
  206. replace string. It then searches for the first occurence of the search
  207. string, positions the cursor to it, and prompts you to enter y, n, or a:
  208.  
  209.     y - yes, make the change and search for next occurence
  210.     n - no, do not make change but search for next occurence
  211.     a - all, make the change and all remaining occurences
  212.  
  213. You may also enter ESC when prompted for the search string, replace
  214. string or change confirmation to cancel the replace. Any changes made
  215. will remain.
  216.  
  217.  
  218. Marks and Cut/Copy/Write/Paste
  219.  
  220. The mark feature may be used to cut, copy or write a portion of the
  221. file. A mark specifies the beginning or the end of the section you wish
  222. to use and is entered by using the Mark (alt-m) command. The marked
  223. character is displayed in reverse video so that you know which character
  224. is marked. You may now position above or below the mark and select
  225. the Cut (alt-c), Copy (alt-b for buffer) or Write (alt-w) commands. Those
  226. commands work on text between the cursor and the mark. Cut and Copy are
  227. used to copy text to a temporary file for subsequent placement using
  228. Paste (alt-p). The difference between Cut and Copy is that Cut removes the
  229. text from the file while Copy just makes a copy. 
  230.  
  231.  
  232. Overflow Mode
  233.  
  234. In the command window it is useful to have old text scroll off the
  235. top of the buffer so that new text may be added to the bottom of the
  236. buffer. This is known as overflow and is perfectly natural in the command
  237. window. In the function definition window you don't want to lose anything
  238. you've typed so don't use overflow mode. To toggle (i.e. switch) between
  239. overflow and no-overflow modes use alt-o. The character "O" will appear
  240. at the middle of the bottom row of the screen when you are in overflow mode. 
  241.  
  242.  
  243. File Mode
  244.  
  245. File mode is the opposite of overflow mode. It is usually used for
  246. composing functions rather than entering commands. In file mode, a
  247. carriage return does not cause the current line of text to be sent to
  248. the Max command interpreter. When you are not in file mode each line of
  249. text to the left of the cursor when a carriage return is entered is sent
  250. to the command interpreter. To toggle (i.e. switch) between file and
  251. no-file modes use alt-f. The character "F" will appear at the middle
  252. of the bottom row of the screen when you are in file mode.
  253.  
  254.  
  255. Status Mode
  256.  
  257. The row at the bottom of the screen that tells you the current line and
  258. column numbers is called the status row. It also tells you how many free
  259. bytes (characters) are left in the buffer. If you are creating a function
  260. in the function definition window it is wise to save your file (using alt-w
  261. for write) when it gets close to 100 or so. Then either allocate a
  262. larger buffer or continue in another file. If the free storage gets low
  263. in the command entry window, don't worry about it. MaxEdit will discard
  264. old text from the top of the buffer so there will be room for new text.
  265. The status row may be toggled (turned off and back on) by entering alt-s.
  266.