Format

@ (file-specification)

Description

The use of command files containing query definitions allows a common set of queries to be used interactively indifferent SCA sessions.

Related Commands

SAVE_QUERY

Example

The following queries could be used to describe all the names that might be associated with the Year 2000 problem:

$ SCA
SCA> @Y2000
SCA> FIND/OUT=Y2000.LIS @Y2000_QUERY AND OCC=REFERENCE

Use the SCA/LSE interface to look at the references found.

Format

ALIGN

Qualifier

Description

The ALIGN command aligns all trailing comments with a particular column. The column in which you position the comments can be either explicitly specified (using the /COMMENT_COLUMN=number qualifier) or based on context.

This command operates on each line in the range, in sequence. For each line, LSE checks to see whether the line has a trailing comment. If not, it proceeds to the next line.

If there is a trailing comment, LSE either inserts or deletes spaces or tabs as necessary to get the comment to align. If there is no room for the comment on the line (that is, if the noncommented text extends beyond the comment column), the comment is aligned one space after the end of the noncommented text.

DECwindows Interface Equivalent

Pull-down menu: Edit → Align

Related Commands

FILL

Example

The following is a sample of commented code:

Format

ANALYZE file-spec[, . . . ]

Qualifiers

Parameter

file-spec[, . . . ]

Specifies the files to be analyzed. You can use wildcards with the file-spec parameter. Within LSE, the current buffer is analyzed by default.

Description

The ANALYZE command creates an analysis data file to describe a source file. The analysis data files produced by this command contain a minimal description of the source file. These files describe the source file primarily as a set of references to unbound names.

With the ANALYZE command, you can use SCA with languages not directly supported by SCA. Do not use this command with those languages that do support SCA. To identify those languages that support SCA, see the VSI DECset for OpenVMS Source Code Analyzer Command-Line Interface and Callable Routines Reference Manual or the DECset Software Product Description (SPD).

The ANALYZE command understands the language-specific rules for forming names (identifiers), comments, quoted strings, and placeholders. It assumes that tokens are reserved words, and does not include them in the analysis data file. It processes placeholders and comments depending on the setting of the /DESIGN qualifier.

You must have a language defined in an environment file to use the ANALYZE command with that language. Based on the description of the language in that file, this command analyzes the source file.

The ANALYZE command uses the LSE environment files to determine the appropriate language based on the file type, or uses the language specified with the /LANGUAGE qualifier. It uses the same logical names as LSE, (LSE$ENVIRONMENT and LSE$SYSTEM_ENVIRONMENT) to access the environment files.

For information about defining your own language, see the chapter on defining LSE templates in the Guide to Language-Sensitive Editor for OpenVMS Systems.

The REPORT command requires that LSE be installed even if you are using this command from the SCA command line.

Related

DEFINE LANGUAGE

LOAD

Examples

Format

ATTACH [subprocess-name]

Parameter

subprocess-name

Specifies the name of the process to which you want to connect. If you do not specify a process name, LSE connects you to the parent process.

Description

The ATTACH command switches control of your terminal to another process,just as the DCL command ATTACH does at the dollar sign ($) prompt. To return to LSE from another process, use the DCL command ATTACH. Use the LOGOUT command to return to LSE only from a subprocess.

Related Commands

SPAWN

Example

LSE> ATTACH SMITH_1

Switches control to the process SMITH_1.

Format

BOX COPY

Description

The BOX COPY command copies the currently selected box to the default location (i.e. the DECwindows clipboard or the paste buffer).

Example

LSE> BOX COPY

Format

BOX CUT

Qualifiers

Description

The BOX CUT command moves the currently selected text to the default location (the DECwindows clipboard or the paste buffer).

Example

LSE> BOX CUT

Format

BOX DRAW

Description

The BOX DRAW command draws a box in the overstrike mode. The box is drawn using the plus sign (+) for the corners, the vertical bar (|) for the sides and a hyphen (-) for the top and bottom.

Examples

        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
        eeeeeeeeBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBeeeeeeeeee
        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

LSE>  BOX DRAW

        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
        eeeeeeee+----------------+IIIIIIIIII
        IIIIIIII|BBBBBBBBBBBBBBBB|IIIIIIIIII
        IIIIIIII|BBBBBBBBBBBBBBBB|IIIIIIIIII
        IIIIIIII+----------------+eeeeeeeeee
        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

Format

BOX PASTE

Qualifiers

Description

The BOX PASTE command copies the contents of the default location to a box with the top left hand corner at the current position.

Examples

        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
        eeeeeeeeBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBeeeeeeeeee
        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

LSE>  BOX PASTE

             BBBBBBBBBBBBBBBBBB
             BBBBBBBBBBBBBBBBBB
             BBBBBBBBBBBBBBBBBB
             BBBBBBBBBBBBBBBBBB

Format

BOX LOWERCASE

Description

The BOX LOWERCASE command changes the case of the text in the selected box to lowercase.

Examples

        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
        eeeeeeeeBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBeeeeeeeeee
        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

LSE>  BOX LOWERCASE

        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
        eeeeeeeebbbbbbbbbbbbbbbbbbIIIIIIIIII
        IIIIIIIIbbbbbbbbbbbbbbbbbbIIIIIIIIII
        IIIIIIIIbbbbbbbbbbbbbbbbbbIIIIIIIIII
        IIIIIIIIbbbbbbbbbbbbbbbbbbeeeeeeeeee
        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

Format

BOX UPPERCASE

Description

The BOX UPPERCASE command changes the case of the text in the selected box to uppercase.

Examples

        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
        eeeeeeeebbbbbbbbbbbbbbbbbbIIIIIIIIII
        IIIIIIIIbbbbbbbbbbbbbbbbbbIIIIIIIIII
        IIIIIIIIbbbbbbbbbbbbbbbbbbIIIIIIIIII
        IIIIIIIIbbbbbbbbbbbbbbbbbbeeeeeeeeee
        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

LSE>  BOX UPPERCASE

        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
        eeeeeeeeBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        IIIIIIIIBBBBBBBBBBBBBBBBBBIIIIIIIIII
        eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee

Format

CALL DECTPU-procedure-name [additional-parameters]

Parameters

DECTPU-procedure-name

Indicates the name of the DECTPU procedure you want to call.

additional-parameters

Contains information to be passed to the procedure as a single string. The called procedure must then parse and interpret this string.

Description

The CALL command, in combination with the DEFINE COMMAND command, provides a means for defining new commands implemented in the DECTPU language. Because the additional parameters are passed to the called procedure without being parsed, these commands have a flexible syntax.

Related Commands

DEFINE COMMAND

DO/TPU

Example

