RVDE7

VDE
VDE
Reference Manual



 q
Previous[ Contents] Index



EAlthough this qualifier is required, you can specify an empty remark 9string. If you do not specify the /REMARK qualifier, VDE prompts you for a remark string.

/REPLACEMENT=keyword

DControls whether the REPLACE command permits immediate replacements ;into the new stream or requires queued replacements. If theEkeyword parameter is IMMEDIATE, the REPLACE command Dwill immediately replace modules into the stream by default. If the Gparameter is QUEUE, the REPLACE command will always queue replacements Hfor the stream so that modules are not replaced into the stream until a Gprivileged user enters a PERFORM REPLACEMENT command. If you omit this ;qualifier, VDE permits immediate replacements into the new Fstream. (See the descriptions of the /IMMEDIATE and /QUEUE qualifiers -to the REPLACE command for more information.),

/REVIEWER=(username [,username...])

GSpecifies reviewers for all changes replaced into the new stream. Each :username parameter specifies the OpenVMS Busername of a user who should review all changes to the specified 5stream. The user must already be recorded in the VDE 9database. When a module is replaced into the stream, VDE =notifies the user of the replacement by mail message. If the +replacement is queued, the user should then=review the queued replacement before it is performed. If the ;replacement is immediate, VDE notifies the user of the new Gmodule generation that was created, and the user may then inspect that generation.

EIf you specify only one username parameter, you may !omit the surrounding parentheses."

/STEP_DELAY=time-interval

FSpecifies the default step-delay time interval used by build jobs for <the new stream. See the description of the BUILD command for)a detailed description of this qualifier.0

/SUCCESSOR=(succ-name [, succ-name...])



/NOSUCCESSOR (default)

BThe /SUCCESSOR qualifier specifies successors to the stream being Ccreated. A successor to a stream is another stream to which source 4changes are propagated by the REPLACE command. Each Dsucc-name parameter specifies the name of a stream :that should be a successor to the new stream given by the 'stream-name parameter.

GThe /NOSUCCESSOR qualifier specifies that the new stream does not have any successors.

HIf both the /SUCCESSOR and /NOSUCCESSOR qualifiers are omitted, the new Estream has no successors unless you specify the /MAIN qualifier. See Hthe description of the /MAIN qualifier for the special rules that apply in this case.

/TIMEOUT=time-interval

FSpecifies the default timeout interval used by build jobs for the new @stream. See the description of the BUILD command for a detailed description of this qualifier. 


Examples

 6    
#1

 
?VDEä CREATE STREAM V5.2-BL3/REMARK="Base Level 3 of V5.2"/NOLOGVDEä      


EThis example creates a new stream called V5.2-BL3. The remark string Aindicates that this is base level 3 of version 5.2 of the user's Bsoftware system. The /NOLOG qualifier suppresses all log messages.

 6    
#2

 
-VDEä CREATE STREAM V5.3 /REMARK="Version 5.3"(Creating directory tree for stream V5.3:6   Root directory DEV$:[PROJDIR.V5_3] has been createdM   Facility ACCTNG root directory DEV$:[PROJDIR.V5_3.ACCTNG] has been createdB      Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.SRC] has been createdB      Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.OBJ] has been createdF      Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.VDE$COM] has been createdF      Subdirectory DEV$:[PROJDIR.V5_3.ACCTNG.VDE$LOG] has been createdI   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 createdD      Subdirectory DEV$:[PROJDIR.V5_3.CODE.VDE$COM] has been createdD      Subdirectory DEV$:[PROJDIR.V5_3.CODE.VDE$LOG] has been createdG   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 createdC      Subdirectory DEV$:[PROJDIR.V5_3.RMS.VDE$COM] has been createdC      Subdirectory DEV$:[PROJDIR.V5_3.RMS.VDE$LOG] has been createdG   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 createdC      Subdirectory DEV$:[PROJDIR.V5_3.SMG.VDE$COM] has been createdC      Subdirectory DEV$:[PROJDIR.V5_3.SMG.VDE$LOG] has been created+   All directories for stream V5.3now exist 3%VDE-I-STRMADDED, stream V5.3 added to the database>%VDE-I-COMMIT, database transaction has successfully committedVDEä      


HThis example creates a new stream called V5.3, representing version 5.3 @of the user software system. The log messages indicate that the Fdirectories for the new stream have been created, that the stream has Bbeen added to the database, and that the database transaction has successfully completed.


M

CREATE USER



<Creates a database record for a new user of the current VDE library.

