Version 4.2.6	SEARCH   INDEX   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT

This section gives a short description of each main command provided by the Software AG Editor and a complete overview of the command syntax.

For general information on using main commands, see Using Commands.

For explanations of the syntax symbols used in this section, refer to System Command Syntax in the System Commands documentation.

Note:
If line numbers appear in the prefix area, column 8 on the screen corresponds to column 1 of the editing area. This is important when specifying columns in main commands.

This section covers the following topics:

• ADVANCE

• AORDER

• AUTOREN

• AUTOSAVE

• BNDS

• BOTTOM

• CANCEL

• CAPS

• CENTER

• CHANGE

• COLS

• CURSOR

• CWINDOW

• DELETE

• DOWN

• DWINDOW

• EMPTY

• END

• ESCAPE

• EXCLUDE

• FIND

• FIX

• HEX

• INCLUDE

• JLEFT

• JRIGHT

• JUSTIFY

• LABEL

• LC

• LEFT

• LIMIT

• LOCATE

• LOG

• MASK

• MWINDOW

• NULLS

• ORDER

• POWER

• PROFILE

• PROTECT

• RCHANGE

• RECOVERY

• RENUMBER

• RESET

• RFIND

• RIGHT

• SORT

• TABS

• TOP

• UC

• UNDO

• UNREN

• UP

• WINDOW

• XSWAP

• Common Command Options

ADVANCE

This command is used to specify whether the cursor moves to the next line automatically after a line update.

If an unqualified ADVANCE command is issued, it is interpreted as ADVANCE ON. The default setting is ADVANCE ON and can be changed by editing your profile; see Setting the Editor Profile.

AORDER

This command is used to specify whether text is to be automatically justified within the set boundaries.

If an unqualified AORDER command is issued, it is interpreted as AORDER ON. The base setting can be changed by editing your profile; see Setting the Editor Profile.

AUTOREN

For PDS members and sequential data sets only. This command is used to specify whether the editor automatically activates the RENUMBER function.

If an unqualified AUTOREN command is issued, it is interpreted as an AUTOREN ON command. The base setting can be changed by editing your profile; see Setting the Editor Profile.

AUTOSAVE

This command is used to specify whether the editor executes an automatic SAVE command when you issue the END command.

If an unqualified AUTOSAVE command is issued, it is interpreted as an AUTOSAVE ON command. Default setting is AUTOSAVE ON and can be changed by editing your profile; see Setting the Editor Profile.

BNDS

This command is used to restrict the effect of certain commands to a specific range of columns.

These boundaries apply to the main commands FIND, CHANGE, CENTER, ORDER, JLEFT and JRIGHT, and their corresponding line commands (for example, TC, TO, LJ or RJ).

If n and m are omitted, the boundaries are set at the first and last column of the editing area.

To see the current boundary settings, issue the BNDS line command.

BOTTOM

This command is used to scroll to the end of the object being edited.

CANCEL

Backs out all changes to data made during the current editing session and leaves the editor. Any changes made since the last time you saved the data are lost.

CAPS

This command is used to switch upper-case translation on and off.

The CAPS command issued without a parameter has the same effect as CAPS ON. The default is CAPS ON. Edit your profile to change this; see Setting the Editor Profile.

CENTER

This command is used to center data.

The CENTER command applies only within the horizontal boundaries as set with the main command BNDS.

For centering, you can also use the line commands TC and TCC.

CHANGE

This command is used to replace a character string (string1) by another character string (string2).

If you want an apostrophe to be part of string1 or string2, you must write it as two apostrophes.

You can specify the string to be replaced (string1) as described in the following section.

This section covers the following topics:

• Using CHANGE Together with Other Commands

• Examples of the CHANGE Command

Using CHANGE Together with Other Commands

To repeat the execution of a CHANGE command, you use the command RCHANGE.

To search the entire data for a character string and then decide occurrence by occurrence whether to replace it by another character string, you can use a combination of the commands FIND, CHANGE, RFIND and RCHANGE:

First, you search for the string:

FIND 'string'

When the string has been found, you can decide whether to:

