DCE$UAF_HELP.HLB  —  DEFINE
 Associates equivalence names with a logical name. If you specify
 an existing logical name, the new equivalence names replace the
 existing equivalence name. The DEFINE command can be used with
 the /KEY qualifier:

 o  The /KEY qualifier associates an equivalence string and a set
    of attributes with a key on the terminal keyboard (see /KEY).

    Format:

    DEFINE  logical-name equivalence-name[,...]

1    /KEY 

 Associates an equivalence string and a set of attributes with a key on
 the terminal keyboard.

    DEFINE/KEY  KEY-NAME  EQUIVALENCE-STRING

       Qualifiers             Defaults

       /[NO]ECHO              /ECHO
       /[NO]ERASE             /NOERASE
       /IF_STATE=(state-name) /NOIF_STATE
       /[NO]LOCK_STATE        /NOLOCK_STATE
       /[NO]LOG               /LOG
       /SET_STATE=(state-name)/NOSET_STATE
       /[NO]TERMINATE         /NOTERMINATE

1.1  –  Parameters 

 key-name

    Specifies the name of the OpenVMS account that is to be added.
    Specifies the name of the key that you are defining. All definable
    keys on VT52 terminals are located on the numeric keypad. On
    VT100-series terminals, you can define the left and right
    arrow keys as well as all the keys on the numeric keypad. On
    terminals with LK201 keyboards, the following three types of keys can
    be defined:

          o  Keys on the numeric keypad

          o  Keys on the editing keypad (except the up and down arrow keys)

          o  Keys on the function key row across the top of the keyboard
             (Note that you cannot define function keys F1 to F5.)

    Some definable keys are enabled for definition all the time.
    Others, including KP0 to KP9, Period, Comma, and Minus, must
    be enabled for definition purposes. You must enter either the
    SET TERMINAL/APPLICATION or the SET TERMINAL/NONUMERIC command
    before using these keys.

    On LK201 keyboards, you cannot define keys or function keys F1 to F5.
    The left and right arrow keys and the F6 to F14 keys are reserved for
    command line editing. You must enter the SET TERMINAL/NOLINE_EDITING
    command before defining these keys. You can also press Ctrl/V to
    enable keys F7 to F14. Note that Ctrl/V will not enable the F6 key.

 equivalence-string

    Specifies the character string to be processed when you press
    the key. Enclose the string in quotation marks (" ")  to
    preserve spaces and lowercase characters.

1.2  –  Qualifiers

1.2.1    /ECHO 

       /ECHO (default)
       /NOECHO

    Displays the equivalence string on your screen after the key
    has been pressed. You cannot use the /NOECHO qualifier with
    the /NOTERMINATE qualifier.

1.2.2    /ERASE 

       /ERASE
       /NOERASE (default)

    Determines whether the current line is erased before the key
    translation is inserted.

1.2.3    /IF_STATE 

       /IF_STATE=(state-name,...)
       /NOIF_STATE

    Specifies a list of one or more states, one of which must be
    in effect for the key definition to work. The /NOIF_STATE
    qualifier has the same meaning as /IF_STATE=current_state. The state
    name is an alphanumeric string. States are established with the
    /SET_STATE qualifier or the SET KEY command. If you specify only one
    state name, you can omit the parentheses. By including several
    state names, you can define a key to have the same function in all
    the specified states.

1.2.4    /LOCK_STATE 

       /LOCK_STATE
       /NOLOCK_STATE (default)

    Specifies that the state set by the /SET_STATE qualifier
    remain in effect until explicitly changed. (By default, the
    /SET_STATE qualifier is in effect only for the next definable key you
    press or the next read-terminating character that you type.) Can
    only be specified with the /SET_STATE qualifier.

1.2.5    /LOG 

       /LOG (default)
       /NOLOG

    Displays a message indicating that the key definition has
    been successfully created.

1.2.6    /SET_STATE 

       /SET_STATE=state-name
       /NOSET_STATE (default)

    Causes the specified state name to be set when the key is
    pressed. (By default, the current locked state is reset when the key
    is pressed.) If you have not included this qualifier with a key
    definition, you can use the SET KEY command to change the
    current state. The state name can be any alphanumeric string; specify
    the state as a character string enclosed in quotation marks.

1.2.7    /TERMINATE 

       /TERMINATE
       /NOTERMINATE (default)

    Specifies whether the current equivalence string is to be
    processed immediately when the key is pressed (equivalent to
    entering the string and pressing the Return key). By default,
    you can press other keys before the definition is processed.
    This allows you to create key definitions that insert text into
    command lines, after prompts, or into other text that you
    are entering.
Close Help