XEDIT Subcommands and Macros

This chapter describes the formats and operands of the XEDIT subcommands and macros. Use the CMS command XEDIT, described in Chapter 2 to invoke the editor prior to issuing these subcommands and macros.

An XEDIT subcommand is a command which is only valid in the environment of the editor. An XEDIT macro is a procedures language (such as REXX) program which issues XEDIT subcommands to the editor.

XEDIT subcommands and macros are generally issued from the XEDIT command line, though they may be issued from a procedures language environment such as REXX. XEDIT sets up a subcommand environment (SUBCOM) named XEDIT to process subcommands which are issued from a procedures language environment. See the XEDIT subcommands in this chapter for responses (such as return codes) that can be issued by the subcommands.

See z/VM: REXX/VM Reference chapter that describes General Concepts — Issuing Subcommands from Your Program for details on how to invoke XEDIT subcommands from a procedures language program (such as REXX). Also see the chapter that describes System Interfaces — Calls Originating from a Clause That is an Expression for details on how REXX passes XEDIT subcommands to the XEDIT SUBCOM.

Some XEDIT subcommands and macros may also require the presence of the EXECCOMM SUBCOM. See z/VM: REXX/VM Reference chapter that describes System Interfaces — Direct Interface to Current Variables for more about EXECCOMM SUBCOM.

XEDIT subcommands and macros in this book are listed in alphabetic order for easy reference. Each subcommand and macro description includes the format and description of operands and, where applicable, usage notes, notes for macro writers, responses, error messages and return codes, and examples.

The following commands and subcommands exist in the CP, CMS, and XEDIT environments:
  • CP
  • QUERY
  • SET
The following commands and subcommands exist in the CMS and XEDIT environments:
  • DELETE
  • EXPAND
  • HELP
  • LOAD
  • REFRESH
  • SORT
  • TYPE
  • XEDIT
The following commands and subcommands exist in the CP and XEDIT environments:
  • CHANGE
  • PURGE
  • RESET
  • TRANSFER

The editor has two modes of operation: edit mode and input mode. Whenever the XEDIT command is entered, edit mode is entered; when the INPUT or REPLACE subcommands are issued with no operands, or when the POWERINP subcommand is issued, input mode is entered. For more information on how to use the editor, see z/VM: XEDIT User's Guide.

Table 1 lists XEDIT subcommands and summary explanations.

