Document revision date: 30 March 2001

## Extensible Versatile Editor Reference Manual

Previous | Contents | Index

## HELP

### Key

EVE Default: | HELP (keypad diagram) GOLD-Help (list of defined keys)
VT100 Keypad: | PF2 (diagram)
EDT Keypad: | PF2 (diagram) GOLD-PF2 (list)
WPS Keypad: | GOLD-H (diagram)

### Format

> HELP [topic]

### Parameter

> #### topic

> An EVE command or other topic on which you want help. You can abbreviate the topic name. If more than one name matches your request, EVE shows a list of the matching topics so you can choose the one you want. (For example, if you type HELP SET, EVE lists all the SET commands.) If you specify a question mark (?) or if you do not specify any topic, EVE displays the list of topics. If you want help on the TPU command, EVE switches to a help library on DECTPU built-in procedures and other topics.

### Description

> The HELP command displays online help for EVE commands, keys, or other topics, including DECTPU built-in procedures.

> EVE has four kinds of help topics:

> - Command topics
>   Command topics explain EVE commands and provide one or more examples or a list of steps that use the command, a list of any keys defined for the command (including EDT or WPS keys), and other information.
> - Keypad topics
>   Keypad topics explain EDT or WPS keys that are defined as special procedures other than as EVE commands. For example with the EDT or WPS keypad, you can press Help and then Ctrl/J to get help on the Delete Previous Word key.
> - Informational topics
>   Informational topics explain areas of operation, features of the editor, or concepts such as the following:

>   > Attributes
>   > Defaults
>   > EDT conversion
>   > Initialization files
>   > Names for keys
>   > Ranges and boxes

> - TPU topics
>   TPU topics explain DECTPU built-in procedures and other topics.

> To scroll through lengthy HELP topics, press the Next Screen and Prev Screen keys (on VT100-series terminals, press KP0 and Period on the numeric keypad). To exit from HELP and resume editing, press the Return key.

> To get help on DECTPU built-ins and other topics, use HELP TPU. For example, the following command displays help on the COPY_TEXT built-in:

>     Command: HELP TPU COPY_TEXT

> The last help topic you viewed is stored in an EVE system buffer named HELP. You can edit the HELP buffer, for example, to add comments of your own. (Some editing operations, such as FILL commands, may not work in the HELP buffer.) The last topic you viewed remains in the HELP buffer until you use another HELP command (or until you exit from the editor).

> You can write out the HELP buffer (for example, to keep a copy of the list of defined keys) by using the WRITE FILE command.

> Note GOLD-Help is a "sleeper" key, meaning that EVE defines this key sequence but does not define a default GOLD key. The definition is enabled when you use the SET GOLD KEY, SET KEYPAD EDT, or SET KEYPAD WPS command, unless you have otherwise defined it yourself.

### Example

> The following example displays help on the ENLARGE WINDOW command. (HELP discards the variable parameter (in this case, 5).)

    Command: HELP ENLARGE WINDOW 5

## INCLUDE FILE

### Key

WPS Keypad: | GOLD-G

### Format

> INCLUDE FILE filespec

### Parameter

> #### filespec

> The file you want to include. You can use logical names and wildcards in the file specification. If more than one file matches your request, EVE shows a list of the matching files so you can choose the one you want. You can include several files in a buffer, but can include only one file at a time. If you do not specify a file, EVE prompts for one. Pressing the Return key or the Do key at the prompt without typing anything cancels the operation.

### Description

> The INCLUDE FILE command copies the file you specify into the current buffer, inserting its contents before the current line. INCLUDE FILE inserts the text of the specified file whether the mode of the buffer is insert or overstrike. The cursor remains on the current character after the text of the file is included.

> Including a file does not change the name of the buffer or the output file associated with the buffer. If the file you are including contains tab characters, the tab stops of the current buffer apply. Including a file does not reformat (rewrap) the text. To reformat text according to the margins of the buffer, use FILL commands.

