Invokes a utility that retrieves site-specific configuration information from VDE.

No direct access nor direct retrieval of any underlying configuration information should be performed, nor should the underlying VDE$LIBRARY_* logical names be translated directly by command procedures, nor should software depend on the continued accessability of the underlying information.

Format

VDE/WHEREIS

Description

The VDE/WHEREIS command invokes a separate utility that retrieves site-specific configuration information associated with a VDE library. The command returns such information as the VDE mnemonic name and location of the Rdb database and CMS libraries associated with the VDE library. VDE/WHEREIS can be used from the command line or within DCL scripts to facilitate library management operations independent of specific configuration information.

VDE/WHEREIS returns configuration information via a set of VDE$WHEREIS_info-item local symbols or process logical names. Whether symbols or logical names are used is controlled by the /RETURN qualifier. The local symbols/process logicals currently defined by VDE/WHEREIS are described below:

VDE$WHEREIS Symbols/Logical Names
VDE$WHEREIS_MNEMONIC
	VDE shorthand name associated with a database
VDE$WHEREIS_BACKUPS_CURRENT
	Location of the latest Rdb database backups
VDE$WHEREIS_BACKUPS_ARCHIVE
	Location of the archival Rdb database backups
VDE$WHEREIS_BACKUPS_AFTER_IMAGE
	Location of the Rdb database after-image journals
VDE$WHEREIS_CMS
	Root specification of the CMS libraries associated with a database
VDE$WHEREIS_DATABASE
	Location (root) of the Rdb database file
VDE$WHEREIS_LABEL
	VDE text label (remark string) associated with a database
VDE$WHEREIS_BACKUP_INCR
	File name of current Rdb database incremental backup saveset
VDE$WHEREIS_BACKUP_FULL
	File name of current Rdb database full backup saveset
VDE$WHEREIS_STATISTICS
	Specification of the VDE statistics database file
VDE$WHEREIS_STAGING
	Location (root) where VDE stages library changes
VDE$WHEREIS_BUILD
	For future use/not fully implemented

When invoking VDE/WHEREIS, you must specify a VDE library, either via the /LIBRARY qualifier with a library mnemonic or root, or via the /INDEX qualifier with the library index.

Qualifiers

/INDEX=library-index

/LIBRARY=library-spec

The /INDEX and /LIBRARY qualifiers to VDE/WHEREIS are used to identify a VDE library for which the utility should return configuration information.

The /INDEX qualifier is used to identify a library by index, or by the offset into the list of all available VDE libraries present on the system. The first library in the list has an index of 0. This qualifier can be used to obtain configuration information for all VDE libraries on a given system, by starting with index 0 and incrementing the index until VDE/WHEREIS completes with a failure status.

The /LIBRARY qualifier to VDE/WHEREIS is used to identify a VDE library via either the shorthand mnemonic name or the database root directory, just as with the standard VDE command.

The /INDEX and /LIBRARY qualifiers are mutually exclusive. If both are specifed, the /INDEX qualifier is used. One of either /INDEX or /LIBRARY is required with the VDE/WHEREIS command.

/LOG

Controls whether informational messages are printed to display the requested library information as it is retrieved. By default, no messages are printed.

/RETURN=keyword

The /RETURN qualifier is used to specify the method in which site-specific library information should be returned to the caller. The qualifier accepts the following two keyword parameters:

• SYMBOLS - the requested information is returned via the local symbols VDE$WHEREIS_info-item. This is the default behavior.
• LOGICAL_NAMES - the requested information is returned via the process logical names VDE$WHEREIS_info-item.

If no /RETURN qualifier is specified with the VDE/WHEREIS command, /RETURN=SYMBOLS is assumed.

Examples

$ VDE/WHEREIS /LIBRARY=PROD$LIB /RETURN=LOGICAL_NAMES
$ DIRECTORY/DATE/SINCE=10-OCT-1996 VDE$WHEREIS_CMS:[*.CMS.CMS$000]
Directory VMS$:[PROD$SHR.CMS.CMS$000]
PROD$SHR.OPT;29      10-OCT-1996 16:45:01.74
PRODDEF.H;15         15-OCT-1996 15:12:01.21
PRODIO.C;24          14-OCT-1996 22:39:24.73
PRODUTIL.C;5         16-OCT-1996 16:31:00.79
   .
   .
   .
      

