| Previous | Contents | Index |
Although this qualifier is required, you can specify an empty remark string. If you do not specify the /REMARK qualifier, VDE prompts you for a remark string.
If you specify only one username parameter, you may omit the surrounding parentheses.
The /NOSUCCESSOR qualifier specifies that the new stream does not have any successors.
If both the /SUCCESSOR and /NOSUCCESSOR qualifiers are omitted, the new stream has no successors unless you specify the /MAIN qualifier. See the description of the /MAIN qualifier for the special rules that apply in this case.
| #1 |
|---|
VDE„ CREATE STREAM V5.2-BL3/REMARK="Base Level 3 of V5.2"/NOLOG
VDE„
|
This example creates a new stream called V5.2-BL3. The remark string indicates that this is base level 3 of version 5.2 of the user's software system. The /NOLOG qualifier suppresses all log messages.
| #2 |
|---|
VDE„ CREATE STREAM V5.3 /REMARK="Version 5.3"
Creating directory tree for stream V5.3:
Root directory DEV$:[PROJDIR.V5_3] has been created
Facility ACCTNG root directory DEV$:[PROJDIR.V5_3.ACCTNG] has been created
Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.SRC] has been created
Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.OBJ] has been created
Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.VDE$COM] has been created
Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.VDE$LOG] has been created
Facility CODE root directory DEV$:[PROJDIR.V5_3.CODE] has been created
Subdirectory DEV$:[PROJDIR.V5_3.CODE.SRC] has been created
Subdirectory DEV$:[PROJDIR.V5_3.CODE.OBJ] has been created
Subdirectory DEV$:[PROJDIR.V5_3.CODE.VDE$COM] has been created
Subdirectory DEV$:[PROJDIR.V5_3.CODE.VDE$LOG] has been created
Facility RMS root directory DEV$:[PROJDIR.V5_3.RMS] has been created
Subdirectory DEV$:[PROJDIR.V5_3.RMS.SRC] has been created
Subdirectory DEV$:[PROJDIR.V5_3.RMS.OBJ] has been created
Subdirectory DEV$:[PROJDIR.V5_3.RMS.VDE$COM] has been created
Subdirectory DEV$:[PROJDIR.V5_3.RMS.VDE$LOG] has been created
Facility SMG root directory DEV$:[PROJDIR.V5_3.SMG] has been created
Subdirectory DEV$:[PROJDIR.V5_3.SMG.SRC] has been created
Subdirectory DEV$:[PROJDIR.V5_3.SMG.OBJ] has been created
Subdirectory DEV$:[PROJDIR.V5_3.SMG.VDE$COM] has been created
Subdirectory DEV$:[PROJDIR.V5_3.SMG.VDE$LOG] has been created
All directories for stream V5.3now exist
%VDE-I-STRMADDED, stream V5.3 added to the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
|
This example creates a new stream called V5.3, representing version 5.3 of the user software system. The log messages indicate that the directories for the new stream have been created, that the stream has been added to the database, and that the database transaction has successfully completed.
Creates a database record for a new user of the current VDE library.
CREATE USER username [, username...]
username
The OpenVMS username of the user to be added to the VDE database. This name can be up to 12 characters long and must follow VDE name syntax.
The CREATE USER command creates the database record for a new user of the current VDE library.Each user of a VDE library must have a record in the database of that library. This record contains the user's OpenVMS username, full name string, authorized and default privileges, and remark string. After the record has been created, the user has access to the VDE library as constrained by the specified privileges. A user who does not have a record in a given VDE database cannot use the VDE Utility to gain access to the database or the corresponding library.
/AUTH_PRIVILEGES=(priv [,priv...])
Specifies the new user's authorized privileges, which are the privileges the user is allowed to set with the VDE command SET PRIVILEGE. Each parameter to this qualifier names a single privilege. If only one privilege is specified, the parentheses may be omitted. If this qualifier is not specified, VDE assigns the standard authorized privileges of the library to the new user.For a list of privileges, see Table 3-5 in SET PRIVILEGES.
/DEF_PRIVILEGES=(priv [,priv...])
Specifies the new user's default privileges, which are the privileges enabled each time the user starts a new VDE session. Each parameter to this qualifier names a single privilege. Each privilege specified becomes an authorized privilege as well as a default privilege, even if it has not been listed with the /AUTH_PRIVILEGES qualifier. If only one privilege is specified, the parentheses may be omitted. If the /DEF_PRIVILEGES qualifier is not specified, VDE assigns the standard default privileges of the library to the new user.For a list of privileges, see Table 3-5 in SET PRIVILEGES.
/LOG (default)
/NOLOG
Controls whether log messages are printed after users have been added to the database. The /LOG qualifier causes the messages to be printed and /NOLOG suppresses them. The messages indicate that users have been added and that the database transaction has successfully committed./NAME="string"
Specifies the full name of the new user. The quoted name string, which can be up to 40 characters long, should contain the full name (first name, middle initials, and last name) of the new user.This qualifier is required. You can specify an empty name string but this is not recommended. If you do not specify the /NAME qualifier, VDE prompts you for a name string.
/NOTIFY=(username [,username...])
Specifies users to notify of all code changes replaced into the VDE library by the new user. Each username parameter specifies the OpenVMS username or mail address of a user who should be notified by mail message each time the new user created by this command replaces a module into the VDE library.Each username parameter can specify the username of a user already recorded in the VDE database, a OpenVMS mail address with one or more node names (such as NODE::SMITH), a mail forwarding alias, or a defined logical name bound to a list of users to notify. If you specify a logical name, keep in mind that the logical name must be defined when it is later used to send notification messages. It should thus be a group or system logical name or a logical name that is in some other way defined for all users of the VDE library.
If you specify only one username parameter, you may omit the surrounding parentheses.
/REMARK="string"
Specifies a remark string to be stored for the new user. The quoted remark string, which can be up to 132 characters long, may contain any explanatory remark about the new user that you want stored in the VDE database. Typically the remark describes the user's affiliation or function within the organization.This qualifier is required although you can specify an empty remark string. If you do not specify the /REMARK qualifier, VDE prompts you for a remark string.
/REVIEWER=(username [,username...])
Specifies reviewers for all code changes replaced into the VDE library by the new user. Each username parameter specifies the OpenVMS username of a user who should review all changes created by the new user. The reviewer must already be recorded in the VDE database. When the new user created by this command replaces a module into the VDE library, VDE notifies the reviewer of the change by mail message. If the replacement is queued, the reviewer should then review the queued replacement before it is performed. If the replacement is immediate, VDE notifies the reviewer of the new module generation that was created, and he or she may then inspect that generation. This qualifier can be used to set up "buddy systems" where two users always review each other's code.If you specify only one username parameter, you may omit the surrounding parentheses.
| #1 |
|---|
VDE„ CREATE USER SMITH NAME="Jane Smith"/REMARK="OpenVMS Developer"
%VDE-I-USERADDED, user SMITH added to the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
|
This command creates a database record for user SMITH. The /NAME qualifier specifies Jane Smith's full name and the /REMARK qualifier identifies her job. The example shows the informational log messages that the /LOG qualifier produces by default.
| #2 |
|---|
VDE„ CREATE USER DOE /NAME="John X. Doe"/REMARK="OpenVMS Writer" -
_VDE„ /AUTH_PRIVILEGES=(BUILD,CREGRP,CREMOD) -
_VDE„ /DEF_PRIVILEGES=(BUILD,CREFAC) /NOLOG
VDE„
|
In this example, user DOE is added to the database. In addition to specifying the full name and a remark for John Doe, this command gives his authorized and default VDE privileges. Note that the CREFAC privilege becomes an authorized privilege as well as a default privilege even though it is not listed by the /AUTH_PRIVILEGES qualifier. In this case, the /NOLOG qualifier suppresses the log messages.
| #3 |
|---|
VDE„ CREATE USER/REMARK="OpenVMS Developer" -
_VDE„ SMITH /NAME="Jane Smith", -
_VDE„ JONES /NAME="Frank Jones"
%VDE-I-USERADDED, user SMITH added to the database
%VDE-I-USERADDED, user JONES added to the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
|
This example illustrates the creation of database records for multiple users with a single CREATE USER command. This command adds users SMITH and JONES to the database. Both get the same remark string because the remark is specified immediately after the CREATE USER command. They get separate full name strings and both get the standard authorized and default privileges of the current library.
Defines a command abbreviation by associating a symbol name with a list of one or more VDE commands.
DEFINE/COMMAND symbol-name="command-string"
symbol-name
Specifies the symbol name that you want associated with a list of VDE commands. The symbol can be up to 255 characters long and can include letters, digits, underscores, and dollar signs. It cannot start with a digit. If symbol-name is already defined, the new definition replaces the old definition.command-string
Specifies the string of VDE commands to associate with the symbol name. The command string must be enclosed in quotation marks and consists of the first part of a VDE command, a whole command, or a list of commands separated by semicolons.
The DEFINE/COMMAND command associates a symbol name with a VDE command string. The command string consists of zero or more VDE commands separated by semicolons and must end with a partial or full VDE command.When the symbol name appears at the beginning of a VDE command, the symbol name is replaced by its associated command string. The resulting string is then parsed and executed as a normal command line by VDE. DEFINE/COMMAND thus gives you the same command abbreviation capability as the symbol assignment statement (symbol-name := command-string) in DCL. Symbol substitution only happens once at the beginning of each command. A symbol's associated command string can therefore not begin with another command symbol.
To display the current symbol definitions created by DEFINE/COMMAND, use the SHOW SYMBOL command.
None.
| #1 |
|---|
VDE„ DEFINE/COMMAND SM = "SHOW MODULE"
VDE„ SM MOD1
Module [FACIL]MOD1.MAR
VDE„
|
This DEFINE/COMMAND command associates the symbol SM with the VDE command "SHOW MODULE". When the SM command is used, SM is expanded to the equivalent command string. The module name MOD1 is then concatenated to that string to form the full command SHOW MODULE MOD1, which VDE then executes.
| #2 |
|---|
VDE„ DEFINE/COMMAND STRMFAC = "SET STREAM V5.3; SET FACILITY RMS"
VDE„ STRMFAC
VDE„ SHOW DEFAULTS
Library LIBNAME in root directory DEV$:[PROJDIR]
Default directory is DEV$:[SMITH]
Current session context:
Default stream is V5.3
Default facility is RMS
VDE„
VDE„
|
This example shows that a symbol can be associated with multiple commands. Here symbol STRMFAC is associated with both a SET STREAM command and a SET FACILITY command, where the two commands are separated by a semicolon. When the STRMFAC command is entered, the command string is substituted for the symbol name and the SET STREAM and SET FACILITY commands are executed. The output from a subsequent SHOW DEFAULTS command shows that the default stream and the default facility have been set by the STRMFAC command.
Defines a key to execute a VDE command. A key definition lets you to enter a command by pressing a key rather than typing the command. The /KEY qualifier is required and must precede any other qualifiers.
DEFINE/KEY key-name string
key-name
Specifies the name of the key you are defining. Table 3-1 contains a list of common keys on common keyboards.
Table 3-1 Key Names Key-name VT100 LK201,LK401 Default VDE Usage PF1 PF1 PF1 Sets GOLD state PF2 PF2 PF2 Gets Help PF3 PF3 PF3 none PF4 PF4 PF4 Sets BLUE state KP0, KP1-KP9 keypad 0-9 keypad 0-9 None PERIOD period key period key None COMMA comma key comma key None MINUS minus key minus key None ENTER ENTER key ENTER key None E1,E2 - Find,Insert Here None E3,E4 - Remove,Select None E5 - Previous Screen None E6 - Next Screen None HELP - Help/F15 Gets Help DO - Do/F16 None F17-F20 - F17-F20 Sets defaults to libraries
Note
You cannot redefine the arrow keys or function keys F1 through F14.string
Specifies the string that is entered when you press the defined key. String can be any VDE command, such as SHOW DEFAULTS or SET CONTEXT. To preserve spaces and lowercase characters, enclose the string in quotation marks.
The DEFINE/KEY command, on certain terminals, enables you to assign definitions to keys other than those on the main keyboard. The command can be used on a variety of terminals including the VT340, VT510 and the DECterm terminal emulator.The string parameter to the DEFINE/KEY command can contain different types of information and usually consists of an entire VDE command. For example, you can assign the SHOW DEFAULTS command to KP0. Then, when you press zero on the keypad, VDE displays your current default settings. Other definitions can consist of text strings to be appended to command lines. When you define a key to insert a text string, use the /NOTERMINATE qualifier so you can continue typing more data after the string has been inserted.
In most instances you will want to use the echo feature. The /ECHO qualifier displays the key definition on the screen each time you press the key. The default setting is /ECHO.
You can create as many definitions for a key as you want as long as you specify a new context for each definition. This new context is called a state. To create additional key definitions you must use two steps. First, using the /SET_STATE qualifier, you must define a key that establishes a state for the definition you want to create. Then you must create the new definition for your key and specify its state using the /IF_STATE qualifier.
State names can include letters, digits, dollar signs, and underscores. Create state names that are easy to remember and type and that remind you of the types of definitions you created. For example, you can create a state called SETSHOW. The key definitions for this state might refer to various VDE SET and SHOW commands.
Like various other utilities on OpenVMS, VDE supplies three built-in states called DEFAULT, GOLD, and BLUE. You can assign different definitions to keys used in combination with the GOLD and BLUE keys by using the /IF_STATE qualifier.
By convention, the GOLD state is selected by pressing the PF1 key, and the BLUE state is seected by pressing the PF4 key.
The SET KEY command changes the keypad state. Use the SHOW KEY command to display key definitions and states.
/ECHO (default)
/NOECHO
Specifies whether the command line is displayed on your screen after you press the defined key. You cannot define a key specifying both /NOECHO and /NOTERMINATE./IF_STATE=(state-name,...)
/NOIF_STATE (default)
Specifies a list of states, any one of which must be set to enable the specified key definition. (By including several state names, you can define a key to have the same function in all the specified states.) If you use the /NOIF_STATE qualifier or omit the /IF_STATE qualifier, the current state at the time you define the key must be set when you use the key definition. The state name can include letters, digits, dollar signs, and underscores. States are established with the /SET_STATE qualifier on another key definition or with the SET KEY command. If you specify only one state name, you can omit the parentheses./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./LOG (default)
/NOLOG
Specifies whether a log message is displayed after a key is defined. The message indicates a key definition has been created successfully. The /LOG qualifier causes such messages to be displayed and the /NOLOG qualifier suppresses them./SET_STATE=state
/NOSET_STATE (default)
Causes the specified state to be set when the key is pressed. (By default, the current locked state is reset when the key is pressed.) A state name can include letters, digits, dollar signs, and underscores. If you omit or negate this qualifier, the current state remains unchanged. You cannot define a key specifying both /SET_STATE and /TERMINATE./TERMINATE
/NOTERMINATE (default)
Determines whether the specified command string executes when you press the key. When you use /NOTERMINATE, you must press RETURN to execute the command string. When you use /TERMINATE, VDE executes the command string immediately when you press the key. You cannot define a key specifying both /SET_STATE and /TERMINATE.
| #1 |
|---|
VDE„ DEFINE/KEY KP1 "SHOW DEFAULTS"
|
This example shows how to define the keypad key KP1 as the VDE command SHOW DEFAULTS. To enter the SHOW DEFAULTS command, press KP1 followed by the RETURN key.
| #2 |
|---|
VDE„ DEFINE/KEY KP6 "SET CONTEXT BUGFIX" /TERMINATE
|
This example shows how to define the keypad key 6 as the SET CONTEXT BUGFIX command. The /TERMINATE qualifier causes the SET CONTEXT BUGFIX command to execute when you press keypad key 6 without having to press RETURN.
| #3 |
|---|
VDE„ DEFINE/KEY MINUS "SHOW DEFAULTS" /TERMINATE /NOECHO
|
This example shows how to define the minus key on the keypad as the SHOW DEFAULTS command. The /TERMINATE qualifier causes the SHOW DEFAULTS command to execute when you press the minus key. The /NOECHO qualifier prevents the display of the command line on the screen. You see the output of the command, but not the command line itself.
| #4 |
|---|
VDE„ DEFINE/KEY/TERMINATE KP7 "SHOW MODULE"
VDE„ DEFINE/KEY/SET_STATE=TEXAS PF3 ""
VDE„ DEFINE/KEY/IF_STATE=TEXAS/TERMINATE KP7 "SHOW FACILITY"
|
This example shows how to create two definitions for the KP7 key using the /SET_STATE and /IF_STATE qualifiers. The first command defines KP7 as the SHOW MODULE command and executes the command when the key is pressed. This is the default key definition for KP7. The second command establishes a new state for the key: when you press PF3, the state is set to TEXAS. The third command creates a new definition for KP7: when you press KP7, VDE executes the SHOW FACILITY command if the state has been set to TEXAS. You can thus execute the SHOW MODULE command by pressing KP7 by itself, and you can execute the SHOW FACILITY command by pressing the PF3 key followed by the KP7 key.
| #5 |
|---|
VDE„ DEFINE/KEY PF3 "SET " /SET_STATE=ALTERED
VDE„ DEFINE/KEY KP7 "CONTEXT BUGFIX" /TERMINATE /IF_STATE=ALTERED
VDE„ DEFINE/KEY KP8 "CONTEXT FEATURE_1" /TERMINATE /IF_STATE=ALTERED
VDE„ DEFINE/KEY KP9 "VERIFY" /TERMINATE /IF_STATE=ALTERED
|
Previous Next Contents Index