• replace it:

  CHANGE 'string' 'new-string'

• or search for the next occurrence of the string by repeating the FIND command:

  RFIND

When the next occurrence of the string has been found, you can again decide whether to:

• replace it by repeating the CHANGE command:

  RCHANGE

• or search for the next occurrence of the string by repeating the FIND command:

  RFIND

Examples of the CHANGE Command

Example 1:

CHG 'LOW' 'HIGH'

This command replaces the first occurrence of LOW by HIGH, regardless of upper or lower case.

Example 2:

CHG C'OPS' 'SPF' .X .Y 28 32 ALL

This command changes OPS (exactly as entered here) into SPF; it changes all occurrences in the block of lines labeled with .X and .Y and between columns 28 and 32.

Example 3:

CHG C'NAME' 'APPL' .X .Y ALL PREFIX NX

This command changes all occurrences of prefix NAME (exactly as entered here) into APPL in all displayed lines in the block labeled with .X and .Y.

Example 4:

CHG * 'NEW'

This command replaces the next occurrence of the string specified in the last CHANGE command by the string NEW.

Example 5:

CHG 'OLD' *

This command replaces the next occurrence of the string OLD by the same new string as specified in the last CHANGE command.

COLS

This command displays a line at the top of the editing area showing column positions.

To display the column positions, you can also use the line command COLS.

CURSOR

This command returns the cursor to the command line when you next press ENTER.

CWINDOW

This command is used to copy a data window according to the command parameters.

DELETE

This command is used to delete lines.

You can specify that only lines which contain a specified character string are to be deleted as described in the following section.

If you enter the DELETE command without any parameters, the current line is deleted.

To delete lines, you can also use the line commands D, Dn and DD.

Example 1:

DEL C'NAME' 1 20 ALL PREFIX NX

This command deletes all lines that contain the string NAME (in upper case exactly as entered here) as a prefix to a word in all lines not excluded from display, if NAME occurs between columns 1 and 20.

Example 2:

DEL C'Abc' .X .Y 10 30 ALL

This command deletes all lines that contain the string Abc (exactly as entered here) between columns 10 and 30 within the block of lines labeled with .X and .Y

DOWN

This command is used to scroll downwards in the data.

The parameter n specifies the number of lines to be scrolled downwards. If n is omitted, the scroll amount is determined by the scroll mode.

DWINDOW

This command is used to delete the last defined data window.

EMPTY

This command controls the deletion of blank lines in the editor.

If you enter EMPTY without any parameter, it is interpreted as EMPTY ON. The default setting is EMPTY OFF (no suppression) and can be changed by editing your profile; see Setting the Editor Profile.

END

Stores the data including all changes and leaves the Software AG Editor.

The command format is:

If AUTOSAVE is set to OFF and you have changed data, the editor asks you to issue a SAVE or CANCEL command.

ESCAPE

This command activates or deactivates the escape character to precede line commands entered in the first column of the data.

The parameter character is the special character to be used. The default escape character is the period (.).

If you issue the ESCAPE command without any parameter, it is interpreted as ESCAPE ON. Default is ESCAPE OFF. Can be changed by editing profile; see Setting the Editor Profile.

EXCLUDE

This command is used to exclude lines from being displayed.

You can specify that only lines which contain a specified character string are to be excluded from display as described in the following section.

If you enter the EXCLUDE command without any parameters, the current line is excluded from display.

To re-display excluded lines, you use the main command INCLUDE.

Example 1:

EX 10

This command excludes line 10 from display.

Example 2:

EX C'NAME' .X ALL PREFIX

This command excludes from display all lines which contain NAME (in upper case as entered here) as a prefix to a word, starting from the line labeled with .X.

FIND

This command is used to search for a specific character string. The cursor is placed on the beginning of the first found string. If the line containing the string was excluded from display, it is displayed when found.

If you want an apostrophe to be part of the string, you must write it as two apostrophes.

You can specify the string as described in the following section.

The FIND command differs from the LOCATE command in the following ways:

• The FIND command is more effective for text searches while the LOCATE command is used primarily to find line numbers or line labels.

