COMMAND REFERENCE
-
ADD - add blank line
- Syntax:
- Add [n]
- Description:
- The ADD command inserts n blank lines after the current line , if issued from the command line or after the focus line , if issued from the filearea or prefix area .
- If SET NEWLINES is set to ALIGNED, the cursor is positioned in the column corresponding to the first column not containing a space in the line above.
- If SET NEWLINES is set to LEFT, the cursor is positioned in the first column.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Default:
- 1
- See Also:
- SOS ADDLINE
- Status:
- Complete
-
ALL - select and display restricted set of lines
- Syntax:
- ALL [rtarget]
- Description:
- The ALL command allows for the selective display, and editting (subject to SET SCOPE ) of lines that match the specified target. This target consists of any number of individual targets seperated by '&' (logical and) or '|' (logical or).
- For example, to display all lines in a file that contain the strings 'ball' and 'cat' on the same line or the named lines .fred or .bill, use the following command
- ALL /ball/ & /cat/ | .fred | .bill
- Logical operators act left to right, with no precedence for &.
- ALL without any arguments, is the equivalent of setting the selection level of all lines in your file to 0 and running SET DISPLAY 0 0.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- SET SCOPE, SET DISPLAY, SET SELECT
- Status:
- Complete.
-
BACKWARD - scroll backwards [n] screens
- Syntax:
- BAckward [n|*]
- Description:
- The BACKWARD command scrolls the file contents backwards through the file n or * screens.
- If 0 is specified as the number of screens to scroll, the last line of the file becomes the current line .
- If the BACKWARD command is issued while the current line is the Top-of-File line , the last line of the file becomes the current line .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Does not support HALF or Lines options.
- Default:
- 1
- See Also:
- FORWARD, TOP
- Status:
- Complete
-
BOTTOM - move to the bottom of the file
- Syntax:
- Bottom
- Description:
- The BOTTOM command moves to the very end of the current file. The last line of the file is set to the current line .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- FORWARD, TOP
- Status:
- Complete
-
CANCEL - quit from all unaltered files in the ring
- Syntax:
- CANcel
- Description:
- The CANCEL command exits from THE quickly by executing a QQUIT command for every file in the ring that does not have any outstanding alterations.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- CCANCEL
- Status:
- Complete.
-
CAPPEND - append text after column pointer
- Syntax:
- CAppend [text]
- Description:
- The CAPPEND command moves the column pointer to the end of the focus line and appends the specified text .
- If no text is specified, the column pointer moves to the first trailing space.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- CLAST
- Status:
- Complete.
-
CCANCEL - qquit from all files in the ring
- Syntax:
- CCancel
- Description:
- The CCANCEL command exits from THE quickly by executing the QQUIT command for every file in the ring. Any changes made to any of the files since the last SAVE will be lost.
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- See Also:
- CANCEL
- Status:
- Complete.
-
CDELETE - delete text starting at column pointer
- Syntax:
- CDelete [column target]
- Description:
- The CDELETE command deletes characters starting from the current column pointer for the specified column target .
- If no column target is specified, the character at the column pointer is deleted.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Incomplete. No string targets.
-
CFIRST - move column pointer to beginning of zone
- Syntax:
- CFirst
- Description:
- The CFIRST command moves the column pointer to the beginning of the zone.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- SET ZONE
- Status:
- Complete.
-
CHANGE - change one string to another
- Syntax:
- Change /string1/string2/ [target] [n] [m]
- Description:
- The CHANGE command changes one string of text to another.
- The first parameter to the change command is the old and new string values, seperated by delimiters. The allowable delimiters are '/' '\' and '@' .
- target specifies how many lines are to be searched for occurrences of string1 to be changed.
- n determines how many occurrences of string1 are to be changed to string2 on each line.
- m determines from which occurrence of string1 on the line changes are to commence.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Default:
- 1 1 1
- See Also:
- SCHANGE
- Status:
- Complete.
-
CINSERT - insert text starting at the column pointer
- Syntax:
- CInsert text
- Description:
- The CINSERT command inserts text starting at the column position.
- It is possible to insert blanks with the CINSERT command.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
CLAST - move the column pointer to end of zone
- Syntax:
- CLAst
- Description:
- The CLAST command moves the column pointer to the end of the zone.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- SET ZONE
- Status:
- Complete.
-
CLOCATE - move the column pointer
- Syntax:
- CLocate column target
- Description:
- The CLOCATE command scans the file for the specified column target beginning with the column following (or preceding) the column pointer.
- Column targets can be specified as absolute targets, relative targets or string targets.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Incomplete. No string targets.
-
CMATCH - find matching bracket character
- Syntax:
- CMATCH
- Description:
- The CMATCH command searches for the matching bracket character to the character under the cursor.
- It handles nested sets of matching pairs. The matching character pairs are []{}<>().
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- Status:
- Complete.
-
CMSG - display text on command line
- Syntax:
- CMSG [text]
- Description:
- The CMSG command, primarily used in macros, displays text on the command line.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- EMSG, MSG
- Status:
- Complete.
-
COMMAND - execute a command without translation
- Syntax:
- COMMAND command [options]
- Description:
- The COMMAND command executes the specified command without synonym or macro translation. THE does not attempt to execute the command as a macro even if SET IMPMACRO is ON. The command will be passed to the operating system if SET IMPOS is ON.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
COMPRESS - reduce spaces to tabs
- Syntax:
- COMPress [target]
- Description:
- The COMPRESS command reduces multiple occurrences of spaces and replaces them with tab characters in the target lines. The current tab columns (set by SET TABS ) are used in determining where tab characters will replaces spaces.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- EXPAND, SET TABS
- Status:
- Not started.
-
CONTROL_CHAR - allow control characters to be entered
- Syntax:
- control_char
- Description:
- The CONTROL_CHAR command prompts the user to enter a control character.
- This command can only be used by assigning it to a function key with the DEFINE command.
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- Status:
- Complete.
-
COPY - copies text from one position to another
- Syntax:
- COPY target1 target2
- COPY BLOCK [RESET]
- Description:
- With the first form of the COPY command, text is copied from target1 to the line specified by target2 . Text can only be copied within the same view of the file.
- The second form of the COPY command copies text within the currently marked block to the current cursor position. The text can be in the same file or a different file.
- Compatibility:
- XEDIT: COPY BLOCK not available.
- KEDIT: Adds extra functionality with [RESET] option.
- With the cursor in the marked block this command in KEDIT
- acts like DUPLICATE BLOCK.
- Status:
- Complete.
-
COVERLAY - overlay text starting at the column pointer
- Syntax:
- COVerlay text
- Description:
- The COVERLAY command overlays the supplied text onto the characters following the column position.
- Spaces in the text do not destroy the existing characters.
- An underscore character "_" in the text places a space in the corresponding character position. Therefore you cannot use the COVERLAY command to place underscores in a line.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
CREPLACE - replace text starting at the column pointer
- Syntax:
- CReplace text
- Description:
- The CREPLACE command replaces the current characters after the column pointer with the supplied text .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
CURSOR - move cursor to specified position
- Syntax:
- CURsor Column
- CURsor Screen UP|DOWN|LEFT|RIGHT
- CURsor Screen row [col]
- CURsor [Escreen] UP|DOWN
- CURsor [Escreen|Kedit] LEFT|RIGHT
- CURsor [Escreen] row [col]
- CURsor CMdline [n]
- CURsor HOME [SAVE]
- CURsor File line [col]
- Description:
- The CURSOR command allows the user to specify where the cursor is to be positioned.
- CURSOR Column moves the cursor to the current column of the focus line .
- CURSOR Screen UP | DOWN | LEFT | RIGHT moves the cursor in the indicated direction one line or column. If the cursor is positioned on the first or last line of the screen, the cursor wraps to the first or last enterable lines. If the cursor is positioned on the left or right edges of the screen, the cursor moves to the left or right edge of the screen on the same line.
- CURSOR Screen row [ col ] moves the cursor to the specified row / col position within the file area. The top left corner of the file area is 1,1. row and col may be specified as '=' , which will default to the current row and/or column position. If row or col are greater than the maximum number of rows or columns in the file area, the cursor will move to the last row/column available. If the specified row is a reserved line , scale line or tab line an error will be displayed. If the row specified is above the Top-of-File line or below the Bottom-of-File line the cursor will be placed on the closest one of these lines.
- CURSOR [ Escreen ] UP | DOWN | LEFT | RIGHT is similar to CURSOR Screen UP | DOWN | LEFT | RIGHT , except that where scrolling of the window is possible, then scrolling will take place.
- CURSOR [ Escreen ] row [ col ] is similar to CURSOR Screen row [ col ], but all coordinates are relative the the top left corner of the logical window, not the top left corner of the filearea . Hence, 1,1 would be an invalid cursor position because it would result in the cursor being moved to the idline . Specification of row and/or col outside the boundaries of the logical window is regarded as an error.
- CURSOR Kedit LEFT | RIGHT mimics the default behaviour of CURL and CURR in KEDIT.
- CURSOR CMdline moves the cursor to the indicated column of the command line .
- CURSOR HOME moves the cursor to the first column of the command line (if not on the command line), or to the last row/column of the filearea if on the command line. With the [ SAVE ] option, the cursor will move to the last row/column of the filearea or prefix area (which ever was the last position) if on the command line .
- CURSOR File moves the cursor to the line and column of the file. If the line and/or column are not currently displayed, an error message is displayed.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
DEFINE - assign one or many commands to a key
- Syntax:
- DEFine key-name [command [args] [[#command [args]...]]]
- Description:
- The DEFINE command allows the user to assign one or many commands and optional parameter(s) to a key.
- Commands may be abbreviated.
- If multiple commands are assigned, then the LINEND setting must be ON and the LINEND character must match the character that delimits the commands at the time that the DEFINE command is executed. LINEND can be OFF at the time the key is pressed.
- With no arguments, any existing definition for that key is removed and the key reverts back to its default assignation (if it had any).
- key-name corresponds to the key name shown with the SHOWKEY command.
- Compatibility:
- XEDIT: N/A
- KEDIT: Minimal. No support for in-memory macro commands.
- KEDIT does not allow multiple commands except as KEXX
- macros.
- See Also:
- SHOWKEY, SET LINEND
- Status:
- Complete.
-
DELETE - delete lines from a file
- Syntax:
- DELete [target]
- Description:
- The DELETE command removes lines from the current file. The number of lines removed depends on the target specified. Lines are removed starting with the focus line .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Default:
- 1
- See Also:
- SOS DELLINE
- Status:
- Complete.
-
DIRECTORY - list the specified directory as an editable file
- Syntax:
- DIRectory [file specification]
- Description:
- The DIRECTORY command displays all files matching the specified file specification .
- When no parameter is supplied, all files in the current directory are displayed subject to any SET DIRINCLUDE restrictions.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- LS, SET DIRINCLUDE
- Status:
- Complete.
-
DOS - execute an operating system command
- Syntax:
- DOS [command]
- Description:
- The DOS command executes the supplied operating system command or runs an interactive shell if no command is supplied.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- OS, !
- Status:
- Complete.
-
DOSNOWAIT - execute an operating system command - no prompt
- Syntax:
- DOSNowait command
- Description:
- The DOSNOWAIT command executes the supplied operating system command not waiting for the user to be prompted once the command has completed.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- OSNOWAIT
- Status:
- Complete.
-
DOSQUIET - execute an operating system command quietly
- Syntax:
- DOSQuiet command
- Description:
- The DOSQUIET command executes the supplied operating system command as quietly as possible.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- OSQUIET
- Status:
- Complete.
-
DOWN - move forward in the file a number of lines
- Syntax:
- Down [relative target]
- Description:
- The DOWN command moves the current line forwards the number of lines specified by the relative target . This relative target can only be a positive integer or the character "*".
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Default:
- 1
- See Also:
- NEXT, UP
- Status:
- Complete.
-
DUPLICATE - duplicate lines
- Syntax:
- DUPlicate [n [target|BLOCK]]
- Description:
- The DUPLICATE command copies the number of lines extrapolated from target or the marked BLOCK , n times.
- Compatibility:
- XEDIT: Equivalent of DUPLICAT command.
- KEDIT: Compatible.
- Status:
- Complete.
-
EDIT - edit another file or switch to next file
- Syntax:
- Edit [file]
- Description:
- The EDIT command allows the user to edit another file . The new file is placed in the file ring . The previous file being edited remains in memory and can be returned to by issuing an EDIT command without any parameters. Several files can be edited at once, and all files are arranged in a ring, with subsequent EDIT commands moving through the ring, one file at a time.
- Compatibility:
- XEDIT: Does not provide options switches.
- KEDIT: Does not provide options switches.
- See Also:
- THE, XEDIT
- Status:
- Complete.
-
EMSG - display message
- Syntax:
- EMSG [message]
- Description:
- The EMSG command displays an message on the message line . This command is usually issued from a macro file.
- Compatibility:
- XEDIT: Does not support [mmmnnns text] option
- KEDIT: Compatible
- See Also:
- CMSG, MSG
- Status:
- Complete.
-
ENTER - execute a command
- Syntax:
- enter
- Description:
- The ENTER command executes the command currently displayed on the command line, if the cursor is currently displayed there. If the key associated with ENTER is pressed while in the filearea , then the cursor will move to the first column of the next line. If the cursor is in the prefix area , any pending prefix commands will be executed. If the mode is currently in insert , then a new line is added and the cursor placed on the next line depending on the value of SET NEWLINE .
- This command can only be used by assigning it to a function key with the DEFINE command.
- This command will be removed in a future version.
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- See Also:
- SOS EXECUTE
- Status:
- Complete.
-
EXPAND - expand tab characters to spaces
- Syntax:
- EXPand [target]
- Description:
- The EXPAND command converts all tab characters to spaces in the target depending on the size of a tab determined by the SET TABS command.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- COMPRESS, SET TABS
- Status:
- Complete.
-
EXTRACT - obtain various internal information about THE
- Syntax:
- EXTract /item/[...]
- Description:
- The EXTRACT command is used to relay information about settings within THE from within a REXX macro. EXTRACT is only valid within a REXX macro.
- For a complete list of item s that can be extracted, see the section; QUERY, EXTRACT and STATUS .
- Compatibility:
- XEDIT: Only allows / as delimiter.
- KEDIT: Only allows / as delimiter.
- Status:
- Complete.
-
FFILE - force a FILE of the current file to disk
- Syntax:
- FFile [filename]
- Description:
- The FFILE command writes the current file to disk to the current file name or to the supplied filename . Unlike the FILE command, if the optional filename exists, this command will overwrite the file.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- Default:
- With no parameters, the current file is written.
- See Also:
- FILE, SAVE, SSAVE
- Status:
- Complete
-
FILE - write the current file to disk and remove from ring
- Syntax:
- FILE [filename]
- Description:
- The FILE command writes the current file to disk to the current file name or to the supplied filename . Unlike the FFILE command, if the optional filename exists, this command will not overwrite the file.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Default:
- With no parameters, the current file is written.
- See Also:
- FFILE, SAVE, SSAVE
- Status:
- Complete
-
FILLBOX - fill the marked box block with a character
- Syntax:
- FILLbox [c]
- Description:
- The FILLBOX command fills the marked block with the specified character, c . If no parameters are supplied and the command is run from the command line, then the box will be filled with spaces. If the command is not run from the command line, the user is prompted for a character to fill the box.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- Status:
- Complete
-
FIND - locate forwards the line which begins with the supplied string
- Syntax:
- Find string
- Description:
- The FIND command attempts to locate a line towards the end of the file that begins with string .
- string can contain two special characters:
- space - this will match any single character in the target line
- underscore - this will match any single space in the target line
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- FINDUP, NFIND, NFINDUP
- Status:
- Complete
-
FINDUP - locate backwards the line which begins with the supplied string
- Syntax:
- FINDUp string
- FUp string
- Description:
- The FINDUP command attempts to locate a line towards the start of the file that begins with string .
- string can contain two special characters:
- space - this will match any single character in the target line
- underscore - this will match any single space in the target line
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- FIND, NFIND, NFINDUP
- Status:
- Complete
-
FORWARD - scroll forwards [n] screens
- Syntax:
- FOrward [n]
- Description:
- The FORWARD command scrolls the file contents forwards n screens.
- If 0 is specified as the number of screens to scroll, the Top-of-File line becomes the current line .
- If the FORWARD command is issued while the current line is the Bottom-of-File line , the Top-of-File line becomes the current line .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Does not support HALF or Lines options.
- Default:
- 1
- See Also:
- BACKWARD, TOP
- Status:
- Complete
-
GET - insert into file the contents of specified file
- Syntax:
- GET [filename] [fromline] [numlines]
- Description:
- The GET command reads a file into the current file, inserting lines after the current line.
- When no filename is supplied the temporary file generated by the last PUT or PUTD command is used.
- When fromline is specified, reading of the file begins at the line number specified. If fromline is not specifed, reading begins at line 1.
- When numlines is specified, reading of the file ends when the specified number of lines has been read. If numlines is not specified, or numlines is specified as '*' , all files from the fromline to the end of file are read.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- PUT, PUTD
- Status:
- Complete
-
HELP - edit help file for THE
- Syntax:
- HELP
- Description:
- The HELP command displays help for the editor. Uses THE_HELP_FILE environment variable to point to the help file. See Appendix 1 for details on this and other environemnt variables.
- Compatibility:
- XEDIT: Similar in concept.
- KEDIT: Similar in concept.
- Status:
- Complete.
-
HIT - simulate hitting of the named key
- Syntax:
- HIT key
- Description:
- The HIT command enables the simulation of hitting the named key . This is most useful from within a macro.
- Be very careful when using the HIT command with the DEFINE command. If you assign the HIT command to a key, DO NOT use the same key name. eg. DEFINE F1 HIT F1 This will result in an infinite processing loop.
- Compatibility:
- XEDIT: N/A
- KEDIT: Similar, but more like the MACRO command.
- Status:
- Complete.
-
INPUT - insert the command line contents into the file
- Syntax:
- Input [string]
- Description:
- The INPUT command inserts the string specified on the 'command line' into the current file after the current line .
- Compatibility:
- XEDIT: Does not provide full input mode option.
- KEDIT: Does not provide full input mode option.
- Status:
- Complete.
-
JOIN - join a line with the line following
- Syntax:
- Join [ALigned]
- Description:
- The JOIN command makes one line out of the focus line and the line following.
- If 'Aligned' is specified, any leading spaces in the following line are ignored. If 'Aligned' is not specified, all characters, including spaces are added.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- SPLIT, SPLTJOIN
- Status:
- Complete.
-
LEFT - scroll the screen to the left
- Syntax:
- LEft [n|HALF]
- Description:
- The LEFT command scrolls the screen to the left.
- If n is supplied, the screen scrolls by that many columns.
- If HALF is specified the screen is scrolled by half the number of columns in the filearea .
- If no parameter is supplied, the screen is scrolled by one column.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- RIGHT, RGTLEFT
- Status:
- Complete.
-
LOCATE - search for a target
- Syntax:
- [Locate] target [command]
- Description:
- The LOCATE command searches for the next or previous occurrence of the specified target . If no parameter is supplied, LOCATE uses the the last target specified. If no prior target has been specified, an error message is displayed.
- With an optional command , this command is executed after finding the target .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
LOWERCASE - change uppercase characters to lowercase
- Syntax:
- LOWercase [target]
- Description:
- The LOWERCASE command changes all uppercase characters in all lines up to the target line to lowercase. All other characters remain untouched.
- Compatibility:
- XEDIT: Equivalent of LOWERCAS command.
- KEDIT: Compatible.
- See Also:
- UPPERCASE
- Status:
- Complete.
-
LS - list the specified directory as an editable file
- Syntax:
- LS [file specification]
- Description:
- The LS command displays all files matching the specified file specification .
- When no parameter is supplied, all files in the current directory are displayed subject to any SET DIRINCLUDE restrictions.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- DIRECTORY, SET DIRINCLUDE
- Status:
- Complete.
-
MACRO - execute a macro command file
- Syntax:
- MACRO filename [arguments ...]
- Description:
- The MACRO command executes the contents of the specified filename as command line commands. The filename can contain either a series of THE commands, or can be a REXX program. The filename is considered a macro .
- REXX macros can be passed optional arguments .
-
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
MARK - mark a portion of text
- Syntax:
- MARK Line|Box|Stream|Word|Column
- Description:
- The MARK command marks a portion of text for later processing by a COPY , MOVE or DELETE command. This marked area is known as a block .
- Compatibility:
- XEDIT: N/A
- KEDIT: Does not implement Stream.
- Adds WORD option and COLUMN options.
- Status:
- Complete.
-
MODIFY - display current SET command for alteration
- Syntax:
- MODify set-command
- Description:
- The MODIFY command displays the current setting of a SET command on the command line enabling the user to change that setting.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- SET, QUERY
- Status:
- Complete.
-
MOVE - move a portion of text
- Syntax:
- MOVE target1 target2
- MOVE BLOCK [RESET]
- Description:
- The MOVE command copies the contents of a portion of the file to the same or a different file, and deletes the marked portion from the original file.
- The first form of the MOVE command, moves the portion of the file specified by target1 to the line spcified by target2 in the same file.
- The second form of the MOVE command moves the contents of the marked block to the current cursor position. If the optional [ RESET ] argument is supplied, the marked block is reset as though a RESET BLOCK command had been issued.
- Compatibility:
- XEDIT: N/A
- KEDIT: Adds extra functionality with [RESET] option.
- Status:
- Incomplete. First form is not supported.
-
MSG - display message on error line
- Syntax:
- MSG [message]
- Description:
- The MSG command displays a message on the message line . This command is usually issued from a macro file. This is similar to EMSG , but MSG does not sound the bell if SET BEEP is on.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- CMSG, EMSG
- Status:
- Complete.
-
NEXT - move forward in the file a number of lines
- Syntax:
- Next [relative target]
- Description:
- The NEXT command moves the current line forwards the number of lines specified by the relative target . This relative target can only be a positive integer or the character "*".
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Default:
- 1
- See Also:
- DOWN, UP
- Status:
- Complete.
-
NEXTWINDOW - switch focus of editing session to another file
- Syntax:
- NEXTWindow
- Description:
- The NEXTWINDOW command moves the focus of the editing session to the other screen (if SCREEN 2 is in effect) or to the next file in the ring .
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- See Also:
- EDIT, SCREEN
- Status:
- Complete.
-
NFIND - locate forwards the line which does NOT begin with the supplied string
- Syntax:
- NFind string
- Description:
- The NFIND command attempts to locate a line towards the end of the file that does NOT begin with string .
- string can contain two special characters:
- space - this will match any single character in the target line
- underscore - this will match any single space in the target line
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- FIND, FINDUP, NFINDUP
- Status:
- Complete
-
NFINDUP - locate backwards the line which does NOT begin with the supplied string
- Syntax:
- NFINDUp string
- NFUp string
- Description:
- The NFINDUP command attempts to locate a line towards the start of the file that does NOT begin with string .
- string can contain two special characters:
- space - this will match any single character in the target line
- underscore - this will match any single space in the target line
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- FIND, FINDUP, NFIND
- Status:
- Complete
-
NOMSG - execute a command suppressing any messages
- Syntax:
- NOMSG command [arguments]
- Description:
- The NOMSG command executes the supplied command but suppresses messages that would normally be displayed as a result of the command.
- Optional arguments may be passed to the command .
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- Status:
- Complete.
-
NOP - no operation command
- Syntax:
- NOP
- Description:
- The NOP command doesn t do anything. It is used as a means of setting a key to do nothing.
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- See Also:
- DEFINE
- Status:
- Complete.
-
OS - execute an operating system command
- Syntax:
- OS [command]
- Description:
- The OS command executes the supplied operating system command or runs an interactive shell if no command is supplied.
- Compatibility:
- XEDIT: N/A
- KEDIT: Equivalent to DOS command.
- See Also:
- DOS, !
- Status:
- Complete.
-
OSNOWAIT - execute an operating system command - no prompt
- Syntax:
- OSNowait command
- Description:
- The OSNOWAIT command executes the supplied operating system command not waiting for the user to be prompted once the command has completed.
- Compatibility:
- XEDIT: N/A
- KEDIT: Equivalent of DOSNOWAIT command.
- See Also:
- DOSNOWAIT
- Status:
- Complete.
-
OSQUIET - execute an operating system command quietly
- Syntax:
- OSQuiet command
- Description:
- The OSQUIET command executes the supplied operating system command as quietly as possible.
- Compatibility:
- XEDIT: N/A
- KEDIT: Equivalent of DOSQUIET command.
- See Also:
- DOSQUIET
- Status:
- Complete.
-
OSREDIR - execute an operating system command and capture output
- Syntax:
- OSRedir filename command [arguments ...]
- Description:
- The OSREDIR command executes the supplied operating system command and redirects output destined for STDOUT and STDERR to the specified filename .
- Optional arguments may be supplied to the command .
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- See Also:
- OS, OSQUIET, OSNOWAIT
- Status:
- Complete.
-
OVERLAYBOX - overlay marked box block on current cursor position
- Syntax:
- OVERLAYBox
- Description:
- The OVERLAYBOX copies the contents of the marked box block over the characters at the current cursor position or to column 1 of the current line if issued from the command line .
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- MOVE, COPY
- Status:
- Complete.
-
PRESERVE - save various editor settings
- Syntax:
- PREServe
- Description:
- The PRESERVE command saves various editing settings at the time the command is issued. These settings can then be restored by using the RESTORE command.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- RESTORE
- Status:
- Incomplete.
-
PRINT - send text to default printer or print spooler
- Syntax:
- PRint [target] [n]
- PRint LINE [text]
- PRint STRING [text]
- PRint FORMfeed
- PRint CLOSE
- Description:
- The PRINT command writes a portion of the current file to the default printer or print spooler, or text entered on the command line.
- PRINT [ target ] [ n ] Sends text from the file contents up to the target to the printer followed by a CR/LF (DOS) or LF(UNIX) after each line. When [ n ] is specified, this sends a formfeed after [ n ] successive lines of text. PRINT LINE [ text ] Sends the remainder of the text on the command line to the printer followed by a CR/LF (DOS) or LF(UNIX). PRINT STRING [ text ] Sends the remainder of the text on the command line to the printer without any trailing line terminator. PRINT FORMfeed Sends a formfeed (^L) character to the printer. PRINT CLOSE Closes the printer spooler.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- SET PRINTER
- Status:
- Complete.
-
PUT - write part of a file to another
- Syntax:
- PUT [target] [filename]
- Description:
- The PUT command writes a portion of the current file, defined by target to another file, either explicit or temporary.
- When no filename is supplied the temporary file used for PUT and GET commands is overwritten.
- When a filename is supplied the portion of the file written out is appended to the specified file.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- PUTD, GET
- Status:
- Complete.
-
PUTD - write part of a file to another and delete
- Syntax:
- PUTD [target] [filename]
- Description:
- The PUTD command writes a portion of the current file, defined by target to another file, either explicit or temporary, and then deletes the lines written.
- When no filename is supplied the temporary file used for PUT and GET commands is overwritten.
- When a filename is supplied the portion of the file written out is appended to the specified file.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- PUT, GET
- Status:
- Complete.
-
QQUIT - exit from the current file without saving changes
- Syntax:
- QQuit
- Description:
- The QQUIT command exits the user from the current file, whether changes made to the file have been saved or not.
- The previous file in the ring then becomes the current file.
- If the current file is the only file in the ring , THE terminates.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- QUIT
- Status:
- Complete
-
QUERY - display various option settings
- Syntax:
- Query item
- Description:
- The QUERY command displays the various settings for options set by THE.
- For a complete list of item s that can be extracted, see the section; QUERY, EXTRACT and STATUS .
- Compatibility:
- XEDIT: Compatible functionality, but not all options.
- KEDIT: Compatible functionality, but not all options.
- See Also:
- STATUS, MODIFY
- Status:
- Complete.
-
QUIT - exit from the current file if no changes made
- Syntax:
- QUIT
- Description:
- The QUIT command exits the user from the current file, provided that any changes made to the file have been saved, otherwise an error message is displayed.
- The previous file in the ring then becomes the current file.
- If the current file is the only file in the ring , THE terminates.
- Compatibility:
- XEDIT: Does not support return code option.
- KEDIT: Compatible.
- See Also:
- QQUIT
- Status:
- Complete
-
READV - read keystrokes and pass to macro
- Syntax:
- READV Cmdline [initial text]
- READV KEY
- Description:
- The READV command allows a REXX macro to interact with the user by accepting either individual keystrokes ( KEY ) or a complete line of text ( Cmdline ).
- The READV Cmdline can take optional initial text to be displayed on the command line.
- The 'macro' obtains the entered information by setting REXX variables. These are set as follows.
- KEY option:
- readv.0 = 3
- readv.1 = name of key (empty if unknown)
- readv.2 = ASCII value of key (null if not an ASCII code)
- readv.3 = curses key value (or ASCII code if an ASCII code)
- 'CMDLINE' option:
- readv.0 = 1
- readv.1 = contents of command line
- While editting the command in READV Cmdline , any key redefinitions you have made will be in effect. Therefore you can use your "normal" editting keys to edit the line. THE will allow the following commands to be executed while in READV Cmdline :
- cursor left, cursor right, cursor down, cursor up,
- sos firstchar , sos endchar , sos startendchar ,
- sos delend , sos delchar , sos delchar ,
- sos tabb , sos tabf , sos tabwordb , sos tabwordf ,
- sos undo , sos delword , set insertmode , text
- Either of the keys, ENTER, RETURN and NUMENTER will terminate READV Cmdline , irrespective of what THE commands have been assigned.
- Compatibility:
- XEDIT: Similar to READ CMDLINE option.
- KEDIT: Compatible.
- Status:
- Complete.
-
RECOVER - recover changed or deleted lines
- Syntax:
- RECover [n|*]
- Description:
- The RECOVER command restores the last n , or all * changed or deleted lines back into the body of the file.
- Compatibility:
- XEDIT: Also recovers changes to lines, not just lines deleted.
- KEDIT: Compatible.
- Status:
- Complete.
-
REDRAW - redraw the current screen
- Syntax:
- REDRAW
- Description:
- The REDRAW command redraws the current contents of the screen. This is usually used when some outside influence has affected the display.
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- See Also:
- REFRESH
- Status:
- Complete.
-
REFRESH - refresh the contents of the current screen
- Syntax:
- REFRESH
- Description:
- The REFRESH command refreshes what is being displayed on the screen. This is usually used from within a macro to indicate the progress of the macro .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- REDRAW
- Status:
- Complete.
-
REPEAT - repeat the last command
- Syntax:
- REPEat [target]
- Description:
- The REPEAT command advances the current line and executes the last command. It is equivalent to NEXT 1 (or UP 1) and = for the specified number of times specified by target .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Incomplete
-
REPLACE - replace the current line with supplied text
- Syntax:
- Replace [text]
- Description:
- The REPLACE command replaces the focus line with the supplied text .
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
RESET - cancel the marked block or prefix commands or both
- Syntax:
- RESet ALL|Block|Prefix
- Description:
- The RESET command unmarks any marked block or outstanding prefix commands or both.
- Compatibility:
- XEDIT: Adds Block and All options.
- KEDIT: Compatible.
- Status:
- Complete.
-
RESTORE - restore various editor settings
- Syntax:
- REStore
- Description:
- The RESTORE command restores various editing settings at the time the command is issued. These settings must have been saved with the PRESERVE command.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- PRESERVE
- Status:
- Incomplete.
-
RGTLEFT - scroll the screen to the left or right
- Syntax:
- RGTLEFT [n]
- Description:
- The RGTLEFT command scrolls the screen n columns to the right if the value of vershift is less than or equal to 0, or if the value of vershift is greater than 0, the screen is scrolled n columns to the left.
- If n is not specified, the screen scrolls by three quarters the number of columns displayed.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- LEFT, RIGHT
- Status:
- Complete.
-
RIGHT - scroll the screen to the right
- Syntax:
- RIght [n|HALF]
- Description:
- The RIGHT command scrolls the screen to the right.
- If n is supplied, the screen scrolls by that many columns.
- If HALF is specified the screen is scrolled by half the number of columns in the filearea .
- If no parameter is supplied, the screen is scrolled by one column.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- LEFT, RGTLEFT
- Status:
- Complete.
-
SAVE - save changes to current file
- Syntax:
- SAVE [filename]
- Description:
- The SAVE command writes the current file to disk. If a filename is supplied, the current file is saved in that file, unless the file already exists which will result in an error message being displayed. The 'Alterations' counter on the idline is reset to zero.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- SSAVE, FILE, FFILE
- Status:
- Complete
-
SCHANGE - selectively change strings
- Syntax:
- SCHange /string1/string2/ [target] [n] [m]
- Description:
- The SCHANGE command changes one string of text to another only after confirming each individual change with the user.
- The first parameter to the change command is the old and new string values, seperated by delimiters. The allowable delimiters are '/' '\' and '@' .
- The second parameter is the target ; how many lines are to be searched for occurrences of string1 to be changed.
- n determines how many occurrences of string1 are to be changed to string2 on each line.
- m determines from which occurrence of string1 on the line changes are to commence.
- Compatibility:
- XEDIT: Functionally compatible, but syntax different.
- KEDIT: Compatible.
- Default:
- 1 1 1
- See Also:
- CHANGE
- Status:
- Complete.
-
SET - execute various set commands
- Syntax:
- SET set_command [set_command parameter(s) ...]
- Description:
- The SET command is a front end to existing SET commands. It treats the first parameter it receives as a command and executes it.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
SHIFT - move text left or right
- Syntax:
- SHift Left|Right [n] [target]
- Description:
- The SHIFT command moves text in the direction specified the number of columns n for the specified target lines.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Status:
- Complete.
-
SHOWKEY - display current key value and command assignation
- Syntax:
- SHOWkey [ALL]
- Description:
-
- With no parameter, the SHOWKEY command prompts the user to enter a key and responds with the key name and associated command (if applicable). To exit from SHOWKEY, press the space bar.
- With ALL specified, a new file is added to the ring with all default key mappings and any key mappings assigned with the DEFINE command shown. The key mappings are displayed as DEFINE commands.
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- Status:
- Complete.
-
SORT - sort selected lines in a file
- Syntax:
- SORT target [[sort field 1] [...] [sort field 10]]
- Description:
- The SORT command sort a portion of a file based on the sort field specifications.
- A sort field specification consists of:
- order flag - [Ascending|Descending]
- left column - left column of field to sort on
- right column - right column of field to sort on
- The right column MUST be >= left column.
- Only 10 sort fields are allowed.
- target can be any valid target including ALL, *, -*, and BLOCK.
- Compatibility:
- XEDIT: XEDIT only allows ordering flag for all fields
- KEDIT: Compatible.
- Status:
- Complete.
-
SOS - execute various sos commands
- Syntax:
- SOS sos_command [sos_command ...]
- Description:
- The SOS command is a front end to existing SOS commands. It treats each parameter it receives as a command and executes it.
- Compatibility:
- XEDIT: XEDIT only permits 1 command
- KEDIT: Compatible.
- Status:
- Complete.
-
SPLIT - split a line into two lines
- Syntax:
- SPlit [ALigned]
- Description:
- The SPLIT command splits the focus line into two lines.
- If 'Aligned' is specified, the first non-blank character of the new line is positioned under the first non-blank character of the focus line .
- If 'Aligned' is not specified, the text of the new line starts in column 1.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- JOIN, SPLTJOIN
- Status:
- Complete.
-
SPLTJOIN - split/join two lines
- Syntax:
- spltjoin
- Description:
- The SPLTJOIN command splits the focus line into two or joins the focus line with the next line depending on the position of the cursor.
- If the cursor is after the last column of a line, the JOIN command is executed, otherwise the SPLIT command is executed.
- The text in the new line is aligned with the text in the focus line .
- This command can only be used by assigning it to a function key.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- JOIN, SPLIT
- Status:
- Complete.
-
SSAVE - force SAVE to specified file
- Syntax:
- SSave [filename]
- Description:
- The SSAVE command writes the current file to disk. If a filename is supplied, the current file is saved in that file, otherwise the current name of the file is used.
- If a filename is supplied and that filename already exists, the previous contents of that filename will be replaced with the current file.
- The 'Alterations' counter on the idline is reset to zero.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- See Also:
- SAVE, FILE, FFILE
- Status:
- Complete
-
STATUS - display current settings of various variables
- Syntax:
- STATus [filename]
- Description:
- The STATUS command, without the optional filename , displays a full screen of current settings for various variables.
- With the filename , the STATUS command creates a file containing a series of SET commands with the current values of these settings.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible. KEDIT does not support [ filename ] option.
- See Also:
- QUERY, EXTRACT, MODIFY
- Status:
- Complete
-
SUSPEND - suspend THE and return to operating system
- Syntax:
- SUSPend
- Description:
- The SUSPEND command suspends the current editing session and returns control to the operating system. Under DOS and OS/2 this is the equivalent of OSNOWAIT . Under UNIX, the process gets placed in the background until it is brought to the foreground.
- Compatibility:
- XEDIT: N/A
- KEDIT: N/A
- See Also:
- OSNOWAIT
- Status:
- Complete
-
TABPRE - switch between FILEAREA and PREFIX area
- Syntax:
- tabpre
- Description:
- The TABPRE command switches the focus of the editor from the filearea to the prefix area and vice versa, depending on which window is currently active.
- This command can only be used by assigning it to a function key.
- This command will be removed in a future version.
- Compatibility:
- XEDIT: N/A
- KEDIT: Equivalent of SOS LEFTEDGE and SOS PREFIX
- See Also:
- SOS LEFTEDGE, SOS PREFIX
- Status:
- Complete.
-
TEXT - simulate keyboard entry of characters
- Syntax:
- TEXT text
- Description:
- The TEXT command simulates the entry of text from the keyboard. This command is actually called when you enter text from the keyboard.
- Compatibility:
- XEDIT: N/A
- KEDIT: Compatible.
- Does not allow trailing spaces in text.
- Status:
- Complete.
-
THE - edit another file or switch to next file
- Syntax:
- THE [filename]
- Description:
- The THE command allows the user to edit another 'file' . The new file is placed in the file ring . The previous file being edited remains in memory and can be returned to by issuing a THE command without any parameters. Several files can be edited at once, and all files are arranged in a ring, with subsequent THE commands moving through the ring, one file at a time.
- Compatibility:
- XEDIT: Does not provide options switches.
- KEDIT: Does not provide options switches.
- See Also:
- XEDIT, EDIT
- Status:
- Complete.
-
TOP - move to the top of the file
- Syntax:
- TOP
- Description:
- The TOP command moves to the very start of the current file. The Top-of-File line is set to the current line .
- TOP is equivalent to BACKWARD *.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- See Also:
- BACKWARD, BOTTOM
- Status:
- Complete
-
UP - move backward in the file a number of lines
- Syntax:
- Up [relative target]
- Description:
- The UP command moves the current line backwards the number of lines specified by the relative target . This relative target can only be a positive integer or the character "*".
- Compatibility:
- XEDIT: Compatible.
- KEDIT: Compatible.
- Default:
- 1
- See Also:
- NEXT, DOWN
- Status:
- Complete.
-
UPPERCASE - change lowercase characters to uppercase
- Syntax:
- UPPercase [target]
- Description:
- The UPPERCASE command changes all lowercase characters in all lines up to the target line to uppercase. All other characters remain untouched.
- Compatibility:
- XEDIT: Equivalent of UPPERCAS
- KEDIT: Compatible.
- See Also:
- LOWERCASE
- Status:
- Complete.
-
XEDIT - edit another file or switch to next file
- Syntax:
- Xedit [file]
- Description:
- The XEDIT command allows the user to edit another file . The new file is placed in the file ring . The previous file being edited remains in memory and can be returned to by issuing an XEDIT command without any parameters. Several files can be edited at once, and all files are arranged in a ring, with subsequent XEDIT commands moving through the ring, one file at a time.
- Compatibility:
- XEDIT: Does not provide options switches.
- KEDIT: Does not provide options switches.
- See Also:
- EDIT, THE
- Status:
- Complete.
-
? - retrieve - return the next/prior command on the command line
- Syntax:
- ?[+]
- Description:
- The ? command returns the next or prior command from the command line ring and displays it on the command line.
- With the [ + ] argument, the next command in the command ring is retrieved.
- With no arguments, the previous command entered on the command line is retrieved.
- Compatibility:
- XEDIT: Compatible.
- KEDIT: See below..
- Does not support multiple ? as in ??? to retrieve the third last
- command.
- This command is bound to the up and down arrows when on the
- command line depending on the setting of SET CMDARROWS .
- See Also:
- SET CMDARROWS
- Status:
- Complete.
-
= - re-execute the last command issued on the command line
- Syntax:
- =
- Description:
- The = command retrieves the most recently issued command from the command line and re-executes it.
- Compatibility:
- XEDIT: Does not support optional [subcommand] option.
- KEDIT: Does not support optional [command] option.
- Status:
- Complete.
-
! - execute an operating system command
- Syntax:
- ! [command]
- Description:
- The ! command executes the supplied operating system command or runs an interactive shell if no command is supplied.
- Compatibility:
- XEDIT: N/A
- KEDIT: Equivalent to DOS command.
- See Also:
- DOS, OS
- Status:
- Complete.
The Hessling Editor is Copyright © Mark Hessling, 1990-1996
<M.Hessling@qut.edu.au>
Generated on: 26 May 1996
Return to Table of Contents