[OpenVMS documentation]
[Site home] [Send comments] [Help with this site] [How to order documentation] [OpenVMS site] [Compaq site]
Updated: 11 December 1998

Overview of OpenVMS Documentation


Previous Contents


Appendix A
Descriptions of Documents

This appendix describes each manual in the OpenVMS documentation set. The following table lists the section where the manuals in a specific set are described.
Descriptions of See Section
Manuals in the OpenVMS Documentation Set A.1
Manuals in the Media Kit A.2
System integrated product manual A.3
Archived manuals A.4

A.1 Full Documentation Set

This section provides a description of each manual in the Documentation Set.

DECamds User's Guide

Provides information for installing and using the DECamds software. DECamds is a system management tool that lets you monitor, diagnose, and track events in OpenVMS system and OpenVMS Cluster environments.

DEC C Run-Time Library Utilities Reference Manual

Provides detailed usage and reference information about DEC C Run-Time Library utilities for managing localization and time zone data in international software applications.

DEC Text Processing Utility Reference Manual

Describes the DEC Text Processing Utility (DECTPU) and provides reference information about the EDT Keypad Emulator interfaces to DECTPU.

Digital Portable Mathematics Library

Documents the mathematics routines in the Digital Portable Mathematics Library (DPML), supplied only with OpenVMS Alpha systems. VAX programmers should refer to the OpenVMS VAX RTL Mathematics (MTH$) Manual.

Extensible Versatile Editor Reference Manual

Contains command reference information about the EVE text editor. It also provides a cross-reference between EDT and EVE commands.

Guidelines for OpenVMS Cluster Configurations

Provides OpenVMS Cluster configuration information for MEMORY CHANNEL, SCSI, CI, DSSI, and LAN-based clusters.

Guide to Creating OpenVMS Modular Procedures

Describes how to perform a complex programming task by dividing it into modules and coding each module as a separate procedure.

Guide to DECthreads

Describes the DECthreads package, Compaq's multithreading run-time libraries. Use the routines in this package to create and control multiple threads of execution within the address space provided by a single process. Offering both usage tips and reference synopses, this document describes three DECthreads interfaces: routines that conform to the IEEE POSIX 1003.1c standard (called pthread), routines that provide thread-related services in nonthreaded applications (called thread-independent services or tis), and a set of Compaq proprietary routines (called cma) that provide a stable, upwardly compatible interface.

Guide to OpenVMS File Applications

Contains guidelines for designing, creating, and maintaining efficient data files by using Record Management Services (RMS). This manual is intended for application programmers and designers responsible for programs that use RMS files, especially if performance is an important consideration.

Guide to the DEC Text Processing Utility

Provides an introduction to developing DECTPU programs.

Migrating an Application from OpenVMS VAX to OpenVMS Alpha

Describes how to create an OpenVMS Alpha version of an OpenVMS VAX application. It provides an overview of the VAX to Alpha migration process and information to help you plan a migration. It discusses the decisions you must make in planning a migration and the ways to get the information you need to make those decisions. In addition, it describes the migration methods available so that you can estimate the amount of work required for each method and select the method best suited to a given application.

OpenVMS Alpha Galaxy Guide

Provides complete details about how to use all of the OpenVMS Galaxy features and capabilities available in OpenVMS Alpha Version 7.2. This book includes procedures for creating, managing, and using OpenVMS Galaxy computing environments on AlphaServer 8400, 8200, and 4100 systems

OpenVMS Alpha Guide to 64-Bit Addressing and VLM Features

Introduces and describes OpenVMS Alpha operating system support for 64-bit virtual addressing and Very Large Memory (VLM). Intended for system and application programmers, this guide highlights the features and benefits of OpenVMS Alpha 64-bit and VLM capabilities. It also describes how to use these features to enhance application programs to support 64-bit addresses and to efficiently harness very large physical memory.

OpenVMS Guide to Extended File Specifications

Provides an overview of Extended File Specifications and describes the overall differences and impact Extended File Specifications introduce to the OpenVMS environment.

OpenVMS Alpha Guide to Upgrading Privileged-Code Applications

Explains the OpenVMS Alpha Version 7.0 changes that might impact Alpha privileged-code applications and device drivers as a result of the OpenVMS Alpha 64-bit virtual addressing and kernel threads support provided in OpenVMS Alpha Version 7.0.