> If you use a search list or wildcard directory (such as [...]) to specify a file, EVE gets the first matching file found---without displaying the $CHOICES$ buffer.

> Including a large file can be slow if you use buffer-change journaling, which is the default in effect.

#### Related Commands

> GET FILE
> GET WILDCARDED FILES
> OPEN
> OPEN SELECTED

### Example

> The following command includes a file called MORE.DAT, copying it into the current buffer:

    Command: INCLUDE FILE MORE.DAT

## INSERT HERE

### Key

EVE Default: | Insert Here
VT100 Keypad: | KP9
EDT Keypad: | GOLD-KP6

### Format

> INSERT HERE

### Description

> The INSERT HERE command inserts at your current position what you previously copied or removed (same as the PASTE command).

> By default, the text is inserted whether the buffer is in insert or overstrike mode. Existing text is pushed to the right or down. Depending on the amount of text inserted and where you are on the line, your text may go past the right margin or even partly out of view. Use FILL commands, if necessary, to reformat (rewrap) your text.

> If SET BOX SELECT is in effect, INSERT HERE is the same as BOX PASTE, usually overwriting existing text. See the description of the BOX PASTE command or read the online help topic on Ranges and Boxes.

> Depending on your setting, the text is inserted either from the INSERT HERE buffer in EVE or from the DECwindows clipboard. The default is SET NOCLIPBOARD, which uses the INSERT HERE buffer. For more information, see the description of the SET CLIPBOARD command.

> The WPS keypad redefines the Insert Here key on the minikeypad as WPS Paste, which lets you use WPS-style alternate paste buffers or the INSERT HERE buffer, but does not use the clipboard.

#### Related Commands

> BOX PASTE
> REMOVE
> SET BOX PAD
> SET BOX SELECT
> SET CLIPBOARD
> STORE TEXT

## INSERT MODE

### Format

> INSERT MODE

### Description

> The INSERT MODE command sets the mode of the current buffer to insert, as opposed to overstrike. In insert mode, as you type, the new text is inserted at the current position, pushing the cursor and any existing text to the right or down.

> The mode of the current buffer is shown in the status line. You can have one buffer set to insert and another buffer set to overstrike. For buffers you create, the default is insert mode.

> The default mode for editing EVE command lines or prompt lines matches your terminal setting (on character-cell terminals only), according to the DCL command SET TERMINAL and independent of the mode of your text buffers.

> If SET BOX NOPAD is in effect, the mode of the buffer determines the effects of BOX CUT and BOX PASTE. In insert mode, BOX CUT causes the text to the right to "collapse" to the left, closing the gap, and BOX PASTE pushes existing lines to the right. To override these effects, use BOX CUT OVERSTRIKE and BOX PASTE OVERSTRIKE.

> For a list of the commands and keys affected by the mode of the buffer, see Table 2-3.

#### Related Commands

> CHANGE MODE
> OVERSTRIKE MODE
> SET BOX PAD

## INSERT PAGE BREAK

### Key

EVE Default: | Ctrl/L
WPS Keypad: | GOLD-N

### Format

> INSERT PAGE BREAK

### Description

> The INSERT PAGE BREAK command inserts a "hard" page break, or a form feed, appearing as a small FF .

> EVE puts the form feed on a line by itself, as follows:

> Cursor Positions | Effects with INSERT PAGE BREAK
> Start of a line of text | Inserts a form feed and then does a RETURN command to start a new line.
> Start of a blank line | Inserts a form feed and moves down to the start of the next line---without doing a RETURN command.
> Elsewhere on a line | Does a RETURN command to start a new line, inserts a form feed, and then does another RETURN.

> To insert a form feed in the middle of a line without causing the line to be split, use the QUOTE command and Ctrl/L.

#### Related Commands

> MOVE BY PAGE
> PAGINATE

## LEARN

### Key

EDT Keypad: | Ctrl/K
WPS Keypad: | Ctrl/K GOLD-> (right angle)

### Format

> LEARN

### Description