The following DECTPU procedure issues a DIRECTORY command from within LSE:

     PROCEDURE dir (dir_params)
         ! Description:
         !   Issues a DCL DIRECTORY command in a subprocess.  The output is
         !   written to the DIRECTORY buffer.  The DIRECTORY buffer is
         !   mapped to the current window.
         !
         ! Parameter:
         !   dir_params - a string beginning with "$".  The text following
         !       the "$" contains parameters and qualifiers to be passed to
         !       the DIRECTORY command.
         !       The "$" is used to provide a parameter for the call to
         !       this procedure when no parameters for the DIRECTORY
         !       command were specified.
         !         LOCAL dir_process, cmd;
         IF GET_INFO(dir_buffer, "TYPE") <> BUFFER THEN
             dir_buffer := CREATE_BUFFER("DIRECTORY");
             SET(NO_WRITE,dir_buffer);
         ENDIF;
         erase(dir_buffer);
         ! Build the DIRECTORY command, picking up parameters that were
         ! passed in.
         cmd := 'DIRECTORY '+SUBSTR(dir_params,2,LENGTH(dir_params)-1);
         ! Create a subprocess and execute the command.
         dir_process := CREATE_PROCESS (dir_buffer, cmd);
         lse$do_command('GOTO BUFFER DIRECTORY');
         DELETE (dir_process);     ENDPROCEDURE

    LSE> DEFINE COMMAND DIR "CALL DIR $"

    LSE> DIR/SIZE/DATE

Note the use of the dollar sign ($) to cause the CALL command to always invoke the procedure named DIR with a parameter, even if you specify nothing else on the command line of the command DIR. The dollar sign also prevents qualifiers on the command DIR from being interpreted as an attempt to place qualifiers on the DECTPU procedure-name parameter named DIR.

Format

CANCEL MARK

Parameter

marker-name

Names the marker to be canceled; a wildcard marker name is allowed. If you do not specify a name for the marker, LSE cancels any marker at the current cursor position.

Description

The CANCEL MARK command causes LSE to remove the specified marker from the text and to delete the marker name.

DECwindows Interface Equivalent

Pull-down menu: Navigate > Cancel Mark

Related Commands

SET MARK

Example

LSE> CANCEL MARK 1

Deletes the marker named 1 from the inventory of markers in your current buffer.

Format

CANCEL SELECT_MARK

Description

The CANCEL SELECT_MARK command cancels the effect of the SET SELECT_MARK command. If a block or range of text is displayed in reverse video, the CANCELSELECT_MARK command returns the text to its normal display.

Keypad Equivalent

Related Commands

SET SELECT_MARK

Format

CAPITALIZE WORD

Description

The CAPITALIZE WORD command capitalizes the first letter of the word following the cursor, or the word that the cursor is on. If a selected range is active,all the words within that range are capitalized.

If a word is already in uppercase letters, the command changes all but the first letter to lowercase. The cursor then moves to the first letter of the word following the target word or selected range.

DECwindows Interface Equivalent

Pull-down menu: Edit > Capitalize

Related Commands

CHANGE CASE

LOWERCASE WORD

UPPERCASE WORD

Format

CENTER LINE

Description

The CENTER LINE command centers text on the line that the cursor is on. You can place the cursor anywhere on the line to be centered.

DECwindows Interface Equivalent

Pull-down menu: Edit > Center Line

Format

CHANGE CASE

Description

The CHANGE CASE command changes the case of letters.

If you select a range of text by using the SET SELECT_MARK command,the case of each letter in the selected range changes.

Keypad Equivalent

Related Commands

CAPITALIZE WORD

LOWERCASE WORD

UPPERCASE WORD

Format

CHANGE DIRECTION

Description

The CHANGE DIRECTION command changes the current direction attribute of the current buffer. The buffer's status line indicates whether the current direction is forward or reverse. The direction affects the operation of such commands as GOTO, ERASE, SEARCH, SUBSTITUTE, CHANGE INDENTATION, and CHANGE CASE.

With the DECwindows interface, you can switch directions by moving the mouse cursor to Forward or Reverse on the status line, then pressing MB1.

Keypad Equivalent

DECwindows Interface Equivalent

Related Commands

SET FORWARD

SET REVERSE

Format

CHANGE INDENTATION

Qualifiers

Description

The CHANGE INDENTATION command adds or removes blanks and tabs from the line that the cursor is on, and sets the new indentation of the current line as the current indentation level.

If you select a range of text by using the SET SELECT_MARK command, the CHANGEINDENTATION command adds or removes blanks and tabs from each line of text in the selected range.

Keypad Equivalent

CHANGE INDENTATION/FORWARD

CHANGE INDENTATION/REVERSE

DECwindows Interface Equivalent

Pull-down menu: Edit > Indentation . . .

Related Commands

ENTER TAB

SET INDENTATION

TAB

UNTAB

Format

CHANGE TEXT_ENTRY_MODE

Description

The CHANGE TEXT_ENTRY_MODE command switches the mode of the current buffer between insert and overstrike. The status line displays the current text-entry mode.

Keypad Equivalent

DECwindows Interface Equivalent

Related Commands

SET INSERT

SET OVERSTRIKE

Format

CHANGE WINDOW_MODE

Description

The CHANGE WINDOW_MODE command changes the number of windows displayed on the screen. If the screen has one window, this command creates a second window. If the screen has two or more windows, the CHANGE WINDOW_MODE command reduces the screen display to a single window containing the current buffer.

Keypad Equivalent

Related Commands

ONE WINDOW

SET SCREEN WINDOW

Format

CHECK LANGUAGE language-name

Qualifiers

Parameter

language-name

Specifies the name of the language whose definitions are to be checked. Wildcards are not permitted.

Restrictions

The /DEFINITIONS and /HELP_INTERFACE qualifiers are mutually exclusive.

Description

If LSE detects any of these conditions, they are reported in the $CHECK_LANGUAGE buffer, which is displayed in an editing window. You can use the WRITE command to write the contents of this buffer to a file. If LSE does not detect any of the conditions listed previously, a success message is displayed.

Example

$ LSEDIT /NODISPLAY /NOCURRENT_FILE /INITIALIZATION=SYS$INPUT: Return
CHECK LANGUAGE/HELP_INTERFACE my_language Return 
WRITE /BUFFER=$CHECK_LANGUAGE CHECK_LANGUAGE.LIS Return
QUIT Return
$

The size and structure (key depth) of the HELP library and the number of tokens and placeholders that have /TOPIC qualifiers determine the amount of time required to check the HELP library for the language. This checking can take a significant amount of time. It may be more convenient to check the HELP library for a language from a batch procedure.

Format

CLOSE BUFFER

Description

The CLOSE BUFFER command writes the buffer, contingent on buffer attributes and status, then deletes the buffer. If the buffer has the WRITE attribute, and you have modified the contents of the buffer since they were last written, LSE first writes the contents of the buffer to its associated file. If a file is not associated with the buffer, LSE prompts you for a file name.

DECwindows Interface Equivalent

Pop-up menu: User buffer > Close

Pull-down menu: File > Close File

Related Commands

WRITE

Format

CMS [cms-command]

Parameter

cms-command

Specifies any valid specification for a CMS command, including valid qualifiers.

Description

The CMS command invokes CMS from within LSE to let you enter any valid CMS command. To use this command, you must have CMS installed on your system.

Related Commands

GOTO FILE

GOTO SOURCE

READ