+Requires CREUSR privilege.




Format

.

CREATE USER username [, username...]




Parameter



username

4The 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.



Description

FThe CREATE USER command creates the database record for a new user of the current VDE library.

5Each 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 Fprivileges, and remark string. After the record has been created, the 9user has access to the VDE library as constrained by the Cspecified privileges. A user who does not have a record in a given 0VDE database cannot use the VDE Utility to gain 4access to the database or the corresponding library.




Qualifiers

+

/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 Fprivilege. 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...])

FSpecifies the new user's default privileges, which are the privileges :enabled each time the user starts a new VDE session. Each Eparameter to this qualifier names a single privilege. Each privilege ?specified becomes an authorized privilege as well as a default Dprivilege, even if it has not been listed with the /AUTH_PRIVILEGES Fqualifier. 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

FControls whether log messages are printed after users have been added Fto the database. The /LOG qualifier causes the messages to be printed Gand /NOLOG suppresses them. The messages indicate that users have been Cadded and that the database transaction has successfully committed.

/NAME="string"

GSpecifies the full name of the new user. The quoted name string, which Ecan be up to 40 characters long, should contain the full name (first 6name, middle initials, and last name) of the new user.

EThis qualifier is required. You can specify an empty name string but Dthis 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 Cuser who should be notified by mail message each time the new user 7created by this command replaces a module into the VDE library.

GEach username parameter can specify the username of a 5user already recorded in the VDE database, a OpenVMS Gmail address with one or more node names (such as NODE::SMITH), a mail Hforwarding alias, or a defined logical name bound to a list of users to Enotify. If you specify a logical name, keep in mind that the logical @name must be defined when it is later used to send notification Hmessages. 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.

EIf you specify only one username parameter, you may !omit the surrounding parentheses.

/REMARK="string"

DSpecifies a remark string to be stored for the new user. The quoted Gremark string, which can be up to 132 characters long, may contain any Bexplanatory remark about the new user that you want stored in the 8VDE database. Typically the remark describes the user's 0affiliation or function within the organization.

DThis qualifier is required although you can specify an empty remark 9string. 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 Freview all changes created by the new user. The reviewer must already ;be recorded in the VDE database. When the new user created 8by this command replaces a module into the VDE library, <VDE notifies the reviewer of the change by mail message. If Fthe replacement is queued, the reviewer should then review the queued Ereplacement before it is performed. If the replacement is immediate, <VDE notifies the reviewer of the new module generation that Bwas created, and he or she may then inspect that generation. This Dqualifier can be used to set up "buddy systems" where two &users always review each other's code.

EIf you specify only one username parameter, you may !omit the surrounding parentheses.




Examples

 6    
#1

 
CVDEä CREATE USER SMITH NAME="Jane Smith"/REMARK="OpenVMS Developer"2%VDE-I-USERADDED, user SMITH added to the database>%VDE-I-COMMIT, database transaction has successfully committedVDEä      


AThis command creates a database record for user SMITH. The /NAME Equalifier specifies Jane Smith's full name and the /REMARK qualifier Eidentifies her job. The example shows the informational log messages ,that the /LOG qualifier produces by default.

 6    
#2

 
BVDEä CREATE USER DOE /NAME="John X. Doe"/REMARK="OpenVMS Writer" -4_VDEä       /AUTH_PRIVILEGES=(BUILD,CREGRP,CREMOD) -1_VDEä       /DEF_PRIVILEGES=(BUILD,CREFAC) /NOLOGVDEä      


CIn this example, user DOE is added to the database. In addition to Gspecifying the full name and a remark for John Doe, this command gives 9his authorized and default VDE privileges. Note that the =CREFAC privilege becomes an authorized privilege as well as aGdefault privilege even though it is not listed by the /AUTH_PRIVILEGES Aqualifier. In this case, the /NOLOG qualifier suppresses the log messages.

 6    
#3

 
-VDEä CREATE USER/REMARK="OpenVMS Developer" -'_VDEä       SMITH /NAME="Jane Smith", -%_VDEä       JONES /NAME="Frank Jones"2%VDE-I-USERADDED, user SMITH added to the database2%VDE-I-USERADDED, user JONES added to the database>%VDE-I-COMMIT, database transaction has successfully committedVDEä      


GThis example illustrates the creation of database records for multiple Gusers with a single CREATE USER command. This command adds users SMITH Gand JONES to the database. Both get the same remark string because the Hremark is specified immediately after the CREATE USER command. They get Dseparate full name strings and both get the standard authorized and *default privileges of the current library.


O

DEFINE/COMMAND



HDefines a command abbreviation by associating a symbol name with a list of one or more VDE commands.



Format

5

DEFINE/COMMAND symbol-name="command-string"




Parameters



symbol-name

BSpecifies the symbol name that you want associated with a list of :VDE commands. The symbol can be up to 255 characters long Cand can include letters, digits, underscores, and dollar signs. It Gcannot 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 Hsymbol name. The command string must be enclosed in quotation marks and 5consists of the first part of a VDE command, a whole 7command, or a list of commands separated by semicolons.



Description

;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.

7When the symbol name appears at the beginning of a VDE Gcommand, the symbol name is replaced by its associated command string. EThe resulting string is then parsed and executed as a normal command <line by VDE. DEFINE/COMMAND thus gives you the same command Habbreviation capability as the symbol assignment statement (symbol-name H:= command-string) in DCL. Symbol substitution only happens once at the Dbeginning of each command. A symbol's associated command string can 0therefore not begin with another command symbol.

ETo display the current symbol definitions created by DEFINE/COMMAND, use the SHOW SYMBOL command.




Qualifiers

None.



Examples

 6    
#1

 
&VDEä DEFINE/COMMAND SM = "SHOW MODULE"VDEä SM MOD1Module [FACIL]MOD1.MARVDEä      


>This DEFINE/COMMAND command associates the symbol SM with the <VDE command "SHOW MODULE". When the SM command is Gused, SM is expanded to the equivalent command string. The module name GMOD1 is then concatenated to that string to form the full command SHOW %MODULE MOD1, which VDE then executes.

 6    
#2

 
AVDEä DEFINE/COMMAND STRMFAC = "SET STREAM V5.3; SET FACILITY RMS"VDEä STRMFACVDEä SHOW DEFAULTS0Library LIBNAME in root directory DEV$:[PROJDIR]!Default directory is DEV$:[SMITH]Current session context:   Default stream is V5.3   Default facility is RMSVDEäVDEä      


AThis example shows that a symbol can be associated with multiple Ccommands. Here symbol STRMFAC is associated with both a SET STREAM ?command and a SET FACILITY command, where the two commands are Cseparated by a semicolon. When the STRMFAC command is entered, the Ecommand string is substituted for the symbol name and the SET STREAM Eand SET FACILITY commands are executed. The output from a subsequent DSHOW DEFAULTS command shows that the default stream and the default .facility have been set by the STRMFAC command.


K

DEFINE/KEY



9Defines a key to execute a VDE command. A key definition Elets you to enter a command by pressing a key rather than typing the Ccommand. The /KEY qualifier is required and must precede any other qualifiers.



Format

$

DEFINE/KEY key-name string




Parameters



key-name

rSpecifies the name of the key you are defining. Table 3-1 contains .a list of common keys on common keyboards.

T  # & ,                                                                                                  
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

DYou cannot redefine the arrow keys or function keys F1 through F14. 


string

ESpecifies the string that is entered when you press the defined key. =String can be any VDE command, such as SHOW FDEFAULTS or SET CONTEXT. To preserve spaces and lowercase characters, &enclose the string in quotation marks.



Description

DThe DEFINE/KEY command, on certain terminals, enables you to assign Gdefinitions to keys other than those on the main keyboard. The command Ecan be used on a variety of terminals including the VT340, VT510 and the DECterm terminal emulator.

EThe string parameter to the DEFINE/KEY command can contain different ;types of information and usually consists of an entire VDE Gcommand. For example, you can assign the SHOW DEFAULTS command to KP0. ;Then, when you press zero on the keypad, VDE displays your Hcurrent default settings. Other definitions can consist of text strings Hto be appended to command lines. When you define a key to insert a text Gstring, use the /NOTERMINATE qualifier so you can continue typing more (data after the string has been inserted.

CIn most instances you will want to use the echo feature. The /ECHO Hqualifier displays the key definition on the screen each time you press &the key. The default setting is /ECHO.

HYou can create as many definitions for a key as you want as long as you Hspecify a new context for each definition. This new context is called a Fstate. To create additional key definitions you must use two Dsteps. First, using the /SET_STATE qualifier, you must define a key Ethat establishes a state for the definition you want to create. Then Fyou must create the new definition for your key and specify its state using the /IF_STATE qualifier.

HState names can include letters, digits, dollar signs, and underscores. FCreate state names that are easy to remember and type and that remind Byou of the types of definitions you created. For example, you can Hcreate a state called SETSHOW. The key definitions for this state might +refer to various VDE SET and SHOW commands.

6Like various other utilities on OpenVMS, VDE supplies Ethree built-in states called DEFAULT, GOLD, and BLUE. You can assign Ddifferent definitions to keys used in combination with the GOLD and +BLUE keys by using the /IF_STATE qualifier.

GBy convention, the GOLD state is selected by pressing the PF1 key, and 2the BLUE state is seected by pressing the PF4 key.

GThe SET KEY command changes the keypad state. Use the SHOW KEY command &to display key definitions and states.




Qualifiers



/ECHO (default)



/NOECHO

ESpecifies whether the command line is displayed on your screen after Cyou press the defined key. You cannot define a key specifying both /NOECHO and /NOTERMINATE.#

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



/NOIF_STATE (default)

GSpecifies a list of states, any one of which must be set to enable the Especified key definition. (By including several state names, you can Hdefine a key to have the same function in all the specified states.) If Gyou use the /NOIF_STATE qualifier or omit the /IF_STATE qualifier, the Fcurrent state at the time you define the key must be set when you use Gthe key definition. The state name can include letters, digits, dollar Csigns, and underscores. States are established with the /SET_STATE Hqualifier 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)

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

/LOG (default)



/NOLOG

ESpecifies whether a log message is displayed after a key is defined. FThe message indicates a key definition has been created successfully. GThe /LOG qualifier causes such messages to be displayed and the /NOLOG qualifier suppresses them.

/SET_STATE=state



/NOSET_STATE (default)

BCauses the specified state to be set when the key is pressed. (By Gdefault, the current locked state is reset when the key is pressed.) A Gstate name can include letters, digits, dollar signs, and underscores. @If you omit or negate this qualifier, the current state remains Bunchanged. You cannot define a key specifying both /SET_STATE and /TERMINATE.

/TERMINATE



/NOTERMINATE (default)

HDetermines whether the specified command string executes when you press Ethe key. When you use /NOTERMINATE, you must press RETURN to execute :the command string. When you use /TERMINATE, VDE executes Bthe command string immediately when you press the key. You cannot 7define a key specifying both /SET_STATE and /TERMINATE.



Examples

 6    
#1

 
#VDEä DEFINE/KEY KP1 "SHOW DEFAULTS"      


;This example shows how to define the keypad key KP1 as the 6VDE command SHOW DEFAULTS. To enter the SHOW DEFAULTS .command, press KP1 followed by the RETURN key.

 6    
#2

 
3VDEä DEFINE/KEY KP6 "SET CONTEXT BUGFIX" /TERMINATE      


EThis example shows how to define the keypad key 6 as the SET CONTEXT GBUGFIX command. The /TERMINATE qualifier causes the SET CONTEXT BUGFIX Gcommand to execute when you press keypad key 6 without having to press RETURN.

 6    
#3

 
8VDEä DEFINE/KEY MINUS "SHOW DEFAULTS" /TERMINATE /NOECHO      


DThis example shows how to define the minus key on the keypad as the @SHOW DEFAULTS command. The /TERMINATE qualifier causes the SHOW FDEFAULTS command to execute when you press the minus key. The /NOECHO Fqualifier prevents the display of the command line on the screen. You ?see the output of the command, but not the command line itself.

 6    
#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"      


GThis example shows how to create two definitions for the KP7 key using Gthe /SET_STATE and /IF_STATE qualifiers. The first command defines KP7 Das the SHOW MODULE command and executes the command when the key is Hpressed. This is the default key definition for KP7. The second command Festablishes a new state for the key: when you press PF3, the state is Gset to TEXAS. The third command creates a new definition for KP7: when =you press KP7, VDE executes the SHOW FACILITY command if the Bstate has been set to TEXAS. You can thus execute the SHOW MODULE @command by pressing KP7 by itself, and you can execute the SHOW AFACILITY command by pressing the PF3 key followed by the KP7 key.

 6    
#5

 
-VDEä DEFINE/KEY PF3 "SET " /SET_STATE=ALTEREDAVDEä DEFINE/KEY KP7 "CONTEXT BUGFIX" /TERMINATE /IF_STATE=ALTEREDDVDEä DEFINE/KEY KP8 "CONTEXT FEATURE_1" /TERMINATE /IF_STATE=ALTERED9VDEä DEFINE/KEY KP9 "VERIFY" /TERMINATE /IF_STATE=ALTERED      





 q
PreviousX Next[ Contents] Index