RVDE7

VDE
VDE
Reference Manual



 q
Previous[ Contents] Index


L

VDE/WHEREIS



=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 Aunderlying VDE$LIBRARY_* logical names be translated directly by @command procedures, nor should software depend on the continued 5accessability of the underlying information.




Format



VDE/WHEREIS




Description

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

;VDE/WHEREIS returns configuration information via a set of GVDE$WHEREIS_info-item local symbols or process logical names. GWhether symbols or logical names are used is controlled by the /RETURN Cqualifier. The local symbols/process logicals currently defined by VDE/WHEREIS are described below: W                                                                                      
VDE$WHEREIS Symbols/Logical Names
 VDE$WHEREIS_MNEMONIC
  3 VDE shorthand name associated with a database
! VDE$WHEREIS_BACKUPS_CURRENT
  1 Location of the latest Rdb database backups
! VDE$WHEREIS_BACKUPS_ARCHIVE
  3 Location of the archival Rdb database backups
% VDE$WHEREIS_BACKUPS_AFTER_IMAGE
  7 Location of the Rdb database after-image journals
 VDE$WHEREIS_CMS
  H 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
  B 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
  7 Specification of the VDE statistics database file
 VDE$WHEREIS_STAGING
  6 Location (root) where VDE stages library changes
 VDE$WHEREIS_BUILD
  3 For future use/not fully implemented


2When invoking VDE/WHEREIS, you must specify a VDE Flibrary, either via the /LIBRARY qualifier with a library mnemonic or 9root, 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.

GThe /INDEX qualifier is used to identify a library by index, or by the <offset into the list of all available VDE libraries present Eon the system. The first library in the list has an index of 0. This Bqualifier 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 7database root directory, just as with the standard VDE command.

GThe /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

CControls whether informational messages are printed to display the Arequested 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 Hsite-specific library information should be returned to the caller. The @qualifier accepts the following two keyword parameters:

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




Examples

 6    
#1

 
5$ VDE/WHEREIS /LIBRARY=PROD$LIB /RETURN=LOGICAL_NAMESB$ 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.

 6    
#2

 
  

 

"
      +$ vde_lib_index = F$EDIT(p1,"UPCASE,TRIM") 5$ VDE/WHEREIS /INDEX='vde_lib_index' /RETURN=SYMBOLS *$ IF .NOT. $STATUS THEN GOTO BCKLIB$Abort ;$ DEFINE/PROCESS BCKLIB$DB_SOURCE   'vde$whereis_database' B$ 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 - 4     MLIB$BACKUP_AREA:'vde$whereis_backup_full'.RBF 





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

 6    
#3

 
 $ VDE/WHEREIS /LIBRARY=EVMS /LOG6VDE Ancillary Support for OpenVMS Alpha Version V1.5-06%VDE-I-WHEREIS, component VDE$WHEREIS_MNEMONIC is EVMSh%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUPS_CURRENT is DISK$VDERDBBKP:[VDE.MASTERPACK_BACKUPS.CURRENT]d%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUPS_ARCHIVE is DISK$VDERDBBKP:[VDE.MASTERPACK_BACKUPS.OLD]o%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUPS_AFTER_IMAGE is DISK$VDERDBBKP:[VDE.MASTERPACK_BACKUPS.DB_JOURNAL]1%VDE-I-WHEREIS, component VDE$WHEREIS_CMS is VMS$O%VDE-I-WHEREIS, component VDE$WHEREIS_DATABASE is DISK$VDEROOT:[VDE.VMS.DBROOT]R%VDE-I-WHEREIS, component VDE$WHEREIS_LABEL is OpenVMS Alpha Base Operating SystemP%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUP_INCR is VDE$DATABASE$EVMS_BCKP_INCRP%VDE-I-WHEREIS, component VDE$WHEREIS_BACKUP_FULL is VDE$DATABASE$EVMS_BCKP_FULLv%VDE-I-WHEREIS, component VDE$WHEREIS_STATISTICS is DISK$VDERDBBKP:[VDE.CHECKIN_STATISTICS]STATISTICS_DATABASE_V10.DATT%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.


D

VSC



