![[Compaq]](../../images/hp.gif)
![[Go to the documentation home page]](../../images/buttons/hp_bn_site_home.gif)
![[How to order documentation]](../../images/buttons/hp_bn_order_docs.gif)
![[Help on this site]](../../images/buttons/hp_bn_site_help.gif)
![[How to contact us]](../../images/buttons/hp_bn_comments.gif)
![[OpenVMS documentation]](../../images/hp_ovmsdoc_sec_head.gif)
| Document revision date: 15 July 2002 | |
|
|
|
|
|
|
| Previous | Contents | Index |
OpenVMS documentation is provided, as follows:
The following sections describe each format in which OpenVMS
documentation is provided and specifies the titles that are available
in that format.
8.1 Printed Documentation
Some printed documentation comes with your OpenVMS media kit. All other printed manuals are separately orderable, either in kits or individually. This section describes the OpenVMS printed documentation offerings, which are broken down into the following categories:
The OpenVMS media kit contains the documents you need to get started with the latest version of the OpenVMS operating system. Table 8-1 lists the books included in the OpenVMS media kit. The books you receive are determined by whether you are a new or a service customer. New customers receive all books; service customers receive only new books and books that have been updated since the last release. You can also order the manuals listed in Table 8-1 individually.
| Manual | Order Number |
|---|---|
| OpenVMS License Management Utility Manual 1 | AA-PVXUF-TK |
| Guide to OpenVMS Alpha Version 7.3--1 CD--ROMs | AA-RSCZA-TE |
| OpenVMS Alpha Version 7.3--1 New Features and Documentation Overview | AA-RSHYA-TE |
| OpenVMS Alpha Version 7.3--1 Upgrade and Installation Manual | AA- QSE8E-TE |
| OpenVMS Alpha Version 7.3--1 Release Notes | AA-RSD0A-TE |
OpenVMS documentation is available in the following documentation sets:
| Documentation Set | Description | Order Number |
|---|---|---|
| Full set | Intended for users who need extensive explanatory information for all major OpenVMS resources. Contains all the OpenVMS documentation in one offering. Includes the Base Documentation set. | QA-001AA-GZ.7.3-1 |
| Base set | Subset of the Full Documentation set. Intended for general users and system managers of small standalone systems. Includes the most commonly used OpenVMS manuals. | QA-09SAA-GZ.7.3-1 |
In addition to ordering the Full or Base Documentation set, you can order any OpenVMS manual individually.
Table 8-2 lists the manuals in the OpenVMS Base and Full Documentation sets. For a description of each manual, see Section 9.2.
| Manual | Order Number |
|---|---|
| OpenVMS Base Documentation Set | QA-09SAA-GZ.7.3-1 |
| OpenVMS DCL Dictionary: A--M 1 | AA-PV5KH-TK |
| OpenVMS DCL Dictionary: N--Z 1 | AA-PV5LH-TK |
| OpenVMS Guide to System Security 1 | AA-Q2HLF-TE |
| OpenVMS System Management Utilities Reference Manual: A--L 1 | AA-PV5PG- TK |
| OpenVMS System Management Utilities Reference Manual: M--Z 1 | AA-PV5QG- TK |
| OpenVMS System Manager's Manual, Volume 1: Essentials 1 | AA-PV5MG-TK |
| OpenVMS System Manager's Manual, Volume 2: Tuning, Monitoring, and Complex Systems 1 | AA-PV5NG-TK |
| OpenVMS User's Manual 1 | AA-PV5JF-TK |
| OpenVMS Alpha Version 7.3--1 New Features and Documentation Overview 2 | AA-RSHYA-TE |
| OpenVMS Alpha Version 7.3--1 Release Notes 2 | AA-RSD0A-TE |
| Additional Books Included in the Full Documentation Set | QA-001AA-GZ.7.3-1 |
| Availability Manager User's Guide 1 | AA-RNSJB-TE |
| COM, Registry, and Events for OpenVMS Developer's Guide 2 | AA-RSCWA-TE |
| Compaq C Run-Time Library Reference Manual for OpenVMS Systems 2 | AA-PUNEK-TK |
| Compaq C Run-Time Library Utilities Reference Manual | AA-R238C-TE |
| Compaq Portable Mathematics Library | AA-PV6VE-TE |
| DECamds User's Guide | AA-Q3JSE-TE |
| DEC Text Processing Utility Reference Manual | AA-PWCCD-TE |
| Extensible Versatile Editor Reference Manual | AA-PWCDD-TE |
| Guidelines for OpenVMS Cluster Configurations 1 | AA-Q28LF-TK |
| Guide to Creating OpenVMS Modular Procedures | AA-PV6AD-TK |
| Guide to OpenVMS File Applications 1 | AA-PV6PE-TK |
| Guide to the POSIX Threads Library | AA-QSBPD-TE |
| Guide to the DEC Text Processing Utility | AA-PWCBD-TE |
| Open Source Security for OpenVMS Alpha, Volume 1: Common Data Security Architecture 2 | AA- RSCUA-TE |
| Open Source Security for OpenVMS Alpha, Volume 2: Compaq SSL (Secure Sockets Layer) for OpenVMS Alpha 2 | AA- RSCVA-TE |
| OpenVMS Alpha Partitioning and Galaxy Guide 1 | AA-REZQD-TE |
| OpenVMS Alpha Guide to Upgrading Privileged-Code Applications | AA-QSBGD-TE |
| OpenVMS Alpha System Analysis Tools Manual 1 | A A-REZTC-TE |
| OpenVMS Calling Standard | AA-QSBBD-TE |
| OpenVMS Cluster Systems 1 | AA-PV5WF-TK |
| OpenVMS Command Definition, Librarian, and Message Utilities Manual | AA-QSBDD-TE |
| OpenVMS Debugger Manual | AA-QSBJD-TE |
| OpenVMS Delta/XDelta Debugger Manual | AA-PWCAD-TE |
| OpenVMS I/O User's Reference Manual 1 | AA-PV6SE-TK |
| OpenVMS Linker Utility Manual | AA-PV6CD-TK |
| OpenVMS MACRO-32 Porting and User's Guide | AA-PV64D-TE |
| OpenVMS Management Station Overview and Release Notes | AA-QJGCE-TE |
| OpenVMS Performance Management | AA-R237C-TE |
| OpenVMS Programming Concepts Manual, Volume I 1 | AA - RNSHB-TK |
| OpenVMS Programming Concepts Manual, Volume II 1 | A A- PV67F-TK |
| OpenVMS Record Management Services Reference Manual 1 | AA-PV6RE-TK |
| OpenVMS Record Management Utilities Reference Manual | AA-PV6QD-TK |
| OpenVMS RTL General Purpose (OTS$) Manual | AA-PV6HD-TK |
| OpenVMS RTL Library (LIB$) Manual | AA-QSBHD-TE |
| OpenVMS RTL Screen Management (SMG$) Manual | AA-PV6LD-TK |
| OpenVMS RTL String Manipulation (STR$) Manual | AA-PV6MD-TK |
| OpenVMS System Messages: Companion Guide for Help Message Users | AA-PV5TD-TK |
| OpenVMS System Services Reference Manual: A--GETUAI 1 | AA-QSBME-TE |
| OpenVMS System Services Reference Manual: GETUTC--Z 1 | AA-QSBNE-TE |
| OpenVMS Utility Routines Manual 1 | AA-PV6EE-TK |
| OpenVMS VAX RTL Mathematics (MTH$) Manual | AA-PVXJD-TE |
| OpenVMS VAX System Dump Analyzer Utility Manual | AA-PV6TD-TE |
| POLYCENTER Software Installation Utility Developer's Guide | AA-Q28MD-TK |
| VAX MACRO and Instruction Set Reference Manual | AA-PS6GD-TE |
| Volume Shadowing for OpenVMS 1 | AA-PVXMH-TE |
System Integrated Products (SIPs) are included in the OpenVMS software, but you must purchase separate licenses to enable them. Table 8-3 shows the documentation associated with System Integrated Products.
| System Integrated Product | Related Documentation |
|---|---|
| Compaq Galaxy Software Architecture on OpenVMS Alpha | The documentation is included in the OpenVMS Full Documentation set, or you can order it separately. |
| OpenVMS Clusters | The OpenVMS Cluster documentation is included in the OpenVMS Full Documentation set. |
| RMS Journaling for OpenVMS |
You must purchase the RMS Journaling documentation separately. Use the
following part number:
RMS Journaling for OpenVMS Manual: AA-JG41C-TE |
| Volume Shadowing for OpenVMS | The documentation is included in the OpenVMS Full Documentation set, or you can order it separately. |
OpenVMS continuously updates, revises, and enhances the OpenVMS operating system documentation. From time to time, manuals are archived. You can access the archived manuals online from the documentation CD-ROMs or from the following Web site:
http://www.compaq.com/openvms |
For a list of the archived OpenVMS manuals, see Section 9.6.
8.2 Documentation Pilot Project
With Version 7.3--1, OpenVMS is introducing several books that have been authored and published using the Standard Generalized Markup Language (SGML). SGML is an industry standard and will provide many benefits to both the customer and OpenVMS documentation. The following books have been produced with this new tool:
Due to several enhancements to the HTML versions of these manuals, you
need the Compaq Secure Web Browser to view the HTML files.
8.3 Online Documentation on CD-ROM
Online documentation for the OpenVMS operating system and many associated products is provided on two CD-ROMS. One is an ISO9660 Level 2 CD-ROM that is readable on Windows and Macintosh systems. The other is a Files-11 CD-ROM that is readable on Windows and OpenVMS systems. The contents of the CD-ROMs are the same, except:
The documentation CD-ROMs contain documentation in a number of formats.
| Documentation | Available Formats |
|---|---|
| Current OpenVMS manuals | HTML, PDF |
| Archived manuals | |
| OpenVMS Alpha Version 7.3--1 Upgrade and Installation Manual | HTML 2, PDF, PostScript, ASCII text |
| OpenVMS Alpha Version 7.3--1 Release Notes | HTML, PDF, PostScript, ASCII text |
| OpenVMS Alpha Version 7.3--1 New Features and Documentation Overview | HTML, PDF, PostScript, ASCII text |
| Layered product documents (Release Notes, Install Guides, Software Product Descriptions (SPDs), Cover Letters) | PostScript, ASCII text |
Bookreader files are no longer available on the documentation CD-ROMs.
8.3.2 PDF Reader
The Adobe Acrobat Reader is provided for viewing PDF files. This self-extracting file can be installed on a computer running Windows. It is located on the ISO9660 Level 2 CD-ROM.
For information about how to access documents on the documentation
CD-ROMs and about the PDF reader, refer to the Guide to OpenVMS Alpha Version 7.3--1 CD--ROMs.
8.4 Online Documentation on the OpenVMS Web Site
You can access OpenVMS manuals in various online formats from the following OpenVMS Web site:
http://www.compaq.com/openvms |
This site contains links to current versions of manuals in the OpenVMS
Full Documentation set as well as to manuals for selected layered
products.
8.5 Online Help
The OpenVMS operating system provides online help for the commands, utilities, and system routines documented in the Full Documentation set.
You can use the Help Message facility to quickly access online descriptions of system messages. In addition, you can add your own source files, such as messages documentation that you have written to the Help Message database. The OpenVMS System Messages: Companion Guide for Help Message Users manual explains how to use the Help Message facility. You can also access DCL Help for Help Message by entering:
$ HELP HELP/MESSAGE |
Reference information for the following OpenVMS utility routines is now included in online help under RTL_Routines :
Access Control List (ACL) Editor (ACLEDIT$)
Backup (BACKUP) (BACKUP$)
Command Language (CLI) (CLI$)
Command File Qualifier (UTIL$)
Convert (CONVERT) (CONV$)
Data Compression/Expansion (DCX) (DCX$)
DEC Text Processing Utility (DECTPU) (TPU$)
EDT (EDT$EDIT; FILEIO; WORKIO; XLATE)
File Definition Language (FDL) (FDL$)
Librarian (LBR) (LBR$)
LOGINOUT (LGI) (LGI$)
Mail Utility (MAIL) (MAIL$)
National Character Set (NCS) (NCS$)
Print Symbiont Modification (PSM) (PSM$; USER-x)
Symbiont/Job Controller Interface (SMB) (SMB$)
Sort/Merge (SOR) (SOR$)
This chapter provides summary descriptions for the following OpenVMS documentation:
Guide to OpenVMS Alpha Version 7.3--1 CD--ROMs
Provides information about the OpenVMS Alpha operating system and documentation CD-ROMs. Lists the contents of the OpenVMS Version 7.3-1 CD-ROM package, includes pointers to installation information, and gives instructions about how to access manuals on the documentation CD-ROM.
OpenVMS License Management Utility Manual
Describes the License Management Facility (LMF), the OpenVMS license management tool. LMF includes the License Management Utility (LICENSE) and VMSLICENSE.COM, the command procedure you use to register, manage, and track software licenses.
OpenVMS Alpha Version 7.3--1 Upgrade and Installation Manual
Provides step-by-step instructions for installing and upgrading the OpenVMS Alpha operating system on Alpha computers. Includes information about booting, shutdown, backup, and licensing procedures.
OpenVMS Alpha Version 7.3--1 New Features and Documentation Overview
Describes new and improved components for the Alpha and VAX operating systems for the Version 7.3-1 release. Includes information about OpenVMS documentation changes for Version 7.3-1 as well as the printed and online OpenVMS documentation offerings.
OpenVMS Alpha Version 7.3--1 Release Notes
Describes changes to the software; installation, upgrade, and
compatibility information; new and existing software problems and
restrictions; and software and documentation corrections.
9.2 Manuals in the OpenVMS Base Documentation Set
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 volumes.
OpenVMS Guide to System Security
Describes the security features available in the OpenVMS Alpha and VAX operating systems. Explains the purpose and proper application of each feature in the context of specific security needs.
OpenVMS System Management Utilities Reference Manual
Presents reference information about 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. Includes a description of the AUTOGEN command procedure. This manual is in two volumes.
OpenVMS System Manager's Manual, Volume 1: 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. Also explains routine disk and magnetic tape operations.
OpenVMS System Manager's Manual, Volume 2: Tuning, Monitoring, and Complex Systems
Describes how to configure and control the network, how to monitor the system, and how to manage system parameters. Also includes information about OpenVMS Cluster systems, network environments, and DECdtm functionality.
Provides an overview of the operating system and presents basic concepts, task information, and reference information that allow you to perform daily computing tasks. Describes how to work with files and directories. Also includes these additional topics:
OpenVMS Alpha Version 7.3--1 New Features and Documentation Overview
Describes new and improved components for the Alpha and VAX operating systems for the Version 7.3-1 release. Includes information about OpenVMS documentation changes for Version 7.3-1 as well as the printed and online OpenVMS documentation offerings.
OpenVMS Alpha Version 7.3--1 Release Notes
Describes changes to the software; installation, upgrade, and
compatibility information; new and existing software problems and
restrictions; and software and documentation corrections.
9.3 Additional Manuals in the OpenVMS Full Documentation Set
Availability Manager User's Guide
Describes how to use the Compaq Availability Manager system management tool, from either an OpenVMS Alpha or a Windows node, to monitor one or more OpenVMS nodes on an extended local area network (LAN) or to target a specific node or process for detailed analysis.
COM, Registry, and Events for OpenVMS Developer's Guide
For programmers developing applications that move easily between the OpenVMS and Windows NT environments. Read this manual if you are encapsulating existing OpenVMS applications or data, or creating new COM appplications for OpenVMS systems. It also provides information for those who want to use the OpenVMS Registry to store information about their OpenVMS systems alone, or who want to use the OpenVMS Registry as a shared repository for both OpenVMS and Windows NT registry information. This manual was formerly available online as the OpenVMS Connectivity Developer Guide.
Compaq C Run-Time Library Reference Manual for OpenVMS Systems
Provides reference information on the functions and macros found in the Compaq C RTL that perform I/O operations, character and string manipulation, mathematical operations, error detection, subprocess creation, system access, and screen management. Includes portability concerns between operating systems, and describes the Compaq C for OpenVMS socket routines used for writing Internet application programs for the TCP/IP protocol.
Compaq C Run-Time Library Utilities Reference Manual
Provides detailed usage and reference information about the Compaq C Run-Time Library utilities for managing localization and time zone data in international software applications.
Compaq Portable Mathematics Library
Documents the mathematics routines in the Compaq Portable Mathematics Library (DPML), supplied only with OpenVMS Alpha systems. VAX programmers should refer to the OpenVMS VAX RTL Mathematics (MTH$) Manual.
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 Text Processing Utility Reference Manual
Describes the DEC Text Processing Utility (DECTPU) and provides reference information about the EDT Keypad Emulator interfaces to DECTPU.
Extensible Versatile Editor Reference Manual
Contains command reference information about the EVE text editor. Also provides a cross-reference between EDT and EVE commands.
Guidelines for OpenVMS Cluster Configurations
This manual provides information to help you choose systems, interconnects, storage devices, and software. It can help you configure these components to achieve high availability, scalability, performance, and ease of system management. Detailed directions using SCSI and Fibre Channel in an OpenVMS Cluster system are also included in this manual.
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 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 POSIX Threads Library
Describes the POSIX Threads Library (formerly named 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 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 the DEC Text Processing Utility
Provides an introduction to developing DECTPU programs.
Open Source Security for OpenVMS Alpha, Volume 1: Common Data Security Architecture
For application developers who want to use the Common Data Security Architecture (CDSA) to add security to their programs. Describes CDSA, gives information about installation and initialization, and provides example programs. Contains the CDSA application programming interface modules.
For application developers who want to protect communication links to OpenVMS applications with Compaq Secure Sockets Layer (Compaq SSL) for OpenVMS Alpha. Contains installation instructions, release notes, and provides example programs. Includes programming information and a reference section for the OpenSSL application programming interface modules.
OpenVMS Alpha Partitioning and Galaxy Guide
Provides complete details about how to use all of the OpenVMS Galaxy features and capabilities available in OpenVMS Alpha Version 7.3. Includes procedures for creating, managing, and using OpenVMS Galaxy computing environments on AlphaServer 8400, 8200, and 4100 systems.
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 Analysis Tools Manual
Describes the following system analysis tools in detail, while also providing a summary of the dump off system disk (DOSD) capability and the DELTA/XDELTA debugger:
| Previous | Next | Contents | Index |
|
|
| privacy and legal statement | ||
| 6657PRO_009.HTML | ||