REPLACE

RESERVE

SET CMS

UNRESERVE

Examples

Format

COLLAPSE

Qualifier

Description

The COLLAPSE command displays an overview of the text at the current cursor position. Low-level detail lines are replaced by a single overview line. The cursor position is recorded before the text is collapsed for use with future EXPAND commands.

The editor determines the relative level of detail of a line by comparing the indentation of the line with the indentation of other lines. The editor's treatment of the indentation of a line is influenced by indentation adjustment definitions. For more information,see the DEFINE ADJUSTMENT command.

In an SCA query buffer, if the cursor is positioned on a symbol that has been expanded, or on an occurrence within an expansion, the COLLAPSE command causes the occurrences to disappear.

Keypad Equivalent

DECwindows Interface Equivalent

COLLAPSE

Pop-up menu: Query buffer → Collapse

Pull-down menu: View → Collapse

COLLAPSE/DEPTH=ALL

Pull-down menu: View → Collapse All

Related Command

DEFINE ADJUSTMENT

DEFINE LANGUAGE/OVERVIEW_OPTIONS

EXPAND

FOCUS

MODIFY LANGUAGE

SET NOOVERVIEW

SET OVERVIEW

VIEW SOURCE

Format

COMPILE [command-string]

Qualifier

Parameter

command-string

Specifies the DCL command line to be executed. If you do not specify a command string, LSE uses the command string specified in the definition of the language associated with the current buffer (see the /COMPILE_COMMAND qualifier of the DEFINELANGUAGE command).

If you specify a dollar sign ($) as the first argument on the COMPILE command, LSE replaces the dollar sign with the default COMPILE command. With this feature, you can append file specifications or command qualifiers to the default COMPILE command without having to type the entire command yourself.

If the command string or the string specified on the /COMPILE_COMMAND qualifier contains LSE$FILE, LSE forms the command used to compile the buffer by substituting for LSE$FILE the file specification that corresponds to the buffer. With this feature, you can insert text on the command line immediately after the file specification and before the /DIAGNOSTICS qualifier. If the COMPILE command does not contain LSE$FILE, LSE appends the file specification to the string specified on the qualifier.

Description

The COMPILE command compiles the contents of a buffer without leaving LSE. When you enter this command, LSE writes the current buffer and other buffers associated with the current language back to their files, if they have been modified since they were last written. A buffer is not written if it is designated READ_ONLY.

LSE then forms a DCL command line by appending the file specification of the current buffer to the command string given on the COMPILE command.

If the current buffer's language has diagnostic capabilities (see the DEFINE LANGUAGE/CAPABILITIES command), LSE appends the /DIAGNOSTICS qualifier to the DCL command it forms, as follows:

/DIAGNOSTICS=current-device:[current-directory]filespec.DIA

LSE then spawns a subprocess to execute the DCL command line.

If you specified the /REVIEW qualifier on the COMPILE command, LSE waits for the subprocess to finish executing the DCL command. Otherwise, the COMPILE command completes as soon as the subprocess begins executing the DCL command.

When the subprocess completes, LSE displays a message in the message buffer. If you specified the /REVIEW qualifier, LSE enters review mode and reviews any compilation errors that occurred.

DECwindows Interface Equivalent

Pull-down menu: Source > Compile

Examples

Format

CONTINUE

Description

With the CONTINUE command, you can return to keypad editing from the command prompt. You can also press Ctrl/Z at the LSE> prompt to return to keypad editing.

Keypad Equivalent

Ctrl/Z, at the LSE> prompt

Related Commands

DO

Format

CONVERT LIBRARY directory-spec1 [directory-spec2]

Parameters

directory-spec1

Specifies the directory specification of the Version 3. n library to be converted.

directory-spec2

Specifies the directory in which the Version 4. n library is to be created. If this parameter is omitted, the new library is created in the directory specified by directory-spec1, and the old library is deleted. If this parameter is specified and is different from directory-spec1, the old library is not deleted.

Description

The CONVERT LIBRARY command converts a Version 3. n library to a format compatible with Version 4. n. Because Version 4. n libraries can contain much more information than Version 3. n libraries, it is recommended that you recompile and load new libraries rather than convert libraries, if possible. This command does not apply to the OpenVMS Alpha product.

Related Commands

CREATE LIBRARY

LOAD

Example

LSE> SCA CONVERT LIBRARY SCA$:[USER.V3LIB] SCA$:[USER.V4LIB]

Uses the existing library [USER.V3LIB] to create a new Version 4. n library named [USER.V4LIB].

Format

CREATE LIBRARY directory-spec[,. . . ]

Qualifiers

Parameter

directory-spec[, . . . ]

Specifies one or more directories in which library files are to be allocated and initialized.

Description

The CREATE LIBRARY command initializes a library and defines it as the active library in your current SCA session. When you subsequently invoke SCA, it uses the logical name SCA$LIBRARY to reestablish the active library list.

Related Commands

CONVERT LIBRARY

LOAD

SET LIBRARY

Examples

Format

CUT

Qualifiers

Description

The CUT command removes or copies text within the selected range and moves it into a designated buffer or default location (the DECwindows Clipboard or character-cell $PASTE buffer). The selected range is the text between the select marker (seethe SET SELECT_MARK command) and the current cursor position. If no select marker has been set and the cursor is positioned on the current search string,that string is moved to the buffer.

The /REPLACE and /SUBSTITUTE qualifiers are mutually exclusive; also, these qualifiers cannot be used in conjunction with the /APPEND and /ERASE qualifiers.

For users of the DECwindows interface, the default setting is /CLIPBOARD;otherwise, the default is /BUFFER=$PASTE.

DECwindows Interface Equivalent

CUT/CLIPBOARD

Pop-up menu: User buffer > Cut

Pull-down menu: Edit > Cut

CUT/NOERASE/CLIPBOARD

Pop-up menu: User buffer > Copy

Pull-down menu: Edit > Copy

Related Commands

PASTE

SET SELECT_MARK

SUBSTITUTE

Example

LSE> CUT/BUFFER=TEMP.TXT

Places the text being moved in the buffer TEMP.TXT.

Format

DCL dcl-command

Parameter

dcl-command

Specifies the DCL command to be executed. If you do not specify a command, LSE prompts for one. Pressing Ctrl/Z at the prompt cancels the operation.

LSE splits the window to show the DCL buffer. You can edit the DCL buffer to move the output from the DCL command into another buffer. You can use the ONE WINDOW command to remove the DCL window.

Description

The LSE command DCL executes a DCL command from within your editing session. LSE spawns a subprocess for the DCL command you specify and creates a buffer named DCL to contain the output from the command.

Example

LSE> DCL DIRECTORY *.TXT

Splits the screen and displays the DCL command DIRECTORY and its output (the directory listing) in the second window. The cursor remains in the first window.

Format

DEFINE ADJUSTMENT adjustment-name [pattern]

Qualifiers

Parameters

adjustment-name

Specifies the name of the adjustment being defined.

pattern

