HELP DEFINE — MicroVMS 4.4
Associates equivalence names with a logical name. If you specify an existing logical name, the new equivalence names replace the existing equivalence name. Format DEFINE logical-name equivalence-name,...
Additional information available:
Parameters
equivalence-name
A character string of 1 to 255 characters. If the string contains
other than upper case alphanumeric, dollar sign, or underscore
characters, enclose it in quotation marks ("). Use double quotation
marks ("") to denote an actual quotation mark. Specifying more than
one equivalence-name for a logical-name creates a search list.
logical-name
A character string of 1 through 255 characters. If the string contains
other than upper case alphanumeric, dollar sign, or underscore
characters, enclose it in quotation marks ("). Use double quotation
marks ("") to denote an actual quotation mark. If the logical name is
to be entered into the process or system directory logical name
tables, then the name may only have from 1 to 31 alphanumeric
characters (including the dollar sign and underscore).
Avoid assigning a logical name that matches the file name of an
executable image in SYS$SYSTEM:. Such an assignment will prohibit
you from invoking that image.
Qualifiers
Additional information available:
/EXECUTIVE_MODE/GROUP/JOB/LOG/NAME_ATTRIBUTES
/PROCESS/SUPERVISOR_MODE/SYSTEM/TABLE/TRANSLATION_ATTRIBUTES
/USER_MODE
/EXECUTIVE_MODE
/SUPERVISOR_MODE (default) /USER_MODE Executive mode requires SYSNAM privilege. Specifies the mode of the logical name. If you specify executive mode without SYSNAM privilege, a supervisor mode logical name is created. The mode of the logical name must be the same as or external to (less privileged than) the mode of the table in which you are placing the name.
/GROUP
/JOB /PROCESS (default) /SYSTEM Group logical names require GRPNAM or SYSPRV privilege. System logical names require SYSNAM or SYSPRV privilege. Specifies the table in which the logical name is to be placed. The /GROUP qualifier is synonymous with /TABLE=LNM$GROUP. The /JOB qualifier is synonymous with /TABLE=LNM$JOB. The /PROCESS qualifier is synonymous with /TABLE=LNM$PROCESS. The /SYSTEM qualifier is synonymous with /TABLE=LNM$SYSTEM.
/JOB
See /GROUP.
/LOG (default)
/NOLOG Displays a message when a new logical name supersedes an existing name.
/NAME_ATTRIBUTES[=(keyword,...)]
Specifies the attributes for a logical name. (By default, no attributes are set.) Possible keywords are: +----------+-----------------------------------------------+ | CONFINE | Does not copy the logical name into a spawned | | | subprocess. Relevant only for logical names | | | in a private table. | +----------+-----------------------------------------------+ | NO_ALIAS | Prohibits creation of logical names with the | | | same name in a less privileged access | | | mode within the specified table. Deletes any | | | previously created, identical names in an | | | outer access mode within the specified table. | +----------+-----------------------------------------------+
/PROCESS
See /GROUP.
/SUPERVISOR_MODE
See /EXECUTIVE_MODE.
/SYSTEM
See /GROUP.
/TABLE=name
Requires WRITE access to the table if the table is shareable. Specifies the name of the logical name table in which the logical name is to be entered. You can specify user-defined tables (created with the CREATE/NAME_TABLE command), the process, job, group, or system logical name table, or the process or system logical name directory tables. The default is LNM$PROCESS. If you specify a table name that translates to more than one table, the logical name is placed with the first table found.
/TRANSLATION_ATTRIBUTES[=keyword,...]
Qualifies each equivalence string. Specifies attributes of the equivalence strings. Possible keywords are: +-----------+----------------------------------------------+ | CONCEALED | Indicates that the equivalence string is the | | | name of a concealed device | +-----------+----------------------------------------------+ | TERMINAL | Terminates logical name translation after | | | translation of this equivalence string | +-----------+----------------------------------------------+
/USER_MODE
See /EXECUTIVE_MODE.
/CHARACTERISTIC
Assigns a numeric value to a queue characteristic. The characteristic is created if it does not exist. Used in conjunction with the CHARACTERISTIC qualifier of the PRINT command. Format DEFINE/CHARACTERISTIC name number Requires the Secure User Environment Option. Requires OPER privilege.
Additional information available:
Parameters
name The name of an existing characteristic or a string of 1 through 31 characters that defines a new characteristic. The character string can include all upper and lover case letters, digits, the dollar sign and the underscore, and must include at least one alphabetic character. number An integer in the range 0 through 127.
/FORM
Assigns a numeric value to a print forms name. Used in conjunction with the /FORM qualifier of the PRINT command. Format DEFINE/FORM name number Requires the Secure User Environment Option. Requires OPER privilege.
Additional information available:
Parameters
name The name of an existing forms type or a string of from 1 to 31 characters to define a new forms type. The character string can include all upper and lover case letters, digits, the dollar sign and the underscore, and must include at least one alphabetic character. number An integer in the range 0 through 127.
Qualifiers
Additional information available:
/DESCRIPTION/LENGTH/MARGIN/PAGE_SETUP/SETUP
/SHEET_FEED/STOCK/TRUNCATE/WIDTH/WRAP
/DESCRIPTION=string
Specifies a string of from 1 to 255 characters to further describe the
form. If the string contains alphanumeric, underscore, or dollar sign
characters, it must be enclosed in quotation marks ("). The default
string is the name specified in the DEFINE/FORM command.
/LENGTH=page-length
Specifies the physical length of a forms page as an integer in the range 1 through 255. Defaults to 66. The print symbiont sets the page length of the device equal to the form length.
/MARGIN=(keyword,...)
Specifies one or more margin options. Possible keywords are: +----------+-----------------------------------------------+ | BOTTOM=n | Specifies the number of blank lines between | | | the end of the print image area and the end | | | of the physical page. The value of n must be | | | between 0 and the value of the /LENGTH | | | parameter and defaults to 6. | +----------+-----------------------------------------------+ | LEFT=n | Specifies the number of columns between the | | | leftmost printing position and the print | | | image area. The value of n must be between | | | 0 and the value of the /WIDTH parameter and | | | defaults to 0. | +----------+-----------------------------------------------+ | RIGHT=n | Specifies the number of columns between the | | | /WIDTH parameter and the image area. The | | | value of n must be between 0 and the value | | | of the /WIDTH parameter and defaults to 0. | +----------+-----------------------------------------------+ | TOP=n | Specifies the number of blank lines between | | | the top of the physical page and the top of | | | the print image. The value of n must be | | | between 0 and the value of the /LENGTH | | | parameter and defaults to 0. | +----------+-----------------------------------------------+
/PAGE_SETUP=(module[,...])
/NOPAGE_SETUP (default) Specifies one or more modules that set up the device before every page. The modules are located in the device control library. When a new page is detected, the system extracts the appropriate modules from the device control library and copies them to the printer before the page is printed.
/SETUP=(module,...)
/NOSETUP (default) Specifies one or more modules in the device control library that set up the device appropriately for the specified form. When the form is mounted, the system extracts the specified module(s) from the device control library and copies them to the printer before the job is printed.
/SHEET_FEED
/NOSHEET_FEED (default) Specifies that print jobs pause at the end of every physical page so that a new piece of paper can be inserted.
/STOCK=type
Specifies the type of paper stock to be associated with the form as a string of from 1 through 31 characters. The string must consist of alphanumeric, underscore, and dollar sign characters.
/TRUNCATE (default)
/NOTRUNCATE Discards any characters that exceed the current line length (specified by /WIDTH and /MARGIN=RIGHT). Incompatible with the /WRAP qualifier. If you specify both /NOTRUNCATE and /NOWRAP, the printer prints as many characters on a line as possible.
/WIDTH=width
Specifies the physical width of the paper in terms of columns or character positions as an integer in the range 0 through 65535. The /MARGIN=RIGHT qualifier overrides the /WIDTH qualifier. Defaults to 132.
/WRAP
/NOWRAP (default) Causes lines that exceed the current line length (specified by /WIDTH and /MARGIN=RIGHT) to wrap onto the next line. Incompatible with the /TRUNCATE qualifier. If you specify both /NOWRAP and /NOTRUNCATE, the printer prints as many characters on a line as possible.
/KEY
Equates a key on the terminal keyboard to a character string. Format DEFINE/KEY key-name equivalence-string
Additional information available:
Parameters
key-name The name of the key to be defined. Permissible keys are as follows: +------------------+------------+-----------------------+ | Keyname | VT100 Key | VT200 Key | +------------------+------------+-----------------------+ | PF1 | PF1 | PF1 | +------------------+------------+-----------------------+ | PF2 | PF2 | PF2 | +------------------+------------+-----------------------+ | PF3 | PF3 | PF3 | +------------------+------------+-----------------------+ | PF4 | PF4 | PF4 | +------------------+------------+-----------------------+ | KP0, KP1-KP9 | Keypad 0-9 | Keypad 0-9 | +------------------+------------+-----------------------+ | PERIOD | period key | period key | +------------------+------------+-----------------------+ | COMMA | comma key | comma key | +------------------+------------+-----------------------+ | MINUS | minus key | minus key | +------------------+------------+-----------------------+ | ENTER | enter key | enter key | +------------------+------------+-----------------------+ | LEFT | left arrow | left arrow | +------------------+------------+-----------------------+ | RIGHT | right arrow| right arrow | +------------------+------------+-----------------------+ | FIND,INSERT HERE | - | Find,Insert Here | +------------------+------------+-----------------------+ | REMOVE,SELECT | - | Remove,Select | +------------------+------------+-----------------------+ | PREV_SCREEN | - | Prev Screen | +------------------+------------+-----------------------+ | NEXT_SCREEN | - | Next Screen | +------------------+------------+-----------------------+ | HELP,DO | - | Help(F15),Do(F16) | +------------------+------------+-----------------------+ | F6-F14, F17-F20 | - | Function Keys F6-F14, | | | | F17-F20 | +------------------+------------+-----------------------+ Note: You must issue the SET TERMINAL/NOLINE_EDITING command before defining the LEFT and RIGHT arrow keys or the F6 through F14 keys. You cannot define the UP and DOWN arrow keys or F1 through F5. equivalence-string A character string to replace the key as input. Enclose the string in quotation marks to preserve spacing and lowercase characters.
Qualifiers
Additional information available:
/ECHO/ERASE/IF_STATE/LOCK_STATE/LOG/SET_STATE
/TERMINATE
/ECHO (default)
/NOECHO Displays the equivalence string on the screen after the key has been pressed. The /NOECHO qualifier is incompatible with the /NOTERMINATE qualifier.
/ERASE
/NOERASE (default) Erases the current line before the key translation is inserted.
/IF_STATE=(state,...)
/NOIF_STATE (default) Specifies a list of one or more states, one of which must be in effect for the key definition to work. The /NOIF_STATE has the same meaning as /IF_STATE=the_current_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.) Relevant only with the /SET_STATE qualifier.
/LOG (default)
/NOLOG Displays a message indicating that the key definition has been successfully created.
/SET_STATE=state
/NOSET_STATE (default)
Specifies a new state to be set when the specified key is pressed. (By
default, the current locked state is reset when the key is pressed.)
Specify the state as a character string enclosed in quotation marks
(").
/TERMINATE
/NOTERMINATE (default) Specifies that the key definition be processed immediately when the key is pressed (equivalent to typing the string and pressing RETURN). By default, you can press other keys before the definition is processed.