RVDE7

VDE
VDE
Reference Manual



 q
Previous[ Contents] Index


P

SHOW STREAM



GDisplays the names and attributes of one or more specified development streams.



Format

6

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




Parameter



stream-name

HThe name of a development stream whose name and other attributes are to be displayed.

DYou can display more than one stream using wildcard characters. The Fpercent sign (%) in a stream name matches any single character in the ?position it occupies and the asterisk (*) matches zero or more Hcharacters in the position it occupies. Those streams whose names match #the wildcard pattern are displayed.

@If you do not specify a stream-name parameter, 0VDE displays all streams in the current library.




Description

@Depending on the qualifiers you select, the SHOW STREAM command Fdisplays the name of each selected stream, the name and remark string Eof each stream, or the name and all other attributes of each stream. CThe command can also show the total number of streams that match a stream name specification.



Qualifiers



/BRIEF



/NORMAL (default)



/FULL

BDetermines the information that is displayed for each stream. The C/BRIEF qualifier displays the name of each stream that matches the Dstream-name parameters. The /NORMAL qualifier displays the name and Hremark string of each stream. The /FULL qualifier displays the name and $all other attributes of each stream.

6Of /BRIEF, /NORMAL, and /FULL, /NORMAL is the default.

/DESCENDANTS

BDisplays all descendants of each specified stream. This qualifier Cdisplays the name of each stream created from the specified stream D(that is, whose parent is the specified stream), the descendants of Eeach such child stream, the descendants of those descendants, and so Eon. The display is indented so that all streams with the same parent 2are indented by the same amount under that parent.

/OPEN



/FROZEN



/CLOSED

FSpecifies that only streams with a certain status be displayed. /OPEN Hspecifies that open streams be displayed, /FROZEN specifies that frozen Dstreams be displayed, and /CLOSED specifies that permanently closed Hstreams be displayed. If you specify a combination of these qualifiers, Fall streams with one of the specified status values are displayed. If Gyou omit all three qualifiers, all streams are displayed regardless of status.

/OUTPUT=file-spec

DDirects the printed output of this command to a specified file. The Efile-spec parameter specifies the name of the file. =VDE creates a new file with that name, directs the command's Hprint output to that file, and prints nothing on your terminal. If this 9qualifier is omitted, all output appears on the terminal.

/QUEUE

GDislays the default batch queues to which build jobs for the specified Gstream are submitted. This information includes the name of each batch Gqueue used to run the build job, the process count for each queue, and *the total process count for the build job.

/SUCCESSOR

GDisplays all successor chains of each specified stream. This qualifier Cdisplays lists of streams separated by arrows (-->) to show how Csource changes are propagated from stream to stream by the REPLACE command.

/TOTAL

=Shows the total number of streams that match the stream-name Bparameters. Other information about the individual streams is not -shown. A separate count is provided for each Hstream-name parameter. Wildcard characters are usually Dused in the stream-name parameters when using this qualifier.



Examples

 6    
#1

 
VDEä SHOW STREAM5Stream BASE-LEVEL-3    "Base level 3 for version 2.1"2Stream V1.0            "Version 1.0 final release"7Stream V1.0-FT1        "Version 1 Field Test 1 release"7Stream V1.0-FT2        "Version 1 Field Test 2 release"7Stream V1.0-FT3        "Version 1 Field Test 3 release"8Stream V1.1            "Version 1.1 as finally released"2Stream V2.0            "Version 2.0 final release"5Stream V2.0-FT         "Version 2 Field Test release"VDEä      


GThis example illustrates the normal output of the SHOW STREAM command. 1VDE lists all streams in the current VDE library H(the default when no stream name parameter is present) and displays the 'name and remark string for each stream.

 6    
#2

 
VDEä SHOW STREAM/BRIEFStream BASE-LEVEL-3Stream V1.0Stream V1.0-FT1Stream V1.0-FT2Stream V1.0-FT3Stream V1.1Stream V2.0Stream V2.0-FTVDEä      


@This example shows the brief output of the SHOW STREAM command. /VDE shows the name of each stream, but no more.

 6    