>The VSC command is a command variant that by default provides =source control services for the OpenVMS VAX library. Use the 0VSC command to perform the following operations:7Use 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 3it automatically accesses the VDE database for the 1OpenVMS VAX library. Unlike VSC, the VDE command @does not automatically access the OpenVMS VAX library. (Further -information on the VDE command is available.)

3VSC includes extensive built-in HELP. At the VSCä, Etype "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 COpenVMS 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 3VDE libraries around. Therefore, at the VSC prompt ,(VSCä), you can enter any valid VDE command.

4To 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:

 

"
$ VSCVSCä




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

 

"
$ VSCVSC> SHOW FACILITY SYS'Facility SYS             "SYS Facility"	VSCä EXIT$




4You 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. 4With 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 Erun in a kept subprocess that is retained from one invocation of the 9VSC command to the next. Use of a kept subprocess allows 1VSC 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. 5/NOKEPT_PROCESS specifies that VSC not run in a kept subprocess.

EDo 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

 #    

 
$ VSCVSCä SHOW FACILITY BAD'Facility BAD             "BAD Facility"VSCä SHOW STREAM V5.41Stream V5.4            "V5.4 SSB release (AETNA)"	VSCä EXIT$      


:In this example the user enters the VSC command from DCL. 0VSC gives the user the VSCä prompt and the user Eenters 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"1Stream V5.4            "V5.4 SSB release (AETNA)"$      


>This example shows the same two VSC commands entered directly 5on 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.




E

Chapter 3
VDE Command Reference







B

@



!Executes a VDE command procedure.



Format



@ file-name




Parameter



file-name

>Indicates the name of the file from which VDE commands should Hbe 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 Fcommands. 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 8 Procedures

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



Examples

 6    
#1

 
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.

 6    
#2

 
VDEä @[MYDIR]MYFILE.TMP      


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


T

ACCEPT REPLACEMENT



<Marks a queued replacement as accepted in the VDE database. FYou 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

CThe name of a queued replacement to be marked as accepted. You can Haccept more than one replacement at a time by using wildcard characters Din the replacement name. The percent sign (%) in a name matches any Bsingle character in the position it occupies and the asterisk (*) Cmatches zero or more characters in the position it occupies. Those Fqueued replacements whose names match the wildcard pattern are marked as accepted.

"remark"

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



Description

BThe 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 Erecord that you have reviewed the code changes in a specified queued Breplacement 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 Gcommand. You must be a reviewer for a replacement in order to issue to 8ACCEPT REPLACEMENT and mark the replacement as accepted.

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

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




Qualifiers



/CONFIRM



/NOCONFIRM (default)

<Controls whether VDE asks you to confirm that you want each ;replacement accepted. The /CONFIRM qualifier causes VDE to Gprint a message for each replacement asking whether you want to accept Gthat replacement. If you answer YES (or Y), that replacement is marked Das accepted. If you answer NO (or N), the replacement status is not Hchanged. If you enter a replacement name with a wildcard specification, ;VDE asks you to confirm the acceptance of each replacement Hwhose 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 Dthat you can edit your comment file for each queued replacement. If Gsuch a comment file already exists (due to a previous ACCEPT or REJECT HREPLACEMENT command for the same replacement), the editor modifies that Dfile. Otherwise, the editor creates a new file in the replacement's Bstaging directory. Its file name is your OpenVMS username and its Ffile 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

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

/LOG (default)



/NOLOG

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

/REMARK="string"

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

/USERNAME=username

BSpecifies that the replacement be marked as accepted on behalf of Danother user. The username parameter specifies the AOpenVMS username of the other user. That user must be a reviewer Ffor the specified replacement. You must have the USERNAME privilege touse this qualifier.



Examples

 6    
#1

 
VDEä ACCEPT REPLACEMENT BROWN-3D%VDE-I-REPACCEPT, replacement BROWN-3 marked as accepted in database>%VDE-I-COMMIT, database transaction has successfully committedVDEä      


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

 6    
#2

 
6VDEä ACCEPT REPLACEMENT SMITH-1/INPUT=COMMENT_FILE.TXTD%VDE-I-REPACCEPT, replacement SMITH-1 marked as accepted in database>%VDE-I-COMMIT, database transaction has successfully committedVDEä      


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






 q
PreviousX Next[ Contents] Index