This example shows how VDE/WHEREIS can be used to retrieve information about a VDE library's CMS-level source files, without necessarily knowing the location of the CMS library.

 
 



  

    

      

      
 
  
 
  
$ vde_lib_index = F$EDIT(p1,"UPCASE,TRIM") 
$ VDE/WHEREIS /INDEX='vde_lib_index' /RETURN=SYMBOLS 
$ IF .NOT. $STATUS THEN GOTO BCKLIB$Abort 
$ DEFINE/PROCESS BCKLIB$DB_SOURCE   'vde$whereis_database' 
$ DEFINE/PROCESS BCKLIB$BACKUP_AREA 'vde$whereis_backups_current' 
$ WRITE SYS$OUTPUT " Performing full database backup for:" 
$ WRITE SYS$OUTPUT "    ''vde$whereis_mnemonic' library .." 
$ RMU /BACKUP /LOG /ONLINE BCKLIB$DB_SOURCE:VDE$DATABASE.RDB - 
     MLIB$BACKUP_AREA:'vde$whereis_backup_full'.RBF 




      

This example shows how VDE/WHEREIS can be used within a DCL command procedure to perform a full backup of the Rdb database associated with a VDE library, independent of the specific library or the database location.

$ VDE/WHEREIS /LIBRARY=EVMS /LOG
VDE Ancillary Support for OpenVMS Alpha Version V1.5-0
%VDE-I-WHEREIS, component VDE$WHEREIS_MNEMONIC is EVMS
%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUPS_CURRENT is DISK$VDERDBBKP:[VDE.MASTERPACK_BACKUPS.CURRENT]
%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUPS_ARCHIVE is DISK$VDERDBBKP:[VDE.MASTERPACK_BACKUPS.OLD]
%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUPS_AFTER_IMAGE is DISK$VDERDBBKP:[VDE.MASTERPACK_BACKUPS.DB_JOURNAL]
%VDE-I-WHEREIS, component VDE$WHEREIS_CMS is VMS$
%VDE-I-WHEREIS, component VDE$WHEREIS_DATABASE is DISK$VDEROOT:[VDE.VMS.DBROOT]
%VDE-I-WHEREIS, component VDE$WHEREIS_LABEL is OpenVMS Alpha Base Operating System
%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUP_INCR is VDE$DATABASE$EVMS_BCKP_INCR
%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUP_FULL is VDE$DATABASE$EVMS_BCKP_FULL
%VDE-I-WHEREIS, component VDE$WHEREIS_STATISTICS is DISK$VDERDBBKP:[VDE.CHECKIN_STATISTICS]STATISTICS_DATABASE_V10.DAT
%VDE-I-WHEREIS, component VDE$WHEREIS_STAGING is DISK$VDESTAGE:[VDE.VMS.VDE$STAGING]
      

This example shows how the /LOG qualifier to the VDE/WHEREIS command can be used to display current site-specific library information.

The VSC command is a command variant that by default provides source control services for the OpenVMS VAX library. Use the VSC command to perform the following operations:

• Reserve source modules from the OpenVMS VAX library for modification
• Replace source modules to the OpenVMS VAX library after they have been modified
• Review source modules modified by other developers
• Create new modules, facilities, and development streams in the OpenVMS VAX library
• Administer the OpenVMS VAX library and control its use
• Display information about the OpenVMS sources in the OpenVMS VAX library

Use the VSC HELP command for additional information on specific VSC commands.

The VSC command runs the OpenVMS Development Environment (VDE) utility and accepts the same commands as the VDE command, but it automatically accesses the VDE database for the OpenVMS VAX library. Unlike VSC, the VDE command does not automatically access the OpenVMS VAX library. (Further information on the VDE command is available.)

VSC includes extensive built-in HELP. At the VSC„, type "HELP". An extensive documentation set, in Bookreader and Postscript formats, is also available.

Format

VSC [VDE-command] [;VDE-command]

Description

The VSC command performs source control operations for the OpenVMS VAX source code control library. It runs the same image as the VDE command and differs only in that it automatically operates on the OpenVMS VAX library, and not any of the other VDE libraries around. Therefore, at the VSC prompt (VSC„), you can enter any valid VDE command.