• The LOCATE command finds only text in upper case beginning in column one of the editor. In addition, in order to find a string, the data in the editor must be in alphabetical order.

• When a line is located with the LOCATE command, the cursor is placed in the prefix area and the line is placed at the top of the editor; with the FIND command, the cursor is placed on the string searched and the line is not necessarily placed at the top of the editor.

To repeat the execution of a FIND command, use the command RFIND.

Example 1:

F C'NAME' .X .Y ALL PREFIX X

This command searches for any occurrence of NAME exactly as entered here as a prefix of a word in any excluded line within the block delineated by .X and .Y.

Example 2:

F C'HILITE' X PREV

This command searches for the previous occurrence of HILITE exactly as entered here in any excluded line.

Example 3:

F P'RCV#' .X .Z 20 30

This command searches for any 4-character string that begins with RCV and whose fourth character is numeric. It searches within the block of lines delineated by .X and .Z and between columns 20 to 30.

Example 4:

F X'6C' SUFFIX NX

This command searches for the character with hexadecimal representation 6C. Only those occurrences of the character that are at the end of word are found. The search is valid for non-excluded lines only.

Example 5:

F '''w'

This command searches for the following character string: 'w.

Example 6:

F 'r''w'

This command searches for the following character string: r'w.

Example 7:

F ''''

This command searches for an apostrophe.

FIX

This command is used to specify the number of columns n, starting with column 1, to remain in display when scrolling to the right. The default setting is FIX OFF 000 and can be changed by editing your profile; see Setting the Editor Profile.

HEX

This command is used to switch hexadecimal display mode on and off.

The default setting is HEX ON and can be changed by editing your profile; see Setting the Editor Profile.

INCLUDE

This command is used to re-display lines that were excluded from display by an EXCLUDE command. The command takes the same parameters as the EXCLUDE command.

If you enter the INCLUDE command without any parameters, it includes the first line of an excluded block.

Example:

IN C'NAME' .X ALL PREFIX

This command recalls all excluded lines with NAME as a prefix to a word exactly as entered here, starting from the line labeled .X.

JLEFT

This command is used to align data left-justified.

The JLEFT command applies only within the horizontal boundaries as set with the main command BNDS.

For left-justification, you can also use the line commands LJ and LJJ.

See also the main command JRIGHT.

Example:

BNDS 10;JLEFT 15 20

The data between column 10 and the rightmost column of your screen in lines 15 to 20 is left-aligned to column 10.

JRIGHT

This command is used to align data right-justified.

The JRIGHT command applies only within the horizontal boundaries as set with the main command BNDS.

For right-justification, you can also use the line commands  LJ and LJJ.

See also the main command JLEFT.

Example 1:

BNDS 4 40;JRIGHT 6 18

The data between columns 4 to 40 in lines 6 to 18 is right-aligned to column 40.

Example 2:

BNDS 10;JRIGHT 15

The data to the right of column 10 in line 15 is right-aligned to the rightmost column of your editing screen.

JUSTIFY

This command is used to set the justification mode for the line commands TO and TOO.

TO and TOO are used to join data lines with subsequent lines. Both commands apply only within the horizontal boundaries as set with the main command BNDS.

Example:

With these commands, you set the horizontal boundaries to columns 10 and 60, and activate left-justification:

BNDS 10 60;JUSTIFY LEFT

When you then mark a line with a TO line command (or a block of lines with two TOO line commands), the data between columns 10 and 60 in the marked line(s) is left-aligned to column 10.

LABEL

This command is used to mark the current line (that is, the line which is currently at top of the editing area) with the specified .label.

The label may be a string of 1 to 4 alphabetic characters.

Example:

To label the current line with .X, you enter the command:

LABEL .X

You can also mark a block of lines with two labels. For example, to mark a block with labels .X and .Y, you first mark the current line (assuming it is the first line of the block to be marked) with .X as shown in the example above; then you scroll until the last line of the block is the current line; then you issue the command LABEL .Y to mark that line with .Y.

To mark a line with a label, you can also use the line command .label; see the section Summary of Line Commands.