#3

 
"VDEä SHOW STREAM/FULL BASE-LEVEL-3Stream BASE-LEVEL-3,   Stream created on  4-APR-1989 14:58:16.13,   Stream created by user SMITH (Jane Smith)   Parent stream is V2.0   Stream has no successors4   Stream is not part of the main development thread   Stream cannot be deleted)   CMS class is not maintained for stream(   Replacements are immediate for stream   Stream is open for checkins7   Default build-step delay interval:     0 00:00:03.227   Default build-job timeout interval:    0 00:45:05.00'   Remark: Base level 3 for version 2.1 VDEä      


>This example shows the full output of the SHOW STREAM command.

 6    
#4

 
VDEä SHOW STREAM/TOTAL V*%Number of streams matching name V*: 7VDEä      


HThe /TOTAL qualifier displays the number of streams that match the name Especification. In this case, the name specification (V*) matches all Fstreams whose names begin with the letter V. There are 7 such streams.

 6    
#5

 
1VDEä SHOW STREAM MAIN/DESCENDANTS/SUCCESSOR/QUEUE0Stream MAIN            "Main development stream"   Descendant streams:      MAIN (main)         V1.0 (main)            V1.0-1            V1.0-2            V1.0-3            V2.0 (main)               V2.1-1               V2.1-2-BL1            SUBDIR_TEST         HICKORY   Successor chains:       MAIN -> V1.0 -> V2.05   Default build-job batch queues to run 1 processes:;      Submit 1 processes (scaled from 1) on queue SYS$BATCH VDEä      


BThis example shows the output of the /DESCENDANT, /SUCCESSOR, and F/QUEUE qualifiers. The /DESCENDANTS qualifier shows the whole tree of Cdescendants created, directly or indirectly, from stream MAIN. The C/SUCCESSOR qualifier shows that the REPLACE command will propagate @changes from stream MAIN into streams V1.0 and V2.0. The /QUEUE Hqualifier shows that build jobs for stream MAIN will submit one process to queue SYS$BATCH by default.


P

SHOW SYMBOL



DDisplays all symbol definitions established with the DEFINE/COMMAND =command. Such symbols are used for VDE command abbreviations.



Format

!

SHOW SYMBOL symbol-name




Parameter



symbol-name

BSpecifies the name of the symbol to show. If symbol-name ?includes asterisks (*), each asterisk is treated as a wildcard Hcharacter that matches zero or more characters. All symbols whose names %match the wildcard pattern are shown.



Description

FThe DEFINE/COMMAND command allows you to create command abbreviations :in the VDE command language. The SHOW SYMBOL command lets )you see all the symbols you have defined.



Qualifiers

None.



Examples

 6    
#1

 
&VDEä DEFINE/COMMAND SM = "SHOW MODULE"VDEä SHOW SYMBOL SMDefined commands:  SM = "SHOW MODULE"VDEä      


>In this example, the DEFINE/COMMAND command creates a command Eabbreviation that binds the string "SHOW MODULE" to symbol HSM. The SHOW SYMBOL command then displays the command definition for SM.

 6    
#2

 
VDEä SHOW SYMBOL *Defined commands:4  SETSTRMFACIL = "SET STREAM MAIN; SET FACILITY RMS"  SM = "SHOW MODULE"VDEä      


EThe SHOW SYMBOL command contains a wildcard character for the symbol Gname. As a result, the command displays the definitions of all defined symbols.


P

SHOW TERMINAL



7Displays the line width and page size that VDE uses to Gformat terminal output. To change these settings, use the SET TERMINAL command.



Format



SHOW TERMINAL




Parameters

None.



Qualifiers

None.



Examples

 6    
#1

 
VDEä SHOW TERMINAL*Terminal page size: 50, Terminal width: 80VDEä      


:The SHOW TERMINAL command shows that VDE currently uses a Fpage size of 50 lines and a line width of 80 columns to format output to the terminal.


L

SHOW USER



@Displays the database records of specified users of the current VDE library.



Format

.

SHOW USER [username [, username...]]




Parameter



username

8The OpenVMS username of an existing user of the current /VDE library. VDE displays this user's database record.

HYou can display information for many users by using wildcard characters Gin the username. The percent sign (%) in a username matches any single Hcharacter in the position it occupies and the asterisk (*) matches zero =or more characters in the position it occupies. VDE displays <all user records whose usernames match the wildcard pattern.

FIf you do not specify a username parameter or the /CURRENT qualifier, .VDE displays all user records in the database.




Description

GDepending on the qualifiers you select, the SHOW USER command displays =the OpenVMS username, full name string, creator and creation Fdate of the user's database record, remark string, and authorized and Fdefault privileges for each specified user. The command also can show Dthe total number of users that match a given username specification.



Qualifiers



/BRIEF (default)



/FULL

EDetermines the type of information about the specified users that is Hdisplayed. The /BRIEF qualifier lists the username and full name string Gof each user. The /FULL qualifier displays the same information as the E/BRIEF qualifier and also the name of the creator of the user record Gand the date the record was created, the remark string, and the user's "authorized and default privileges.

/Of /BRIEF and /FULL, the former is the default.

/CURRENT

ADisplays the user record of the current user. Do not specify the >username parameter if you use this qualifier.

/OUTPUT=file-spec

DDirects the printed output of this command to a specified file. The Efile-spec parameter specifies the name of the file. =VDE creates a new file with that name, directs the command's Hprint output to that file, and prints nothing on your terminal. If this 9qualifier is omitted, all output appears on the terminal.

/TOTAL

DShows the total number of users that match the username parameters. DOther information about the users is not shown. A separate count is @provided for each username parameter. Wildcard Hcharacters are usually used in the username parameters when using this qualifier.



Examples

 6    
#1

 
VDEä SHOW USERUser DOE (John Doe)User DOLOMITE (Rock Dolomite)User JONES (Frank Jones)User SMITH (Jane Smith)VDEä      


EThis example illustrates the SHOW USER command without parameters or Hqualifiers. The command lists the usernames and full names of all users !recorded in the current database.

 6    
#2

 
VDEä SHOW USER SMITH, DO*User SMITH (Jane Smith)User DOE (John Doe)User DOLOMITE (Rock Dolomite)VDEä      


HIn this example, the SHOW USER command with username parameters gives a Fbrief listing for user SMITH and all users whose usernames begin with "DO".

 6    
#3

 
VDEä SHOW USER SMITH/FULLUser SMITH (Jane Smith)4   User added to database on 20-OCT-1988 17:56:23.830   User added to database by user DOE (John Doe)   Remark: OpenVMS Developer   Default privileges:      BUILD CREFAC CREMOD   Authorized privileges:       BUILD CREFAC CREMOD CREUSRVDEä      


GHere the /FULL qualifier lists all database information for user SMITH.

 6    
#4

 
VDEä SHOW USER/TOTAL D*#Number of users matching name D*: 2VDEä      


FThis example shows how the /TOTAL qualifier lists the number of users Bwhose usernames match a given name specification. In this case, a Fusername containing a wildcard character (D*) selects all users whose Husernames begin with "D." The output shows that there are two such users in the database.


P

SHOW VERIFY



EIndicates whether command input is verified (echoed) at the terminal Bbefore the input is executed. To enable verification, use the SET VERIFY command.



Format



SHOW VERIFY




Parameters

None.



Qualifiers

None.



Examples

 6    
#1

 
VDEä SHOW VERIFYNot verifying commandsVDEä      


DThe SHOW VERIFY command shows that command verification is disabled.


R

SHOW VERSION



3Displays the VDE version string for the version of VDE you are running.



Format



SHOW VERSION




Parameters

None.



Qualifiers

None.

%



Examples

 6    
#1

 
VDEä SHOW VERSION,Executing VDE for OpenVMS VAX Version V1.5-0VDEä      



%
:The SHOW VERSION command displays what version of VDE you are running.


D

SPAWN



@Creates a subprocess of the current process. The context of the Esubprocess is copied from the current process. You can use the SPAWN :command to leave VDE temporarily, perform other functions 4(such as reading your mail), and then return to VDE.



Format



SPAWN [command]




Parameter



command

>Specifies the DCL command string that executes in the created Fsubprocess. When the command completes, the subprocess terminates and Dcontrol is returned to the parent process. If this parameter is not Especified, a subprocess is created that transfers control to the DCL command level.



Qualifiers



/INPUT=filespec

FSpecifies an input file containing one or more DCL command strings to Gbe executed by the spawned subprocess. If you specify a command string Ealong with an input file, the command string is processed before the >commands in the input file. After processing is complete, the subprocess is terminated.!

/LOGICAL_NAMES (default)



/NOLOGICAL_NAMES

HSpecifies whether the logical names of the parent process are copied to Gthe subprocess. When you do not want the subprocess to use the logical 0names of the parent process, enter the qualifier/NOLOGICAL_NAMES.

/OUTPUT=filespec

GIdentifies the output file to which the results of the SPAWN operation Eare written. If you omit the /OUTPUT qualifier, output is written by 2default to the current SYS$OUTPUT device. Whenever?you use the /NOWAIT qualifier, you should also use the /OUTPUT Hqualifier to specify a new output destination. Doing so prevents output Afrom being displayed on your terminal while you are entering new VDE commands.!

/PROCESS=subprocess-name

>Specifies the name of the subprocess. The default name of the "subprocess is USERNAME_n.

/SYMBOLS (default)



/NOSYMBOLS

EDetermines whether the system passes DCL global and local symbols to (the subprocess. The default is /SYMBOLS.

/WAIT (default)



/NOWAIT

=Controls whether VDE waits until the subprocess is completed =before allowing more VDE commands to be entered. The /NOWAIT 9qualifier allows you to enter new VDE commands while the Dspecified subprocess is running. If you specify /NOWAIT, you should Ealso use the /OUTPUT qualifier to direct the output stream to a file Crather than to your terminal. Doing so prevents your terminal from 3being used by more than one process simultaneously.



Examples

 6    
#1

 
VDEä SPAWN$ SHOW TIME  24-MAR-1989 16:35:14$ LOGOUT7  Process JONES_1 logged out at 24-MAR-1989 16:35:17.37"%VDE-I-SPAWNED, subprocess spawned2%VDE-I-RETURNED, control returned to process JONESVDEä      


GThe SPAWN command without parameters creates a subprocess that prompts Hfor DCL command input. The user enters the SHOW TIME command at the DCL @prompt and the time is displayed. The user then logs out of the 5subprocess, which returns control to the VDE session.

 6    
#2

 
VDEä SPAWN SHOW TIME15-OCT-1988 15:34:07"%VDE-I-SPAWNED, subprocess spawned2%VDE-I-RETURNED, control returned to process JONESVDEä      


DThis example shows how to create a subprocess that executes the DCL =command SHOW TIME while you are using VDE. After the command =is completed, you are returned immediately to the VDE prompt.

 6    
#3

 
VDEäSPAWN MAILMAIL> READ/NEW   .   .   .
MAIL> EXIT"%VDE-I-SPAWNED, subprocess spawned2%VDE-I-RETURNED, control returned to process SMITHVDEä      


?This example shows how to create a subprocess that invokes the 4OpenVMS MAIL Utility while you are in VDE. When you >exit from the MAIL Utility, the subprocess disappears and the VDEä prompt returns.

 6    
#4

 
%VDEä SPAWN /OUTPUT=TIME.DAT SHOW TIME"%VDE-I-SPAWNED, subprocess spawned2%VDE-I-RETURNED, control returned to process SMITH	VDEä EXIT$ TYPE TIME.DAT15-OCT-1988 15:34:07$      


HThis example shows how to create a subprocess to invoke the DCL command ;SHOW TIME while you are using the VDE Utility. The /OUTPUT Aqualifier specifies that the results of the SHOW TIME command be !written to a file named TIME.DAT.

 6    
#5

 
$VDEä SPAWN /NOLOGICAL_NAMES SET HOST_Node: MARS   .   .   .$ LOGOUTCRAMMER logged out at ... ,%REM-S-END, control returned to node _BETA::"%VDE-I-SPAWNED, subprocess spawned2%VDE-I-RETURNED, control returned to process JONESVDEä      


GThis example shows how to use the SPAWN command to create a subprocess Hwhich uses the SET HOST command to log onto another node. To leave node CMARS and move back to node BETA, enter the DCL command LOGOUT. The D/NOLOGICAL_NAMES qualifier prevents the logical names of the parent process from being copied to the subprocess.


R

START BUILD_JOB



EStarts the execution of a build job by submitting build processes to OpenVMS batch queues.

*Requires BUILD privilege.




Format

:

START BUILD_JOB [stream-name [, stream-name...]]




Parameter



stream-name

DThe name of a development stream. The most recent build job in this stream is started.

GYou can start build jobs for more than one development stream by using Gwildcard characters in the stream name. The percent sign (%) in a name Amatches any single character in the position it occupies and the @asterisk (*) matches zero or more characters in the position it Eoccupies. Build jobs are started for those streams whose names match the wildcard pattern.

<If you omit the stream-name parameter, VDE 8starts the most recent build job for the default stream.




Description

GThe START BUILD_JOB command starts the most recently created build job Ein each stream that matches the specified stream names. (To create a "build job, use the BUILD command.)

FTo start a build job, the START BUILD_JOB command submits one or more Abatch jobs to the OpenVMS batch queues associated with the build Gjob. Then each batch job runs a program called VDE$BUILD that executes Hthe build steps belonging to the build job. The steps are executed in a Bloop until all the steps are done. The VDE$BUILD program does the following for each build step:

FBy running this program in many processes simultaneously for a single Abuild job, you can distribute the execution of your build across Hseveral processors (whether in a single machine or in multiple machines Fin a cluster). The /QUEUE qualifier specifies the batch queues to run Gthe build job. The /PROCESS_COUNT qualifier specifies the total number <of processes VDE submits to the batch queues performing the build job.

GIf you specify the /QUEUE and /PROCESS_COUNT qualifiers with the START HBUILD_JOB command, they override any previous specifications. If you do <not specify them with the START BUILD_JOB command, VDE uses Cthe queues and process count specified with the BUILD command that Hcreated the build job. If neither was specified with the BUILD command, =VDE uses the default queues and process count for the stream.

EYou cannot start a build job that is currently running. However, you Dcan suspend such a build job with the SUSPEND BUILD_JOB command and Hthen restart it using the START BUILD_JOB command. (This is useful, for Hexample, if you want to change the batch queues running the build job.) HAlso, you cannot start a build job that has already completed execution.




Qualifiers



/AFTER=date-time

GIndicates that the build job begins execution after the specified date ;and time. The date and time are stated in standard OpenVMS Fdate-time syntax. This qualifier specifies the start time for each of *the batch jobs that execute the build job.

/CONFIRM



/NOCONFIRM (default)

<Controls whether VDE asks you to confirm that you want each 8build job started. The /CONFIRM qualifier causes VDE to Fprint a message for each build job asking whether you want that build Hjob started. If you answer YES (or Y), the build job is started. If you ?answer NO (or N), the build job is not started. The /NOCONFIRM 7qualifier causes VDE to start the specified build jobs without asking for confirmation.

/LOG (default)



/NOLOG

CControls whether log messages are printed after each build job has Gstarted. The /LOG qualifier causes such messages to be printed and the C/NOLOG qualifier suppresses them. These messages indicate that the Gbuild job has started and shows how many processes have been submitted 2to each batch queue associated with the build job."

/PROCESS_COUNT=proc-count

BSpecifies the total number of processes to execute the build job. :VDE creates the processes by submitting batch jobs to the Fqueues specified by the /QUEUE qualifier or to the default queues for =the default stream. The number of processes that VDE creates :(that is, the number of OpenVMS batch jobs it submits) is ?specified with the proc-count parameter. This Dparameter thus specifies the degree of parallelism you want for the build job.-

/QUEUE=(queue-name [,queue-name...])

=Specifies the OpenVMS batch queues to which the build job is Dsubmitted. Each queue-name parameter specifies one Fbatch queue. The queue-name parameter may optionally Hbe followed by a process count in parentheses. This count specifies the Fnumber of processes started on the queue that runs the build job. For Gexample, SYS$BATCH(3) causes three build-job processes to be submitted Dto queue SYS$BATCH. If the process count is omitted, one process is submitted to the queue.

CIf you only specify one queue-name parameter, the parentheses may be omitted.




 q
PreviousX Next[ Contents] Index