> The LEARN command starts a learn sequence of keystrokes to be defined as a single key. A learn sequence can comprise commands, text, or both. In some text editors and word processors, this is called a macro. You can define any of the following keys:
> - Function key, such as PF4, KP7, or F20
> - Control key, such as Ctrl/N
> - GOLD key sequence, such as GOLD-KP7 or GOLD A
> - Shifted function key, such as Shift/F14 (DECwindows only)
> - Alt key combination, such as Alt/Z (DECwindows only)
> - Mouse button, such as MB3 click (DECwindows only)

> Do not press a key you have used in the sequence being remembered.

> To cancel the definition, press the Return key or Ctrl/M, which cannot be redefined.

> Your key definition overrides the current definition of the specified key, whether the EVE default, EDT keypad, WPS keypad, or your own. For example, if the key you define for the learn sequence is ordinarily defined by a keypad setting, such as EDT or WPS, your definition overrides the keypad definition. To restore the keypad definition, use the UNDEFINE KEY command.

> The key definition remains in effect throughout your editing session or until you redefine or undefine the key. To save the key definition for future sessions, use the SAVE EXTENDED EVE command to create a section file. You cannot put a learn sequence in an initialization file.

> A learn sequence records keystrokes rather than the key definitions at the time the sequence was created. Therefore, before you "replay" a learn sequence, check that any keys used in the sequence are defined appropriately, and also that any settings that affect the sequence are correct; otherwise, the learn sequence may fail or may not work as expected. Depending on what your learn sequence is to do, check the following:

> > Box settings (box selection, padding)
> > Buffer attributes (margins, paragraph indent, tab stops)
> > Clipboard setting
> > Contents of the INSERT HERE buffer or DECwindows clipboard
> > Contents of $RESTORE$ buffers
> > Cursor motion (bound or free)
> > Direction (forward or reverse)
> > Key definitions, including keypad setting and GOLD key
> > Mode (insert or overstrike)
> > Pending delete setting
> > Search attributes (white space, case exact)
> > Search string and direction for FIND NEXT
> > Tab mode (insert, movement, spaces)
> > Wildcard setting

> Mouse operations (such as choosing DECwindows menu items) are not learned.

#### Related Commands

> REMEMBER
> UNDEFINE KEY

### Example

> In the following example, you create a learn sequence to bind the INSERT HERE and FILL PARAGRAPH commands to F20. Thereafter, pressing F20 inserts the text you copied or removed and then fills the current paragraph.

    Command: LEARN
    Press keystrokes to be learned. Press Ctrl/R to remember these keystrokes.
    Command: INSERT HERE
    Command: FILL PARAGRAPH
    Ctrl/R
    Press the key you want to use to do what was just learned: F20
    Key sequence remembered.

## LINE

### Format

> LINE integer [procedure]

### Parameters

> #### integer

> The number of the line you want to go to. If you specify a number greater than the total number of lines in the buffer, EVE moves the cursor to the end of the buffer. If you do not specify a line number, EVE prompts for one. Pressing the Return key or the Do key at the prompt without typing anything cancels the operation.

> #### procedure

> The DECTPU procedure in which you want to go to the specified line. The procedure must be in the current buffer. You can abbreviate the procedure name but you cannot use wildcards; the name is not case sensitive. If more than one procedure matches your request, EVE shows a list of the matching procedures ($CHOICES$ buffer) so you can choose the one you want. Specifying a procedure is useful because some compiler messages refer to line numbers in a procedure.

### Description

> The LINE command moves the cursor to the start of a line you specify by number---either in the current buffer or within a specified DECTPU procedure in the buffer. If you do not specify a line number, the LINE command prompts for one but does not prompt for a procedure name.

> If you specify a number greater than the total number of lines in the buffer, EVE moves the cursor to the end of the buffer.

> To find out the current line number and total number of lines in the buffer, use the WHAT LINE command.

#### Related Commands

> MOVE BY LINE
> MOVE DOWN
> MOVE UP
> WHAT LINE