LC

This command is used to change one or more lines to lower case.

You can specify that only lines which contain a specified character string are to be changed to lower case. If you want an apostrophe to be part of the string, you must write it as two apostrophes.

You can specify the string as described in the following section.

If you enter the LC command without any parameters, the current line is changed to lower case.

Example:

LC C'NAME' .X .Y ALL PREFIX NX

This command changes to lower case all displayed lines within the block labeled with .X and .Y if they contain the string NAME (in upper case as entered here) as prefix to a word.

LEFT

This command scrolls the data to the left.

If n or LEFT is omitted, the scrolling amount is determined by the scroll mode.

LIMIT

With this command, you specify the maximum number of lines to be searched with a FIND or RFIND command. The parameter n is the number of lines to be searched. This setting can be changed by editing your profile; see Setting the Editor Profile.

LOCATE

This command is used to scroll a specific line to the top of the editing area (that is, make it the current line).

The command provides the following options:

The LOCATE command differs from the FIND command in the following ways:

• The FIND command is more effective for text searches while the LOCATE command is used primarily to find line numbers or line labels.

• The LOCATE command finds only text in upper case beginning in column one of the editor. In addition, in order to find a string, the data in the editor must be in alphabetical order.

• When a line is located with the LOCATE command, the cursor is placed in the prefix area and the line is placed at the top of the editing area; with the FIND command, the cursor is placed on the string searched and the line is not necessarily placed at the top of the editing area.

Examples:

LOC 32

Places line number 32 at the top of the editing area.

32

Same as above.

LOC .X

Places the line labeled .X at the top of the editing area.

LOG

This command activates or deactivates the log file.

The log file is a history of all modifications made in the editor since session begin. When the log file is active, each time you press ENTER, the changes made since the previous ENTER are recorded in the log file. When using the UNDO command you can consecutively back out changes made since the beginning of the editing session. Edit your profile to change the setting; see Setting the Editor Profile.

Important:
You must ensure the LOG is activated before starting to edit.

MASK

This command activates or deactivates the mask function. When the mask function is active, each time you insert a line in the editor, a predefined line of text is entered instead of a blank line. The mask line is defined by using the MASK line command. The mask function is useful when you must write several lines of code which are identical or very similar.

For detailed instructions on using the mask function, see To define and use a mask line.

The default setting is MASK OFF and can be changed by editing your profile; see Setting the Editor Profile.

MWINDOW

This command is used to move a data window according to the command parameters.

NULLS

This command is used determine if the data lines are to be filled with null characters.

The default setting is NULLS ON and can be changed by editing your profile; see Setting the Editor Profile.

ORDER

This command is used to join data lines.

The ORDER command applies only within the horizontal boundaries as set with the main command BNDS.

Within the set boundaries, the lines are concatenated and are filled to the greatest possible extent; words that do not fit into one line are automatically placed in the next line.

To join data lines, you can also use the line commands TF, TO and TOO.

POWER

This command switches the editor to text-entry mode. You are presented with a blank screen into which you can enter one or more lines of text. After entry, press ENTER and the text is inserted into the first line of the editing area.

PROFILE

This command displays your editor profile at the top of the edit screen.

With n you specify additional lines to be displayed. Possible values for n are:

PROTECT

This command is used to protect the prefix area. To enter line commands with the prefix area protected, type the line command in column 1 of the editing area preceded by the escape character.

The default setting is PROTECT ON and can be changed by editing your profile; see Setting the Editor Profile.

RCHANGE

This command repeats the last CHANGE command.

RECOVERY

This command is used to activate or deactivate the recovery feature for the current editing session. You can also specify the number of updates to be performed before a checkpoint save is performed.

When using parameter n, you specify the number of updated lines after which a checkpoint save is performed.

The default setting is RECOVERY ON and can be changed by editing your profile; see Setting the Editor Profile.

RENUMBER

For PDS members and sequential data sets only. Specifies renumbering of the lines in the editing area according to the parameters.

To deactivate line renumbering, see the UNREN command.

RESET

