ftp.update.uu.se

home *** CD-ROM | disk | FTP | other *** search

/ ftp.update.uu.se / ftp.update.uu.se.2014.03.zip / ftp.update.uu.se / pub / rainbow / msdos / misc / kedtms.lzh / KEDT.DOC < prev next >

Wrap

Text File | 1985-08-09 | 38KB | 825 lines

KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 1 I. INTRODUCTION KEDT is a Rainbow 100 rendition of DEC's standard KED/EDT keypad editor. It is a combination of some of my favorite features from KED and EDT as well as a host of functionality specific for the Rainbow. I think you will find that KEDT looks and feels just like the real thing. Many subtle KED/EDT editing features have been carefully duplicated. In some ways, KEDT actually outperforms KED/EDT. KEDT was originally written for CP/M-86/80; recently it was converted to to operate under native mode MS-DOS and takes advantage of many MS-DOS features. KEDT may be freely distributed within the public domain but may not be sold for profit. Every Rainbow should have a copy! Jay Jervey Fountain Valley, CA August 10, 1985 (V1.2) II. INSTALLATION NOTES Usage: KEDT [drv:][path]filename.ext To install the editor, place KEDT.COM in a directory pointed to by your PATH environment variable. Place KEDT.HLP (the editor's help file) in either the default directory that you will be working in or in a directory accessible by SEARCH or DPATH. KEDT requires at least 55K bytes of free memory. KEDT creates normal 7-bit ASCII text files (unless you use some of KEDT's special formatting features). In general, KEDT does not permit 8-bit characters except for those provided by the SPECIAL INSERT function. Thruout this manual, when a function or command is preceeded by an asterisk (*), the feature or attribute set by that function may be permanantly saved in a new .COM file using the <Select> Z function. III. KEYPAD FUNCTIONS The keypad function layout of KEDT is exactly the same as KED/EDT. One additional function (Gold <PF2>) has been added, namely DEFINE SEARCH & REPLACE. The HELP function will display a keypad map and may be printed with the <Ctrl><Print Screen> function (hint: use 132 column mode when printing the keypad map - it looks nicer). <PF1> or GOLD Acts as a shift key for keypad functions. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 2 <PF2> or HELP Display either a message describing the last error or a helpful summary of KEDT functions. This implementation of HELP is similar to DEC's KED editor. Don't be confused by the error message display. Just hit <PF2> again to get the function help display. There are several screens of help available. <PF3> or FIND NEXT Search for the next occurrence of a previously defined search target string. <PF4> or DELETE LINE Delete the current line of text from the cursor up to, and including, the newline. The previously deleted line is pushed on the disposal stack. See later discussions concerning the disposal stack. <7> or PAGE Advance/backup up a page (delimited by a formfeed or ^L). <8> or SECTION Advance/backup a section (16 lines by default). <9> or APPEND Append a select range to the paste buffer. With most select-range oriented functions, a select range is either a region of text defined by the SELECT function or a search target string (if the cursor is on that string). The latter definition takes precedence over the former if both ranges exist simultaneously. <-> or DELETE WORD Delete all text from the cursor up to, but not including, the next word. Words are delimited by spaces, tabs, and newlines. <4> or ADVANCE Causes all functions with directionality to proceed forwards from the cursor. <5> or BACKUP Causes all functions with directionality to proceed backwards from the cursor. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 3 <6> or CUT Move text defined by the current select range into the paste buffer. The select range text in the edit buffer is deleted and the previous contents of the paste buffer are lost. <,> or DELETE CHARACTER Delete the character immediately under the cursor. <1> or WORD MOVE Advance/backup one word. <2> or END-OF-LINE Advance to the end of the current line or backup to the end of the previous line. <3> or CHARACTER MOVE Advance one character (won't backup). <0> or BEGINNING OF LINE Advance to the beginning of the next line or backup to the beginning of the current line. <.> or SELECT Tag the current cursor position as the beginning of a select range. Note that the SELECT function and the Rainbow <Select> key have completely different uses. A select range may not extend into a virtual disk buffer region. This means a select range is limited to about 22,000 characters. <Enter> or ENTER Terminate prompted input. <Gold PF2> or DEFINE SEARCH & REPLACE Prompt for search string target and advance/backup to that target. Then prompt for replace string and perform replace. Additional replaces may be performed with FINDNEXT/REPLACE sequences or SUBSTITUTE (see below). The replace string is placed in the paste buffer. Thus, a replace string can also be defined by a CUT operation (like KED/EDT). KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 4 <Gold PF3> or FIND Prompt for search string target and advance/backup to that target. The current search string target is displayed in the prompt. Case is generally not significant in the target string. However, the following modifiers may be placed in the target string to provide more flexible searching. The notation "<char>" below represents any single character. ^L<char> - take <char> literally; this can be used to explicitly search for upper/lowercase. ^N<char> - match any character except <char>; this is effectively a "NOT" logical operator ^E - match any character; this is a wildcard ^S - match any word separator (tab or space) <Gold PF4> or UNDELETE LINE Insert the previously deleted line at the cursor. This may be done repeatedly to make several copies of a line. Note that this is the ONLY undelete function that does not pop the disposal stack. <Gold 7> or COMMAND Prompt for command input. See later section for valid commands. <Gold 8> or FILL Format text within select range by wrapping words at column defined by SET WRAP command. Paragraphs are delimited by a blank line, a formfeed, or a tab in column one. <Gold 9> or REPLACE Substitute the search target string at the cursor with the previosuly defined replace string. If the replace string is null (ie. the paste buffer is empty), then just delete the search target. The replaced string is pushed on the disposal stack. This function is similar to the SUBSTITUTE function (see below) except that it is not followed by a search for the next target. <Gold -> or UNDELETE WORD If the last item deleted was a word, then insert that word at the cursor. This function is a pseudo version of the KED/EDT undelete word operation. It actually just pops the disposal stack. The disadvantage of this implementation is that the last word deleted will not be popped if some other item was pushed on the stack in the interim. Also, this prevents making copies of a word. However, the advantage is that you can delete several consecutive words and then pop them back somewhere else. To copy a word, you may use CUT and PASTE. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 5 <Gold 4> or MOVE TO BOTTOM Move to the bottom of the edit file. <Gold 5> or MOVE TO TOP Move to the top of the edit file. <Gold 6> or PASTE Insert the contents of the paste buffer at the cursor. <Gold ,> or UNDELETE CHARACTER If the last item deleted was a character, then insert that character at the cursor. This function is a pseudo version of the KED/EDT undelete character operation. Like undelete-word, it just pops the disposal stack. <Gold 1> or CHANGE CASE Change the case of the select range. If a select range is not active, then change the case of the character at the cursor. <Gold 2> or DELETE TO END-OF-LINE Delete the current line of text from the cursor up to, but not including, the newline. The previously deleted line is pushed on the disposal stack. <Gold 3> or SPECIAL INSERT This function is somewhat different than the KED/EDT function. A page of selected DEC 8-bit ASCII characters and VT100 graphic character equivalents is displayed. These can be cut or deleted and moved to the edit buffer. Control characters may be inserted using the CTRL/K function (described later). WARNING: Certain 8-bit characters are used internally by KEDT. Therefore, DO NOT edit binary files with this editor or attempt to use other 8-bit characters. <Gold 0> or OPEN LINE Open a line at the current cursor position. <Gold .> or RESET Deactivate the select range defined by a previous SELECT function. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 6 <Gold Enter> or SUBSTITUTE Substitute the search target string at the cursor with the previosuly defined replace string and then advance/backup to the next search target. If the replace string is null, then just delete the search target. The replaced target string is pushed on the disposal stack. The SUBSITUTE function is useful for repeated replace operations. IV. OTHER EDITING FUNCTIONS <Select> - The Rainbow <Select> key is used by KEDT as a secondary, but separate, Gold key. Do not confuse the <Select> key with the SELECT function even though many of the <Select> key operations involve select ranges. <Backspace> - Move cursor to the beginning of the current line. <Delete> - Delete the previous character. The deleted character is NOT pushed on the disposal stack. <Linefeed> - Delete the previous word. <Ctrl/U> - Delete from the cursor to the beginning of the current line. If cursor is already at the beginning of the line, delete the previous line. During prompted input, <Ctrl/U> will cancel the input and any related function (like EDT). <Remove> - Delete line from the cursor up to and including the newline and push the line on the disposal stack. Note that this is the ONLY line deletion function that pushes directly to the disposal stack. The other line deletion functions save the line in a special holding area which can be repeatedly undeleted. However, before another deleted line supersedes the current line in this special area, the area is pushed to the regular disposal stack and can be retrieved with the <Insert Here> function described below. <Insert Here> - Pop a line (or last item pushed) from the disposal stack. <Prev Screen> - Perform a backup section function. <Next Screen> - Perform an advance section function. <Gold> <Up Arrow> - If possible, scroll the screen up 1 line. <Gold> <Down Arrow> - If possible, scroll the screen down 1 line. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 7 <Gold> <Left Arrow> - If possible, scroll the screen left 1 tab stop. <Gold> <Right Arrow> - If possible, scroll the screen right 1 tab stop. <F19> - Copy the character at the cursor to the right or left depending on the advance/backup state. The <F19> and <F20> functions are particulary useful for VT100 line drawing. <F20> - Copy the character at the cursor up or down depending on the advance/backup state. <Select> <Select> - Clear the screen. <Ctrl/W> - Repaint the screen. <Ctrl/K><Key> - Insert control key where <Key> is 'A' thru '_' <Find> - Exchange the select range tag and the cursor. This is useful for verifying the select range boundaries since KEDT does not reverse-video the select range. <Select><PF3> - Make the select range the search string target and move to that target. Very handy. <Select> <Insert Here> - Toggle overtype/insert mode. KEDT allows over- typing, unlike KED/EDT. When in overtype mode, the cursor can move anywhere on the screen. When text is then placed beyond the end of a line, spaces are inserted to fill out the line. Overtype mode is particulary useful for VT100 line drawing. <Do> nnn - Repeat the next function or keystroke nnn times where nnn is a number from 1 to 32767.Obviously, certain functions should not, and will not, be repeated. Also, do not enter a gigantic number to do something that only requires a moderate repeat count. Otherwise, you may spend a long time waiting for the editor while it loops doing nothing. If nnn is not present, the default repeat count is 4. The default repeat count is multiplied by 4 each time you press <Do> in succession. Thus, <Do><Do> will give 16. <Do><Do><Do> will give 64, etc. <Ctrl/C> - Reset the editor. If you are being prompted for input, the prompt and its associated function will be cancelled. Functions that are in progress will not be aborted (searches, disk i/o, printing etc.). <Help> - Same as <PF2>. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 8 * <Select> S - Toggle screen background. * <Select> C - Toggle column mode (80/132) * <Select> A - Toggle screen intensity attribute (bold/normal) * <Main Screen> - Toggle keystroke macro definition mode. This is equivalent to the KED LEARN command. When this mode is on, all keystrokes continue to execute normally but they are also saved in a buffer. A sequence of up to 200 keystrokes can be saved. Any key can be saved except <Interrupt> and <Resume>. Pressing <Interrupt> a second time terminates the keystroke macro definition. The macro buffer can be saved permanently using the <Select> Z function. <Resume> - Execute the keystroke macro. If macro definition mode is on, terminate macro definition before executing. If an error is encountered or <Ctrl/C> is pressed during execution, the macro will halt. <Break> - Display the filespec of the current edit file. <Interrupt> - Push to a new MS-DOS command shell. The edit file and any temporary work files are left open. Do not attempt to edit the same file again while pushed to the new shell. KEDT will try to warn you if you do this. If a file was being created, you will destroy it if you try to edit it again while pushed. However, as long as you use a unique edit filename, you may invoke KEDT multiple times without harm. Caution: you may see lost clusters if you run CHKDSK while pushed to a new shell. These are clusters from KEDT's temp files. Do not ask CHKDSK to remove them. Prompt Terminators - When being prompted for input, <ESC>, <Ctrl/Z>, <Keypad 4>, <Keypad 5>, and <Enter> will always terminate input. <Return> will also terminate input except when entering a search or replace target (in which case <Return> (ie. newline) is treated as a valid search character). <Keypad 4> and <Keypad 5> will set directionality before terminating input (like KED/EDT). <Ctrl/C> or <Ctrl/U> will abort prompted input. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 9 V. INPUT/OUTPUT FUNCTIONS KEDT provides full directory path support. A path may be specified at any prompt that requests a filename. Paths are processed in exactly the same manner as the MS-DOS CHDIR command. <Exit> - Save editing changes in a new file, rename the old file with a .BAK extension, and exit to the system. If a zero-length file would be created, a <Cancel> function is executed instead. <Select> X - Identical to the <EXIT> key <Cancel> - Return to the system without saving changes. You will be prompted for confirmation before the edit session is terminated. <Select> Q - Identical to the <CANCEL> key <Select> W - Save editing changes in a new file, rename the old file with a .BAK extension, but don't exit. The edit session will be restarted. This is useful for protecting your work in anticipation of a power failure or system crash. <F18> - Prompt for an output filename and write the active select range to that file. The select range is then deleted from the text. This function, combined with <Select> I, can be useful as a disk cut-and-paste function if memory limitations prevent a regular CUT operation. Note: this function and the two that follow will display a default filename in the prompt. When you enter a filename for any of the three functions, that filename becomes the default for all three. <Select> O - Same as <F18> <F17> - Prompt for an input filename and read in the entire file at the cursor. <Select> I - Same as <F17> <Addtnl Options> - Prompt for a filename and list that file one screen at a time. The file will wrap back to the top when end-of-file is reached. <Select> L - Same as <Addtnl Options> <Select> M - Move select range from the list screen to the edit buffer. This function is valid when viewing a screen other than the main edit buffer, eg. when listing another file, during SPECIAL INSERT, when viewing a directory, etc. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 10 <Ctrl> <Print Screen> - Output the entire edit file to the printer. If a screen other than the edit buffer is being viewed, only that screen is printed. This is handy for printing the KEDT help screens. <Select> P - Output the active select range to the printer. <Select> D - Prompt for a filename and list a directory of those files. Wildcards are allowed. The default is *.* <Select> Z - Prompt for an executable filename (.COM) and zap the current editor setup to a new image. Tab settings, general screen attributes, etc. can be permanently saved with this function. The default file extension is .COM <F4> - Prompt for an output filename and save the entire edit session in that file. This function is useful for emergency saves on another drive if the current drive is full. VI. FORMATTING FUNCTIONS * <Select> T - Display current tab settings and allow tab stops to be set or cleared. Pressing 'C' clears all tabs and pressing 'D' sets default tabs every 8 columns. To set/clear an individual tab, move the cursor to to the desired column and press 'T'. Only 14 tab stops can be defined at any one time. <Select> R - Display a columnar ruler at the top of the screen. Any function which causes the screen to be cleared or repainted will erase the ruler. <Select> U - Underline the active select range. If a select range is not defined, then just insert the under- lining format characters. Note: many of the following formatting functions do so with a pair of special formatting characters enclosing the text. The uppercase formatting character turns on the attribute while the lowercase character turns off the attribute. The formatting is performed when the special characters are actually sent to the screen or printer. This can cause some strange problems when doing onscreen formatting of large blocks of text. If everything seems to be out of control, a <Ctrl/C> will clear all attributes. You may find it convenient to format large blocks of text just before printing to avoid onscreen formatting problems. To unformat a section of text, just delete the special characters enclosing it. Formatting attributes can be combined. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 11 <Select> B - Make the active select range bold. If a select range is not defined, then just insert the bold format characters. Valid for LA50 printer only. <Select> G - Convert the select range to VT100 graphics. If a select range is not defined, then just insert the graphics format characters. The SPECIAL INSERT function displays all the VT100 graphics characters and their keyboard equivalents. <Select> E - Make the active select range enhanced text on printout. If a select range is not defined, then just insert the enhanced format characters. No onscreen formatting is performed. <Select> <Up Arrow> - Superscript the active select range on printout. If a select range is not defined, then just insert the superscript format characters. No onscreen formatting is performed. Note: the superscript and subscript formatting characters just cause the printer to do partial-line movements. You can increase the degree of scripting by inserting multiple formatting characters. You may need to experiment with scripting on the LA100 printer. <Select> <Down Arrow> - Subscript the active select range on printout. If a select range is not defined, then just insert the subscript format characters. No onscreen formatting is performed. <Select> H n - Set printer horizontal pitch where n = 1 to 6 (5, 6, 8.25, 10, 12, & 16.5 cpi, respectively) No onscreen formatting is performed. The hori- zontal pitch formatting character is a reverse video digit indicating the pitch. Note that this function and the following one do not operate on a select range. The pitch remains in effect until explicitly changed. Note: the default horizontal pitch depends on the column mode (80/132). <Select> V n - Set printer vertical pitch where n = 1 to 6 (2, 3, 4, 6, 8, & 12 lines/inch, respectively) No onscreen formatting is performed. The vertical pitch formatting character is an underlined reverse video digit indicating the pitch. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 12 VII. COMMANDS The following commands are valid for the Gold <7> or COMMAND function. Many of these commands are redundant. Some are provided for KED/EDT compatibility. The minimum command syntax is shown in uppercase. EXit - Same as the <Exit> key. QUIT - Same as the <Cancel> key except that confirmation is not required. Input "file" - Same as the <F17> function. Include "file" - Same as the <F17> function. Output "file" - Same as the <F18> function. Write "file" - Same as the <F18> function. List "file" - Same as the <Addtnl Options> function. DIr "file" - Same as the <Select> D function. Help - Same as the <PF2> or <Help> function. PRInt - Same as the <Ctrl><Print Screen> function. PUrge - Purge (clear) the paste buffer. nnnn - Move cursor to line number nnnn where nnnn = 1 to 32767. If nnnn is preceeded by a +/- sign, then the move will be relative to the current line number. DElete "file" - Delete file. * SET Font n - Select printer character font n where n = 1 to 5. This is only valid for the LA100. * SET NOQuiet - Ring the keyboard bell on an error condition. * SET Quiet - Reverse the screen background on an error condition. * SET Ctrlz - Terminate all output files with a Ctrl/Z character * SET NOCtrlz - Do not terminate output files with a Ctrl/Z character * SET WRap n - Set word-wrap column to n where n = 10 to 120. This is used in conjunction with the FILL function. * SET WIndow n - Set the vertical scrolling region to n lines where n = 0 to 21. This is the number of lines that you can move up and down without scrolling. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 13 * SET SEction n - Set the the number of lines to move for the SECTION function to n lines where n = 1 to 22. * SET SCroll Fast - Allow vertical scrolling to get ahead of the display. This provides for faster response. * SET SCroll Norm - Do not allow vertical scrolling to get ahead of the display. This mode of scrolling is more like KED/EDT but is slower. * SET Virtual d: - Use drive d: for virtual buffering. If d: is missing, then the default drive will always be used. This command must be followed by a <Select> Z function in order to become effective. Generally, switching the virtual drive is useful when editing large files on floppy systems. Changing the virtual drive can be effective in the following cases: 1) I/O will be more efficient when using RAM disk for virtual buffering, particularly on floppy systems. 2) Using another drive for virtual buffering on a floppy system can minimize space requirements on the edit drive. If space considerations are not a problem and a RAM disk is not available, the default drive is always the most efficient virtual buffering drive. Note also that the input and output files will always remain on the default drive. Thus, if you have enough RAM disk, the greatest speed can be achieved by editing a file directly off the ram disk. VIII. IMPLEMENTATION NOTES The following KED/EDT features are not supported by KEDT: 1) Journaling is not supported. 2) Multiple simultaneous file editing is not supported. 3) Key redefinition is not supported. 4) Line editing mode is not supported. 5) Buffer commands, substitution commands, etc. at the command prompt are not supported. 6) EDTINI.EDT is not supported. The following KEDT features are implemented differently: 1) KEDT uses a disposal stack for word and character deletion. This means you cannot repeatedly undelete the same word/char. However, you can delete multiple words/chars and retrieve all of them. This can be very efficient. 2) KEDT does not wrap lines automatically like KED and EDT. Instead, KEDT scrolls horizontally. This improves performance. KEDT-MS V1.2 Rainbow MS-DOS Keypad Editor Page 14 3) KEDT does not reverse-video select ranges like KED and EDT. This is one that really bothers me but I couldn't find a good way to do it without severely degrading performance. 4) KEDT uses the KED form of help and error reporting. 5) KEDT allows you to continue editing while prompting you for input at the top of the screen. This can seem a little strange at first but it has the advantage of letting you move the cursor around, delete things, etc. even after you've decided to do something that requires a prompt. The following KEDT features/capabilities need to be documented: 1) KEDT can edit files as large as 512K. However, in order to edit a 512K file, you would need another 512K of disk space for the output file and about 490K for the virtual disk buffer. Use this example as a rule of thumb for sizing free disk space before you start editing a file. Don't forget. You have a panic button, namely the <F4> function, if your disk fills up. 3) KEDT may run out of memory if you are editing large files and you cut-and-paste large sections of text. If you get repeated memory errors, try one or more of the following: a) Reset the editor with a Ctrl/C b) Clear the paste buffer with the PURGE command c) Save the edit session with a <Select> W d) If all else fails, exit and restart 4) KEDT normally handles errors gracefully and just beeps you. However, certain severe errors will clear the screen and display an error message (like when the disk fills up). Don't be alarmed by this. Just proceed and resolve the problem. 5) If KEDT detects a fatal system error on startup, it will notify you and then exit. Startup errors are invariably due to an illegal drive specifier, an attempt to edit a file on a write-protected drive, an illegal filename, or some other file system failure. 6) Certain functions are not valid while other functions are in progress. You will receive a 'Function not valid in this context' error if you try to do too many things at once. For example, if you try to define a search string while listing a file, you will get this error because KEDT cannot prompt you for new input while it's already prompting you for input. Note, you can always display the latest error message with the help function even if you are being prompted for input. You can also quit using <Cancel> at any prompt.