### Examples

> To move the cursor to the start of line 10 in the current buffer, use the following command:

#1
    Command: LINE 10

> To move the cursor to the start of line 10 in a procedure named USER_PROC in the current buffer, use the following command:

#2
    Command: LINE 10 USER_PROC

## LOWERCASE WORD

### Format

> LOWERCASE WORD

### Description

> The LOWERCASE WORD command makes letters lowercase in a range, box, or single word. You can use LOWERCASE WORD with a select range, found range, or box. With a select range or found range, LOWERCASE WORD works on each word in the range, starting with the first character of the range and ending at the end of the range.

> If there is no selection or found range, LOWERCASE WORD works on the current word. If you are between words, it works on the next word on the line.

#### Related Commands

> CAPITALIZE WORD
> UPPERCASE WORD

### Example

> The following commands find the next occurrence of a search string you have already specified, and then makes all the letters of the found text lowercase:

    Command: FIND NEXT
    Command: LOWERCASE WORD

## MARK

### Format

> MARK marker-name

### Parameter

> #### marker-name

> The name you want to mark the current position in the buffer. Marker names are not case sensitive and may contain embedded spaces. You cannot use wildcards (for example, an asterisk is treated as a character in the marker name). If you specify a marker name that is already used, the previous marker is canceled. If you do not specify a marker, EVE prompts for one. Pressing the Return key or the Do key at the prompt without typing anything cancels the operation.

### Description

> The MARK command puts an invisible marker at the current position and associates it with the name you specify. Later, using the GO TO command, you can return to the marked position. Using MARK and GO TO makes it easier to move through a large buffer or to move between buffers. Markers are not saved from session to session. To find out marker names in a buffer, use the SHOW command.

> For an example of using MARK and GO TO, see the description of the GO TO command.

## MOVE BY LINE

### Key

EVE Default: | F12
VT100 Keypad: | MINUS

### Format

> MOVE BY LINE

### Description

> The MOVE BY LINE command moves the cursor a line at a time in the direction of the buffer; forward or reverse, as shown in the status line. In forward direction, MOVE BY LINE moves the cursor to the end of the current line or, if you are already there, to the end of the next line. In reverse direction, it moves to the start of the current line or, if you are already there, to the start of the previous line. You can repeat the operation until you reach the bottom or top of the buffer.

> The SET FUNCTION KEYS DECWINDOWS command defines F12 as START OF LINE.

#### Related Commands

> CHANGE DIRECTION
> END OF LINE
> LINE
> START OF LINE

## MOVE BY PAGE

### Key

EDT Keypad: | KP7
WPS Keypad: | PF2

### Format

> MOVE BY PAGE

### Description

> The MOVE BY PAGE command moves the cursor a page at a time in the direction of the buffer; forward or reverse, as shown in the status line. A page break is a form feed (appearing as a small FF ) or the top or bottom of the buffer. Thus, if there is no form feed in the current direction, MOVE BY PAGE moves to the top or bottom of the buffer.

#### Related Commands

> CHANGE DIRECTION
> INSERT PAGE BREAK
> PAGINATE

## MOVE BY WORD

### Key

EDT Keypad: | KP1
WPS Keypad: | KP4 (WPS Word) GOLD-KP4

### Format

> MOVE BY WORD

### Description

> The MOVE BY WORD command moves the cursor a word at a time in the direction of the buffer; forward or reverse, as shown in the status line. MOVE BY WORD always moves the cursor to the start of a word. In the forward direction, the cursor moves to the start of the next word, if any; that is, the first nonwhite-space character in the word. In reverse direction, the cursor moves to the start of the current word or, if you are already there, to the start of the previous word, if any. You can repeat the operation until you reach the bottom or top of the buffer.

#### Related Commands

> CHANGE DIRECTION
> END OF LINE
> MOVE BY LINE
> START OF LINE

Previous | Next | Contents | Index

| privacy and legal statement |
6021PRO_005.HTML