Specifies the string that LSE compares against source lines. If no pattern is used, the adjustment-name parameter is used. For details about the syntax for pattern strings, see the section about pattern-matching rules in the Guide to Language-Sensitive Editor for OpenVMS Systems.

Pattern strings match any string that you can specify directly on the command line. Strings with special characters must be enclosed in quotes ( “ ”). Regardless of whether the string is quoted, the comparison is case-insensitive. You must use the “$()” convention to enclose named pattern elements.

Definitions with literal strings take precedence over definitions with predefined patterns.

Description

The DEFINE ADJUSTMENT command defines the behavior of the LSE viewing commands on individual lines of a source file. With the DEFINE ADJUSTMENT command, you can modify the behavior of overviews to match your formatting conventions. You can save DEFINE ADJUSTMENT commands in your environment file.

Related Commands

COLLAPSE

DEFINE LANGUAGE/OVERVIEW_OPTIONS

DELETE ADJUSTMENT

EXPAND

EXTRACT ADJUSTMENT

FOCUS

SHOW ADJUSTMENT

VIEW SOURCE

Examples

Format

DEFINE ALIAS alias-name [value]

Qualifiers

Parameters

alias-name

Specifies the name to be defined as an alias. The characters in the alias name must be in the /IDENTIFIER_CHARACTERS string in the DEFINELANGUAGE command.

value

Specifies a quoted string. When you expand the alias, LSE replaces the alias name with the string given by the value parameter. You must not use a value parameter if you specify the /INDICATED qualifier.

Description

With the DEFINE ALIAS command, you can use a shortened name to generate a string of text. You can specify an identifier at the current cursor position as the text you want to generate. After you define an alias name, you can type the alias and then enter the EXPAND command; the text you have assigned to that alias is then displayed.

DEFINE ALIAS/INDICATED

Keypad Equivalent

Related Commands

DEFINE LANGUAGE

EXPAND

Example

LSE> DEFINE ALIAS/LANGUAGE=FORTRAN lse "The VSI Language-Sensitive Editor"

Causes the quoted string to appear when you type lse and then enter the EXPAND command when you are in the Fortran language environment.

See the section about defining an alias in the Guide to Language-Sensitive Editor for OpenVMS Systems for additional examples.

Format

DEFINE COMMAND command-name value-string

Parameters

command-name

Specifies the name to be defined as a command. A command name can contain up to 255 characters, but must begin with a letter, an underscore, or a dollar sign. After the first character, you can use any combination of alphanumeric characters, underscores, or dollar signs.

value-string

Specifies a quoted string containing an LSE command or the leading portion of an LSE command.

Description

With the DEFINE COMMAND command, you can define your own commands or specify an abbreviation for an LSE command. Before the command executes, LSE substitutes the specified value string for the command name.

To define a command for a sequence of commands, use the DO command inside the value string.

Related Commands

CALL

DO

Example

LSE> DEFINE COMMAND CLS "DO/TPU ""ERASE(CURRENT_BUFFER)"""

Associates the command name CLS with the command DO/TPU “ERASE(CURRENT_BUFFER)”. After entering this command,whenever you type CLS at the command prompt, LSE uses DECTPU to clear all text from the current buffer.

Format

DEFINE KEY key-specifier string

Qualifiers

Parameter

key-specifier

Specifies a keyword that indicates the key to be defined. If you use the DEFINE KEY command to change the definition of a key that was previously defined, LSE does not save the previous definition.

Table 2.2, “LSE Keynames for the Editing and Auxiliary Keypad” lists the LSE key names and their VT200-type (or higher ) and VT100-type counterparts for the editing and auxiliary keypad. Table 2.3, “LSE Keynames for Keys on the Main Keyboard” lists the LSE keynames and their VT200-type (or higher ) and VT100-typecounterparts for the main keyboard keys.

As an alternative to using the /IF_STATE=GOLD qualifier, the key-specifier parameter accepts keynames prefixed with GOLD/. In addition, you can specify control keys as Ctrl/ x, where x is an alphabetic character (A through Z).

string

Specifies an LSE command to be executed when the key is pressed. This is a required parameter unless you use the /LEARN qualifier; you cannot use the string parameter with either the /LEARN or /STATE=GOLD qualifier.

If you want to define a key to be lowercase, you must put the key specifier in lowercase and in quotes. However, GOLD and Ctrl sequences are not case-sensitive. For example, Ctrl/A and Ctrl/a produce the same results. Also, GOLD/A is the same as GOLD/a.

If the first key pressed in response to the (Key:) prompt is a key that does not correspond to a printing key character, LSE echoes the corresponding keyname. Tables 2.2 and 2.3 list keys that do not correspond to a printable character.

If the first key pressed is the GOLD key, LSE waits for you to press a second key. LSE then echoes the key specifier for the key sequence. For example, if you press the GOLD key and then press the P key, LSE echoes GOLD/P.

Only the first key you press in response to the prompt (or the first two keys if the GOLD key is first) is handled in this special way. Subsequent input to the prompt is treated as though you typed in the text that LSE echoes. Ctrl/C, Ctrl/Z, and the Return key required to end the input line are all handled in this way. Erasing all the text at the prompt (using Ctrl/U or the DELETE command) causes LSE to interpret the next key input as the first key.

Description

The DEFINE KEY command associates an LSE command with a key. You can bind commands to control keys, numeric keypad keys, and the arrow keys on all keyboards. You can also bind a command to the sequence of the GOLD key followed by any keyboard key, where the GOLD key is the key defined to set the GOLD state (usually PF1). (On the VT200-series ( or higher ) keyboard, you can also bind to the function (F) keys and the keys on the editing keypad.)

The HELP/KEYPAD command uses the values of the /LEGEND and /TOPIC qualifiers to build a keypad diagram for the keypad keys and to access help text for the keys. The SHOW KEY/FULL command displays the strings associated with the /LEGEND, /TOPIC_STRING, and /REMARK qualifiers.

The effect of a key can vary with its context. The DEFINE KEY command provides only for definitions for keys that are used in the work region.

DECwindows Interface Equivalent

DEFINE KEY/DIALOG

Pull-down menu: Show → Show Key *

Related Commands

END DEFINE

Example

LSE> DEFINE KEY "GOLD/KP5" "GOTO TOP"

If the PF1 key sets the GOLD state, then the key sequence PF1-KP5 always issues a GOTO TOP command after you assign this definition.

See the section about defining keys in the Guide to Language-Sensitive Editor for OpenVMS Systems for additional examples.

Format

DEFINE KEYWORDS keyword-list-name
keyword [/DESCRIPTION=text]
   .
   .
   .
keyword [/DESCRIPTION=text]
END DEFINE

Qualifier

Parameters

keyword-list-name

Identifies the keyword list. The name must follow the rules applied to token names in LSE. You can then use the name as the value you specify for the /KEYWORDS qualifier to the DEFINE TAG command, as well as the parameter for the DELETE KEYWORDS,EXTRACT KEYWORDS, and SHOW KEYWORDS commands.

keyword