To invoke the VSC utility, enter the VSC command at the DCL prompt ($). The system responds with the prompt for the VSC utility (VSC„). For example:

$ VSC VSC„

At the VSC„ prompt, you can enter VSC commands to perform VSC functions. To exit from VSC, enter the EXIT command or press CTRL/Z. The following example shows how to enter VSC commands from within the utility at the VSC„ prompt:

$ VSC VSC> SHOW FACILITY SYS Facility SYS "SYS Facility" VSC„ EXIT $

You can also enter VSC commands directly on the VSC command line. The following example shows how to enter the same VSC command from the DCL command line:

$ VSC SHOW FACILITY SYS Facility SYS "SYS Facility" $

Qualifier

/INTERFACE=keyword

The /INTERFACE qualifier allows the user to select a keyword representing the prefered user interface presented by VSC. With the VSC/INTERFACE=DECWINDOWS keyword, the Motif graphical user interface is used. With the VSC/INTERFACE=CHARACTER_CELL keyword, the traditional command interface is used.

/KEPT_PROCESS (default)

/NOKEPT_PROCESS

Specifies whether VSC runs with or without creating a kept process. /KEPT_PROCESS specifies that the VSC utility should run in a kept subprocess that is retained from one invocation of the VSC command to the next. Use of a kept subprocess allows VSC to connect to the VSC database once for many invocations of VSC, thus speeding up subsequent accesses to the database. It also allows VSC to retain state information, such as the default stream and facility, between invocations. /NOKEPT_PROCESS specifies that VSC not run in a kept subprocess.

Do not attempt to use the DCL ATTACH command to attach to a VDE or VSC kept process.

/LIBRARY=directory-spec

Specifies the mnemonic name or root directory of an alternate VDE library (other than the OpenVMS VAX library) with which you want to work. Subsequent VSC operations will access the database associated with that library.

Example

$ VSC
VSC„ SHOW FACILITY BAD
Facility BAD             "BAD Facility"
VSC„ SHOW STREAM V5.4
Stream V5.4            "V5.4 SSB release (AETNA)"
VSC„ EXIT
$
      

In this example the user enters the VSC command from DCL. VSC gives the user the VSC„ prompt and the user enters two commands, SHOW FACILITY and SHOW STREAM. The EXIT command ends the VSC session and returns the user to the DCL prompt ($). The VSC kept subprocess remains and will be reentered by each subsequent VSC command.

$ VSC SHOW FACILITY BAD; SHOW STREAM V5.4
Facility BAD             "BAD Facility"
Stream V5.4            "V5.4 SSB release (AETNA)"
$
      

This example shows the same two VSC commands entered directly on the DCL-level VSC command line. Both commands are executed, after which VSC exits and returns to the DCL prompt ($). In this case, VSC does not prompt for commands. Again, the kept subprocess remains.

Executes a VDE command procedure.

Format

@ file-name

Parameter

file-name

Indicates the name of the file from which VDE commands should be read. If no file extension is specified, the file type is assumed to be .VDE.

Description

A command procedure is a file containing a sequence of VDE commands. When the command procedure is executed, the commands in the file are processed in order as if each command had been entered individually from the terminal or workstation.

DCL Command Procedures If invoking VDE commands from within a DCL command procedure, do not use a VDE kept subprocess.

Examples

VDE„ @INFILE
      

This example shows how to execute the VDE commands in the file INFILE.VDE in your default directory. As there was no file extension explicitly specified in the example command, VDE defaults the file extension to .VDE.

VDE„ @[MYDIR]MYFILE.TMP
      

This example shows how to execute the VDE commands in file MYFILE.TMP in directory [MYDIR].

Marks a queued replacement as accepted in the VDE database. You can only mark a replacement as accepted if you are a reviewer for that replacement.

Requires RESREP privilege.

Format

ACCEPT REPLACEMENT rep-name [, rep-name...] ["remark"]

Parameter

rep-name

The name of a queued replacement to be marked as accepted. You can accept more than one replacement at a time by using wildcard characters in the replacement name. 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 queued replacements whose names match the wildcard pattern are marked as accepted.

"remark"