Table 1. XEDIT Subcommand Summary
Subcommand Purpose
Add Adds n line(s) after current line.
ALL Selects a collection of lines for display/editing.
ALter Changes a single character to another (character or hex).
BAckward Scrolls backward n screen displays.
Bottom Goes to last line of file.
CANCEL Terminates the editing session for all files.
CAppend Adds text to end of current line.
CDelete Deletes characters, starting at column pointer.
CFirst Moves column pointer to beginning of the zone.
Change Changes one string to another.
CInsert Inserts text starting at the column pointer of the current line.
CLAst Moves the column pointer to the end of the zone specified.
CLocate Locates a string; moves the column pointer and the line pointer.
CMS Passes a command to CMS, or enters CMS subset mode.
CMSG Displays message in command line of user's screen.
COMMAND Executes a subcommand without checking for synonym or macro.
COMPress Prepares line(s) for realignment by replacing blanks with tab characters.
COpy Copies line(s) at specified location.
COUnt Displays the number of times a string appears.
COVerlay Replaces characters, starting at column pointer.
CP Passes command to control program.
CReplace Replaces characters, starting at the column pointer.
CURsor Moves the cursor to specified position on the screen, and optionally assigns a priority for this position.
DELete Deletes line(s) beginning with the current line.
Down Moves line pointer n lines toward end of file (same as NEXT).
DUPlicat Duplicates line(s).
EMSG Displays a message and sounds the alarm.
EXPand Repositions data according to new tab settings.
EXTract Returns information about internal XEDIT variables and file data.
FILE Writes file to disk or directory.
Find Searches for line that starts with specified text.
FINDUp Searches for a line that starts with specified text; searches in a backward direction.
FOrward Scrolls forward n screen displays.
GET Inserts lines from another file.
Help Requests online display of XEDIT subcommands and macros; invokes the z/VM® HELP Facility.
HEXType Displays line(s) in hexadecimal and EBCDIC.
Input Inserts a single line, or enters input mode.
Join Combines two or more lines into one line.
LEft Views data to the left of column one.
LOAD Reads file into storage; use in profile macro only.
Locate Moves line pointer to specified target.
LOWercas Changes uppercase letters to lowercase.
LPrefix Simulates writing in the prefix area of the current line. Used on typewriter terminals.
MACRO Executes macro without checking for subcommand or synonym.
MErge Combines two sets of lines.
MODify Displays a subcommand and its current values in the command line, so it can be overtyped and reentered.
MOve Moves line(s) to another place in the file.
MSG Displays message in message line.
Next Moves line pointer n lines toward end of file (same as DOWN).
NFind Searches forward for first line that does not start with the specified text.
NFINDUp Searches backward for first line that does not start with the specified text.
Overlay Replaces characters in current line.
PARSE Scans a line of a macro to check the format of its operands.
POWerinp Enters input mode for continuous typing.
PREServe Saves settings of XEDIT variables until RESTORE is entered.
PURge Removes macro from virtual storage.
PUT Inserts lines into another file (new or existing), or into a buffer (to be retrieved by GET from another file).
PUTD Same as PUT, but deletes original lines.
Query Displays the current value of editing options.
QUIT Ends an editing session without saving changes.
READ Places information from the terminal in the console stack.
RECover Replaces removed lines.
REFRESH Issued from a macro, it updates the display on the screen.
RENum Renumbers VSBASIC or FREEFORT files.
REPEat Advances line pointer and re-executes last subcommand.
Replace Replaces current line, or deletes current line and enters input mode.
RESet Removes prefix subcommands or macros when screen is in pending status.
RESTore Restores settings of XEDIT variables to values they had when PRESERVE was issued.
RGTLEFT Shifts display to the right or left; reissue to shift back to original display.
RIght Views data to the right of the last (right-most) column.
SAVE Writes file to disk or directory and remains in edit mode.
SCHANGE Locates string and makes a selective change, using PF keys.
SET ALT Changes the number of alterations that have been made to the file since the last AUTOSAVE or since the last SAVE.
SET APL Informs the editor and CMS if APL keys are used.
SET ARBchar Defines an arbitrary character to be used in a target definition.
SET AUtosave Automatically issues a SAVE subcommand at specified intervals.
SET BFSLine Controls the translation between records and byte stream for BFS files.
SET BRKkey Specifies whether CP should break in when the BRKKEY (defined by CP TERMINAL BRKKEY) is pressed.
SET CASE Uppercase or lowercase control; specifies if case is significant in target searches.
SET CMDline Moves the position of the command line.
SET COLOR Associates specific colors and attributes with various fields on the XEDIT screen.
SET COLPtr Specifies if column pointer is displayed (typewriter terminals only).
SET CTLchar Defines a control character(s), which associate parts of a reserved line with highlighting, protection, visibility, various colors, extended highlighting, and Programmed Symbol Sets.
SET CURLine Defines the position of the current line on the screen.
SET DISPlay Indicates which selection levels of lines will be displayed on the screen.
SET ENTer Defines a meaning for the Enter key.
SET ESCape Defines a character that lets you enter a subcommand while in input mode (typewriter terminals only).
SET ETARBCH Defines an arbitrary character within a file containing Double-Byte Character Set (DBCS) characters to be used in target definitions.
SET ETMODE Informs the editor that there are Double-Byte Character Set strings in the file.
SET FILler Defines a character that is used when a line is expanded.
SET FMode Changes the file mode of the current file.
SET FName Changes the file name of the current file.
SET FType Changes the file type of the current file.
SET FULLread Controls whether the 3270 null character is recognized in the middle of the screen lines.
SET HEX Allows string operands and targets to be specified in hexadecimal.
SET IMage Controls how tabs and backspaces are handled when a line is entered.
SET IMPcmscp Controls whether subcommands not recognized by the editor are transmitted to CMS and CP.
SET LASTLorc Defines the contents of the last locate or change buffer.
SET LINENd Defines a line end character.
SET LRecl Defines a new logical record length.
SET MACRO Controls the order in which the editor searches for subcommands and macros.
SET MASK Defines a new mask, which is the contents of added lines and the input zone.
SET MSGLine Defines position of message line and the number of lines a message may expand to.
SET MSGMode Controls the message display.
SET NAMetype File IDs are in CMS format (fn ft fm) or in BFS format (pathname).
SET NONDisp Defines a character to XEDIT and CMS that is used in place of non-displayable characters.
SET NULls Specifies whether trailing blanks are replaced with nulls to allow character insertion.
SET NUMber Specifies whether file line numbers are displayed in the prefix area.
SET PAn Defines a meaning for a PA key.
SET PACK Specifies if the file is to be written to disk or SFS directory in packed format.
SET PENDing Controls the execution of a prefix macro and the status of the screen while the macro is being executed.
SET PFn Defines a meaning for a PF key.
SET PName Changes the BFS path name of the current file.
SET Point Defines a symbolic name for the current line.
SET PREfix Controls the display of the prefix area or defines a synonym for a prefix subcommand.
SET RANge Controls limits for line-pointer movement.
SET RECFm Defines the record format.
SET REMote Controls the way data transmission is handled in XEDIT and CMS.
SET RESERved Reserves a line, which cannot be used by the editor.
SET SCALe Controls the display of the scale line.
SET SCOPE Specifies whether the editor operates on the entire file or on only those lines displayed.
SET SCReen Divides the screen into logical screens, for multiple views of the same or of different files.
SET SELect Assigns a selection level to a line or group of lines in a file.
SET SERial Controls file serialization.
SET SHADow Specifies whether the file is to be displayed with or without shadow lines indicating where lines have been excluded from the display.
SET SIDcode Specifies a character string that is to be inserted into every line of an update file.
SET SPAN Allows a string target to span a number of lines.
SET SPILL Controls whether truncation will occur for certain subcommands.
SET STAY Specifies for certain subcommands whether the line pointer moves when searching for a string.
SET STReam Specifies whether the editor searches only the current line or the whole file for a column-target.
SET SYNonym Specifies whether the editor looks for synonyms; assigns a synonym.
SET TABLine Controls the display of the tab line.
SET TABS Defines the logical tab stops.
SET TERMinal Specifies whether a terminal is used in line mode or full-screen mode.
SET TEXT Informs the editor and CMS if TEXT keys are used.
SET TOFEOF Controls the display of TOF/EOF lines.
SET TRANSLat Controls user-defined uppercase translation.
SET TRunc Defines the truncation column.
SET VARblank Specifies whether the number of blanks between two words is significant in a target search.
SET Verify Controls whether lines changed by subcommands are displayed; defines the columns displayed and whether displayed in EBCDIC, hexadecimal or both.
SET WRap Controls whether the editor wraps around the file if EOF (or TOF for backward searches) is reached during a search.
SET Zone Defines new limits within each line for target searches.
SET = Inserts string into the equal buffer.
SHift Moves data right or left (data loss possible).
SI Continuously adds lines and positions cursor for indented text.
SORT Sorts all or part of a file, in ascending or descending order.
SOS Specifies functions for screen operation simulation.
SPlit Splits a line into two or more lines.
SPLTJOIN Splits a line or joins two lines at the cursor.
STAck Places line(s) from the file into the console stack.
STATus Displays SET subcommand current settings; creates a macro that contains these settings.
SUPerset Specifies multiple SET options on one subcommand to improve performance.
TOP Moves line pointer to null TOP OF FILE line.
TRAnsfer Places editing variable(s) in the console stack, for use by a macro.
Type Displays lines.
Up Moves line pointer n lines toward top of file.
UPPercas Translates all lowercase characters to uppercase.
Xedit Edits multiple files.
& Use before a subcommand to redisplay the command.
= Re-executes the last subcommand, macro, or CP/CMS command.
? Displays the last subcommand, macro, or CP/CMS command executed.