Privileged-code applications from versions prior to OpenVMS Alpha Version 7.0 might require the source-code changes described in this guide.

OpenVMS Alpha System Tools Manual

Describes the following system analysis tools in detail, while also providing a summary of the dump off system disk (DOSD) and DELTA/XDELTA debugger:

The OpenVMS Alpha System Analysis Tools Manual is intented primarily for the system programmer who must investigate the causes of system failures and debug kernel mode code, such as a device driver.

OpenVMS Calling Standard

Documents the calling standard for the operating system. This manual indicates aspects of the calling standard that are specific to OpenVMS Alpha or OpenVMS VAX.

OpenVMS Cluster Systems

Describes procedures and guidelines for configuring and managing OpenVMS Cluster systems. This document also describes how to provide high availability, building-block growth, and unified system management across coupled systems.

OpenVMS Command Definition, Librarian, and Message Utilities Manual

Contains descriptive and reference information about the following utilities:

OpenVMS DCL Dictionary

Describes the DIGITAL Command Language (DCL) and provides an alphabetical listing of detailed reference information and examples for all DCL commands and lexical functions. This manual is in two parts.

OpenVMS Debugger Manual

Explains the features of the OpenVMS Debugger for programmers.

OpenVMS Delta/XDelta Debugger Manual

Describes the Delta/XDelta utility used to debug programs that run in privileged processor mode or at an elevated interrupt priority level.

OpenVMS Guide to System Security

Describes the security features available in the OpenVMS Alpha and VAX operating systems. It explains the purpose and proper application of each feature in the context of specific security needs.

OpenVMS I/O User's Reference Manual

Contains the information that system programmers need to program I/O operations using the device drivers that are supplied with the operating system.

OpenVMS Linker Utility Manual

Describes how to use the Linker utility to create images that run on OpenVMS systems. The manual also explains how to control a link operation with link qualifiers and link options.

OpenVMS Management Station Overview and Release Notes

Provides an overview of OpenVMS Management Station and describes how to get started using the software. OpenVMS Management Station is a powerful, Microsoft Windows based management tool for system managers and others who perform user account and printer management tasks on OpenVMS systems. OpenVMS Management Station provides a comprehensive user interface to OpenVMS user account and printer management. This document also includes release notes for OpenVMS Management Station.

OpenVMS Master Index

Offers an edited compilation of indexes from the manuals in the Full Documentation Set.

Note

Index entries shown in the Bookreader version of the OpenVMS Master Index refer to page numbers in the hardcopy manuals.

OpenVMS Performance Management

Introduces and explains the techniques used to optimize performance on an OpenVMS system.

OpenVMS Programming Concepts Manual

Describes concepts such as process creation, kernel threads and the kernel threads process structure, interprocess communication, process control, data sharing, condition handling, and ASTs. This manual uses system services, utility routines, and run-time library (RTL) routines to illustrate mechanisms for utilizing OpenVMS features.

OpenVMS Programming Interfaces: Calling a System Routine

Describes the OpenVMS programming interface and defines the standard conventions to call an OpenVMS system routine from a user procedure. The Alpha and VAX data type implementations for various high-level languages are also presented in this manual.

OpenVMS Record Management Services Reference Manual

Provides reference and usage information for all programmers who use RMS data files.

OpenVMS Record Management Utilities Reference Manual

Contains descriptive and reference information about the following RMS utilities:

OpenVMS RTL General Purpose (OTS$) Manual

Documents the general-purpose routines contained in the OTS$ facility of the OpenVMS Run-Time Library. This manual indicates which routines are specific to Alpha or VAX, as well as how routines function differently on each system.

OpenVMS RTL Library (LIB$) Manual

Documents the general-purpose routines contained in the LIB$ facility of the OpenVMS Run-Time Library. This manual indicates which routines are specific to Alpha or VAX, as well as how routines function differently on each system.

OpenVMS RTL Screen Management (SMG$) Manual

Documents the screen management routines contained in the SMG$ facility of the OpenVMS Run-Time Library. This manual indicates which routines are specific to Alpha or VAX, as well as how routines function differently on each system.

OpenVMS RTL String Manipulation (STR$) Manual

Documents the string manipulation routines contained in the STR$ facility of the OpenVMS Run-Time Library. This manual indicates which routines are specific to Alpha or VAX, as well as how routines function differently on each system.

OpenVMS System Management Utilities Reference Manual

Presents reference information on the utilities you can use to perform system management tasks on your system as well as the tools to control and monitor system access and resources. This two-part manual also includes a description of the AUTOGEN command procedure.

OpenVMS System Manager's Manual: Essentials

Provides instructions for setting up and maintaining routine operations, such as starting up the system, installing software, and setting up print and batch queues. It also documents routine disk and magnetic tape operations.

OpenVMS System Manager's Manual: Tuning, Monitoring, and Complex Systems

Describes configuring and controlling the network, monitoring the system and performance, and managing system parameters. The manual also includes information on OpenVMS Cluster and network environments and DECdtm functionality.

OpenVMS System Messages: Companion Guide for Help Message Users

Describes features of the Help Message facility, a tool that you can use to display message descriptions. The manual describes the HELP/MESSAGE command and qualifiers and also includes detailed information about customizing the Help Message database. The manual also provides descriptions of messages that can occur when the system and Help Message are not fully operable.

OpenVMS System Services Reference Manual

Presents the set of routines that the operating system uses to control resources, allow process communication, control I/O, and perform other such operating system functions. This manual is in two parts.

OpenVMS User's Manual

Provides an overview of the operating system and presents basic concepts, task information, and reference information that enable you to perform daily computing tasks. It describes how to work with files and directories. It also includes these additional topics:

OpenVMS Utility Routines Manual

Describes the routines that allow a program to use the callable interface of selected OpenVMS utilities.

OpenVMS VAX RTL Mathematics (MTH$) Manual

Documents the mathematics routines contained in the MTH$ facility of the OpenVMS Run-Time Library, which is relevant only to programmers using OpenVMS VAX. (Alpha programmers should refer to Digital Portable Mathematics Library.)

OpenVMS VAX System Dump Analyzer Utility Manual

Explains how to use the System Dump Analyzer utility to investigate system failures and examine a running OpenVMS VAX system. VAX programmers should refer to this manual; Alpha programmers should refer to the OpenVMS Alpha System Dump Analyzer Utility Manual.

OpenVMS Version 7.2 New Features Manual

Describes new and improved components for the Alpha and VAX operating systems for Version 7.2 release.

OpenVMS Version 7.2 Release Notes

Describes temporary problems and bug fixes to the Alpha and VAX operating systems.

Overview of OpenVMS Documentation

Provides a general introduction to the documentation set. This manual explains how the set is organized, describes all of its components, and provides ordering information.

POLYCENTER Software Installation Utility Developer's Guide

Describes the procedure and provides guidelines for developing software products that will be installed using the POLYCENTER Software Installation utility. Intended for developers who are designing installation procedures for software products layered on the OpenVMS operating system.

Porting VAX MACRO Code to OpenVMS Alpha

Describes how you can port existing VAX MACRO assembly language code to an OpenVMS Alpha system by using the features of the MACRO-32 compiler. It provides information to help you identify and correct VAX MACRO code that relies on elements of the VAX architecture. The manual examines the function of each compiler directive and built-in, explaining the circumstances under which it is necessary to add a directive or built-in to VAX MACRO assembly language code. It also discusses the qualifiers that govern the behavior of the compiler.

TCP/IP Networking on OpenVMS Systems

Provides an introductory overview of TCP/IP networking and describes OpenVMS DCL support for TCP/IP capabilities.

VAX MACRO and Instruction Set Reference Manual

Documents both the assembler directives of VAX MACRO and the VAX instruction set.

Volume Shadowing for OpenVMS

Describes how to provide high data availability with phase II volume shadowing.

Writing OpenVMS Alpha Device Drivers in C

Provides definitive information about writing device drivers in the C programming language for devices connected to Alpha processors. Writing OpenVMS Alpha Device Drivers in C is available from Digital Press. For more information, see http://www.bh.com/digitalpress.

A.2 Media Kit

This section provides a description of each manual in the media kit.

Guide to OpenVMS Version 7.2 CD--ROMs

Provides information about the OpenVMS Alpha and OpenVMS VAX operating system and documentation CD-ROMs. It lists the contents of the OpenVMS Version 7.2 CD-ROM package, includes pointers to installation information, and gives instructions on how to access manuals on the Documentation CD-ROM.