Specifies a one-line remark for the replacement. Typically this remark summarizes why the replacement is acceptable. Specifying the remark parameter is equivalent to specifying the /REMARK qualifier after the ACCEPT REPLACEMENT keywords.

Description

The ACCEPT REPLACEMENT command is used during the (optional) code review process supported by VDE, and is the negation of the REJECT REPLACEMENT command.

The ACCEPT REPLACEMENT command updates the VDE database to record that you have reviewed the code changes in a specified queued replacement and that you judge those changes to be acceptable for replacement into the VDE library---the replacement into the VDE library is performed with a subsequent PERFORM REPLACMENT command. You must be a reviewer for a replacement in order to issue to ACCEPT REPLACEMENT and mark the replacement as accepted.

The ACCEPT REPLACEMENT command allows you to attach a comment file to the queued replacement. This file gives your comments to the author of the replacement and to the other reviewers. If you have already created such a file, use the /INPUT qualifier to copy it to the replacement's staging area. If you want to create such a file, use the /EDIT qualifier. This qualifier causes VDE to invoke your preferred editor to create a comment file for the replacement. If you have already created a comment file for the replacement with an earlier ACCEPT or REJECT command, the /EDIT qualifier lets you edit that file again. This capability is useful if you change your mind or want to add more information.

If you wish to mark a replacement as not acceptable, use the REJECT REPLACEMENT command. If you wish to see the review status of a queued replacement, see the documentation on the SHOW REPLACEMENT command in SHOW REPLACEMENT.

Qualifiers

/CONFIRM

/NOCONFIRM (default)

Controls whether VDE asks you to confirm that you want each replacement accepted. The /CONFIRM qualifier causes VDE to print a message for each replacement asking whether you want to accept that replacement. If you answer YES (or Y), that replacement is marked as accepted. If you answer NO (or N), the replacement status is not changed. If you enter a replacement name with a wildcard specification, VDE asks you to confirm the acceptance of each replacement whose name matches the wildcard specification. The /NOCONFIRM qualifier causes VDE to mark the specified replacements as accepted without asking for confirmation.

/EDIT

Specifies that VDE should invoke your preferred editor so that you can edit your comment file for each queued replacement. If such a comment file already exists (due to a previous ACCEPT or REJECT REPLACEMENT command for the same replacement), the editor modifies that file. Otherwise, the editor creates a new file in the replacement's staging directory. Its file name is your OpenVMS username and its file type is VDE$COMMENT. The comment file typically contains comments for the author of the replacement and the other reviewers.

This qualifier is ignored if you are running in batch mode.

/INPUT=file-spec

Specifies a comment file for the queued replacement. VDE reads the text file given by the file-spec parameter and writes its contents into a new file in the replacement's staging directory. The file name of the new file is your OpenVMS username and its file extension is VDE$COMMENT. The comment file typically contains remarks to the author of the replacement or information for the other reviewers.

/LOG (default)

/NOLOG

Controls whether log messages are printed after each replacement has been marked as accepted. The /LOG qualifier causes such messages to be printed and the /NOLOG qualifier suppresses them. These messages indicate that the replacement has been accepted and that the database transaction has successfully committed.

/REMARK="string"

Specifies a one-line remark for the replacement. Typically this remark summarizes why the replacement is acceptable. For longer comments, you may create a comment file with the /INPUT or /EDIT qualifier.

/USERNAME=username

Specifies that the replacement be marked as accepted on behalf of another user. The username parameter specifies the OpenVMS username of the other user. That user must be a reviewer for the specified replacement. You must have the USERNAME privilege to use this qualifier.

Examples

VDE„ ACCEPT REPLACEMENT BROWN-3
%VDE-I-REPACCEPT, replacement BROWN-3 marked as accepted in database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

This example marks that the current user finds queued replacement BROWN--3 acceptable to be replaced into the VDE library.

VDE„ ACCEPT REPLACEMENT SMITH-1/INPUT=COMMENT_FILE.TXT
%VDE-I-REPACCEPT, replacement SMITH-1 marked as accepted in database
%VDE-I-COMMIT, database transaction has successfully committed
VDE„
      

In this example, the user marks replacement SMITH--1 as accepted and provides a comment file that gives additional information to the user who queued the replacement.