Names an individual keyword. Each keyword on the list must appear on a line by itself. You cannot use continuation characters between the lines for each keyword, but you can use a continuation character between a particular keyword and its associated qualifier.

Related Commands

DEFINE TAG

DELETE KEYWORDS

EXTRACT KEYWORDS

SHOW KEYWORDS

Example

DEFINE KEYWORDS author_names
   "Pat Jones"   /DESCRIPTION="Project Leader"
   "Chris Brown"
   "Leslie Green"
END DEFINE

Creates a keyword list named author_names and lists the individual names.

Format

DEFINE LANGUAGE language-name

Qualifiers

Parameter

language-name

Specifies the name of the language whose characteristics are to be defined.

Description

The DEFINE LANGUAGE command specifies a language so LSE can properly recognize language-specific text characteristics.

After you specify these language characteristics by using the DEFINELANGUAGE command, you can use the MODIFY LANGUAGE command when you want to make subsequent changes.

Related Commands

DELETE LANGUAGE

EXTRACT LANGUAGE

MODIFY LANGUAGE

SET LANGUAGE

SHOW LANGUAGE

Examples

1.  DEFINE LANGUAGE ADA -
      /CAPABILITIES=DIAGNOSTICS -
      /COMPILE_COMMAND="ADA" -
      /FILE_TYPES=(.ADA) -
      /IDENTIFIER_CHARACTERS= -
          "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ$_0123456789" -
      /INITIAL_STRING="{compilation_unit}" -
      /COMMENT=(TRAILING="–") -
      /PLACEHOLDER_DELIMITERS=( -        REQUIRED=("{","}"), -
        REQUIRED_LIST=("{","}..."), -
        OPTIONAL=("[","]"), -
        OPTIONAL_LIST=("[","]...") ) -
      /PUNCTUATION_CHARACTERS=",;()*.'" -
      /QUOTED_ITEM=(QUOTES="""'") -
      /TAB_INCREMENT=4 -
      /TOPIC_STRING="ADA Language_Topics"

2.  DEFINE LANGUAGE PASCAL -
      /CAPABILITIES=DIAGNOSTICS -
      /COMMENT=(BEGIN=("{","(*"),END=("}","*)")) -
      /COMPILE_COMMAND="PASCAL " -
      /FILE_TYPES=(.PAS) -
      /IDENTIFIER_CHARACTERS= -
          "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ$%_0123456789" -
      /INITIAL_STRING="%{compilation_unit}%" -
      /PLACEHOLDER_DELIMITERS=( -
        REQUIRED=("%{","}%"), -
        REQUIRED_LIST=("%{","}%..."), -
        OPTIONAL=("%[","]%"), -
        OPTIONAL_LIST=("%[","]%...") ) -
      /PUNCTUATION_CHARACTERS=",;:()[]{}.'" -
      /QUOTED_ITEM=(QUOTES="""'") -
      /TAB_INCREMENT=4 -
      /TOPIC_STRING="PASCAL "

Defines characteristics of the Pascal language.

See the sections about language definition in the Guide to Language-Sensitive Editor for OpenVMS Systems for additional examples.

Format

DEFINE PACKAGE package-name

Qualifiers

Parameter

package-name

Specifies the name of the package being defined.

Description

The DEFINE PACKAGE command defines a subroutine package for which subroutine-call templates are automatically generated. Packages can contain routine definitions, which describe calls to subroutines, and parameter definitions, which describe parameters for subroutine calls.

Related Commands

DEFINE PARAMETER

DEFINE ROUTINE

DELETE PACKAGE

EXTRACT PACKAGE

SHOW PACKAGE

Example

   DEFINE PACKAGE system_services -
       /LANGUAGES =(BASIC,C,COBOL,FORTRAN,PLI) -
       /HELP_LIBRARY = HELPLIB -
       /TOPIC_STRING = "system_services" -
       /ROUTINE_EXPAND = "LSE$PKG_EXPAND_ROUT_" -  ! Special routines for
       /PARAMETER_EXPAND = "LSE$PKG_EXPAND_PARM_"  ! system services

   DEFINE ROUTINE sys$add_holder -
       /PACKAGE = system_services -
       /DESCRIPTION = "Add Holder Record To The Rights Database" -
        id/BY_VALUE, -
        holder/BY_REFERENCE, -
        attrib/BY_VALUE/OPTIONAL -
   DEFINE PARAMETER id -
       /PACKAGE = system_services -
   DEFINE PARAMETER holder -
       /PACKAGE = system_services -
   DEFINE PARAMETER attrib -
       /PACKAGE = system_services -

Shows the incorporation of the DEFINE PACKAGE command in a complete package definition, along with the DEFINE PARAMETER and DEFINE ROUTINE commands.

Format

DEFINE PARAMETER

Qualifier

Parameter

param-name

Specifies the name of the parameter. This name must be unique among the tokens of any language from which the package is used.

Description

The DEFINE PARAMETER command defines a parameter within a package. That parameter can be associated with more than one routine by means of the DEFINEROUTINE command.

Related Commands

DEFINE PACKAGE

DEFINE ROUTINE

DELETE PARAMETER

EXPAND

EXTRACT PARAMETER

SHOW PARAMETER

Example

   DEFINE PACKAGE system_services -
       /LANGUAGES =(BASIC,C,COBOL,FORTRAN,PLI) -
       /HELP_LIBRARY = HELPLIB -
       /TOPIC_STRING = "system_services" -
       /ROUTINE_EXPAND = "LSE$PKG_EXPAND_ROUT_" -  ! Special routines for
       /PARAMETER_EXPAND = "LSE$PKG_EXPAND_PARM_"  ! system services

   DEFINE ROUTINE sys$add_holder -
       /PACKAGE = system_services -
       /DESCRIPTION = "Add Holder Record To The Rights Database" -
        id/BY_VALUE, -
        holder/BY_REFERENCE, -
        attrib/BY_VALUE/OPTIONAL -

   DEFINE PARAMETER id -
       /PACKAGE = system_services -
   DEFINE PARAMETER holder -
       /PACKAGE = system_services -
   DEFINE PARAMETER attrib -
       /PACKAGE = system_services -

Shows the incorporation of the DEFINE PARAMETER command into a complete package definition, along with the DEFINE PACKAGE and DEFINE ROUTINE commands.

Format

DEFINE PLACEHOLDER placeholder-name

placeholder body

END DEFINE

or

DEFINE PLACEHOLDER placeholder-name

/PLACEHOLDER= other-placeholder

Qualifiers

Parameters

placeholder-name

Specifies the name of the placeholder being defined. A placeholder name must be unique within a language and can be a quoted string. To redefine an existing placeholder, you must first delete it using the DELETE PLACEHOLDER command.

placeholder body

Is the body of the placeholder being defined. The interpretation of the placeholder body depends on the type of placeholder. LSE displays the body of a terminal placeholder when you attempt to expand the placeholder. Note that displaying this text does not replace the terminal placeholder and its delimiters.

The body of a nonterminal placeholder is the text of the placeholder expansion; when a nonterminal placeholder is expanded, the placeholder name and enclosing delimiters are replaced with the text of the placeholder body.

A nonterminal placeholder can have more than one quoted string in each body line. For the expansion of the placeholder, you can set the indentation of each string by using the /INDENTATION qualifier and its associated keywords.

Each quoted string in the body line of a nonterminal placeholder can take the qualifier and keywords described in the following section.

keyword1

integer1

You can specify any integer for the integer1 option. The default is 0. The integer is added to the column position as specified by keyword1 and adjusts the indentation by that number of columns. The integer can be negative. When the value for keyword1 is FIXED, integer1specifies the column position at which to put body text; it must be positive.

keyword2

Note that you cannot specify keyword2 when keyword1 has a FIXED value.

If there is more than one quoted string in a body line, a comma must separate the strings. For Fortran, if the body line is inside of a comment or there is a tab in the body lines,the /INDENTATION qualifier and associated keywords do not take effect for the first quoted string for each body line.

For more information about using the /INDENTATION qualifier,see the examples for the EXPAND command.

Each line of the body of a menu placeholder represents one option in the menu. An option can be a string of text, placeholder name, or token name. If the option is a string of text, it must appear in quotes. If the option is a placeholder name or a token name and does not appear in quotes,that placeholder name or token name appears in uppercase letters in the menu display. For a placeholder name or token name to appear in lowercase letters in a menu, you must enter the placeholder name or token name as a lowercase, quoted string.

Each line in the body of a menu placeholder can take one or more of the following qualifiers:

/DESCRIPTION=string

Specifies a description string displayed in the right-hand column of the menu. If this qualifier is omitted, LSE gets the description string from the corresponding definition if the line has either the /TOKEN or the/PLACEHOLDER qualifier. If neither /TOKEN nor /PLACEHOLDER is specified, the line is a literal string and the value of the /DESCRIPTION string defaults to the empty string.

/LIST

/NOLIST (D)

Specifies whether the delimiters for the placeholder should be list delimiters. Use this qualifier only in conjunction with the /PLACEHOLDER qualifier.

/PLACEHOLDER

Specifies that the name or string is the name of a placeholder in the language. This qualifier is mutually exclusive with the /TOKEN qualifier.

/TOKEN

Specifies that the name or string is the name of a token in the language. This qualifier is mutually exclusive with the /PLACEHOLDER and /[NO]LIST qualifiers.

Description

The DEFINE PLACEHOLDER command creates and establishes the characteristics of a placeholder for use with a particular language. A placeholder definition consists of a DEFINE PLACEHOLDER command followed by a placeholder body (which might occupy more than one line). If you do not specify the /PLACEHOLDER qualifier, you must end the placeholder body with an END DEFINE command.

Subsequently, you can use the new placeholder with the EXPAND and HELP/LANGUAGE commands.

Related Command

DEFINE TOKEN

DELETE PLACEHOLDER

END DEFINE

EXPAND

EXTRACT PLACEHOLDER

HELP/INDICATED

SHOW PLACEHOLDER

Examples

Format

DEFINE ROUTINE routine-name [parameter, . . .

Qualifiers

Parameters

routine-name

Specifies the name of the routine. Routine names must be unique within a package. Furthermore, routine names cannot conflict with any token names used by LSE for any language using the package.

parameter, . . .

Specifies the names of the parameters of the routine. These parameters must be defined (using the DEFINE PARAMETER command) before expanding an instance of a call on this routine. However, the parameters do not need to be defined before the DEFINE ROUTINE command. If you omit this qualifier, the routine is presumed to have no parameters.

The /BY_VALUE, /BY_REFERENCE, and /BY_DESCRIPTOR qualifiers are mutually exclusive. These qualifiers are used primarily for languages, such as COBOL,that require explicit specification of passing mechanisms for routine calls.

Description

The DEFINE ROUTINE command defines templates for a routine contained within a subroutine package. This command makes the routine known as an element of a package. The first time the routine name is expanded, LSE generates an appropriate template and simulates a corresponding DEFINE TOKEN command. Thus, you can expand and unexpand routines in the same manner as tokens. Note, however, that commands such as SHOW TOKEN do not operate on tokens defined from routines; instead, you should use the appropriate routine commands, such as SHOW ROUTINE and EXTRACT ROUTINE.

Related Command

DEFINE PACKAGE

DEFINE PARAMETER

DELETE ROUTINE

EXPAND

EXTRACT ROUTINE

SHOW ROUTINE

Example

DEFINE PACKAGE system_services -
       /LANGUAGES =(BASIC,C,COBOL,FORTRAN,PLI) -
       /HELP_LIBRARY = HELPLIB -
       /TOPIC_STRING = "system_services" -
       /ROUTINE_EXPAND = "LSE$PKG_EXPAND_ROUT_" -  ! Special routines for
       /PARAMETER_EXPAND = "LSE$PKG_EXPAND_PARM_"  ! system services

   DEFINE ROUTINE sys$add_holder -
       /PACKAGE = system_services -
       /DESCRIPTION = "Add Holder Record To The Rights Database" -
        id/BY_VALUE, -
        holder/BY_REFERENCE, -
        attrib/BY_VALUE/OPTIONAL

    DEFINE PARAMETER id -
       /PACKAGE = system_services

    DEFINE PARAMETER holder -
       /PACKAGE = system_services

    DEFINE PARAMETER attrib -
       /PACKAGE = system_services

Shows the incorporation of the DEFINE ROUTINE command into a complete package definition, along with DEFINE PACKAGE and DEFINE PARAMETER commands.

Format

DEFINE TAG tag-name

Qualifiers

Parameter

tag-name

Specifies the name of the tag being defined. The tag name must consist only of alphanumeric characters, the dollar sign ($), or the underscore (_), and can contain embedded blanks. Tag names are case-insensitive. If you include embedded blanks, place the name inside quotation marks.

Description

The DEFINE TAG command defines the specified tag. Tags are headings embedded inside comments for use with design reports. You can save the definition in an environment file and direct the compiler to process tags with the /DESIGN qualifier.

For more information about how to use tags, seethe section about design information in the Guide to Language-Sensitive Editor for OpenVMS Systems.

Related Commands

DELETE TAG

EXTRACT TAG

SHOW TAG

Examples

Format

DEFINE TOKEN     token-name

token body

END DEFINE

or

DEFINE TOKEN     token-name

/PLACEHOLDER= placeholder-name

Qualifiers

Parameter

token-name

Specifies the name for the token being defined. Each token for a particular language must have a unique name. Token and alias names must not conflict. A token name can be any character including a blank space, but not a leading or trailing space.

token body

Is the text of the token expansion. When the token is expanded, the token name is replaced with the text of the token body. A token can have more than one quoted string in each body line. For the expansion of the token, you can set the indentation of each string by using the /INDENTATION qualifier and its associated keywords.

Each quoted string in the body line of a token can take the qualifier and keywords described as follows.

keyword1

integer1

You can specify any integer for the integer1 option. The default is 0. The integer is added to the column position as specified by keyword1 and adjusts the indentation by that number of columns. The integer can be negative. When the value for keyword1 is FIXED, integer1specifies the column position at which to put body text and must be positive.

keyword2

Note that you cannot specify keyword2 when keyword1 has a FIXED value.

If there is more than one quoted string in a body line, a comma must separate the strings. For Fortran, if the body line is inside of a comment or there is a tab in the body lines,the /INDENTATION qualifier and associated keywords do not take effect for the first quoted string for each body line.

For more information about the use of the /INDENTATION qualifier,see the examples for the EXPAND command.

Description

The DEFINE TOKEN command defines an editing token for use with the EXPAND command. When you enter the EXPAND command while the cursor is positioned immediately after the token name or an abbreviation of the token name, LSE replaces the input string with the body of the token.

Related Commands

DELETE TOKEN

EXPAND

EXTRACT TOKEN

SHOW TOKEN

Example

Format

DELETE ADJUSTMENT adjustment-name

Qualifier

Parameter

adjustment-name

Specifies the name of the adjustment to be deleted.

Description

The DELETE ADJUSTMENT command removes a specified name from the list of adjustments associated with a language.

Related Command

DEFINE ADJUSTMENT

EXTRACT ADJUSTMENT

SHOW ADJUSTMENT

Example

LSE> DELETE ADJUSTMENT/LANGUAGE=EXAMPLE then

Removes the adjustment named then from the list of adjustments associated with the language EXAMPLE.

Format

DELETE ALIAS alias-name

Qualifier

Parameter

alias-name

Specifies the alias name to be deleted.

Description

The DELETE ALIAS command cancels the definition of an alias name established by a previous DEFINE ALIAS command.

Related Commands

DEFINE ALIAS

Examples

LSE> DELETE ALIAS lse

Cancels the definition of the alias named lse.

Format

DELETE BUFFER [buffer-name]

Parameter

buffer-name

Indicates which buffer is to be deleted. The default is the current buffer.

Description

The DELETE BUFFER command deletes the specified buffer. If the buffer is being displayed, LSE replaces it with another buffer. You cannot delete system buffers.

If the specified buffer has been modified and is not read-only, LSE prompts you to answer Y if you want to continue the DELETE BUFFER operation. Otherwise, answer N.

Related Commands

GOTO BUFFER

GOTO FILE

SHOW BUFFER

Example

LSE> DELETE BUFFER USER.BUF

Deletes the buffer named USER.BUF.

Format

DELETE COMMAND command-name

Parameter

command-name

Specifies the command to be deleted.

Description

The DELETE COMMAND command cancels the definition of a command previously established by a DEFINE COMMAND command.

Related Commands

DEFINE COMMAND

Example

LSE> DELETE COMMAND XYZ

Cancels the definition of the user-defined command XYZ.

Format

DELETE KEY key-specifier

Qualifier

Parameter

key-specifier

Indicates the keyword or single printing character for the key to be deleted. Valid key-specifiers include all keynames recognized by the DEFINE KEY command.

Description

The DELETE KEY command cancels a key definition established by a previous DEFINEKEY command. If the key is a printing key, LSE restores the original function of inserting a printing character at the current cursor position; otherwise, the key is undefined.

Related Commands

DEFINE KEY

SHOW KEY

Example

LSE> DELETE KEY KP7

Deletes the definition for the KP7 key (the 7 key on the numeric keypad).

Format

DELETE KEYWORDS keyword-list-name

Parameter

keyword-list-name

Specifies the keyword list to be deleted.

Description

The DELETE KEYWORDS command cancels the keyword list defined by the previous DEFINEKEYWORDS command.

Related Commands

DEFINE KEYWORDS

EXTRACT KEYWORDS

SHOW KEYWORDS

Example

LSE> DELETE KEYWORDS author_name

Cancels the keyword list named author_name.

Format

DELETE LANGUAGE language-name

Parameter

language-name

Specifies the language to be deleted.

Description

The DELETE LANGUAGE command cancels the language defined by the previous DEFINELANGUAGE command. LSE does not actually delete the tokens, placeholders, and aliases associated with the language, but it makes them unavailable for use. If you subsequently enter a DEFINE LANGUAGE command for the same language name, LSE re-associates all the previously defined tokens, placeholders, and aliases with the new language definition. Thus, you can use the DELETE LANGUAGE command as a step in modifying the properties of a language definition.

Related Commands

DEFINE LANGUAGE

EXTRACT LANGUAGE

SHOW LANGUAGE

Example

LSE> DELETE LANGUAGE ADA

Cancels the previously defined characteristics for the Ada language.

Format

DELETE LIBRARY library-spec[, . . . ]

Qualifiers

Parameter

library-spec[, . . . ]

Specifies one or more libraries to be deleted. The library must be one of the current SCA libraries established by the SET LIBRARY command. You can use a library number in place of a library specification. For example, the primary library is library #1. You can also specify a wildcard name expression.

Related Commands

CREATE LIBRARY

LOAD

SET LIBRARY

SHOW LIBRARY

Example

LSE> DELETE LIBRARY/CONFIRM SCA$:[USER.SCA]

Deletes a library after confirmation that the library should be deleted.

Format

DELETE MODULE module-name[, . . . ]

Qualifiers

Parameter

module-name[, . . . ]

Specifies the names of the modules to be deleted from the current library. You can specify a wildcard name expression.

Description

The DELETE MODULE command allows you to selectively update a specific SCA library.

Example

$ SCA DELETE MODULE module_1

Deletes module_1 from the library.

Format

DELETE OVERVIEW

Qualifier

Description

The DELETE OVERVIEW command gets rid of all the overview lines in the current buffer and makes all the real lines in the buffer visible.

Example

LSE> DELETE OVERVIEW

Format

DELETE PACKAGE package-name

Parameter

package-name

Names the package definition to be deleted.

Description

The DELETE PACKAGE command deletes the specified package. The routines and parameters associated with the package are not deleted, but they are no longer available for use. If a subsequent DEFINE PACKAGE command is entered for the same package name, all the previously defined routines and parameters become associated with the new package definition. Thus, you can use the DELETE PACKAGE command, followed by the DEFINE PACKAGE command, to modify the properties of a package definition.

Related Commands

DEFINE PACKAGE

EXTRACT PACKAGE

SHOW PACKAGE

Example

LSE> DELETE PACKAGE system_services

Deletes the package named system_services.

Format

DELETE PARAMETER parameter-name

Qualifier

Parameter

parameter-name

Specifies the name of the parameter to be deleted.

Description

The DELETE PARAMETER command deletes the specified parameter definition from the package specified by the /PACKAGE qualifier.

Related Commands

DEFINE PARAMETER

EXTRACT PARAMETER

SHOW PARAMETER

Example

LSE> DELETE PARAMETER/PACKAGE=system_services id

Deletes the parameter named id from the package named system_services.

Format

DELETE PLACEHOLDER name

Qualifier

Parameter

name

Specifies the name of the placeholder to be deleted.

Description

The DELETE PLACEHOLDER command removes a specified name from the list of placeholders associated with a language.

Related Commands

DEFINE PLACEHOLDER

EXTRACT PLACEHOLDER

SHOW PLACEHOLDER

Example

LSE> DELETE PLACEHOLDER/LANGUAGE=EXAMPLE parameter

Removes the placeholder named parameter from the list of placeholders associated with the language EXAMPLE.

Format

DELETE QUERY [query-name]

Parameter

query-name

Specifies the query to be deleted. If you omit the query name, the current query is deleted. You can specify wildcards.

Description

The DELETE QUERY command deletes an SCA query.

DECwindows Interface Equivalent

Pop-up menu: Query buffer > Delete Query

Related Commands

FIND

GOTO QUERY

NEXT QUERY

PREVIOUS QUERY

SHOW QUERY

Example

LSE> DELETE QUERY 1

Removes the query named 1.

Format

DELETE ROUTINE routine-name

Qualifier

Parameter

routine-name

Specifies the name of the routine to be deleted.

Description

The DELETE ROUTINE command deletes a routine definition from a package. If the routine has already been expanded in the current editing session, the tokens defined by the expansion remain.

Related Commands

DEFINE ROUTINE

EXTRACT ROUTINE

SHOW ROUTINE

Example

LSE> DELETE ROUTINE/PACKAGE=system_services sys$add_holder

Deletes the routine named sys$add_holder from the package named system_services.

Format

DELETE TAG name

Qualifier

Parameter

name

Specifies the name of the tag to be deleted.

Description

The DELETE TAG command removes a specified name from the list of tags associated with a language.

Related Commands

DEFINE TAG

EXTRACT TAG

SHOW TAG

Example

LSE> DELETE TAG/LANGUAGE=EXAMPLE parameters

Removes the tag named parameters from the list of tags associated with the language EXAMPLE.

Format

DELETE TOKEN name

Qualifier

Parameter

name

Specifies the token name to be deleted.

Description

The DELETE TOKEN command removes a token name from the list of tokens associated with either the current language or a language you specify.

Related Commands

DEFINE TOKEN

EXTRACT TOKEN

SHOW TOKEN

Example

LSE> DELETE TOKEN/LANGUAGE=EXAMPLE assignment

Removes the token assignment from the list of tokens associated with the language EXAMPLE.

Format

DELETE WINDOW

Description

The DELETE WINDOW command deletes the current window, unless there is only one window. The remaining windows are enlarged to occupy the entire screen.

Related Commands

ONE WINDOW

SET SCREEN WINDOW

Format

DO [string[, . . . ]]

Qualifiers

Parameter

string[, . . . ]

Specifies a list of comma-separated commands or statements to be executed. Commands with embedded spaces, such as GOTO BUFFER, must be enclosed by double quotation marks.

Description

With the DO command, you can enter commands from a command line or from a buffer. You can specify a list of commands to be executed, or direct LSE to prompt you for LSE/SCA commands or DECTPU program statements (see the DEC Text Processing Utility Reference Manual for a description of DECTPU programs).

To end the prompting for commands and return to keypad editing, enter the CONTINUE command, or press Ctrl/Z.

Keypad Equivalent

Related Commands

CALL

CONTINUE

GOTO COMMAND

EXTEND

Examples

Format

END DEFINE

Description

The END DEFINE command ends the body that follows a DEFINE PLACEHOLDER or DEFINE TOKEN command, if the placeholder or token definition has a body. The END DEFINE command ends the list of keywords defined by the DEFINE KEYWORDS command.

The END DEFINE command also ends the sequence of keystrokes that follows a DEFINE KEY/LEARN command. To use the END DEFINE command for this purpose,enter the command by pressing a key you have defined to be the END DEFINE key.

Related Commands

DEFINE KEY

DEFINE KEYWORDS

DEFINE PLACEHOLDER

DEFINE TOKEN

Example

   DEFINE PLACEHOLDER parameter -
     /LANGUAGE = EXAMPLE -
     /DESCRIPTION = "Parameter name"
     /DUPLICATION = HORIZONTAL -
     /SEPARATOR = ", " -
     /TYPE = TERMINAL
     "A string of letters and digits starting with a letter."
   END DEFINE

Shows the position of the END DEFINE command at the end of a DEFINE PLACEHOLDER command.

Format

END REVIEW

Description

The END REVIEW command ends the current REVIEW session (initiated by a REVIEW or COMPILE/REVIEW command) and deletes the window containing the$REVIEW buffer.

DECwindows Interface Equivalent

Pop-up menu: Review buffer > End Review

Related Commands

REVIEW

Format

ENLARGE WINDOW line-count

Parameter

line-count

Specifies the number of screen lines you want to add to the current window. If you do not supply this parameter, LSE prompts you for the number of lines to add.

The maximum size of a window depends on the size and type of the terminal screen you are using. The minimum size is one line of text and one line for the status line.

Description

The ENLARGE WINDOW command enlarges the window the text cursor is in (if you are using more than one window). LSE shrinks the other window (or windows) accordingly.

Related Commands

SHRINK WINDOW

Example

LSE> ENLARGE WINDOW 10

Adds ten lines to the current window, taking them proportionally from the other window (or windows) on the screen.

Format

ENTER COMMENT

Qualifiers

Description

The ENTER COMMENT command converts pseudocode into comments. It inserts a comment near the current cursor position.

If the cursor is on a pseudocode placeholder, the command moves the placeholder's text into the comment and replaces the placeholder with the LSE$GENERIC placeholder. The cursor is then positioned on the generic placeholder.

If the cursor is in a comment, the LSE editor finds a nearby pseudocode placeholder P, and converts P's content into a comment. The LSE$GENERIC placeholder is inserted in place of P and the cursor remains on the generic placeholder. The command qualifiers are ignored when the cursor is on a comment.

If the cursor is not on a placeholder or comment, the command inserts a new comment and puts the LSE$GENERIC placeholder inside the comment. The cursor is then positioned on the generic placeholder.

If there is a sequence of pseudocode placeholders and a selected range is active when ENTER COMMENT is executed, all text in the selected range is converted into a comment and the placeholders are replaced with LSE$GENERIC placeholders accordingly. The cursor is positioned on the first placeholder after the comment.

DEFINE PLACEHOLDER LSE$BLOCK_COMMENT /TYPE=NOTERMINAL
    "– {tbs}"
    "–"
END DEFINE

DEFINE PLACEHOLDER LSE$LINE_COMMENT /TYPE=NOTERMINAL
    "– {tbs}"
END DEFINE

DEFINE PLACEHOLDER LSE$GENERIC /TYPE=NOTERMINAL
    "{tbs}"
END DEFINE

DEFINE PLACEHOLDER LSE$BLOCK_COMMENT
    "*"/INDENTATION=(fixed,1), "{tbs}"
    "*"/INDENTATION=(fixed,1)

DEFINE PLACEHOLDER LSE$BLOCK_COMMENT
    "!", " {tbs}"/INDENTATION=EXPAND
    "!"

Related Commands

UNDO ENTER COMMENT

Examples

The following are examples of converting pseudocode to comments: