VDE

VDE
Reference Manual

Order Number: ??--?????--??

December 1997

This is a reference for the OpenVMS Development Environment (VDE) source code control and source code builder package. This reference provides details of the OpenVMS Development Environment and the OpenVMS Source Control utilities; these utilities are used within various Digital engineering organizations including the OpenVMS group.

Revision/Update Information: This manual supersedes the VDE Reference Manual, Version 1.5-0.

Software Version: VDE Version 1.5-0

Operating System Version: OpenVMS Alpha Version 6.2 OpenVMS VAX Version 6.2

Digital Equipment Corporation Maynard, Massachusetts

11-DEC-1998 17:50:16.05

Copyright ©11-DEC-1998 17:50:16.05

The following are trademarks of Digital Equipment Corporation: Bookreader, DEC Notes, DECdirect, Digital, OpenVMS, OpenVMS Cluster, VAX, VAX Document, VMScluster, VMS, and the DIGITAL logo.

The following are third-party trademarks:

Motif, OSF, OSF/1, OSF/Motif, and Open Software Foundation are registered trademarks of the Open Software Foundation, Inc.

All other trademarks and registered trademarks are the property of their respective holders.

Contents Index

Preface

Intended Audience

This manual is intended for users who want to know how to use the OpenVMS Development Environment.

Document Structure

This document contains a reference description of the OpenVMS Development Environment (VDE) source code control and source code build environment. It provides users with reference information related to module reservations and replacements, replacement reviews, library creation and various library maintenance operations.

This manual contains the following information:

Chapter 1 provides a full description of the VDE Utility.
Chapter 2 outlines the following VDE information:
- Invoking the utility
- Exiting from the utility
- Directing output
- Restrictions and VDE privileges required
Chapter 3 contains the command reference for VDE commands. This section includes the command format, command qualifiers and parameters, and examples.
Appendix B contains information useful for working directly with the VDE dependency recording callable interface.
Appendix C contains information useful for working with the unsupported VDE calling interface.
Appendix E includes a list of error messages that can be displayed by VDE.

Associated Documents

Guide to Using VDE
VDE Installation and New Features Guide

Conventions

In this manual, every use of OpenVMS Alpha means the OpenVMS Alpha operating system, every use of OpenVMS VAX means the OpenVMS VAX operating system, and every use of OpenVMS means both the OpenVMS Alpha operating system and the OpenVMS VAX operating system.

The following conventions are used in this manual:

Ctrl/ x A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.

PF1 x A sequence such as PF1 x indicates that you must first press and release the key labeled PF1, then press and release another key or a pointing device button.

GOLD x A sequence such as GOLD x indicates that you must first press and release the key defined GOLD, then press and release another key. GOLD key sequences can also have a slash (/), dash (-), or underscore (_) as a delimiter in EVE commands.

[Return] In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.)

... A horizontal ellipsis in examples indicates one of the following possibilities:

Additional optional arguments in a statement have been omitted.
The preceding item or items can be repeated one or more times.
Additional parameters, values, or other information can be entered.

.
.
. A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.

( ) In format descriptions, parentheses indicate that, if you choose more than one option, you must enclose the choices in parentheses.

[ ] In format descriptions, brackets indicate optional elements. You can choose one, none, or all of the options. (Brackets are not optional, however, in the syntax of a directory name in an OpenVMS file specification, or in the syntax of a substring specification in an assignment statement.)

{ } In format descriptions, braces surround a required choice of options; you must choose one of the options listed.

boldface text Boldface text represents the introduction of a new term or the name of an argument, an attribute, or a reason.
Boldface text is also used to show user input in Bookreader versions of the manual.

italic text Italic text emphasizes important information, indicates variables, and indicates complete titles of manuals. Italic text also represents information that can vary in system messages (for example, Internal error number), command lines (for example, /PRODUCER= name), and command parameters in text.

UPPERCASE TEXT Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege.

- A hyphen in code examples indicates that additional arguments to the request are provided on the line that follows.

numbers All numbers in text are assumed to be decimal, unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.

mouse The term mouse refers to any pointing device, such as a mouse, a puck, or a stylus.

MB1, MB2, MB3 MB1 indicates the left mouse button, MB2 indicates the middle mouse button, and MB3 indicates the right mouse button. (The buttons can be redefined by the user.)

PB1, PB2, PB3, PB4 PB1, PB2, PB3, and PB4 indicate buttons on the puck.

SB, SB SB and SB indicate buttons on the stylus.

Chapter 1
Introduction to VDE

The OpenVMS Development Environment (VDE) utilities assist OpenVMS engineers in managing the software development process.

This is the VDE reference manual. For a complete introduction, overview of the VDE package, and for information on commonly performed VDE tasks, please see the Guide to Using VDE.

VDE commands enable OpenVMS engineers to perform the following tasks:

Create, modify, display, and delete information in a VDE database such as that used by OpenVMS. This information includes the users, facilities, modules, development streams, groups, and other entities that define the software system that you want to manage and build.
Define, set, and show current context and default settings.
Build a software system. VDE can perform both complete and minimal system builds. In a complete build, all modules in the software system are compiled, linked, and otherwise processed. In a minimal system build, only those modules that have been changed since the last system build are compiled, linked, and processed.
Reserve source modules from the VDE library and replace them after they have been modified.
Collect and report software development statistics.
Transfer control to another process while still in VDE. Users typically interact with the VDE package using either the VDE or the VSC DCL commands. Both commands have equivilent capabilities, though the VSC defaults are specifically tailored to the requirements of OpenVMS engineering.

VDE is implemented as a set of images, and several DCL commands.

1.1 Using VDE

This section describes how to enter commands from within the utility or from the DCL command line. It also describes how to use the VDE help facility.

1.1.1 Entering VDE and VSC Commands

You can enter VDE commands in either of two ways: by invoking the utility and allowing it to prompt for input, or by including the command directly on the DCL command line.

There are two VDE interfaces supported within the VDE package: the VDE interface, and the VSC interface. Both interfaces support the same command verbs, and both function similarly.

The only salient differences between the two interfaces involves differences in the invocation defaults and the prompt string: VDE is a general interface and does not default to a particular source code library, while VSC is specifically tailored for users accessing the OpenVMS source code libraries and sets its library default appropriately.

Save for the default options and cosmetic aspects such as the command prompt string, the VDE and VSC interfaces are fully compatible and are fully interchangeable.

Note that certain qualifiers present on the VDE utility---such as VDE/READ_UAF and VDE/STATUS---may invoke utilities other than the VDE utility. There may be no VSC equivilents to some of these VDE utilities.

1.1.1.1 Invoking VDE

To invoke the VDE utility, enter the VDE or the VSC command at the OpenVMS DCL prompt ($). OpenVMS responds with the appropriate prompt for the utility.

$ VDE VDE> EXIT $ VSC VSC> EXIT $

Once the command has been invoked, you then can enter commands at the VDE prompt. For example, to display the default VDE library, enter the SHOW LIBRARY command:

VDE> SHOW LIBRARY Main library LIBNAME in root directory DEV$:[PROJDIR] VDE>

You are returned to the VDE prompt when the command has executed and you then can enter another VDE command.

Ending a Session

To exit from VDE, enter the VDE command EXIT or press CTRL/Z.

1.1.1.2 Entering Commands from DCL

To enter a VDE command from the DCL command line, type VDE at the DCL prompt ($) then type a VDE command on the same DCL command line. The following example shows how to display the name of the default VDE library:

$ VDE SHOW LIBRARY Main library LIBNAME in root directory DEV$:[PROJDIR] $

You are returned to the DCL prompt ($) when the command has been executed. For this reason, this form is most appropriate when you only need to enter a single VDE command.

Multiple commands can be specified on a single VDE or VSC DCL command line by using a semicolon as a delimiter.

VDE> SHOW LIBRARY; SHOW VERSION Library VMS in root directory VSC$ROOTDISK:[VMS.DBROOT] Executing VDE for OpenVMS Alpha Version V1.5-0 VDE>

1.1.1.3 Using Abbreviations

All command and qualifier keywords for VDE commands can be abbreviated to the shortest unique abbreviation. The DELETE command, for example, can be abbreviated to DEL because no other VDE command begins with those three letters. The DELETE command cannot be abbreviated to DE, however, because the DEFINE command makes the two-letter abbreviation ambiguous.

Note

The number of letters needed to reference a particular VDE command is subject to change in future releases of VDE. DIGITAL strongly recommends that all VDE or VSC commands imbedded within command procedures specify the full command. This avoids errors should any particular VDE command abbreviation become ambiguous in a potential future release of the VDE package.

1.1.2 Using HELP

The VDE interfaces contain a HELP command and an extensive online HELP facility. To obtain help on a particular command, append the command to the HELP command.

VDE> HELP SHOW VERSION SHOW VERSION Displays the VDE version string for the version of VDE you are running. Format SHOW VERSION Additional information available: Parameters Qualifiers Examples SHOW VERSION Subtopic?

The help library also contains a complete list of all error messages and the associated recovery procedures.

1.2 Command Summary

The following table lists all the available VDE commands by functional category:

Creating Database Information Modifying Database Information

CREATE CONTEXT MODIFY CONTEXT

CREATE DEPENDENCY MODIFY DEPENDENCY

CREATE FACILITY MODIFY FACILITY

CREATE GROUP MODIFY GROUP

CREATE LIBRARY MODIFY LIBRARY

CREATE MODULE MODIFY MODULE

CREATE SESSION MODIFY SESSION

CREATE STREAM MODIFY STREAM

CREATE USER MODIFY USER

Displaying Database Information Deleting Database Information

SHOW CONTEXT DELETE CONTEXT

SHOW DEPENDENCY DELETE DEPENDENCY

SHOW FACILITY DELETE FACILITY

SHOW GROUP DELETE GROUP

SHOW LIBRARY DELETE LIBRARY

SHOW MODULE DELETE MODULE

SHOW SESSION UNRESERVE/SESSION

SHOW STREAM DELETE STREAM

SHOW USER DELETE USER

Setting the Development Context

SHOW DEFAULTS SET STREAM

SET LIBRARY SET PRIVILEGES

SHOW LIBRARY CANCEL PRIVILEGES

SET CONTEXT SHOW PRIVILEGES

SET FACILITY RESERVE/SESSION

CREATE CONTEXT MODIFY CONTEXT

SHOW CONTEXT DELETE CONTEXT

SHOW SESSION UNRESERVE/SESSION

Reserving Modules Building the System

RESERVE BUILD

REPLACE COMPILE

UNRESERVE LINK

FETCH TEST

Defining Directory Structures

SET DIRECTORY CANCEL DIRECTORY

SHOW DIRECTORY CREATE DIRECTORY_TREE

Mode Settings

SHOW ALL SET VERIFY

SET LOG SET NOVERIFY

CANCEL LOG CANCEL VERIFY

SHOW LOG SHOW VERIFY

SET TERMINAL

SHOW TERMINAL

Tailoring VDE Exiting or Transferring Control

DEFINE/COMMAND HELP

DELETE/COMMAND @ file-name

SHOW SYMBOL SPAWN

DEFINE/KEY ATTACH

DELETE/KEY EXIT

SET KEY

SHOW KEY

SET PROMPT

Creating Database Information	Modifying Database Information
CREATE CONTEXT	MODIFY CONTEXT
CREATE DEPENDENCY	MODIFY DEPENDENCY
CREATE FACILITY	MODIFY FACILITY
CREATE GROUP	MODIFY GROUP
CREATE LIBRARY	MODIFY LIBRARY
CREATE MODULE	MODIFY MODULE
CREATE SESSION	MODIFY SESSION
CREATE STREAM	MODIFY STREAM
CREATE USER	MODIFY USER

Displaying Database Information	Deleting Database Information
SHOW CONTEXT	DELETE CONTEXT
SHOW DEPENDENCY	DELETE DEPENDENCY
SHOW FACILITY	DELETE FACILITY
SHOW GROUP	DELETE GROUP
SHOW LIBRARY	DELETE LIBRARY
SHOW MODULE	DELETE MODULE
SHOW SESSION	UNRESERVE/SESSION
SHOW STREAM	DELETE STREAM
SHOW USER	DELETE USER

Setting the Development Context
SHOW DEFAULTS	SET STREAM
SET LIBRARY	SET PRIVILEGES
SHOW LIBRARY	CANCEL PRIVILEGES
SET CONTEXT	SHOW PRIVILEGES
SET FACILITY	RESERVE/SESSION
CREATE CONTEXT	MODIFY CONTEXT
SHOW CONTEXT	DELETE CONTEXT
SHOW SESSION	UNRESERVE/SESSION

Reserving Modules	Building the System
RESERVE	BUILD
REPLACE	COMPILE
UNRESERVE	LINK
FETCH	TEST

Defining Directory Structures
SET DIRECTORY	CANCEL DIRECTORY
SHOW DIRECTORY	CREATE DIRECTORY_TREE

Mode Settings
SHOW ALL	SET VERIFY
SET LOG	SET NOVERIFY
CANCEL LOG	CANCEL VERIFY
SHOW LOG	SHOW VERIFY
SET TERMINAL
SHOW TERMINAL

Tailoring VDE	Exiting or Transferring Control
DEFINE/COMMAND	HELP
DELETE/COMMAND	@ file-name
SHOW SYMBOL	SPAWN
DEFINE/KEY	ATTACH
DELETE/KEY	EXIT
SET KEY
SHOW KEY
SET PROMPT

Contents

Index

Ctrl/ x	A sequence such as Ctrl/ x indicates that you must hold down the key labeled Ctrl while you press another key or a pointing device button.
PF1 x	A sequence such as PF1 x indicates that you must first press and release the key labeled PF1, then press and release another key or a pointing device button.
GOLD x	A sequence such as GOLD x indicates that you must first press and release the key defined GOLD, then press and release another key. GOLD key sequences can also have a slash (/), dash (-), or underscore (_) as a delimiter in EVE commands.
`[Return]`	In examples, a key name enclosed in a box indicates that you press a key on the keyboard. (In text, a key name is not enclosed in a box.)
...	A horizontal ellipsis in examples indicates one of the following possibilities: Additional optional arguments in a statement have been omitted. The preceding item or items can be repeated one or more times. Additional parameters, values, or other information can be entered.
. . .	A vertical ellipsis indicates the omission of items from a code example or command format; the items are omitted because they are not important to the topic being discussed.
( )	In format descriptions, parentheses indicate that, if you choose more than one option, you must enclose the choices in parentheses.
[ ]	In format descriptions, brackets indicate optional elements. You can choose one, none, or all of the options. (Brackets are not optional, however, in the syntax of a directory name in an OpenVMS file specification, or in the syntax of a substring specification in an assignment statement.)
{ }	In format descriptions, braces surround a required choice of options; you must choose one of the options listed.
boldface text	Boldface text represents the introduction of a new term or the name of an argument, an attribute, or a reason. Boldface text is also used to show user input in Bookreader versions of the manual.
italic text	Italic text emphasizes important information, indicates variables, and indicates complete titles of manuals. Italic text also represents information that can vary in system messages (for example, Internal error number), command lines (for example, /PRODUCER= name), and command parameters in text.
UPPERCASE TEXT	Uppercase text indicates a command, the name of a routine, the name of a file, or the abbreviation for a system privilege.
-	A hyphen in code examples indicates that additional arguments to the request are provided on the line that follows.
numbers	All numbers in text are assumed to be decimal, unless otherwise noted. Nondecimal radixes---binary, octal, or hexadecimal---are explicitly indicated.
mouse	The term mouse refers to any pointing device, such as a mouse, a puck, or a stylus.
MB1, MB2, MB3	MB1 indicates the left mouse button, MB2 indicates the middle mouse button, and MB3 indicates the right mouse button. (The buttons can be redefined by the user.)
PB1, PB2, PB3, PB4	PB1, PB2, PB3, and PB4 indicate buttons on the puck.
SB, SB	SB and SB indicate buttons on the stylus.

VDE

VDE Reference Manual