OpenVMS Alpha Version 7.2 Upgrade and Installation Manual

Provides step-by-step instructions for installing and upgrading the OpenVMS Alpha operating system on Alpha computers. It also includes information about booting, shutdown, backup, and licensing procedures.

OpenVMS VAX Version 7.2 Upgrade and Installation Manual

Provides step-by-step instructions for installing and upgrading the OpenVMS VAX computers. It also includes information about booting, shutdown, backup, and licensing procedures.

OpenVMS License Management Utility Manual

Describes the License Management Facility (LMF), the software license management tool. LMF includes the License Management Utility (LICENSE) and the command procedure VMSLICENSE.COM, which is used to register, manage, and track software licenses on line.

A.3 System Integrated Product

RMS Journaling for OpenVMS Manual

Describes the three types of RMS Journaling as well as other OpenVMS components that support RMS Journaling. This manual also describes the RMS Recovery utility (which is used to recover data saved using journaling), the transaction processing system services, and system management tasks required when using RMS Journaling.

A.4 Archived Manuals

This section provides a description of each archived manual.

A Comparison of System Management on OpenVMS AXP and OpenVMS VAX

Discusses system management tools, the impact of Alpha page sizes on system management operations, the system directory structure, interoperability issues, and performance information. This manual is designed for system managers who need to learn quickly how to manage an OpenVMS Alpha system.

Building Dependable Systems: The OpenVMS Approach

Offers practical information about analyzing the dependability requirements of your business applications and deciding how to use your computing systems to support your dependability goals. This information is complemented by technical summaries of the dependability features of OpenVMS and related hardware and layered software products.

Creating an OpenVMS Alpha Device Driver from an OpenVMS VAX Device Driver

Describes the procedures for converting a device driver used on OpenVMS VAX to a device driver that runs on OpenVMS Alpha. This book also contains data structures, routines, and macros for maintaining an Alpha driver written in Macro-32.

Creating an OpenVMS AXP Step 2 Device Driver from a Step 1 Device Driver

Provides information for upgrading a Step 1 device driver (used in earlier versions of OpenVMS AXP) to a Step 2 device driver. A Step 2 device driver is required for OpenVMS AXP Version 6.1.

Creating an OpenVMS AXP Step 2 Device Driver from an OpenVMS VAX Device Driver

Provides information for migrating a device driver used on OpenVMS VAX to a Step 2 device driver used on OpenVMS AXP Version 6.1.

Guide to OpenVMS AXP Performance Management

Introduces and explains the techniques used to optimize performance on an OpenVMS Alpha system.

Guide to OpenVMS Performance Management

Introduces and explains the techniques used to optimize performance on an OpenVMS VAX system.

Migrating an Environment from OpenVMS VAX to OpenVMS Alpha

Describes how to migrate a computing environment from an OpenVMS VAX system to an OpenVMS Alpha system or a mixed-architecture cluster. It provides an overview of the VAX to Alpha migration process and describes the differences in system and network management on VAX and Alpha computers.

Migrating to an OpenVMS AXP System: Planning for Migration

Describes the general characteristics of RISC architectures, compares the Alpha architecture to the VAX architecture, and presents an overview of the migration process and a summary of migration tools provided by Compaq. The information in this manual is intended to help you define the optimal migration strategy for your application.

Migrating to an OpenVMS AXP System: Recompiling and Relinking Applications

Provides detailed technical information for programmers who must migrate high-level language applications to OpenVMS Alpha. This manual describes how to set up a development environment to facilitate the migration of applications, helps programmers identify application dependencies on elements of the VAX architecture, and introduces compiler features that help resolve these dependencies. Individual sections of this manual discuss specific application dependencies on VAX architectural features, data porting issues (such as alignment concerns), and the process of migrating VAX shareable images.

OpenVMS Alpha System Dump Analyzer Utility Manual

Explains how to use the System Dump Analyzer utility to investigate system failures and examine a running OpenVMS Alpha system. Alpha programmers should refer to this manual; VAX programmers should refer to the OpenVMS VAX System Dump Analyzer Utility Manual.

OpenVMS AXP Device Support: Developer's Guide

Describes how to write a driver for OpenVMS Alpha for a device not supplied by Compaq.

OpenVMS AXP Device Support: Reference

Provides the reference material for the Writing OpenVMS Alpha Device Drivers in C by describing the data structures, macros, and routines used in device-driver programming.

OpenVMS Bad Block Locator Utility Manual

Describes how to use the Bad Block Locator utility to locate bad blocks on older types of media.

OpenVMS Compatibility Between VAX and Alpha

Compares and contrasts OpenVMS on VAX and Alpha computers, focusing on the features provided to end users, system managers, and programmers.

OpenVMS Developer's Guide to VMSINSTAL

Describes the VMSINSTAL command procedure and provides guidelines for designing installation procedures that conform to standards recommended by Compaq. Intended for developers who are designing installation procedures for software products layered on the OpenVMS operating system.

OpenVMS DIGITAL Standard Runoff Reference Manual

Describes the DSR text-formatting utility.

OpenVMS EDT Reference Manual

Contains complete reference information for the EDT editor.

OpenVMS Exchange Utility Manual

Describes how to use the Exchange utility to transfer files between some foreign format volumes and OpenVMS native volumes.

OpenVMS Glossary

Defines terms specific to OpenVMS that are used throughout the documentation.

OpenVMS National Character Set Utility Manual

Describes how to use the National character set utility to build NCS definition files.

OpenVMS Obsolete Features Manual

Presents the DCL commands, system services, RTL routines, and utilities made obsolete by VMS Version 4.0 through Version 5.0. The manual also has an appendix of DCL commands, RTL routines, and utilities eliminated from VMS Version 4.0.

OpenVMS Programming Environment Manual

Provides a general description of Compaq products and tools that define the programming environment. This manual introduces facilities and tools such as the compilers, the linker, the debugger, the System Dump Analyzer, system services, and routine libraries.

OpenVMS RTL DECtalk (DTK$) Manual

Documents the DECtalk support routines contained in the DTK$ facility of the OpenVMS Run-Time Library.

OpenVMS RTL Parallel Processing (PPL$) Manual

Documents the parallel-processing routines contained in the PPL$ facility of the OpenVMS Run-Time Library. This manual indicates which routines are specific to Alpha or VAX, as well as how routines function differently on each system.

OpenVMS Software Overview

Provides an overview of the OpenVMS operating system and some of its available products.

OpenVMS SUMSLP Utility Manual

Describes how to use the SUMSLP batch-oriented editor to update source files.

OpenVMS System Messages and Recovery Procedures Reference Manual

Contains an alphabetical listing of the errors, warnings, and informational messages issued by the operating system. Also provides the meaning of each message and a statement of the action to be taken in response to each message. This manual is in two parts.

OpenVMS Terminal Fallback Utility Manual

Describes how to use the Terminal Fallback utility to manage the libraries, character conversion tables, and terminal parameters that are available within this utility.

OpenVMS VAX Card Reader, Line Printer, and LPA11--K I/O User's Reference Manual

Describes the card reader, laboratory peripheral accelerator, and line printer drivers on OpenVMS VAX.

OpenVMS VAX Device Support Manual

Describes how to write an OpenVMS VAX driver for a device not supplied by Compaq.

OpenVMS VAX Device Support Reference Manual

Provides the reference material for the OpenVMS VAX Device Support Manual by describing the data structures, macros, and routines used in device-driver programming.

OpenVMS VAX Patch Utility Manual

Describes how to use the Patch utility to examine and modify executable and shareable OpenVMS VAX images.

OpenVMS Wide Area Network I/O User's Reference Manual

Describes the DMC11/DMR11, DMP11 and DMF32, DR11-W and DRV11-WA, DR32, and asynchronous DDCMP interface drivers on OpenVMS VAX.

PDP--11 TECO User's Guide

Describes the operating procedures for the PDP-11 TECO (Text Editor and Corrector) program.

POLYCENTER Software Installation Utility User's Guide

Provides information on the POLYCENTER Software Installation utility, a new component that lets you install and manage software products that are compatible with the utility.

Previous Contents Contents

[Site home] [Send comments] [Help with this site] [How to order documentation] [OpenVMS site] [Compaq site]
[OpenVMS documentation]

Copyright © Compaq Computer Corporation 1998. All rights reserved.

Legal
4511PRO_002.HTML