HP 3000 Manuals

HP EDIT Reference Manual

Describe 

Purpose 

Provides a brief command description.

Default Syntax 

None

This command does not have a default key assignment.  You can either
assign a key to the command using the Assign Key command or issue the
command using Execute Editor Command.

Description 

This command provides information about a specified command, including
syntax, a brief description, and basic procedure.

Command Process 

When you execute the command, HP EDIT temporarily suspends the editing
session, displays the Command Description screen, and prompts you for a
command name.  After you provide the command name, HP EDIT displays the
information on the screen.  You can display information on other HP EDIT
commands by pressing any key to return to the prompt and then providing
another command name.

Options 

There are a number of key options available to assist you in using this
command.  After you execute the command and the prompt appears, you can
use the following keys to perform the described functions:

Space bar             Attempts to complete the partial name specified and
                      display the entire command on the message line.
                      For instance, if you type fill beside the prompt
                      and press this key, HP EDIT responds by displaying
                      fill character on the message line.  You can then
                      press Return to execute this command.  This feature
                      is useful if you remember the beginning of a
                      command name but cannot recall the entire name.

?                     Displays command names that begin with the partial
                      command name specified.  For instance, if you type
                      forward beside the prompt and press Return, HP EDIT
                      does not execute the command because more than one
                      command begins with the word forward.  If you then
                      type ?, HP EDIT displays a list of possible
                      entries.  You would then press Return and supply
                      the desired word that completes the command, which
                      is either character, line, or word.

Return                Attempts to execute the entire or partial command
                      name specified.  If HP EDIT cannot execute the
                      command as specified, it displays the portion that
                      it recognizes.  You must then supply the remaining
                      minimum number of characters necessary for HP EDIT
                      to execute the command.

                      For instance, if you only type for and press
                      Return, HP EDIT completes the word to forward and
                      moves the cursor beyond this word.  You must then
                      specify whether you want the editor to move forward
                      a character, word, or line.  If you want to specify
                      a line, you would only have to type l after the
                      word forward and press the Return key.

Backspace             Deletes a character from a typed command string.

CTRL w                Deletes a word from a typed command string.

CTRL u                Deletes the entire typed command string and returns
                      the cursor to its original position beside the
                      prompt.

CTRL r                Refreshes the entire typed command string.  This
                      feature is useful when a terminal message obscures
                      the command string.

CTRL y                Aborts the command process and returns the cursor
                      to its former text position.

Procedure 

To obtain a brief description about a command: 

   1.  Issue Execute Editor Command (E). HP EDIT displays the prompt
       Command:  on the message line.

   2.  Type describe and press Return.  HP EDIT suspends the editing
       session and displays the Command Description screen and the prompt
       Command to describe:  at the top of the screen.

   3.  Type the name of the command for which you want to obtain
       information.  HP EDIT displays the syntax, a brief description,
       and basic procedure for the specified command.

   4.  Press CTRL y or Return to exit the Command Description screen and
       return to the editing session.  You can also press CTRL y if you
       are in the process of entering a command name when you want to
       exit.

Example 

To obtain a brief description for the Paste After and Paste Before 
commands: 

   1.  Issue Execute Editor Command (E). HP EDIT displays the following
       prompt on the message line:

            Command: _

   2.  Type describe and press Return.  HP EDIT displays the Command
       Description screen and prompt as shown:


            

   3.  Type paste after at the cursor position and press Return HP EDIT
       displays the following information for the command and moves the
       cursor to the bottom of the text:


            

   4.  Type paste before and press Return.  HP EDIT displays the
       following information for the command:


            

   5.  Press CTRL y to exit the Command Description screen and return to
       the editing session.

Related Commands 

Help

MPE/iX 5.0 Documentation