Command Definition, Librarian, and Message Utilities
Total Page:16
File Type:pdf, Size:1020Kb
VSI OpenVMS Command Definition, Librarian, and Message Utilities Document Number: DO-DCDLMU-01A Publication Date: August 2019 This manual describes how to use the Command Definition Utility to modify Open- VMS DCL, how to use the Librarian utility to create and maintain OpenVMS libraries, and how to use the Message utility to supplement OpenVMS system messages with messages of your own. Revision Update Information: This is a new manual. Operating System and Version: VSI OpenVMS x86-64 Version 9.1 VSI OpenVMS I64 Version 8.4-1H1 VSI OpenVMS Alpha 8.4-2L1 VMS Software, Inc. (VSI) Bolton, Massachusetts, USA Command Definition, Librarian, and Message Utilities: Copyright © 2019 VMS Software, Inc. (VSI), Bolton, Massachusetts, USA Legal Notice Confidential computer software. Valid license from VSI required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice. The only warranties for VSI products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. VSI shall not be liable for technical or editorial errors or omissions contained herein. HPE, HPE Integrity, HPE Alpha, and HPE Proliant are trademarks or registered trademarks of Hewlett Packard Enterprise. Intel, Itanium, and IA-64 are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other coun- tries. The VSI OpenVMS documentation set is available on DVD. ii Command Definition, Librarian, and Message Utilities Preface ..................................................................................................................................... v 1. About VSI ...................................................................................................................... v 2. Who Should Use This Manual ......................................................................................... v 3. How This Manual Is Organized ....................................................................................... v 4. Related Documents ........................................................................................................ vi 5. VSI Encourages Your Comments .................................................................................... vi 6. How to Order Additional Documentation ........................................................................ vi 7. Typographycal Conventions ........................................................................................... vi Chapter 1. Command Definition Utility .............................................................................. 1 1.1. Command Processing ................................................................................................... 1 1.1.1. Command String Components ............................................................................ 1 1.1.2. System and Process Command Tables ................................................................ 2 1.2. Using CDU .................................................................................................................. 2 1.3. Choosing a Table ......................................................................................................... 2 1.3.1. Modifying Your Process Command Table ........................................................... 3 1.3.2. Adding a System Command ............................................................................... 3 1.3.3. Creating an Object Module ................................................................................ 4 1.4. Writing a Command Definition File .............................................................................. 4 1.4.1. Defining Syntax ................................................................................................ 5 1.4.2. Defining Values ................................................................................................ 6 1.4.2.1. Built-In Value Types ............................................................................... 6 1.4.2.2. User-Defined Keywords .......................................................................... 7 1.4.3. Defining Command Verbs .................................................................................. 8 1.4.4. Disallowing Entity Combinations ....................................................................... 8 1.4.4.1. Specifying Expression Entities ................................................................ 9 1.4.4.2. Operators .............................................................................................. 12 1.4.5. Identifying Object Modules .............................................................................. 13 1.5. Processing Command Definition Files ......................................................................... 14 1.5.1. Adding Command Definitions to a Command Table .......................................... 14 1.5.2. Deleting Command Definitions ........................................................................ 14 1.5.3. Creating Object Modules ................................................................................. 15 1.5.4. Creating New Command Tables ....................................................................... 15 1.6. Using Command Language Routines ........................................................................... 16 1.6.1. CDU Usage Summary ..................................................................................... 16 1.6.2. CDU File Statements ....................................................................................... 17 1.6.3. CDU Qualifiers ............................................................................................... 32 1.6.4. CDU Examples ............................................................................................... 38 Chapter 2. Librarian Utility ............................................................................................... 43 2.1. LIBRARIAN Description ........................................................................................... 43 2.1.1. Types of Libraries ........................................................................................... 43 2.1.2. Structure of Libraries ....................................................................................... 44 2.1.3. Character Case of Library Keys ....................................................................... 45 2.1.4. Shareable Image Libraries ................................................................................ 45 2.1.5. Help Libraries ................................................................................................. 46 2.1.5.1. Creating Help Files ............................................................................... 46 2.1.5.2. Formatting Help Files ........................................................................... 47 2.1.5.3. Help Text Example ............................................................................... 48 2.1.5.4. Retrieving Help Text ............................................................................. 50 2.1.6. Using the Librarian Utility to Save Disk Space ................................................. 52 2.1.7. Librarian Utility (LBR) Routines ...................................................................... 52 2.1.8. LIBRARIAN Usage Summary ......................................................................... 52 iii Command Definition, Librarian, and Message Utilities 2.1.9. LIBRARIAN Qualifiers ................................................................................... 54 Chapter 3. Message Utility ................................................................................................. 77 3.1. MESSAGE Description .............................................................................................. 77 3.1.1. Message Format .............................................................................................. 77 3.1.2. Constructing Messages ..................................................................................... 78 3.1.2.1. The Message Source File ...................................................................... 78 3.1.2.2. Compiling the Message Source File ....................................................... 79 3.1.2.3. Linking the Message Object Module ...................................................... 79 3.1.3. Using Message Pointers ................................................................................... 80 3.1.4. The SET MESSAGE Command ....................................................................... 81 3.1.5. Message Source Files ...................................................................................... 82 3.1.6. MESSAGE Usage Summary ............................................................................ 83 3.1.7. MESSAGE Qualifiers ...................................................................................... 84 3.1.8. MESSAGE Commands .................................................................................... 87 3.1.9. MESSAGE Examples ...................................................................................... 97 iv Preface 1. About VSI VMS Software,