This command resets all pending line commands and deletes all line labels.

RFIND

This command repeats the last FIND command.

RIGHT

This command scrolls data to the right.

If n or RIGHT is omitted, the scrolling amount is determined by the scroll mode.

SORT

The SORT command sorts lines in the editor in ascending or descending alphabetical order. An unqualified SORT command sorts all data in the object in ascending order.

TABS

This command is used to control tabulator settings.

You can enable or disable logical or physical tabulation by using the command TABS ON or TABS OFF. Tabulation is also enabled by any command that changes a tabulation setting.

For example, the following command enables logical tabulation with the ampersand sign (&) as logical tabulation character:

TABS &

You set tab positions by using the TABS command. For example, the following command sets tabs in columns 10, 20 and 30:

TABS 10 20 30

You can enter data and automatically move it to a specific tab position by preceding it with a logical tabulation character. One tabulation character moves the data to the next tab position, two tabulation characters move the data to the second tab position, and so on.

To display the current TABS command settings, issue the main command PROFILE.

To display the current tab positions, issue the line command TABS.

The default setting is TABS OFF blank and can be changed by editing your profile; see Setting the Editor Profile.

Apart from tab positions, you can specify the following parameters with the TABS command:

To tabulate data in a specific column, multiple tab characters are possible: issue the TABS line command and type over each asterisk (*) marking the tab positions with another special character. Any input preceded by any of these special characters are tabulated in the corresponding column. You can type an L (for LEFT), an R (for RIGHT) or a D (for DECIMAL) after each tabulation character to specify placement of data for the tab position.

Note:
For further instructions and examples of using tabulation, see also Using the Physical or Logical Tabulator.

TOP

This command is used to scroll to the beginning of the object being edited.

UC

The UC command converts one or more lines to upper case. It applies the same parameters as the LC command. If you enter the UC command without parameters, it changes the current line to upper case.

UNDO

If the log file is active (see the LOG command), the UNDO command backs out all changes made since the last time you pressed ENTER. Repeated use of the UNDO command backs out consecutive changes in reverse order. You can thus back out all changes one by one until you restore the source to its original status at session begin.

You can specify the following parameters with the UNDO command:

UNREN

Deactivates the renumbering of lines.

To activate line renumbering, see the RENUMBER command.

UP

This command scrolls upwards in the data.

The parameter n specifies the number of lines to be scrolled upwards. If n is omitted, the scroll amount is determined by the scroll mode.

WINDOW

This command is used to define a data window to be copied or moved. The starting line and column and the end line and column of the window are specified in the command parameters. At least l1 and l2 are required.

Note that all data in the source work area within the specified points becomes part of the window. For an example, see the section Copying a Window with Data.

XSWAP

The command is used to exchange displayed lines with excluded lines. Lines are excluded by using the EXCLUDE command.

Common Command Options

There are some options which are available with several main commands. These options are described in the following section.

• Redisplay Feature

• Line Specifications

• Column Specifications

• Displayed or Non-Displayed Lines

• Direction of Operation

• Special Occurrences

Redisplay Feature

The editor provides a command redisplay feature: if you precede a command with two ampersands (&&), it remains displayed in the command line and is executed every time you press ENTER until you delete the command or overtype it.

Line Specifications

With these options, you can restrict the effect of a command to a certain range of lines:

X and Y can also be any label of 1 to 4 alphabetic characters (see the LABEL command).

Column Specifications

With these options, you can restrict the effect of a command to a certain range of columns. These column numbers refer to the actual data columns; the line numbers preceding the data are not counted. So, if you specify column 1 with a command, this may physically be the 8th column of your screen, but it is in fact the 1st column of the data you are editing.

Displayed or Non-Displayed Lines

With one of the following options, you can specify that only excluded or only included lines are to be affected by a command:

Direction of Operation

With these options, you can specify the direction in which a command is to operate:

Special Occurrences

With these options, you can specify whether only special occurrences of the specified string are to be affected by a command:

www.softwareag.com

Copyright © 1979-2010 Software AG, Darmstadt, Germany.

SEARCH   INDEX   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT