VDE
VDE
Reference Manual


Previous Contents Index


DELETE STREAM

Deletes one or more development streams from the current VDE library.

Requires DELSTRM privilege.


Format

DELETE STREAM stream-name [, stream-name...]


Parameter

stream-name

The name of a stream to be deleted from the current VDE library. You can delete more than one stream at a time by using wildcard characters. The percent sign (%) in a name matches any single character in the position it occupies and the asterisk (*) matches zero or more characters in the position it occupies. Those streams whose names match the wildcard pattern are deleted.

Description

The DELETE STREAM command deletes each specified development stream from the current VDE library. When a stream is deleted, all database information associated with the stream is deleted. The deleted database information includes the stream's group definitions, scripts, and build dependency graph. The stream is also removed from any stream successor chains it belongs to. The stream's disk directories remain unchanged, however; they are not deleted.

You can only delete a stream if the delete attribute is set for the stream. If this attribute is not set, you must set it with the MODIFY STREAM /DELETE command before you can delete the stream. Unless the library's allow-deletion attribute is set, the stream must also be closed before it can be deleted. (Use MODIFY STREAM /CLOSED to close a stream.)


Qualifiers

/CONFIRM

/NOCONFIRM (default)

Controls whether VDE asks you to confirm that you want each stream deleted. The /CONFIRM qualifier causes VDE to print a message for each stream asking whether you want that stream deleted. If you answer YES (or Y), that stream is deleted from the library. If you answer NO (or N), the stream is not deleted. If you enter a stream name with a wildcard specification, VDE asks you to confirm the deletion of each stream whose name matches the wildcard specification. The /NOCONFIRM qualifier causes VDE to delete the specified streams without asking for confirmation.

/LOG (default)

/NOLOG

Controls whether log messages are printed after each stream has been deleted. The /LOG qualifier causes such messages to be printed and the /NOLOG qualifier suppresses them. These messages indicate that the stream has been deleted from the library and that the database transaction has successfully committed.

/REMARK="string"

Specifies a remark string to be stored in the database for the deleted stream. The quoted remark string, which can be up to 132 characters long, may contain any explanatory remark that you want to store in the database.

Examples

#1

VDE„ DELETE STREAM V3.1-1
%VDE-I-STRMDEL, stream V3.1-1 deleted from the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

In this example, development stream V3.1-1 is deleted from the current VDE library. The log messages confirm that the stream was deleted and that the database transaction successfully completed.

#2

VDE„ DELETE STREAM V2.0-BL1, V2.0-BL2, V2.0-BL3
%VDE-I-STRMDEL, stream V2.0-BL1 deleted from the database
%VDE-I-STRMDEL, stream V2.0-BL2 deleted from the database
%VDE-I-STRMDEL, stream V2.0-BL3 deleted from the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This example shows how to specify a list of stream names to delete multiple streams from the library. The log messages list the deleted streams.


DELETE USER

Deletes user records from the database in the current VDE library. This command deletes the database record for each user whose OpenVMS username is listed as a parameter and denies that user access to the current VDE library.

Requires CREUSR privilege.


Format

DELETE USER username [, username...]


Parameter

username

The OpenVMS username of the VDE user whose record is deleted from the database of the current VDE library. You can delete more than one username at a time by using wildcard characters. The percent sign (%) in a username matches any single character in the position it occupies and the asterisk (*) matches zero or more characters in the position it occupies. Those users whose usernames match the wildcard pattern are deleted.

Description

The DELETE USER command disables access by, and disallows any command specification of, the specified user. It also cancels all review and notification entries for the specified user.

The command marks the specified user records in the database as deleted, though the user records are not physically deleted from the database. As a result of this behaviour, records in the VDE database can continue to refer to the user records marked as deleted. For example, the record for each module indicates who created the module, and the SHOW MODULE command shows the creator's username and full name string. That information is found in the creator's user record, even if the creator has since left the project and a DELETE USER command has marked the associated user record as deleted.

A user that lacks a matching user entry, or has a deleted user entry, will be unable to access the VDE utility1 Further, usernames that have been deleted will not be accepted on VDE commands. However, the username record does remain within the database, should manual recovery be required at a later date.

Lists of valid VDE users can also be automatically maintained using the VDE/READ_UAF command. VDE/READ_UAF compares the current list of users stored in the VDE database with those stored in the OpenVMS system authorization database (SYSUAF). The VDE/READ_UAF command is described in VDE/READ_UAF.

As an alternative to the DELETE USER command, one could clear all bits in the associated privilege mask, and/or one could use the MODIFY USER/USER command to rename the user. These steps prevent the user from performing operations on the VDE database, but these options preserve the ability to specify the username in VDE commands.


Qualifiers

/CONFIRM

/NOCONFIRM (default)

Controls whether VDE asks you to confirm that you want each user record deleted from the database. The /CONFIRM qualifier causes VDE to print a message for each user record giving the username and asking whether you want that record deleted. If you answer YES (or Y), that user record is deleted from the database. If you answer NO (or N), the user record is not deleted. If you enter a username with a wildcard specification, VDE asks you to confirm the deletion of each username that matches the wildcard specification. The /NOCONFIRM qualifier causes VDE to delete the specified users from the database without asking for confirmation.

/LOG (default)

/NOLOG

Controls whether log messages are printed after each user record has been deleted. These messages indicate that the user has been deleted from the database and that the database transaction has successfully committed. The /LOG qualifier causes such messages to be printed and the /NOLOG qualifier suppresses them.

/REMARK="string"

Specifies a remark string to be stored in the database for the deleted user record. The quoted remark string, which can be up to 132 characters long, may contain any explanatory remark that you want to store in the database.

Examples

#1

VDE„ DELETE USER SMITH
%VDE-I-USERDEL, user SMITH deleted from the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

In this example, the record for user SMITH is deleted from the database of the current VDE library. The log messages confirm that the user record was deleted and that the database transaction successfully completed.

#2

VDE„ DELETE USER SMITH, DOE, JONES
%VDE-I-USERDEL, user SMITH deleted from the database
%VDE-I-USERDEL, user DOE deleted from the database
%VDE-I-USERDEL, user JONES deleted from the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This example shows how to delete multiple users from the database. The log messages list the users who have been deleted.

#3

VDE„ DELETE USER/CONFIRM SMITH, DOE
Delete user SMITH ? [No]: Y
%VDE-I-USERDEL, user SMITH deleted from the database
Delete user DOE ? [No]: N
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This example illustrates the /CONFIRM qualifier. This qualifier causes VDE to ask the user whether each specified user record should be deleted from the database. For user SMITH, the answer is Y (for YES) and that user record is deleted from the database. For user DOE, the answer is N (for NO) and that user record is not deleted. Hence there is no log message for user DOE. The final log message indicates that the database transaction for the whole command has successfully committed.

#4

VDE„ DELETE USER %O*
%VDE-I-USERDEL, user DOE deleted from the database
%VDE-I-USERDEL, user JONES deleted from the database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

In this example, the username specification (%O*) contains wildcard characters. All usernames with an "O" in the second position match the specification. Hence users DOE and JONES are deleted from the database.

Note

1 This assumes that the VDE library option that allows automatic addition of new users upon first access is disabled.

DIFFERENCES

Displays the differences between any two module generations.

Format

DIFFERENCES gen-spec-1 [gen-spec-2]


Parameter

gen-spec-1

Specifies the first module generation to be compared. The generation specification consists of the following in order: An example of a generation specification is [RMS]MOD1.MAR;5.

If you omit the facility name, a module generation from the default facility is compared. If you omit the generation number, the most recent generation of the module in the specified (or default) stream is compared.

If you specify a zero or negative generation number, that number is relative to the most recent generation of the module in the stream specified by the /STREAM qualifier (or the default stream if that qualifier is omitted). For example, if the most recent generation is generation 5, then generation 0 is the same as generation 5 and generation --1 is the same as generation 4.

If you specify the /GENERATION qualifier, VDE compares the generation with the given CMS generation expression and ignores the generation number on the gen-spec-1 parameter.

gen-spec-2

Specifies the second module generation to be compared. This parameter can have the same form as the first parameter (gen-spec-1) to fully specify a VDE generation. If the facility, module, and type names are the same as for the first parameter, this second parameter can be abbreviated to just the generation number, optionally preceded by a semicolon. For example, ";5" or just "5" is enough to specify generation 5 of the module given by the gen-spec-1 parameter.

If the gen-spec-2 parameter is omitted, VDE compares the generation given by the gen-spec-1 parameter with the immediately preceding generation. You can also use the /GENERATION and /STREAM qualifiers to compare other generations of the same module.


Description

The DIFFERENCES command determines the differences between any two module generations in the VDE library. It fetches the two specified generations into a scratch directory and runs the DCL DIFFERENCES command in a subprocess to compare the texts of the two generations and to display the differences between them on your terminal.

The command fetches the specified generations into a scratch directory determined as follows. If logical name VDE$SCRATCH is defined, VDE fetches the files into the directory that this logical name is bound to. If this logical name is not defined, VDE fetches the files into a VDE-created subdirectory [.VDE$SCRATCH] under the current SYS$SCRATCH directory. (By default, SYS$SCRATCH is defined as your SYS$LOGIN login directory. This logical name can be redefined by a user to reference a user-created subdirectory; all scratch files can thus be corraled in a particular subdirectory.) VDE creates the [.VDE$SCRATCH] subdirectory if it does not already exist, and defines the logical name VDE$SCRATCH to reference it. VDE then spawns a subprocess to run the DCL DIFFERENCES command and display the differences. VDE deletes the fetched files at the end of the command unless you specify the /KEEP qualifier. The difference output goes to your terminal by default, but you can direct it to a file using the /OUTPUT qualifier.

Although the DIFFERENCES command can compute the differences between any two generations in the VDE library, it is almost always used to compare two generations of the same module. For this reason, you can reduce the second generation specification parameter so it consists of only a generation number. The following example compares generations 5 and 2 of module [FACIL]MOD.TYP for your default stream:


VDE„ DIFFERENCES [FACIL]MOD.TYP;5 ;2

You can also omit the second generation specification parameter entirely. In this case, the specified generation is compared to its immediate predecessor. The following command thus compares generation 5 with generation 4:


VDE„ DIFFERENCES [FACIL]MOD.TYP;5

When you omit the second parameter, you can use the /GENERATION qualifier to specify the CMS generation expressions of the two generations to compare. For example, the following command compares the generations with CMS generation expressions 10A2 and 11B1:


VDE„ DIFFERENCES [FACIL]MOD.TYP/GENERATION=(10A2,11B1)

You can also use the /STREAM qualifier to specify that the latest generations from two streams be compared. The following example illustrates this use of the /STREAM qualifier:


VDE„ DIFFERENCES [FACIL]MOD.TYP/STREAM=(V2.0,V2.2)
This example compares the latest generations of the given module in streams V2.0 and V2.2.

In addition to accepting certain VDE-specific qualifiers, the DIFFERENCES command accepts all qualifiers that the DCL DIFFERENCES command accepts. These qualifiers are simply passed through to the subprocess that runs the OpenVMS DIFFERENCES program.


Qualifiers

/GENERATION=gen-expr

Specifies that the module generation that has the CMS generation expression given by the gen-expr parameter be compared. If this qualifier is omitted, VDE uses the generation given by the generation number on the module-name parameter. If both this qualifier and the generation number are omitted, the command uses the latest generation of the module for the specified development stream.

/KEEP

Specifies that one or both of the fetched and compared module generations be retained in the scratch directory after the command completes. If this qualifier is omitted, the files containing those generations are deleted after the differences are computed. If you specify the /KEEP qualifier after the gen-spec-1 parameter, the file containing that generation is kept. Likewise, if you specify the /KEEP qualifier after the gen-spec-2 parameter, the file containing that generation is kept. If you specify the qualifier after the DIFFERENCES keyword or after both parameters, the files containing both generations are kept.

/STREAM=stream-name

Specifies that the generation to be compared should be taken from the development stream given by the stream-name parameter. If this qualifier is omitted, the generation is taken from your default stream unless you use the /GENERATION qualifier.

/CHANGE_BAR
/COMMENT_DELIMITER

/IGNORE
/MAXIMUM_DIFFERENCES

/MATCH
/MERGED

/MODE
/NUMBER

/NONUMBER
/OUTPUT

/PARALLEL
/SEPARATED

/SLP
/WIDTH /WINDOW

These qualifiers are passed through to the spawned DCL DIFFERENCES command without change. See the description of the DIFFERENCES command in the OpenVMS DCL Dictionary manual for a description of these qualifiers and their parameters.


Example


VDE„ DIFFERENCES [FACIL]A.B32
************
File DEVD$:[SMITH.VDE$SCRATCH]A.REQ;2
    9   !       declarations.  Here is an additional comment.
   10   !
******
File DEVD$:[SMITH.VDE$SCRATCH]A.REQ;1
    9   !       declarations.
   10   !
************
 
Number of difference sections found: 1
Number of difference records found: 1
 
DIFFERENCES /IGNORE=()/MERGED=1-
    DEVD$:[SMITH.VDE$SCRATCH]A.REQ;2-
    DEVD$:[SMITH.VDE$SCRATCH]A.REQ;1
VDE„
      

This example compares the default stream's two most recent generations of module [FACIL]A.B32 and displays their differences on the terminal.


EXIT

Ends the VDE session or ends execution of commands in a command procedure.

Format

EXIT


Parameters

None.

Description

When you enter the EXIT command at the terminal, you end the current VDE session. (Pressing Ctrl/Z also ends a VDE session.) When VDE executes an EXIT command in a command procedure, it returns control to the command stream that invoked the command procedure. That command stream may be the terminal or another command procedure.

Qualifiers

/KEPT_PROCESS

If you enter the EXIT/KEPT_PROCESS command at the terminal (not in a VDE command procedure) and the VDE utility is running in a kept subprocess, this qualifier causes VDE to terminate that subprocess before it returns you to DCL level. The advantage of terminating the kept subprocess is that it no longer consumes resources. The disadvantage is that your next VDE command will require more time to reactivate the VDE image and reconnect to the VDE database.

Examples

#1

VDE„ EXIT
$
      

This example shows how the EXIT command returns control to DCL.


EXTRACT SCRIPT

Extracts a VDE script from the VDE database and writes it to a file.

Format

EXTRACT SCRIPT file-spec


Parameter

file-spec

Specifies the OpenVMS file specification for the output file that will contains the text of the extracted script. If you omit the directory specification from the file-spec parameter, your current default directory is assumed. If you omit the file extension from the file-spec parameter, file extension VDESCRIPT is assumed.

Description

The EXTRACT SCRIPT command reads a specified VDE script from the VDE database and writes it to an ASCII text file. VDE only extracts the script of the specified type and segment number that belongs to the default development stream. You can use the EXTRACT SCRIPT command when you want to get a script into a file so that you can edit it and then reinsert it into the database with a subsequent CREATE SCRIPT command.

You must specify a script-type qualifier to select the script you want extracted. See the description of the CREATE SCRIPT command for an explanation of the format of scripts, the different types of scripts, and how scripts are selected using script-type qualifiers. You must also specify the script segment number unless the default value applies.

Keywords used within scripts are documented in Script Keywords, while script functions are in Script Functions, and script types are in Script Types. For other script-related commands, also see CREATE SCRIPT, DELETE SCRIPT, INVOKE SCRIPT, MODIFY SCRIPT, and SHOW SCRIPT.


Qualifiers

/BUILD

Specifies that the default stream's BUILD script be extracted.

/COMPILE=mod-name

Specifies that the default stream's COMPILE script with the specified mod-name specification be extracted.

/COPY=mod-name

Specifies that the default stream's COPY script with the specified mod-name specification be extracted.

/CREATE_FACILITY

Specifies that the script that VDE invokes when a new facility is created should be extracted.

/DELETE_GENERATION=mod-name

Specifies that the default stream's DELETE_GENERATION script with the specified mod-name specification be extracted.

/DIFFERENCES=mod-name

Specifies that the default stream's DIFFERENCES script with the specified mod-name specification be extracted.

/FETCH=mod-name

Specifies that the default stream's FETCH script with the specified mod-name specification be extracted.

/INSERT_GENERATION=mod-name

Specifies that the default stream's INSERT_GENERATION script with the specified mod-name specification be extracted.

/LINK=mod-name

Specifies that the default stream's LINK script with the specified mod-name specification be extracted.

/LOG (default)

/NOLOG

Controls whether log messages are printed after the script is extracted. The /LOG qualifier causes such messages to be printed and the /NOLOG qualifier suppresses them. These messages indicate that the script has been extracted and identify the output file.

/NEW_STREAM=fac-name

Specifies that the default stream's NEW_STREAM script with the specified fac-name specification be extracted.

/NOKEEP=mod-name

Specifies that the default stream's NOKEEP script with the specified mod-name specification be extracted.

/REPLACE=mod-name

Specifies that the default stream's REPLACE script with the specified mod-name specification be extracted.

/RESERVE=mod-name

Specifies that the default stream's RESERVE script with the specified mod-name specification be extracted.

/SEGMENT=seg-num

Specifies the segment number of the script to extract. The seg-num parameter specifies the integer segment number. If you omit this qualifier, VDE extracts the script with segment number 10.

/SET_FACILITY=fac-name

Specifies that the default stream's SET_FACILITY script with the specified fac-name specification be extracted.

/SET_STREAM

Specifies that the default stream's SET_STREAM script be extracted.

/STAGING=mod-name

Specifies that the default stream's STAGING script with the specified mod-name specification be extracted.

/UNRESERVE=mod-name

Specifies that the default stream's UNRESERVE script with the specified mod-name specification be extracted.

Examples

#1

VDE„ EXTRACT SCRIPT/COMPILE=[CODE]*.C [MYDIR]SCRIPT_C
%VDE-I-SCRPEXTR, script extracted to file DEV$:[MYDIR]SCRIPT_C.VDESCRIPT;1
 script to compile module [CODE]*.C (segment 10)
VDE„ EXIT
$ TYPE [MYDIR]SCRIPT_C.VDESCRIPT
! Script to compile a C module.
!
EMIT "$ SET VERIFY"
EMIT "$ DEFINE/NOLOG SRC$ ", $DIR(SRC)
EMIT "$ DEFINE/NOLOG OBJ$ ", $DIR(OBJ)
EMIT "$ CC/DEBUG/OBJ=OBJ$:/ANA=OBJ$: SRC$:",$MODTYP
EMIT "$ VDE/DEPEND C OBJ$:",$MOD,".ANA"
EXIT
$
      

This example extracts the script to compile C modules in facility CODE. VDE writes the script into file DEV$:[MYDIR]SCRIPT_C.VDESCRIPT. The subsequent TYPE command shows that the file contains the text of the script.


Previous Next Contents Index