Digital PDFs

AI-Y516A-TE

April 1986

322 pages

Original

25MB

Document:	VMS 4.4 VAX VMS Mini-Reference
Order Number:	AI-Y516A-TE
Revision:
Pages:	322
Original Filename:	https://archive.org/download/stx_AI-Y516A-TE_VMS_4.4_VAX_VMS_Mini-Reference_Apr86/AI-Y516A-TE_VMS_4.4_VAX_VMS_Mini-Reference_Apr86.pdf

OCR Text

nee

VAX/VMS

Mini-Refe

VAX/VMS
Mini-Reference
Order Number: AI-Y516A-TE

April 1986
This manual provides quick-reference information on VAX/VMS DCL
commands and lexical functions, utilities, text editors and formatters, and
callable system routines.

Revison/Update Information:

This is a new manual.

Software Version:

VAX/VMS Version 4.4

digital equipment corporation
maynard, massachusetts

April 1986
The information in this document is subject to change without notice and should not
be construed as a commitment by Digital Equipment Corporation. Digital Equipment
Corporation assumes no responsibility for any errors that may appear in this document.
The software described in this document is furnished under a license and may be used or
copied only in accordance with the terms of such license.
No responsibility is assumed for the use or reliability of software on equipment that is not
supplied by Digital Equipment Corporation or its affiliated companies.
Copyright ©1986 by Digital Equipment Corporation
All Rights Reserved.
Printed in U.S.A.
The postpaid READER'S COMMENTS form on the last page of this document requests the
user's critical evaluation to assist in preparing future documentation.
The following are trademarks of Digital Equipment Corporation:
DEC
DEC/CMS
DEC/MMS
DECnet
DECsystem-10
DECSYSTEM-20
DECUS
DECwriter

DIBOL
EduSystem
IAS
MASSBUS
PDF
PDT
RSTS
RSX

UNIBUS
VAX
VAXcluster
VMS
VT

smma
ZK-3208

HOW TO ORDER ADDITIONAL DOCUMENTATION
DIRECT MAIL ORDERS
USA & PUERTO RICO*

CANADA

INTERNATIONAL

Digital Equipment Corporation
P.O. Box CS2008
Nashua, New Hampshire
03061

Digital Equipment
of Canada Ltd.
100 Herzberg Road
Kanata, Ontario K2K 2A6
Attn: Direct Order Desk

Digital Equipment Corporation
PSG Business Manager
c/o Digital’s local subsidiary
or approved distributor

In Continental USA and Puerto Rico call 800-258-1710.
In New Hampshire, Alaska, and Hawaii call 603-884-6660.
In Canada call 800-267-6215.
*Any prepaid order from Puerto Rico must be placed with the local Digital subsidiary (809-754-7575).
Internal orders should be placed through the Software Distribution Center (SDC), Digital Equipment Corporation,
Westminster, Massachusetts 01473.
This document was prepared using an in-house documentation production system. All page composition and
make-up was performed by T^X, the typesetting system developed by Donald E. Knuth at Stanford University.
T^X is a registered trademark of the American Mathematical Society.

Contents
Preface

vii

General Information
GEN.l

Getting Help.

GEN-1

GEN.2

Terminal Function Keys.

GEN-2

GEN.3

Line Editing Terminal Function Keys.

GEN-3

GEN.4
GEN.4.1
GEN.4.2

File Specification Format.
File Specification Defaults.
Default File Types.

GEN-4
GEN-5
GEN-5

GEN.5

Device Names.

GEN-7

GEN.6

Process Privileges.

GEN-8

GEN.7

Resource Quotas.

GEN-10

DCL Commands, Utilities, and
Lexical Functions
EOT Editor
EDT.l

Summary of EDT.

EDT-1

EDT.2
EDT.2.1

Keypad Mode .
EDT Keypad Functions.

EDT-3
EDT-5

EDT.3
EDT.3.1
EDT.3.2
EDT.3.3

Line Mode .
Line Mode Commands.
Line Mode Qualifiers.
Line Mode Specifiers.

EDT-10
EDT-10
EDT-13
EDT-14

EDT.4
EDT.4.1
EDT.4.2

Nokeypad Mode.
Nokeypad Commands.
Nokeypad Specifiers.

EDT-16
EDT-17
EDT-22

Contents

EDT.5

The SET and SHOW Commands.

EDT-24

EOT.6

The Journal Facility.

EDT-28

EDT.7

Startup Command Files.

EDT-29

EDT.8

Defining Keys.

EDT-30

EDT.9

EDT Macros

EDT-32

VAX Text Processing Utility
VAXTPU.l

Data Types.VAXTPU-1

VAXTPU.2

Built-In Procedures.VAXTPU-2

VAXTPU.3

Global Variables for Built-In Procedures .... VAXTPU-12

VAXTPU.4

Information Returned with Built-In Procedure
GET_INFO.VAXTPU-13

DIGITAL Standard Runoff
DSR.l

DSR Commands.

DSR-1

DSR.2

DSR Flags.

DSR-13

DSR.3
DSR.3.1
DSR.3.2

RUNOFF Command Line Format.
Default File Types for Output.
Command Line Qualifiers.

DSR-16
DSR-16
DSR-17

DSR.4

/INDEX Command Line Qualifiers.

DSR-20

DSR.5

/CONTENTS Command Line Qualifiers

. . .

DSR-21

DSR.6

Producing an Index.

DSR-22

DSR. 7

Producing a Table of Contents.

DSR-23

Introduction to System Routines
System Services

Contents

Run-Time Library Routines
Callable Utility Routines
VAX Record Management
Services
RMS.l

RMS Control Blocks

RMS-1

RMS.2

RMS Control Block Macros.

RMS-10

RMS.3

RMS Services.

RMS-17

System Management, Operations,
and Programming Tools
MISC.l

"How-To" Instructions for Useful Tasks ....

MISC-1

MISC.2
MISC.2.1
MISC.2.2
MISC.2.3
MISC.2.4
MISC.2.5
MISC.2.6
MISC.2.7

Utilities Without DCL Commands.
RUN AUTHORIZE.
DELTA Debugger.
RUN SYS$SYSTEM:DISKQUOTA.
$ RUN SYS$SYSTEM:DTSEND.
INSTALL.
RUN SYS$SYSTEM:NCP.
RUN SYS$SYSTEM:SYSGEN .

MISC-2
MISC-2
MISC-5
MISC-6
MISC-6
MISC-7
MISC-9
MISC-10

DCL-1
EDT-1

Mail Utility Default Keypad Definitions ....
EDT Default Keypad Editing Keys.

DCL-35
EDT-4

GEN-1
GEN-2
GEN-3
GEN-4
GEN-5
GEN-6
GEN-7

Terminal Function Keys.
Line Editing Terminal Function Keys .
File Specification Defaults .
Default File Types .
Device Types .
Process Privileges
.
Resource Quotas .

GEN-2
GEN-3
GEN-5
GEN-5
GEN-7
GEN-8
GEN-10

Figures

Tables

Contents

EDT-l
EDT-2
VAXTPU-1

The Range Specifier .
EDT-15
The Entity Specifier .
EDT-23
GET_INFO - Using a Variable as Parameterl
.VAXTPU-13
VAXTPU-2 GET_INFO - Using a Keyword as Parameterl
.VAXTPU-19
DSR-1
DSR Flags .
DSR-14
RMS-1
FAB Fields .
RMS-1
RMS-2
NAM Block Fields .
RMS-3
RMS-3
RAB Fields.
RMS-4
RMS-4
XABALL Fields .
RMS-5
RMS-5
XABDAT Fields .
RMS-6
RMS-6
XABFHC Fields .
RMS-6
RMS-7
XABKEY Fields .
RMS-7
RMS-8
XABPRO Fields .
RMS-8
RMS-9
XABRDT Fields .
RMS-9
RMS-10
XABSUM Fields.
RMS-10
RMS-11
XABTRM Fields.
RMS-10

Preface
Intended Audience
This manual is intended for all system users. In most cases, this manual provides
only selected and abbreviated information; thus, it assumes that you are familiar with
the basic concepts and conventions associated with any information you look up.

Structure of This Document
This manual consists of sections documenting major parts of the system. The
progression is roughly from general interest information, to programmer-oriented
information, to system management and other information. The sections are
organized as follows:

General Information: GEN
DCL Commands, Utilities, Lexical Functions: DCL
Text Editors and Formatters:
EDT (EDT Editor)
VAXTPU (VAX Text Processing Utility)
DSR (DIGITAL Standard Runoff)
Programming Information:
SYS (System Services)
RTL (Run-Time Library)
UTIL (Callable Utility Routines)
RMS (VAX Record Management Services)
System Management, Operations, Programming Tools:
MISC (includes utilities without their own DCL commands)

viii

Preface

Associated Documents
Complete documentation on the features included in this manual, including
conceptual background information, is in the appropriate reference manuals in the
complete VAX/VMS document set. The following manuals are particularly useful:
•

Introduction to the VAX/VMS Document Set

•

VAX/VMS DCL Concepts Manual

•

VAX/VMS DCL Dictionary

•

VAX EDT Reference Manual

•

VAX DIGITAL Standard Runoff (DSR) Reference Manual

•

VAX Text Processing Utility Reference Manual

•

Introduction to VAX/VMS System Routines

•

VAX/VMS System Services Reference Manual

•

VAX/VMS Run-Time Library Routines Reference Manual

•

VAX/VMS Utility Routines Reference Manual

•

VAX Record Management Services Reference Manual

•

Manuals documenting VAX/VMS utilities that have interactive commands (Mail,
Monitor, etc.)

This comprehensive Mini-Reference supersedes the following quick-reference
booklets:
•

VAX/VMS DCL Commands and Lexical Functions

•

VAX EDT Quick Reference Guide

•

VAX DSR Quick Reference Guide

•

VAX/VMS System Services and Run-Time Library Routines

The following conventions are observed in this manual:
Convention

Meaning

[RETj

A symbol with a one- to six-character abbreviatio
indicates that you press a key on the terminal, f
example, |RET| .

|CTRL/xl

The phrase CTRL/x indicates that you must press
labeled CTRL while you simultaneously press an
key, for example, CTRL/C, CTRL/Y, CTRL/O.

$ SHOW TIME
05-JUN-1986 11:55:22

Command examples show all output lines or pro
characters that the system prints or displays in b
letters. All user-entered commands are shown in
letters.

$ TYPE MYFILE.DAT

Vertical series of periods, or ellipsis, mean either
all the data that the system would display in resp
the particular command is shown or that not all
a user would enter is shown.

file-spec, . . .

Horizontal ellipsis indicates that additional param
values, or information can be entered.

[logical-name]

Square brackets indicate that the enclosed item is
(Square brackets are not, however, optional in the
of a directory name in a file specification or in th
of a substring specification in an assignment state

quotation marks

Refer to double quotation marks (”). The term ap
(') is used to refer to a single quotation mark.

General

General Information
GEN.1

Getting Help

You can get help at the DCL level (dollar sign ($) prompt) on a variety of top
example:
Command

Display

HELP

List of topics about which you can request help.

HELP COPY

Information about the DCL command COPY.

HELP COPY/LOG

Information about the /LOG qualifier of the COPY comm

HELP SYSTEM

List of system services about which you can request help.

HELP RTL

List of classes of Run-Time Library routines; you can requ
detailed information.

You can also type HELP at the prompt for many interactive utilities (for exa
MAIL and PHONE).

Table GEN-1

Terminal Function Keys

Key

Function

RETURN

Transmits the current line to the system for processing. (On some
terminals, the RETURN key is labeled CR.)
Before a terminal session, initiates login sequence.

CTRL/B or
Up arrow

Displays the last command line issued. If pressed again, displays
the previous command in the recall buffer. The recall buffer stores
the 20 most recently issued commands.

CTRL/C or

During command entry, cancels command processing. CTRL/C is
displayed as "Cancel".

F6l

Certain applications enable CTRL/C as the cancel key. For
these applications, CTRL/C cancels the operation in progress. If
CTRL/C is not enabled, then the action is changed to an interrupt
(CTRL/Y).
CTRL/I

Duplicates the function of the TAB key.

CTRL/K

Advances the current line to the next vertical tab stop.

CTRL/L

Causes the terminal to go to the beginning of the next page. This
use of CTRL/L is ignored when the line editing characteristic is
enabled.

CTRL/O

Alternately suppresses and continues display of output to the
terminal. CTRL/O is displayed as "Output off" and "Output on".

CTRL/Q

Resumes terminal output that was suspended by CTRL/S.

CTRL/R

Retypes the current input line and leaves the cursor positioned at
the end of the line.

CTRL/S

Suspends terminal output until CTRL/Q is pressed.

CTRL/T

Momentarily interrupts terminal output to display a line of
statistical information about the current process. SET CONTROL=T
must be specified in the systemwide login command file, or by the
user (in LOGIN.COM or interactively). The display includes your
node and user name, the time, the name of the image you are
running, and information about system resources you have used
during your current terminal session.

CTRL/U

Discards from start of line to (but not including) current position
on the current input line.

^This key is available only on an LK201 keyboard.

Key

Function

CTRL/X

Discards from start of line to (but not including) the curre
position on the current line, and deletes data in the typebuffer.

CTRL/Y

During command entry, interrupts command processing. C
echoes as "Interrupt". You can disable CTRL/Y with the c
SET NOCONTROL=Y.

Under most conditions, CTRL/Y will return the user to th
prompt. The program running will still be active. You ca
any of the commands performed within the command int
(see table in the VAX/VMS DCL Concepts Manual), and th
continue the program by entering the CONTINUE comma
CTRL/Z or
FlQl

Signals the end of the file for data entered from the term
CTRL/Z is displayed as "Exit".

DELETE

Deletes the last character entered at the terminal. (On so
terminals, the DELETE key is labeled DEL or RUBOUT.)

TAB

Moves the printing element or cursor on the terminal to t
tab stop on the terminal. The system provides tab stops a
eighth character position on a line. Tab settings are hardw
terminal characteristics that can generally be modified by

Down arrow

Displays the next line in the recall buffer.

This key is available only on an LK201 keyboard.

GEN.3 Line Editing Terminal Function Keys
Table GEN-2

Line Editing Terminal Function Keys

Key

Function

CTRL/A or
FI4I

Switches between overstrike mode and insert mode. The
mode (as set with SET TERMINAL/LINE—EDIT) is reset
beginning of each line.

CTRL/D or
Left arrow

Moves the cursor one character to the left.

^This key is available only on an LK201 keyboard.

Key

Function

CTRL/E

Moves the cursor to the end of the line.

CTRL/F or
Right arrow

Moves the cursor one character to the right.

CTRL/H or
BACKSPACE or
FI2I

Moves the cursor to the beginning of the line.

CTRL/J or
LINEFEED or
FI3I

Deletes the word to the left of the cursor.

CTRL/U

Deletes characters from the beginning of the line to the cursor.
(This overrides the standard CTRL/U function, which discards the
current input line.)

CTRL/V

Allows you to enter one of the line editing function keys without
the key performing its line editing function. CTRL/V acts as a
quote character, allowing you to input a control character without
having the terminal interpret the character.

F7,F8,F9,F11

Reserved to DIGITAL

This key is available only on an LK201 keyboard.

GEN.4 File Specification Format
node::device:[directory]file-name.type;version
Example:
BOSTON::WORKS:[SMITH]VERIFY_INPUT_DATA.F0R;7

Table GEN-3

File Specification Defaults

Field

Defaults

node

The system assumes that the device is on the local system.

device

The system uses the device (usually a disk) established at log
by the SET DEFAULT command. Devices are usually identif
logical names.

If a physical device name is used and a controller designatio
omitted, the controller designation defaults to A. If a unit nu
omitted, the unit number defaults to 0. (The ALLOCATE, M
and SHOW DEVICES commands, however, treat a device na
does not contain controller and/or unit numbers as a generic
name.) For more details, see the discussions of these comma
the VAX/VMS DCL Dictionary.
directory

The system uses the directory name established at login or by
DEFAULT command.

file-name

No defaults are applied to the first file name in an input fil
specification. Most commands apply default output file name
on the file name of an input file.

type

Various commands apply defaults for file types, based on the
file type conventions summarized in Table GEN-4.

version

For input files, the system assumes the highest version numb

For output files, if no file with the specified file name and fil
exists in the current directory, the file is created with a versi
number of 1. However, if one or more versions do exist, the
file's version number is one higher than the current highest
number.

GEN.4.2 Default File Types
Table GEN-4

Default File Types

File Type

Contents

ANL

Output file for the ANALYZE command

BJL

BACKUP journal file

CLD

Command description file

File Type

Contents

COM

Command procedure file to be executed with the @ (Execute Procedure)
command, or to be submitted for batch execution with the SUBMIT
command

DAT

Input or output data file

DIF

Output listing created by the DIFFERENCES command

DIR

Directory file

DIS

Distribution list file for the MAIL command

DMP

Output listing created by the DUMP command

EDT

Initialization command input file for the EDT Editor

EXE

Image file created by the VAX/VMS Linker

FDL

File definition language file

HLB

Help text library file

HLP

Input source file for help libraries

INI

Initialization file

JNL

Journal file created by the VAX/VMS Patch Utility

JOU

Journal file created by the EDT Editor

LIS

Listing file created by a language compiler or assembler; default input file
type for PRINT and TYPE commands

LOG

Batch job output file

MAI

Mail message file

MAP

Memory allocation map created by the VAX/VMS Linker

MAR

Input source file for the VAX MACRO assembler

MEM

Output file for DIGITAL Standard Runoff

MLB

Macro library for the VAX MACRO assembler

MSG

Source file that specifies the text of messages

OBJ

Object file created by a language compiler or assembler

OLB

Object module library

OPT

Options file for input to the LINK command

PAR

SYSGEN parameter file

RNO

Input source file for DIGITAL Standard Runoff

STB

Symbol table file created by the VAX/VMS Linker

SYS

System image

TEC

TECO indirect command file

TJL

Journal file created by the VAXTPU and ACL editors

File Type

Contents

TLB

Text library

TMP

Temporary file

TPU

Command file for the VAXTPU Editor

TXT

Input file for text libraries or MAIL command output

UPD

Update file of changes for a VAX MACRO source program; also inp
SUMSLP Editor

GEN.5 Device Names
Table GEN-5

Device Types

Code

Device Type

Card reader

Console storage device

RC25 cartridge disk

RP05, RP06 disk

TU58 cartridge tape

RA60 Disk

RL02 cartridge disk

RK06, RK07 cartridge disk

RL02 cartridge disk, R80 disk (730 IDC only)

RM03, RM05, RM80, RP07 disk

RA80, RA81 disk

RXOl floppy diskette

RX02 floppy diskette

LPAll-K laboratory peripheral accelerator

Line printer on DMF32

Line printer on LPll

Local area terminal

Mailbox

TU78 magnetic tape

Code

Device Type

TSll magnetic tape

TE16, TU45, TU77 magnetic tape

TA78, TA81, TK50, TU81 magnetic tape

NET

Network communications logical device

System "null" device

Operator's console

Remote terminal

Interactive terminal

Virtual terminal

DRll-W general purpose DMA interface

DMPll synchronous communications line

DEUNA synchronous communications line

DR32 interface adapter

DMF32 synchronous communications line

DUPll synchronous communications line

DMCll synchronous communications line

DEQNA synchronous communications line

GEN.6 Process Privileges
Table GEN-6

Process Privileges

Privilege

Allows [Disallows] Process to

[NOJACNT

Create processes for which no accounting messages are written

[NO]ALL

Have all process privileges

[NOJALLSPOOL

Allocate spooled devices

[NOJALTPRI

Set priority values

[NO]BUGCHK

Make bugcheck error log entries

[NOJBYPASS

Bypass UIC protection

General Information

gen-9

Process Privileges

Table GEN-6 (Cont.)

Process Privileges

Privilege

Allows [Disallows] Process to

[NO]CMEXEC

Change its mode to executive

[NO]CMKRNL

Change its mode to kernel

[NO]DETACH

Create detached processes

[NO]DIAGNOSE

Issue diagnostic I/O requests

[NO]EXQUOTA

Exceed its quotas

[NO]GROUP

Control other processes in the same group

[NO]GRPNAM

Place names in the group logical name table

[NO]GRPPRV

Access files in its own group with all the access rights granted to the
system category of user for those files

[NO]LOG_IO

Issue logical I/O requests to a device

[NO]MOUNT

Issue a mount volume QIO request

[NOJNETMBX

Create a network device

[NO]OPER

Perform operator functions

[NOJPFNMAP

Create or delete sections mapped by page frame number

[NO]PHY_IO

Issue physical I/O requests to a device

[NOJPRMCEB

Create permanent common event flag clusters

[NO]PRMGBL

Create permanent global sections

[NO]PRMMBX

Create permanent mailboxes

[NO]PSWAPM

Alter its swap mode

[NO]READALL

Bypass existing restrictions that would otherwise prevent the process
from reading a file

[NO]SECURITY

Perform security-related functions such as enabling or disabling security
audits or setting the system password

[NOJSETPRV

Give higher privileges to other processes

[NO]SHARE

Assign a channel to a device, even if the channel is allocated to another
process or subprocess

[NOJSHMEM

Create or delete data structures in shared memory

[NO]SYSGBL

Create system global sections

[NO]SYSLCK

Request locks on systemwide resources

[NO]SYSNAM

Place names in the system logical name table

[NOJSYSPRV

Access files and other resources as if the user has a system UIC

[NO]TMPMBX

Create temporary mailboxes

[NO]VOLPRO

Override volume protection

[NO]WORLD

Affect processes outside the user's group

GEN.7 Resource Quotas
Table GEN-7

Resource Quotas

Name

Quota

ASTLM

AST (asynchronous system trap) limit

BIOLM

Buffered I/O limit

BYTLM

Buffered I/O byte count (buffer space) quota

CPUTIME

CPU time limit

DIOLM

Direct I/O limit

ENQLM

Enqueue limit

FILLM

Open file quota

JTQUOTA

Initial byte quota for job logical name table

MAXACCTJOBS

Maximum active processes for an account

MAXDETACH

Maximum detached processes for a user name

MAXJOBS

Maximum active processes for a user name

PGFLQUOTA

Paging file quota

PRCLM

Subprocess quota

SHRFILLM

Maximum number of open shared files

TQELM

Timer queue entry quota

WSDEFAULT

Default working set size

WSEXTENT

Working set extent quota

WSQUOTA

Working set size quota

Text
Processing

DCL Commands, Utilities, and Lexical Functions
This section lists DCL commands, with their parameters and qualifiers. For those
DCL commands invoking utilities that have their own interactive commands (for
example, MAIL), the utility's commands are listed also. For certain commands, other
information is provided.
Lexical functions are listed as F$... entries.
Utilities that do not have their own DCL commands, but are instead invoked by the
RUN command (for example, SYSGEN), are listed in the last section of this manual,
"System Management, Operations, and Programming Tools."

symbol-name =[=] expression
symbol-name[bit-position,size] =[=] replacement-expression
symbol-name :=[=] string
symbol-name[offset,size] :=[=] replacement-string
@file-spec [pi [p2 [... p8]]]
/OUTPUT=file-spec
ACCOUNTING file-spec[,...]
/ACCOUNT=(["-",]account-name[,...])
/NOACCOUNT (default)
/ADDRESS=(["-",]node-address[,...])
/NOADDRESS (default)
/BEFORE[=time]
/NOBEFORE (default)
/BINARY
/NOBINARY (default)
/ENTRY=(["-",]queue-entry[,...])
/NOENTRY (default)
/FULL
/NOFULL (default)
/IDENTIFICATION=(["-",]process-id[,...])
/NOIDENTIFICATION (default)
/IMAGE=(["-",]image-name[,...])
/NOIMAGE (default)
/JOB=(["-",]job-name[,...])
/NOJOB (default)
/LOG
/NOLOG (default)
/NODE=(["-",]node-name[,...])
/NONODE (default)

DCL-2

DCL Commands, Utilities, and Lexical Functions

/OUTPUT[=file-spec]
/NOOUTPUT
/OWNER=(["-",]owner-process-id[,...])
/NOOWNER (default)
/PRIORITY=(["-",]priority[,...])
/NOPRIORITY (default)
/PROCESS=(["-",]process-type[,...])
/NOPROCESS (default)
/QUEUE=(["-",]queue-name[,...])
/NOQUEUE (default)
/REJECTED[=file-spec]
/NOREJECTED (default)
/REMOTE_lI>=(["-",]remote-id[,...])
/NOREMOTE_ID (default)
/REPORT[=(report-itein[,...])]
/NOREPORT (default)
/SINCE[=time]
/NOSINCE (default)
/SORT[=([-]sort-item[,...])
/NOSORT (default)
/STATUS=(["-",]exit-status[,...])
/NOSTATUS (default)
/SUMMARY=(summary-item[,...])
/NOSUMMARY (default)
/TERMINAL=(["-",]tenninal-name[,...])
/NOTERMINAL (default)
/TlTLE=title
/NOTITLE (default)
/TYPE=(["-",]record-type[,...])
/NOTYPE (default)
/UIC=(["-",]uic[,...])
/NOUIC (default)
/USER=(["-",]user-name[,...])
/NOUSER (default)
ALLOCATE device-name[:][,...] [logical-name[:]]
/GENERIC
/NOGENERIC (default)
/LOG (default)
/NOLOG
ANALYZE/CRASH_DUMP file-spec
/CRASH_DUMP
/RELEASE
/SYSTEM
/SYMBOL[=file-spec]
Interactive Commands: See ANALYZE/SYSTEM for SDA commands.
ANALYZE/DISK-STRUCTURE device-name:
/CONFIRM
/NOCONFIRM (default)
/LIST[=file-spec]
/NOLIST (default)
/READ-CHECK
/NOREAD_CHECK (default)
/REPAIR
/NOREPAIR (default)
/USAGE[=file-spec]
ANALYZE/ERROR_LOG [file-spec[,...]]
/BEFORE[=time]
/BINARY[=file-spec]
/NOBINARY
/BRIEF
/ENTRY[=(start:decimal-value[,end:decimal-value])]
/EXCLUDE=(device or entry-type[,...])
/FULL
/NOFULL

DCL Commands, Utilities, and Lexical Functions

/INCLUDE=(device or entry-type[,...])
/INTERACTIVE _MODE
/NOINTER ACTIVE _MODE
/LOG
/NOLOG
/OUTPUT[=file-spec]
/PAGE
/NOPAGE
/REGISTER_DUMP
/REJECTED[=file-spec]
/SID_REGISTER[=%Xhexadecimal-value]
/SINCE[=time]
/STATISTICS
/SUMM ARY[=summary-type[,...]]
/UNKNOWN
ANALYZE/IMAGE file-spec [,...]
/FIXUP-SECTION
/GST
/HEADER
/INTERACTIVE
/NOINTERACTIVE (default)
/OUTPUT=file-spec
/PATCH_TEXT
ANALYZE/MEDIA device
/BAD_BLOCKS=[list]
/EXERCISE=(FULL,[NO]KEEP,PATTERN)
/LOG
/NOLOG (default)
/OUTPUT[=file-spec]
/RETRY
/NORETRY (default)
/SHOW

/NOEXERCISE (default)

ANALYZE/OBJECT file-spec[,...]
/DBG
/EOM
/GSD
/INCLUDE[=(module[,...])]
/INTERACTIVE
/NOINTERACTIVE (default)
/LNK
/MHD
/OUTPUT[=file-spec]
/TBT
/TIR
ANALYZE/PROCESS-DUMP dump-file
/FULL
/IMAGE=image-name

/NOIMAGE

dcl-3

DCL-4

DCL Commands, Utilities, and Lexical Functions

/INTERACTIVE
/NOINTERACTIVE (default)
/MISCELLANEOUS
/OUTPUT=file-spec
/RELOCATION
ANALYZE/RMS_FILE file-spec[,...]
/CHECK
/FDL
/INTERACTIVE
/OUTPUT=file-spec
/STATISTICS
/SUMMARY

/NOOUTPUT

Interactive Commands:
AGAIN
BACK [n]
DOWN [branch]
DUMP n
EXIT
FIRST
HELP [keyword...]
NEXT [n]
POSITION/BUCKET bucket-vbn [/INDEX=n]
POSITION/RECORD record-offset
REST
TOP
UP
ANALYZE/SYSTEM
Interactive Commands:
@ (Execute Procedure)
ATTACH
/PARENT
COPY
DEFINE
/ECHO
/IF_STATE
/KEY
/SET_STATE=state_name
/TERMINATE

DCL Commands, Utilities, and Lexical Functions

EVALUATE
/CONDITION-VALUE
/PSL
/PTE
/SYMBOLS
EXAMINE
/ALL
/CONDITION -VALUE
/INSTRUCTION
/NOSKIP
/NOSUPPRESS
/PO
/PI
/PSL
/PTE
/SYSTEM
/TIME
EXIT
FORMAT
/TYPE=block_type
HELP
READ
/RELOCATE=expression
REPEAT
SEARCH
/LENGTH=Iength_specifier
/STEPS=step_factor
SET LOG
SET OUTPUT
SET PROCESS
/INDEX=index —value
/SYSTEM
SET RMS
SHOW CLUSTER
/CSID=n

/scs
SHOW CONNECTIONS
/ADDRESS=n
SHOW CRASH
SHOW DEVICE
/ADDRESS=n
SHOW HEADER
SHOW LOCK
/ALL

DCL-5

OCL-6

DCL Commands, Utilities, and Lexical Functions

SHOW PAGE-TABLE
/GLOBAL
/SYSTEM
/ALL
SHOW PEN-DATA
/ALL
/BAD
/FREE
/MODIFIED
/SYSTEM
SHOW POOL
/ALL
/FREE
/HEADER
/IRP
/LRP
/NONPAGED
/PAGED
/SRP
/SUMMARY
/TYPE=block—type
SHOW PORTS
/ADDRESS=n
SHOW PROCESS
/ALL
/CHANNEL
/INDEX=nn
/LOCKS
/PO
/PI
/PAGE-TABLES
/PCB
/PHD
/PROCESS-SECTION-TABLE
/REGISTERS
/RMS=option
/SYSTEM
/WORKING-SET
SHOW RESOURCE
/ALL
/LOCKID=nn
SHOW RMS
SHOW RSPID
/CONNECTION=n

DCL Commands, Utilities, and Lexical Functions

SHOW STACK
/ALL
/EXECUTIVE
/INTERRUPT
/KERNEL
/SUPERVISOR
/USER
SHOW SUMMARY
/IMAGE
SHOW SYMBOL
/ALL
SPAWN
/INPUT=fiIespec
/NOLOGICAL -NAMES
/NOSYMBOLS
/NOTIFY
/NOWAIT
/OUTPUT=filespec
/PROCESS=process_name
VALIDATE QUEUE
/SELF-RELATIVE
APPEND input-file-spec[,...] output-file-spec
/ALLOCATION=n
/BACKUP
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CONTIGUOUS
/NOCONTIGUOUS
/CREATED (default)
/EXCLUDE=(file-spec[,...])
/EXPIRED
/EXTENSION=n
/LOG
/NOLOG (default)
/MODIFIED
/NEW_VERSION
/NONEW_VERSION (default)
/PROTECTION=(code)
/READ_CHECK
/NOREAD_CHECK (default)
/SINCE[=time]
/WRITE_CHECK
/NO WRITE-CHECK (default)
ASSIGN equivalence-name[,...] logical-name[:]
/EXECUTIVE-MODE
/GROUP

DCL-7

DCL-8

DCL Commands, Utilities, and Lexical Functions

/JOB
/LOG (default)
/NOLOG
/NAME_ATTRIBUTES[=(keyword[,...])]
/PROCESS (default)
/SUPERVISOR-MODE (default)
/SYSTEM
/TABLE=name
/TRANSLAT10N_ATTRlBUTES[=(keyword[,...])]
/USER_MODE
ASSIGN/MERGE target-queue[:] source-queue[:]
ASSIGN/QUEUE queue-name[;] logical-queue-naine[:]
ATTACH [process-name]
/lDENTlFlCAT10N=pid
BACKUP input-specifier output-specifier
/BACKUP
/BEFORE=time
/BLOCK_SIZE=n
/BRIEF
/BUFFER_COUNT=n
/COMMENT=string
/COMPARE
/CONFIRM
/CRC (default)
/NOCRC
/CREATED
/DELETE
/DENSITY=n
/EXCLUDE=(file-spec[,...])
/EXPIRED
/FAST
/FULL
/GROUP_SlZE=n
/IGNORE=option
/IMAGE
/INCREMENTAL
/INITIALIZE
/NOINITIALIZE (default)
/INTERCHANGE
/JOURNAL[=file-spec]
/LABEL=(string[,...])
/LIST[=file-spec]
/LOG
/NOLOG (default)
/MODIFIED

DCL Commands, Utilities, and Lexical Functions

/NEW_VERSION
/OVERLAY
/OWNER_UIC[=[uic]]
/PHYSICAL
/PROTECTION[=(code)]
/RECORD
/REPLACE
/REWIND
/NOREWIND (default)
/SAVE-SET
/SELECT=(fiIe-spec[,...])
/SINCE=time
/TRUNCATE
/NOTRUNCATE (default)
/VERIFY
/VOLUME=n
CALL label [pl[p2[... p8]]]
/OUTPUT=file-spec
CANCEL [process-name]
/IDENTIFICATION=pid
CLOSE logical-name[:]
/ERROR=label
/LOG (default)

/NOLOG

CONNECT virtual-terminal-name
/CONTINUE
/NOCONTINUE (default)
/LOGOUT (default)
/NOLOGOUT
CONTINUE
CONVERT input-file-spec[,...] output-file-spec
/APPEND
/NOAPPEND
/CREATE
/NOCREATE
/EXCEPTIONS_FILE[=file-spec]
/NOEXCEPTIONS_FILE
/EXIT
/NOEXIT
/FAST-LOAD
/NOFAST_LOAD
/FDL=file-spec
/FILL-BUCKETS
/NOFILL-BUCKETS
/FIXED-CONTROL
/NOFIXED-CONTROL
/KEY[=n]
/MERGE
/PAD[=[%b]x]
/NOPAD
/PROLOG=n

dcl-9

DCL-10

DCL Commands, Utilities, and Lexical Functions

/READ_CHECK
/NOREAD_CHECK
/SHARE
/NOSHARE
/SORT
/NOSORT
/STATISTICS
/NOSTATISTICS
/TRUNCATE
/NOTRUNCATE
/WORK_FILES=n
/WRITE-CHECK
/NOWRITE-CHECK
CONVERT/RECLAIM file-spec
/STATISTICS

/NOSTATISTICS

COPY input-file-spec[,...] output-file-spec
/ALLOCATION=n
/BACKUP
/BEFORE[=time]
/BY_OWNER[=uic]
/CONCATENATE (default)
/NOCONCATENATE
/CONFIRM
/NOCONFIRM (default)
/CONTIGUOUS
/NOCONTIGUOUS
/CREATED (default)
/EXCLUDE=(file-spec[,...])
/EXPIRED
/EXTENSION=n
/LOG
/NOLOG (default)
/MODIFIED
/OVERLAY
/NOOVERLAY (default)
/PROTECTION=(code)
/READ-CHECK
/NOREAD-CHECK (default)
/REPLACE
/NOREPLACE (default)
/SINCE[=time]
/TRUNCATE
/NOTRUNCATE (default)
/VOLUME=n
/WRITE-CHECK
/NO WRITE-CHECK (default)
CREATE file-spec[,...]
/LOG
/NOLOG (default)
/OWNER-UIC=uic
/PROTECTION=(code)
/VOLUME=n
CREATE/DIRECTORY directory-spec[,...]
/LOG
/NOLOG (default)
/OWNER-UIC[=option]
/PROTECTION=(code)

DCL Commands, Utilities, and Lexical Functions

/VERSION _LIMIT=n
/VOLUME=n
CREATE/FDL=fdl-file-spec [file-spec]
/LOG

/NOLOG

CREATE/NAME-TABLE table-name
/ ATTRIBUTES[-(key word[,...])]
/EXECUTIVE-MODE
/LOG
/NOLOG (default)
/PARENT_TABLE=table
/PROTECTION
/QUOTA=bytes
/SUPERVISOR-MODE (default)
/USER-MODE
DEALLOCATE device-name[:]
/ALL
DEASSIGN [logical-name[:]]
/ALL
/EXECUTIVE-MODE
/GROUP
/JOB
/PROCESS (default)
/SUPERVISOR-MODE (default)
/SYSTEM
/TABLE=name
/USER-MODE
DEASSIGN/QUEUE logical-queue-name[:]
DEBUG
Interactive Commands:
ALLOCATE
@filespec
ATTACH
CALL
/[NOjAST
CANCEL ALL

DCL-11

DCL-12

DCL Commands, Utilities, and Lexical Functions

CANCEL BREAK
/ALL
/BRANCH
/CALL
/EVENT=event-name
/EXCEPTION
/INSTRUCTION
/LINE
CANCEL DISPLAY
/ALL
CANCEL EXCEPTION BREAK
CANCEL IMAGE
/ALL
CANCEL MODE
CANCEL MODULE
/ALL
/[NO]RELATED
CANCEL RADIX
/OVERRIDE
CANCEL SCOPE
CANCEL SOURCE
/EDIT
/MODULE=moduIe-name
CANCEL TRACE
/ALL
/BRANCH
/CALL
/EVENT=event-name
/EXCEPTION
/INSTRUCTION
/LINE
CANCEL TYPE/OVERRIDE
CANCEL WATCH
/ALL
CANCEL WINDOW
/ALL
|CTRL/C|
|CTRL/W|
|CTRL/Y|
|CTRL/Z|

DECLARE

DCL Commands, Utilities, and Lexical Functions

DEFINE
/ADDRESS
/COMMAND
/LOCAL
/VALUE
DEFINE/KEY
/[NOJECHO
/[NO]IF_STATE=(state-name[,...])
/[NO]LOCK_STATE
/[NO]LOG
/[NO]SET_STATE=state-name
/[NO]TERMINATE
DELETE
/ALL
/LOCAL
DELETE/KEY
/ALL
/[NO]LOG
/[NO]STATE=(state-name[,...])
DEPOSIT
/ASCIC
/ASCID
/ASCILn
/ASCIW
/ASCIZ
/BYTE
/D_FLOAT
/DATE-TIME
/FLOAT
/G_FLOAT
/H_FLOAT
/INSTRUCTION
/LONGWORD
/OCTAWORD
/PACKEDin
/QUADWORD
/TASK
/TYPE=type-expression
/WORD
DISABLE AST

DCL-13

DCL-14

DCL Commands, Utilities, and Lexical Functions

DISPLAY
/CLEAR
/[NO]DYNAMIC
/GENERATE
/HIDE
/[NO]MARK_CHANGE
/[NO]POP
/[NOJPUSH
/REFRESH
/REMOVE
/SIZE:n
EDIT
/[NOJEXIT
ENABLE AST
EVALUATE
/BINARY
/CONDITION-VALUE
/DECIMAL
/HEXADECIMAL
/OCTAL
EVALUATE /ADDRESS
/BINARY
/DECIMAL
/HEXADECIMAL
/OCTAL
EXAMINE
/ASCIC
/ASCID
/ASCILn
/ASCIW
/ASCIZ
/BINARY
/BYTE
/CONDITION-VALUE
/D_FLOAT
/DATE_TIME
/DECIMAL
/DEFAULT
/FLOAT
/G-FLOAT
/H_FLOAT
/HEXADECIMAL
/INSTRUCTION
/[NOJLINE

DCL Commands, Utilities, and Lexical Functions

/LONGWORD
/OCTAL
/OCTAWORD
/PACKED:n
/PSL
/PSW
/QUADWORD
/SOURCE
/[NOJSYMBOL
/TASK
/TYPE=type-expression
/WORD
EXIT
EXITLOOP
EXPAND
/DOWN:n
/LEFT:n
/RIGHT:n
/UP:n
EXTRACT
/ALL
/APPEND
/SCREEN-LAYOUT
FOR
GO
HELP
IF
MOVE
/DOWN:n
/LEFT:n
/RIGHTin
/UP:n
QUIT
REPEAT
SAVE
SCROLL
/BOTTOM
/DOWN:n
/LEFT:n
/RIGHTin
/TOP
/UP:n

DCL-15

DCL-16

DCL Commands, Utilities, and Lexical Functions

SEARCH
/ALL
/IDENTIFIER
/NEXT
/STRING
SELECT
/ERROR
/INPUT
/INSTRUCTION
/OUTPUT
/PROGRAM
/PROMPT
/SCROLL
/SOURCE
SET ATSIGN
SET BREAK [WHEN] [DO]
/AFTER:n
/BRANCH
/CALL
/EVENT=event-name
/EXCEPTION
/INSTRUCTION[=(op-code[,...])]
/INTO
/[NO]JSB
/LINE
/MODIFY
/OVER
/RETURN
/[NO]SHARE
/[NOjsiLENT
/[NO]SOURCE
/[NO]SYSTEM
/TEMPORARY
SET DEFINE
SET DISPLAY
/[NO]DYNAMIC
/HIDE
/MARK-CHANGE
/POP
/PUSH
/REMOVE
/SIZE:n

DCL Commands, Utilities, and Lexical Functions

SET EDITOR
/CALLABLE_EDT
/CALLABLE-LSEDIT
/CALLABLE_TPU
/[NO]START_POSITION
SET EVENT_FACILITY
SET EXCEPTION BREAK
SET IMAGE
/ALL
SET KEY
/[NO]LOG
/[NO]STATE=state-name
SET LANGUAGE
SET LOG
SET MARGINS
SET MAX_SOURCE_FILES
SET MODE
SET MODULE
/ALL
/ALLOCATE
/[NOJRELATED
SET OUTPUT
SET PROMPT
SET RADIX
/INPUT
/OUTPUT
/OVERRIDE
SET SCOPE
/MODULE
SET SEARCH
SET SOURCE
/EDIT
/MODULE=moduIe-name
SET STEP
SET TASK
/ABORT
/ACTIVE
/ALL
/[NO]HOLD
/PRIORITY=n
/RESTORE
/TIME_SLICE=t
/VISIBLE

DCL-17

DCL-18

DCL Commands, Utilities, and Lexical Functions

SET TERMINAL
/PAGE:n
/WIDTH:n
SET TRACE
/AFTER:n
/BRANCH
/CALL
/EVENT=event-naine
/EXCEPTION
/INSTRUCTION[=(op-code[,...])]
/INTO
/[NO]JSB
/LINE
/MODIFY
/OVER
/RETURN
/[NOJSILENT
/[NOJSOURCE
/[NO]SYSTEM
/TEMPORARY
SET TYPE
/OVERRIDE
SET WATCH
/AFTERin
/[NO]SILENT
/[NO]SOURCE
/TEMPORARY
SET WINDOW
SHOW AST
SHOW ATSIGN
SHOW BREAK
SHOW CALLS
SHOW DEFINE
SHOW DISPLAY
/ALL
SHOW EDITOR
SHOW EVENT-FACILITY
SHOW EXIT-HANDLERS
SHOW IMAGE
SHOW KEY
/ALL
/BRIEF
/DIRECTORY
/[N 0]STATE=(state-name[,...])

DCL Commands, Utilities, and Lexical Functions

SHOW LANGUAGE
SHOW LOG
SHOW MARGINS
SHOW MAX-SOURCE-FILES
SHOW MODE
SHOW MODULE
/[NO]RELATED
/[NO]SHARE
SHOW OUTPUT
SHOW RADIX
/OVERRIDE
SHOW SCOPE
SHOW SEARCH
SHOW SELECT
SHOW SOURCE
/EDIT
SHOW STACK
SHOW STEP
SHOW SYMBOL
/ADDRESS
/DEFINED
/DIRECT
/LOCAL
/TYPE
/USE-CLAUSE
SHOW TASK
/ALL
/CALLS[=n]
/FULL
/[NO]HOLD
/PRIORITY=(n[,...])
/STATE=(state[,...])
/STATISTICS
/TIME-SLICE
SHOW TERMINAL
SHOW TRACE
SHOW TYPE
/OVERRIDE
SHOW WATCH
SHOW WINDOW
/ALL
SPAWN
/NOWAIT

DCL-19

DCL-20

DCL Commands, Utilities, and Lexical Functions

STEP
/BRANCH
/CALL
/EXCEPTION
/INSTRUCTION[=(op-code[,...])]
/INTO
/[NOJJSB
/LINE
/OVER
/RETURN
/[NO]SHARE
/[NO]SILENT
/[NO]SOURCE
/[NO]SYSTEM
SYMBOLIZE
TYPE
UNDEFINE
/ALL
/LOCAL
UNDEFINE/KEY
/ALL
/[NO]LOG
/[NO]STATE=(state-name[,...])
WHILE
$DECK
/DOLLARS[=string]
DEFINE logical-name equivalence-name[,...]
/EXECUTIVE-MODE
/GROUP
/JOB
/LOG (default)
/NOLOG
/NAME_ATTRIBUTES[=(keyword[,...])]
/PROCESS (default)
/SUPERVISOR-MODE (default)
/SYSTEM
/TABLE=name
/TRANSLATION_ATTRIBUTES[=(keyword[,...])]
/USER-MODE
DEFINE/CHARACTERISTIC characteristic-name characteristic-number

DCL Commands, Utilities, and Lexical Functions

DEFINE/FORM form-name form-number
/DESCRIPTION=string
/LENGTH=n
/MARGIN=(option[,...])
/PAGE_SETUP=(module[,...])
/NOPAGE-SETUP (default)
/SETUP=(module[,...])
/SHEET-FEED
/NOSHEET-FEED (default)
/STOCK=string
/TRUNCATE (default)
/NOTRUNCATE
/WRAP
/NOWRAP (default)
/WlDTH=n
DEFINE/KEY key-name equivalence-string
/ECHO (default)
/NOECHO
/ERASE
/NOERASE (default)
/lF-STATE=(state-name,...)
/N01F_STATE
/LOCK-STATE
/NOLOCK-STATE (default)
/LOG (default)
/NOLOG
/SET-STATE=state-name
/NOSET-STATE (default)
/TERMINATE
/NOTERMINATE (default)
DELETE file-spec[,...]
/BACKUP
/BEFORE[=time]
/BY-OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED (default)
/ERASE
/NOERASE (default)
/EXCLUDE=(file-spec[,...])
/EXPIRED
/LOG
/NOLOG (default)
/MODIFIED
/SlNCE[=time]
DELETE/CHARACTERISTIC characteristic-name
DELETE/ENTRY=(entry-number[,...]) queue-name[:]
DELETE/FORM form-name
DELETE/INTRUSION-RECORD source

DCL-21

DCL-22

DCL Commands, Utilities, and Lexical Functions

DELETE/KEY [key-name]
/ALL
/LOG (default)
/NOLOG
/STATE=(state-name[,...])
/NOSTATE (default)
DELETE/QUEUE queue-name[:]
DELETE/SYMBOL [symbol-name]
/ALL
/GLOBAL
/LOCAL (default)
/LOG
/NOLOG (default)
DEPOSIT location=data[,...]
/ASCII
/BYTE
/DECIMAL
/HEXADECIMAL
/LONGWORD
/OCTAL
/WORD
DIFFERENCES master-file-spec [revision-file-spec]
/CHANGE_BAR[=(format[,...])]
/COMMENT_DELIMITER[=(delimiter[,...])]
/IGNORE=(option[,...])
/MATCH=size
/MAXIMUM_DIFFERENCES=n
/MERGED[=n]
/MODE=(radix[,...])
/NUMBER (default)
/NONUMBER
/OUTPUT[=file-spec]
/PARALLEL[=n]
/SEP ARATED[=(input-file[,...])]
/SLP
/WIDTH=n
/WINDOW=size

DIRECTORY [file-spec[,...]]
/ACL
/BACKUP
/BEFORE[=time]
/BRIEF (default)
/BY_OWNER[=uic]

DCL Commands, Utilities, and Lexical Functions

/COLUMNS=n
/CREATED (default)
/DATE[=option]
/NODATE
/EXCLUDE=(file-spec[,...])
/EXPIRED
/FILE_ID
/FULL
/GRAND_TOTAL
/HEADING
/NOHEADING
/MODIFIED
/OUTPUT[=me-spec]
/NOOUTPUT
/OWNER
/NOOWNER (default)
/PRINTER
/PROTECTION
/NOPROTECTION (default)
/SECURITY
/SELECT=(key word[,...])
/SINCE[=time]
/SIZE[=option]
/NOSIZE (default)
/TOTAL
/TRAILING
/NOTRAILING
/VERSIONS=n
/ WIDTH=(key word[,...])
DISCONNECT
/CONTINUE

/NOCONTINUE (default)

DISMOUNT device-name[:]
/ABORT
/CLUSTER
/UNIT
/UNLOAD (default)

/NOUNLOAD

DUMP file-spec [,...]
/ALLOCATED
/BLOCKS[=(option[,...])]
/BYTE
/DECIMAL
/FILE_HEADER
/FORMATTED (default)
/NOFORMATTED
/HEADER
/HEXADECIMAL (default)
/LONGWORD (default)
/NUMBER[=n]
/OCTAL

DCL-23

DCL-24

DCL Commands, Utilities, and Lexical Functions

/OUTPUT[=file-spec]
/PRINTER
/RECORDS[=(option[,...])]
/WORD
EDIT/ACL file-spec
/JOURNAL[=file-spec]
/NOJOURNAL
/KEEP=(option[,...])
/MODE=option
/OBJECT=type
/OBJECT=file
/RECOVER[=file-spec]
/NORECOVER
EDIT file-spec
/COMMAND[=file-spec]
/NOCOMMAND
/CREATE (default)
/NOCREATE
/JOURNAL[=joumal-file]
/NOJOURNAL
/OUTPUT=output-file
/NOOUTPUT
/READ-ONLY
/NOREAD_ONLY (default)
/RECOVER
/NORECOVER (default)
See also EDT section, under "Text Editors and Formatters.'
EDIT/FDL file-spec
/ANALYSIS=fdl-file-spec
/CREATE
/DISPLAY=graph-option
/EMPHASIS=tuning-bias
/GRANULARITY=n
/NOINTERACTIVE
/NUMBER_KEYS=n
/OUTPUT=fdl-file-spec
/PROMPTIN G=prompt-option
/RESPONSES=response-option
/SCRIPT=script-title
/NOSCRIPT
Interactive Commands:
ADD
DELETE
EXIT
HELP
INVOKE
MODIFY
QUIT

DCL Commands, Utilities, and Lexical Functions

SET
VIEW
EDIT/SUM input-file
/HEADER
/LISTING[=file-spec]
/OUTPUT[=file-spec]
/NOOUTPUT
/UPDATE[=(update-file-spec[,...])]
EDIT/TECO [file-spec]
EDIT/TECO/EXECUTE=command-file [argument]
/COMMAND[=file-spec]
/NOCOMMAND
/CREATE (default)
/NOCREATE
/EXECUTE=command-file [argument]
/MEMORY (default)
/NOMEMORY
/OUTPUT=output-file
/NOOUTPUT (default)
/READ-ONLY
/NOREAD_ONLY (default)
EDIT/TPU [file-spec]
/COMMAND[=command-file] (default)
/NOCOMMAND
/CREATE (default)
/NOCREATE
/DISPLAY[=file-spec] (default)
/NODISPLAY
/JOURNAL[=journal-file] (default)
/NOJOURNAL
/OUTPUT=output-file (default)
/NOOUTPUT
/READ-ONLY
/NOREAD-ONLY (default)
/RECOVER
/NORECOVER (default)
/SECTION[=file-spec] (default)
/NOSECTION
See also VAXTPU section under "Text Editors and Formatters.'
$EOD
$EOJ
EXAMINE location[:location]
/ASCII
/BYTE
/DECIMAL
/HEXADECIMAL
/LONGWORD
/OCTAL
/WORD
EXCHANGE [subcommand] [file-spec] [file-spec]
EXIT [status-code]

DCL-25

DCL-26

DCL Commands, Utilities, and Lexical Functions

F$CVSI(bit-position,width,string)
F$CVTIME([input_time] [,output_time] [,field])
F$CVUI(bit-position,width,string)
F$DIRECTORY()
F$EDIT(string,edit-list)
F$ELEMENT(element-number,delimiter,string)
F$ENVIRONMENT(item)
F$EXTRACT(offset,length,string)
F$F AO(control-string[,argl ,arg2.. .argl 5])
F$FILE _ATTRIBUTES(file-spec,item)
F$GETDVI(device-name,item)
F$GETJPI(pid4tem)
F$GETSYI(item [,node])
F$IDENTIFIER(identifier,conversion-type)
F$INTEGER(expression)
F$LENGTH(string)
F$LOCATE(substring,string)
F$LOGICAL(logical-name)
F$MESSAGE(status-code)
F$MODE()
F$PARSE(file-spec [,default-spec] [,related-spec] [,field] [,parse-type])
F$PID(context-symbol)
F$PRIVILEGE(priv-states)
F$PROCESS()
F$SEARCH(file-spec[,stream-id])
F$SETPRV(priv-states)
F$STRIN G(expression)
F$TIME()
F$TRNLNM(logical-naine [,table] [,index] [,mode] [,case] [,item])

DCL Commands, Utilities, and Lexical Functions

F$TYPE(symbol-name)
F$USER()
F$VERIFY([procedure-value] [,image-value])
GOSUB label
GOTO label
HELP [keyword ...]
/INSTRUCTIONS (default)
/NOINSTRUCTIONS
/LIBLIST (default)
/NOLIBLIST
/LIBRARY=file-spec
/NOLIBRARY
/OUTPUT[=file-spec]
/NOOUTPUT
/PAGE (default)
/NOPAGE
/PROMPT (default)
/NOPROMPT
/USERLlBRARY=(table[,...])
/NOUSERLIBRARY
IF expression THEN [$] command
INITIALIZE device-name[:] volume-label
/ACCESSED=n
/BADBLOCKS=(area[,...])
/CLUSTER_SIZE=n
/DATA_CHECK[=(option[,...])]
/DENSITY=density-value
/DIRECTORIES=n
/ERASE
/NOERASE (default)
/EXTENSION=n
/FILE_PROTECTION=code
/GROUP
/HEADERS=n
/HIGHWATER (default)
/NOHIGHWATER
/INDEX=position
/LABEL=option
/MAXIMUM _FILES=n
/OVERRIDE=(option[,...])
/OWNER_UIC=uic
/PROTECTION=code
/SHARE (default)
/NOSHARE
/STRUCTURE=level
/SYSTEM
/USER_NAME=string
/VERIFIED
/NOVERIFIED
/WINDOWS=n

DCL-27

DCL-28

DCL Commands, Utilities, and Lexical Functions

INITIALIZE/QUEUE queue-name[:]
/BASE_PRIORITY=n
/BATCH
/NOBATCH (default)
/BLOCK_LIMIT=([lowlim,]uplim)
/NOBLOCK_LIMIT (default)
/CHARACTERISTlCS=(characteristic[,...])
/NOCHARACTERISTICS (default)
/CPUDEFAULT=time
/CPUMAXlMUM=time
/DEFAULT=(option[,...])
/NODEFAULT
/DISABLE-SWAPPING
/NODISABLE-SWAPPING (default)
/ENABLE-GENERIC (default)
/NOENABLE-GENERIC
/FORM -MOUNTEI>type
/GENERlC[=(queue-name[,...])]
/NOGENERIC (default)
/JOB-LlMIT=n
/LlBRARY=file-name
/NOLIBRARY
/ON=[node::]device[:] (printer, terminal, server queue)
/OWNER_UIC=uic
/PROCESSOR=file-name
/NOPROCESSOR
/PROTECT10N=(codes)
/RECORD-BLOCKING (default)
/NORECORD-BLOCKING
/RETAIN[=option]
/NORETAIN (default)
/SCHEDULE=[NO]SIZE
/SEPARATE=(option[,...])
/NOSEPARATE (default)
/START
/NOSTART (default)
/TERMINAL
/NOTERMINAL (default)
/WSDEFAULT=n
/WSEXTENT=n
/WSQUOTA=n
INQUIRE symbol-name [prompt-string]
/GLOBAL
/LOCAL (default)
/PUNCTUATION (default)

/NOPUNCTUATION

$ JOB user-name
/AFTER=time
/CHARACTERlSTICS=(characteristic[,...])
/CLl=Hle-name
/CPUTlME=n
/DELETE (default)
/NODELETE
/HOLD
/NOHOLD (default)
/KEEP
/NOKEEP (default)
/LOG-FlLE=file-spec
/NOLOG_FILE
/NAME=job-name

DCL Commands, Utilities, and Lexical Functions

/NOTIFY
/NONOTIFY (default)
/PARAMETERS=(parameter[,...])
/PRINTER=queue-name
/NOPRINTER
/PRIORITY=n
/QUEUE=queue-name[:]
/RESTART
/NORESTART (default)
/TRAILING-BLANKS (default)
/NOTRAILING-BLANKS
/WSDEFAULT=n
/WSEXTENT=n
/WSQUOTA=n
Lexical Functions

See F$... entries.

LIBRARY library-file-spec [input-file-spec[,...]]
/BEFORE[=time]
/COMPRESS[=(option[,...])]
/CRE ATE[=(option[,...])]
/CROSS-REFERENCE[=(option[,...])]
/DATA=option
/DELETE=(module[,...])
/EXTRACT=(module[,...])
/FULL
/GLOBALS
/NOGLOBALS
/HELP
/HISTORY
/INSERT
/LIST[=file-spec]
/NOLIST
/LOG
/NOLOG
/MACRO
/NAMES
/NONAMES
/OBJECT
/ONLY=(module[,...])
/OUTPUT=file-spec
/REMOVE=(symbol[,...])
/REPLACE
/SELECTIVE -SEARCH
/SHARE
/SINCE[=time]
/SQUEEZE
/NOSQUEEZE
/TEXT
/WIDTH=n
/MODULE=module-name

dcl-29

DCL-30

DCL Commands, Utilities, and Lexical Functions

LINK file-spec[,...]
/BRIEF
/CONTIGUOUS
/NOCONTIGUOUS (default)
/CROSS-REFERENCE
/NOCROSS-REFERENCE
/DEBUG[=file-spec]
/NODEBUG
/EXECUTABLE[=file-spec]
/NOEXECUTABLE
/FULL
/HEADER
/MAP[=file-spec]
/NOMAP
/POIMAGE
/PROTECT
/SHAREABLE[=file-spec]
/NOSHAREABLE
/SYMBOL _TABLE[=file-spec]
/NOSYMBOL -TABLE
/SYSLIB
/NOSYSLIB
/SYSSHR
/NOSYSSHR
/SYSTEM[=base-address]
/NOSYSTEM
/TRACEBACK (default)
/NOTRACEBACK
/USERLIBRARY[=(table[,...])]
/NOUSERLIBRARY
/INCLUDE=(module-name[,...])
/LIBRARY
/OPTIONS
/SELECTIVE-SEARCH
/SHAREABLE
/SHAREABLE=NOCOPY
ICTRL/CI ICTRL/Yl

< RETURN >

(Login procedure)

/CLI=command-language-interpreter
/COMMAND[=file-spec]
/NOCOMMAND
/DISK=device-name[:]
/TABLES=(command-table[,...])
LOGOUT
/BRIEF
/FULL
/HANGUP

/NOHANGUP

MACRO file-spec[,...]
/CROSS-REFERENCE[=(function[,...])]
/NOCROSS-REFERENCE (default)
/DEBUG[=option]
/NODEBUG (default)
/DISABLE=(function[,...])
/NODISABLE
/ENABLE=(function[,...])
/NOENABLE
/LIBRARY
/NOLIBRARY
/LlST[=fae-spec]
/NOLIST
/OBJECT[=file-spec]
/NOOBJECT

DCL Commands, Utilities, and Lexical Functions

/SHOW[=(function[,...])]
/NOSHOW[=(function[,...])]
/UPDATE[=(update-file-spec[,...])]
/NOUPDATE
MAIL [file-spec] [recipient-name]
/SUBJECT="text"
/EDIT=[(send,reply[=extract],forward)]
/SELF
Interactive Commands:
ANSWER [file-spec]
/[NO]EDIT
/EXTRACT
/LAST
/[NO]SELF
ATTACFl [process-name]
/PARENT
BACK
/[NO]EDIT
COMPRESS [file-spec]
/OUTPUT=out-file-spec
COPY foldemame [filename]
/ALL
/[NO]CONFIRM
CURRENT
/[NO]EDIT
DEFINE/KEY key-name string
/[NO]ECHO
/[NO]IF_STATE=state-list
/[NO]LOCK_STATE
/[NO]LOG
/[NO]SET_STATE=state
/[NO]TERMINATE
DELETE [message-number]
/ALL
DIRECTORY [foldemame]
/BEFORE=date
/FOLDER
/FULL
/NEW
/SINCE=date
/START=start-point

DCL-31

DCL-32

DCL Commands, Utilities, and Lexical Functions

EDIT [filename]
/COMMAND=ini-file-spec
/CREATE
/JOURNAL=jou-file-spec
/OUTPUT=out-Hle-spec
/READ
/RECOVER
ERASE
EXIT
EXTRACT file-spec
/ALL
/APPEND
/MAIL
/NOHEADER
FILE foldemame [filename]
/ALL
/[NO]CONFIRM
FIRST
/[NO]EDIT
FORWARD
/[NO]EDIT
/NOHEADER
HELP [topic]
LAST
/[NO]EDIT
MAIL [file-spec]
/[NO]EDIT
/LAST
/[NO]SELF
/SUBJECT="text"
MOVE foldemame [filename]
/ALL
/[NO]CONFIRM
NEXT
/[NO]EDIT
PRINT
/ALL
/COPIES=n
/NOTIFY
/PRINT
/QUEUE=queue-name
PURGE
/RECLAIM
/STATISTICS

DCL Commands, Utilities, and Lexical Functions

QUIT
READ [foldemame] [message-number]
/BEFORE=date
/[NOjEDIT
/NEW
/SINCE=date
REPLY [file-spec]
/[NO]EDIT
/EXTRACT
/LAST
/[NO]SELF
SEARCH [search-string]
SELECT [foldemame]
/BEFORE=date
/NEW
/SINCE=date
SEND [file-spec]
/[NO]EDlT
/LAST
/[NO]SELF
/SUBJECT="text"
SET [NO]AUTO_PURGE
SET COPY-SELF command, [command]
SET FILE filename
SET FOLDER
/BEFORE=date
/NEW
/SINCE=date
SET [NO]FORWARD [_user-name],address
/USER=user-name
SET [NO]MAIL-DIRECTORY [.subdirectory-name]
/LOG
SET [NO]PERSONAL_NAME "text-string"
SET WASTEBASKET-NAME foldemame
SHOW ALL
SHOW AUTO-PURGE
SHOW COPY-SELF
SHOW DELETED
SHOW FILE
SHOW FOLDER
SHOW FORWARD

DCL-33

DCL-34

DCL Commands, Utilities, and Lexical Functions

SHOW KEY [key-name]
/ALL
/BRIEF
/DIRECTORY
/STATE(=state,state,...)
SHOW MAIL-DIRECTORY
SHOW NEW_MAIL-COUNT
SHOW PERSONAL-NAME
SHOW WASTEBASKET-NAME
SPAWN [command]
/INPUT=me-spec
/[NO]LOGIC AL -NAMES
/OUTPUT=file-spec
/PROCESS=subprocess-name
/[NO]SYMBOLS
/[NojwAIT

Figure DCL-1

rPF1

Mail Utility Default Keypad Definitions
PF4

PF3

PF2
HELP

EXTRACT/MAIL

ERASE

DIR/FOLDER

EXTRACT

SELECT MAIL

GOLD

—

8
SEND

FORWARD

READ/NEW

SEND/EDIT

REPLY/EDIT/EXT

FORWARD/EDIT

SHOW NEW

4
CURRENT

FIRST

LAST

DIR/NEW

CURRENT/EDIT

FIRST/EDIT

LAST/EDIT

DIR MAIL

ENTER

1
BACK

DIR

BACK/EDIT

PRINT/PR/NOTIF

DIR/STAR 99999

0
NEXT

FILE

NEXT/EDIT

DELETE

SELECT:

J
ZK-1619-84

DCL-36

DCL Commands, Utilities, and Lexical Functions

MERGE input-file-specl,input-file-spec2[,...] output-file-spec
/CHECK_SEQUENCE
/NOCHECK_SEQUENCE
/COLLATING _SEQUENCE=sequence
/DUPLICATES
/NODUPLICATES
/KEY=(field[,...])
/SPECIFICATION[=file-spec]

/STABLE
/NOSTABLE
/STATISTICS
/NOSTATISTICS
/FORMAT=(file-attribute[,...])
/ALLOCATION=n
/BUCKET_SIZE=n
/CONTIGUOUS
/FORMAT=(record-format[,...])
/INDEXED-SEQUENTIAL

/OVERLAY
/RELATIVE
/SEQUENTIAL
MESSAGE file-spec[,...]
/FILE_NAME=file-spec
/NOFILE_NAME
/LIST[=fiIe-spec]
/NOLIST
/OBJECT[=file-spec]
/NOOBJECT
/SYMBOLS
/NOSYMBOLS
/TEXT
/NOTEXT
Message Source File Statements:
Facility directive .FACILITY
Severity directive .SEVERITY
Base message number directive .BASE
Message definition message-name
END directive .END
Literal directive .LITERAL
Identification directive .IDENT
Listing directives
Title directive .TITLE
Page directive .PAGE
MONITOR [class-name[,...]]
Interactive Commands:
CONVERT file-spec
EXECUTE (@) file-spec
EXIT

DCL Commands, Utilities, and Lexical Functions

HELP [command]
INITIALIZE
MONITOR classname[,...]
SET DEFAULT classname[,...]
SHOW DEFAULT
Monitor Class Names:
ALL—CLASSES — Statistics for all classes
CLUSTER — Clusterwide performance statistics
DECNET — DECnet-VAX statistics
DISK — Disk I/O statistics
DLOCK — Distributed lock management statistics
FCP — File control primitive statistics
FILE—SYSTEM—CACHE — File system cache statistics
lO — System I/O statistics
LOCK — Lock management statistics
MODES — Time spent in each of the processor modes
PAGE — Page management statistics
POOL — Statistics on space allocation in the nonpaged dynamic pool
PROCESSES — Statistics on all processes
SCS — System communications services statistics
STATES — Number of processes in each of the scheduler states
SYSTEM — Summary of statistics from other classes
MOUNT device-name[:][,...] [volume-label[,...]] [logical-name[:]]
/ASSIST (default)
/NOASSIST
/ACCESSED=n
/AUTOMATIC (default)
/NOAUTOMATIC
/BIND=volume-set-name
/BLOCKSIZE=n
/C ACHE=(option[,...])
/NOCACHE
/CLUSTER
/COMMENT="string"
/CONFIRM
/NOCONFIRM (default)
/COPY (default)
/NOCOPY
/DATA -CHECK[=(option[,...])]
/DENSITY=n
/EXTENSION=n
/FOREIGN
/GROUP
/HDR3 (default)
/NOHDR3
/INITIALIZE=CONTINUATION
/JOURNAL (default)
/NOJOURNAL
/LABEL (default)
/NOLABEL

DCL-37

DCL-38

DCL Commands, Utilities, and Lexical Functions

/MESSAGE (default)
/NOMESSAGE
/MOUNT_VERIFICATION (default)
/NOMOUNT_VERIFICATION
/OVERRIDE=(option[,...])
/OWNER_UlC=uic
/PROCESSOR=option
/PROTECTION=code
/QUOTA (default)
/NOQUOTA
/REBUILD (default)
NOREBUILD
/RECORDSIZE=n
/SHADOW=(physical-device-name[:][,...])
/SHARE
/NOSHARE (default)
/SYSTEM
/UNLOAD (default)
/NOUNLOAD
/WlNDOWS=n
/WRITE (default)
/NOWRITE
ON condition THEN [$] command
OPEN logical-name[:] file-spec
/APPEND
/ERROR=label
/READ
/SHARE[=option]
/WRITE
$ PASSWORD [password]
PATCH file-spec
/ABSOLUTE
/JOURNAL[=file-spec]
/NEW_VERSION (default)
/OUTPUT[=file-spec]
/UPDATE[=(eco-level[,...])]
/VOLUME[=n]
Interactive Commands:
ALIGN
/BYTE
/WORD
/LONG
/QUAD
/PAGE
CANCEL MODE
CANCEL MODULE
/ALL

/N0NEW_VERS10N

DCL Commands, Utilities, and Lexical Functions

CANCEL PATCH_AREA
CANCEL SCOPE
CHECK ECO
CHECK NOT ECO
CREATE
DEFINE
DELETE
/BYTE
/WORD
/LONG
/OCTAL
/DECIMAL
/HEXADECIMAL
/[NO]ASCII
/[NOJINSTRUCTION
/[NO]SYMBOLS
/[NO]GLOBALS
/[NO]SCOPE
DEPOSIT
/BYTE
/WORD
/LONG
/OCTAL
/DECIMAL
/HEXADECIMAL
/[NOJASCII
/[NOJINSTRUCTION
/[NOJSYMBOLS
/[NOJGLOBALS
/[NOJSCOPE
/PATCH_AREA
EVALUATE
/BYTE
/WORD
/LONG
/OCTAL
/DECIMAL
/HEXADECIMAL
/[NOJASCII
/[NOJINSTRUCTION
/[NOjSYMBOLS
/[NOJGLOBALS
/[NOJSCOPE

DCL-39

DCL-40

DCL Commands, Utilities, and Lexical Functions

EXAMINE
/BYTE
/WORD
/LONG
/OCTAL
/DECIMAL
/HEXADECIMAL
/[NOJASCII
/[NO]INSTRUCTION
/[NOJSYMBOLS
/[NOJGLOBALS
/[NOJSCOPE
EXIT
HELP
INSERT
/OCTAL
/DECIMAL
/HEXADECIMAL
/[NO]INSTRUCTION
/[NOJSYMBOLS
/[NOJGLOBALS
/[NOjSCOPE
REPLACE
/BYTE
/WORD
/LONG
/OCTAL
/DECIMAL
/HEXADECIMAL
/[NOJASCII
/[NOJINSTRUCTION
/[NOJSYMBOLS
/[NOJGLOBALS
/[NOJSCOPE
SET ECO
SET MODE
SET MODULE
/ALL
SET PATCH-AREA
/INITIALIZE=size-expression
SET SCOPE
SHOW MODE
SHOW MODULE
SHOW PATCH-AREA

DCL Commands, Utilities, and Lexical Functions

SHOW SCOPE
UPDATE
VERIFY
/BYTE
/WORD
/LONG
/OCTAL
/DECIMAL
/HEXADECIMAL
/[NO]ASCII
/[NOJINSTRUCTION
/[NOJSYMBOLS
/[NOJGLOBALS
/[NO]SCOPE
PHONE [phone-command]
/SCROLL
/NOSCROLL
/SWITCH_HOOK="character"
/VIEWPORT_SIZE=n
Interactive Commands:
ANSWER
DIAL
DIRECTORY
EXIT
FACSIMILE
HANGUP
HELP
HOLD
MAIL
PHONE
REJECT
UNHOLD
PRINT file-spec[,...]
/AFTER=time
/NOAFTER
/BACKUP
/NOBACKUP
/BEFORE[=time]
/NOBEFORE
/BURST[=keyword]
/NOBURST
/BY_OWNER[=uic]
/NOBY_OWNER
/CHARACTERISTICS=(characteristic[,...])
/CONFIRM
/NOCONFIRM (default)
/COPIES=n
/CREATED (default)
/NOCREATED

DCL-41

DCL-42

DCL Commands, Utilities, and Lexical Functions

/DELETE
/NODELETE (default)
/DEVICE=queue-name[:]
/EXCLUDE=(file-spec[,...])
/NOEXCLUDE
/EXPIRED
/NOEXPIRED
/FEED (default)
/NOFEED
/FLAG[=keyword]
/NOFLAG
/FORM=type
/HEADER
/NOHEADER (default)
/HOLD
/NOHOLD (default)
/IDENTIFY (default)
/NOIDENTIFY
/JOB_COUNT=n
/LOWERCASE
/NOLOWERCASE (default)
/MODIFIED
/NOMODIFIED
/NAME=job-name
/NOTE=string
/NOTIFY
/NONOTIFY (default)
/OPERATOR=string
/PAGES=([lowlim,]uplim)
/PARAMETERS=(parameter[,...])
/PASSALL
/NOPASSALL (default)
/PRIORITY=n
/QUEUE=queue-name[:]
/REMOTE
/RESTART (default)
/NORESTART
/SETUP=module[,...]
/SINCE[=time]
/NOSINCE
/SPACE
/NOSPACE (default)
/TRAILER[=keyword]
/NOTRAILER
/USER=usemame
PURGE [file-spec[,...]]
/BACKUP
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED (default)
/ERASE
/NOERASE (default)
/EXCLUDE=(file-spec[,...])
/EXPIRED
/KEEP=n
/LOG
/NOLOG (default)
/MODIFIED
/SINCE[=time]

DCL Commands, Utilities, and Lexical Functions

READ logical-name[;] symbol-name
/DELETE
/END_OF_FILE=label
/ERROR=label
/INDEX=n
/KEY=string
/MAT CH=option
/NOLOCK
/PROMPT=string
/TIME_OUT=n
/NOTIME _OUT (default)
RECALL [command-specifier]
/ALL
RENAME input-file-spec[,...] output-file-spec
/BACKUP
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED (default)
/EXCLUDE=(file-spec[,...])
/EXPIRED
/LOG
/NOLOG (default)
/MODIFIED
/NEW_VERSION (default)
/NONEW_VERSION
/SINCE[=time]
REPLY ["message-text]"
/ABORT=identification-number
/ALL
/BELL
/BLANK _TAPE=identification-number
/DISABLE[=(keyword[,...])]
/EN ABLE[=(key word[,...])]
/INITIALIZE_TAPE=identification-number
/LOG
/NOLOG
/NODE[=(node-name[,...])]
/NOTIFY (default)
/NONOTIFY
/PENDING=identification-number
/SHUTDOWN
/STATUS
/TEMPORARY
/TERMINAL=(terminal-name[,...])

DCL-43

DCL-44

DCL Commands, Utilities, and Lexical Functions

/TO=identification-number
/URGENT
/USERNAME[=(usemame[,...])]
/WAIT
REQUEST "message-text"
/REPLY
/TO[=(operator[,...])]
RETURN [status-code]
RUN file-spec
/DEBUG

/NODEBUG

RUN file-spec
/ACCOUNTING (default)
/NOACCOUNTING
/AST_LIMIT=quota
/AUTHORIZE
/NOAUTHORIZE (default)
/BUFFER_LIMIT=quota
/DELAY=delta-time
/DETACHED
/NODETACHED
/DUMP
/NODUMP (default)
/ENQUEUE _LIMIT=quota
/ERROR=file-spec
/EXTENT=quota
/FILE_LIMIT=quota
/INPUT=file-spec
/INTERVAL=delta-time
/IO_BUFFERED=quota
/IO_DIRECT=quota
/JOB_TABLE_QUOTA=quota
/MAILBOX=unit
/MAXIMUM_WORKING_SET=quota
/OUTPUT=file-spec
/PAGE_FILE=quota
/PRIORITY=n
/PRIVILEGES=(privilege[,...])
/PROCESS—N AME=process-name
/QUEUE_LIMIT=quota
/RESOURCE-WAIT (default)
/NORESOURCE-WAIT
/SCHEDULE=absolute-time
/SERVICE-FAILURE
/NOSERVICE-FAILURE (default)
/SUBPROCESS-LIMIT=quota
/SWAPPING (default)
/NOSWAPPING

DCL Commands, Utilities, and Lexical Functions

dcl-45

/TIME_LIMIT=limit
/UIC=uic
/WORKING_SET=default
RUNOFF file-spec[,...]
/BACKSPACE
/BOLD[=n]
/NOBOLD
/CHANGE _BARS[="character"]
/NOCHANGE _BARS
/DEBUG[=(option[,...])]
/NODEBUG (default)
/DEVICE=(option[,...])
/DOWN[=n]
/NODOWN (default)
/FORM_SIZE=n
/INTERMEDIATE[=file-spec]
/NOINTERMEDIATE (default)
/LOG
/NOLOG (default)
/MESS AGES=(option[,...])
/OUTPUT[=file-spec]
/NOOUTPUT
/PAGES=string
/PAUSE
/NOPAUSE (default)
/REVERSE-EMPHASIS
RIGHT[=n]
/NORIGHT (default except for LNOl)
/SEPARATE_UNDERLINE[="character"]
/SEQUENCE
/NOSEQUENCE (default)
/SIMULATE
/NOSIMULATE (default)
/UNDERLINE_CHARACTER[="character"]
/NOUNDERLINE-CHARACTER
/VARIANT=string
RUNOFF/CONTENTS file-spec[,...] or file-spec[+...]
/BOLD
/DEEPEST_HEADER=n
/IDENTIFICATION
/NOIDENTIFICATION (default)
/INDENT
/NOINDENT (default)
/LOG
/NOLOG (default)
/OUTPUT[=fiIe-spec]
/NOOUTPUT
/PAGE _NUMBERS=(option[,...])
/REQUIRE=file-spec
/NOREQUIRE (default)
/SECTION-NUMBERS (default)
/NOSECTION-NUMBERS
/UNDERLINE
/NOUNDERLINE (default)
RUNOFF/INDEX file-spec[,...] or file-spec[+...]
/IDENTIFICATION
/LINES_PER_PAGE=n
/LOG
/OUTPUT[=file-spec]
/NOOUTPUT
/PAGE_NUMBERS=option

DCL-46

DCL Commands, Utilities, and Lexical Functions

/REQUIRE=file-spec
/RESERVE=n
SEARCH file-spec[,...] search-string[,...]
/EXACT
/NOEXACT (default)
/EXCLUDE=(file-spec[,...])
/FORMAT=option
/HEADING (default)
/NOHEADING
/LOG
/NOLOG (default)
/MAT CH=option
/NUMBERS
/NONUMBERS (default)
/OUTPUT[=file-spec]
/NOOUTPUT
/REMAINING
/NOREMAINING (default)
/STATISTICS
/NOSTATISTICS (default)
/WINDOW[=(nl,n2)]
/NOWINDOW (default)
SET option
SET ACCOUNTING
/DISABLE[=(keyword[,...])]
/ENABLE[=(keyword[,...])]
/NEW_FILE
SET ACL object-name
/ACL[=(ace[,...])]
/AFTER=ace
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED
/DEFAULT
/DELETE
/EDIT
/EXCLUDE=(file-spec[,...])
/JOURNAL[=file-spec]
/NOJOURNAL
/KEEP=(option[,...])
/LIKE=(OBJECT_TYPE=type,OBJECT_NAME=name)
/LOG
/NOLOG (default)
/MODE=[NO]PROMPT
/NEW
/OBJECT_TYPE=type
/RECOVER[=file-spec]
/NORECOVER (default)
/REPLACE=(ace[,...])
/SINCE[=time]

DCL Commands, Utilities, and Lexical Functions

SET AUDIT
/ALARM
/DEVICE=dev-name[:]
/DIS ABLE=(key word[,...])
/EN ABLE=(key word[,...])
/JOURNAL
/NEW_VERSION
SET BROADCAST=(class-name[,...])
SET CARD-READER device-name[:]
/026
/029
/LOG

/NOLOG (default)

SET CLUSTER/QUORUM[=quorum-value]
SET COMMAND [file-spec[,...]]
/DELETE=(verb[,...])
/LISTING[=file-spec]
/OBJECT[=file-spec]
/OUTPUT[=file-spec]
/REPLACE
/TABLE=[file-spec]

/NOLISTING
/NOOUTPUT

Command Definition Utility Statements and Clauses;
Statements
DEFINE SYNTAX syntax-name [verb-clause[,...]]
DEFINE TYPE type-name [type-clause[,...]]
DEFINE VERB verb-name [verb-clause[,...]]
IDENT ident-string
MODULE module-name
The clauses that can be specified with various statements are
summarized as follows.
Verb Clauses for DEFINE SYNTAX
DISALLOW expression
IMAGE image-string
NODISALLOWS
NOPARAMETERS
NOQUALIFIERS
PARAMETER param-name [,param-clause[,...]]

DCL-47

DCL-48

DCL Commands, Utilities, and Lexical Functions

param-clause entries:
DEFAULT
LABEL = label-name
PROMPT = prompt-string
VALUE[(param-value-clause[,...])]
param-value-clause entries:
CONCATENATE
DEFAULT = default-string
LIST
NOCONCATENATE
REQUIRED
TYPE = type-name
QUALIFIER qual-name [,qual-clause[,...]]
qual-clause entries:
BATCH
DEFAULT
LABEL = label-name
NEGATABLE
NONNEGATABLE
PLACEMENT = placement-clause
GLOBAL
LOCAL
POSITIONAL
SYNTAX = syntax-name
VALUE[(qual-value-clause[,...])]
ROUTINE routine-name
Parameter and Qualifier Value Clauses
DEFAULT = default-string
LIST
REQUIRED
TYPE = type-name
Type Clause for DEFINE TYPE
KEYWORD keyword-name [,keyword-clause[,...]]
keyword-clause entries:
DEFAULT
LABEL = label-name
NEGATABLE
NONNEGATABLE
SYNTAX = syntax-name
VALUE[(key-value-clause[,...])]

DCL Commands, Utilities, and Lexical Functions

DCL-49

Verb Clauses for DEFINE VERB
DISALLOW expression
IMAGE image-string
NODISALLOWS
NOPARAMETERS
NOQUALIFIERS
PARAMETER param-name [,param-clause[,...]]
QUALIFIER qual-name [,qual-clause[,...]]
ROUTINE routine-name
SYNONYM synonym-name
SET [NO]CONTROL[=(T,Y)]
SET DAY
/DEFAULT
/LOG
/NOLOG (default)
/PRIMARY
/SECONDARY
SET DEFAULT device-name[:]
SET DEVICE device-name[:]
/ACL
/AVAILABLE
/NOAVAILABLE
/DUAL-PORT
/NODUAL-PORT
/ERROR-LOGGING
/NOERROR-LOGGING
/LOG
/NOLOG (default)
/SPOOLED[=(queue-name[:],intermediate-disk-name[:])]
SET DEVICE/ACL[=(ace[,...])] device-name
/AFTER=ace
/DELETE
/EDIT
/JOURNAL[=file-spec]
/NOJOURNAL
/KEEP=(option[,...])
/LIKE=object-spec
/LOG
/NOLOG (default)
/MODE=[NO]PROMPT
/NEW
/RECOVER[=file-spec]
/NORECOVER (default)
/REPLACE=(ace[,...])
SET DEVICE/SERVED node-name$DDcu:

/NOSPOOLED

DCL-50

DCL Commands, Utilities, and Lexical Functions

SET DIRECTORY directory-spec[,...]
/ACL
/BACKUP
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED (default)
/EXCLUDE=(directory-spec[,...])
/EXPIRED
/LOG
/NOLOG (default)
/MODIFIED
/OWNER_UIC[=uic]
/SINCE[=time]
/VERSION_LIMIT[=n]
SET DIRECTORY/ACL[=(ace[,...])] directory-spec[,...]
/AFTER=ace
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED
/DEFAULT
/DELETE
/EDIT
/EXCLUDE=(directory-spec[,...])
/JOURNAL[=file-spec]
/NOJOURNAL
/KEEP=(option[,...])
/LIKE=object-spec
/LOG
/NOLOG (default)
/MODE=[NO]PROMPT
/NEW
/RECOVER[=file-spec]
/NORECOVER (default)
/REPLACE=(ace[,...])
/SINCE[=time]
SET FILE file-spec[,...]
/ACL
/BACKUP
/NOBACKUP (default)
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED
/DATA_CHECK[=([NO]READ,[NO]WRITE)]

DCL Commands, Utilities, and Lexical Functions

/END_OF_FILE
/ENTER=new-file-spec
/ERASE_ON_DELETE
/EXCLUDE=(file-spec[,...])
/EXPIRATION_DATE=date
/EXTENSION[=n]
/GLOBAL _BUFFER=n
/JOURNAL=(keyword[,...])
/LOG
/NOLOG (default)
/NODIRECTORY
/OWNER_UIC[=uic]
/PROTECTION[=(code)]
/REMOVE
/SINCE[=time]
/UNLOCK
/TRUNCATE
/VERSION _LIMIT[=n]

/NOEXPIRATION_DATE

SET FILE/ACL[=(ace[,...])] file-spec[,...]
/AFTER=ace
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED
/DEFAULT
/DELETE
/EDIT
/EXCLUDE=(aie-spec[,...])
/JOURNAL[=file-spec]
/NOJOURNAL
/KEEP=(option[,...])
/LIKE=aie-spec
/LOG
/NOLOG (default)
/MODE=[NO]PROMPT
/NEW
/RECOVER[=aie-spec]
/NORECOVER (default)
/REPLACE=(ace[,...])
/SINCE[=time]
SET HOST node-name
/LOG[=aie-spec]

/NOLOG (default)

DCL-51

DCL-52

DCL Commands, Utilities, and Lexical Functions

SET HOST/DTE terminal-name
/DIAL=(NUMBER:number[,MODEM_TYPE:modem-type])
/LOG[=file-spec]
/NOLOG
SET HOST/HSC node-name
/LOG[=file-spec]

/NOLOG (default)

SET KEY
/LOG (default)
/NOLOG
/STATE=state-name
/NOSTATE
SET LOGINS
/INTERACTIVE[=n]
SET MAGTAPE device-name[:]
/DENSITY=density
/END_OF_FILE
/LOG
/NOLOG
/LOGSOFT (default)
/REWIND
/SKIP=option
/UNLOAD

/NOLOGSOFT

SET MESSAGE [file-spec]
/DELETE
/FACILITY
/NOFACILITY
/IDENTIFICATION
/NOIDENTIFICATION
/SEVERITY
/NOSEVERITY
/TEXT
/NOTEXT
SET [NO]ON
SET OUTPUT_RATE[=delta-time]
SET PASSWORD
/GENERATE[=value]
/SECONDARY
/SYSTEM
SET PRINTER printer-name[:]
/CR
/NOCR (default)
/FALLBACK
/NOFALLBACK (default)
/FF (default)
/NOFF
/LAll

DCL Commands, Utilities, and Lexical Functions

/LA180
/LOWERCASE
/NOLOWERCASE (default)
/LOG
/NOLOG (default)
/LPll (default)
/PAGE=n
/PASSALL
/NOPASSALL (default)
/PRINTALL
/NOPRINTALL (default)
/TAB
/NOTAB (default)
/TRUNCATE (default)
/NOTRUNCATE
/UNKNOWN
/UPPERCASE (default)
/NOUPPERCASE
/WlDTH=n
/WRAP
/NOWRAP (default)
SET PROCESS [process-name]
/CPU=[NO]ATTACHED
/DUMP
/NODUMP (default)
/lDENTlFlCAT10N=pid
/NAME=string
/PRIORlTY=n
/PRIVILEGES=(privilege[,...])
/RESOURCE-WAIT
/NORESOURCE-WAIT
/RESUME
/SUSPEND
/NOSUSPEND
/SWAPPING (default)
/NOSWAPPING
SET PROMPT[=string]
/CARRIAGE-CONTROL (default)

/NOCARRIAGE-CONTROL

SET PROTECTION[=(code)] file-spec[,...]
/CONFIRM
/NOCONFIRM (default)
/LOG
/NOLOG (default)
/PROTECTION=(code)
SET PROTECTION[=(code)]/DEFAULT
SET PROTECTION[=code]/DEVICE device-name[:]
/OWNER_UIC=uic
SET QUEUE queue-name[:]
/BASE_PRIORITY=n
/BLOCK-LIMIT=([lowlim,]uplim)
/NOBLOCK_LIMIT
/CHARACTERISTICS=(characteristic[,...])
/NOCHARACTERISTICS
/CPUDEFAULT=time

dcl-53

DCL-54

DCL Commands, Utilities, and Lexical Functions

/CPUMAXIMUM=time
/DEFAULT=(option[,...])
/NODEFAULT
/DISABLE -SWAPPING
/NODISABLE -SWAPPING
/ENABLE-GENERIC
/NOENABLE-GENERIC
/FORM _MOUNTED=type
/JOB-LIMIT=n
/OWNER-UIC=uic
/PROTECTION=(ownership[:access],...)
/RECORD-BLOCKING
/NORECORD-BLOCKING
/RETAIN[=option]
/NORETAIN
/SCHEDULE=[NO]SIZE
/SEPARATE=(option[,...])
/NOSEPARATE
/WSDEFAULT=n
/WSEXTENT=n
/WSQUOTA=n
SET QUEUE/ENTRY=entry-number queue-name[:]
/AFTER=time
/NOAFTER
/BURST[=keyword]
/NOBURST
/CHARACTERISTICS=(characteristic[,...])
/NOCHARACTERISTICS
/CLI=filename
/COPIES=n
/CPUTIME=option
/FEED
/NOFEED
/FLAG[=keyword]
/NOFLAG
/FORM=type
/HEADER
/NOHEADER
/HOLD
/NOHOLD
/JOB-COUNT=n
/KEEP
/NOKEEP
/LOG_FILE=file-spec
/NOLOG-FILE
/LOWERCASE
/NOLOWERCASE
/NAME=job-name
/NOCHECKPOINT
/NODELETE
/NOTE=string
/NOTIFY
/NONOTIFY
/OPERATOR=string
/PAGES=([I,]u)
/P ARAMETERS=(parameter[,...])
/PASSALL
/NOPASSALL
/PRINTER[=queue-name]
/NOPRINTER
/PRIORITY=n
/RELEASE

DCL Commands, Utilities, and Lexical Functions

/REQUEUE=queue-name[:]
/RESTART
/NORESTART
/SETUP=module[,...]
/SPACE
/NOSPACE
/TRAILER[=keyword]
/NOTRAILER
/WSDEFAULT=n
/WSEXTENT=n
/WSQUOTA=n
SET RESTART_VALUE=string
SET RIGHTS-LIST id-name[,...]
/ ATTRIBUTES=(key word[,...])
/DISABLE
/ENABLE
/IDENTIFICATION=pid
/PROCESS[=process-name]
/SYSTEM
SET RMS-DEFAULT
/BLOCK_COUNT=count
/BUFFER_COUNT=count
/DISK
/EXTEND_QUANTITY=n
/INDEXED
/MAGTAPE
/NETWORK_BLOCK_COUNT=count
/PROLOG=n
/RELATIVE
/SEQUENTIAL (default)
/SYSTEM
/UNIT-RECORD
SET SYMBOL
/SCOPE=(keyword,...)
SET TERMINAL [device-name[:]]
/ADVANCED-VIDEO
/NOADVANCED_VIDEO
/ALTYPEAHD
/NOALTYPEAHD
/ANSI_CRT
/NOANSI-CRT
/APPLICATION-KEYPAD
/AUTOBAUD
/NOAUTOBAUD
/BLOCK-MODE
/NOBLOCK_MODE
/BRDCSTMBX
/NOBRDCSTMBX

DCL-55

DCL-56

DCL Commands, Utilities, and Lexical Functions

/BROADCAST (default)
/NOBROADCAST
/CRFILL[=formula]
/DEC_CRT[=(valuel,value2)]
/NODEC_CRT[=(valuel,value2)]
/DEVICE _T YPE=terminal-type
/DIALUP
/NODIALUP (default)
/DISCONNECT
/NODISCONNECT (default)
/DISMISS
/NODISMISS (default)
/DMA
/NODMA
/ECHO (default)
/NOECHO
/EDIT_MODE
/NOEDIT_MODE
/EIGHT-BIT
/NOEIGHT_BIT
/ESCAPE
/NOESCAPE (default)
/FALLBACK
/NOFALLBACK
/FRAME=n
/FORM
/NOFORM
/FULLDUP
/NOFULLDUP (default)
/HALFDUP (default)
/NOHALFDUP
/HANGUP
/NOHANGUP (default)
/HARDCOPY
/NOHARDCOPY
/HOSTSYNC
/NOHOSTSYNC (default)
/INQUIRE
/INSERT
/LFFILL[=formula]
/LINE_EDITING
/NOLINE-EDITING
/LOCAL-ECHO
/NOLOCAL-ECHO (default)
/LOWERCASE
/NOLOWERCASE
/MANUAL
/MODEM
/NOMODEM
/NUMERIC-KEYPAD (default)
/OVERSTRIKE (default)
/PAGE[=n]
/PARITY[=option]
/NOPARITY (default)
/PASTHRU
/NOPASTHRU (default)
/PERMANENT
/PRINTER-PORT
/NOPRINTER-PORT
/PROTOCOL=DDCMP
/PROTOCOL=NONE (default)
/READSYNC
/NOREADSYNC (default)
/REGIS
/NOREGIS
/SCOPE
/NOSCOPE
/SET-SPEED
/NOSET-SPEED
/SECURE-SERVER
/NOSECURE-SERVER (default)
/SIXEL -GRAPHICS
/NOSIXEL -GRAPHICS
/SOFT-CHARACTERS
/NOSOFT-CHARACTERS
/SPEED=rate

DCL Commands, Utilities, and Lexical Functions

/SWITCH=DECNET
/SYSPASSWORD
/NOSYSPASSWORD (default)
/TAB
/NOTAB
/TTSYNC (default)
/NOTTSYNC
/TYPE-AHEAD (default)
/NOTYPE_AHEAD
/UNKNOWN
/UPPERCASE
/NOUPPERCASE
/WIDTH=n
/WRAP (default)
/NOWRAP
SET TIME[=time]
SET UIC uic
SET [NO]VERIFY[=([NO]PROCEDURE, [NO]IMAGE)]
SET VOLUME device-spec[:][,...]
/ACCESSED[=n]
/DATA_CHECK[=(option[,...])]
/ERASE_ON_DELETE
/NOERASE_ON-DELETE (default)
/EXTENSION[=n]
/FILE_PROTECT10N=(code)
/HIGHWATER-MARKING
/NOHIGHWATER-MARKING
/LABEL=volume-label
/LOG
/NOLOG (default)
/MOUNT-VERIFICATION
/NOMOUNT-VERIFICATION
/OWNER_UlC[=uic]
/PROTECTION=(code)
/REBUILD
/RETENTION=(min[,max])
/UNLOAD (default)
/NOUNLOAD
/USER_NAME[=user-name]
/WINDOWS[=n]
SET WORKING-SET
/ADJUST (default)
/NOADJUST
/EXTENT=n
/LlMlT=n
/LOG
/NOLOG (default)
/QUOTA=n
SHOW option
SHOW ACCOUNTING

dcl-57

DCL-58

DCL Commands, Utilities, and Lexical Functions

SHOW ACL
/OBJECT_TYPE=type
SHOW AUDIT
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW BROADCAST
/OUTPUT[=me-spec]

/NOOUTPUT

SHOW CLUSTER
/BEGINNING=time
/CONTINUOUS
/ENDING=time
/INTERVAL=seconds
/OUTPUT[=file-spec]
Interactive Commands:
@ (Execute Procedure)
ADD CIRCUITS
/ALL
/TYPE=ALL
/TYPE=[NO]OPEN
ADD CLUSTER
/ALL
ADD CONNECTIONS
/ALL
/TYPE=ALL
/TYPE=[NO]OPEN
ADD COUNTERS
/ALL
ADD CREDITS
/ALL
ADD ERRORS
/ALL
ADD (Field)
ADD LOCAL-PORTS
/ALL
ADD MEMBERS
/ALL

/INTERVAL=15 (default)
/NOOUTPUT

DCL Commands, Utilities, and Lexical Functions

ADD SYSTEMS
/ALL
/ID=system-id
/NODE=node-name
/TYPE=hardware-type
DEFINE/KEY
/[NOJECHO
/[NO]ERASE
/[NO]IF_STATE
/[NO]LOCK_STATE
/[NO]LOG
/[NO]SET_STATE
/[NO]TERMINATE
DESELECT
EXIT
HELP
INITIALIZE
MOVE direction value
PAN direction value
REFRESH
REMOVE CIRCUITS
/TYPE=ALL
/TYPE=[NO]OPEN
REMOVE CLUSTER
REMOVE CONNECTIONS
/TYPE=ALL
/TYPE=[NO]OPEN
REMOVE COUNTERS
REMOVE CREDITS
REMOVE ERRORS
REMOVE (Field)
REMOVE LOCAL-PORTS
REMOVE MEMBERS
REMOVE SYSTEMS
/ID=system-id
/NODE=node-name
/TYPE=hardware-type
SAVE [file-spec]
SCROLL direction value
SELECT [window-name]
SET AUTO-POSITIONING (ON,OFF)
SET (Field)
/WIDTH=field-name-width
/FORMAT=radix

DCL-59

DCL-60

DCL Commands, Utilities, and Lexical Functions

SET FUNCTION function-name
SET INTERVAL
SET SCREEN
WRITE [file-spec]
/ALL
SHOW CPU
SHOW DEFAULT
SHOW DEVICES [device-name[:]]
/ALLOCATED
/BRIEF (default)
/FILES
/FULL
/MOUNTED
/OUTPUT[=fiIe-spec]
/NOOUTPUT
/SYSTEM
/NOSYSTEM
/WINDOWS
SHOW DEVICES/SERVED
/ALL
/COUNT
/HOST
/OUTPUT=[fiIespec]
/RESOURCE
SHOW ERROR
/FULL
/OUTPUT[=fiIe-spec]

/OUTPUT=SYS$OUTPUT (default)

SHOW INTRUSION
/OUTPUT[=fiIe-spec]
/TYPE=keyword
SHOW KEY [key-name]
/ALL
/BRIEF (default)
/NOBRIEF
/DIRECTORY
/FULL
/NOFULL (default)
/STATE=(state-name[,...])
/NOSTATE
SHOW LOGICAL [IogicaI-name[;],[...]]
/ACCESS_MODE=mode
/ALL (default)

DCL Commands, Utilities, and Lexical Functions

/DESCENDANTS
/NODESCENDANTS (default)
/FULL
/GROUP
/JOB
/LITERAL
/NOLITERAL
/OUTPUT[=file-spec]
/NOOUTPUT
/PROCESS
/RESIDENCE
/NORESIDENCE
/STRUCTURE
/NOSTRUCTURE (default)
/SYSTEM
/TABLE=(name[,...])
SHOW MAGTAPE device-name[:]
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW MEMORY
/ALL (default)
/FILES
/FULL
/OUTPUT[=file-spec]
/PHYSICAL-PAGES
/POOL
/SLOTS

/NOOUTPUT

SHOW NETWORK
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW PRINTER device-name[:]
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW PROCESS [process-name]
/ACCOUNTING
/ALL
/CONTINUOUS
/IDENTIFICATION=pid
/MEMORY
/OUTPUT[=file-spec]
/NOOUTPUT
/PRIVILEGES
/QUOTAS
/SUBPROCESSES
SHOW PROTECTION

DCL-61

DCL-62

DCL Commands, Utilities, and Lexical Functions

SHOW QUEUE [queue-name]
/ALL
/BATCH
/BRIEF (default)
/DEVICE
/FILES
/FULL
/OUTPUT[=Hle-spec]

/NOOUTPUT

SHOW QUEUE/CHARACTERISTICS [characteristic-name]
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW QUEUE/FORM [form-name]
/BRIEF (default)
/FULL
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW QUOTA
/DISK[=device-name[:]]
/USER=uic
SHOW RMS_DEFAULT
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW STATUS
SHOW SYMBOL [symbol-name]
/ALL
/GLOBAL
/LOCAL
/LOG (default)

/NOLOG

SHOW SYSTEM
/BATCH
/FULL
/NETWORK
/OUTPUT[=file-spec]
/PROCESS (default)
/SUBPROCESS

/NOOUTPUT

SHOW TERMINAL [device-name[:]]
/OUTPUT[=file-spec]
/PERMANENT

/NOOUTPUT

DCL Commands, Utilities, and Lexical Functions

SHOW [DAY]TIME
SHOW TRANSLATION logical-name
/GROUP
/PROCESS
/SYSTEM
/TABLE=name
SHOW USERS [username]
/OUTPUT[=file-spec]

/NOOUTPUT

SHOW WORKIN_SET
/OUTPUT[=aie-spec]

/NOOUTPUT

SORT input-file-spec[,...] output-file-spec
/COLLATING _SEQUENCE=sequence
/DUPLICATES
/NODUPLICATES
/KEY=(field[,...])
/PROCESS=type
/SPECIFICATION[=file-spec]
/STABLE
/NOSTABLE
/STATISTICS
/NOSTATISTICS
/WORK_FILES=n
/FORM AT=(fiIe-attribute[,...])
/ALLOCATION=n
/BUCKET_SIZE=n
/CONTIGUOUS
/FORMAT=(record-format[,...])
/INDEXED-SEQUENTIAL
/OVERLAY
/RELATIVE
/SEQUENTIAL
SPAWN [command-string]
/CARRIAGE -CONTROL
/NOCARRIAGE -CONTROL
/CLI=cli
/NOCLI
/INPUT=file-spec
/KEYPAD (default)
/NOKEYPAD
/LOG (default)
/NOLOG
/LOGICAL-NAMES (default)
/NOLOGICAL-NAMES
/NOTIFY
/NONOTIFY (default)
/OUTPUT=file-spec
/PROCESS=subprocess-name
/PROMPT[=string]

dcl-63

DCL-64

DCL Commands, Utilities, and Lexical Functions

/SYMBOLS (default)
/NOSYMBOLS
/TABLE=command-table
/WAIT (default)
/NOWAIT
START/CPU
START/QUEUE queue-name[:]
/ALIGN[=(option[,...])]
/BACKWARD=n
/BASE_PRIORITY=n
/BATCH
/NOBATCH (default)
/BLOCK_LIMIT=([lowlim,]uplim)
/NOBLOCK_LIMIT
/CHARACTERISTICS=(characteristic[,...])
/NOCHARACTERISTICS
/CPUDEFAULT=time
/CPUMAXIMUM=time
/DEFAULT=(option[,...])
/NODEFAULT
/DISABLE-SWAPPING
/NODISABLE-SWAPPING (default)
/ENABLE-GENERIC (default)
/NOENABLE-GENERIC
/FORM -MOUNTED=type
/FORWARD=n
/GENERIC[=(queue-name[,...])]
/NOGENERIC (default)
/JOB_LIMIT=n
/LIBRARY=file-name
/NOLIBRARY
/NEXT
/ON=[node::]device[:] (printer, terminal, server queue)
/OWNER-UIC=uic
/PROCESSOR=file-name
/NOPROCESSOR
/PROTECTION=(codes)
/RECORD-BLOCKING (default)
/NORECORD-BLOCKING
/RETAIN[=option]
/NORETAIN
/SCHEDULE=[NO]SIZE
/SEARCH="search-string"
/SEP ARATE=(option[,...])
/NOSEPARATE
/TERMINAL
/NOTERMINAL
/TOP-OF-FILE
/WSDEFAULT=n
/WSEXTENT=n
/WSQUOTA=n
START/QUEUE/MANAGER [file-spec]
/BUFFER_COUNT=n
/EXTEND-QUANTITY=n
/NEW-VERSION
/NONEW-VERSION (default)
/RESTART
/NORESTART (default)

DCL Commands, Utilities, and Lexical Functions

dcl-65

STOP [process-name]
/IDENTIFICATION=pid
STOP/CPU
STOP/QUEUE queue-name[:]
STOP/QUEUE/ABORT queue-name[:]
STOP/QUEUE/ENTRY=entry-number queue-name[:]
STOP/QUEUE/MANAGER
STOP/QUEUE/NEXT queue-name[:]
STOP/QtJEUE/REQUEUE[=queue-name] queue-name[:]
STOP/QUEUE/ENTRY=entry-number/REQUEUE[=queue-name] queue-name[:]
/ENTRY=entry-number
/HOLD
/PRIORITY=n
STOP/QUEUE/RESET queue-name[:]
SUBMIT file-spec[,...]
/AFTER=time
/NOAFTER
/BACKUP
/NOBACKUP
/BEFORE[=time]
/NOBEFORE
/BY_OWNER[=uic]
/NOBY_OWNER
/CHARACTERISTICS=(characteristic[,...])
/CLI=filename
/CONFIRM
/NOCONFIRM (default)
/CPUTIME=option
/CREATED (default)
/NOCREATED
/DELETE
/NODELETE (default)
/EXCLUDE=(file-spec[,...])
/NOEXCLUDE
/EXPIRED
/NOEXPIRED
/HOLD
/NOHOLD (default)
/IDENTIFY (default)
/NOIDENTIFY
/KEEP
/NOKEEP
/LOG_FILE[=file-spec]
/NOLOG_FILE
/MODIFIED
/NOMODIFIED
/NAME=job-name
/NOTIFY
/NONOTIFY (default)
/PARAMETERS=(parameter[,...])
/PRINTER[=queue-name]
/NOPRINTER
/PRIORITY=n

DCL-66

DCL Commands, Utilities, and Lexical Functions

/QUEUE=queue-name[:]
/REMOTE
/RESTART
/NORESTART (default)
/SINCE[=time]
/NOSINCE
/USER=usemame
/WSDEFAULT=n
/WSEXTENT=n
/WSQUOTA=n
SYNCHRONIZE [job-name]
/ENTRY=entry-number
/QUEUE=queue-name[:]
TYPE file-spec[,...]
/BACKUP
/BEFORE[=time]
/BY_OWNER[=uic]
/CONFIRM
/NOCONFIRM (default)
/CREATED (default)
/EXCLUDE=(file-spec[,...])
/EXPIRED
/MODIFIED
/OUTPUT[=file-spec]
/NOOUTPUT
/PAGE
/NOPAGE (default)
/SINCE[=time]
UNLOCK file-spec[,...]
/CONFIRM
/NOCONFIRM (default)
/LOG
/NOLOG (default)
WAIT delta-time
WRITE logical-name expression[,...]
/ERROR=label
/SYMBOL
/UPDATE

EDT Editor
The material presented here is a supplement to the Introduction to the EDT Editor and
the VAX EDT Reference Manual. It is intended as a summary and memory refresher
for the commands and functions covered in the EDT manuals. You should have the
VAX EDT Reference Manual available for further information on the topics covered.
Included is a summary of all EDT functions, commands, specifiers, and qualifiers.
There is also a brief description of these special EDT features:
•

Journal Files

•

Startup Command Files

•

Keypad Key Definitions

•

EDT Macros

EDT.1

Summary of EDT

EDT is an interactive text editor that has three distinct editing modes: keypad, line,
and nokeypad. Both the keypad and nokeypad modes are screen editors. Line mode
can be used on any type of terminal—hardcopy or screen.
With the EDT editor you can create and edit almost all types of text files. When you
are editing a file, you can add or delete text, move or copy text from one place to
another, save or discard your editing work.
To call up the EDT editor, you must use a system command: EDIT. Include the name
of the file you want to edit on the command line. For example:
$

EDIT LETTER.DAT

If a file named LETTER.DAT exists in the current directory, EDT puts a copy of that
file into the MAIN buffer in your EDT session. Then EDT displays the first line from
the file on your screen or paper, followed by the line mode asterisk prompt (*). You
are now ready to begin your EDT session.

EDT-2

EDT Editor
Summary of EDT

If you are using EDT to create a new file called LETTER.DAT, your session starts off
like this:
$
EDIT LETTER.DAT
Input file does not exist
[EOB]
*

The message "Input file does not exist" tells you that no text was copied to the MAIN
buffer. The end-of-buffer mark ([EOB]) is printed in place of the first line, since there
is no text to display. The next step is to insert some text in the buffer, using one of
the three editing modes.
When you start your editing session, EDT's default mode is line mode. To shift to
keypad mode, use the line mode CHANGE command. To shift back to line mode
from keypad mode, use CTRL/Z.
To go from line mode to nokeypad mode, you must first give the SET NOKEYPAD
command and then the CHANGE command. The nokeypad EX command shifts EDT
from nokeypad editing back to line mode.
You can use EDT's online HELP facility any time during your editing session. The
line mode HELP command supplies general information on EDT as well as details on
line mode and nokeypad mode commands. The HELP command by itself provides
information on using the HELP facility and a list of topics that you can get help on.
For help on a specific topic, type the HELP command followed by the topic name,
for example, HELP EXIT.
When you are in keypad mode, press the HELP key (HELP on VT200-type terminals;
PF2 on VTlOO-type terminals; red on VT52s). EDT displays a diagram of the keypad,
a list of other keypad editing keys, and tells you to press the key you want help on.
You must use the line mode HELP command to get information on nokeypad
editing. The relevant topics are HELP CHANGE, HELP CHANGE SCREEN,
HELP CHANGE ENTITIES, and HELP CHANGE SUBCOMMANDS. Nokeypad
command descriptions are found under the SUBCOMMANDS topic. Thus, if
you want information on the BELL command, you must type HELP CHANGE
SUBCOMMANDS BELL.

EDT Editor

EDT-3

Keypad Mode

EDT.2 Keypad Mode
Keypad mode uses the numeric keypad located to the right of the main keyboard on
VT 100-type and VT52 terminals. On terminals with LK201 keyboards, there are two
keypads to the right of the main keyboard. The numeric keypad at the right edge of
the keyboard corresponds to the VTIOO keypad.
The arrow keys on VTIOO-type terminals are considered to be part of the keypad.
On terminals with LK201 keyboards, the arrow keys are located at the bottom of the
second keypad.
Four keyboard keys have special editing functions: BACKSPACE, DELETE,
LINEFEED, and TAB. On the LK201 keyboard, the BACKSPACE and LINEFEED keys
are located in the row of function keys across the top of the keyboard. (BACKSPACE
is key FI2; LINEFEED is key FI3.)
In addition EDT has preset functions for several control key sequences:
A*
C
D*
E*
F (VT52 only)
H

I
J
K
L
M

R*
T*
U*
W*

* These letters have preset functions with GOLD as well as with CTRL.
Most keypad keys have two editing functions associated with them. To use the
upper (or primary) function (for example, FNDNXT) simply press the indicated key.
To use the lower (or alternate) function (for example, FIND), first press the GOLD
key (PFl on VTIOO; blue on VT52) and then the keypad key. Figure EDT-1 shows
the default keypad editing keys for popular terminal types. (At the bottom of each
key representation is the keypad key number, for use with the DEFINE KEY and
SHOW KEY commands.)

4
ADVANCE

5
BACKUP

BOTTOM

TOP

CUT

DEL C

PASTE

UND C
6

5
BACKUP

BOTTOM

TOP

2
WORD

EOL

CHAR

CHNGCASE

DEL EOL

SPECINS

CHNGCASE

ENTER

•

WORD

4
ADVANCE

ENTER

DEL EOL
2

•

LINE

SELECT

OPEN LINE

RESET

LINE
SUBS
OPEN LINE
2J

VTIOO

VT52

Keypad F^diting Keys - LK201 Keyboard

CPF1

PF2

GOLD
Help

function 28

Function 29

HELP
20

SECT

COMMAND
Find

Insert
Here

Remove

Function 1

Function 2

Function 3

Sol oc t

Prev
Screen

Next
Screen

^Function 4

Function 5

Function 6

FILL

4
ADVANCE

5
BACKUP

BOTTOM

TOP
4

2
EOL

CHNGCASE

DEL EOL

R
8

WORD

8
PAGE

•

0
LINE

V
VT200 Series

OPEN LINE
0

EDT Editor

edt-5

Keypad Mode

EDT.2.1 EDT Keypad Functions
ADVANCE
Sets the editing direction to forward: to the right and toward the bottom of the
buffer.
APPEND
Deletes the select range from the current buffer; appends it to the end of the
PASTE buffer.
BACKSPACE (CTRL/H)
Moves the cursor to the beginning of the current line or the previous line.
BACKUP
Sets the editing direction to backward: to the left and toward the top of the
buffer.
I GOLD I BOTTOM

Moves the cursor to the end of the current buffer.
CHAR (VT100 only)
Moves the cursor one character in the current direction.

I GOLD ICHNGCASE (change case)
Changes the case of all letters in the select range or current search string, or the
case of the current letter.
CTRL/A (tab compute) (IgoldI A)
Resets the tab indentation level to the current cursor position if that position is a
multiple of the current SET TAB value.
CTRL/C (abort operation)
Aborts certain EDT operations, such as searches.
CTRL/D (tab decrement) (IgoldI Pl
Reduces the current tab level count by one.
CTRL/E (tab increment) (IgoldI E)
Increases the current tab level count by one.
CTRL/H (same as BACKSPACE)
CTRL/I (same as TAB)
CTRL/J (same as LINEFEED)

EDT-6

EDT Editor
Keypad Mode

CTRL/K (define key)
Activates EDT's define key facility. See the section on key definitions.
CTRL/L (form feed)
Inserts a form feed character in your text.
CTLR/M (same as RETURN)
CTRL/R ([goldIR)
Refreshes the screen.
CTRL/T (tab adjust) (IgoldIT)
Indents each line in the select range.
CTRL/U ([goldIU)
Deletes text from the current cursor position to the beginning of the line.
Generally, does not delete the line terminator. The deleted text replaces the
contents of the delete line buffer. Cancels the FIND, COMMAND, and CTRL/K
functions.
CTRL/W ffGOLblW)
Refreshes the screen.
CTRL/Z ([goldIZ)
Shifts from keypad mode to line mode.
CUT
Deletes the select range and places it in the PASTE buffer. The previous contents
of the PASTE buffer are deleted.
DEL C (delete character)
Deletes the character that the cursor is on. The deleted character replaces the
contents of the delete character buffer.
I GOLD I DEL EOL (delete to end of line)

Deletes text from the current cursor position to the end of the line. Generally,
does not delete the line terminator. The deleted text replaces the contents of the
delete line buffer.
DELETE
Deletes the character to the left of the current cursor position. The deleted
character replaces the contents of the delete character buffer.

EDT Editor

EDT-7

Keypad Mode

DEL L (delete line)
Deletes text from the current cursor position to the beginning of the next line,
deleting the line terminator. The deleted line replaces the contents of the delete
line buffer.
DEL W (delete word)
Deletes characters from the current cursor position to the beginning of the next
word. The deleted word replaces the contents of the delete word buffer.
DO (LK201 only)
Sends a command or search string to EDT for processing.
DOWN (down arrow)
Moves the cursor down to the position on the next line that corresponds to the
current cursor position.
ENTER
Sends a command or search string to EDT for processing. Completes the
CTRL/K key definition process.
EOL (end of line)
Moves the cursor to the next line terminator in the current EDT direction.
[goldI fill (VT52 = CTRL/F)

Reformats the text in the select range so that as many whole words as possible
are included within the current EDT SET SCREEN width (80 or 132) or SET
WRAP value. If SET WRAP is in effect, EDT uses that value rather than the SET
SCREEN width.
I GOLD I FIND

Locates the search string that you type when EDT displays the "Search for:"
prompt.
FNDNXT (find next)
Locates the next occurrence of the current search string in the current direction.
GOLD
Accesses alternate keypad functions. Also used with keyboard digits to repeat
keypad functions. Used with keyboard keys and control keys to form key
sequences for defining. (See Defining Keys.)
HELP
Provides information on keypad mode editing keys.

EDT-8

EDT Editor
Keypad Mode

LEFT (left arrow)
Moves the cursor one character to the left.
LINE
Moves the cursor to the beginning of the next line in the current EDT direction.
LINEFEED (CTRL/J)
Deletes characters from the current cursor position to the beginning of the word
that the cursor is in. If the cursor is at the beginning of a word, the previous
word is deleted. The deleted word replaces the contents of the delete word
buffer.
[goldI open line

Adds a line terminator to the right of the current cursor position. The cursor
does not move.
PAGE
Moves the cursor to the next EDT page boundary in the current EDT direction.
<FF> is the default page boundary. Moves the cursor to the top or bottom of
the buffer if there are no page markers in the text.
[gold! paste

Inserts the contents of the PASTE buffer to the left of the cursor.
[gold] replace

Deletes the select range and replaces it with the contents of the PASTE buffer.
[goldI reset

Cancels the select range and sets EDT's direction to forward. Can be used after
CTRL/K to cancel the text that you have entered on the definition line.
RETURN
Inserts a line terminator in the text. The cursor moves to the beginning of the
new line.
RIGHT (right arrow)
Moves the cursor one character to the right.
SECT (section)
Moves the cursor 16 lines in the current EDT direction.
+SECT (LK201 only)
Moves the cursor 16 lines forward.

EDT Editor

edt-9

Keypad Mode

-SECT (LK201 only)
Moves the cursor 16 lines backward.

SELECT
Marks one end of a select range. When you move the cursor again, the characters
that the cursor passes over become the select range.

I GOLD ISPECINS (special insert)
Allows you to insert any character from the DEC multinational character set into
your text by entering the decimal equivalent value for that character.

I GOLD I SUBS (substitute)
Replaces the next occurrence of the current search string in your text with the
contents of the PASTE buffer.

TAB (CTRL/I)
Moves the text that is to the right of the cursor (including the cursor character) to
the right to the nearest preset EDT tab stop. If the cursor is at the first column
position of a line and SET TAB is in effect, indents the line to the current tab
level.

IgoldITOP
Moves the cursor to the beginning of the current buffer.

I GOLD I UNO C (undelete character)
Inserts the contents of the delete character buffer to the left of the cursor.

[g^UND L
Inserts the contents of the delete line buffer to the left of the cursor.
[gold] UNO W
Inserts the contents of the delete word buffer to the left of the cursor.

UP (up arrow)
Moves the cursor up to the position on the previous line that corresponds to the
current cursor position.

WORD
Moves the cursor to the beginning of the next word in the current EDT direction.

EDT-10

EDT Editor
Line Mode

EDT.3 Line Mode
Line editing can be used on any interactive terminal. This mode focuses on the
line as the unit of text. Whenever you see the line mode asterisk prompt (*), you
can type a line mode command. The italicized letters in the line mode syntax
statements that follow indicate the minimum abbreviation for both command words
and qualifiers.
Line mode commands use qualifiers and specifiers in addition to commands.
Qualifiers, which modify the way EDT processes the command, are always optional.
You must precede a qualifier with a slash (for example, /QUERY).
Specifiers tell EDT which part of the text to act on. Optional specifiers are enclosed
in square brackets (for example, [=buffer]). The main specifier is range, which refers
to the line or lines affected by the command. Table EDT-1 shows various ways to
specify ranges.
This section contains brief descriptions of the line mode commands, then the
qualifiers, and finally the specifiers.

EDT.3.1 Line Mode Commands
CHANGE [=buffer] [range] [;nokeypad-command(s)]
Shifts EDT to keypad or nokeypad mode. To shift to keypad mode simply use
CHANGE. To shift to nokeypad mode, precede the CHANGE command with the
SET NOKEYPAD command. Whenever SET NOKEYPAD is in effect, you must
issue the SET KEYPAD command before typing CHANGE to shift to keypad
mode.
CLEAR buffer
Deletes the entire buffer from your EDT session. The name of the cleared buffer
no longer appears in the SHOW BUFFER list unless the cleared buffer is MAIN
or PASTE. Do not precede the buffer name with either an equal sign or the word
BUFFER.
COPY [=buffer-1] [range-1] TO [=buffer-2] [range-2] [/QUERY] [/DUPLICATED]
Makes a copy of the text specified by location-1 and puts the copy in location-2.
The text remains in location-1 as well. The default for location-1 and location-2
is the current line.
CTRL/C
Aborts certain EDT operations such as WRITE, PRINT, and TYPE. If the
operation is aborted, EDT displays "Aborted by CTRL/C." If the operation is
not aborted, EDT displays "CTRL/C ignored."

EDT Editor

edt-11

Line Mode

CTRL/R
Refreshes the current line, leaving EDT at the end of the line, enabling you to
type additional characters on that line.
CTRL/Z
Causes EDT to exit from the insert state. Use after INSERT and REPLACE.
DEFINE KEY key-name AS “string”
Defines a keypad editing key. You must use the line mode DEFINE KEY
command in startup command files and EDT macros. Key name is the spelledout version which uses CONTROL for the CTRL key and the special keypad
numbers for keypad keys. (See Figure EDT-1 for EDT's special keypad numbers.)
The string parameter is one or more nokeypad commands, enclosed in quotation
marks. (See Defining Keys.)
DEFINE MACRO macro-name
Defines the name of an EDT buffer containing the macro to be a new line mode
command for the duration of your EDT session. (See EDT Macros.)
DELETE [=buffer] [range] [/QUERY]
Deletes the specified text. If you supply no specifiers, EDT deletes the current
line.
EXIT [file-spec] [/SEQUENCE[:initial[:increment]]] [/SAVE]
Ends the EDT session, saving a copy of the MAIN buffer text in an external file.
If you supply a file specification, EDT creates a file with that name and copies
the contents of the MAIN buffer into that file.
FILL [=buffer] [range]
Reformats lines of text so as many whole words as possible are included within
the current EDT SET SCREEN width or SET WRAP value. If SET WRAP is in
effect, FILL uses that value rather than the SET SCREEN width. If you supply
no specifiers, EDT assumes that a screen mode select range is active.
FIND [=buffer] [range]
Moves EDT to the specified buffer or range. No text is displayed. If you supply
no specifiers, EDT remains at the current line.
HELP [topic [subtopic ... ] ]
Displays information on various EDT topics at your terminal. If you supply no
topic, HELP gives information on how to use the EDT HELP facility.
INCLUDE file-spec [=buffer] [range]
Copies the specified file into the current EDT session. If you give no location
specifiers, the copy is placed above the current line.

EDT-12

EDT Editor
Line Mode

INSERT [=buffer] [range] I return | text Ictrl/z|
INSERT [=buffer] [range] ;line-to-be-inserted
Inserts text at the specified location. If you give no location, EDT inserts the text
above the current line. The first form enables you to insert as many lines as you
need. The second form can accommodate only one line of text at a time.

MOVE [=buffer-1] [range-1] TO [=buffer-2] [range-2] [/QUERY]
Deletes the text from location-1 and inserts it at location-2. The default for
location-1 and location-2 is the current line.

<null> (implied TYPE) [=buffer] [range]
The <null> command consists simply of one or both location specifiers. EDT
displays the lines that are specified as the command. When a range that consists
of an English word (such as BEGIN, END, REST) is the first element of the
<null> command, that word must be preceded by a percent sign (%), for
example %BEGIN, %END, %REST.

PRINT file-spec [=buffer] [range]
Creates a file that contains a copy of the text you specify. Adds a form feed and
two blank lines to the top of the file and every 60 lines. Changes the EDT line
numbers into elements of text. If you give no location specifiers, EDT copies the
entire current buffer.

QUIT [/SAVE]
Ends your EDT session without saving a copy of your editing work. The /SAVE
qualifier saves only a copy of the journal file, not the edited text.

REPLACE [=buffer] [range] I return! text |ctrl/z|
REPLACE [^buffer] [range] ;line-to-be-inserted
Deletes the text specified by buffer or range and shifts to the insert state. If you
give no location specifiers, EDT deletes the current line. The first form enables
you to insert as many lines as you need. The second form can accommodate
only one line of text at a time.

RESEQUENCE [=buffer] [range] [/SEQUENCE [:initial [increment] ] ]
Renumbers the EDT line numbers for the specified location. If you supply no
location, EDT renumbers the entire current buffer. The default values for initial
and increment are 1. If you omit the /SEQUENCE qualifier, EDT uses those
default values.

SUBSTITUTE/[string-1]/string-2/ [=buffer] [range] [/BRIEF[:n]] [/QUERY]
[/NOTYPE]
Replaces string-1 with string-2. If you omit string-1, EDT uses the current
search string. If you supply no location specifiers, the substitution takes place
on the current line. You can replace the slashes surrounding the strings with

EDT Editor

edt-13

Line Mode

any punctuation mark (except % and _) that does not occur in either string. You
must always use the slash to indicate any qualifiers in the command line.

[SUBSTITUTE] NEXT[/[string-1]/string-2/]
Replaces the next occurrence of string-1 with string-2. If the string to be deleted
is the current search string and the replacement string is the current substitute
string, you do not have to include either the strings or the delimiters with the
command. If you choose to use the word or abbreviation for SUBSTITUTE, you
must separate it from NEXT (or N) with a space. You can replace the slashes
surrounding the strings with any punctuation mark (except % or _) that does not
occur in either string.

TAB ADJUST [-]n [=buffer] [range]
Indents the specified line(s) by the current SET TAB value multiplied by the level
count n. Use the minus sign to move indented text back toward the left margin.
If you supply no location specifiers, EDT assumes that a screen mode select range
is active.

TYPE [=buffer] [range] [/BRIEF[:n]] [/STAY]
Displays the specified lines at your terminal. If you supply no location specifiers,
EDT displays the current line. If you specify a buffer without a range, EDT
displays the entire buffer.

WRITE file-spec [=buffer] [range] [/SEQUENCE [rinitial [:increment] ] ]
Puts a copy of the lines specified into the specified file. If you supply no location
specifiers, EDT copies the entire current buffer.

EDT.3.2 Line Mode Qualifiers
Line mode qualifiers affect the way EDT processes a command. You can only use
certain qualifiers with certain commands. Whenever you use a qualifier, you must
type the slash before the qualifier name to signal EDT that the following letters refer
to a qualifier, not a command word or string. Qualifiers are always the last elements
in a line mode command line.

/BRIEF[:n]
EDT displays only the first n characters of a line or lines. The default value for n
is 10. Use with SUBSTITUTE and TYPE.

/DUPLICATED
EDT copies the text n times in the same location. Use with COPY.

/NOTYPE
EDT displays only the substitution message, not the lines in which substitutions
took place. Use with SUBSTITUTE.

EDT-14

EDT Editor
Line Mode

/QUERY
EDT prompts with a question mark to verify if you want the operation performed
on the particular line it has just displayed. Use with COPY, DELETE, MOVE,
and SUBSTITUTE. The responses are:
Y (YES)

Perform the command on this line.

N (NO)

Do not perform the command on this line.

A (ALL)

Perform the command on all remaining lines.

Q (QUIT)

Do not perform the command on any remaining lines.

/SAVE
EDT saves a copy of the journal file in the current directory. Use with EXIT and
QUIT.

/SEQUENCE [increment [linitial] ]
With RESEQUENCE, assigns new line numbers to the specified lines. The
default values for initial and increment are 1.
With EXIT and WRITE, /SEQUENCE causes the EDT line numbers to be retained
as sequence numbers in the external file. EDT uses these sequence numbers as
EDT line numbers when you next edit the file. If initial and increment are
omitted, EDT uses the EDT line numbers as the sequence numbers.

/STAY
Maintains EDT's current position in the text regardless of which lines you have
asked EDT to display. Use with TYPE.

EDT.3.3 Line Mode Specifiers
Line mode specifiers refer to information that you supply to EDT. In place of the
specifier name, type the name of a buffer, key, or macro (for example, CLEAR
PASTE). See Table EDT-1 for details on the range specifier.

buffer
The name of an EDT buffer (text storage area). When you use buffer with
the CLEAR command, do not precede it with a buffer signal. With all other
commands, use either the equal sign (=) immediately before the buffer name (for
example, =MAIN) or the word BUFFER followed by a space before the buffer
name (for example, BUFFER MAIN). If the buffer does not exist, EDT creates
one, except in the case of CLEAR. EDT moves to the named buffer, except for
CLEAR, WRITE, and PRINT.

file-spec
The specification for an external file. Can include a directory specification. With
INCLUDE, tells EDT which file to copy into your editing session. With EXIT,
PRINT, and WRITE, tells EDT which file to create to hold text from your editing

EDT Editor

EDT-15

Line Mode

session. If you include directory information, the directory must exist and you
must have access to it.

key-name
The name of the key you want to define with your DEFINE KEY command. Use
the special EDT key name, (for example, CONTROL B for CTRL/B) or keypad
key number to designate the key. (See Figure EDT-1.)

macro-name
The name of the macro you are defining, which must be the name of the buffer
containing the macro.

nokeypad-command(s)
One or more nokeypad commands joined on a single line. Separate the
nokeypad command(s) from the CHANGE command with a semicolon (;).

range
One or more lines of text. See Table EDT-1.

String
A group of contiguous characters. In line mode, the string specifier is the
nokeypad definition used with DEFINE KEY.

string-1, string-2
String-1 is always the search string; string-2 is always the substitute string. In
substitute commands, EDT always replaces string-1 with string-2.

Table EDT-1
Range Type
or Symbol

The Range Specifier

Description
The current line

number

The EDT line number

"string" or 'string^

The next line containing the quoted string

BEGIN

The first line of the buffer

END

The last line of the buffer

WHOLE

The entire buffer

BEFORE

All lines from the top of the buffer to the current line

REST

All lines from the current line to the end of the buffer

LAST

The last line worked on in the previous buffer

EDT-16

EDT Editor
Line Mode

Table EDT-1 (Cont.)
Range Type
or Symbol

The Range Specifier

Description

SELECT

A select range created in a screen mode (Can include only whole lines.)

, or AND

Joins noncontiguous ranges in a list.

: or THRU

Indicates a group of contiguous lines (for example, TYPE 10 THRU 20 or
TYPE 10:20).

Indicates n lines from the current line (for example TYPE +10).

#n or FOR n

Tells EDT to operate on the next n lines.
Indicates that the range specifier is toward the bottom of the buffer.
Indicates that the range specifier is toward the top of the buffer.

ALL

Refers to all lines containing the quoted string.

Signals EDT that the following characters indicate a range specifier.
Needed only when a <null> command line begins with a letter.

Here are some sample line mode commands with various ranges:
CHANGE 38
DELETE ALL "1983”
FIND -2
INSERT 256.3
•/.BEGIN
REPLACE 7:11
SUBSTITUTE/DEC/DIGITAL/WHOLE
TYPE "July”

COPY 4 THRU 10 TO.
FILL . THRU +10
INCLUDE XFILE.DAT END
MOVE REST TO 27
PRINT SUBPR0G.DAT BEFORE
RESEQUENCE 1 THRU 150
TAB ADJUST 1. 3. 5, 7. 9
WRITE 0UTFILE.DAT SELECT

EDT.4 Nokeypad Mode
Nokeypad mode is a screen editor for use with VT100-type and VT52 terminals.
Text appears on the upper lines of the screen. As you type commands, they are
displayed at the bottom of the screen. When you press RETURN, EDT processes the
commands.
Nokeypad commands are the basis for keypad mode key definitions. Nokeypad
commands consist of English words and abbreviations. A number of commands
take the entity specifier to determine which part of the text will be affected by the
command. Table EDT-2 lists the entity specifiers. Nokeypad specifiers are described
after the nokeypad commands.

EDT Editor

EDT-17

Nokeypad Mode

Nokeypad commands cannot have spaces. For example, to delete two paragraphs
and put the text in a buffer named EXTRA, type CUT2PAR=EXTRA. You can put
several nokeypad commands on the same line. Spaces between commands are
allowed, but not required. You can repeat a series of commands by preceding the
commands with the repeat count and enclosing them in parentheses: for example,
3(V D+EL).

EDT.4.1 Nokeypad Commands
ADV (advance)
Sets EDT's current direction to forward.

APPEND
[+/-l[count]APPEND[+/-][count]entity[=buffer]
Deletes the specified entity from the current buffer and places it at the end of
either the PASTE buffer or the specified buffer.

ASC (ASCII)
[number]ASC
Uses a character's decimal equivalent value to insert that character into the text.
Valid decimal values range from 0 to 255. If you supply no number, EDT inserts
the null character (decimal 0).

BACK (backup)
Sets EDT's current direction to backward.

BELL
Sounds the terminal bell.

CHGC (change case)
[+/-][count]CHGC[+/-][count]entity
Changes the case of all letters in the specified entity. All uppercase letters are
changed to lowercase and all lowercase letters become uppercase.

CHGL (change case lower)
[+/-l[count]CHGL[+/-][count]entity
Changes all uppercase letters in the specified entity to lowercase.

CHGU (change case upper)
[+/-l[count]CHGU[+/-][count]entity
Changes all lowercase letters in the specified entity to uppercase.

EDT-18

EDT Editor
Nokeypad Mode

" (circumflex)
[count]"[character]
Allows you to insert ASCII control characters (decimal values 0 through 31) in
text or command lines. If you supply no character, EDT inserts the null character
(decimal 0).

CLSS (clear search string)
Deletes the contents of the search buffer.

CTRL/C
Aborts certain EDT operations, such as searches.

CTRL/Z
Causes EDT to exit from the insert state. Use with I (insert) and R (replace).

CUT
[+/-][count]CUT[+/-][count]entity[=bufffer]
Deletes the specified entity from the current buffer and places it in either the
PASTE buffer or the specified buffer.

D (delete)
[+/“][count]D[+/-l[count]entity
Deletes the specified entity. If the entity is a character, word or part of a word,
or line or part of a line, the text is stored in one of EDT's special buffers: delete
character buffer, delete word buffer, or delete line buffer.

DATE
Inserts the current date and time into your text.

DEFK (define key)
Used only to define a keypad editing key to perform the key definition process.

DESEL (deactivate select)
Cancels the select range.

DLWC (default lowercase)
Changes EDT's default move state so that wherever the cursor moves, all
uppercase letters are changed to lowercase.

DMOV (default move)
Changes EDT's default move state from either DLWC or DUPC back to the
normal state, in which the case of letters is unaffected by cursor movement.

EDT Editor

edt-19

Nokeypad Mode

*Down Arrow Key
Moves the cursor down to the corresponding column position on the line below
the current line.
♦Not a nokeypad command.

DUPC (default uppercase)
Changes EDT's default move state so that wherever the cursor moves, all
lowercase letters are changed to uppercase.

EX (exit to line mode)
Shifts EDT from nokeypad mode to line mode.

EXT (extend)
EXT line mode command
Enables you to use a line mode command without leaving nokeypad mode.
Cannot be used with parentheses and a repeat count.

FILL
[+/-][count]FILL[+/-][count]entity
Reformats text so that as many whole words as possible are fitted within the
current EDT SET SCREEN width (80, 132) or SET WRAP value. If SET WRAP is
in effect, FILL uses that value rather than the SET SCREEN width.

HELP
Used only to define a keypad editing key to access keypad mode HELP
information.

I (insert)
Itext Z
I I RETURN I text ICTRL/Zl
Allows you to insert text at the current cursor location. The first form inserts the
text that is typed on the command line. Use the second form to insert more than
one line. EDT shifts the cursor back to its former position in the text displayed
on your screen. When you finish inserting the text, press CTRL/Z to exit from
the insert state.

KS (KED substitute)
Used directly after the PASTE command to have EDT position the cursor on
the last character of the inserted text if EDT's direction is forward, or the first
character in the inserted text if EDT's direction is backward.

♦Left Arrow Key
Moves the cursor one character to the left.
♦Not a nokeypad command.

EDT-20

EDT Editor
Nokeypad Mode

“move”
[+/-][count]entity
The "move" command consists simply of the entity specifier with or without a
sign or count specifier. Moves the cursor by the specified entity. If you specify a
string, EDT moves the cursor to that string.

PASTE
[count]PASTE[=buffer]
Inserts the entire contents of the PASTE buffer or the specified buffer into the
text to the left of the cursor.

QUIT
Ends your EDT session without saving a copy of any editing work.

R (replace)
[+/-][count]R[+/-][count]entity
Deletes the specified entity and shifts to the insert state. EDT returns the cursor
to the screen so you can enter new text. Use CTRL/Z to exit from the insert
state.

REF (refresh)
Refreshes the screen.

*Right Arrow Key
Moves the cursor one character to the right.
♦Not a nokeypad command.

S (substitute)
[+/-][count]S/[string-1]/string-2/
Moves to the next occurrence of string-1 and replaces it with string-2. The
slashes surrounding the strings can be replaced by any other punctuation mark
that does not occur in either string, but all three delimiters must be identical.
If string-1 is omitted, the current search string is used.

SEL (select)
Marks one end of a select range. When you move the cursor again, the characters
that the cursor passes over become an active select range.

SHL (shift left)
[count]SHL
Shifts the screen image one tab stop (eight columns) to the left. Has no effect on
the text.

EDT Editor

EDT-21

Nokeypad Mode

SHR (shift right)
[count]SHR
Shifts the screen image one tab stop (eight columns) to the right if the text has
already been shifted to the left. Has no effect on the text.

SN (substitute next)
[+/-][count]SN
Using the current search and substitute strings, locates the next occurrence of the
search string and replaces it with the substitute string.

SSEL (search and select)
[+/-]SSEL[+/-]“string”
Locates the quoted string and makes it an active select range.

TAB
[count]TAB
Moves the text to the right of the cursor (including the cursor character) over
to the nearest preset EDT tab stop. If SET TAB is in effect and the cursor is
in column one of a line, EDT indents the line by the current SET TAB value
multiplied by the current tab level count.

TADJ (tab adjust)
[+/-][level-count]TADJ[+/-][entity-count]entity
Indents lines of text using the current SET TAB value. Use L, PAR, or PAGE for
entity.

TC (tab compute)
Resets the indentation level to the current cursor position if that position is a
multiple of the current SET TAB value.

TD (tab decrement)
[count]TD
Decreases the current tab level count by one or count.

TGSEL (toggle select)
If a select range is active, TGSEL cancels it. If no select range is active, TGSEL
sets one end of the new select range.

Tl (tab increment)
[count]TI
Increases the current tab level count by one or count.

EDT-22

EDT Editor
Nokeypad Mode

TOP
Moves the current cursor line to the top of the screen if there are more than 22
lines between the cursor line and the end of the buffer. If there are less than 22
lines to the end of the buffer, TOP has no effect on the screen image.

UNDO (undelete character)
[count]UNDC
Inserts the contents of the delete character buffer to the left of the cursor.

UNDL (undelete line)
[count]UNDL
Inserts the contents of the delete line buffer to the left of the cursor.

UNDW (undelete word)
[count]UNDW
Inserts the contents of the delete word buffer to the left of the cursor.

*Up Arrow Key
Moves the cursor up to the corresponding column position on the line above the
current line.
♦Not a nokeypad command.

XLATEstring Z
Used with VAX/VMS callable EDT to pass a string to the calling program.

EDT.4.2 Nokeypad Specifiers
Nokeypad specifiers refer to information that you supply to EDT. In place of buffer
and entity, for example, you type the name of the buffer or entity. See Table EDT-2
for a list of nokeypad entities. Note the difference between the string entity and the
string specifier used with commands such as S, SN, and SSEL.
+/Determines the direction for the individual command, but does not change EDT's
current direction. + is to the right, toward the bottom of the buffer;—is to the
left, toward the top of the buffer.

=buffer
When used with CUT or APPEND, determines which storage area to use for
the deleted text. With PASTE, tells EDT where to find the text to insert in the
current buffer.

EDT Editor

edt-23

Nokeypad Mode

count
When count precedes the command, it determines how many times to repeat
the command. When count precedes the entity, it determines how many entities
the command affects. Generally, a repeat count has the same effect as an entity
count (for example, 2DC is the same as D2C).

entity
The portion of text which the command affects. See Table EDT-2.

line mode command
The line mode command line that you type with EXT. EDT performs the line
mode command(s) without leaving nokeypad mode.

String
A search string with SSEL. Information for EDT to send to a program when used
with XLATE.

String-1, string-2
String-1 is always the search string; string-2 is always the substitute string. In
substitute commands, EDT always replaces string-1 with string-2.

Table EDT-2
Entity

The Entity Specifier
Description

Character

Word

Beginning of word

End of word

Line

Beginning of line

End of line

Next line

SEN

Sentence

BSEN

Beginning of sentence

ESEN

End of sentence

PAR

Paragraph

BPAR

Beginning of paragraph

EPAR ♦

End of paragraph

PAGE

Page

EDT-24

EDT Editor
Nokeypad Mode

Table EDT-2 (Cont.)
Entity

The Entity Specifier

Description

BPAGE

Beginning of page

EPAGE ♦

End of page

Select range

"string" or 'string^

All the text between the current cursor position and the quoted string

Beginning of buffer

End of buffer

Vertical

♦ Cannot be used twice in succession or with a repeat count.

EDT.5 The SET and SHOW Commands
SET commands modify the way EDT behaves during your editing session. They
have no effect on the text you are editing. You can use SET commands to customize
your editing session. SHOW commands tell which SET commands are in effect.
Four SHOW commands (SHOW BUFFER, SHOW FILES, SHOW KEY, and SHOW
VERSION) have no corresponding SET commands.

SET AUTOREPEAT
SET NOAUTOREPEAT
SHOW AUTOREPEAT
Enables EDT's use of the DEC ARM VTIOO control sequence to prevent keypad
keys from repeating faster than EDT can update the screen. Default: SET
AUTOREPEAT for most terminals.

SHOW BUFFER
Lists all buffers currently in use during your EDT session. Also lists the number
of lines in each buffer. An equal sign ( = ) indicates the current buffer. An asterisk
(♦ ) next to MAIN indicates that there are more lines in the MAIN buffer, but
EDT has not yet seen them.

SET CASE UPPER
SET CASE LOWER
SET CASE NONE
SHOW CASE
Flags upper- or lowercase letters on single-case terminals. Default: SET CASE
NONE.

EDT Editor

edt-25

The SET and SHOW Commands

SET COMMAND file-spec
SHOW COMMAND
Enables use of an additional startup command file. Default: operating system
dependent. You can only use these commands in startup command files.

SET CURSOR top:bottom
SHOW CURSOR
Controls scrolling of the screen relative to the distance of the cursor from the
screen top or bottom. Values for top and bottom can range from 1 to 21.
Default: SET CURSOR 7:14.

SET ENTITY WORD “string”
SET ENTITY SENTENCE “string”
SET ENTITY PARAGRAPH “string”
SET ENTITY PAGE “string”
SHOW ENTITY WORD
SHOW ENTITY SENTENCE
Defines boundary delimiters for the specified entity. Defaults:
SET
SET
SET
SET

ENTITY WORD "
<LF><VT><FF><CR>"
ENTITY SENTENCE ".!?"
ENTITY PARAGRAPH "<CR><CR>''
ENTITY PAGE "<FF>"

SHOW FILES
Displays the name of the input file and the output file for your EDT session.

SET FNF
SET NOFNF
SHOW FNF
NOFNF suppresses the message: "Input file does not exist." Use in a startup
command file. Default: SET FNF

SET HELP file-spec
SHOW HELP
Determines which HELP file is current.

SHOW KEY key-name
Prints the definition of the specified keypad editing key. Key-name must use the
special line mode conventions and keypad key numbers. (See Figure EDT-1 for
the keypad key numbers.)

EDT-26

EDT Editor
The SET and SHOW Commands

SET KEYPAD
SET NOKEYPAD
SHOW KEYPAD
Sets the screen mode to either keypad or nokeypad. Does not shift to either
screen mode. Default; SET KEYPAD.

SET LINES number
SHOW LINES
Sets the number of text lines displayed on the screen. The value for number can
range from 1 through 22. Use in a startup command file. Default: SET LINES

22.
SET MODE LINE
SET MODE CHANGE
SHOW MODE
Sets the operating mode for EDT. Default: SET MODE LINE. Use in a startup
command file.

SET NUMBERS
SET NONUMBERS
SHOW NUMBERS
Determines if EDT line numbers are visible in line mode. With SET
NONUMBERS, EDT does not indent lines when displaying them in line mode or
display the line numbers. Default; SET NUMBERS.

SET PARAGRAPH WPS
SET PARAGRAPH NOWPS
SHOW PARAGRAPH
Determines where EDT puts the cursor after moving to a new paragraph.
Default: SET PARAGRAPH NOWPS.

SET PROMPT prompt-type “string”
SHOW PROMPT prompt-type
Determines various prompt characters to use when simulating an EDT session for
test purposes.

SET QUIET
SET NOQUIET
SHOW QUIET
Determines whether the terminal bell sounds when an EDT error message is
displayed in a screen mode. Default: SET NOQUIET.

EDT Editor

EDT-27

The SET and SHOW Commands

SET REPEAT
SET NOREPEAT
SHOW REPEAT
Determines whether you can use the GOLD repeat feature or SPECINS in
keypad mode. Default: SET REPEAT.

SET SCREEN width
SHOW SCREEN
Sets the maximum number of characters that EDT displays on a line of text. The
possible widths for VTlOO-type terminals with advanced video option are 80 and
132. The width for VTIOO terminals without AVO and for VT52 terminals is 80.
For hardcopy terminals you can specify any width from 1 to 132. Default: set by
operating system.

SET SEARCH (GENERAL, EXACT, WPS, CASE INSENSITIVE, DIACRITICAL
INSENSITIVE)
SET SEARCH (BEGIN, END)
SET SEARCH (BOUNDED, UNBOUNDED)
SHOW SEARCH
Determines how EDT performs searches. Defaults: SET SEARCH GENERAL,
SET SEARCH BEGIN, SET SEARCH UNBOUNDED.

SET SUMMARY
SET NOSUMMARY
SHOW SUMMARY
Determines whether EDT displays summary information when you end your
EDT session with the EXIT command. Default: SET SUMMARY.

SET TAB number
SET NOTAB
SHOW TAB
Sets the tab value for various tabbing functions. Default: SET NOTAB.

SET TERMINAL (HCPY, VT52, VT100)
SET TERMINAL (SCROLL, NOSCROLL)
SET TERMINAL (EIGHTBIT, NOEIGHTBIT)
SET TERMINAL (EDIT, NOEDIT)
SHOW TERMINAL
Determines how EDT interprets your terminal. Default: the terminal information
supplied to EDT by the operating system.

EDT-28

EDT Editor
The SET and SHOW Commands

SET TEXT END “string”
SET TEXT PAGE “string”
SHOW TEXT END
SHOW TEXT PAGE
Determines the text that EDT displays for the end of buffer marker or the page
marker. Has no effect on your text. Defaults: SET TEXT END "[EOB]", SET
TEXT PAGE " <FF> ".

SET TRUNCATE
SET NOTRUNCATE
SHOW TRUNCATE
Determines whether EDT truncates lines that exceed the current screen width.
Default: SET TRUNCATE.

SET VERIFY
SET NOVERIFY
SHOW VERIFY
Determines whether EDT displays the commands in a startup command file or
EDT macro as they are being processed. Default: SET NOVERIFY.

SHOW VERSION
Displays the current EDT version number and the EDT copyright information.

SET WORD DELIMITER
SET WORD NODELIMITER
SHOW WORD
Determines whether EDT interprets word boundaries (except for space) as
separate words. Default: SET WORD DELIMITER.

SET WRAP number
SET NOWRAP
SHOW WRAP
Determines whether EDT wraps text being inserted in keypad mode. Also
determines the maximum line length for filling text in all three modes. Default;
SET NOWRAP.

EDT.6 The Journal Facility
EDT's journal facility keeps track of each keystroke you make during your EDT
session in a special file called the journal file. When you finish your editing session
by typing either EXIT or QUIT, EDT normally discards the journal file. If your
editing session ends abruptly due to a system interruption, the journal file is saved,
even though your editing work has been lost. Using the journal file, EDT can restore

EDT Editor

edt-29

The Journal Facility

almost all of your editing work. Sometimes the last few commands you typed or the
last few keypad editing keys you pressed have not been recorded in the journal file
at the time the interruption occurs.
The journal file is normally stored in the current directory and has .JOU for the file
type. The file name is the same as the name of the file you were editing when the
interruption took place. For example, if you are editing the file LETTER.DAT, the
journal file name is LETTER.JOU. (It is possible to instruct EDT to use a different
name or file type for the journal file by using the /JOURNAL qualifier.)
Include the /RECOVER qualifier in your EDIT/EDT command line in order to have
EDT use the journal file to restore your editing work. Even when you use EDT to
create a new file, you can use the /RECOVER qualifier to have EDT restore your
editing work after a system interruption.
As soon as EDT has processed all the command information and keystrokes stored
in the journal file, it continues to use that journal file to store the new information
that results from any further editing work you do during the recovery session. If you
are able to end your editing session with EXIT or QUIT, EDT discards the journal file
from the directory. However, if you find journal files in your directory that you do
not plan to use, simply delete them.
You can use the /SAVE qualifier with the line mode EXIT or QUIT command to save
the journal file even when there is no system interruption.

EDT.7 Startup Command Files
Startup command files establish various settings and key definitions at the start of
your EDT session. These files can contain only line mode commands. SET and
DEFINE KEY commands are the ones most frequently found in startup command
files.
Generally, EDT reads a systemwide startup command file at the beginning of your
editing session. If no systemwide startup command file exists on your system, EDT
looks for a file named EDTINI.EDT in your default directory and processes the
commands in that file.
If you want EDT to use a startup command file with another name, you must include
that command file specification in the /COMMAND qualifier when you invoke EDT.
You can use EDT to create a startup command file. There are very few restrictions to
organizing such a file. If you need to use the carriage return character (CTRL/M) in
a SET or DEFINE KEY command, you must enter it from a change mode.

EDT-30

EDT Editor
Startup Command Files

Here are some typical commands that might be put in a startup command file:
SET QUIET
SET WRAP 60
SET SEARCH BOUNDED
SET TAB 5
SET MODE CHANGE
DEFINE KEY GOLD P AS "PAR.”
You can include all the necessary commands to set up an EDT macro in your startup
command file. The sample macro, called EXACT, resets the search parameter to exact
when you type the macro name as a line mode command. The following commands
can be put in the startup command file to create the EXACT macro:
DEFINE MACRO EXACT
FIND =EXACT
INSERT; SET SEARCH EXACT
FIND =MAIN

EDT.8 Defining Keys
You can redefine or relocate any preset keypad editing key. You can also create
definitions for editing keys that have none. These key definitions enable you to
perform a variety of editing tasks in keypad mode.
There are five types of keys or key sequences that can be defined.

Key or Key Sequence

Cannot Define

Keypad keys
Control keys or GOLD control
key

C, O, Q, S, and any others prohibited by your operating
system

GOLD keyboard key

0, 1, 2, 3, 4, 5, 6, 7, 8, 9, - (When you use !, %, ^ or " in
the DEFINE KEY command, you must enclose the character
in quotation marks, for example: "!".)

DELETE or GOLD DELETE
FUNCTION key or GOLD
FUNCTION key

LK201 keyboard only. FI, F2, F3, F4, and F5 with or
without GOLD.

In EDT the following special keyboard keys and control keys are linked. When you
redefine one, you have redefined the other.
VT100\VT52
BACKSPACE
TAB
LINEFEED
RETURN

LK201
<—>
<-—>
<--->
<-—>

CTRL/H
CTRL/I
CTRL/J
CTRL/M

<-—>
<--->
<-—>
<->

F12
Tab
F13
Return

EDT Editor

edt-31

Defining Keys

NOTE: The LK201 FI2 and FI3 keys are linked to CTRL/H and CTRL/J when the
terminal is in VTIOO compatibility mode. When the terminal is operating in VT200
mode, FI 2 and FI3 are not linked to CTRL/H and CTRL/J. They have the same
preset definitions, but can be defined independently, just as CTRL/A and I gold | A
can be defined independently.
Keypad key definitions use nokeypad command syntax. Nokeypad mode enables
you to put several commands on a single line. Thus, you can create key definitions
to do several commands in succession. If you want EDT to process the command
as soon as you press the key or key sequence, place a period at the end of the
definition. This corresponds to pressing the ENTER key in keypad mode.
You can use the SHOW KEY command to find out the existing definitions for all
EDT editing keys. However, you must use special terms to tell EDT which key or
key sequence you want information about. Figure EDT-1 gives the special keypad
key numbers to use with the SHOW KEY command for VTIOO and VT52 terminals.
For control keys, type SHOW KEY CONTROL character (for example, SHOW KEY
CONTROL A). To find out the definition of a GOLD key sequence, type SHOW KEY
GOLD keyboard key or SHOW KEY GOLD CONTROL keyboard key (for example,
SHOW KEY GOLD ♦ or SHOW KEY GOLD CONTROL ]). To see the definition for
the DELETE key, spell out the word (for example, SHOW KEY GOLD DELETE).
To see the definition for a key on the second keypad or in the function key row of
the LK201 keyboard, spell out the word FUNCTION and use the EDT FUNCTION
number designation, not the F number that appears on the keyboard (for example,
SHOW KEY FUNCTION 24 for the FI2 key).
By enclosing all parts of the definition except for the ending period in parentheses,
you can use the keypad GOLD repeat feature to process the command(s) several
times in succession.
There are two ways to define/redefine keypad editing keys. From keypad mode you
can use the CTRL/K function. The line mode DEFINE key command can be accessed
from any mode.
Using CTRL/K, you can press the key(s) you are defining. Whenever you want to
include a preset keypad editing key in your definition, you can press that key as
part of the definition process. EDT prompts you for both the key you are defining
and the definition. For example, suppose you wanted to define CTRL/P to move a
paragraph at a time:
[ctrl/k]

Press the key you wish to define:
[CTRL/P]

Now enter the definition terminated by ENTER:
PAR. I ENTER I

EDT-32

EDT Editor
Defining Keys

The DEFINE KEY command in line mode uses the typed out version of the key name
and requires that the definition be enclosed in quotation marks. The same definition
using line mode is:
DEFINE KEY CONTROL P AS "PAR."
To redefine keypad keys with the DEFINE KEY command, you must know their
special EDT numbers. Figure EDT-1 shows these numbers for both VTlOO-type and
VT52 terminals, as well as the FUNCTION key numbers for the LK201 keyboard.
To redefine the PAGE function to be

type:

DEFINE KEY 7 AS "(-W)."
To redefine GOLD Left Arrow to be "SHL.", type:
DEFINE KEY GOLD 15 AS "SHL."
Here are some sample DEFINE KEY commands:
DEFINE
DEFINE
DEFINE
DEFINE
DEFINE
DEFINE

EDT.9

KEY
KEY
KEY
KEY
KEY
KEY

GOLD CONTROL B AS "CHGUW."
GOLD DELETE AS "-DW."
CONTROL V AS " (+V D-CI[!1]."
CONTROL N AS "?’Nokeypad Command: ’."
GOLD 21 AS "S^O?*Find:
Substitute:
FUNCTION 17 AS "IWashington. DC'^Z."

EDT Macros

EDT macros allow you to extend the line mode command language. A macro is a
group of one or more line mode commands that is processed when you type the
macro name as a line mode command word. For instance, you can create a macro
called XT to be the command SET SEARCH EXACT, and another macro called GEN
to be the command SET SEARCH GENERAL.
To create a macro, use a line mode command to move to a new buffer. That buffer
must have the same name as the macro. Using EDT, enter the line mode command
or commands that you want to be processed when you type the macro name. Then
issue the command
DEFINE MACRO macro-name
EDT now adds the macro name to its list of valid line mode commands. You are
ready to use that command any time during your editing session. If you plan to use
the macro in repeated EDT sessions, you can put it in a startup command file or
simply store it in an external file to be included in later EDT sessions.

EDT Editor

EDT-33

EOT Macros

If you put a DEFINE MACRO command in a startup command file, you must include
commands to enter the macro text into a buffer with the same name as the macro.
If you store a macro in an external file, use the INCLUDE command to put the
macro in a buffer with the same name and issue the DEFINE MACRO command to
establish the name as a line mode command.
The following example creates a macro called SINCY, which inserts the closing of a
letter above the current line when you type the newly created line mode command
SINCY.
♦FIND =SINCY
♦INSERT
INSERT
INSERT
INSERT
INSERT
INSERT
INSERT
INSERT
INSERT

Sincerely yours,

James T. Cortland
President

[CTRL/Zl

♦DEFINE MACRO SINCY
♦FIND =MAIN
To close a letter from Mr. Cortland, type SINCY as a line mode command.
♦SINCY
♦TYPE "sincerely" THRU END
132
133
134
135
136
137
138
139
[EOB]

Sincerely yours,

James T. Cortland
President

VAX Text Processing Utility
The following information is provided on VAXTPU:
•

Data types

•

Built-in procedures

•

Global variables used with built-in procedures

•

Information obtainable using the built-in procedure GET_INFO

Complete information can be found in the VAX Text Processing Utility Reference
Manual.
VAXTPU has two editing interfaces: the Extensible VAX Editor (EVE) and the EDT
Keypad Emulator. The Guide to Text Processing on VAX/VMS and the VAX Text
Processing Utility Reference Manual have information on using these interfaces.
Information on callable VAXTPU routines is in the MISC section; complete
descriptions are in the VAX/VMS Utility Routines Reference Manual.

VAXTPU.1

Data Types

Data Type

Description

BUFFER

A work space, used to hold text for manipulation

INTEGER

A 32-bit signed whole number quantity (commas and decimal points are
not permitted)

LEARN

A series of keystrokes to be replayed at some future time

MARKER

A reference point associated with a character position within a text
buffer, used to mark locations for positioning or creating ranges

PATTERN

A structure representing a sequence of characters within a buffer

VAXTPU-2

VAX Text Processing Utility
Data Types

Data Type

Description

PROCESS

A VAX/VMS subprocess (VAXTPU can create, delete, and communicate
with these subprocesses)

PROGRAM

Internal representation of VAXTPU statements (programs are what
VAXTPU executes)

RANGE

A contiguous sequence of characters between (and including) two
specified markers within a text buffer

STRING

A string of characters from the DEC multinational character set

UNSPECIFIED

The initial value of a variable after it has been compiled

WINDOW

An area of the screen for displaying buffers

VAXTPU.2

Built-In Procedures

ADD^KEY_MAP (stringl, string2, strings [,...])
Adds one or more key maps to a key-map list.

ADJUST.WINDOW (window, integerl, integer2)
Changes the size and/or screen location of a window and makes the window
that you specify the current window.

ANCHOR
Disables seek search or incremental search pattern matching and ties a search for
a matching string to the current character position.

pattern := ANY (string)
Returns a pattern that matches any single character in the string used as a
parameter.

APPEND^LINE
Places the current line at the end of the previous line.

pattern := ARB (integer)
Returns a pattern that matches an arbitrary sequence of characters starting at the
current character position and extending for the length you specify.

String := ASCII (integer)
Converts an integer to a string.

ATTACH [{integer!string}]
Deassigns the terminal and enables you to switch control from your current
process to another process that you have previously created.

VAX Text Processing Utility

vaxtpu-3

BuilMn Procedures

marker := BEGINNING.OF ({buffer I range})
Returns a marker that points to the first position of a buffer or a range.

string2 := CALL—USER (integer, stringl)
Calls a program written in another language from within VAXTPU. The CALL —
USER parameters are passed to the external routine exactly as you enter them;
VAXTPU does not process the parameters in any way. The integer is passed by
reference, and string is passed by descriptor; string2 is the value returned by the
external program.

CHANGE—CASE ({buffer I range I string}, keyword)
Modifies the case of all the alphabetic characters in the specified unit of text
according to the keyword that you supply.

[program := ] COMPILE ({string I range I buffer})
Converts VAXTPU procedures and statements into an internal, compiled format.
Valid items for compilation can be represented by a string, a range, or a buffer.
COMPILE optionally returns a program.

COPY-TEXT ({string! range I buffer})
Makes a copy of the text you specify and places it in the current buffer.

[buffer :=] CREATE-BUFFER (stringl [,string2])
Defines a new work space for editing text. You can create an empty buffer or you
can associate an input file name with the buffer. CREATE-BUFFER optionally
returns a buffer.

[string2:=] CREATE-KEY-MAP (stringl)
Creates and names a key map. Optionally returns a string that is the name of
the key map created.

[stringl:=] CREATE-KEY-MAP-LIST (stringl, string2, [.„])
Creates and names a key-map list. Also specifies the initial key maps in the keymap list it creates. Optionally returns a string that is the name of the key-map
list created.

process := CREATE—PROCESS (buffer [,string])
Starts a subprocess and associates a buffer with it. You can optionally specify
an initial command to send to the subprocess. CREATE—PROCESS returns a
process.

range := CREATE—RANGE (markerl, marker2, keyword)
Returns a range that includes two markers and all the characters between them.
You must specify how the characters in the range are to be displayed when they

VAXTPU-4

VAX Text Processing Utility
Built-In Procedures

are visible on the screen (no special video, reverse video, bolding, blinking, or
underlining).

[window :=] CREATE_WINDOW (integerl, integer2, keyword)
Defines a screen area called a window. You must specify the screen line number
at which the window starts, the length of the window, and if the status line is
displayed. CREATE—WINDOW optionally returns a window.

buffer := CURRENT-BUFFER
Returns the buffer in which you are currently positioned.

string := CURRENT-CHARACTER
Returns a string one character long for the character at the current character
position in the current buffer.

integer := CURRENT-COLUMN
Returns an integer that is the current column number of the cursor on the screen.

keyword := CURRENT-DIRECTION
Returns a keyword that indicates the current direction of the current buffer. The
valid keywords are FORWARD and REVERSE.

String := CURRENT-LINE
Returns a string that represents the current line. The current line is the line that
contains the current character position.

integer := CURRENT-OFFSET
Returns an integer for the offset of the current character position within the
current line.

integer := CURRENT-ROW
Returns an integer that is the screen line on which the cursor is located.

window := CURRENT-WINDOW
Returns the window in which the cursor is visible.

CURSOR-HORIZONTAL (integer)
Moves the cursor position across the screen the number of screen columns that
you specify.

CURSOR-VERTICAL (integer)
Moves the cursor position up or down the screen by the number of screen lines
that you specify.

VAX Text Processing Utility

vaxtpu-5

Built-In Procedures

DEFINE-_KEY ({string 11 buffer I range I program I learn}, keyword [,string2
[,Strings]])
Associates executable VAXTPU code with a key or a combination of keys.

DELETE ({buffer I marker I process I program I range I window})
Removes VAXTPU structures from your editing context. When you delete a
structure, (for example, a range), all variables that refer to that structure are reset
to UNSPECIFIED. If the deleted structure had any associated resources, these
resources are returned to the editor.

EDIT (string, keywordi [,...] [,keyword2])
Modifies a string according to the keywords you specify. EDIT is similar (but not
identical) to the DCL lexical function F$EDIT.

marker := END_OF ({buffer I range})
Returns a marker that points to the last character position in a buffer or a range.

ERASE ({rangelbuffer})
Removes the contents of the range or buffer that you specify.

[string :=] ERASE_CHARACTER (integer)
Deletes the number of characters you specify and optionally returns a string that
represents the characters you deleted.

[String :=] ERASE^LINE
Removes the current line from the current buffer. ERASE—LINE optionally
returns the line you remove in a string data type.

EXECUTE ({program I buffer I range I string I learn})
Does one of the following:
•

Executes programs that you have previously compiled.

•

Compiles and then executes any executable statements in a buffer, a range,
or a string.

•

Replays or executes a learn sequence.

EXIT
Terminates the editing session and writes out any modified buffers that have
associated files. VAXTPU queries you for a file name for any buffer that you
have modified that does not already have an associated file.
Buffers that have the NO—WRITE attribute are not written out. See SET (NOWRITE, buffer).

VAXTPU-6

VAX Text Processing Utility
Built-In Procedures

string2 := EXPAND—NAME (stringl, keyword)
Returns a string that contains the name or names of any VAXTPU variables,
keywords, or procedures (built-in or user-written) that begin with the string that
you specify. VAXTPU searches its internal symbol tables to find a match, using
your input string as the initial substring for the match.

string2 := FAO (stringl [,FAO parameters])
Invokes the Formatted ASCII Output (FAO) system service to convert a control
string to a formatted ASCII output string. By specifying arguments for FAO
directives in the control string, you can control the processing performed by the
$FAO system service. The FAO built-in procedure returns a string that contains
the formatted ASCII output.

string4 := FILE-PARSE (stringl [,string2 [,strings [,keyword]]])
Performs the equivalent of the DCL F$PARSE lexical function. That is, it calls
the VAX RMS service SPARSE to parse a file specification and to return either an
expanded file specification or the file specification field that you request.
FILE—PARSE returns a string that contains the expanded file specification or
the field you specify. If you do not provide a complete file specification, FILE—
PARSE supplies defaults in the return string.
If an error occurs during the parse, FILE—PARSE returns a null string.

string2 := FILE—SEARCH (stringl)
Calls the RMS service $SEARCH to search a directory file and return the full file
specification for the file that you name.
FILE—SEARCH returns a string containing the resulting file specification. If the
file is not found in the directory, FILE—SEARCH returns a null string and signals
an error.

FILL ({buffer I range}, string [,integer1 [,integer2]])
Reformats the text in the specified buffer or range so that the lines of text are
approximately the same length.

return—value := GET—INFO ({parameterl, parameter2l parameterl, parameter2,
parameters})
Provides information about the current status of your editing context. See
Tables VAXTPU-1 and VAXTPU-2 at the end of this section for a list of the
information that GET—INFO returns.

HELP—TEXT (stringl, string2, keyword, buffer)
Invokes the VAX/VMS HELP facility. You must specify the help library to be
used for help information, the initial library topic, the prompting mode for the
HELP facility, and the buffer to which the help information is written.

VAX Text Processing Utility

vaxtpu-7

Built-In Procedures

integer := INDEX (stringl, string2)
Locates a character or a substring within a string and returns its location within
the string.

integer := INT (string)
Converts a string that consists of numeric characters into an integer.

JOURNAL .CLOSE
Closes an open journal file (if one exists for your session) and saves the journal
file.

[string2 := ] JOURNAL .OPEN (string)
Opens a journal file and starts making a copy of your editing session by recording
every keystroke and command that you execute. Optionally returns a string
containing the file specification of the file journaled. This procedure is not valid
for batch mode.

keyword2 := KEY.NAME ({string I keyword 1} [,SHIFT.KEY])
Returns a VAXTPU keyword for a key or a combination of keys.

keyword := LAST.KEY
Returns a VAXTPU keyword for the last key you entered. If you are replaying a
learn sequence, it returns a keyword for the last key you replayed.

LEARN.BEGIN (keyword)

learn := LEARN.END
Saves all keystrokes typed between LEARN.BEGIN and LEARN JND.
LEARN .BEGIN starts saving all keystrokes that you type. LEARN JND
stops the "learn mode" of VAXTPU and returns a learn sequence that consists of
all the keystrokes that you entered.

integer := LENGTH ({string I range})
Returns an integer that is the number of character positions in a string or a range.

pattern := LINE.BEGIN
Returns a pattern that matches the beginning-of-line condition.

VAXTPU-8

VAX Text Processing Utility
Built-In Procedures

pattern := LINE.END
Returns a pattern that matches the end-of-line condition.

{programllearnlintegerlstring2} := LOOKUP—KEY (keywordi, keyword2
[,string1])
Returns the executable code or the comment that is associated with the key you
specify. The code can be returned as a program or as a learn sequence. The
comment is returned as a string.

MAP (window, buffer)
Associates a buffer with a window and causes the window to become visible on
the screen. Before using MAP you must already have created the buffer and the
window that you specify as parameters. See CREATE—BUFFER and CREATE—
WINDOW.

marker := MARK (keyword)
Returns a marker for the current character position in the current buffer. You
must specify how the marker is to be displayed on the screen (no special video,
reverse video, bolding, blinking, or underlining).

pattern := MATCH (string)
Returns a pattern that matches a sequence of characters starting at the current
character position and continuing up to and including all the characters specified
in string.

MESSAGE ({string I range})
Inserts the characters in the string or range that you specify into the message
buffer, if one exists (by default, VAXTPU looks for a buffer that is named
MESSAGE-BUFFER). If there is no MESSAGE-BUFFER, VAXTPU displays
the message at the current location on the device pointed to by SYS$OUTPUT
(usually your terminal).

MOVE-HORIZONTAL (integer)
Changes the current character position in the current buffer by the number of
characters you specify.

MOVE-TEXT ({string I range I buffer})
Moves the text you specify and places it in front of the current character position
in the current buffer. When you move text with range and buffer parameters,
you remove it from its original location.

MOVE-VERTICAL (integer)
Modifies the current character position in the current buffer by the number of
lines you specify.

VAX Text Processing Utility

vaxtpu-9

Built-In Procedures

pattern := NOTANY (string)
Returns a pattern that matches any single character not in the string that is used
as a parameter.

POSITION ({buffer I marker I range I window})
Establishes the current character position in the editing context. You can position
to a range, a marker, a buffer, or a window.

QUIT
Leaves the editor without writing to a file.

String := READ_CHAR
Stores the next character entered from the keyboard in a string variable.

[string2 :=] READ-FILE (stringl)
Reads a file and adds the contents of the file immediately before the current line
in the current buffer. Optionally returns a string containing the file specification
of the file read.

keyword := READ-KEY
Waits for you to press a key and then returns the keyword for that key.

string2 := READ—LINE [(stringl [.integer])]
Displays the text that you specify as a prompt for input and reads the information
entered in response to the prompt. You can optionally specify the maximum
number of characters to be read. READ—LINE returns a string that holds the
data that is entered in response to the prompt.

REFRESH
Repaints the whole screen. It erases any extraneous characters, such as those
caused by noise on a communication line, and repositions the text so that the
screen represents the last known state of the editing context.

pattern := REMAiN
Returns a pattern that matches any string starting at the current character position
and continuing to the end of the current line.

REMOVE-KEY-MAP (stringl, string2 [,ALL])
Removes key maps from key-map lists.

SAVE (string)
Writes the binary form of all currently defined procedures, variables, and key
definitions to the section file you specify.

VAXTPU-10

VAX Text Processing Utility
Built-In Procedures

pattern := SCAN (string)
Returns a pattern that matches the longest string of characters that does not
contain any of the characters included in the parameter string.

pattern := SCANL (string)
Returns a pattern that matches the longest string of characters that does not
contain any of the characters included in the parameter string. SCANL crosses
record (line) boundaries.

[integer2:=] SCROLL (window [,{+l-linteger1])
Moves the lines of text in the buffer up or down on the screen by the number
of lines you specify. The cursor does not move but stays positioned at the
same relative screen location. The current character position is different from
the character position that was current before you issued the scroll command.
SCROLL optionally returns an integer that indicates the number and direction
(negative number = upward, positive number = downward) of lines actually
scrolled.

range := SEARCH ({string I pattern}, keywordi [,keyword2])
Looks for a particular arrangement of characters and returns a range that contains
the matching characters in the current buffer.

marker := SELECT (keyword)
Returns a marker for the current character position in the current buffer. You
must specify how the marker is to be displayed on the screen (no special video,
reverse video, bolding, blinking, or underlining).
The marker returned by SELECT indicates the first character position in a select
range. The video attribute that you specify for the marker applies to all the
characters in a select range. For information on creating a select range, see
SELECT_JRANGE.

range := SELECT_RANGE
Returns a range that contains all the characters between the marker established
with the SELECT built-in and the current character position. SELECT-RANGE
does not include the character at the end position in the selected range.

SEND ({buffer! range I string}, process)
Passes data to a subprocess.

SEND—EOF (process)
Uses features of the VAX/VMS mailbox driver to send an end-of-file message
(IO$—WRITEOF) to a subprocess.

VAX Text Processing Utility

vaxtpu-ii

Built-In Procedures

SET (keyword, parameter [,...])
Allows you to establish or to change certain features of a VAXTPU session. SET
requires a keyword as its first parameter. The keyword indicates which feature of
the editor is being set. You can set the mode for entering text, the text that is to
be displayed on certain parts of the screen, the direction of a buffer, the status of
a buffer, and so on.
Valid keywords: AUTO-REPEAT, BELL, DEBUG, EOB_TEXT, FACILITYNAME, FORWARD, INFORMATIONAL, INSERT, JOURNALING, KEY-MAPLIST, MARGINS, MAX-LINES, MESSAGE-FLAGS, NO-WRITE, OUTPUTFILE, OVERSTRIKE, PAD, PERMANENT, PROMPT-AREA, REVERSE,
SCREEN-UPDATE, SCROLLING, SELF-INSERT, SHIFT-KEY, STATUS-LINE,
SUCCESS, SYSTEM, TAB-STOPS, TEXT, TIMER, UNDEFINED-KEY VIDEO,
WIDTH.

[integer2 :=] SHIFT (window, integerl)
Changes the relative position of text that is displayed in a window on the screen.
The text in the window is shifted to the right or to the left. The shift applies
to any buffer associated with the window that you specify. SHIFT optionally
returns an integer.

SHOW ({keyword I data type})
Displays information about VAXTPU data types and the current settings of
attributes that can be applied to certain data types.

pattern := SPAN (string)
Returns a pattern that matches the longest string of characters that contains only
characters appearing in string. (SPAN does not cross record (line) boundaries;
contrast with SPANL.)

pattern := SPANL (string)
Returns a pattern that matches the longest string of characters that contains only
characters appearing in string. (SPANL continues pattern matching across end
of line; contrast with SPAN.)

SPAWN [String]
Deassigns the terminal and then creates a VAX/VMS subprocess.

SPLIT-LINE
Breaks the current line before the current character position and creates two lines.

string := STR (Integer)
Converts an integer to a string.

strlng2 := SUBSTR ({stringl Irange}, Integerl, Integer2)
Returns a string that represents a substring of a string or a range.

VAXTPU-12

VAX Text Processing Utility
Built-In Procedures

TRANSLATE ({stringll range I buffer}, string2 , stringS)
Invokes the VAX/VMS Run-Time Library procedure STR$TRANSLATE. The
VAXTPU procedure takes three parameters. Some of the characters in the first
parameter are replaced by the characters in the second parameter. The third
parameter is used as a match string to determine which characters from the first
parameter are replaced.

UNDEFINE^KEY (keyword [.string])
Removes the current binding from the key that you specify.

UNMAP (window)
Disassociates a window from its buffer and removes the window from the screen.

UPDATE (window)
Causes the screen manager to make a window reflect the current internal state of
the buffer that is associated with the window.

[string2 :=] WRITE-FILE ({buffer I range} [,string1])
Writes data to the file that you specify. Optionally returns a string that is the file
specification of the file created.

VAXTPU.3 Global Variables for Built-In Procedures
Variable

Information Held

ERROR

Keyword that specifies an error or warning status

ERROR_LINE

Line number at which an error or warning occurred

DEBUG-LINE

Line number at which a breakpoint occurred

GET_INFO
Table VAXTPU-1

GET_INFO - Using a Variable as Parameterl

Parameterl

Parameter2

Return Value

Description of Return

Any VAXTPU
variable

"type"

Keyword

Data type of item

A buffer variable

"character"

String

Character at the current
character position

"file_name"

String

Name of a file given as
second parameter to CR
BUFFER; null if none w
specified

"first—marker"

Marker or Integer
0

First marker in VAXTPU
internal list of markers,
none

"first-range"

Range or Integer
0

First range in VAXTPU
internal list of ranges, 0
none

"line"

String

Line of text at current c
position

"map—count"

Integer

Number of windows ass
with the buffer

"modified"

Integer (1 or 0)^

Value that indicates wh
the buffer has been mod

"name"

String

Name given buffer whe
created

"next—marker"

Marker or Integer
0

Next marker in VAXTP
internal list of markers,
more

"next—range"

Range or Integer
0

Next range in VAXTPU
internal list of ranges, 0
more

"offset"

Integer

Offset of current charac
position from the begin
the line

^An integer value of 1 indicates True and an integer value of 0 indicates False.

Table VAXTPU-1 (Cont.)
Parameterl

GET_INFO - Using a Variable as Parameter!

Parameter2

Return Value

Description of Return Value

"offset—column"

Integer

Screen column that the current
character position would
occupy if it were on the screen,
unshifted

"record_count"

Integer

Number of records (lines) in the
buffer

"record—size"

Integer

Maximum length for records
(lines) in the buffer

The following items are established or changed with the built-in
procedure SET.
"direction"

Keyword

FORWARD or REVERSE

"eob—text"

String

String representing the end-ofbuffer text

"key—map—list"

String

Key-map list that is bound to
the buffer.

"left—margin"

Integer

Current left margin setting

"max—lines"

Integer

Maximum number of records
(lines) in the buffer

"mode"

Keyword

INSERT or OVERSTRIKE

"no—write"

Integer (1 or 0)^

Value that indicates whether
the buffer (if modified) should
be output to a file upon exit

"output—file"

String or Integer
0

The name of the file used with
the built-in procedure SET
(OUTPUT-FILE,...)

"permanent"

Integer (1 or 0)^

Value that indicates whether
the buffer is permanent or if it
can be deleted

"right—margin"

Integer

Current right margin setting

"system"

Integer (1 or 0)^

Value that indicates whether
the buffer is a system buffer

^An integer value of 1 indicates True and an integer value of 0 indicates False.

Parameterl

Parameter2

Return Value

Description of Return

"tab_stops"

String or Integer

String that represents th
(each separated by a si
space) of tab stops for
(TAB—STOPS, buffer, s
integer that is the inter
between tab stops for S
(TAB—STOPS, buffer, in

"buffer"

Buffer

Buffer in which the ma
located

"offset"

Integer

Offset of the marker fro
beginning of the line

"offset—column"

Integer

Screen column that the
would occupy if it were
screen - does not accou
shifting of text within a

"video"

Keyword

Video attribute of the m

A process
variable

"pid"

Integer

Process identification n

A range variable

"buffer"

Buffer

The buffer in which the
is located

"video"

Keyword

Video attribute of the r

A marker
variable

The following items are established or changed with the bui
procedure SET.
A string
variable^

"self-insert"

Integer (1 or 0)^

Value that indicates wh
printable characters are
inserted into the buffer
are not defined

"shift-key"

Keyword

Keyword for the key cu
used as the shift key

"undefined—key"

Any VAXTPU
variable or
Integer 0

Program called when a
undefined character is e
0 if the program issues
default message

^An integer value of 1 indicates True and an integer value of 0 indicates False.
^The string must identify the name of either a key map or a key-map list.

Table VAXTPU-1 (Cont.)

GET_INFO - Using a Variable as Parameterl

Parameterl

Parameter2

Return Value

Description of Return Value

A window
variable

"beyond—eol"

Integer (1 or 0)^

Value that indicates whether
the cursor is beyond the end of
the current line

"buffer"

Buffer or Integer
0

The buffer that is associated
with the window, 0 if none

"current—
column"

Integer

Column in which the cursor
was most recently located

"current—row"

Integer

Row in which the cursor was
most recently located

"next"

Window or
Integer 0

Next window in VAXTPU's
internal list of windows, 0 if
last^

"original—
bottom"

Integer

Screen line number of the
bottom of the window when it
was created (does not include
status line)

"original —length"

Integer

Number of lines in the window
(includes status line)

"original—top"

Integer

Screen line number of the top
of the window when it was
created

"previous"

Window or
Integer 0

Previous window in VAXTPU's
internal list of windows, 0 if
first^

"shift—amount"

Integer

Number of columns the
window is shifted to the left

"visible"

Integer (1 or 0)^

Value that indicates whether
window is mapped to the
screen and is not occluded

"visible—bottom"

Integer

Screen line number of the
visible bottom of the window
(does not include status line)

"visible—length"

Integer

Visible length of the window
(includes status line)

^An integer value of 1 indicates True and an integer value of 0 indicates False.
^VAXTPU orders windows according to their "original top" line number. If multiple windows have the
same top line number, the most recently created window comes first in VAXTPU's list of windows.

Parameterl

Parameter2

Return Value

Description of Return

"visible_top"

Integer

Screen line number of
visible top of the windo

The following items are established or changed with the bui
procedure SET.
"blink—Status"

Integer (1 or 0)^

Value that indicates wh
BLINK is one of the vid
attributes of the window
status line

"blink—video"

Integer (1 or 0)^

Value that indicates wh
BLINK is one of the vi
attributes of the window

"bold—status"

Integer (1 or 0)^

Value that indicates wh
BOLD is one of the vid
attributes of the windo
status line

"bold—video"

Integer (1 or 0)^

Value that indicates wh
BOLD is one of the vid
attributes of the window

"no—video"

Integer (1 or 0)^

Value that indicates wh
video attribute of the w
NONE

"no—videostatus"

Integer (1 or 0)^

Value that indicates wh
video attribute of the w
status line is NONE

"pad"

Integer (1 or 0)^

Value that indicates wh
the window is blank pa
the right

"reverse-video"

Integer (1 or 0)^

Value that indicates wh
REVERSE is one of the
attributes of the window

"reverse—status"

Integer (1 or 0)^

Value that indicates wh
REVERSE is one of the
attributes of the windo
status line

"scroll —amount"

Integer

Number of lines to scro

^An integer value of 1 indicates True and an integer value of 0 indicates False.

Parameterl

Parameter2

Return Value

Description of Return Value

"scroll—bottom"

Integer

Bottom of the scrolling area this is an offset from the bottom
screen line

"scroll—top"

Integer

Top of the scrolling area - this
is an offset from the top screen
line

"status—line"

String or Integer
0

Text of status line, 0 if none

"status—video"

Keyword or
Integer

If there is no video attribute
or only one video attribute
for the window's status
line, the appropriate video
keyword (NONE, BLINK,
BOLD, REVERSE, UNDERLINE
or SPECIAL-GRAPHICS)
is returned; if there are
multiple video attributes for
the window's status line, the
integer 1 is returned. (If there is
no status line for the window,
the integer 0 is returned.)

"text"

Keyword

Value that indicates which
keyword was used with SET
(TEXT, window, keyword)

"underline—
status"

Integer (1 or 0)^

Value that indicates whether
UNDERLINE is one of the
video attributes of the window's
status line

"underline—
video"

Integer (1 or 0)^

Value that indicates whether
UNDERLINE is one of the
video attributes of the window

^An integer value of 1 indicates True and an integer value of 0 indicates False.

Parameterl

Table VAXTPU--2

Parameter2

Return Value

Description of Return

"video"

Keyword or
Integer

If there is no video att
or only one video attri
the window, the appro
video keyword (NONE
BLINK, BOLD, REVER
or UNDERLINE) is ret
if there are multiple v
attributes for the wind
integer 1 is returned.

"width"

Integer

Width of the window

GET_INFO - Using a Keyword as Parameterl

Parameterl

Parameter2

Return Value

Description of Return

BUFFERJSl

"current"

Buffer or Integer
0

Current buffer, 0 if no

"first"

Buffer or Integer
0

First buffer in VAXTP
internal list of buffers,
none^

"last"

Buffer or Integer
0

Last buffer in VAXTPU
internal list of buffers,
none^

"next"^

Buffer or Integer
0

Next buffer in VAXTP
internal list of buffers,

"previous"^

Buffer or Integer
0

Preceding buffer in VA
internal list of buffers,
first^

"command"

Integer (1 or 0)^

Value that indicates w
/COMMAND was spe
when VAXTPU was in

"command-file"

String

File specification for
/COMMAND=

COMMAND¬
LINE

WaXTPU orders buffers and processes according to the order in which they are created; the
created are the first in the list.
^Use string constants "current" or "first" before using "next".

Use "current" or "last" before

"previous".
^An integer value of 1 indicates True and an integer value of 0 indicates False.

Parameterl

Parameter2

Return Value

Description of Return Value

"create"

Integer (1 or 0)^

Value that indicates whether
/CREATE is active (either by
default or because /CREATE
was specified when VAXTPU
was invoked)

"display"

Integer (1 or 0)^

Value that indicates whether
/DISPLAY is active (either by
default or because /DISPLAY
was specified when VAXTPU
was invoked)

"file_name"

String

File specification used as a
parameter when VAXTPU was
invoked

"journal"

Integer (1 or 0)^

Value that indicates whether
/JOURNAL is active (either by
default or because /JOURNAL
was specified when VAXTPU
was invoked)

"journal—file"

String

File specification for
/JOURNAL=

"output"

Integer (1 or 0)^

Value that indicates whether
/OUTPUT is active (either by
default or because /OUTPUT
was specified when VAXTPU
was invoked)

"output—file"

String

File specification for /OUTPUT=

"read-only"

Integer (1 or 0)^

Value that indicates whether
/READ-ONLY was specified
when VAXTPU was invoked

"recover"

Integer (1 or 0)^

Value that indicates whether
/RECOVER was specified when
VAXTPU was invoked

"section"

Integer (1 or 0)^

Value that indicates whether
/SECTION is active (either by
default or because /SECTION
was specified when VAXTPU
was invoked)

'^An integer value of 1 indicates True and an integer value of 0 indicates False.

Parameterl

DEBUG

Parameter2

Return Value

Description of Return

"section—file"

String

File specification for
/SECTION=

"local"

Variable

First local variable in t
previous procedure, 0 i
are no more local varia
When the return value
TPU$_FAILURE is retu
When you set the debu
context to local, and u
the GET_INFO parame
DEBUG, the parameter
and "previous" refer to
variables.

"next"

Parameter or
variable

Next parameter (or 0 if
are no more parameter
the context is set to pa
next local variable (or
are no more local varia
when the context is set
When the return value
TPU$_FAILURE is retu

"parameter"

Parameter

First parameter of the p
procedure, 0 if there ar
more parameters. Whe
return value is 0, TPU
FAILURE is returned.
you set the debugging
to parameter and use t
GET_INFO parameter
the parameters "next"
"previous" refer to para

"previous"

Parameter or
variable

Previous parameter (or
there are no more para
when the context is se
parameter; previous lo
variable (or 0 if there a
more local variables) w
context is set to local.
the return value is 0, T
FAILURE is returned.

Parameterl

Parameter2

Return Value

Description of Return Value

DEFINED_KEY4

"first"

Keyword

Keyword of the first key in the
specified key map or key-map
list.

"last"

Keyword

Keyword of the last key in the
specified key map or key-map
list.

"next"5

Keyword

Keyword of the next key in the
specified key map or key-map
list.

"previous"^

Keyword

Keyword of the previous key
in the specified key map or
key-map list.

"first"

String

Name of the first key map in
the key-map list.

"last"

String

Name of the last key map in
the key-map list.

"next"^

String

Name of the next key map in
the key-map list.

"previous"^

String

Name of the previous key map
in the key-map list.

"current"

String

Name of the current key-map
list.

"first"

String

Name of the first key-map list.

KEY_MAP6

KEY_MAP_LIST

"last"

String

Name of the last key-map list.

"next"^

String

Name of the next key-map list.

"previous"^

String

Name of the previous key-map
list.

“^Use String constants "current" or "first" before using "next".

Use "current" or "last" before using

"previous".
^When Parameterl is DEFINED_KEY the built-in procedure takes a string as a third parameter.

The

string specifies the name of either the key map or key-map list to be searched.
^Use string constant "first" before using "next". Use "last" before using "previous". Note that "current"is not valid when Parameterl is DEFINED_KEY or KEY_MAP, although it is valid when Parameterl is
KEY_MAP_LIST.
^When Parameterl is KEY_MAP, the built-in procedure takes a string as a third parameter. The string
specifies the name of the key-map list to be searched.

Parameterl

Parameter2

Return Value

Description of Return

PROCESS

"first"

Process or
Integer 0

First process in VAXT
internal list of processe
none^

"last"

Process or
Integer 0

Last process in VAXTP
internal list of processe
none^

"next"2

Process or
Integer 0

Next in VAXTPU's inte
of processes, 0 if last^

"previous"^

Process or
Integer 0

Preceding process in V
internal list of processe
first^

"ansi_crt"

Integer (1 or 0)^

Value that indicates w
the terminal is an ANS

"current—
column"

Integer

Column number of the
column

"current—row"

Integer

Screen line number of
current row

"dec—crt"

Integer (1 or 0)^

Value that indicates w
the terminal is a DEC—

"dec—crt2"

Integer (1 or 0)^

Value that indicates w
the terminal is a DEC—

"edit—mode"

Integer (1 or 0)^

Value that indicates w
the terminal is set to e

"eightbit"

Integer (1 or 0)^

Value that indicates w
the terminal uses eigh
characters

"line—editing"

Keyword or
Integer 0

Current method of line
(Insert or Overstrike),

"original—Width"

Integer

Physical width of the
when you invoked VA

"scroll"

Integer (1 or 0)^

Value that indicates w
terminal has scrolling
DEC-CRT

"visible—length"

Integer

Page length of the term

SCREEN

^Use string constants "current" or "first" before using "next".

Use "current" or "last" before

"previous".
^An integer value of 1 indicates True and an integer value of 0 indicates False.

Parameterl

Parameter2

Return Value

Description of Return Value

"width"

Integer

Current physical width of the
screen

"vklOO"

Integer (1 or 0)^

Value that indicates whether
the terminal is a GIGI

"vtlOO"

Integer (1 or 0)^

Value that indicates whether
the terminal is in the VTIOO
series

"vt200"

Integer (1 or 0)^

Value that indicates whether the
terminal is in the VT200 series;
returns true only on VAX/VMS
Version 4.0 or higher

The following items are established or changed with the built-in
procedure SET.

SYSTEM

"auto_repeat"

Integer (1 or 0)^

Value that indicates whether the
terminal's auto repeat feature is
on

"prompt—length"

Integer

Number of lines in the prompt
area

"prompt—row"

Integer

Screen line number at which
the prompt area begins

"screen —update"

Integer (1 or 0)^

Value that indicates whether
screen updating is turned on

"display"

Integer (1 or 0)^

Value that indicates whether
the supported input device is a
terminal; if the VAXTPU session
is running in batch mode, 0 is
returned.

"journal—file"

String

Name of the journal file

"section—file"

String

Name of section file used when
VAXTPU was invoked

"update"

Integer

Update number of this version
of VAXTPU

"version"

Integer

Version number of VAXTPU

The following items are established or changed with the built-in
procedure SET.

^An integer value of 1 indicates True and an integer value of 0 indicates False.

Table VAXTPU-2 (Cont.)
Parameterl

WINDOW|[SI

GET_INFO - Using a Keyword as Parameterl

Parameter2

Return Value

Description of Return

"bell"

Keyword or
Integer 0

ALL if bell is on for al
messages, BROADCAST
is on for broadcast mes
only, 0 if SET (BELL,...
is off

"facility_name"

String

Current facility name

"informational"

Integer (1 or 0)^

Value that indicates wh
SET (INFORMATIONA
on

"journalingfrequency"

Integer

The number that indica
frequently records are w
the journal file

"message-flags"

Integer

Current value of messa
setting

"shift-key"

Keyword

Value of the key set wi
(SHIFT-KEY) for the cu
buffer

"success"

Integer (1 or 0)^

Value that indicates wh
SET (SUCCESS,...) is o

"timed—message"

String or Integer
0

Text that VAXTPU disp
at one-second intervals
prompt area

"current"

Window or
Integer 0

Current window on the
0 if none

"first"

Window or
Integer 0

First window in VAXT
internal list of windows
none^

"last"

Window or
Integer 0

Last window in VAXTP
internal list of windows
none^

"next"^

Window or
Integer 0

Next window in VAXT
internal list of windows
last^

^Use string constants "current" or "first" before using "next". Use "current" or "last" before u
"previous".
^An integer value of 1 indicates True and an integer value of 0 indicates False.

^VAXTPU orders windows according to their "original top" line number. If multiple windows
same top line number, the most recently created window comes first in VAXTPU's list of wind

Parameterl

Parameter2

Return Value

"previous"^

Window or
Integer 0

Description of Return Value
Preceding window in VAXTPU's
internal list of windows, 0 if
fiistZ

^Use string constants "current" or "first" before using "next". Use "current" or "last" before using
"previous".
^VAXTPU orders windows according to their "original top" line number. If multiple windows have the
same top line number, the most recently created window comes first in VAXTPU's list of windows.

DIGITAL Standard Runoff
The information on the DIGITAL Standard Runoff (DSR) text formatter consists of
the following sections:
1.

DSR commands

DSR flags

RUNOFF command line format

RUNOFF/INDEX command qualifiers

RUNOFF/CONTENTS command qualifiers

How to produce an index

How to produce a table of contents

For further information, see the VAX DIGITAL Standard Runoff (DSR) Reference Manual
and the VAX/VMS Guide to Text Processing.
Online help about the command format is available on your VAX/VMS system by
typing:
$ HELP RUNOFF

NOTE: A dagger (j) is used to indicate that a command starts by issuing a .BREAK
command. The dagger is not part of the command.

DSR.1

DSR Commands

DSR commands, with default values and standard abbreviations.

DSR-2

DIGITAL Standard Runoff
DSR Commands

.APPENDIXt [appendix-title] (.AX)
Starts a new appendix on a new page.

.AUTOJUSTIFY (.AJ) (default)
.NO AUTOJUSTIFY (.NAJ)
Turns on justification and filling at the start of each header level, chapter,
appendix, note, and footnote.

.AUTOPARAGRAPH (.AP)
.NO AUTOPARAGRAPH (.NAP) (default)
Starts a new paragraph each time a blank line or a line that begins with a space
or tab is encountered. (See .AUTOTABLE and .SET PARAGRAPH.)

AUTOSUBTITLE [[+/-] header-level-number] (.AST) (default)
.NO AUTOSUBTITLE (.NAST)
Outputs as a subtitle the title of the latest header at or below the level specified.
This is effective only when .SUBTITLE is enabled.
Default: If no parameter is specified, the output header level 1 title becomes the
subtitle.

.AUTOTABLE (.AT)
.NO AUTOTABLE (.NAT) (default)
Starts a new paragraph at any line that does not begin with a space or tab. (See
.AUTOPARAGRAPH.)

.BEGIN BAR (.BB)
.END BAR (.EB)
Inserts change bars at the start of all output lines for text between .BEGIN BAR
and .END BAR. This is effective only when the .ENABLE BAR command has
been issued. (See also /CHANGE_BARS qualifier description.)

.BLANKt [Nn] (.B)
Outputs n blank lines. If n is negative, outputs blank lines until n lines are left
on the page. Terminates output of blank lines at a page break.
Default: .BLANK 1

.BREAK (.BR)
Ends current line immediately without filling or justifying.

.CENTERt [[+/-]n];text (.C)
.CENTREt [[+/-]n];text (.C)
Centers text around column n/2 on the next line.
Default: Centers text between left and right margins.

DIGITAL Standard Runoff

DSR-3

DSR Commands

.CHAPTERt [title] (.CH)
Starts a new chapter on a new page.

.CONTROL CHARACTERS (.CC)
.NO CONTROL CHARACTERS (.NCC) (Default)
Enables (disables) recognition of control characters as normal text to be processed
and output. If disabled, all control characters in the input stream are ignored.

.DATE (.D)
.NO DATE (.ND) (Default)
Prints date (DD MMM YY) under the page number at the top of each page, when
.SUBTITLE is enabled and .LAYOUT 0 or 3 is in effect. (See .SET DATE.)

.DISABLE BAR (.DBB) (Default)
.DISABLE BOLDING (.DBO)
.DISABLE HYPHENATION (.DHY)
.DISABLE INDEXING (.DIX)
.DISABLE OVERSTRIKiNG (.DOV)
.DISABLE TOC (.DTC)
See .ENABLE BAR, .ENABLE BOLDING, .ENABLE HYPHENATION, .ENABLE
INDEXING, .ENABLE OVERSTRIKING, .ENABLE TOC, and .ENABLE
UNDERLINING.

.DISPLAY APPENDIXf appendix-number-format-code (.DAX)
.DISPLAY CHAPTERt chapter-number-format-code (.DCH)
.DISPLAY ELEMENTSt [“l”,]list-number-format-code[,“r”] (.DLE)
.DISPLAY LEVELSf [hl1],[hl2],[hl3],[hl4],[hl5],[hl6] (.DHL)
.DISPLAY NUMBERf page-number-format-code (.DNM)
.DISPLAY SUBPAGEf subpage-number-format-code (.DSP)
Changes the numbering format of appendixes, chapters, list elements, header
levels, pages, and subpages.
In .DISPLAY ELEMENTS, the first and third parameters are single (or null)
quoted characters to be used to the left ("1") and right ("r") of the element
number or letter in each list entry.

DIGITAL Standard Runoff

DSR-4

DSR Commands

Format
Code

Description

decimal numbers

octal numbers

hexadecimal numbers

roman uppercase numerals

roman lowercase numerals

roman mixed case numerals (only first character is uppercase)

letters, uppercase

letters, lowercase

letters, mixed case (only first letter is uppercase)

Defaults:
.DISPLAY APPENDIX LU (letters, uppercase)
.DISPLAY CHAPTER D (decimal numbers)
.DISPLAY ELEMENTS " '',D,".'' (decimal numbers)
.DISPLAY LEVELS D,D,D,D,D,D (decimal numbers)
.DISPLAY NUMBER D (decimal numbers)
.DISPLAY SUBPAGE LU (letters, uppercase)

.ELSE variant-name
Use after .IF or .IFNOT and before .ENDIF. Processes text between .ELSE and
.ENDIF as input only if variant-name is (is NOT for .IFNOT) specified by a
/VARIANT switch (qualifier) in the command line.

.ENABLE BAR (.EBB)
.DISABLE BAR (.DBB) (Default)
Enables (disables) generation of change bars for text between .BEGIN BAR
and .END BAR. (Once change bars are enabled, the entire text is shifted three
columns to the right.)

.ENABLE BOLDING (.EBO) (Default)
.DISABLE BOLDING (.DBO)
Enables (disables) bolding by means of the Bold flag (*), if .FLAGS BOLD is in
effect.

.ENABLE HYPHENATION (.EHY) (Default)
.DISABLE HYPHENATION (.DHY)
Enables (disables) hyphenation by means of the Hyphenate flag ( = ), if .FLAGS
HYPHENATE is in effect.

DIGITAL Standard Runoff

dsr-5

DSR Commands

.ENABLE INDEXING (.EIX)
.DISABLE INDEXING (.DIX)
Enables (disables) collecting and printing of index entries.

.ENABLE OVERSTRIKING (.EOV) (Default)
.DISABLE OVERSTRIKING (.DOV)
Enables (disables) overstriking by means of the Overstrike flag (%), if .FLAGS
OVERSTRIKE is in effect.

.ENABLE TOC (.ETC) (Default)
.DISABLE TOC (.DTC)
Enables (disables) the collection of information for the table of contents.

.ENABLE UNDERLINING (.EUN) (Default)
.DISABLE UNDERLINING (.DUL)
Enables (disables) underlining by means of the Underline flag (&), if .FLAGS
UNDERLINE is in effect.

.END BAR (.EB)
.END FOOTNOTE (.EFN)
.END LIST [n] (.ELS)
.END LITERAL (.EL)
.END NOTE [n] (.EN)
.END SUBPAGE (.ES)
See .BEGIN BAR, .FOOTNOTE, .LIST, .LITERAL, .NOTE, and .SUBPAGE.

.ENDIF variant-name (.El)
Terminates .IF or .IFNOT conditional.

.ENTRY topic[> subtopic1> ...> subtopicn] (.Y)
Creates an index entry with no page number reference.

.FIGUREt [n] (.FG)
Outputs n blank lines. If there are not n lines left on the current page, outputs n
blank lines at the top of the next page.
Default: .FIGURE 1

.FIGURE DEFERREDt [n] (.FGD)
Similar to .FIGURE, but if there are not n lines left on the current page, continues
to output text on the current page and outputs n blank lines at the top of the
next page.
Default: .FIGURE DEFERRED 1

DSR-6

DIGITAL Standard Runoff
DSR Commands

.FILLf (.F) (Default)
.NO FILLt (.NF)
Adds words to each output line until the addition of one more word would cross
the right margin. (See .JUSTIFY.)

.FIRST TITLE (.FT)
Outputs the page number, title, and subtitle on the first page of the document.
.FIRST TITLE must precede any text.
Default: No title information on the first page.

.FLAGS ACCEPT (.FL ACCEPT) (Default)
.NO FLAGS ACCEPT (.NFL ACCEPT)
.FLAGS BOLD [new-bold-flag] (.FL BOLD)
.NO FLAGS BOLD (.NFL BOLD) (Default)
.FLAGS BREAK [new-break-flag] (.FL BREAK)
.NO FLAGS BREAK (.NFL BREAK) (Default)
.FLAGS CAPITALIZE [new-capitalize-flag] (.FL CAPITALIZE)
.NO FLAGS CAPITALIZE (.NFL CAPITALIZE) (Default)
.FLAGS COMMENT [new-comment-flag] (.FL COMMENT) (Default)
.NO FLAGS COMMENT (.NFL COMMENT)
.FLAGS CONTROL [new-control-flag] (.FL CONTROL) (Default)
.NO FLAGS CONTROL (.NFL CONTROL)
.FLAGS HYPHENATE [new-hyphenate-flag] (.FL HYPHENATE)
.NO FLAGS HYPHENATE (.NFL HYPHENATE) (Default)
.FLAGS INDEX [new-index-flag] (.FL INDEX)
.NO FLAGS INDEX (.NFL INDEX) (Default)
.FLAGS LOWERCASE [new-lowercase-flag] (.FL LOWERCASE) (Default)
.NO FLAGS LOWERCASE (.NFL LOWERCASE)
.FLAGS OVERSTRIKE [new-overstrike-flag] (.FL OVERSTRIKE)
.NO FLAGS OVERSTRIKE (.NFL OVERSTRIKE) (Default)
.FLAGS PERIOD [new-period-flag] (.FL PERIOD)
.NO FLAGS PERIOD (.NFL PERIOD) (Default)

DIGITAL Standard Runoff

dsr-7

DSR Commands

.FLAGS SPACE [new-space-flag] (.FL SPACE) (Default)
.NO FLAGS SPACE (.NFL SPACE)
.FLAGS SUBINDEX [new-subindex-flag] (.FL SUBINDEX) (Default)
.NO FLAGS SUBINDEX (.NFL SUBINDEX)
.FLAGS SUBSTITUTE [new-substitute-flag] (.FL SUBSTITUTE)
.NO FLAGS SUBSTITUTE (.NFL SUBSTITUTE) (Default)
.FLAGS UNDERLINE [new-underline-flag] (.FL UNDERLINE) (Default)
.NO FLAGS UNDERLINE (.NFL UNDERLINE)
.FLAGS UPPERCASE [new-uppercase-flag] (.FL UPPERCASE) (Default)
.NO FLAGS UPPERCASE (.NFL UPPERCASE)
The .FLAGS commands turn on/off recognition of the specified flags. For all
flags except Bold, Hyphenate, Overstrike, and Underline, these commands also
enable/disable the function as well as recognition of the flag. (See .ENABLE
BOLDING, .ENABLE HYPHENATION, .ENABLE OVERSTRIKING, .ENABLE
UNDERLINING, and Section DSR.2, DSR Flags.)
Exception: The Control flag cannot be reenabled after the .NO FLAGS
CONTROL command has disabled it.

.FLAGS [ALL] (.FL [ALL]) (Default)
.NO FLAGS [ALL] (.NFL [ALL])
The .NO FLAGS ALL command unconditionally disables recognition of all flags
except the Control and Comment flags. After a .NO FLAGS ALL (and before
a .FLAGS ALL) command, no other flag commands take effect. Execution of a
.FLAGS ALL command reinstates flags that were active before the .NO FLAGS
ALL command as well as flags set after the .NO FLAGS ALL command.

.FOOTNOTE (.FN)
.END FOOTNOTE (.EFN)
Places the text between the .FOOTNOTE and .END FOOTNOTE commands in a
footnote at the bottom of the current page.

.HEADER LEVELf [[_]level-number] [title] (.HL)
Starts a new header.
Default: Same level as current header.

.HEADERS LOWER
.HEADERS MIXED (Default)
.HEADERS UPPER
Changes case of 'Page' and 'Index' header words.

DSR-8

DIGITAL Standard Runoff
DSR Commands

.HEADERS [ON] (.HD [ON]) (Default)
.NO HEADERS[ON] (.NHD)
Enables (disables) printing of running heads (title and subtitle information) on
the top three or four lines of each page.

.IF variant-name
If variant-name is specified by a /VARIANT switch (qualifier) in the command
line, processes as input all text between .IF and the corresponding .ELSE (or
.ENDIF, if there is no .ELSE). Conditionals (.IF ... .ENDIF and .IFNOT ...
.ENDIF) can be embedded within other conditionals.

.IFNOT variant-name (.IN)
Similar to .IF, but processes input text if variant-name is NOT specified by a
/VARIANT switch (qualifier).

.INDENTt [[+/-]n] (.1)
Indents the next line n columns to the right (or left, if the parameter is negative)
of the left margin.
Default: Paragraph indent (initially five columns).

.INDEX topic[> subtopic1> ...> subtopicn] (.X)
Creates an index entry with a page number reference.

.JUSTIFY (.J) (Default)
.NO JUSTIFY (.NJ)
Inserts enough additional space between words on a line so that the last word
reaches the right margin. .NO JUSTIFY inserts no additional spacing and creates
a ragged right margin. (See .FILL.)

.KEEP (.K)
.NO KEEP (.NK) (Default)
Outputs all blank input lines as blank lines (when in .NO FILL mode). .NO
KEEP causes blank lines to be discarded.

.LAYOUTt layout-code[,bottom-of-page-spacing] (.LO)
Specifies page layouts:

DIGITAL Standard Runoff

DSR-9

DSR Commands

Code

Page Layout

Title/subtitle flush left, page number and date flush right

Title/subtitle centered, page number centered at the bottom

Title/subtitle flush left odd page, flush right even page, page number centered
at the bottom

Title/subtitle flush left, running page numbers centered at the bottom

The second parameter (vertical spacing between text and page number) is
required for codes 1 to 3 and not allowed for code 0.
Default: .LAYOUT 0

.LEFT MARGINt [+/-]column (.LM)
Sets left margin.
Default: .LEFT MARGIN 0

.LISTt [spacing-between-items,][“character”] (.LS)
.END LISTt [[-]spacing-after-last-item] (.ELS)
Starts (ends) an itemized list. The second parameter allows a bullet character to
be used to replace the numbers that begin each list entry. Lists can be embedded
within other lists. If the .END LIST parameter is negative, outputs blank lines
after the list until the designated number of lines is left on the page.
Default: Single spacing, decimal numbering.

.LIST ELEMENTt;text (.LE;)
Begins new list entry. (Place between .LIST and .END LIST.)

.LITERAL (.LT)
.END LITERAL (.EL)
Outputs block of text between .LITERAL and .END LITERAL exactly as input.
Flags and commands are not recognized within the literal (except for .END
LITERAL), but underlining, bolding, and spacing in effect at the beginning of the
literal continue throughout. Tabs are expanded with spaces, and the left margin
applies to the literal.

.NO AUTOJUSTIFY (.NAJ)
.NO AUTOPARAGRAPH (.NAP) (Default)
.NO AUTOSUBTITLE (.NAST)
.NO CONTROL CHARACTERS (.NCC) (Default)
.NO DATE (.ND) (Default)
.NO FILLt (.NF)

DSR-10

DIGITAL Standard Runoff
DSR Commands

.NO HEADERS [ON] (.NHD [ON])
.NO JUSTIFY (.NJ)
.NO PAGING (.NPA)
.NO PERIOD (.NPR)
.NO SUBTITLE (.NST) (Default)
See .AUTOJUSTIFY, .AUTOPARAGRAPH, .AUTOSUBTITLE, CONTROL
CHARACTERS, .DATE, .FILL, .FLAGS flag-name, .FLAGS [ALL], .HEADERS
[ON], .JUSTIFY, .FOOTNOTE, .PAGING, .PERIOD, or .SUBTITLE.

.NO NUMBER (.NNM)
Disables listing (but not counting) of page numbers. (See .NUMBER PAGE.)

.NO SPACE (.NSP)
Inserts no space between the last character on the previous input line and the
first character on the next input line (when in .FILL mode).

.NOTE [title] (.NT)
.END NOTE [[-]spacing-after-note] (.EN)
Indents text between .NOTE and .END NOTE from both margins and separates it
from the rest of the text by blank lines. Prints NOTE or title centered above the
text of the note. Notes can be embedded within other notes. If the .END NOTE
parameter is negative, outputs blank lines after the note until the designated
number of lines is left on the page.
Default: title = NOTE, spacing-after-note = .SKIP 2

.NUMBER APPENDIX [+/-]new-letter-or-page-number (.NMAX)
.NUMBER CHAPTER [+/-]new-letter-or-page-number (.NMCH)
.NUMBER LEVEL [[+/-]n1],...,[[+/-]n6] (.NMLV)
.NUMBER LIST [+/-]new-element-number (.NMLS)
.NUMBER PAGE [[+/-]new-letter-or-page-number] (.NMPG)
.NUMBER RUNNING [+/-]new-letter-or-page-number (.NMR)
Alters the sequence of numbering for an appendix, chapter, header level, list
element, page, running page, or subpage. In all cases, sequential numbering
resumes.
.NUMBER PAGE and .NUMBER SUBPAGE enable paging and subpaging,
respectively. (See .NO NUMBER.)

.PAGEt ( PG)
Starts a new page.

.PAGE SIZEt [[+/-]length][,[+/-]width] (.PS)
Sets column width (3 to 150) and number of lines per page (13 to 9999).
Default: .PAGE SIZE 58,70

DIGITAL Standard Runoff

DSR-11

DSR Commands

.PAGING (.PA) (Default)
.NO PAGING (.NPA)
Enables (disables) paging. If disabled, text becomes one page.

.PARAGRAPHf [spaces-indented],[vertical-spacing],[test-page-lines] (.P)
Starts a new paragraph and resets paragraph characteristics.
Default: .PARAGRAPH 5,1,2

.PERIOD (.PR) (Default)
.NO PERIOD (.NPR)
Enables (disables) automatic output of two spaces after a period (.), colon (:),
question mark (?), or exclamation point (!) (when .FILL is in effect).

.REPEAT number-of-occurrences “string” (.RPT)
Repeats string of up to 150 text characters. When .NO FILL is in effect, places
each replication on a separate line.

.REQUIRE “file-spec” (.REQ)
Takes input text from a specified file. The .REQUIRE command can be embedded
within files that have been required. The default file type is .RNO.

.RIGHTf [[+/-]columns-from-right-margin];text (.R)
Places text flush with the right margin (no parameter), or flush with a point to
the left (positive parameter), or right (negative parameter) of the right margin.

.RIGHT MARGINt [+/-]last-column (.RM)
Sets right margin.
Default: .RIGHT MARGIN 70

.SET DATEt [[+/-]day],[[+/-]month],[[+/-]year] (.SDT)
Resets date ($$day,$$month,$$year). Use decimal digits (dd,mm,yyyy) to set the
date. (See .FLAGS SUBSTITUTE and .DATE.)
Default: Current system date

.SET LEVEL [+/-]level-number (.SL)
Presets the level of the next section head without issuing a .HEADER LEVEL
command.

.SET PARAGRAPH [spaces-indented],[vertical-spacing],[test-page-lines]
(.SPR)
Sets paragraph characteristics. (Similar to .PARAGRAPH, but does not start a
new paragraph.)

DSR-12

DIGITAL Standard Runoff
DSR Commands

■SET TIME [[+/-]hours],[[+/-]minutes],[[+/-]seconds] (.STM)
Resets time ($$hours,$$minutes,$$seconds). (See .FLAGS SUBSTITUTE.)

■SKIPt [Hvertical-spacing] (.S)
Similar to .BLANK, but .SPACING setting controls the number of lines that are
skipped.
Default: .SKIP 1

■SPACINGt vertical-spacing (.SP)
Changes the amount of spacing between lines of text (and between blank lines
output by .SKIP).
Default: .SPACING 1 (single spacing)

■STYLE HEADERSt (n1,n2,n3,n4,n5,n6,n7,n8,n9) (.STHL)
Assigns header levels at which different formatting styles are in effect.
Parameters n2 and n3 are in effect at the specified level and at all levels with a
header level less than n2 or n3. Parameters nl, n4, and n5 are in effect at the
specified level and at all levels with a header number greater than nl, n4, or n5.
nl = Lowest level at which text starts on same line as title
n2 = Highest level at which title is in all capitals
n3 = Highest level at which first letter of title words is capitalized
n4 = Lowest level that has no header number
n5 = Lowest level that has a centered title
n6 = Number of blank lines before the start of a header
n7 = Number of blank lines after the end of a header
n8 = Implicit test page value executed at start of each header
n9 = Number of spaces between the section number and title
Default: .STYLE HEADERS 3,1,6,7,7,2,1,9,2

■SUBPAGEt (.SPG)
■END SUBPAGEt (-ES)
Places text between the .SUBPAGE and .END SUBPAGE commands on pages
numbered by appending a letter to the page number. Outputs new pages both
before and after subpaging.

■SUBTITLE [new-subtitle] (.ST)
■NO SUBTITLE (.NST) (Default)
Enables (disables) subtitling.

DIGITAL Standard Runoff

DSR-13

DSR Commands

.TAB STOPS [[[+/-ltab-column],...] (.TS)
Resets tab stops. A null parameter causes the corresponding tab to remain
unchanged. No parameters at all disables all tabs.
Default: .TAB STOPS 8,16,24,32,40,...

.TEST PAGEt n (.TP)
Starts a new page if there are fewer than n lines left on the current page.

.TITLEt new-title (.T)
Specifies a new title.

.VARIABLE variant-name [true,false] (.VR)
Finds conditional commands (.IF, .IFNOT, .ELSE, and .ENDIF) and identifies
which are "true" and which are "false." "True" conditionals will be processed.
/DEBUG must be specified.
Default: A space character is output as both "true" and "false".

.XLOWER (.XL)
Makes the case of letters in index entries correspond to the case specified
(explicitly or by flags) in .INDEX and .ENTRY commands (and after the index
flag).

.XUPPER (.XU) (Default)
Capitalizes the first letter of the first word of each index entry and makes all
subsequent text in the index entry lowercase, unless explicit use of the Uppercase
or Capitalize flag in the corresponding .INDEX or .ENTRY command (or after the
index flag) overrides this.

DSR.2

DSR Flags

For bolding, overstriking, hyphenating, and underlining, the DSR command .FLAGS
flag-name causes recognition of the flag character and the .ENABLE function-name
command causes actual operation of the flag. The .FLAGS command causes both
recognition of the flag character and operation of the flag for all .FLAGS commands
except the following: BOLD, HYPHENATE, OVERSTRIKE, and UNDERLINE.

Table DSR-1

DSR Flags
Recognition

Operation
.ENABLE/
.DISABLE

BOLDING

.FLAGS/
.NOFLAGS

Flag Action

Example

Takes next
character as literal
text.

_$_$day is $$day —^
$$day is 18

BOLD

♦

Bolds (overprints)
next character.

B*BB ^ BBB

Turns on bolding
of all text.
Turns off
automatic bolding.

^*AB CD\* CD ^ AB CD CD

Allows but does
not require a line
break at this point.

... end-lof-lline ... —►
... endof-line ...

Capitalizes next
word.

a <bc <de —► a BC DE

^ <

Turns on
capitalization
of all text.
Turns off
automatic
capitalization.

aBc '' <dEf Ghf'' jKL
aBc DEE GHI jKL

Starts comment.

.!Whole Line Comment

Starts DSR
command.

.FILL.JUSTIFY

\*
BREAK

CAPITALIZE

COMMENT

CONTROL
HYPHENATION

HYPHENATE

Allows but does
not require
hyphenation at
this point

... hy=phen=ate ... —►
Some people will hyphen¬
ate to improve a book's
appearance.

INDEX

Indexes next word.

> Digital Equipment —►
Digital, 1-1

LOWERCASE

Makes next
character
lowercase.

AB\CD

ABcD

Table DSR-1 (Cont.)

DSR Flags
Recognition

Operation
.ENABLE/
.DISABLE

.FLAGS/
.NOFLAGS

Flag Action
W

OVERSTRIKING

Turns on
lowercasing of
all text.
Turns off
automatic
lowercasing.

Example

ABCWDEF G^^HIj
ABCdef gHIj

OVERSTRIKE

Overstrikes
previous character.

0%/

PERIOD

Causes (at least)
two spaces to be
output (if flag
is followed by a
space).

... end.)-i- Start ...—►
... end.) Start ...

SPACE

Outputs (exactly)
one space.

a##b#c###d ^ a
C
D

SUBINDEX

Subindexes next
word. (Used
in .INDEX
and .ENTRY
commands.)

.X DSR> pocket guid
DSR
pocket guide
flags, 357

SUBSTITUTE

Inserts time and
date information.

$$date
$$time
$$year
$$month
$$day
$$hours
$$minutes
$$seconds

^
—»
—►
—►
—^
—^
—>

12 M
15:09
1986
Marc
12
15
09
32

DIGITAL Standard Runoff

DSR-16

DSR Flags

Table DSR-1 (Cont.)

DSR Flags

Operation

Recognition

.ENABLE/
.DISABLE

.FLAGS/
.NOFLAGS

Flag Action

Example

UNDERLINING

UNDERLINE

A&BC

UPPERCASE

DSR.3

Underlines next
character.
Turns on
underlining of
all nonblank text.
Turns off
automatic
underlining.
Capitalizes next
character.

ABC

''&AB CD_EF\&GH
AB CD EFGH

"abc

Abe

RUNOFF Command Line Format
$ RUNOFF[/qualifier...]

input-file-spec [/qualifier...]

DSR.3.1 Default File Types for Output
The following defaults are applied, except when /DEVICE=LN01 or /DEVICE=LN03
is specified, in which case the default output type is LNI.
Input

Output

Input

Output

.RNB

.BLB

.RNO

.MEM

.RNC

.CCO

.RNP

.RND

.DOC

.RNS

.STD

.RNE

.ERR

.RNT

.MEC

.RNH

.HLP

.RNX

.MEX

.RNL

.PLM

none

.MEM

.RNM

.MAN

other

.MEM

DIGITAL Standard Runoff

DSR-17

RUNOFF Command Line Format

DSR.3.2 Command Line Qualifiers
/BACKSPACE
Backspaces (instead of overprinting) to underline, boldface, and overstrike.
/BOLD=overstrikes
/NOBOLD
/BOLD specifies the number of overstrikes to simulate bolding. The .FLAGS
BOLD command must be executed within the input file to cause the Bold flag (♦)
to be recognized. /NOBOLD disables bolding for all input.
Default: /BOLD=l
/CHANGE_BARS[=“new-change-bar-character”]
/NOCHANGE_BARS
Enables change bars and optionally specifies a change bar character other than
the default vertical bar (I). /NOCFIANGEBARS disables change bars for all
input.
/DEBUG[=ALL]
Traces all the DEBUG options.
/DEBUG=CONDITIONALS
Ignores conditionals; draft flags appear in output.
/DEBUG=CONTENTS
Echoes .SEND TOC commands in output file.
/DEBUG=FILES
Echoes .REQUIRE commands in output file.
/DEBUG=INDEX
Echoes index entries in output file.
/DEBUG=SAVE_RESTORE
Echoes .SAVE and .RESTORE commands in output.

/DEBUG=(option,.-)
Default: No debugging features are enabled.
/DEV1CE=LN01 [.option,...]
/DEVICE=LN01 E[,option,...]

DSR-18

DIGITAL Standard Runoff
RUNOFF Command Line Format

/DEVICE=LN03[,option,...]
Generates output for the LNOl laser printer, the European LNOIE, or the LN03
laser printer, respectively. If specified, the default file type is .LNI and the
following options may be specified:
ITALIC
UNDERLINE

Determines whether underlined or italic text is generated for DSR
underlining sequences. Default: ITALIC

PORTRAIT
LANDSCAPE

Selects orientation of text displayed by the laser printer. Default:
PORTRAIT

/DOWN[=n]
Skips n blank lines at the top of each page before the header (title) information.
Defaults: /DOWN=0. /DOWN without a parameter skips 5 lines.

/FORM_-SIZE[=number]
Specifies maximum number of lines of text that can be output on a page.
Default: /FORM_SIZE=66

/INTERMEDIATE[=file-spec]
/NOINTERMEDIATE (Default)
Creates an intermediate file (.BRN) of table of contents and indexing information.
This file is used for processing by the DSR Indexing and Table of Contents
utilities.

/LOG
/NOLOG (Default)
Outputs termination message (number of errors, DSR version number, number of
pages) to terminal after completion of DSR processing.

/MESSAGES=option
The OUTPUT option sends error messages to the output file only. The USER
option sends error messages to the terminal only.
Default: Error messages sent to both terminal and output file.

/OUTPUT[=file-spec]
/NOOUTPUT
Specifies output file.
Default: /OUTPUT=input.MEM

DIGITAL Standard Runoff

dsr-19

RUNOFF Command Line Format

/PAGES=“start1 :end1
Outputs only the pages within the ranges specified. If endn is not specified in
the last range, defaults to the last page of the text. A maximum of 5 ranges may
be specified.
Default: All pages output.

/PAUSE
/NOPAUSE (Default)
Output pauses and terminal bell rings after printing of each page. You can press
any key to resume printing.

/REVERSE^EMPHASIS
Reverses the standard order of underlining and printing for text to be underlined.
Cause the following output sequence: line of text, carriage return without line
feed, underline character(s).
Default: Output sequence as follows: underline character(s), carriage return
without line feed, line of text.

/RIGHT[=columns]
Shifts each line of the output file right by the specified number of columns.
/RIGHT without a parameter shifts the text 5 columns.
Default: /RIGHT=0

/SEPARATE^UNDERLINE[=“character”]
Underlines after executing a line feed. Uses separate characters on the next line,
rather than overprinting with the underscore character.
Default: /SEPARATE _UNDERLINE="-"

/SEQUENCE
/NOSEQUENCE (Default)
Generates input file sequence numbers in the output file.

/SIMULATE
/NOSIMULATE (Default)
Simulates form feeds with line feeds. (Causes an automatic /PAUSE before the
first page.)

/UNDERLINE_CHARACTER=“character”
/NOUNDERLINE-CHARACTER
Substitutes character for the underscore as the underlining character. Character
will be overprinted. /NOUNDERLINE disables underlining for all input. (See
/NONSPACING-UNDERLINE and /SEPARATE-UNDERLINE.)

DSR-20

DIGITAL Standard Runoff
RUNOFF Command Line Format

Default: /UNDERLINE _CHARACTER="_''

/VARIANT=string
/VARIANT=“string,,..”
Associates string or strings with a true condition in the execution of conditional
commands (.IF, .IFNOT, .ELSE, .ENDIF).

DSR.4 /INDEX Command Line Qualifiers
$ RUNOFF/INDEX file-spec[_]

file-spec[+...]

/IDENTIFICATION
/NOIDENTIFICATION (Default)
Controls whether /INDEX reports its version number.

/LINES-PER_PAGE=number-oMines
Specifies number of lines per page to be used for indexing information
(exclusive of headings and footings). /LINES_PER_PAGE has no effect if
/LAYOUT=GALLEY has been specified.
Default: LINES_PER_PAGE=55 (54 for typeset output)

/LOG
/NOLOG (Default)
Controls whether /INDEX reports the file specification of each input
(intermediate) file it processes, and the file specification of the generated output
file.

/OUTPUT[=file-spec]
/NOOUTPUT
Specifies output file.
Default: /OUTPUT=input.RNX

/PAGE_NUMBERS=option
/NOPAGE_NUMBERS
Controls appearance of page numbers in the index. The options are:
NORUNNING

Chapter-oriented page numbers (such as 6-4) are used.

RUNNING

Running page numbers (such as 127) are used.

Default: /PAGE_NUMBERS=NORUNNING

/REQUIRE=file-spec
Specifies a file of DSR input to be inserted at the top of the first index page
(instead of the default centered title "INDEX" followed by three blank lines).

DIGITAL Standard Runoff

DSR-21

/INDEX Command Line Qualifiers

/RESERVE=number-of-lines
Specifies the number of lines to allow at the top of the first index page for
inclusion of required text. Usually used in conjunction with /REQUIRE.

DSR.5 /CONTENTS Command Line Qualifiers
$ RUNOFF/CONTENTS file-spec[,...]

file-spec[+...]

/BOLD[=header-level-depth]
/NOBOLD (Default)
Performs any bolding that is present in header, example, figure, and table titles.
If an argument is supplied, performs bolding only up through the level specified.
/DEEPEST_HEADER[=header-level-depth]
Displays in the table of contents only those headers up through the level
specified.
Default: /DEEPEST_HEADER=6
/IDENTIFICATION
/NOINDENTIFICATION (Default)
Controls whether /CONTENTS reports its version number.
/INDENT
/NOINDENT (Default)
Establishes Table of Contents indention rules.
/LOG
/NOLOG (Default)
Controls whether /CONTENTS reports the file specification of each input (.BRN
/.BIX) file it processes, and the file specification of each generated output file.
/OUTPUT[=file-spec]
/NOOUTPUT
Specifies output file.
Default: /OUTPUT=input.RNT
/PAGE_NUMBERS=option
Controls appearance of page numbers in the table of contents. The options are:
NORUNNING

Uses chapter-oriented page numbers (such as 1-2).

RUNNING

Uses running page numbers (such as 127).

Default: /PAGE_NUMBERS=NORUNNING

DSR-22

DIGITAL Standard Runoff
/CONTENTS Command Line Qualifiers

/REQUIRE=file-spec
Includes the contents of a file of DSR input to be inserted at the top of the
first table of contents page, instead of the default centered title "CONTENTS"
followed by three blank lines.

/SECTION_NUMBERS (Default)
/NOSECTION-NUMBERS
Controls the display of section (header level) numbers in the table of contents.

/UNDERLINE
/NOUNDERLINE (Default)
Performs any underlining that is present in header, example, figure, or table
titles.

DSR.6

Producing an Index

Use the following steps to produce an index:
1.

Enter indexing commands (.X or .Y) in the RNO file.

Process the RNO file with RUNOFF/INTERMEDIATE to generate an
intermediate binary file (BRN).

Process the resulting BRN file with RUNOFF/INDEX to generate an RNX file.

Process the RNX file with RUNOFF in one of the following ways:

•

Process the RNX file with RUNOFF to produce a MEX file that contains a
formatted index.

•

Include the RNX file in a master file that uses .REQUIRE commands to
include all parts of your document. When you process the master file with
the RUNOFF command, the formatted index will be placed in your document
where you "require" it.

Use the DCL PRINT command on either the MEX or MEM file to see a copy of
your index.

These steps are described more fully in the VAX DIGITAL Standard Runoff (DSR)

Reference Manual.

DIGITAL Standard Runoff
Producing a Table of Contents

DSR-23

DSR.7 Producing a Table of Contents
The DSR table of contents utility creates a formatted table-of-contents file from the
chapter, section, and appendix titles specified by .CHAPTER, .APPENDIX, .HEADER
LEVEL, and .SEND TOC commands in your RNO file.
Use the following steps to produce a table of contents:
1.

Process the RNO file with RUNOFF/INTERMEDIATE to produce an intermediate
binary file (BRN).

Process the resulting BRN file with RUNOFF/CONTENTS to produce an RNT
file.

Process the RNT file with RUNOFF in one of the following ways:

•

Process the RNT file with the RUNOFF command to produce a MEC file that
contains the formatted table of contents.

•

Include the RNT file in a master file that uses .REQUIRE commands to
include all parts of your document. When you process the master file with
the RUNOFF command, the formatted table of contents will be placed in the
MEM file where you "require" it.

Use the DCL PRINT command on either the MEC or MEM file to get a copy of
your table of contents.

These steps are described more fully in the VAX DIGITAL Standard Runoff (DSR)

Reference Manual.

Progr

Introduction to System Routines
The sections that follow provide quick reference information for programmers
using VAX/VMS system services (SYS), Run-Time Library routines (RTL), callable
utility routines (UTIL), and VAX Record Management Services (RMS). Complete
documentation of these components, including examples and explanations of
important concepts, is in the appropriate reference manuals in the VAX/VMS
document set.
In this Mini-Reference, routines are listed alphabetically within each section.
Following the routine format is a description of each argument, with the following
items of information: argument name, VMS usage, data type, access method, and
passing mechanism. For example,
flags I mask—longword I long word (unsigned) I read only I by value

indicates that the flags argument has a VMS usage of mask—longword, is an unsigned
longword, is accessed as read-only data by the called routine, and contains the actual
data to be used by the called routine (and thus is passed "by value"). The Introduction
to VAX/VMS System Routines explains each of these items; it also includes the "VAX
Procedure Calling and Condition Handling Standard" and tables matching VMS
Usage entries with their implementations in various VAX languages.
Several system services have synchronous forms ending in "W," indicating the
program should "wait" until the called routine completes before proceeding.
Each synchronous form system service has an abbreviated entry following the
asynchronous form; you should refer to the asynchronous form service for return
status and argument information. For example, the return status and arguments for
SYS$GETQUIW (Get Queue Information and Wait) are the same as for SYS$GETQUI
(Get Queue Information).

System Services
SYS$ADD_HOLDER id ,holder ,[attrib]
id I rights_id I longword (unsigned) I read only I by value
holderlrights—holderlquadword (unsigned) I read only I by reference
attrib I mask—longword I longword (unsigned) I read only I by value

SYS$ADD_IDENT name ,[id] ,[attrib] ,[resid]
name I char-string I character-coded text string I read only I by descriptor-fixed length
string descriptor
id I rights—id I longword (unsigned) I read only I by value
attrib I mask—longword I longword (unsigned) I read only I by value
resid I rights—id I longword (unsigned) I write only I by reference

SYS$ADJSTK [acmode] ,[adjust] ,newadr
acmode I access—mode I longword (unsigned) I read only I by value
adjust I word—signed I word (signed) I read only I by value
newadr I address I longword (unsigned) I modify I by reference

SYS$ADJWSL [pagcnt] ,[wsetlm]
pagcnt I longword—signed I longword (signed) I read only I by value
wsetlm I longword—unsigned I longword (unsigned) I write only I by reference

SYS$ALLOC devnam ,[phylen] ,[phybuf] ,[acmode] ,[flags]
devnam I device—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
phylen I word—unsigned I word (unsigned) I write only I by reference
phybuf I device—name I character-coded text string I write only I by descriptor-fixed length
string descriptor

SYS-2

System Services

acmode I access_mode I longword (unsigned) I read only I by value
flags I mask—longword I long word (unsigned) I read only I by value

SYS$ASCEFC efn ,name /[prot] ,[perm]
efn I ef_number I longword (unsigned) I read only I by value
name I ef_cluster_name I character-coded text string I read only I by descriptor-fixed
length string descriptor
prot I boolean I byte (unsigned) I read only I by value
perm I boolean I by te (unsigned) I read only I by value

SYS$ASCTIM [timlen] ,timbuf ,[timadr] ,[cvtflg]
timlen I word—unsigned I word (unsigned) I write only I by reference
timbuf I time_name I character-coded text string I write only I by descriptor-fixed length
string descriptor
timadr I date_time I quadword (unsigned) I read only I by reference
cvtflg I longword—unsigned I longword (unsigned) I read only I by value

SYS$ASCTOID name ,[id] ,[attrib]
name I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
id I rights_id I longword (unsigned) I write only I by reference
attrib I mask—longword I longword (unsigned) I write only I by reference

SYS$ASSIGN devnam ,chan ,[acmode] ,[mbxnam]
devnam I device_name I character-coded text string I read only I by descriptor-fixed length
string descriptor
chan I channel I word (unsigned) I write only I by reference
acmode I access—mode I longword (unsigned) I read only I by value
mbxnam I device—name I character-coded text string I read only I by descriptor-fixed length
string descriptor

SYS$BINTIM timbuf ,timadr
timbuf I time—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
timadr 1 date—time I quadword (unsigned) I write only I by reference

System Services

SYS-3

SYS$BRKTHRU [efn] ,msgbuf [,sendto] [,sndtyp] [,iosb] [,carcon] [,flags] [,reqid]
[,timout] [,astadr] [,astprm]
efnief—numberllongword (unsigned) I read only I by value
msgbuflchar—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
sendto I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
sndtyp I longword—unsigned I longword (unsigned) I read only I by value
iosbiio—status—blocklquadword (unsigned) I write only I by reference
carcon I longword—unsigned I longword (unsigned) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
reqid I longword—unsigned I longword (unsigned) I read only I by value
timout I longword—unsigned I longword (unsigned) I read only I by value
astadr last—procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user—arg I longword (unsigned) I read only I by value

SYS$BRKTHRUW [efn] ,msgbuf [,sendto] [,sndtyp] [,iosb] [,carcon] [,flags] [,reqid]
[,timout] [,astadr] [,astprm]
SYS$CANCEL chan
chan I channel I word (unsigned) I read only I by value

SYS$CANEXH [desblk]
desblklexit—handler—block I longword (unsigned) I read only I by reference

SYS$CANTIM [reqidt] ,[acmode]
reqidt I user—arg I longword (unsigned) I read only I by value
acmode I access—mode I longword (unsigned) I read only I by value

SYS$CANWAK [pidadr] ,[prcnam]
pidadr I process—id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor

SYS$CHANGE-ACL [chan] ,objtyp ,[objnam] ,itmlst ,[acmode] ,[nullarg] ,[contxt]
chan I channel I word (unsigned) I read only I by value
objtyp I longword—unsigned I longword (unsigned) I read only I by reference
objnaml char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
itmlstlitem—list—31 longword (unsigned) I read only I by reference

SYS-4

System Services

acmodelaccess—modellongword (unsigned) I read only I by reference
nullarginull—argllongword (unsigned) I read only I by value
contxticontextilongword (unsigned) I modify I by reference

SYS$CHECK_ACCESS objtyp ,objnam ,usrnam ,itmlst
obj typ I longword—unsigned I longword (unsigned) I read only I by reference
objnam I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
usrnam I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
itmlst I item—list _31 longword (unsigned) I read only I by reference

SYS$CHKPRO itmlst
itmlst I item_list_31 longword (unsigned) I read only I by reference

SYS$CLREF efn
efn I ef_number I longword (unsigned) I read only I by value

SYS$CMEXEC routin ,[arglst]
routin I procedure I procedure entry mask I call without stack unwinding I by reference
arglst I arg—list I longword (unsigned) I read only I by reference

SYS$CMKRNL routin ,[arglst]
routin I procedure I procedure entry mask I call without stack unwinding I by reference
arglst I arg—list I longword (unsigned) I read only I by reference

SYS$CNTREG pagcnt ,[retadr] ,[acmode] ,[region]
pagcnt I longword—unsigned I longword (unsigned) I read only I by value
retadr I address—range I longword (unsigned) I write only I by reference
acmodelaccess—modellongword (unsigned) I read only I by value
region I longword_unsigned I longword (unsigned) I read only I by value

SYS$CREATE_RDB [sysid]
sysidlsystem—access—id I quad word (unsigned) I read only I by reference

SYS$CRELNM [attr] ,tabnam ,lognam ,[acmode] ,[itmlst]
attr I mask—longword I longword (unsigned) I read only I by reference
tabnam I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor

System Services

sys-5

lognam I logical_name I character-coded text string I read only I by descriptor-fixed length
string descriptor
acmodelaccess—modelbyte (unsigned) I read only I by reference
itmlstlitem_list_3llongword (unsigned) I read only I by reference

SYS$CRELNT [attr] ,[resnam] ,[reslen] ,[quota] ,[promsk] ,[tabnam] ,partab ,[acmode]
attrlmask—longwordllongword (unsigned) I read only I by reference
resnam I logical—name I character-coded text string I write only I by descriptor-fixed length
string descriptor
reslen I word—unsigned I word (unsigned) I write only I by reference
quota I longword—unsigned I longword (unsigned) I read only I by reference
promsk I file—protection I word (unsigned) I read only I by reference
tabnam I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
partab I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
acmode I access—mode I byte (unsigned) I read only I by reference

SYS$CREMBX [prmflg] ,chan ,[maxmsg] ,[bufquo] ,[promsk] ,[acmode] ,[lognam]
prmflg I boolean I byte (unsigned) I read only I by value
chan I channel I word (unsigned) I write only I by reference
maxmsg I longword—unsigned I longword (unsigned) I read only I by value
bufquo I longword—unsigned I longword (unsigned) I read only I by value
promsk I file—protection I longword (unsigned) I read only I by value
acmode I access—mode I longword (unsigned) I read only I by value
lognam I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor

SYS$CREPRC [pidadr] ,[image] ,[input] ,[output] ,[error] ,[prvadr] ,[quota] ,[prcnam]
,[baspri] ,[uic] ,[mbxunt] ,[stsflg]
pidadr I process—id I longword (unsigned) I write only I by reference
image I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
input I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
output I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor

SYS-6

System Services

error I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
prvadr I mask—privileges I quad word (unsigned) I read only I by reference
quotalitem—quota—list I longword (unsigned) I read only I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
baspri I longword—unsigned I longword (unsigned) I read only I by value
uic I uic I longword (unsigned) I read only I by value
mbxunt I word—unsigned I word (unsigned) I read only I by value
stsflg I mask—longword I longword (unsigned) I read only I by value

SYS$CRETVA inadr ,[retadr] ,[acmode]
inadr I address—range I longword (unsigned) I read only I by reference
retadr I address—range I longword (unsigned) I write only I by reference-array reference or
descriptor
acmode I access—mode I longword (unsigned) I read only I by value

SYS$CRMPSC [inadr] ,[retadr] ,[acmode] /[flags] ,[gsdnam] ,[ident] ,[relpag] ,[chan]
,[pagcnt] ,[vbn] ,[prot] ,[pfc]
inadr I address—range I longword (unsigned) I read only I by reference
retadr I address—range I longword (unsigned) I write only I by reference-array reference or
descriptor
acmode I access—mode I longword (unsigned) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
gsdnam I section—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
ident I section—id I quad word (unsigned) I read only I by reference
relpag I longword—unsigned I longword (unsigned) I read only I by value
chan I channel I word (unsigned) I read only I by value
pagcnt I longword_unsigned I longword (unsigned) I read only I by value
vbn I longword—unsigned I longword (unsigned) I read only I by value
prot I file—protection I longword (unsigned) I read only I by value
pfc I longword—unsigned I longword (unsigned) I read only I by value

SYS$DACEFC efn
efn I ef—number I longword (unsigned) I read only I by value

System Services

sys-7

SYS$DALLOC [devnam] ,[acmode]
devnam I device_name I character-coded text string I read only I by descriptor-fixed length
string descriptor
acmode I access_mode I longword (unsigned) I read only I by value
SYS$DASSGN chan
chan I channel I word (unsigned) I read only I by value
SYS$DCLAST astadr ,[astprm] ,[acmode]
astadr I ast_procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user_arg I longword (unsigned) I read only I by value
acmode I access_mode I longword (unsigned) I read only I by value
SYS$DCLCMH addres ,[prvhnd] ,[type]
addres I procedure I procedure entry mask I call without stack unwinding I by reference
prvhnd I address I longword (unsigned) I write only I by reference
type I longword—unsigned I longword (unsigned) I read only I by value
SYS$DCLEXH desblk
desblk I exit _handler_block I longword (unsigned) I read only I by reference
SYS$DELLNM tabnam ,[lognam] ,[acmode]
tabnam I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
lognam I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
acmode I access—mode I byte (unsigned) I read only I by reference
SYS$DELMBX chan
chan I channel I word (unsigned) I read only I by value
SYS$DELPRC [pidadr] ,[prcnam]
pidadr I process—id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
SYS$DELTVA inadr ,[retadr] ,[acmode]
inadr I address—range I longword (unsigned) I read only I by reference
retadr I address—range I longword (unsigned) I write only I by reference
acmode I access—mode I longword (unsigned) I read only I by value

SYS-8

System Services

SYS$DEQ [Ikid] [,valblk] [,acmode] [,flags]
Ikidllock—idllongword (unsigned) I read only I by value
valblk I lock _value_block I longword (unsigned) I modify I by reference
acmode I access_mode I longword (unsigned) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
SYS$DGBLSC [flags] ,gsdnam ,[ident]
flags I mask—longword I longword (unsigned) I read only I by value
gsdnam I section—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
ident I section—id I quad word (unsigned) I read only I by reference
SYS$DISMOU devnam ,[flags]
devnam I device—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
flags I mask—longword I longword (unsigned) I read only I by value
SYS$DLCEFC name
namelef—cluster—name I character-coded text string I read only I by descriptor-fixed
length string descriptor
SYS$ENQ [efn] ,lkmode ,lksb [,flags] [,resnam] [,parid] [,astadr] [,astprm] [,blkast]
[,acmode] [,nullarg]
efn I ef—number I longword (unsigned) I read only I by value
Ikmode I longword—unsigned I longword (unsigned) I read only I by value
Iksbllock—status—block I longword (unsigned) I write only I by reference
flags I mask—longword I longword (unsigned) I read only I by value
resnam I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
parid I lock—id I longword (unsigned) I read only I by value
astadr last—procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user-arg I longword (unsigned) I read only I by value
blkast last-procedure I procedure entry mask I call without stack unwinding I by reference
acmode I access—mode I longword (unsigned) I read only I by value
nullarg I null—arg I longword (unsigned) I read only I by value

System Services

sys-9

SYS$ENQW [efn] ,lkmode ,lksb [,flags] [,resnam] [,parid] [,astadr] [,astprm] [,blkast]
[,acmode] [,nullarg]
SYS$ERAPAT [type] ,[count] ,[patadr]
type I longword—unsigned I longword (unsigned) I read only I by value
count I longword—unsigned I longword (unsigned) I read only I by value
patadrilongword—unsignedllongword (unsigned) I write only I by reference
SYS$EXIT [code]
code I cond_value I longword (unsigned) I read only I by value
SYS$EXPREG pagcnt ,[retadr] ,[acmode] ,[region]
pagcnt I longword—unsigned I longword (unsigned) I read only I by value
retadr I address_range I longword (unsigned) I write only I by reference
acmode I access__mode I longword (unsigned) I read only I by value
region I longword—unsigned I longword (unsigned) I read only I by value
SYS$FAO ctrstr ,[outlen] ,outbuf ,[pl]...[Pn]
SYS$FAOL ctrstr ,[outlen] ,outbuf [,prmlst]
ctrstr I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
outlen I word—unsigned I word (unsigned) I write only I by reference
outbufi char—string I character-coded text string I write only I by descriptor-fixed length
string descriptor
pi to pn I varying—arg I longword (unsigned) I read only I by value
prmlstlvector—longword—unsigned I longword (unsigned) I read only I by reference
SYS$FILESCAN srcstr ,valuelst ,[fldflags]
srcstr I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
valuelstlitem—list—21 longword (unsigned) I modify I by reference
fldflags I mask—longword I longword (unsigned) I write only I by reference
SYS$FIND-HELD holder ,[id] ,[attrib] ,[contxt]
holderirights—holderiquadword (unsigned) I read only I by reference
id I rights—id I longword (unsigned) I write only I by reference
attrib I mask—longword I longword (unsigned) I write only I by reference
contxt I context I longword (unsigned) I modify I by reference

SYS-10

System Services

SYS$FIND_HOLDER id ,[holder] ,[attrib] ,[contxt]
id I rights_id I longword (unsigned) I read only I by value
holderirights—holderiquadword (unsigned) I write only I by reference
attrib I mask—longword I longword (unsigned) I write only I by reference
contxt I context I longword (unsigned) I modify I by reference
SYS$FINISH-JIDB contxt
contxt I context I longword (unsigned) I modify I by reference
SYS$FORCEX [pidadr] ,[prcnam] ,[code]
pidadr I process—id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
code I cond—value I longword (unsigned) I read only I by value
SYS$FORMAT_-ACL aclent ,[acllen] ,aclstr ,[width] ,[trmdsc] ,[indent] ,[accnam]
aclent I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
acllen I word—unsigned I word (unsigned) I write only I by reference
aclstr I char—string I character-coded text string I write only I by descriptor-fixed length
string descriptor
width I word—unsigned I word (unsigned) I read only I by reference
trmdsc I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
indentiword—unsigned I word (unsigned) I read only I by reference
accnamlaccess—bit—names I longword (unsigned) I read only I by reference
SYS$GETDVI [efn] ,[chan] ,[devnam] ,itmlst [,iosb] [,astadr] [,astpnn] [,nullarg]
efn I ef—number I longword (unsigned) I read only I by value
chan I channel I word (unsigned) I read only I by value
devnam I device—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
itmlstlitem—list—31 longword (unsigned) I read only I by reference
iosb I io—status—block I quad word (unsigned) I write only I by reference
astadr last—procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user—arg I longword (unsigned) I read only I by value
nullarginull—argiquadword (unsigned) I read only I by reference

System Services

SYS-11

SYS$GETDVIW [efn] ,[chan] ,[devnam] ,itmlst [,iosb] [,astadr] [,astprm] [,nullarg]
SYS$GETJPI [efn] ,[pidadr] ,[prcnam] ,itmlst [,iosb] [,astadr] [,astprm]
efnlef_numberllongword (unsigned) I read only I by value
pidadriprocess—idllongword (unsigned) I modify I by reference
prcnam I process_name I character-coded text string I read only I by descriptor-fixed length
string descriptor
itmlstlitem_list_3llongword (unsigned) I read only I by reference
iosb I io_status_block I quadword (unsigned) I write only I by reference
astadr last-procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user_arg I longword (unsigned) I read only I by value
SYS$GETJPIW [efn] ,[pidadr] ,[prcnam] ,itmlst [,iosb] [,astadr] [,astprm]
SYS$GETLKI [efn] ,lkidadr ,itmlst [,iosb] [,astadr] [,astprm] [,nullarg]
efn I ef—number I longword (unsigned) I read only I by value
Ikidadr I lock —id I longword (unsigned) I modify I by reference
itmlstlitem—list—31 longword (unsigned) I read only I by reference
iosb I io—status—block I quad word (unsigned) I write only I by reference
astadr last—procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user-arg I longword (unsigned) I read only I by value
nullarg I null—arg I longword (unsigned) I read only I by value
SYS$GETLKIW [efn] ,lkidadr ,itmlst [,iosb] [,astadr] [,astprm] [,nullarg]
SYS$GETMSG msgid ,msglen ,bufadr ,[flags] ,[outadr]
msgid I cond—value I longword (unsigned) I read only I by value
msglen I word—unsigned I word (unsigned) I write only I by reference
bufadr I char—string I character-coded text string I write only I by descriptor-fixed length
string descriptor
flags I mask—longword I longword (unsigned) I read only I by value
outadr I vector—byte—unsigned I byte (unsigned) I write only I by reference
SYS$GETQUI [efn] ,func [,nullarg] [,itmlst] [,iosb] [,astadr] [,astprm]
efn I ef—number I longword (unsigned) I read only I by value
fund function—code I longword (unsigned) I read only I by value
nullarg I null—arg I longword (unsigned) I read only I by value
itmlstlitem—list—31 longword (unsigned) I read only I by reference
iosb I io—status—block I quadword (unsigned) I write only I by reference

SYS-12

System Services

astadr I ast_procedure I procedure entry mask I call without stack unwinding I by reference
astprmiuser—parmllongword (unsigned) I read only I by value

SYS$GETQUIW [efn] ,func [,nullarg] [,itmlst] [,iosb] [,astadr] [,astprm]
SYS$GETSYI [efn] ,[csidadr] ,[nodename] ,itmlst [,iosb] [,astadr] [,astprm]
efnlef_numberllongword (unsigned) I read only I by value
csidadri process—idllongword (unsigned) I modify I by reference
nodename I process__name I character-coded text string I read only I by descriptor-fixed
length string descriptor
itmlstlitem_list_3llongword (unsigned) I read only I by reference
iosbiio—status—blocklquadword (unsigned) I write only I by reference
astadr last—procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user—arg I longword (unsigned) I read only I by value

SYS$GETSYIW [efn] ,[csidadr] ,[nodename] ,itmlst [,iosb] [,astadr] [,astprm]
SYS$GETTIM timadr
timadridate—timelquadword (unsigned) I write only I by reference

SYS$GETUAI [nullarg] ,[nullarg] ,usmam ,itmlst ,[nullarg] ,[nullarg] ,[nullarg]
nullarg I null—arg I longword (unsigned) I read only I by value
usrnam I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
itmlstlitem—list—31 longword (unsigned) I read only I by reference

SYS$GRANTID [pidadr] ,[prcnam] ,[id] ,[name] ,[prvatr]
pidadr I process—id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
id I rights—holder I quadword (unsigned) I modify I by reference
name I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
prvatr I mask—longword I longword (unsigned) I write only I by reference

SYS$HIBER

System Services

sys-13

SYS$IDTOASC id ,[namlen] ,[nambuf] ,[resid] ,[attrib] ,[contxt]
id I rights_id I longword (unsigned) I read only I by value
namlen I word—unsigned I word (unsigned) I write only I by reference
nambuf I char_string I character-coded text string I write only I by descriptor-fixed length
string descriptor
resid I rights_id I longword (unsigned) I write only I by reference
attrib I mask—longword I longword (unsigned) I write only I by reference
contxt I context I longword (unsigned) I modify I by reference

SYS$LCKPAG inadr ,[retadr] ,[acmode]
inadr I address—range I longword (unsigned) I read only I by reference
retadr I address—range I longword (unsigned) I write only I by reference-array reference or
descriptor
acmode I access—mode I longword (unsigned) I read only I by value

SYS$LKWSET inadr ,[retadr] ,[acmode]
inadr I address—range I longword (unsigned) I read only I by reference
retadr I address—range I longword (unsigned) I write only I by reference
acmode I access—mode I longword (unsigned) I read only I by value

SYS$MGBLSC inadr ,[retadr] ,[acmode] ,[flags] ,gsdnam ,[ident] ,[relpag]
inadr I address—range I longword (unsigned) I read only I by reference
retadr I address—range I longword (unsigned) I write only I by reference
acmode I access—mode I longword (unsigned) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
gsdnam I section—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
ident I section—id I quad word (unsigned) I read only I by reference
relpag I longword—unsigned I longword (unsigned) I read only I by value

SYS$MOD_HOLDER id ,holder ,[set_attrib] ,[clr_attrib]
id I rights—id I longword (unsigned) I read only I by value
holder I rights—holder I quad word (unsigned) I read only I by reference
set—attrib I mask—longword I longword (unsigned) I read only I by value
clr—attrib I mask—longword I longword (unsigned) I read only I by value

SYS-14

System Services

SYS$MOD_IDENT id ,[set_attrib] ,[clr_attrib] ,[new_name] ,[new_value]
id I rights_id I longword (unsigned) I read only I by value
set_attriblmask_longwordllongword (unsigned) I read only I by value
clr_attrib I mask—longword I longword (unsigned) I read only I by value
new—name I char—string I character-coded text string I read only I by descriptor-fixed
length string descriptor
new—value I rights—id I longword (unsigned) I read only I by value

SYSSMOUNT itmlst
itmlstlitem—list—31 longword (unsigned) I read only I by reference

SYS$MTACCESS Iblnam ,[uic] ,[st<i—version] ,[access_char] ,[access_spec] ,type
Iblnam I address I longword (unsigned) I read only I by reference
uic I uic I longword (unsigned) I read only I by value
std—version I longword—unsigned I longword (unsigned) I read only I by value
access—char I longword—unsigned I longword (unsigned) I read only I by value
access—spec I longword—unsigned I longword (unsigned) I read only I by value
type I longword—unsigned I longword (unsigned) I read only I by value

SYS$NUMTIM timbuf ,[timadr]
timbuf I vector—word—unsigned I word (unsigned) I write only I by reference
timadr I date—time I quad word (unsigned) I read only I by reference

SYS$PARSE—ACL aclstr ,aclent ,[errpos] ,[accnam]
aclstr I char—string I character-coded text string I read only I by descriptor-fixed length
string descriptor
aclent I char—string I character-coded text string I write only I by descriptor-fixed length
string descriptor
errpos I word—unsigned I word (unsigned) I write only I by reference
accnamlaccess—bit—names I longword (unsigned) I read only I by reference

SYS$PURGWS inadr
inadr I address—range I longword (unsigned) I read only I by reference

System Services

SYS-15

SYS$PUTMSG msgvec ,[actrtn] ,[facnam] ,[actprm]
msgvec I cntrlblk I longword (unsigned) I read only I by reference
actrtn I procedure I procedure entry mask I call without stack unwinding I by reference
facnam I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
actprm I user_arg I longword (unsigned) I read only I by value

SYS$QIO [efn] ,chan ,func [,iosb] [,astadr] [,astprm] [,pl] [,p2] [,p3] [,p4] [,p5] [,p6]
efn I ef_number I longword (unsigned) I read only I by value
chan I channel I word (unsigned) I read only I by value
fund function—code I longword (unsigned) I read only I by value
iosb I io—status—block I quadword (unsigned) I write only I by reference
astadr last—procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user—arg I longword (unsigned) I read only I by value
pi to p61 varying—arg I longword (unsigned) I read only I by reference

SYS$QIOW [efn] ,chan ,func [,iosb] [,astadr] [,astprm] [,pl] [,p2] [,p3] [,p4] [,p5] [,p6]
SYS$READEF efn ,state
efn I ef—number I longword (unsigned) I read only I by value
state I mask—longword I longword (unsigned) I write only I by reference

SYS$REM_HOLDER id ,holder
id I rights—id I longword (unsigned) I read only I by value
holder I rights—holder I quadword (unsigned) I read only I by reference

SYS$REM_IDENT id
id I rights—id I longword (unsigned) I read only I by value

SYS$RESUME [pidadr] ,[prcnam]
pidadr I process—id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor

SYS$REVOKID [pidadr] ,[prcnam] ,[id] ,[name] ,[prvatr]
pidadr I process—id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
id I rights—id I quadword (unsigned) I modify I by reference

SYS-16

System Services

name I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
prvatrlmask—longwordllongword (unsigned) I write only I by reference
SYS$RMSRUNDWN buf-addr, type-value
buf-addr I char_string I character-coded text string I write only I by descriptor
type-valuelbyte_unsignedlbyte (unsigned) I read only I by value
SYS$SCHDWK [pidadr] ,[prcnam] ,daytim ,[reptim]
pidadr I process_id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
day tim I date-time I quadword (unsigned) I read only I by reference
reptim I date-time I quadword (unsigned) I read only I by reference
SYS$SETAST enbflg
enbflg I boolean I byte (unsigned) I read only I by value
SYS$SETDDIR [new-dir-addr] [,length-addr] [,cur-dir-addr]
new-dir-addr I char—string I character-coded text string I read only I by descriptor-fixed
length string descriptor
length-addr I word—unsigned I word (unsigned) I write only I by reference
cur-dir-addr I char—string I character-coded text string I write only I by descriptor-fixed
length string descriptor
SYS$SETDFPROT [new-def-prot-addr,] [cur-def-prot-addr]
new-def-prot-addr I file—protection I word (unsigned) I read only I by reference
cur-def-prot-addr I file—protection I word (unsigned) I write only I by reference
SYS$SETEF efn
efn I ef—number I longword (unsigned) I read only I by value
SYS$SETEXV [vector] ,[addres] ,[acmode] ,[prvhnd]
vector I longword—unsigned I longword (unsigned) I read only I by value
addres I procedure I procedure entry mask I call without stack unwinding I by reference
acmode I access—mode I longword (unsigned) I read only I by value
prvhnd I procedure I longword (unsigned) I write only I by reference

System Services

sys-17

SYSSSETIME [timadr]
timadrldate—timelquadword (unsigned) I read only I by reference
SYS$SETIMR [efn] ,daytim ,[astadr] ,[reqidt]
efnlef—numberllongword (unsigned) I read only I by value
day tim I date_time I quad word (unsigned) I read only I by reference
astadr I ast_procedure I procedure entry mask I call without stack unwinding I by reference
reqidtluser_argllongword (unsigned) I read only I by value
SYS$SETPRA astadr ,[acmode]
astadr I ast_procedure I procedure entry mask I call without stack unwinding I by reference
acmode I access_mode I longword (unsigned) I read only I by value
SYS$SETPRI [pidadr] ,[prcnam] ,pri ,[prvpri]
pidadr I process_id I longword (unsigned) I modify I by reference
prcnam I process_name I character-coded text string I read only I by descriptor-fixed length
string descriptor
pri I longword—unsigned I longword (unsigned) I read only I by value
prvpri I longword—unsigned I longword (unsigned) I write only I by reference
SYS$SETPRN [prcnam]
prcnam I process_name I character-coded text string I read only I by descriptor-fixed length
string descriptor
SYS$SETPRT inadr ,[retadr] ,[acmode] ,prot ,[prvprt]
inadr I address_range I longword (unsigned) I read only I by reference
retadr I address__range I longword (unsigned) I write only I by reference-array reference or
descriptor
acmode I access_mode I longword (unsigned) I read only I by value
prot I page-protection I longword (unsigned) I read only I by value
prvprt I page-protection I byte (unsigned) I write only I by reference
SYS$SETPRV [enbflg] ,[prvadr] ,[prmflg] ,[prvprv]
enbflg I boolean I byte (unsigned) I read only I by value
prvadr I mask —privileges I quad word (unsigned) I read only I by reference
prmflg I boolean I byte (unsigned) I read only I by value
prvprv I mask—privileges I quad word (unsigned) I write only I by reference

SYS-18

System Services

SYS$SETRWM [watflg]
watflgllongword—unsignedllongword (unsigned) I read only I by value

SYS$SETSFM [enbflg]
enbflg I boolean I byte (unsigned) I read only I by value

SYS$SETSSF [mask]
maskimask—longwordllongword (unsigned) I read only I by value

SYS$SETSTK inadr ,[retadr] ,[acmode]
inadrladdress—rangellongword (unsigned) I read only I by reference
retadrladdress—rangellongword (unsigned) I write only I by reference
acmode I access_mode I longword (unsigned) I read only I by value

SYS$SETSWM [swpflg]
swpflg I longword—unsigned I longword (unsigned) I read only I by value

SYS$SETUAI [nullarg] ,[nullarg] ,usrnam ,itmlst ,[nullarg] ,[nullarg]
nullarg I null _arg I longword (unsigned) I read only I by value
usrnam I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
itmlst I item—list _31 longword (unsigned) I read only I by reference

SYS$SNDERR msgbuf
msgbuf I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor

SYS$SNDJBC [efn] ,func [,nullarg] [,itmlst] [,iosb] [,astadr] [,astprm]
efn I ef_number I longword (unsigned) I read only I by value
fund function—code I longword (unsigned) I read only I by value
nullarg I null _arg I longword (unsigned) I read only I by value
itmlst I item_list_31 longword (unsigned) I read only I by reference
iosbiio—status—blocklquadword (unsigned) I write only I by reference
astadr last—procedure I procedure entry mask I call without stack unwinding I by reference
astprm I user—arg I longword (unsigned) I read only I by value

SYS$SNDJBCW [efn] ,func [,nullarg] [,itmlst] [,iosb] [,astadr] [,astprm]

System Services

SYS-19

SYS$SNDOPR msgbuf ,[chan]
msgbuf I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
chan I channel I word (unsigned) I read only I by value
SYS$SUSPND [pidadr] ,[prcnam]
pidadriprocess—idllongword (unsigned) I modify I by reference
prcnam I process_name I character-coded text string I read only I by descriptor-fixed length
string descriptor
SYSSSYNCH [efn] ,[iosb]
efnlef_numberllongword (unsigned) I read only I by value
iosb I io_status_block I quadword (unsigned) I write only I by reference
SYS$TRNLNM [attr] ,tabnam ,lognam ,[acmode] ,[itmlst]
attrlmask—longwordllongword (unsigned) I read only I by reference
tabnam I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
lognam I logical—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
acmode I access—mode I byte (unsigned) I read only I by reference
itmlstlitem—list—3llongword (unsigned) I read only I by reference
SYS$ULKPAG inadr ,[retadr] ,[acmode]
inadr I address—range I longword (unsigned) I read only I by reference
retadriaddress—rangellongword (unsigned) I write only I by reference-array reference or
descriptor
acmode I access—mode I longword (unsigned) I read only I by value
SYS$ULWSET inadr ,[retadr] ,[acmode]
inadr I address—rangellongword (unsigned) I read only I by reference-array reference or
descriptor
retadriaddress—rangellongword (unsigned) I write only I by reference-array reference or
descriptor
acmode I access—mode I longword (unsigned) I read only I by value
SYS$UNWIND [depadr] ,[newpc]
depadr I longword—unsigned I longword (unsigned) I read only I by reference
newpc I address I longword (unsigned) I read only I by reference

SYS-20

System Services

SYS$UPDSEC inadr ,[retadr] ,[acmode] ,[updflg] ,[efn] ,[iosb] ,[astadr] ,[astprm]
inadrladdress—rangellongword (unsigned) I read only I by reference-array reference or
descriptor
retadrladdress—rangellongword (unsigned) I write only I by reference-array reference or
descriptor
acmode I access_mode I longword (unsigned) I read only I by value
updflgllongword—unsignedllongword (unsigned) I read only I by value
efn I ef_number I longword (unsigned) I read only I by value
iosbiio—status—blocklquadword (unsigned) I write only I by reference
astadr last—procedure I procedure entry mask I call without stack unwinding I by
reference-procedure reference or descriptor
astprm I user_arg I longword (unsigned) I read only I by value
SYS$UPDSECW inadr [,retadr] [,acmode] [,updflg] [,efn] [,iosb] [,astadr] [,astprm]
SYSSWAITFR efn
efn I ef_number I longword (unsigned) I read only I by value
SYS$WAKE [pidadr] ,[prcnam]
pidadr I process—id I longword (unsigned) I modify I by reference
prcnam I process—name I character-coded text string I read only I by descriptor-fixed length
string descriptor
SYS$WFLAND efn ,mask
efn I ef—number I longword (unsigned) I read only I by value
mask I mask—longword I longword (unsigned) I read only I by value
SYS$WFLOR efn ,mask
efn I ef—number I longword (unsigned) I read only I by value
mask I mask—longword I longword (unsigned) I read only I by value

Run-Time Library Routines
DTK$ANSWER_JPHONE voice-id [,num-rings] [,text]
voice-id I identifier I longword (unsigned) I read only I by reference
num-rings I longw^ord—signed I longword (signed) I read only I by reference
text I char_string I character string I read only I by descriptor

DTK$DIAL—PHONE voice-id ,phone-num [,mode] [,text] [,timeout]
voice-id I identifier I longword (unsigned) I read only I by reference
phone-num I char_string I character string I read only I by descriptor
mode I mask—longword I longword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor
timeout I longword—signed I longword (signed) I read only I by reference

DTK$HANGUP-PHONE voice-id [,text]
voice-id I identifier I longword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor

DTK$INITIALIZE new-voice-id ,out-device [,device-type]
new-voice-id I identifier I longword (unsigned)! write only I by reference
out-device I device—name I character string I read only I by descriptor
device-type llongword—signed llongword (signed) I write only I by reference

DTK$LOAD—DICTIONARY voice-id ,text ,substitution
voice-id I identifier llongword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor
substitution I char—string I character string I read only I by descriptor

RTL-2

Run-Time Library Routines

DTK$READ_KEYSTROKE voice-id ,key-code [^prompt] [,timeout]
voice-id I identifier I longword (unsigned) I read only I by reference
key-code I longword—signedllongword (signed) I write only I by reference
prompt I char_string I character string I read only I by descriptor
timeout I longword—signed I longword (signed) I read only I by reference

DTK$READ_STRING voice-id ,out-string [,prompt] [,timeout] [,term-code]
voice-id I identifier I longword (unsigned) I read only I by reference
out-string I char_string I character string I write only I by descriptor
prompt I char_string I character string I read only I by descriptor
timeout I longword—signed I longword (signed) I read only I by reference
term-code I longword—signed I longword (signed) I write only I by reference

DTK$RETURN_-LAST_INDEX voice-id ,p-index
voice-id I identifier I longword (unsigned) I read only I by reference
p-index I longword—signed I longword (signed) I write only I by reference

DTK$SET_INDEX voice-id ,p-index
voice-id I identifier I longword (unsigned) I read only I by reference
p-index I longword—signed I longword (signed) I read only I by reference

DTK$SET-_KEYPAD_MODE voice-id ,mode
voice-id I identifier I longword (unsigned) I read only I by reference
mode I mask—longword I longword (unsigned) I read only I by reference

DTK$SEX_LOGGING_MODE voice-id [,new-mode] [,old-mode]
voice-id I identifier I longword (unsigned) I read only I by reference
new-mode I mask—longword I longword (unsigned) I read only I by reference
old-mode I mask—longword I longword (unsigned)! write only I by reference

DTK$SET—MODE voice-id [,new-mode] [,old-mode]
voice-id I identifier llongword (unsigned) I read only I by reference
new-mode I mask—longword llongword (unsigned) I read only I by reference
old-mode I mask —longword I longword (unsigned) I write only I by reference

DTK$SET—SPEECH_-MODE voice-id ,new-mode [,old-mode]
voice-id I identifier llongword (unsigned) I read only I by reference
new-mode I mask—longword llongword (unsigned) I read only I by reference
old-mode I mask—longword I longword (unsigned)! write only I by reference

Run-Time Library Routines

rtl-3

DTK$SET_TERMINAL_MODE voice-id [,new-mode] [,old-mode]
voice-id I identifier I longword (unsigned) I read only I by reference
new-mode I mask_longword I longword (unsigned) I read only I by reference
old-mode I mask—longword I longword (unsigned)! write only I by reference

DTK$SET_VOICE voice-id [,new-voice] [,speech-rate]
[,comma-pause] [,period-pause]
voice-id I identifier ilongword (unsigned) I read only I by reference
new-voicellongword_signedllongword (signed) I read only I by reference
speech-rate llongword—signed Ilongword (signed) I read only I by reference
comma-pause llongword—unsigned Ilongword (unsigned) I read only I by reference
period-pause I longword—unsigned I longword (unsigned) I read only I by reference

DTK$SPEAK_JFILE voice-id ,filespec [,mode]
voice-id I identifier I longword (unsigned) I read only I by reference
filespec I char_string I character string I read only I by descriptor
mode I mask—longword I longword (unsigned) I read only I by reference

DTK$SPEAK_PHONEMIC_TEXT voice-id ,text [,mode]
voice-id I identifier I longword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor
mode I mask—longword I longword (unsigned) I read only I by reference

DTK$SPEAK_TEXT voice-id ,text [,mode]
voice-id I identifier I longword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor
mode I mask—longword I longword (unsigned) I read only I by reference

DTK$TERMINATE voice-id
voice-id I identifier I longword (unsigned) I read only I by reference

LIB$ADDX a ,b ,result [,len]
a I longword—signed I longword integer (signed) I read only I by reference, array reference
b I longword—signed I longword integer (signed) I read only I by reference, array reference
result I longword—signed I longword integer (signed) I write only I by reference, array
reference
len I longword—signed I longword integer (signed) I read only I by reference

RTL-4

Run-Time Library Routines

LIB$ANALYZE_SDESC inp-dsc ,len ,data-adr
JSB entry: LIB$ANALYZE_SDESC_R2
inp-dsc I char_string I character string I read only I by descriptor
lenlword—unsignedlword (unsigned) I write only I by reference
data-adrllongword_unsignedllongword (unsigned) I write only I by reference
LIB$ASN—WTH^MBX dev-nam ,max-msg ,buf-quo ,dev-chn ,mbx-chn
dev-nam I device_name I character string I read only I by descriptor
max-msgllongword_signedllongword integer (signed) I read only I by reference
buf-quo I longword—signed I longword integer (signed) I read only I by reference
dev-chn I word—signed I word integer (signed) I write only I by reference
mbx-chn I channel I word integer (signed) I write only I by reference
LIB$AST_IN__PROG
LIB$ATTACH process-id
process-id I process_id I longword integer (unsigned) I read only I by reference
LIB$BBCCI position ,base
position I longword—signed I longword integer (signed) I read only I by reference
base I address I unspecified I read only I by reference
LIB$BBSSI position ,base
position I longword—signed I longword integer (signed) I read only I by reference
base I address I unspecified I read only I by reference
LIB$CALLG arglist ,procedure
arglist I arg_list I longword (unsigned) I read only I by reference, array reference
procedure I procedure I procedure entry mask I function call (before return) I by
reference,procedure reference
LIB$CHAR one-char-str ,ascii-code
one-char-str I char_string I character string I write only I by descriptor
ascii-code I byte_unsignedl byte (unsigned) I read only I by reference

LIB$CRC table ,inicrc ,stream
table I longword—signed I longword integer (signed) I read only I by reference
inicrc I longword—signed I longword integer (signed) I read only I by reference
stream I char_string I character string I read only I by descriptor

Run-Time Library Routines

rtl-5

LIB$CRC_TABLE poly ,table
polylmask—longwordllongword (unsigned) I read only I by reference
tablellongword—signedllongword integer (signed) I write only I by reference, array
reference
LIB$CREATE_DIR dev-dir-spec [,owner-UIC] [,prot-enable] [,prot-value]
[,max-versions] [,rvn]
dev-dir-spec I device_name I character string I read only I by descriptor
owner-UICluicIlongword (unsigned) I read only I by reference
prot-enablelmask_wordlword (unsigned) I read only I by reference
prot-value I file-protection I word (unsigned) I read only I by reference
max-versionsiword—unsignediword (unsigned) I read only I by reference
rvn I word—unsigned I word (unsigned) I read only I by reference
LIB$CREATE«>USER_VM—ZONE zone-id [,user-arg] [,user-get-rtn] [,user-free-rtn]
[,user-reset-rtn] [,user-delete-rtn]
zone-idllongword—unsignedllongword (unsigned)! write only I by reference
user-argluser_argllongword (unsigned) I read only I by reference
user-get-rtn I procedure I procedure entry mask I function call (before return) I by reference,
procedure reference
user-free-rtn I procedure I procedure entry mask I function call (before return) I by
reference, procedure reference
user-reset-rtn I procedure I procedure entry mask I function call (before return) I by
reference, procedure reference
user-delete-rtn I procedure I procedure entry mask I function call (before return) I by
reference, procedure reference
LIB$CREATE^VM—ZONE zone-id [,algorithm] [,algorithm-arg] [,flags] [,extend-size]
[,initial-size] [,block-size] [,alignment] [,page-limit] [,pl]
zone-id llongword_unsigned I longword (unsigned)! write only! by reference
algorithm!longword_signed!longword integer (signed)!read only!by reference
algorithm-arg!longword_signed!longword integer (signed)!read only!by reference
flags!longword_signed!longword integer (signed)!read only!by reference
extend-size!longword_signed!longword integer (signed)!read only!by reference
initial-size!longword—signed!longword integer (signed)!read only!by reference
block-size!longword signed!longword integer (signed)!read only!by reference

RTL-6

Run-Time Library Routines

alignment I longword—signed I longword integer (signed) I read only I by reference
page-limit I longword—signed I longword integer (signed) I read only I by reference
pi llongword—signedllongword integer (signed) I read only I by reference
LIB$CRF_INS_KEY ctl-tbl ,keyl ,vall ,flags
ctl-tbl I longword—signed I longword integer (signed) I read only I by reference, array
reference
key II char_string I character string I read only I by descriptor
vail I longword—signed I longword integer (signed) I read only I by reference
flags I mask—longword I longword (unsigned) I read only I by reference
LIB$CRF-INS_REF ctl-tbl ,keyl ,ref2 ,refl ,ref-def
ctl-tbl I vector—longword—signed I longword integer (signed) I read only I by reference,
array reference
key 11 longword—signed I longword integer (signed) I read only I by reference
ref21 char_string I character string I read only I by descriptor
ref 11 longword—signed Hong word integer (signed) I write only I by reference
ref-def I longword—signed I longword integer (signed) I read only I by reference
LIB$CRF_OUTPUT ctl-tbl ,width ,pagl ,pag2 ,mode-ind ,del-sav-ind
ctl-tbllvector—longword—signed I longword integer (signed) I read only I by reference,
array reference
width I longword—signed I longword integer (signed) I read only I by reference
pagl I longword—signed I longword integer (signed) I read only I by reference
pag21 longword—signed I longword integer (signed) I read only I by reference
mode-ind I longword—signed I longword integer (signed) I read only I by reference
del-sav-ind I longword—signed I longword integer (signed) I read only I by reference
LIB$CURRENCY currency-str [,out-len]
currency-str I char—string I character string I write only I by descriptor
out-leniword_unsigned I word (unsigned) I write only I by reference
LIB$CVT-DX_DX src ,dst [,dst-len]
src I address I unspecified I read only I by descriptor
dst I address I unspecified I write only I by descriptor
dst-leni word—unsigned I word (unsigned) I write only I by reference
LIB$CVT—DTB count ,string ,result
LIB$CVT__HTB count ,string ,result

Run-Time Library Routines

rtl-7

LIB$CVT_OTB count ,string ,result
count I longword—signed I longword integer (signed) I read only I by value
string I char_string I character string I read only I by reference
result I longword—signed I longword integer (signed) I write only I by reference
LIB$D ATE-TIME dst-str
dst-str I date_time I character string I write only I by descriptor
LIB$DAY day-number [,user-time] [,day-time]
day-number I longword—signed I longword integer (signed) I write only I by reference
user-timeldate_timelquadword integer (signed) I read only I by reference
day-time I longword—signed I longword integer (signed) I write only I by reference
LIB$DAY-OF_WEEK time ,day-num
timeldate_timelquadword (unsigned) I read only I by reference
day-num I longword—unsigned I longword (unsigned) I write only I by reference
LIB$DECODE_FAULT signal-args ,mechanism-args ,user-action [,user-arg]
[instruction-definitions]
signal-args I vector_longword_unsigned I longword (unsigned) I read only I by reference,
array reference
mechanism-args I vector_longword_unsigned I longword (unsigned) I read only I by
reference, array reference
user-action I procedure I bound procedure value or procedure entry mask I call after stack
unwind I by descriptor, procedure
user-arg I user_arg I unspecified I read only I by value
instruction-definitions I vector_byte_unsigned I byte (unsigned) I read only I by reference,
array reference
LIB$DEC—OVER new-setting
new-setting I byte_unsigned I byte (unsigned) I read only I by reference
LIB$DELETE_FILE filespec [,default-filespec] [,related-filespec] [,success-routine]
[,error-routine] [,confirm-routine] [,user-arg] [,resultant-name] [,file-scan-context]
filespec I char_string I character string I read only I by descriptor
default-filespec I char_string I character string I read only I by descriptor
related-filespec I char_string I character string I read only I by descriptor
success-routine I procedure I procedure entry mask I function call (before return) I by
reference

RTL-8

Run-Time Library Routines

error-routine I procedure I procedure entry mask I function call (before return) I by
reference
confirm-routine I procedure I procedure entry mask I function call (before return) I by
reference
user-arg I user_arg I unspecified I read only I unspecified
resultant-name I char_string I character string I write only I by descriptor
file-scan-context I context I longword (unsigned) I modify I by reference
LIB$DELETE-LOGICAL log-nam [,table-desc]
log-nam I logical—name I character string I read only I by descriptor
table-desc I char_string I character string I read only I by descriptor
LIB$DELETE-SYMBOL symbol [,tbl-ind]
symbol I char_string I character string I read only I by descriptor
tbl-ind I longword—signed I longword integer (signed) I read only I by reference
LIB$DELETE-VM-ZONE zone-id
zone-id I longword—unsigned I longword (unsigned) I read only I by reference
LIB$DIGIT—SEP digit-sep-str [,out-len]
digit-sep-str I char—string I character string I write only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference
LIB$DIS ABLE-CTRL disable-msk [,old-msk]
disable-msk I mask—longword I longword (unsigned) I read only I by reference
old-msk I mask—longword I longword (unsigned) I write only I by reference
LIB$DO-COMMAND cmd-text
cmd-text I char—string I character string I read only I by descriptor
LIB$EDIV divisor ,dividend ,quotient ,remainder
divisor 1 longword—signed I longword integer (signed) I read only I by reference
dividend I quadword—signed I quadword integer (signed) I read only I by reference
quotient I longword—signed I longword integer (signed) I write only I by reference
remainder I longword_signed I longword integer (signed) I write only I by reference

Run-Time Library Routines

rtl-9

LIB$EMODF multiplier ,mult-ext ,multiplicand ,mt ,fract
LIB$EMODD multiplier ,mult-ext ,multiplicand ,int ,fract
LIB$EMODG multiplier ,mult-ext ,multiplicand ,int ,fract
LIB$EMODH multiplier ,mult-ext ,multiplicand ,int ,fract
multiplier I floating-point ID-floating, F—floating, G—floating, H—floating I read only I by
reference
mult-ext I byte—signed, word—unsigned I byte integer (signed), word (unsigned) I read
only I by reference
multiplicand I floating—point ID—floating, F—floating, G—floating, H—floating I read only I
by reference
intllongword_signed I longword integer (signed) I write only I by reference
fractifloating—point ID—floating, F—floating, G—floating, H—floating I write only I by
reference
LIB$EMUL multiplier ,multiplicand ,addend ,product
multiplier I longword—signed I longword integer (signed) I read only I by reference
multiplicand I longword—signed I longword integer (signed) I read only I by reference
addend I longword—signed I longword integer (signed) I read only I by reference
product I quadword—signed I quadword integer (signed) I write only I by reference
LIB$EN ABLE-CTRL enable-msk [,old-msk]
enable-msk I mask—longword I longword (unsigned) I read only I by reference
old-msk I mask—longword I longword (unsigned) I write only I by reference
LIB$ESTABLISH new-handier
new-handier I procedure I procedure entry mask I read only I by reference
LIB$EXTV pos ,size ,base
pos I longword—signed I longword integer (signed) I read only I by reference
size I byte—unsigned I byte (unsigned) I read only I by reference, array reference
base I longword—unsigned I longword (unsigned) I read only I by value
LIB$EXTZV pos ,size ,base
pos I longword—signed I longword (signed) I read only I by reference
size I by te—unsigned I by te (unsigned) I read only I by reference
base I longword—unsigned I longword (unsigned) I read only I by value
LIB$FFC start-pos ,size ,base ,find-pos

RTL-10

Run-Time Library Routines

LIB$FFS start-pos ,size ,base ,find-pos
start-posllongword_signed I longword integer (signed) I read only I by reference
size I byte_unsigned I byte (unsigned) I read only I by reference
base I longword—unsigned I longword (unsigned) I read only I by reference
find-pos I longword_signed I longword integer (signed) I write only I by reference
LIB$FILE_SCAN fab ,success-rtn ,error-rtn [,context]
fab I fab I unspecified I read only I by reference
success-rtn I procedure I procedure entry mask I function call (before return) I by reference,
procedure reference
error-rtn I procedure I procedure entry mask I function call (before return) I by reference,
procedure reference
context I context I longword (unsigned) I modify I by reference
LIB$FILE_SCAN__END fab [,context]
fab I fab I unspecified I modify I by reference
context I context I longword (unsigned) I modify I by reference
LIB$FIND_FILE file-spec ,result-spec ,context [,default-spec] [,related-spec]
[,stv-addr] [,user-flags]
file-spec I char_string I character string I read only I by descriptor
result-spec I char_string I character string I modify I by descriptor
context I context I longword (unsigned) I modify I by reference
default-spec I char_string I character string I read only I by descriptor
related-spec I char_string I character string I read only I by descriptor
stv-addr I longword—unsigned I longword (unsigned) I write only I by reference
user-flags I mask—longwordl longword (unsigned) I read only I by reference
LIB$FINDJILE_END context
context I context I longword (unsigned) I read only I by reference
LIB$FIND_IMAGE—SYMBOL filename ,symbol-desc ,symbol-val
filename I char_string I character string I read only I by descriptor
symbol-desc I char_string I character string I read only I by descriptor
symbol-val I longword—signed I longword (signed) I write only I by reference

Run-Time Library Routines

rtl-ii

LIB$FIXUP-JFLT sig-args ,mch-args [,new-operand]
sig-args I vector_longword_unsigned I longword (unsigned) I read only I by reference,
array reference
mch-args I vector_longword_unsigned I longword (unsigned) I read only I by reference,
array reference
new-operand I floating-point I F_floating I read only I by reference
LIB$FLT_UNDER new-setting
new-setting I byte_unsigned I byte (unsigned) I read only I by reference
LIB$FREE_EF event-flag-num
event-flag-num I ef__number I longword integer (signed) I read only I by reference
LIB$FREE—LUN log-unit-num
log-unit-num I longword—signed I longword integer (signed) I read only I by reference
LIB$FREE-.TIMER handle-adr
handle-adr I address I longword (unsigned) I modify I by reference
LIB$FREE_VM num-bytes ,base-adr [,zone-id]
num-bytes I longword—signed I longword integer (signed) I read only I by reference
base-adr I address I longword (unsigned) I read only I by reference
zone-id I longword—unsigned I longword (unsigned) I read only I by reference
LIB$FREE—VM_PAGE num-pages ,base-adr
num-pages I longword—signed I longword integer (signed) I read only I by reference
base-adr I address I longword (unsigned) I read only I by reference
LIB$GET_COMMAND get-str [,prompt-str] [,out-len]
get-str I char_string I character string I write only I by descriptor
prompt-str I char_string I character string I read only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference
LIB$GET_COMMON dst-str [,chars-copied]
dst-str I char_string I character string I write only I by descriptor
chars-copiediword_signed I word integer (signed) I write only I by reference

RTL-12

Run-Time Library Routines

LIB$GETDVI item-code [,channel] [,device-name] [,out-value] [,out-string] [,out-len]
item-code I longword—signed I longword integer (signed) I read only I by reference
channel I channel I word (unsigned) I read only I by reference
device-name I device_name I character string I read only I by descriptor
out-value I longword—unsigned I longword (unsigned) I write only I by reference
out-string I char_string I character string I write only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference
LIB$GET__EF event-flag-num
event-flag-num I ef__number I longword integer (signed) I write only I by reference
LIB$GET-_FOREIGN get-str [,user-prompt] [,out-len] [,force-prompt]
get-str I char_string I character string I write only I by descriptor
user-prompt I char_string I character string I read only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference
force-prompt I longword—signed I longword integer (signed) I modify I by reference
LIB$GET_INPUT get-str [,prompt-str] [,out-len]
get-str I char_string I character string I write only I by descriptor
prompt-str I char_string I character string I read only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference
LIB$GETJPI item-code [,process-id] [,process-name] [,out-value] [,out-string] [,out-len]
item-code I longword—signed I longword integer (signed) I read only I by reference
process-id I process_id I longword (unsigned) I modify I by reference
process-name I process_name I character string I read only I by descriptor
out-value I varying_arg I unspecified I write only I by reference
out-string I char_string I character string I write only I by descriptor
out-len I word_signed I word integer (signed) I write only I by reference
LIB$GET_LUN log-unit-num
log-unit-num I longword—signed I longword integer (signed) I write only I by reference

Run-Time Library Routines

rtl-13

LIB$GETSYI item-code [,out-value] [,out-string] [,out-len] [,csid] [,node-name]
item-code I longword—signed I longword integer (signed) I read only I by reference
out-value I varying_arg I unspecified I write only I by reference
out-string I char_string I character string I write only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference
csid I longword—unsigned I longword (unsigned) I modify I by reference
node-name I char_string I character string I read only I by descriptor
LIB$GET«.SYMBOL symbol ,ret-buf [,ret-len] [,tbl-ind]
symbol I char__string I character string I read only I by descriptor
ret-buf I char_string I character string I write only I by descriptor
ret-leniword—signediword integer (signed) I write only I by reference
tbl-ind I longword—signed I longword integer (signed) I write only I by reference
LIB$GET_VM num-bytes, base-adr [,zone-id]
num-bytes I longword—signed I longword integer (signed) I read only I by reference
base-adr I address I longword (unsigned) I write only I by reference
zone-id I longword—unsigned I longword (unsigned) I read only I by reference
LIB$GET_-VM_-PAGE num-pages ,base-adr
num-pages I longword_signed I longword integer (signed) I read only I by reference
base-adr I address I longword (unsigned) I write only I by reference
LIB$ICHAR src-str
src-str I char_string I character string I read only I by descriptor
LIB$INDEX src-str ,sub-str
src-str I char_string I character string I read only I by descriptor
sub-str I char_string I character string I read only I by descriptor
LIB$INIT_TIMER [handle-adr]
handle-adr I longword—unsigned I longword (unsigned) I modify I by reference

RTL-14

Run-Time Library Routines

LIB$INSERT_TREE treehead ,sym-str ,ctrl-flg ,compare-rtn ,alloc-rtn ,newnode
[,user-data]
treehead I longword—unsigned I longword (unsigned) I modify I by reference
sym-str I char_string I character string I read only I by descriptor
Ctrl-fig I mask—longword I long word (unsigned) I read only I by reference
compare-rtn I procedure I procedure entry mask I function call (before return) I by
reference, procedure reference
alloc-rtn I procedure I procedure entry mask I function call (before return) I by reference,
procedure reference
newnode I longword—unsigned I longword (unsigned) I write only I by reference
user-data I user_arg I unspecified I unspecified I unspecified
LIB$INSQHI entry ,header [,retry-cnt]
entrylquadword—signedlquadword integer (signed) I modify I by reference, array
reference
header I quadword_signed I quadword integer (signed) I modify I by reference
retry-cnt I longword—unsigned I longword (unsigned) I read only I by reference
LIB$INSQTI entry ,header [,retry-cnt]
entrylquadword—signedlquadword integer (signed) I modify I by reference, array
reference
header I quadword—signed I quadword integer (signed) I modify I by reference
retry-cnt I longword—unsigned I longword (unsigned) I read only I by reference
LIB$INSV src ,pos ,size ,base
src I longword_signed I longword integer (signed) I read only I by reference
pos I longword—signed I longword integer (signed) I read only I by reference
size I byte—unsigned I byte (unsigned) I read only I by reference
base I address I aligned bit string I write only I by reference
LIB$INT_-OVER new-setting
new-setting I byte—unsigned I byte (unsigned) I read only I by reference
LIB$LEN src-str
src-str I char—string I character string I read only I by descriptor
LIB$LOCC char-str ,src-str
char-str I char—string I character string I read only I by descriptor
src-str I char—string I character string I read only I by descriptor

Run-Time Library Routines

rtl-15

LIB$LOOKUP_KEY search-str ,key-table [,key-value] [,full-str] [,out-len]
search-str I char_string I character string I read only I by descriptor
key-tablellongword—unsignedllongword (unsigned) I read only I by reference, array
reference
key-valuellongword_unsigned I longword (unsigned) I write only I by reference
full-str I char_string I character string I write only I by descriptor
out-len I word_signed I word integer (signed) I write only I by reference
LIB$LOOKUP_TREE treehead ,sym-str ,compare-rtn ,newnode
treehead I longword—unsigned I longword (unsigned) I read only I by reference
sym-str I char_string I character string I read only I by descriptor
compare-rtn I procedure I procedure entry mask I function call (before return) I by
reference, procedure reference
newnode I longword—unsigned I longword (unsigned) I write only I by reference
LIB$LP-LINES
LIB$MATCHC sub-str ,scr-str
sub-str I char_string I character string I read only I by descriptor
src-str I char_string I character string I read only I by descriptor
LIB$MATCH__COND cond-val ,cond-val-i
cond-val I cond_value I longword (unsigned) I read only I by reference
cond-val-i I cond—value I longword (unsigned) I read only I by reference
LIB$MOVC3 length ,source ,dest
length I word—unsigned I word (unsigned) I read only I by reference
source I address I unspecified I read only I by reference
dest I address I unspecified I write only I by reference
LIB$MOVC5 src-len ,source ,fill ,dst-len ,dest
src-len I word—unsigned I word (unsigned) I read only I by reference
source I address I unspecified I read only I by reference
filllbyte—signedibyte integer (signed) I read only I by reference
dst-len I word—unsigned I word (unsigned) I read only I by reference
dest I varying_arg I unspecified I write only I by reference

RTL-16

Run-Time Library Routines

LIB$MOVTC src-str ,fill-char ,trans-tbl ,dst-str
src-str I char_string I character string I read only I by descriptor
fill-char I char_string I character string I read only I by descriptor
trans-tbl I char_string I character string I read only I by descriptor
dst-str I char_string I character string I write only I by descriptor
LIB$MOVTUC src-str ,stop-char ,trans-tbl ,dst-str [,fill-char]
src-str I char_string I character string I read only I by descriptor
stop-char I char_string I character string I read only I by descriptor
trans-tbl I char_string I character string I read only I by descriptor
dst-str I char_string I character string I write only I by descriptor
fill-char I char_string I character string I read only I by descriptor
LIB$PAUSE
LIB$POLYF arg ,degree ,coeff ,result
LIB$POLYD arg ,degree ,coeff ,result
LIB$POLYG arg ,degree ,coeff ,result
LIB$POLYH arg ,degree ,coeff ,result
Each of the above four formats accepts as input one of the four floating-point types.
arg I floating-point IE-floating, D_floating, G—floating, H—floating I read only I by
reference
degree I word—signed I word integer (signed) I read only I by reference
coeffifloating—point IF—floating, D—floating, G—floating, H—floating I read only I by
reference, array reference
resultifloating—point IF—floating, D—floating, G—floating, H—floating I write only I by
reference
LIB$PUT—COMMON src-str [,chars-copied]
src-str I char—string I character string I read only I by descriptor
chars-copiediword—signed I word integer (signed) I write only I by reference
LIB$PUT_OUTPUT msg-str
msg-str I char—string I character string I read only I by descriptor
LIB$RADIX—POINT radix-point-str [,out-len]
radix-point-str I char—string I character string I write only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference

Run-Time Library Routines

rtl-17

LIB$REMQHI header ,remque-adr [,retry-cnt]
headeriquadword—signedlquadword integer (signed) I modify I by reference
remque-adriaddressllongword (unsigned) I write only I by reference
retry-cnt I longword—unsigned I longword (unsigned) I read only I by reference
LIB$REMQTI header ,remque-adr [,retry-cnt]
headeriquadword—signedlquadword integer (signed) I modify I by reference
remque-adriaddressllongword (unsigned) I write only I by reference
retry-cnt I longword—unsigned I longword (unsigned) I read only I by reference
LIB$RENAME_FILE old-filespec ,new-filespec [,default-filespec] [,related-filespec]
[,flags] [,success-routine] [,error-routine] [,confirm-routine] [,user-arg]
[,old-resultant-name] [,new-resultant-name] [,file-scan-context]
old-filespec I char_string I character string I read only I by descriptor
new-filespec I char_string I character string I read only I by descriptor
default-filespec I char_string I character string I read only I by descriptor
related-filespec I char_string I character string I read only I by descriptor
flags I mask—longword I longword (unsigned) I read only I by reference
success-routine I procedure I procedure entry mask I function call (before return) I by
reference
error-routine I procedure I procedure entry mask I function call (before return) I by
reference
confirm-routine I procedure I procedure entry mask I function call (before return) I by
reference
user-arg I user_arg I unspecified I read only I unspecified
old-resultant-name I char_string I character string I write only I by descriptor
new-resultant-name I char_string I character string I write only I by descriptor
file-scan-context I context I longword (unsigned) I modify I by reference
LIB$RESERVE__EF event-flag-num
event-flag-num I ef_number I longword integer (signed) I read only I by reference
LIB$RESET_VM_JZONE zone-id
zone-id I longword—unsigned I longword (unsigned) I read only I by reference
LIB$REVERT

RTL-18

Run-Time Library Routines

LIB$RUN_PROGRAM pgm-name
pgm-name I char_string I character string I read only I by descriptor
LIB$SCANC src-str ,table-arr ,mask
src-str I char_string I character string I read only I by descriptor
table-arrlbyte_unsignedlbyte (unsigned) I read only I by reference, array reference
mask I by te_unsigned I by te (unsigned) I read only I by reference
LIB$SCOPY_DXDX src-str ,dst-str
JSB entry: LIB$SCOPY_DXDX6
src-str I char_string I character string I read only I by descriptor
dst-str I char_string I character string I write only I by descriptor
LIB$SCOPY-_R_DX src-len ,src-adr ,dst-str
JSB entry: LIB$SCOPY_R_DX6
src-len I word—unsigned I word (unsigned) I read only I by reference
src-adr I char__string I character string I read only I by reference
dst-str I char_string I character string I read only I by descriptor
LIB$SET_LOGICAL log-nam [,value] [,table-desc] [,attributes] [,item-list]
Either the item-list or value argument must be specified. If both item-list and value
are specified, the value argument is ignored.
log-nam I logical—name I character string I read only I by descriptor
value I char_string I character string I read only I by descriptor
table-desc I char_string I character string I read only I by descriptor
attributes I longword—unsigned I longword (unsigned) I read only I by reference
item-list I item—list I longword (unsigned) I read only I by reference, array reference
LIB$SET_SYMBOL symbol ,value [,tbl-ind]
symbol I char—string I character string I read only I by descriptor
value I char—string I character string I read only I by descriptor
tbl-ind I longword—signed I longword integer (signed) I read only I by reference
L1B$SFREE1_DD dsc-adr
JSB entry: LIB$SFREE1_DD6
dsc-adr I quadword—unsigned I quadword (unsigned) I modify I by reference

Run-Time Library Routines

rtl-19

LIB$SFREEN_DD dsc-num ,first-dsc
JSB entry: LIB$SFREEN_DD6
dsc-num I longword—unsigned I longword (unsigned) I read only I by reference
first-dsclvector_quadword_unsignedlquadword (unsigned) I modify I by reference, array
reference

LIB$SGET1_DD length ,string
JSB entry: LIB$SGET1_DD_R6
length I word—unsigned I word (unsigned) I read only I by reference
string I quadword_unsigned I quadword (unsigned) I modify I by reference
LIB$SHOW__TIMER [handle-adr] [,code] [,action-rtn [,user-arg]]
handle-adr I address I longword (unsigned) I read only I by reference
code I longword—signed I longword integer (signed) I read only I by reference
action-rtn I procedure I procedure entry mask I function call (before return) I by reference,
procedure reference
user-arg I user_arg I unspecified I read only I by value
LIB$SHOW_VM [code] [,action-rtn [,user-arg]]
code I longword—signed I longword integer (signed) I read only I by reference
action-rtn I procedure I procedure entry mask I function call (before return) I by reference,
procedure reference
user-arg I user_arg I unspecified I read only I unspecified

LIB$SIGNAL condition-value 1 [,numberl] [,FAO-argl...,FAO-argnl]
[,condition-value2] [,number2] [,FAO-arg2...,FAO-argn2]
Only the condition-valuel argument must be specified; other arguments are
optional. The numberl argument, if specified, contains the number of FAO
arguments that will be associated with condition-valuel. The condition-value2
argument is optional; it may be specified with or without the number2 or FAOarg2 arguments. The number2 argument, if specified, contains the number of
FAO arguments that will be associated with condition-value2. You may specify
condition-value3, condition-value4, condition-valueS, and so on, along with their
corresponding number and FAO arguments.
condition-value I cond_value I longword (unsigned) I read only I by value
number I longword—signed I longword integer (signed) I read only I by value
FAO-arg(s) 1 varying_arg I unspecified I read only I unspecified

RTL-20

Run-Time Library Routines

LIB$SIG_TO_RET sig-args ,mch-args
sig-args I vector_longword_unsigned I longword (unsigned) I read only I by reference,
array reference
mch-args I vector_longword_unsigned I longword (unsigned) I read only I by reference,
array reference
LIB$SIG—TO_STOP sig-args ,mch-args
sig-args I vector_longword_unsigned I longword (unsigned) I modify I by reference, array
reference
mch-args I vector_longword_unsigned I longword (unsigned) I read only I by reference,
array reference
LIB$SIM_TRAP sig-args ,mch-args
sig-args I vector_longword_unsigned I longword (unsigned) I modify I by reference, array
reference
mch-args I vector_Jongword_unsigned I longword (unsigned) I read only I by reference,
array reference
LIB$SKPC char-str ,src-str
char-str I char_string I character string I read only I by descriptor
src-str I char_string I character string I read only I by descriptor
LIB$SPANC src-str ,table-arr ,mask
src-str I char_string I character string I read only I by descriptor
table-arrlvector_byte_unsignedlbyte (unsigned) I read only I by reference, array
reference
masklbyte_unsignedlbyte (unsigned) I read only I by reference
LIB$SPAWN [command-string] [,input-file] [,output-file] [,flags] [,process-name]
[,process-id] [,completion-status] [,completion-efn] [,completion-astadr]
[,completion-astarg] [,prompt] [,cli]
command-string I char_string I character string I read only I by descriptor
input-file I char_string I character string I read only I by descriptor
output-file I char_string I character string I read only I by descriptor
flags I mask—longword I longword (unsigned) I read only I by reference
process-name I char_string I character string I read only I by descriptor
process-id I longword—unsigned I longword (unsigned) I write only I by reference
completion-status I longword—unsigned I longword (unsigned) I write only I by reference

Run-Time Library Routines

rtl-21

completion-efnibyte—unsignedibyte (unsigned) I read only I by reference
completion-astadr I procedure I procedure entry mask I call without stack unwinding I by
reference
completion-astarg I user_arg I unspecified I read only I unspecified
prompt I char_string I character string I read only I by descriptor
cli I char_string I character string I read only I by descriptor
LIB$STAT_TIMER code ,value [,handle-adr]
code I function—code I longword integer (signed) I read only I by reference
value I user_arg I unspecified I write only I by reference
handle-adriaddressllongword (unsigned) I read only I by reference
LIB$STAT_VM code ,value
code I function—code I longword integer (signed) I read only I by reference
value I longword—signed I longword integer (signed) I write only I by reference
LIB$STOP condition-value 1 [,numberl] [,FAO-argl...,FAO-argnl] [,condition-value2]
[,number2] [,FAO-arg2...,FAO-argn2]
Only the condition-valuel argument must be specified; other arguments are
optional. The numberl argument, if specified, contains the number of FAO
arguments that will be associated with condition-valuel. The condition-value2
argument is optional; it may be specified with or without the number2 or FAOarg2 arguments. The number2 argument, if specified, contains the number of
FAO arguments that will be associated with condition-value2. You may specify
condition-value3, condition-value4, condition-valueS, and so on, along with their
corresponding number and FAO arguments.
condition-value I cond—value I longword (unsigned) I read only I by value
number I longword_signed I longword integer (signed) I read only I by value
FAO-arg(s) I varying—arg I unspecified I read only I by value
LIB$SUBX a ,b ,diff [,len]
a I vector—longword_signed I longword integer (signed) I read only I by reference, array
reference
b I vector—longword_signed I longword integer (signed) I read only I by reference, array
reference
diffivector—longword—signed I longword integer (signed) I write only I by reference, array
reference
len I longword_signed I longword integer (signed) I read only I by reference

RTL-22

Run-Time Library Routines

LIB$SYS_ASCTIM [out-len] ,dst-str [,user-time] [,cnv-flg]
out-len I word-signed I word integer (signed) I write only I by reference
dst-str I time_name I character string I write only I by descriptor
user-timeldate_timelquadword integer (signed) I read only I by reference
cnv-flglmask_longwordllongword (unsigned) I read only I by reference
LIB$SYS__FAO ctr-str [,out-len] ,out-buf [,pl,...,pn]
ctr-str I char_string I character string I read only I by descriptor
out-len I word_integer I word integer (signed) I write only I by reference
out-buf I char_string I character string I write only I by descriptor
p 1 —pn I varying_arg I unspecified I read only I unspecified
LIB$SYS_FAOL ctr-str ,[out-len] ,out-buf ,pl - pn
ctr-str I char_string I character string I read only I by descriptor
out-len I word-integer I word integer (signed) I write only I by reference
out-buf I char_string I character string I write only I by descriptor
pi—pn I varying_arg I longword (unsigned) I read only I by reference, array reference
LIB$SYS—GETMSG msg-id ,[msg-len] ,dst-str [,flags] [,out-arr]
msg-id I longword—signed I longword integer (signed) I read only I by reference
msg-leniword_signed I word integer (signed) I write only I by reference
dst-str I char_string I character string I write only I by descriptor
flags I mask—longword I longword (unsigned) I read only I by reference
out-arr I longword—unsigned I longword (unsigned) I write only I by reference, array
reference
LIB$SYS_TRNLOG logical-name ,[dst-len] ,dst-str [,table] [,acc-mode] [,dsb-msk]
logical-name I logical—name I character string I read only I by descriptor
dst-len I word—signed I word integer (signed) I write only I by reference
dst-str I char—string I character string I write only I by descriptor
table I byte—integer I byte integer (signed) I write only I by reference
acc-mode I access—mode I by te integer (signed) I write only I by reference
dsb-msk I byte—unsigned I byte (unsigned) I read only I by reference
LIB$TPARSE arg-blk ,state-tbl ,key-tbl
arg-blk I address I longword (unsigned) I modify I by reference
state-tbl I address I unspecified I read only I by reference
key-tbl I address I unspecified I read only I by reference

Run-Time Library Routines

RTL-23

LIB$TRA_ASC_EBC src-str ,dst-str
src-str I char_string I character string I read only I by descriptor
dst-strlbyte_unsignedlbyte (unsigned) I write only I by descriptor
LIB$TRA_EBC_ASC src-str ,dst-str
src-str I byte_unsigned I byte (unsigned) I read only I by descriptor
dst-str I char_string I character string I write only I by descriptor
LIB$TR A VERSE—TREE treehead ,action-rtn [,user-data]
treehead I longword—unsigned I longword (unsigned) I read only I by reference
action-rtn I procedure I procedure entry mask I function call (before return) I by reference,
procedure reference
user-data I user_arg I unspecified I read only I by reference
LIB$TRIM_FILESPEC in-file ,out-file [,width] [,out-len]
in-file I char_string I character string I read only I by descriptor
out-file I char_string I character string I write only I by descriptor
width I word—unsigned I word (unsigned) I read only I by reference
out-len I word—unsigned I word (unsigned) I write only I by reference
LIB$WAIT seconds
seconds I floating-point I F_floating I read only I by reference
MTH$ACOS X
MTH$DACOS X
MTH$GACOS X
MTH$HACOS h_radians ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$ACOS_R4
JSB entry: MTH$DACOS_R7
JSB entry: MTH$GACOS_R7
JSB entry: MTH$HACOS_R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
XI floating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—radians I floating-point IH —floating I write only I by reference

RTL-24

Run-Time Library Routines

MTH$ACOSD X
MTH$DACOSD x
MTH$GACOSD x
MTH$HACOSD h_degrees ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$ACOSD_R4
JSB entry: MTH$DACOSD_R7
JSB entry: MTH$GACOSD_R7
JSB entry: MTH$HACOSD_R8
Each of the above JSB entries accepts as input one of the four floating-point types.
xI floating-point I F_floating, G—floating, D—floating, H—floating I read only I by reference
h_degrees I floating—point IH_floating I write only I by reference

MTH$ASIN X
MTH$DASIN X
MTH$GASIN X
MTH$HASIN h_radians ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$ASIN_R4
JSB entry: MTH$DASIN_R7
JSB entry: MTH$GASIN_R7
JSB entry: MTH$HASIN_R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—radians I floating-point IH—floating I write only I by reference

Run-Time Library Routines

rtl-25

MTH$ASIND X
MTH$DASIND x
MTH$GASIND x
MTHSHASIND h_degrees ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry; MTH$ASIND_R4
JSB entry: MTH$DASIND_R7
JSB entry: MTH$GASIND_R7
JSB entry: MTH$HASIND_R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
XI floating-point I F_floating, D_floating, G—floating, H—floating I read only I by reference
h—degrees I floating-point IH—floating I write only I by reference

MTH$ATAN x
MTH$DATAN x
MTH$GATAN x
MTH$HATAN h_radians ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry; MTH$ATAN_R4
JSB entry; MTH$DATAN_R7
JSB entry; MTH$GATAN_R7
JSB entry: MTH$HATAN_R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h_radianslfloating—point IH—floating I write only I by reference

RTL-26

Run-Time Library Routines

MTH$ATAND x
MTH$DATAND x
MTH$GATAND x
MTH$HATAND h_degrees ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$ATAND-_R4
JSB entry: MTH$DATAND_R7
JSB entry: MTH$GATAND_R7
JSB entry: MTH$HATAND_R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
XI floating-point I F-Jloating, D—floating, G—floating, H—floating I read only I by reference
h—degrees I floating-point IH—floating I write only I by reference

MTH$ATAN2 y ,x
MTH$DATAN2 y ,x
MTH$GATAN2 y ,x
MTH$HATAN2 h_radians ,y ,x
Each of the above four formats accepts as input one of the four floating-point types.
ylfloating—point IF—floating, D—floating, G—floating, H—floating I read only I by
reference
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—radians I floating-point IH—floating I write only I by reference

MTH$ATAND2 y ,x
MTH$DATAND2 y ,x
MTH$GATAND2 y ,x
MTH$HATAND2 h_degrees ,y ,x
Each of the above four formats accepts as input one of the four floating-point types.
y I floating—point IF—floating, D—floating, G—floating, H—floating I read only I by
reference
XI floating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—degrees I floating-point IH —floating I write only I by reference

Run-Time Library Routines

rtl-27

MTH$ATANH x
MTH$DATANH x
MTH$GATANH x
MTHSHATANH h_atanh ,x
Each of the above four formats accepts as input one of the four floating-point types.
XI floating-point I F__floating, D—floating, G—floating, H—floating I read only I by reference
h—atanh I floating—point IH—floating I write only I by reference

MTH$CABS complex-number
MTH$CDABS complex-number
MTH$CGABS complex-number
Each of the above three formats accepts as input one of the three floating-point
complex types.
complex-numbericomplex—number IF—floating complex, D—floating complex, G—
floating complex I read only I by reference

MTH$CCOS complex-number
MTH$CDCOS complex-cosine ,complex-number
MTH$CGCOS complex-cosine ,complex-number
Each of the above three formats accepts as input one of the three floating-point types.
complex-numberIcomplex—number IF—floating complex, D—floating complex, G—
floating complex I read only I by reference
complex-cosinelcomplex—number ID—floating complex, G—floating complex I write
only I by reference

MTH$CEXPP complex-number
MTH$CDEXP complex-exp ,complex-number
MTH$CGEXP complex-exp ,complex-number
Each of the above three formats accepts as input one of the three floating-point
complex types.
complex-numberIcomplex—number IF—floating complex, D—floating complex, G—
floating complex I read only I by reference
complex-expicomplex—number ID—floating complex, G—floating complex I write
only I by reference

RTL-28

Run-Time Library Routines

MTH$CLOG complex-number
MTH$CDLOG complex-natlog ,complex-number
MTH$CGLOG complex-natlog ,complex-number
Each of the above three formats accepts as input one of the three floating-point
complex types.
complex-number I complex—number I F_floating complex, D_floating complex, G_
floating complex I read only I by reference
complex-natlog I complex—number I D—floating complex, G—floating complex I write
only I by reference

MTH$CMPLX real-part ,imag-part
MTH$DCMPLX complx ,real-part ,iniag-part
MTH$GCMPLX complx ,real-part ,imag-part
Each of the above three formats accepts as input one of three floating-point types.
real-partlfloating—point IF—floating, D—floating, G—floating I write only I by reference
imag-partifloating—point IF—floating, D—floating, G—floating I write only I by reference
complxlcomplex—number I D—floating complex, G—floating complex I write only I by
reference

MTH$CONJG complex-number
MTH$DCONJG complex-conjugate ,complex-number
MTH$GCONJG complex-conjugate ,complex-number
Each of the above three formats accepts as input one of the three floating-point
complex types.
complex-numbericomplex—number IF—floating complex, D—floating complex, G—
floating complex I read only I by reference
complex-conjugatelcomplex—number I D—floating complex, G—floating complex I write
only I by reference

Run-Time Library Routines

rtl-29

MTHSCOS X
MTHSDCOS X
MTH$GCOS X
MTH$HCOS h_cosine ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$COS_R4
JSB entry: MTH$DCOS_R7
JSB entry: MTH$GCOS_R7
JSB entry: MTH$HCOS_R5
Each of the above four JSB entries accepts as input one of the four floating-point
types.
XI floating-point IE-floating, D_floating, G—floating, H—floating I read only I by reference
h—cosine I floating-point IH—floating I write only I by reference

MTH$COSD X
MTH$DCOSD X
MTHSGCOSD x
MTH$HCOSD h_cosine ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$COSD_R4
JSB entry: MTH$DCOSD_R7
JSB entry: MTH$GCOSD_R7
JSB entry: MTH$HCOSD_R5
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—cosine I floating-point IH—floating I write only I by reference

MTH$COSH X
MTH$DCOSH X
MTH$GCOSH X
MTH$HCOSH h_cosh ,x
Each of the above four formats accepts as input one of the four floating-point types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read onlylby reference
h—cosh I floating—point IH—floating I write onlylby reference

RTL-30

Run-Time Library Routines

MTH$CSIN complex-number
MTH$CDSIN complex-sine ,complex-number
MTH$CGSIN complex-sine ,complex-number
Each of the above three formats accepts as input one of the three floating-point
complex types.
complex-number I complex—number I F_floating complex, D_floating complex, G—
floating complex I read only I by reference
complex-sine I floating-point ID—floating, G —floating I write only I by reference

MTH$CSQRT complex-number
MTH$CDSQRT complex-sqrt ,complex-number
MTH$CGSQRT complex-sqrt ,complex-number
Each of the above three formats accepts as input one of the three floating-point
complex types.
complex-numbericomplex—number IF—floating complex, D—floating complex, G—
floating complex I read only I by reference
complex-sqrticomplex—number ID—floating complex, G—floating complex I write
only I by reference

MTH$CVT__D_G source
MTH$CVT_G_D source
source I floating—point ID—floating, G—floating I read only I by reference

MTH$CVT_DA^GA source ,dest [,count]
MTH$CVT_GA_DA source ,dest [,count]
source I floating—point ID—floating, G—floating I read only I by reference, array reference
destifloating—point IG—floating, D—floating I write only I by reference, array reference
count I longword—signed I longword integer (signed) I read only I by reference

Run-Time Library Routines

rtl-31

MTH$EXP X
MTH$DEXP X
MTHSGEXP X
MTH$HEXP h_exp ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$EXP_R4
JSB entry: MTH$DEXP_R6
JSB entry: MTH$GEXP_R6
JSB entry: MTH$HEXP_R6
Each of the above four JSB entries accepts as input one of the four floating-point
types.
x I floating-point I F_floating, D_floating, G—floating, H—floating I read onlylby reference
h—exp I floating-point IH—floating I write onlylby reference
MTH$AIMAG complex-number
MTH$DIMAG complex-number
MTH$GIMAG complex-number
Each of the above three formats corresponds to one of the three floating-point
complex types.
complex-numbericomplex—number IF—floating complex, D—floating complex, G—
floating complex I read onlylby reference
MTH$ALOG X
MTH$DLOG X
MTH$GLOG X
MTH$HLOG h_natlog ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$ALOG_R5
JSB entry: MTH$DLOG_R8
JSB entry: MTH$GLOG_R8
JSB entry: MTH$HLOG-R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read onlylby reference
h—natlog I floating—point IH—floating I write onlylby reference

RTL-32

Run-Time Library Routines

MTH$ALOG2 x
MTH$DLOG2 x
MTH$GLOG2 x
MTH$HLOG2 h_log2 ,x
Each of the above four formats accepts as input one of the four floating-point types.
XI floating-point I F__floating, D_floating, G—floating, H—floating I read only I by reference
h—log21 floating-point IH —floating I write only I by reference
MTH$ALOG10 x
MTH$DLOG10 x
MTH$GLOG10 x
MTH$HLOG10 K_loglO ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$ALOG10_R5
JSB entry: MTH$DLOG10_R8
JSB entry: MTH$GLOG10_R8
JSB entry: MTH$HLOG10_R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
XI floating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—logl 01 floating—point IH—floating I write only I by reference
MTH$RANDOM seed
seed I longword—unsigned I longword (unsigned) I modify I by reference
MTH$REAL complex-number
MTH$DREAL complex-number
MTH$GREAL complex-number
Each of the above three formats accepts as input one of the three floating-point
complex types.
complex-numbericomplex—number IF—floating complex, D—floating complex, G—
floating complex I read only I by reference

Run-Time Library Routines

rtl-33

MTH$SIN X
MTH$DSIN X
MTHSGSIN X
MTH$HSIN h_sine ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$SIN_R4
JSB entry: MTH$DSIN_R7
JSB entry: MTH$GSIN_R7
JSB entry: MTH$HSIN_R5
Each of the above four JSB entries accepts as input one of the four floating-point
types.
x I floating-point I F_floating, D_floating, G—floating, H—floating I read onlylby reference
h_sine I floating—point IH—floating I write onlylby reference
MTH$SINCOS X ,sine ,cosine
MTH$DSINCOS X ,sine ,cosine
MTH$GSINCOS X ,sine ,cosine
MTH$HSINCOS X ,sine ,cosine
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$SINCOS_R5
JSB entry: MTH$DSINCOS_R7
JSB entry: MTH$GSINCOS_R7
JSB entry: MTH$HSINCOS_R7
Each of the above four JSB entries accepts as input one of the four floating-point
types.
XI floating-point I F_floating, D_floating, G—floating, H—floating I read onlylby reference
sinelfloating—point IF—floating, D—floating, G—floating, H—floating I write onlylby
reference
cosine I floating—point IF—floating, D—floating, G—floating, FI—floating I write onlylby
reference

RTL-34

Run-Time Library Routines

MTH$SINCOSD X ,sine ,cosine
MTH$DSINCOSD X ,sine ,cosine
MTH$GSINCOSD X ,sine ,cosine
MTH$HSINCOSD X ,sine ,cosine
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$SINCOSD_R5
JSB entry: MTH$DSINCOSD_R7
JSB entry: MTH$GSINCOSD_R7
JSB entry: MTH$HSINCOSD_R7
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xl floating-point I F_floating, D_floating, G—floating, H—floating I read only I by reference
sine I floating-point IF—floating, D—floating, G—floating, H—floating I write only I by
reference
cosine I floating—point IF—floating, D—floating, G—floating, H—floating I write only I by
reference
MTH$SIND X
MTH$DSIND X
MTH$GSIND X
MTH$HSIND h_sine ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$SIND_R4
JSB entry: MTH$DSIND_R7
JSB entry: MTH$GSIND_R7
JSB entry: MTH$HSIND_R5
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—sine I floating-point IH—floating I write only I by reference

Run-Time Library Routines

rtl-35

MTH$SINH X
MTH$DSINH X
MTH$GSINH X
MTH$HSINH h_sinh ,x
Each of the above four formats accepts as input one of the four floating-point types.
x I floating-point I F_floating, D—floating, G—floating, H—floating I read only I by reference
h_sinhifloating—point IH—floating I write only I by reference
MTH$SQRT X
MTH$DSQRT x
MTH$GSQRT x
MTH$HSQRT h_sqrt ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$SQRT_R3
JSB entry: MTH$DSQRT_R5
JSB entry: MTH$GSQRT_R5
JSB entry: MTH$HSQRT_R8
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read onlylby reference
h_sqrtifloating—point IH—floating I write onlylby reference
MTH$TAN X
MTH$DTAN x
MTH$GTAN x
MTH$HTAN h_tan ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$TAN_R4
JSB entry: MTH$DTAN_R7
JSB entry: MTH$GTAN_R7
JSB entry: MTH$HTAN_R5
Each of the above four JSB entries accepts as input one of the four floating-point
types.
xlfloating—point IF—floating, D—floating, G—floating, H—floating I read onlylby value
h—tan I floating-point IH—floating I write onlylby reference

RTL-36

Run-Time Library Routines

MTHSTAND x
MTHSDTAND x
MTH$GTAND x
MTH$HTAND h_tan ,x
Each of the above four formats accepts as input one of the four floating-point types.
JSB entry: MTH$TAND_R4
JSB entry: MTH$DTAND_R7
JSB entry: MTH$GTAND_R7
JSB entry: MTH$HTAND_R5
Each of the above four JSB entries accepts as input one of the four floating-point
types.
XI floating-point I F_floating, D_floating, G—floating, H—floating I read only I by reference
h—tan I floating—point IH—floating I write only I by reference
MTH$TANH x
MTH$DTANH x
MTH$GTANH x
MTHSHTANH h_tanh ,x
Each of the above four formats accepts as input one of the four floating-point types.
XI floating—point IF—floating, D—floating, G—floating, H—floating I read only I by reference
h—tanh I floating-point IH—floating I write only I by reference
MTH$UMAX argl [... ,argn]
argl llongword—unsigned I longword (unsigned) I read only I by reference
argn I longword—unsigned I longword (unsigned) I read only I by reference
MTH$UMIN argl [... ,argn]
argl llongword—unsigned I longword (unsigned) I read only I by reference
argn I longword—unsigned I longword (unsigned) I read only I by reference
OTS$CNVOUT value ,out-string ,digits-in-fract
OTS$CNVOUT_G value ,out-string ,digits-in-fract

Run-Time Library Routines

rtl-37

OTS$CNVOUT_H value ,out-string ,digits-in-fract
value I floating-point I D_floating, G—floating, H—floating I read only I by reference
out-string I char—string I character string I write only I by descriptor, fixed length
digits-in-fract I longword—unsigned I longword (unsigned) I read only I by value
OTS$CVT__L _TB value ,out-str [,int-digits] [,value-size]
valuel varying—arg I unspecified I read only I by reference
out-str I char—string I character string I write only I by descriptor, fixed-length
int-digits I longword—signed I longword integer (signed) I read only I by value
value-size I longword—signed I longword integer (signed) I read only I by value
OTS$CVT—L_TI value ,out-str [,int-digits] [,value-size] [,flags]
value I varying—arg I unspecified I read only I by reference
out-str I char—string I character string I write only I by descriptor, fixed length
int-digits I longword—signed I longword integer (signed) I read only I by value
value-size I longword—signed I longword integer (signed) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
OTS$CVT_L_TL value ,out-str
value I longword—signed I longword integer (signed) I read only I by reference
out-str I char—string I character string I write only I by descriptor, fixed length
OTS$CVT_L_TO value ,out-str [,int-digits] [,value-size]
value I varying—arg I unspecified I read only I by reference
out-str I char—string I character string I write only I by descriptor, fixed length
int-digits I longword—signed I longword integer (signed) I read only I by value
value-size I longword—signed I longword integer (signed) I read only I by value
OTS$CVT_-L_TU value ,out-str [,int-digits] [,value-size]
value I varying—arg I unspecified I read only I by reference
out-str I char—string I character string I write only I by descriptor, fixed-length
int-digits I longword—unsigned I longword (unsigned) I read only I by value
value-size I longword—unsigned I longword (unsigned) I read only I by value

RTL-38

Run-Time Library Routines

OTS$CVT_L_TZ value ,out-str [,int-digits] [,value-size]
value I varying_arg I unspecified I read only I by reference
out-str I char_string I character string I write only I by descriptor, fixed length
int-digitsllongword__signedllongword integer (signed) I read only I by value
value-size I longword—signed I longword integer (signed) I read only I by value
OTS$CVT_TB_L inp-str ,value [,value-size] [,flags]
inp-str I char_string I character string I read only I by descriptor
value I varying_arg I unspecified I write only I by reference
value-size I longword—signed I longword integer (signed) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
OTS$CVT_TI_L inp-str ,value [,value-size] [,flags]
inp-str I char_string I character string I read only I by descriptor, fixed-length or dynamic
string
value I varying_arg I unspecified I write only I by reference
value-size I longword—signed I longword integer (signed) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
OTS$CVT—TL —L inp-str ,value [,value-size]
inp-str I char—string I character string I read only I by descriptor, fixed-length or dynamic
string
valuel varying—arg I unspecified I write only I by reference
value-size I longword—signed I longword integer (signed) I read only I by value
OTS$CVT_TO_L inp-str ,value [,value-size] [,flags]
inp-str I char—string I character string I read only I by descriptor, fixed-length or dynamic
string
value I varying—arg I unspecified I write only I by reference
value-size I longword signed I longword integer (signed) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
OTS$CVT_TU_L inp-str ,value [,value-size] [,flags]
inp-str I char—string I character string I read only I by descriptor, fixed-length
value I varying—arg I unspecified I write only I by reference
value-size I longword—signed I longword integer (signed) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value

Run-Time Library Routines

rtl-39

OTS$CVT_T_D inp-str ,value [,digits-in>fract] [,scale-factor] [,flags] [,ext-bits]
OTS$CVT_T_F inp-str ,value [,digits-in-fract] [,scale-factor] [,flags] [,ext-bits]
OTS$CVT_T_G inp-str ,value [,digits-in-fract] [,scale-factor] [,flags] [,ext-bits]
OTS$CVT_T_H inp-str ,value [,digits-in-fract] [,scale-factor] [,flags] [,ext-bits]
Each of the above four formats corresponds to one of the four floating-point types.
inp-str I char_string I character string I read only I by descriptor, fixed-length or dynamic
string
value I floating-point I D_floating, F—floating, G—floating, H—floating I write only I by
reference
digits-in-fract I longword—unsigned I longword (unsigned) I read only I by value
scale-factor I longword—signed I longword integer (signed) I read only I by value
flags I mask—longword I longword (unsigned) I read only I by value
ext-bits I word signed I word integer (signed) I write only I by reference
OTS$CVT—TZ_L inp-str ,value [,value-size] [,flags]
inp-str I char—string I character string I read only I by descriptor, fixed-length or dynamic
string
value I varying—arg I unspecified I write only I by reference
value-size I longword—signed I longword integer (signed) I read only I by value
flags I mask—long word I longword (unsigned) I read only I by value
OTS$DIVC dividend ,divisor
OTS$DIVCD_R3 dividend ,divisor
OTS$DIVCG—R3 dividend ,divisor
Each of the above three formats corresponds to one of the three floating-point
complex types.
dividendicomplex—number IF—floating complex, D—floating complex, G—floating
complex I read only I by value
divisoricomplex—number IF—floating complex, D—floating complex, G—floating
complex I read only I by value
OTS$DIV—PK__LONG divd ,divr ,divr-prec ,quot ,quot-prec ,prec-data ,scale-data
divd I address I packed decimal string I read only I by reference
divr I address I packed decimal string I read only I by reference
divr-preci word_signed I word integer (signed) I read only I by value

RTL-40

Run-Time Library Routines

quot I address I packed decimal string I write only I by reference
quot-preciword—signediword integer (signed) I read only I by value
prec-data I word_signed I word integer (signed) I read only I by value
scale-data I word—signed I word integer (signed) I read only I by value

OTS$DIV_PK—SHORT divd ,divr ,divr-prec ,quot ,quot-prec ,prec-data
divd I address I packed decimal string I read only I by reference
divr I address I packed decimal string I read only I by reference
divr-prec I word—signed I word integer (signed) I read only I by value
quot I address I packed decimal string I write only I by reference
quot-prec I word—signed I word integer (signed) I read only I by value
prec-data I word—signed I word integer (signed) I read only I by value

OTS$MOVE3 length ,source ,dest
JSB entry: OTS$MOVE3_R5
length I longword—signed I longword integer (signed) I read only I by value
sourcelbyte—unsignedibyte (unsigned) I read only I by reference, array reference
destibyte—unsignedibyte (unsigned) I write only I by reference, array reference

OTS$MOVE5 srclen ,source ,fill ,dstlen ,dest
JSB entry: OTS$MOVE5_R5
srclen I longword—signed I longword integer (signed) I read only I by value
sourcelbyte—unsignedibyte (unsigned) I read only I by reference, array reference
fill I byte—unsigned I byte (unsigned) I read only I by value
dstlen I longword—signed I longword integer (signed) I read only I by value
dest I byte—unsigned I byte (unsigned) I write only I by reference, array reference

OTS$MULCD—R3 multiplier ,multiplicand
OTS$MULCG—R3 multiplier ,multiplicand
The above formats correspond to the D—floating and G—floating complex types.
multipliericomplex—number ID—floating complex, G—floating complex I read only I by
value
multiplicandicomplex—number ID—floating complex, G—floating complex I read only I by
value

Run-Time Library Routines

rtl-41

OTS$POWCC base ,exponent
OTS$POWCDCD»Jl3 base ,exponent
OTS$POWCGCG_R3 base ,exponent
Each of the above three formats corresponds to one of the three floating-point
complex types.
base I complex—number I F_floating complex, D_floating complex, G—floating
complex I read only I by value
exponent I complex—number I F—floating complex, D—floating complex, G—floating
complex I read only I by value

OTS$POWCJ base ,exponent
OTS$POWCDJJl3 base ,exponent
OTS$POWCGJ_-R3 base ,exponent
Each of the above three formats corresponds to one of the three floating-point
complex types.
baselcomplex—number I F—floating complex, D—floating complex, G—floating
complex I read only I by value
exponent I longword

signed I longword integer (signed) I read only I by value

OTS$POWDD base ,exponent
OTS$POWDJ base ,exponent
OTS$POWDR base ,exponent
The above formats correspond to raising the D_floating base to a D_floating,
longword, or E—floating exponent.
base I floating—point ID—floating I read only I by value
exponent I floating—point ID—floating, longword integer (signed), F—floating I read
only I by value

OTS$POWGG base ,exponent
OTS$POWGJ base ,exponent
baselfloating—point IG—floating I read only I by value
exponentifloating—point IG—floating, longword integer (signed) I read only I by value

RTL-42

Run-Time Library Routines

OTS$POWHH__R3 base ,exponent
OTS$POWHJ_R3 base ,exponent
The above formats correspond to raising an H—floating number to either an H—
floating or a signed longvs^ord integer exponent.
base I floating-point IH—floating I read only I by value
exponentllongword—signed IH—floating, longword integer (signed) I read only I by value

OTS$POWII base ,exponent
base I word—signed I word integer (signed) I read only I by value
exponent I word—signed I word integer (signed) I read only I by value

OTS$POWJJ base ,exponent
base I longword—signed I longword integer (signed) I read only I by value
exponent I longword—signed I longword integer (signed) I read only I by value

OTS$POWLULU base ,exponent
base I longword—unsigned I longword (unsigned) I read only I by value
exponent I longword—unsigned I longword (unsigned) I read only I by value

OTS$POWRLU base ,exponent
OTS$POWDLU base ,exponent
OTS$POWGLU base ,exponent
OTS$POWHLU—R3 base ,exponent
base I floating—point IF—floating, D—floating, G—floating, H—floating I read only I by value
exponentllongword—unsigned I longword (unsigned) I read only I by value

OTS$POWRD base ,exponent
OTS$POWRJ base ,exponent
OTS$POWRR base ,exponent
The above formats correspond to raising the base to a D—floating, longword and
F—floating exponent.
baselfloating—point IF—floating I read only I by value
exponent I varying—arg ID—floating, longword integer (signed), F—floating I read only I by
value

Run-Time Library Routines

rtl-43

OTS$SCOPY_DXDX src-str ,dst-str

JSB entry: OTS$SCOPY_DXDX6
src-str I char_string I character string I read only I by descriptor
dst-str I char_string I character string I write only I by descriptor

OTS$SCOPY_R_DX src-len ,src-adr ,dst-str

JSB entry: OTS$SCOPY_R_DX6
src-len I word_unsigned I word (unsigned) I read only I by value
src-adr I char_string I character string I read only I by reference
dst-str I char_string I character string I write only I by descriptor

OTS$SFREEl_DD dyn-dsc

JSB entry: OTS$SFREEl_DD6
dyn-dsc I quadword_unsigned I quadword (unsigned) I modify I by reference

OTS$SFREEN_DD dsc-num ,first-dsc

JSB entry: OTS$SFREEN_DD6
dsc-num I longword—unsigned I longword (unsigned) I read only I by value
first-dsc I quadword—unsigned I quadword (unsigned) I modify I by reference

OTS$SGETl—DD len ,dyn-dsc

JSB entry: OTS$SGETl_DD_R6
len I word_unsigned I word (unsigned) I read only I by value
dyn-dsc I quadword—unsigned I quadword (unsigned) I modify I by reference

SMG$ADD_KEY_DEF key-table-id ,key-name [,if-state] [,attributes] [,equiv-string]
[,state-string]
key-table-id I longword_unsigned I longword (unsigned) I read only I by reference
key-name I char_string I character string I read only I by descriptor
if-state I char_string I character string I read only I by descriptor
attributes I mask—longword I longword (unsigned) I read only I by reference
equiv-string I char—string I character string I read only I by descriptor
state-string I char—string I character string I read only I by descriptor

SMG$ALLOW__ESCAPE display-id ,esc-flag
display-id I longword—unsigned I longword (unsigned) I read only I by reference
esc-flag I mask—longword I longword (unsigned) I read only I by reference

RTL-44

Run-Time Library Routines

SMG$BEGIN_DISPLAY_UPDATE display-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$BEGIN__PASTEBOARD_UPDATE pasteboard-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$CANCEL-INPUT keyboard-id
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$CHANGE_PBD_CHARACTERISTICS pasteboard-id [,desired-width]
[,resulting-width] [,desired-height] [,resulting-height] [,desired-background-color]
[,resulting-background-color]
pasteboard-id I longword—unsigned I longword (unsigned) I read only 1 by reference
desired-width I longword—signed I longword integer (signed) I read only I by reference
resulting-width I longword—signed I longword integer (signed) I write only I by reference
desired-height I longword—signed I longword integer (signed) I read only I by reference
resulting-height I longword—signed I longword integer (signed) I write only I by reference
desired-background-color I longword—unsigned I longword (unsigned) I read only I by
reference
resulting-background-color I longword—unsigned I longword (unsigned) I write only I by
reference
SMG$CHANGE—RENDITION display-id ,start-row ,start-col ,rows ,columns
[,rendition-set] [,rendition-complement]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
start-row I longword—signed I longword integer (signed) I read only I by reference
start-col I longword—signed I longword integer (signed) I read only I by reference
rows I longword—signed I longword integer (signed) I read only I by reference
columns I longword—signed I longword integer (signed) I read only I by reference
rendition-set I longword—unsigned I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
SMG$CHANGE—VIRTUAL—DISPLAY display-id ,rows ,columns
[,display-attributes] [,video-attributes] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
rows I longword—signed I longword integer (signed) I read only I by reference
columns I longword—signed I longword integer (signed) I read only I by reference
display-attributes I mask—longword I longword (unsigned) I read only I by reference

Run-Time Library Routines

rtl-45

video-attributes I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$CHECK_FOR_OCCLUSION display-id ,pasteboard-id ,occlusion-state
display-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
occlusion-state I longword—signed I longword integer (signed) I write only I by reference
SMG$CONTROL_MODE pasteboard-id [,new-mode] [,old-mode]
pasteboard-id I longword—unsigned I longword (unsigned) I read only 1 by reference
new-mode I longword—unsigned I longword (unsigned) I read only I by reference
old-mode 1 longword—unsigned I longword (unsigned) I write only I by reference
SMG$COPY_VIRTUAL-DISPLAY curr-display-id ,new-display-id
curr-display-id I longword—unsigned I longword (unsigned) I read only I by reference
new-display-id I longword—unsigned I longword (unsigned) I write only I by reference
SMG$CRE ATE -KEY-TABLE new-key-table-id
new-key-table-id I longword—unsigned I longword (unsigned) I write only I by reference
SMG$CREATE—PASTEBOARD new-pasteboard-id [,output-device] [,pb-rows]
[,pb-columns] [,preserve-screen-flag]
new-pasteboard-id I longword—unsigned I longword (unsigned) I write only I by reference
output-device I char—string I character string I read only I by descriptor
pb-rows I longword—signed I longword integer (signed) I write only I by reference
pb-columns I longword—signed I longword integer (signed) I write only I by reference
preserve-screen-flag I mask—longword I longword (unsigned) I read only I by reference
SMG$CREATE—VIRTUAL—DISPLAY num-rows, num-columns, new-display-id
[,display-attributes] [,video-attributes] [,char-set]
num-rows I longword—signed I longword integer (signed) I read only I by reference
num-columns I longword_signed I longword integer (signed) I read only I by reference
new-display-id I longword—unsigned I longword (unsigned) I write only I by reference
display-attributes I longword—unsigned I longword (unsigned) I read only I by reference

RTL-46

Run-Time Library Routines

video-attributes I mask—longword I long word (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$CRE ATE-.VIRTUAL _JCEYBOARD new-keyboard-id [,mespec]
[,default-filespec] [,resultant-filespec] [,recall-size]
new-keyboard-id I longword—unsigned I longword (unsigned) I write only I by reference
filespec I char_string I character string I read only I by descriptor
default-filespec I char_string I character string I read only I by descriptor
resultant-filespec I char_string I character string I write only I by descriptor
recall-size I byte_unsigned I byte (unsigned) I read only I by reference
SMG$CURSOR_COLUMN display-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$CURSOR__ROW display-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$DEFINE__KEY key-table-id ,command-line
key-table-id I longword—unsigned I longword (unsigned) I read only I by reference
command-line I char—string I character string I read only I by descriptor
SMG$DEL -TERM-TABLE
SMG$DELETE—CHARS display-id ,num-chars ,row ,column
display-id I longword—unsigned I longword (unsigned) I read only I by reference
num-chars I longword—signed I longword integer (signed) I read only I by reference
row I longword—signed I longword integer (signed) I read only I by reference
column I longword—signed I longword integer (signed) I read only I by reference
SMG$DELETE—KEY—DEF key-table-id ,key-name [,if-state]
key-table-id I longword—unsigned I longword (unsigned) I read only I by reference
key-name I char—string I character string I read only I by descriptor
if-state I char—string I character string I read only I by descriptor
SMG$DELETE—LINE display-id ,start-line [,number-lines]
display-id I longword_unsigned I longword (unsigned) I read only I by reference
start-line I longword—signed I longword integer (signed) I read only I by reference
number-lines I longword—signed I longword integer (signed) I read only I by reference

Run-Time Library Routines

rtl-47

SMG$DELETE—PASTEBOARD pasteboard-id [,clear-screen-flag]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
clear-screen-flaglmask—longwordllongword (unsigned) I read only I by reference
SMG$DELETE-VIRTUAL -DISPLAY display-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$DELETE-VIRTUAL -KEYBOARD keyboard-id
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$DIS ABLE -BROADCAST-TRAPPING pasteboard-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$DIS ABLE -UNSOLICITED-INPUT pasteboard-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$DRAW—LINE display-id ,start-row ,start-column ,end-row ,end-column
[,rendition-set] [,rendition-complement]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
start-row I longword—signed I longword integer (signed) I read only I by reference
start-column I longword—signed I longword integer (signed) I read only I by reference
end-row I longword—signed I longword integer (signed) I read only I by reference
end-column I longword—signed I longword integer (signed) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask —longword I longword (unsigned) I read only I by reference
SMG$DRAW—RECTANGLE display-id ,top-left-row ,top-left-column
,bottom-right-row ,bottom-right-column [,rendition-set] [,rendition-complement]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
top-left-row I longword—signed I longword integer (signed) I read only I by reference
top-left-column I longword—signed I longword integer (signed) I read only I by reference
bottom-right-row I longword—signed I longword integer (signed) I read only I by reference
bottom-right-column I longword—signed I longword integer (signed) 1 read only I by
reference

RTL-48

Run-Time Library Routines

rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
SMG$EN ABLE-UNSOLICITED-INPUT pasteboard-id , AST-routine
[, AST-argument]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
AST-routine I ast_procedure I procedure entry mask I read only I by reference
AST-argumentluser_argllongwordlread only I by value
SMG$END-DISPLAY-UPDATE display-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$END-PASTEBOARD-UPDATE pasteboard-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$ERASE—CHARS display-id ,number-of-chars ,row-number ,column-number
display-id I longword—unsigned I longword (unsigned) I read only I by reference
number-of-chars I longword—signed I longword integer (signed) I read only I by reference
row-number I longword—signed I longword integer (signed) I read only I by reference
column-number I longword—signed I longword integer (signed) I read only I by reference
SMG$ERASE—DISPLAY display-id [,start-row] [,start-column] [,end-row]
[,end-column]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
start-row I longword—signed I longword integer (signed) I read only I by reference
start-column I longword—signed I longword integer (signed) I read only I by reference
end-row I longword—signed I longword integer (signed) I read only I by reference
end-column I longword—signed I longword integer (signed) I read only I by reference
SMG$ERASE_LINE display-id [,line-number] [,column-number]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
line-number I longword signed I longword integer (signed) I read only I by reference
column-number I longword—signed I longword integer (signed) I read only I by reference
SMG$ERASE —PASTEBOARD pasteboard-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference

Run-Time Library Routines

rtl-49

SMG$FIND—CURSOR—DISPLAY pasteboard-id ,returned-display-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
returned-display-idllongword—unsignedllongword (unsigned) I write only I by reference
SMG$FLUSH-BUFFER pasteboard-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$GET—BROADCAST—MESSAGE pasteboard-id [,message] [,message-length]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
message I char_string I character string I write only I by descriptor
message-length I word—signed I word integer (signed) I write only I by reference
SMG$GET-CHAR-AT-PHYSICAL-CURSOR pasteboard-id ,character
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
character I byte—unsigned I byte (unsigned) I write only I by reference
SMG$GET—DISPLAY—ATTR display-id [,height] [,width] [,display-attributes]
[,video-attributes] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
height I longword—signed I longword integer (signed) I write only I by reference
width I longword signed I longword integer (signed) I write only I by reference
display-attributes I longword—unsigned I longword (unsigned) I write only I by reference
video-attributes I longword—unsigned I longword (unsigned) I write only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$GET—KEY—DEF key-table-id ,key-name [,if-state] [,attributes] [,equiv-string]
[,state-string]
key-table-id I longword—unsigned I longword (unsigned) I read only I by reference
key-name I char—string I character string I read only I by descriptor
if-state I char—string I character string I read only I by descriptor
attributes I mask—longword I longword (unsigned) I write only I by reference
equiv-string I char—string I character string I write only I by descriptor
state-string I char—string I character string I write only I by descriptor
SMG$GET-KEYBOARD-ATTRIBUTES keyboard-id ,p-kit ,p-kit-size
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
p-kit I address I longword (unsigned) I write only I by reference
p-kit-size I longword—unsigned I longword (unsigned) I read only I by reference

RTL-50

Run-Time Library Routines

SMG$GET_NUMERIC_DATA termtable-address ,request-code ,buffer-address
termtable-address I address I longword (unsigned) I read only I by reference
request-code I longword—signed I longword integer (signed) I read only I by reference
buffer-address I address I longword (unsigned) I write only I by reference
SMG$GET_PASTEBOARD_ATTRIBUTES pasteboard-id ,pb-info-table
,pb-info-table-size
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
pb-info-tablelvector_byte_unsignedlbyte (unsigned) I write only I by reference, array
reference
pb-info-table-size I longword—unsigned I longword (unsigned) I read only I by reference
SMG$GET_PASTING_JNFO display-id ,pasteboard-id ,pasted-flag
[,pasteboard-row] [,pasteboard-col]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
pasted-flag I boolean I longword (unsigned) I write only I by reference
pasteboard-row I longword—signed I longword (signed) I write only I by reference
pasteboard-col I longword—signed I longword (signed) I write only I by reference
SMG$GET—TERM—DATA termtable-address ,request-code ,max-buffer-length
,retum-length ,buffer-address [,input-argument-vector]
termtable-address I address I longword (unsigned) I read only I by reference
request-code I longword—unsigned I longword (unsigned) I read only I by reference
max-buffer-length I longword—signed I longword integer (signed) I read only I by reference
return-length I longword_signed I longword integer (signed) I write only I by reference
buffer-address I address I longword (unsigned) I write only I by reference
input-argument-vector I address I longword (unsigned) I read only I by reference, array
reference
SMG$HOME—CURSOR display-id [,position]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
position I longword—unsigned I longword (unsigned) I read only I by reference
SMG$INIT_TERM—TABLE terminal-name, term-entry-address
terminal-name I char—string I character string I read only I by descriptor
term-entry-address I longword—unsigned I longword (unsigned) I write only I by reference

Run-Time Library Routines

rtl-51

SMG$INIT-_-TERM_-TABLE_BY_TYPE terminal-type ,term-entry-address
[,terminal-name]
terminal-type I byte_signed I byte integer (signed) I read only I by reference
term-entry-address I address I longword (unsigned) I write only I by reference
terminal-name I device_name I character string I write only I by descriptor

SMG$INSERT_CHARS display-id ,string ,row ,column [,rendition-set]
[,rendition-complement] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
string I char_string I character string I read only I by descriptor
row I longword signed I longword integer (signed) I read only I by reference
column I longword_signed I longword integer (signed) I read only I by reference
rendition-set I mask —longword I longword (unsigned) I read only I by reference
rendition-complement I mask —longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference

SMG$INSERT_.LINE display-id ,line-number [,string] [,direction] [,rendition-set]
[,rendition-complement] [,wrap-flag] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
line-number I longword—signed I longword integer (signed) I read only I by reference
string I char—string I character string I read only I by descriptor
direction I longword—unsigned I longword (unsigned) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
wrap-flag I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference

SMG$IN VALID ATE -DISPLAY display-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference

SMG$LABEL—BORDER display-id [,label-text] [,position] [,units] [,rendition-set]
[,rendition-complement] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
label-text I char—string I character string I read only I by descriptor
position I longword_unsigned I longword (unsigned) I read only I by reference
units I longword_signed I longword integer (signed) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference

RTL-52

Run-Time Library Routines

rendition-complement I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$LIST_-KEY-_DEFS key-table-id ,context [,key-name] [,if-state] [,attributes]
[,equiv-string] [,state-string]
key-table-id I longword—unsigned I longword (unsigned) I read only I by reference
context I context I longword integer (signed) I modify I by reference
key-name I char_string I character string I modify I by descriptor
if-state I char_string I character string I write only I by descriptor
attributes I longword—unsigned I longword (unsigned) I write only I by reference
equiv-string I char—string I character string I write only I by descriptor
state-string I char—string I character string I write only I by descriptor
SMG$LOAD_KEY_DEFS key-table-id ,filespec [,default-filespec] [,lognam-flag]
key-table-id I longword—unsigned I longword (unsigned) I read only I by reference
filespec I char—string I character string I read only I by descriptor
default-filespec I char—string I character string I read only I by descriptor
lognam-flag I mask—longword I longword (unsigned) I read only I by reference
SMG$MOVE—VIRTUAL—DISPLAY display-id ,pasteboard-id ,pasteboard-row
,pasteboard-column [,top-display-id]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-row I longword—signed I longword integer (signed) I read only I by reference
pasteboard-column I longword—signed I longword integer (signed) I read only I by reference
top-display-id I longword—unsigned I longword (unsigned) I read only I by reference
SMG$PASTE—VIRTUAL—DISPLAY display-id ,pasteboard-id ,pasteboard-row
,pasteboard-column [,top-display-id]
display-id 1 longword_unsigned I longword (unsigned) I read only I by reference
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-row I longword—signed I longword integer (signed) I read only I by reference
pasteboard-column I longword—signed I longword integer (signed) I read only I by reference
top-display-id I longword_unsigned I longword (unsigned) I read only I by reference
SMG$POP-VIRTUAL-DISPLAY display-id ,pasteboard-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference

Run-Time Library Routines

rtl-53

SMG$PUT_CHARS display-id ,text [,line-number] [,column-number] [,erase-flag]
[,rendition-set] [,rendition-complement] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
text I char_string I character string I read only I by descriptor
line-number I longword—signed I longword integer (signed) I read only I by reference
column-number I longword—signed I longword integer (signed) I read only I by reference
erase-flag I mask_longword I longword (unsigned) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask_longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$PUT_CHARS_HIGHWIDE display-id ,text [,line-number] [,column-number]
[,rendition-set] [,rendition-complement] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
text I char_string I character string I read only I by descriptor
line-number I longword_signed I longword integer (signed) I read only I by reference
column-number I longword—signed I longword integer (signed) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$PUT__CHARS_WIDE display-id ,text [,line-number] [,column-number]
[,rendition-set] [,rendition-complement] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor
line-number I longword—signed I longword integer (signed) I read only I by reference
column-number I longword_signed I longword integer (signed) I read only I by reference
rendition-set I mask —longword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$PUT_LINE display-id ,text [,line-advance] [,rendition-set]
[,rendition-complement] [,wrap-flag] [,char-set] [,direction]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor
line-advance I longword signed I longword integer (signed) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference

RTL-54

Run-Time Library Routines

rendition-complement I mask—longword I longword (unsigned) I read only I by reference
wrap-flag I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
direction I longword_unsigned I longword (unsigned) I read only I by reference
SMG$PUT—LINE—HIGHWIDE display-id ,text [,line-adv] [,rendition-set]
[,rendition-complement] [,wrap-flag] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
text 1 char_string I character string I read only I by descriptor
line-adv I longword—signed I longword integer (signed) I read only I by reference
rendition-set I longword—unsigned I longword (unsigned) I read only I by reference
rendition-complement I longword—unsigned I longword (unsigned) I read only I by
reference
wrap-flag I longword—unsigned I longword (unsigned) I read only I by reference
char-set I longword—signed I longword integer (signed) I read only I by reference
SMG$PUT—LINE—WIDE display-id ,text [,line-advance] [,rendition-set]
[,rendition-complement] [,wrap-flag] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
text I char—string I character string I read only I by descriptor
line-advance I longword—signed I longword integer (signed) I read only I by reference
rendition-set I mask—long word I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
wrap-flag I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$PUT—PASTEBOARD pasteboard-id ,p-rtn ,p-prm ,p-ff-flag
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
p-rtn I longword—unsigned I procedure entry mask I read only I by reference
p-prm 1 user—arg I longword integer (signed) I read only I by reference
p-ff-flag I mask—longword I longword (unsigned) I read only I by reference
SMG$PUT-VIRTUAL-DISPLAY-ENCODED display-id ,encoded-length
,encoded-text [,line-number] [,column-number] [,placeholder-arg] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
encoded-length I longword—unsigned I longword (unsigned) I read only I by reference
encoded-text I address 1 unspecified I read only I by reference

Run-Time Library Routines

rtl-55

line-number I longword—signed I longword integer (signed) I read only I by reference
column-number I longword—signed I longword integer (signed) I read only I by reference
placeholder-arg I longword_unsigned I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$PUT_WITH—SCROLL display-id [,text] [,direction] [,rendition-set]
[,rendition-complement] [,wrap-flag] [,char-set]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
text I char_string I character string I read only I by descriptor
direction I longword—unsigned I longword (unsigned) I read only I by reference
rendition-set I mask —longword I longword (unsigned) 1 read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
wrap-flag I mask—longword I longword (unsigned) I read only I by reference
char-set I longword—unsigned I longword (unsigned) I read only I by reference
SMG$READ—COMPOSED—LINE keyboard-id ,key-table-id ,received-text
[,prompt-string] [,received-string-length] [,display-id] [,function-keys-flag] [,ini-string]
[,timeout] [,rendition-set] [,rendition-complement] [,terminator-code]
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
key-table-id I longword—unsigned I longword (unsigned) I read only I by reference
received-text I char—string I character string I write only I by descriptor
prompt-string I char—string I character string I read only I by descriptor
received-string-length I word—unsigned I word (unsigned) I write only I by reference
display-id I longword—unsigned I longword (unsigned) I read only I by reference
function-keys-flag I longword—unsigned I longword (unsigned) I read only I by reference
ini-string I char—string 1 character string I read only I by descriptor
timeout I longword—signed I longword (signed) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
terminator-code I word—unsigned I word (unsigned) I write only I by reference
SMG$READ JROM__DISPLAY display-id ,returned-string [,terminator-string][,row]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
returned-string I char—string I character string I write only I by descriptor
terminator-string I char—string I character string I read only I by descriptor
row I longword—signed I longword (signed) I read only I by reference

RTL-56

Run-Time Library Routines

SMG$READ_KEYSTROKE keyboard-id ,terminator-code [,prompt-string] [,timeout]
[,display-id] [,rendition-set] [,rendition-complement]
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
terminator-code I word—unsigned I word (unsigned) I write only I by reference
prompt-string I char_string I character string I read only I by descriptor
timeout I longword signed I longword (signed) I read only I by reference
display-id I longword—unsigned I longword (unsigned) I read only I by reference
rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
SMG$READ—STRING keyboard-id ,received-text [,prompt-string] [,max-length]
[,modifiers] [,timeout] [,terminator-set] [,received-string-length] [,terminator-code]
[,display-id] [,ini-string] [,rendition-set] [,rendition-complement]
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
received-text I char_string I character string I write only I by descriptor
prompt-string I char—string I character string I read only I by descriptor
max-length I longword—signed I longword integer (signed) I read only I by reference
modifiers I mask—longword I longword (unsigned) I read only I by reference
timeout I longword—signed I longword integer (signed) I read only I by reference
terminator-set I char—string I character string I read only I by descriptor, fixed length
received-string-length I word—unsigned I word (unsigned) I write only I by reference
terminator-code I word—unsigned I word (unsigned) I write only I by reference
display-id I longword—unsigned I longword (unsigned) I read only I by reference
ini-string I char—string I character string I read only I by descriptor
rendition-set I mask—longword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference
SMG$READ-_VERIFY keyboard-id ,out-string ,in-string ,pic-string ,fill-char
,clear-char [,prompt-string] [,modifiers] [,timeout] [,terminator-set] [,ini-offset]
[,terminator-code] [,display-id] [,alt-echo-string] [,alt-display-id] [,rendition-set]
[,rendition-complement]
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
out-string I char—string I character string I write only I by descriptor
in-string I char—string I character string I write only I by descriptor
pic-string I char—string I character string I read only I by descriptor
fill-char I char—string I character string I read only I by descriptor
clear-chari char—string I character string I read only I by descriptor

Run-Time Library Routines

rtl-57

prompt-string I char_string I character string I read only I by descriptor
modifiers I mask—longword I longword (unsigned) I read only I by reference
timeout I longword—signed I longword (signed) I read only I by reference
terminator-set I char_string I character string I read only I by descriptor, fixed length
ini-offset I longword—signed I longword (signed) I read only I by reference
terminator-code I word—unsigned I word (unsigned) I write only I by reference
display-id I longword—unsigned I longword (unsigned) I read only I by reference
alt-echo-string I char_string I character string I read only I by descriptor
alt-display-id I longword—signed I longword (signed) I read only I by reference
rendition-set I mask_Jongword I longword (unsigned) I read only I by reference
rendition-complement I mask—longword I longword (unsigned) I read only I by reference

SMG$REPAINT_LINE pasteboard-id ,row-start [,num-of-lines]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
row-start I longword—signed I longword (signed) I read only I by reference
num-of-lines I longword—signed I longword (signed) I read only I by reference

SMG$REPAINT_SCREEN pasteboard-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference

SMG$REPASTE—VIRTUAL--DISPLAY display-id ,pasteboard-id ,pb-row
,pb-column [,top-display-id]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
pb-row I longword—signed I longword integer (signed) I read only I by reference
pb-column I longword—signed I longword integer (signed) I read only I by reference
top-display-id I longword—unsigned I longword (unsigned) I read only I by reference

SMG$REPL ACE-INPUT-LINE keyboard-id [,out-line] [,num-of-lines]
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
out-line I char—string I character string I read only I by descriptor
num-of-lines I byte—unsigned I byte (unsigned) I read only I by reference

SMG$RESTORE—PHYSICAL—SCREEN pasteboard-id ,saved-display-id
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
saved-display-id I longword—unsigned I longword (unsigned) I read only I by reference

RTL-58

Run-Time Library Routines

SMG$RETURN_CURSOR_POS display-id ,row-number ,column-number
display-id I longword—unsigned I longword (unsigned) I read only I by reference
row-number I longword—signed I longword integer (signed) I write only I by reference
column-number I longword—signed I longword integer (signed) I write only I by reference

SMG$RETURN _INPUT_LINE keyboard-id ,out-line [,match-string] [,line-num]
[,out-length]
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
out-line I char—string I character string I write only I by descriptor
match-string I char—string I character string I read only I by descriptor
line-num I byte—unsigned I byte (unsigned) I read only I by reference
out-length I word—unsigned I word (unsigned) I write only I by reference

SMG$RING__BELL display-id [,number-of-times]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
number-of-times I longword—signed I longword integer (signed) I read only I by reference

SMG$SAVE__PHYSICAL-«SCREEN pasteboard-id ,saved-display-id
[,desired-row-start] [,desired-row-end]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
sa ved-display-id I longword—unsigned I longword (unsigned) I write only I by reference
desired-row-start I longword—signed I longword integer (signed) I read only I by reference
desired-row-end I longword—signed I longword integer (signed) I read only I by reference

SMG$SCROLL _DISPLAY_AREA display-id [,starting-row ,starting-column]
[,height] [,width] [,direction] [,count]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
starting-row I longword—signed I longword integer (signed) I read only I by reference
starting-column I longword—signed I longword integer (signed) I read only I by reference
height! longword—signed I longword integer (signed) I read only I by reference
width I longword—signed I longword integer (signed) I read only I by reference
direction I longword—unsigned I longword (unsigned) I read only I by reference
count I longword—signed I longword integer (signed) I read only I by reference

Run-Time Library Routines

rtl-59

SMG$SET_BROADCAST_TRAPPING pasteboard-id [,AST-routine]
[, AST-argument]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
AST-routine I ast_procedure I procedure entry mask I read only I by reference
AST-argument I user_arg I longword (unsigned) I read only I by value
SMG$SET_CURSOR_ABS display-id [,row] [,column]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
row I longword—signed I longword integer (signed) I read only I by reference
column I longword—signed I longword integer (signed) I read only I by reference
SMG$SET_CURSOR_MODE pasteboard-id ,cursor-mode
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
cursor-mode I boolean I longword (unsigned) I read only I by reference
SMG$SET_CURSOR_REL display-id [,delta-row] [,delta-column]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
delta-row I longword—signed I longword integer (signed) I read only I by reference
delta-column I longword—signed I longword integer (signed) I read only I by reference
SMG$SET-DEFAULT-STATE key-table-id [,new-state] [,old-state]
key-table-id I longword—unsigned I longword (unsigned) I read only I by reference
new-state I char—string I character string I read only I by descriptor
old-state I char—string I character string I write only I by descriptor
SMG$SET—DISPLAY-_SCROLL __REGION display-id [,starting-line] [,ending-line]
display-id I longword—unsigned I longword (unsigned) I read only I by reference
starting-line I longword—signed I longword integer (signed) I read only I by reference
ending-line I longword—signed I longword integer (signed) I read only I by reference
SMG$SET_KEYPAD_MODE keyboard-id ,new-mode
keyboard-id I longword—unsigned I longword (unsigned) I read only I by reference
new-mode I longword—unsigned I longword (unsigned) I read only I by reference

RTL-60

Run-Time Library Routines

SMG$SET_OUT_OF_BAND_ASTS pasteboard-id ,control-char-mask ,AST-routine
[, AST-argument]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
control-char-mask I mask—longword I longword (unsigned) I read only I by reference
AST-routine I ast_procedure I procedure entry mask I read only I by reference
AST-argument I user_arg I longword (unsigned) I read only I by value
SMG$SET—PHYSICAL—CURSOR pasteboard-id ,pb-row ,pb-column
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
pb-row I longword—unsigned I longword (unsigned) I read only I by reference
pb-column I longword—unsigned I longword (unsigned) I read only I by reference
SMG$SNAPSHOT pasteboard-id [,ff-flag]
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
ff-flag I boolean I longword (unsigned) I read only I by reference
SMG$UNPASTE-VIRTUAL-DISPLAY display-id ,pasteboard-id
display-id I longword—unsigned I longword (unsigned) I read only I by reference
pasteboard-id I longword—unsigned I longword (unsigned) I read only I by reference
STR$ADD asign ,aexp ,adigits ,bsign ,bexp ,bdigits ,csign ,cexp ,cdigits
asign I longword—unsigned I longword (unsigned) I read only I by reference
aexp I longword—signed I longword integer (signed) I read only I by reference
adigits I char—string I character string I read only I by descriptor
bsign I longword—unsigned I longword (unsigned) I read only 1 by reference
bexp I longword—signed I longword integer (signed) I read only I by reference
bdigits I char—string I character string I read only I by descriptor
csign I longword—signed I longword integer (signed) I write only I by reference
cexp I longword_signed I longword integer (signed) I write only I by reference
cdigits I char—string I character string I write only I by descriptor
STR$ANALYZE—SDESC inp-dsc ,len ,data-adr
JSB entry: STR$ANALYZE_SDESC-R1
inp-dsc I char—string I character string I read only I by descriptor
len I word—signed I word integer (signed) I write only I by reference for CALL entry point,
by value for JSB entry point
data-adr I address I longword (unsigned) I write only I by reference for CALL entry point,
by reference for JSB entry point

Run-Time Library Routines

STR$APPEND dst-str ,src-str
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
STR$CASE_BLIND_COMPARE srcl-str ,src2-str
srcl-str I char_string I character string I read only I by descriptor
src2-str I char_string I character string I read only I by descriptor
STR$COMPARE srcl-str ,src2-str
srcl-str I char_string I character string I read only I by descriptor
src2-str I char__string I character string I read only I by descriptor
STR$COMPARE_EQL srcl-str ,src2-str
srcl-str I char__string I character string I read only I by descriptor
src2-str I char_string I character string I read only I by descriptor
STR$COMPARE—MULTI srcl-str ,src2-str [,case-blind-flag] [,foreign-lang]
srcl-str I char_string I character string I read only I by descriptor
src2-str I char_string I character string I read only I by descriptor
case-blind-flag I mask—longword I longword (unsigned) I read only I by value
foreign-langllongword—unsignedllongword (unsigned) I read only I by value
STR$CONCAT dst-str ,srcl-str [... ,srcn-str]
dst-str I char_string I character string I write only I by descriptor
srcl-str I char_string I character string I read only I by descriptor
srcn-str I char_string I character string I read only I by descriptor
STR$COPY—DX dst-str ,src-str
JSB entry: STR$COPY_DX_R8
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
STR$COPY—R dst-str ,src-len ,src-str
JSB entry: STR$COPY_R_R8
dst-str I char_string I character string I write only I by descriptor
src-len I word—unsigned I word (unsigned) I read only I by reference
src-str I char_string I character string I read only I by reference

RTL-61

RTL-62

Run-Time Library Routines

STR$DIVIDE asign ,aexp ,adigits ,bsign ,bexp ,bdigits ,tot-digits ,rnd-trunc ,csign
,cexp ,cdigits
asign I longword—unsigned I longword (unsigned) I read only I by reference
aexp I longword—signed I longword integer (signed) I read only I by reference
adigitsichar—stringinum. string, unsigned I read only I by descriptor
bsign I longword—unsigned I longword (unsigned) I read only I by reference
bexp I longword—signed I longword integer (signed) I read only I by reference
bdigitsichar—stringinum. string, unsigned I read only I by descriptor
tot-digits I longword—signed I longword integer (signed) I read only I by reference
rnd-trunc I longword—unsigned I aligned bit string I read only I by reference
csign I longword—signed I longword integer (signed) I write only I by reference
cexp I longword—signed I longword integer (signed) I write only I by reference
cdigitsichar—stringinum. string, unsigned I write only I by descriptor
STR$DUPL>.CHAR dst-str [,length] [,char]
JSB entry: STR$DUPL_CHAR_R8
dst-str I char—string I character string I write only I by descriptor
length I longword—signed I longword integer (signed) I read only I by reference
char I byte—unsigned I byte (unsigned) I read only I by reference
STR$FIND_JIRST_JN_SET src-str ,set-of-chars
src-str I char—string I character string I read only I by descriptor
set-of-chars I char—string I character string I read only I by descriptor
STR$FIND_FIRST-NOT-IN-_SET src-str ,set-of-chars
src-str I char—string I character string I read only I by descriptor
set-of-chars I char—string I character string I read only I by descriptor
STR$FIND—EIRST—SUBSTRING src-str ,index ,sub-string-index ,sub-stringl ...
[,sub-stringn]
src-str I char—string I character string I read only I by descriptor
index I longword_signed I longword integer (signed) I write only I by reference
sub-string-index I longword_signed I longword integer (signed) I write only I by reference
sub-string 11 char—string I character string I read only I by descriptor
sub-stringn I char—string I character string I read only I by descriptor

Run-Time Library Routines

STR$FREE1_DX dsc-adr
JSB entry: STR$FREE1_DX_R4
dsc-adr I char_string I character string (unsigned) I modify I by descriptor
STR$GET1_DX len ,str
JSB entry: STR$GET1_DX_R4
len I word—unsigned I word (unsigned) I read only I by reference
str I char_string I character string I modify I by descriptor
STR$LEFT dst-str ,src-str ,end-pos
entry: STR$LEFT_R8
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
end-pos I longword—signed I longword integer (signed) I read only I by reference
STR$LEN_EXTR dst-str ,src-str ,start-pos ,length
JSB entry: STR$LEN_EXTR_R8
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
start-pos I longword—signed I longword integer (signed) I read only I by reference
length I longword—signed I longword integer (signed) I read only I by reference
STR$MATCH_WILD cand-str ,pattem-str
cand-str I char_string I character string I read only I by descriptor
pattern-str I char_string I character string I read only I by descriptor
STR$MUL asign ,aexp ,adigits ,bsign ,bexp ,bdigits ,csign ,cexp ,cdigits
asign I longword—unsigned I longword (unsigned) I read only I by reference
aexp I longword—signed I longword integer (signed) I read only I by reference
adigitsichar—stringinum. string, unsigned I read only I by descriptor
bsign I longword—unsigned I longword (unsigned) I read only I by reference
bexp I longword—signed I longword integer (signed) I read only I by reference
bdigitsichar—stringinum. string, unsigned I read only I by descriptor
csign I longword—signed I longword integer (signed) I write only I by reference
cexp I longword—signed I longword integer (signed) I write only I by reference
cdigitsichar—stringinum. string, unsigned I write only I by descriptor

RTL-63

RTL-64

Run-Time Library Routines

STR$POSITION src-str ,sub-str [,start-pos]
JSB entry: STR$POSITION_R6
src-str I char_string I character string I read only I by descriptor
sub-str I char_string I character string I read only I by descriptor
start-pos I longword—signed I longword integer (signed) I read only I by reference
STR$POS_EXTR dst-str ,src-str ,start-pos ,end-pos
JSB entry: STR$POS_EXTR_R8
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
start-pos I longword—signed I longword integer (signed) I read only I by reference for CALL
entry point, by value for JSB entry point
end-pos I longword—signed I longword integer (signed) I read only I by reference for CALL
entry point, by value for JSB entry point
STR$PREFIX dst-str ,src-str
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
STR$RECIP asign ,aexp ,adigits ,bsign ,bexp ,bdigits ,csign ,cexp ,cdigits
asign I longword—unsigned I longword (unsigned) I read only I by reference
aexp I longword—signed I longword integer (signed) I read only I by reference
adigitslchar_stringlnum. string, unsigned I read only I by descriptor
bsign I longword—unsigned I longword (unsigned) I read only I by reference
bexp I longword—signed I longword integer (signed) I read only I by reference
bdigitsichar—stringinum. string, unsigned I read only I by descriptor
csign I longword—signed I longword integer (signed) I write only I by reference
cexp I longword—signed I longword integer (signed) I write only I by reference
cdigitsichar—stringinum. string, unsigned I write only I by descriptor
STR$REPLACE dst-str ,src-str ,start-pos ,end-pos ,rpl-str
JSB entry: STR$REPLACE_R8
dst-str I char_string I character string I write only I by descriptor
src-str I char—string I character string I read only I by descriptor
start-pos I longword—signed I longword integer (signed) I read only I by reference for CALL
entry point, by value for JSB entry point
end-pos I longword—signed I longword integer (signed) I read only I by reference for CALL
entry point, by value for JSB entry point
rpl-str I char—string I character string I read only I by descriptor

Run-Time Library Routines

rtl-65

STR$RIGHT dst-str ,src-str ,start-pos
JSB entry: STR$RIGHT_R8
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
start-pos I longword—signed I longword integer (signed) I read only I by reference for CALL
entry point, by value for JSB entry point
STR$ROUND places ,trunc-flg ,asign ,aexp ,adigits ,csign ,cexp ,cdigits
places I longword—signed I longword integer (signed) I read only I by reference
trunc-flg I longword—unsigned I longword (unsigned) I read only I by reference
asign I longword—unsigned I longword (unsigned) I read only I by reference
aexp I longword—signed I longword integer (signed) I read only I by reference
adigitsichar—stringinum. string, unsigned I read only I by descriptor
csign I longword—signed I longword integer (signed) I write only I by reference
cexp I longword—signed I longword integer (signed) I write only I by reference
cdigitsichar—stringinum. string, unsigned I write only I by descriptor
STR$TRANSLATE dst-str ,src-str ,trans-str ,match-str
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
trans-str I char_string I character string I read only I by descriptor
match-str I char_string I character string I read only I by descriptor
STR$TRIM dst-str ,src-str [,out-len]
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor
out-len I word—unsigned I word (unsigned) I write only I by reference
STR$UPCASE dst-str ,src-str
dst-str I char_string I character string I write only I by descriptor
src-str I char_string I character string I read only I by descriptor

Callable Utility Routines
CLI$DCL—PARSE command-string ,table [,param-routine] [,prompt-routine]
[,prompt-string]
command-string I char_string I character string I read only I by descriptor-fixed length
table I char_string I unspecified I read only I by reference
param-routine I procedure I procedure entry mask I read only I by reference
prompt-routine I procedure I procedure entry mask I read only I by reference
prompt-string I char_string I character string I read only I by descriptor
CLI$DISPATCH [userarg]
userarg I longword—unsigned I longword (unsigned) I read only I by value
CLI$GET_VALUE entity_desc ,retdesc [,retlength]
entity_desc I char_string I character string I read only I by descriptor
retdesc I char_string I character string I write only I by descriptor
retlength I word—unsigned I word (unsigned)! write only I by reference
CLI$PRESENT entity_desc
entity_desc I char_string I character string I read only I by descriptor
CONV$CONVERT [status-block-address] [,flags]
status-block-address I vector_longword_unsigned I longword (unsigned) I write only I by
reference
flags I mask—longword Hong word (unsigned) I read only I by reference

UTIL-2

Callable Utility Routines

CONV$PASS_FILES input-file-spec ,output-file-spec [,fdl-file-spec] [,exception-filespec] [/flags]
input-file-spec I char_string I character-coded text string I read only I by descriptor-fixed
length string descriptor
output-file-spec I char_string I character-coded text string I read only I by descriptor-fixed
length string descriptor
fdl-file-spec I char_string I character-coded text string I read only I by descriptor-fixed
length string descriptor
exception-file-spec I char_string I character-coded text string I read only I by descriptorfixed length string descriptor
flagsimask—longwordllongword (unsigned) I read only I by reference
CONV$PASS_OPTIONS [parameter-list-address] [,flags]
parameter-list-address I vector_longword_unsigned I longword (unsigned) I read only I by
reference
flagsimask—longwordllongword (unsigned) I read only I by reference
CONV$RECLAIM input-file-spec [,statistics_blk]
input-file-spec I char—string I character-coded text string I read only I by descriptor-fixed
length string descriptor
statistics—blk I vector—longword—unsigned I longword (unsigned) I write only I by reference
DCX$ ANALYZE-DATA context ,record
context I context I longword (unsigned) I read only I by reference
record I char—string I character string I read only I by descriptor
DCX$ ANALYZE-DONE context
context I context I longword I write only I by reference
DCX$ANALYZE—INIT context [,item-code ,item-value]
The second and third arguments are both optional but, if specified, must be specified
together. Further, this pair of arguments may be repeated, with different values, in
the same call.
context I context I longword (unsigned) I write only I by reference
item-code I longword—unsigned I longword (unsigned) I read only I by reference
item-value I longword—unsigned I longword (unsigned) I read only I by reference

Callable Utility Routines

util-3

DCX$COMPRESS—DATA context ,in-rec ,out-rec [,out-length]
context I context I longword (unsigned) I read only I by reference
in-rec I char_string I character string I read only I by descriptor
out-rec I char_string I character string I write only I by descriptor
out-length I word—signed I word integer (signed) I write only I by reference
DCX$COMPRESS_DONE context
context I context I longword (unsigned) I write only I by reference
DCX$COMPRESS_INIT context ,map
context I context I longword (unsigned) I write only I by reference
map I address I longword (unsigned) I read only I by reference
DCX$EXPAND_DATA context ,m-rec ,out-rec [,out-length]
context I context I longword (unsigned) I read only I by reference
in-rec I char_string I character string I read only I by descriptor
out-rec I char_string I character string I write only I by descriptor
out-length I word—signed I word integer (signed) I write only I by reference
DCX$EXPAND_DONE context
context I context I longword (unsigned) I write only I by reference
DCX$EXPAND__INIT context ,map
context I context I longword (unsigned) I write only I by reference
map I address I longword (unsigned) I read only I by reference
DCX$MAKE_MAP context ,map-addr [,map-size]
context I context I longword (unsigned) I write only I by reference
map-addr I address I longword (unsigned) I write only I by reference
map-size I longword—signed I longword (unsigned)! write only I by reference
EDT$EDIT in_file [,out_file] [,com_file] [,jou_file] [,options] [,fileio] [,workio] [,xlate]
in—file I char_string I character-coded text string I read only I by descriptor
out—file I char—string I character-coded text string I read only I by descriptor
com—file I char—string I character-coded text string I read only I by descriptor
jou—file I char—string I character-coded text string I read only I by descriptor
options I mask—longword I aligned bit string I read only I by reference

UTIL-4

Callable Utility Routines

fileiol vector_longword_unsignedlbound procedure value I function call I by reference
workiol vector_longword_unsignedlbound procedure value I function call I by reference
xlatel vector_longword_unsignedlbound procedure value I function call I by reference
FILEIO code ,stream ,record ,rhb
codellongword—unsignedllongword (unsigned) I read only I by reference
streamllongword—unsignedllongword (unsigned) I read only I by reference
record I char_string I character-coded text string I modify I by descriptor
rhb I char_string I character-coded text string I modify I by descriptor
WORKIO code ,recordno ,record
code I longword—unsigned I longword (unsigned) I read only I by reference
recordnollongword—signedllongword integer (signed) I read only I by reference
record I char_string I character string I modify I by descriptor
XLATE string
string I char_string I character-coded text string I modify I by descriptor
FDL$CREATE fdl_desc [,file_name] [,default_name] [,result^name] [,fid_block]
[,flags] [,stmnt_num] [,retlen] [,sts] [,stv]
fdl_desc I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
file_name I char_string I character-coded text string I read only I by descriptor-fixed length
string descriptor
default—name I char_string I character-coded text string I read only I by descriptor-fixed
length string descriptor
result-name I char_string I character-coded text string I write only I by descriptor-fixed
length string descriptor
fid—block I vector—longword—unsigned I longword (unsigned)! write only I by reference
flags I mask—longword llongword (unsigned) I read only I by reference
stmnt—numilongword_unsigned llongword (unsigned) I write only I by reference
retlen llongword—unsigned llongword (unsigned)! write only I by reference
stsllongword—unsigned I longword—unsigned I write only I by reference
stv I longword—unsigned I longword (unsigned)! write only I by reference

Callable Utility Routines

util-5

FDL$GENERATE flags ,fab^pointer ,rab_pointer [,fdl_file_dst] [,fdl_file_resnam]
[,fdl_str_dst] [,bad_blk_addr] [,retlen]
flagsimask—longwordllongword (unsigned) I read only I by reference
fab_pointerladdressllongword (unsigned) I read only I by reference
rab—pointerladdressllongword (unsigned) I read only I by reference
fdl_file_dst I char_string I character-coded text string I read only I by descriptor
fdl_file_resnam I char_string I character-coded text string I write only I by descriptor-fixed
length string descriptor
fdl_str_dst I char_string I character-coded text string I write only I by descriptor-fixed
length string descriptor
bad_blk_addrladdressllongword (unsigned)! write only I by reference
retlenllongword—unsignedllongword (unsigned)!write only!by reference
FDL$PARSE fdl_spec ,fdl_fab_pointer ,fdl__rab_pointer [,flags] [,dflt_fdl_spc]
[,stmnt_num]
fdl—Spec!char_string!character-coded text string!read only !by descriptor-fixed length
string descriptor
fdl—fab—pointer!address!longword (unsigned)!write only!by reference
fdl—rab—pointer!address!longword (unsigned)!write only!by reference
flags! mask—longword! long word (unsigned)! read only! by reference
dflt—fdl—spc!char—string!character-coded text string!read only !by descriptor-fixed
length string descriptor
stmnt—num!longword—unsigned!longword (unsigned)!write only!by reference
FDL$RELEASE [fab_pointer] [,rab_pointer] [,flags] [,badblk_addr]
fab—pointer!address!longword (unsigned)!read only!by reference
rab—pointer!address!longword (unsigned)!read only!by reference
flags!mask—longword!longword (unsigned)!read only!by reference
badblk—addr!address!longword (unsigned)!write only!by reference
LBR$CLOSE library-index
library-index!longword—unsigned!longword (unsigned)!read only!by reference
LBR$DELETE_DATA library-index ,txtrfa
library-index!longword—unsigned!longword (unsigned) !read only!by reference
txtrfa!vector—longword—unsigned!longword (unsigned)!read only! by reference
LBR$DELETE-_KEY library-index ,key-name
library-index!longword—unsigned!longword (unsigned)!read only !by reference
key-name!longword—unsigned!longword (unsigned)!read only!by reference

UTIL-6

Callable Utility Routines

LBR$FIND library-index ,txtrfa
library-index I longword—unsigned I longword (unsigned) I read only I by reference
txtrfal vector_longword_unsignedllongword (unsigned) I read only I by reference
LBR$FLUSH library-index ,block-type
library-index I longword—unsigned I longword (unsigned) I read only I by reference
block-type I longword_unsigned I longword (unsigned) I read only I by value
LBR$GET—HEADER library-index ,retary
library-index I longword—unsigned I longword (unsigned) I read only I by reference
retary I vector—longword—signed I longword (signed) I write only I by reference
LBR$GET_HELP library-index [,line-width] [,routine] [,data] [,key-l] [,key-2...
,key-10]
If the key-1 descriptor is 0, or if it is not present, LBR$GET_HELP will assume that
the key-1 name is "HELP," and it ignores all the other keys. For key-2 through key10, a descriptor address of 0, or a length of 0, or a string address of 0 will terminate
the list.
library-index I longword—unsigned I longword (unsigned) I read only I by reference
line-width I longword—signed I longword (signed) I read only I by reference
routine I procedure I procedure entry mask I read only I by reference
data I longword—unsigned I longword (unsigned) I write only I by reference
key-l,key-2,...,key-101 longword—signed I longword (signed) I read only I by descriptor
LBR$GET_HISTORY library-index ,action-routine
library-index I longword_unsigned I longword (unsigned) I read only I by reference
action-routine I procedure I procedure entry mask I modify I by reference
LBR$GET_INDEX library-index ,index-number ,routine-name [,match-desc]
library-index I longword—unsigned I longword (unsigned) I read only I by reference
index-number I longword_unsigned I longword (unsigned) I read only I by reference
routine-name I procedure I procedure entry mask I read only I by reference
match-desc I char—string I character string I read only I by descriptor
LBR$GET_RECORD library-index [,inbufdes] [,outbufdes]
library-index I longword—unsigned I longword (unsigned) I read only I by reference
inbufdesl char—string I character string I write only I by descriptor
outbufdes I char—string I character string I write only I by descriptor

Callable Utility Routines

util-7

LBR$INI—CONTROL library-index ,func [,type] [,namblk]
library-index I longword—unsigned I longword (unsigned)! write only! by reference
fund function—code llongword (unsigned) I read only I by reference
typellongword—unsignedllongword (unsigned) I read only I by reference
namblk I nam I longword (unsigned) I read only I by reference
LBR$INSERT—KEY library-index ,key-name ,txtrfa
library-index llongword—unsigned llongword (unsigned) I read only I by reference
key-name I longword—unsigned I longword (unsigned)! write only I by reference
txtrfa I vector—longword—unsigned I longword (unsigned) I modify I by reference
LBR$LOOKUP—KEY library-index ,key-name ,txtrfa
library-index I longword—unsigned I longword (unsigned) I read only I by reference
key-name I longword—unsigned I longword (unsigned) I read only I by reference
txtrfa I vector—longword—unsigned I longword (unsigned) I write only I by reference
LBR$OPEN library-index [,fns] [,create-options] [,dns] [,rlfna] [,rns] [,rnslen]
The fns argument and the create-options argument are required in some
circumstances. See the descriptions of these arguments for more information.
library-index I longword—unsigned I longword (unsigned) I read only I by reference
fns I char—string I character string I read only I by descriptor
create-optionsivector—longword—unsigned I longword (unsigned) I read only I by
reference
dns I char—string I character string I read only I by descriptor
rlfna I longword—unsigned I longword (unsigned) I read only I by reference
rns I char—string I character string I write only I by descriptor
rnslen I longword—signed I longword (signed) I write only I by reference
LBR$OUTPUT_HELP output-routine [,output-width] [,line-desc] [,library-name]
[,flags] [,input-routine]
output-routine I procedure I procedure entry mask I write only I by reference
output-width I longword—signed I longword (signed) I read only I by reference
line-desc I char—string I character string I read only I by descriptor
library-name I char—string I character string I read only I by descriptor
flags I mask—longword I longword (unsigned) I read only I by reference
input-routine I procedure I procedure entry mask I read only I by reference
LBR$PUT_END library-index
library-index I longword_unsigned I longword (unsigned) I read only I by reference

UTIL-8

Callable Utility Routines

LBR$PUT__HISTORY library-index ,record-desc
library-index I longword—unsigned I longword (unsigned) I read only I by reference
record-desc I char_string I character string I read only I by descriptor
LBR$PUT__RECORD library-index ,bufdes ,txtrfa
library-index I longword_unsigned I longword (unsigned) I read only I by reference
bufdes I char_string I character string I read only I by descriptor
txtrfa I vector_longword_unsigned I longword (unsigned)! write only I by descriptor
LBR$REPLACE_JCEY library-index ,key-name ,oldrfa ,newrfa
library-index llongword—unsignedllongword (unsigned) I read only I by reference
key-name I char_string I character string I read only I by descriptor
key-name llongword—unsignedllongword (unsigned) I read only! by reference
oldrfaIvector_longword_unsignedllongword (unsigned)!write only !by reference
newrfa!vector_longword_unsigned!longword (unsigned)!read only !by reference
LBR$RET_RMSSTV
LBR$SEARCH library-index ,mdex-number ,rfa-to-find ,routine-name
library-index!longword_unsigned!longword (unsigned)!read only !by reference
index-number!longword_unsigned!longword (unsigned)!read only !by reference
rfa-to-find!vector_longword_unsigned!longword (unsigned)!write only !by reference
routine-name!procedure!procedure entry mask!read only!by reference
LBR$SET-_INDEX library-index ,mdex-number
library-index!longword_unsigned!longword (unsigned)!read only !by reference
index-number!longword_unsigned!longword (unsigned)!read only!by reference
LBR$SET_LOCATE library-index
library-index!longword_unsigned!longword (unsigned)!read only !by reference
LBR$SET_MODULE library-index ,rfa [,bufdesc] [,buflen] [,updatedesc]
library-index!longword_unsigned!longword (unsigned)!read only !by reference
rfa!vector_longword_unsigned!longword (unsigned)!write only !by reference
bufdesc!char_string!character string!write only!by descriptor
buflen!longword_signed!longword (signed)!write only!by reference
updatedesc!char_string!character string!read only!by descriptor
LBR$SET_MOVE library-index
library-index I longword—unsigned! longword (unsigned)! read only! by reference

Callable Utility Routines

util-9

PSM$PRINT [streams] [,bufsiz] [,worksiz]
streams I longword—unsigned I longword (unsigned) I read only I by reference
bufsizilongword—unsignedllongword (unsigned) I read only I by reference
worksiz I longword—unsigned I longword (unsigned) I read only I by reference
PSM$READ_ITEM_DX request_id ,item ,buffer
request—id I address I longword (unsigned) I read only I by reference
item I longword—unsigned I longword (unsigned) I write only I by reference
buffer I char—string I character string I read only I by descriptor
PSM$REPLACE code ,routine
code I longword—unsigned I longword (unsigned) I read only I by reference
routine I procedure I procedure entry mask I read only I by reference
PSM$REPORT request—id [,status]
request—id I identifier I longword (unsigned) I read only I by reference
status I cond—value I longword (unsigned)! write only I by reference
USER-FORMAT-ROUTINE request-id ,work_area ,func ,func_desc_l
,func—arg—l ,func_desc_2 ,func—arg—2
The func—arg—1 and func—arg—2 arguments are not used in some cases; see the
Description section for more information.
request—id I identifier I longword (unsigned) I write only I by reference
work—area I address Hong word (unsigned) I write only I by reference
fund function—code llongword (unsigned)! write only! by reference
func—desc—1!char—string!character string!read only!by descriptor
func—arg—1!vector—byte—unsigned!byte (unsigned)!read only!by reference
func—desc—21 char—string! character string! read only! by reference
func—arg—2!vector—byte—unsigned!byte (unsigned)!read only! by reference
USER-INPUT-ROUTINE request—id ,work—area ,func ,funcdesc ,funcarg
request—id!identifier!longword (unsigned)!write only!by reference
work—area!address!longword (unsigned)!write only!by reference
func!function—code!longword (unsigned)!read only!by reference
funcdesc!char—string!character string!read only!by descriptor
funcarg!longword—unsigned!longword (unsigned)!read only!by reference

UTIL-10

Callable Utility Routines

USER-OUTPUT-ROUTINE request-id ,work—area ,func ,funcdesc ,funcarg
request—id I identifier I longword (unsigned)! write only I by reference
work—area I address llongword (unsigned) I write only I by reference
fund function—code llongword (unsigned) I read only I by reference
funcdesci char—string I character string I read only I by descriptor
funcarg I user—arg llongword (unsigned) I read only I by reference

SMB$CHECK_FOR«MESSAGE
SMB$INITIALIZE structure-level [,ast—routine] [,streams]
structure—level llongword—unsigned I longword (unsigned) I read only I by reference
ast—routine last—procedure I procedure entry mask I read only I by reference
streams I longword—unsigned I longword (unsigned) I read only I by reference

SMB$READ—MESSAGE stream ,buffer ,request
stream I longword—unsigned I longword (unsigned) I write only I by reference
buffer I char—string I character string I write only I by descriptor
request I identifier I longword (unsigned) I write only I by reference

SMB$READ—MESSAGE—ITEM message ,context ,item—code ,buffer [,size]
message I char—string I character string I read only I by descriptor
context I context I longword (unsigned) I read only I by reference
item—code I longword—unsigned I longword (unsigned) I write only I by reference
buffer I char—string I character string I read only I by descriptor
sizel word—unsigned I word (unsigned) I write only I by reference

SMB$SEND—TO—JOBCTL stream [,request] [,accounting] [,checkpoint]
[,device—status] [,error]
stream I longword—unsigned I longword (unsigned) I read only I by reference
request I identifier I longword (unsigned) I read only I by reference
accounting I char—string I character string I read only I by descriptor
checkpoint I char—string I character string I read only I by descriptor
device—status I longword—unsigned I longword (unsigned) I read only I by reference
errorl vector—longword—unsigned I longword (unsigned) I read only I by reference

Callable Utility Routines

util-11

SOR$BEGIN—MERGE [key-buffer] [,lrl] [,options] [,merge_order] [,user_compare]
[,user_equal] [,user_input] [,context]
key_bufferl vector_word_unsignedl word (unsigned) I read only I by reference
Irl I word—unsigned I word (unsigned) I read only I by reference
optionsimask—longwordllongword (unsigned) I read only I by reference
merge_orderlbyte_unsignedlbyte (unsigned) I read only I by reference
user_compare I procedure I procedure entry mask I function call I by reference
user_equal I procedure I procedure entry mask I function call I by reference
user_input I procedure I procedure entry mask I function call I by reference
context I context I longword (unsigned) I modify I by reference
SOR$BEGIN_.SORT [key_buffer] [,lrl] [,options] [,file_alloc] [,user_compare]
[,user_equal] [,sort—process] [,work—files] [,context]
key_bufferl vector_word_unsignedlword (unsigned) I read only I by reference
Irl I word—unsigned I word (unsigned) I read only I by reference
optionsimask—longwordllongword (unsigned) I read only I by reference
file—alloc I longword—unsigned I longword (unsigned) I read only I by reference
user—compare I procedure I procedure entry mask I function call I by reference
user—equal I procedure I procedure entry mask I function call I by reference
sort—process I byte—unsigned I byte (unsigned) I read only I by reference
work—files I byte—unsigned I byte (unsigned) I read only I by reference
context I context I longword (unsigned)! write only I by reference
SOR$END-SORT [context]
context I context I longword I write only I by reference
SOR$PASS—FILES [inp—desc] [,out—desc] [,org] [,rfm] [,bks] [,bls] [,mrs] [,alq] [,fop]
[,fsz] [,context]
inp—desc I char—string I character-coded text string I read only I by descriptor
out—desc I char—string I character-coded text string I read only I by descriptor
org I byte—unsigned I byte (unsigned) I read only I by reference
rfm I byte—unsigned I byte (unsigned) I read only I by reference
bks I byte—unsigned I byte (unsigned) I read only I by reference
bis I word—unsigned I word (unsigned) I read only I by reference
mrs I word—unsigned I word (unsigned) I read only I by reference
alq I longword—unsigned I longword (unsigned) I read only I by reference

UTIL-12

Callable Utility Routines

fopimask—longwordllongword (unsigned) I read only I by reference
fszibyte—unsignedibyte (unsigned) I read only I by reference
context I context I longword (unsigned)! write only I by reference
SOR$RELEASE_REC desc [,context]
desclchar_string I character-coded text string I read only I by descriptor
context I context I longword I modify I by reference
SOR$RETURN_REC desc [,length] [,context]
desc! char_string I character-coded text string I write only I by descriptor
length I word—unsigned I word (unsigned) I write only I by reference
context I context llongword (unsigned) I modify I by reference
SOR$SORT__MERGE [context]
context I context I longword (unsigned) I modify I by reference
SOR$SPEC_-FILE [spec_file] [,spec_buffer] [,context]
spec—file I char_string I character-coded text string I read-only I by descriptor
spec—buffer I char_string I character-coded text string I read-only I by descriptor
context I context I longword (unsigned) I modify I by reference
SOR$STAT code ,result [,context]
code I word—unsigned I word (unsigned) I read only I by reference
result llongword—unsigned llongword (unsigned) I write only I by reference
context I context llongword (unsigned) I modify I by reference
TPU$CLEANUP flags
flags I mask—longword I longword (unsigned) I read only I by reference
TPU$CLIPARSE string, fileio, calluser
string I char_string I character string I read only I by descriptor
fileio I vector—longword_unsigned I bound procedure value I read only I by descriptor
calluserivector—longword—unsigned I bound procedure value I read only I by descriptor
TPU$CONTROL
TPU$EDIT input, output
input I char—string I character string I read only I by descriptor
output I char—string I character string I read only I by descriptor

Callable Utility Routines

util-13

TPU$EXECUTE-COMMAND string
String I char_string I character string I read only I by value
TPU$EXECUTE JNIFILE
TPU$FILEIO code, stream, data
codellongword—unsignedllongword (unsigned) I read only I by reference
stream I unspecified I longword (unsigned) I modify I by reference
datalitem_list_3llongword (unsigned) I modify I by reference
TPU$HANDLER signal—vector, mechanism—vector
signal—vector I arg—list I longword (unsigned) I modify I by reference
mechanism—vector I arg—list I longword (unsigned) I read only I by reference
TPU$INITIALIZE callback
callbackivector—longword—unsigned I bound procedure value I read only I by descriptor
TPU$MESSAGE string
string I char—string I character string I read only I by descriptor
TPU$PARSEINFO fileio, calluser
fileiol vector—longword—unsigned I bound procedure value I read only I by descriptor
calluserl vector—longword—unsigned I bound procedure value I read only I by descriptor
TPU$TPU command
command I char—string I character string I read only I by descriptor
FILEIO code, stream, data
code I longword—unsigned I longword (unsigned) I read only I by reference
stream I unspecified I longword (unsigned) I modify I by reference
datalitem—list—31 longword (unsigned) I modify I by reference
HANDLER signal—vector, mechanism—vector
signal—vector I arg—list I longword (unsigned) I modify I by reference
mechanism—vector I arg—list I longword (unsigned) I read only I by reference
INITIALIZE callback
callbackivector—longword—unsigned I bound procedure value I read only I by reference

UTIL-14

Callable Utility Routines

USER integer, stringin, stringout
integerllongword—unsignedllongword (unsigned) I read only I by descriptor
stringin I char_string I character string I read only I by descriptor
stringout I char_string I character string I read only I by descriptor

VAX Record Management Services
RMS.1

RMS Control Blocks

Table RMS-1

FAB Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

<FALQ>

FILE ALLOCATION

Allocation quantity (

<FBID> 1

None

Block identifier

<FBKS>

FILE BUCKET_SIZE

Bucket size

<FBLN> 1

None

Block length

<FBLS>

2
_2

FILE MT_BLOCK_SIZE

Magnetic tape block

None

Channel access mod
protection

<FCTX>

FILE CONTEXT

Context

<FDEQ>

FILE EXTENSION

Default file extensio
quantity

<FDEV> 3

None

Device characteristic

<FDNA>

FILE DEFAULT_NAME

Default file specifica
string address

<FDNS>

FILE DEFAULT_NAME

Default file specifica
string size

<FCHAN_
MODE>

^Statically initialized field (by the VAX MACRO $FAB macro) to identify this control block as
^Two-bit field.
^ Field cannot be initialized by the VAX MACRO $FAB macro.

Field Offset

Size
(bytes)

FDL Attribute

Description

<FFAC>

ACCESS^

File access

<FFNA>

FILE NAME

File specification string
address

<FFNS>

FILE NAME

File specification string size

<FFOP>

FILE4

File-processing options

<FFSZ>

RECORD CONTROLFIELD-SIZE

Fixed length control area size

<FGBC>

FILE GLOBAL-BUFFERCOUNT

Global buffer count

<FIFI> 3

None

Internal file identifier

<FLNM>

None

Logical name translation
access mode

<FMRN>

FILE MAX-RECORDNUMBER

Maximum record number

<FMRS>

RECORD SIZE

Maximum record size

<FNAM>

None

Name block address

<FORG>

FILE ORGANIZATION

File organization

<FRAT>

RECORD^

Record attributes

<FRFM>

RECORD FORMAT

Record format

<FRTV>

FILE WINDOW-SIZE

Retrieval window size

<FSDC> 3

None

Secondary device
characteristics

<FSHR>

SHARING**

File sharing

<FSTS> 3

None

Completion status code

<FSTV> 3

None

Status values

<FXAB>

None

Extended attribute block
address

^Two-bit field.
^ Field cannot be initialized by the VAX MACRO $FAB macro.
Field contains options; corresponding FDL equivalents are listed in the description of the field.

Table RMS-2

NAM Block Fields

Field Offset

Size (bytes)

Description

<NBID> 1

Block identifier

<NBLN> 1

Block length

<NDEV_B> 2

Device string length

<NDEV_L> 2

Device string address

<ND1D> 2

Directory identification

<NDIR_B> 2

Directory string length

<NDIR_L> 2

Directory string address

<NDVI> 2

Device identification

<NESA>

Expanded string area address

<NESL> 2

Expanded string length

<NESS>

Expanded string area size

<NFID> 2

File identification

<NFNB> 2

File name status bits

<NNAME_B> 2

File name string length

<NNAME_L> 2

File name string address

<NNODE_B> 2

Node name string length

<NNODE_L> 2

Node name string address

<NNOP>

Name block options

<NRLF>

Related file NAM block address

<NRSA>

Resultant string area address

<NRSL> 2

Resultant string length

<NRSS>

Resultant string area size

<NTYPE_B> 2

File type string length

<NTYPE_L> 2

File type string address

<NVER_B> 2

File version string length

<NVER_L> 2

File version string address

<NWCC> 2

Wildcard context

^Statically initialized field (by the VAX MACRO $NAM macro) to identify this control block a
^ Field cannot be initialized by the VAX MACRO $NAM macro.

Table RMS-3

RAB Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

<RBID> 1

None

Block identifier

<RBKT>

CONNECT BUCKET-CODE

Bucket code

<RBLN> ’

None

Block length

<RCTX>

CONNECT CONTEXT

User context

<RFAB>

None

File access block address

<RISI> 2

None

Internal stream identifier

<RKBF>

None

Key buffer address

<RKRF>

CONNECT KEY_OF_
REFERENCE

Key of reference

<RKSZ>

None

Key size

<RMBC>

CONNECT MULTIBLOCKCOUNT

Multiblock count

<RMBF>

CONNECT MULTIBUFFERCOUNT

Multibuffer count

<RPBF>

None

Prompt buffer address

<RPSZ>

None

Prompt buffer size

<RRAC>

CONNECT^

Record access mode

<RRBF>

None

Record buffer address

<RRFA>

None

Record's file address

<RRHB>

None

Record header buffer

<RROP>

CONNECT^

Record-processing options

<RRSZ>

None

Record size

<RSTS> 2

None

Completion status code

<RSTV> 2

None

Status value

<RSTV0> 4

None

Low-order word status value

<RSTV2> 4

None

High-order word status value

<RTMO>

CONNECT TIMEOUTPERIOD

Timeout period

^Statically initialized field (by the VAX MACRO $RAB macro) to identify this control block as a RAB.
^Field cannot be initialized by VAX MACRO $RAB macro.
^ Field contains options; corresponding FDL equivalents are listed in the description of the field.
"^Alternate definition of <RSTV>

field.

Table RMS-3 (Cont.)

RAB Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

<RUBF>

None

User record area add

<RUSZ>

None

User record area size

<RXAB>

None

Next XAB address

Table RMS-4

XABALL Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

<XAID>

AREA n

Area identification n

<XALN>

AREA POSITION^

Alignment boundary

<XALQ>

AREA ALLOCATION

Allocation quantity

<XAOP>

AREAl

Allocation options

<XBKZ>

AREA BUCKET_SIZE

Bucket size

<XBLN> 2

None

Block length

<XCOD> 2

None

Type code

<XDEQ>

AREA EXTENSION

Default extension qu

<XLOC>

AREA POSITION

Location

<XNXT>

None

Next XAB address

<XRFI>

AREA POSITION FILE_ID
or FILE-NAME

Related file identifier

<XVOL>

AREA VOLUME

Related volume num

^ Field contains options; corresponding FDL equivalents are listed in the description of the fiel

2Statically initialized field (by the VAX MACRO $XABALL macro) to identify this control bloc
XABALL.

Table RMS-5

XABDAT Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

<XBDT> 1

DATE BACKUP

Backup date and time

<XBLN> 2

None

Block length

<XCDT> 1

DATE CREATION

Creation date and time

<XCOD> 2

None

Type code

<XEDT>

DATE EXPIRATION

Expiration date and time

<XNXT>

None

Next XAB address

<XRDT> 1

DATE REVISION

Revision date and time

<XRVN> 1

FILE REVISION

Revision number

^ Field cannot be initialized by the VAX MACRO $XABDAT macro.
^Statically initialized field (by the VAX MACRO $XABDAT macro) to identify this control block as a
XABDAT.

Table RMS-6

XABFHC Fields

Field Offset

Size
(bytes)

Description

<XATR> 1

Record attributes; equivalent to <FRAT>

<XBKZ> 1

Bucket size; equivalent to <FBKS>

<XBLN> 2

Block length

<XCOD> 2

Type code

<XDXQ> 1

Default file extension quantity; equivalent to <FDEQ>

<XEBK> 1

End-of-file block

<XFFB> 1

First free byte in the end-of-file block

<XGBC> 1

Default global buffer count

<XHBK> 1

Highest virtual block in the file; equivalent to
<FALQ>

<XHSZ> 1

Fixed-length control header size; equivalent to <FFSZ>

<XLRL> 1

Longest record length

^ Field cannot be initialized by the VAX MACRO $XABFHC macro.
^Statically initialized field (by the VAX MACRO $XABFHC macro) to identify this control block as a
XABFHC.

Table RMS-6 (Cont.)

XABFHC Fields

Field Offset

Size
(bytes)

Description

<XMRZ> 1

Maximum record size; equivalent to <FMRS>

<XNXT>

Next XAB address

<XRFO> 1

File organization and record format; combines
<FRFM> and <FORG>

<XSBN> 1

Starting logical block number for the file if it is
contiguous; otherwise this field is 0

<XVERLIMIT> 1

Version limit for the file

^ Field cannot be initialized by the VAX MACRO $XABFHC macro.

Table RMS-7

XABKEY Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

<XBLN> 1

None

Block length

<XCOD> 1

None

Type code

<XDAN>

KEY DATA_AREA

Data bucket are
number

<XDBS> 2

None

Data bucket size

<XDFL>

KEY DATA_FILL

Data bucket fill

<XDTP>

KEY TYPE3

Data type of the

<XDVB> 2

None

First data bucke
block number

<XFLG>

KEY3

Key options flag

<XIAN>

KEY INDEX_AREA

Index bucket ar
number

<XIBS> 2

None

Index bucket siz

<XIFL>

KEY INDEX _FILL

Index bucket fil

<XKNM>

KEY NAME

Key name buffe

^Statically initialized field (by VAX MACRO $XABKEY macro) to identify this control block a
XABKEY.
^ Field cannot be initialized by the VAX MACRO $XABKEY macro.

^ Field contains options; corresponding FDL equivalents are listed in the description of the fiel

Field Offset

Size
(bytes)

FDL Attribute

Description

<XLAN>

KEY LEVEL1_INDEX_AREA

Lowest level of index
area number

<XLVL> 2

None

Level of root bucket

<XMRL> 2

None

Minimum record length

<XNSG> 2

None

Number of key segments

<XNUL>

KEY NULL-VALUE

Null key value

<XNXT>

None

Next XAB address

<XPOSn>

KEY POSITION and
SEGn-POSITION

Key position,
XAB$W_POSO to
XAB$W_POS7

KEY PROLOG

Prologue level

<XREF>

KEY n

Key of reference

<XRVB> 2

None

Root bucket virtual
block number

<XSIZn>

KEY LENGTH and
SEGn-LENGTH

Key size XAB$B—SIZO to
XAB$B_SIZ7

<XTKS> 2

None

Total key field size

2 Field cannot be initialized by the VAX MACRO $XABKEY macro.

Table RMS-8

XABPRO Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

None

Address of buffer that contains
ACL

None

ACL positioning context

None

Receives the length of an ACL
during an Open or Display
service

None

Length of buffer containing
binary ACEs

None

System error status for ACL
processing

Field Offset

Size
(bytes)

FDL Attribute

Description

<XBLN> 1

None

Block length

<XCOD> 1

None

Type code

<XGRP> 2

FILE OWNER

Group number of file o

<XMBM> 2

FILE OWNER

Member number of file

FILE MT_PROTECTION

Magnetic tape accessibi

<XNXT>

None

Next XAB address

<XPRO>

FILE PROTECTION

File protection; contains
four separate fields den
protection for system, o
group, and world

<XPROT_
OPT>

None

File protection options

<XUIC>

FILE OWNER

User identification code
contains both the group
member fields

^Statically initialized field (by the VAX MACRO $XABPRO macro) to identify this control blo
XABPRO.
2 Field cannot be initialized by the VAX MACRO $XABPRO macro.

Table RMS-9

XABRDT Fields

Field Offset

Size
(bytes)

FDL Attribute

Description

<XBLN> 1

None

Block length

<XCOD> 1

None

Type code

<XNXT>

None

Next XAB address

<XRDT> 2

DATE REVISION

Revision date and time

<XRVN> 2

FILE REVISION

Revision number

^Statically initialized field (by the VAX MACRO $XABRDT macro) to identify this control blo
XABRDT.

^ Field cannot be initialized by the VAX MACRO SXABRDT macro; these fields must be set a
Open or Create service and before the Close service to be used as input to the Close service.

RMS-10

VAX Record Management Services
RMS Control Blocks

Table RMS-10

XABSUM Fields
Description

Field Offset

Size

<XBLN> 1

Byte

Block length

<XCOD>1

Byte

Type code

<XNOA> 2

Byte

Number of allocation areas defined for the file

<XNOK> 2

Byte

Numbers of keys defined for the file

<XNXT>

Longword

Next XAB address

<XPVN> 2

Word

Prologue version number

^Statically initialized field (by VAX MACRO $XABSUM macro) to identify this control block as an
XABSUM.
^ Field cannot be initialized by the VAX MACRO $XABSUM macro.

Table RMS-11

XABTRM Fields

Field Offset

Size
(bytes)

<XBLN> 1

Block length

<XCOD> 1

Type code

Item list address

<XITMLST_LEN>

Item list length

<XNXT>

Next XAB address

Description

^Statically initialized field (by the VAX MACRO SXABTRM macro) to identify this control block as an
XABTRM.

RMS.2 RMS Control Block Macros
$FAB ALQ=allocation-quantity,
BKS=bucket-size,
BLS=block-size,
CHAN _MODE=channel-access-mode,
CTX=user-context-value,
DEQ=extension-quantity,
DNA=defauJt-filespec-address,
DNM= <filespec> ,

VAX Record Management Services

RMS-11

RMS Control Block Macros

DNS=default-filespec-string-size,
FAC= <BIO BRO DEL GET PUT TRN UPD> ,
FNA=filespec-string-address,
FNM= <filespec> ,
FNS=filespec-string-size,
pOP=
DFW DLT MXV NAM NEF NFS OFP POS
RCK RWC RWO SCF SPL SQO SUP TEF TMD TMP UFO WCK> ,
FSZ=header-size,
GBC=global-buffer-count,
LNM_MODE=logical-name-translation-access-mode,
MRN=maximum-record-number,
MRS=maximum-record-size,
NAM=nam-address,
fIDX
IDX >1
ORG= \ REL \ ,
SEQ
CR
RAT=
<BLK FTN>
}■
PRN
FIX
STM
STMCR
RFM=
STMLF
UDF
VAR
VFC
RTV=window-size,
SHR= <DEL GET MSE NIL PUT UPD UPI>
XAB=xab-address

$FAB_STORE fab=fab-address,
ALQ= allocation-quantity,
BKS=bucket-size,
BLS=block-size,
CHAN _MODE=channel-access-mode,
CTX=user-context-value,
DEQ=extension-quantity,
DNA=default-filespec-address,
DNM= <filespec> ,
DNS=default-filespec-string-size,
FAC= <BIO BRO DEL GET PUT TRN UPD> ,
FNA=filespec-string-address,
FNM= <filespec> ,
FN S=filespec-string-size,

VAX Record Management Services

RMS-12

RMS Control Block Macros

<CBT CIF CTG DFW DLT MXV NAM NEF NFS OFF
FOP= POS RCK RWC RWO SCF
SPL SQO SUP TEF TMD TMP UFO WCK> ,
FSZ=header-size,
GBC=global-buffer-count,
LNM_MODE=logical-name-translation-access-mode,
MRN=maximum-record-number,
MRS=maximuin-record-size,
NAM=nam-address,
IDX
ORG=
5= I REL ^ ,
SEQ
CR
RAT= i <bLK FTN>
PRN
FIX
STM
STMCR
RFM=
STMLF
UDF
VAR
VFC
RTV=window-size,
SHR= <DEL GET MSE NIL PUT UPD UPI> ,
XAB=xab-address

$NAM ESA=expanded-string-address,
ESS=expanded-string-size,
NOP= <NOCONCEAL PWD SRCHXABS SYNCHK> ,
RLF=related-fiIe-nam-block-address,
RSA=resultant-string-address,
RSS=resultant-string-size
$NAM_STORE NAM=nam-address,
DID= directory-identification,
DVI= device-identification,
ESA=expanded-string-address,
ESS= expanded-string-size,
FID= file-identification,
NOP= <NOCONCEAL PWD SRCHXABS SYNCHK> ,
RLF=related-fiIe-nam-block-address,
RSA=resultant-string-address,
RSS= resultant-string-size

VAX Record Management Services
RMS Control Block Macros

$RA6 BKT=bucket-code-number,
CTX=user-context-value,
FAB=fab-address,
KBF=key-buffer-address,
KRF=key-of-reference-number,
KSZ=key-size,
MBC=multiblock-count-number,
MBF=multibuffer-count-number,
PBF=prompt-buffer-address,
PSZ=prompt-buffer-size,

I SEQ J
RBF=record-buffer-address,
RHB=record-header-buffer-address,
<ASY BIO CCO CVT EOF EQNXT
ETO FDL KGE KGT LIM LOA
ROP= LOG NLK NXR NXT PMT PTA
RAH REA RLK RNE RNF RRL
TMO TPT UIF ULK WAT WBH> ,
RSZ=record-size,
TMO=time-out-number-of-seconds,
UBF=user-record-buffer-address,
USZ=user-record-buffer-size,
XAB=xab-address
$RAB_STORE RAB=rab-address,
BKT= bucket-code-number,
CTX=user-context-value,
FAB=fab-address,
KBF=key-buffer-address,
KRF= key-of-reference-number,
KSZ= key-size,
MBC= multiblock-count-number,
MBF= multibuffer-count-number,
PBF=prompt-buffer-address,
PSZ= prompt-buffer-size,
f KEY ^
RAC= \ RFA \ ,
SEQ
RBF=record-buffer-address,
RFA= record-file-address,
RHB=record-header-buffer-address,

RMS-13

VAX Record Management Services

RMS-14

RMS Control Block Macros

<ASY BIO CCO CVT EOF EQNXT
ETO FDL KGE KGT LIM LOA
ROP= LOG NLK NXR NXT PMT PTA
RAH REA RLK RNE RNF RRL
TMO TPT UIF ULK WAT WBH> ,
RSZ= record-size,
TMO=time-out-number-of-seconds,
UBF=user-record-buffer-address,
USZ= user-record-buffer-size,
XAB=xab-address
$XABALL AID=area-identification-number,
' ANY
CYL
ALN=
LBN
RFI
VBN
ALQ=allocation-quantity,
AOP= <CBT CTG HRD ONC>
BKZ=bucket-size,
DEQ=extension-quantity,
LOC=location-number,
NXT=next-xab-address,
RFI= <f(l), f(2), f(3)> ,
VOL=volume-number

$XAB ALL-STORE XAB=xaball-address,
AID= area-identification-number,
ANY ^
CYL
LBN
/
RFI
VBN
ALQ= allocation-quantity,
AOP= <CBT CTG HRD ONC> ,
BKZ= bucket-size,
DEQ= extension-quantity,
LOC= location-number,
NXT=next-xab-address,
RFI= related-file-identification,
VOL= volume-number
$XABDAT EDT=date-time,
NXT=next-xab-address

VAX Record Management Services
RMS Control Block Macros

$XABDAT_STORE XAB=xabdat-address,
CDT= creation-date-time,
EDT= expiration-date-time,
RDT= revision-date-time,
RVN= revision-number,
NXT=next-xab-address
$XABFHC NXT=next-xab-address
$XABFHC_STORE XAB=xabfhc-address,
NXT=next-xab-address
$XABKEY DAN=data-bucket-area-number,
DFL=data-bucket-fill-size,
BN2
DBN2
BN4
DBN4
BN8
IN2
DIN2
IN4
,
DIN4
INS
DINS
PAC
DPAC
STG
DSTG
<CHG DAT_NCMPR DUP
" """
IDX_NCMPR KEY_NCMPR NUL> ,
IAN=index-bucket-area-number,
IFL=index-bucket-file-size,
KNM=key-name-buffer-address,
LAN=Iowest-level-index-area-number,
NUL=nuII-key-value,
NXT=next-xab-address,
POS= <position,...> ,
PROLOG=proIogue-IeveI,
REF=key-of-reference-vaIue,
SIZ= <size,...>

rms-15

RMS-16

VAX Record Management Services
RMS Control Block Macros

$XABKEY_STORE XAB=xabkey-address,
DAN= data-bucket-area-number,
DFL= data-bucket-fill-size,
BN2
DBN2
BN4
DBN4
BN8
IN2
DIN2
DTP=
IN4
DIN4
INS
DINS
PAC
DPAC
STG
DSTG
<CHG DAT_NCMPR DUP
FLG=
IDX_NCMPR KEY_NCMPR NUL>
IAN= index-bucket-area-number,
IFL= index-bucket-fill-size,
KNM=key-name-buffer-address,
LAN= lowest-level-index-area-number,
NUL= null-key-value,
NXT=next-xab-address,
POS= <position,...> ,
PROLOG= prologue-level,
REF= key-of-reference-value,
SIZ= <size,...>

$XABPRO ACLBUF=ACL-buffer-address,
ACLCTX= <ACL-context> ,
ACLSIZ=ACL-buffer-size,
MTACC=magnetic-tape-accessibility,
NXT=next-xab-address,
PRO= < system, owner, group, world> ,
PROT_OPT= < PROPAGATE > ,
UIC= < group, member >

VAX Record Management Services

rms-17

RMS Control Block Macros

$XABPRO_STORE XAB=xabpro-address,
ACLBUF=ACL-buffer-address,
ACLCTX= <ACL-context> ,
ACLSIZ= ACL-buffer-size,
MTACC= magnetic-tape-accessibility,
NXT=next-xab-address,
PRO= < system, owner, group, world > ,
PROT_OPT= < PROPAGATE > ,
UIC= uic-value
$XABRDT NXT=next-xab-address
$XABRDT_STORE XAB=xabrdt-address,
RDT= revision-date-time,
RVN= revision-number,
NXT=next-xab-address
$XABSUM NXT=next-xab-address
$XABSUM_STORE XAB=xabsum-address,
NXT=next-xab-address
$XABTRM ITMLST=item-list-address,
ITMLST_LEN=item-list-length,
NXT=next-xab-address
$XABTRM XAB=xabtrm-address,
ITMLST=item-list-address,
ITMLST_LEN= item-list-length,
NXT=next-xab-address

RMS.3

RMS Services

SYS$CLOSE fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err I ast_procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference

SYS$CONNECT rab [,[err] [,suc]]
rab I rab I longword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference

RMS-18

VAX Record Management Services
RMS Services

SYS$CREATE fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err I ast_procedure I procedure entry mask I call without stack unwinding I by reference
sue last-procedure I procedure entry mask I call without stack unwinding I by reference
SYS$DELETE rab [,[err] [,suc]]
rab I rab I longword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$DISCONNECT rab [,[err] [,suc]]
rab I rab I longword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$DISPLAY fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$ENTER fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$ERASE fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$EXTEND fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference

VAX Record Management Services

rms-19

RMS Services

SYS$FIND rab [,[err] [,suc]]
rabirabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$FLUSH rab [,[err] [,suc]]
rabirabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$FREE rab [,[err] [,suc]]
rabirabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$GET rab [,[err] [,suc]]
rabirabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$NXTVOL rab [,[err] [,suc]]
rabirabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$OPEN fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$PARSE fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$PUT rab [,[err] [,suc]]
rabirabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference

RMS-20

VAX Record Management Services
RMS Services

SYS$READ rab [,[err] [,suc]]
rablrabllongword (unsigned) I modify I by reference
err I ast_procedure I procedure entry mask I call without stack unwinding I by reference
sue last-procedure I procedure entry mask I call without stack unwinding I by reference
SYS$RELEASE rab [,[eiT] [,suc]]
rablrabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$REMOVE fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$RENAME old-fab [,[err] [,suc]] ,newfab
old-fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
new-fabifabllongword (unsigned) I modify I by reference
SYS$REWIND rab [,[err] [,suc]]
rab I rab I longword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$SEARCH fab [,[err] [,suc]]
fabifabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference
SYS$SPACE rab [,[err] [,suc]]
rablrabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference

VAX Record Management Services

RMS-21

RMS Services

SYS$TRUNCATE rab [,[err] [,suc]]
rablrabllongword (unsigned) I modify I by reference
err I ast—procedure I procedure entry mask I call without stack unwinding I by reference
sue last—procedure I procedure entry mask I call without stack unwinding I by reference

SYS$UPDATE rab [,[err] [,suc]]
rablrabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue I ast—procedure I procedure entry mask I call without stack unwinding I by reference

SYS$WAIT rab
rablrabllongword (unsigned) I modify I by reference

SYS$WRITE rab [,[err] [,suc]]
rablrabllongword (unsigned) I modify I by reference
err last—procedure I procedure entry mask I call without stack unwinding I by reference
sue I ast—procedure I procedure entry mask I call without stack unwinding I by reference

System Mgt.,
Operations

System Management, Operations, and
Programming Tools
This section provides "how-to" instructions for dealing with common duties and
problems faced by operators, and includes information on utilities that do not have
DCL command interfaces.

MISC.1 “How-To” Instructions for Useful Tasks
Task

Procedure or Command

Stopping a job that is
currently printing.

Press "Off Line" button or switch on printer, if desired.
Then type $ DELETE/ENTRY=n queue-name. (Type SHOW
QUEUE/ALL queue-name to find entry number.)

Deleting a print or batch job
that has not yet started.

$ DELETE/ENTRY=n queue-name

Backing up to tape or disk

$ BACKUP input-specifier output-specifier (See the VAX/VMS
Backup Utility Reference Manual.)

Capturing terminal output in
a file

$ DEFINE/USER_MODE SYS$OUTPUT file-spec (for next
image only); $ SET HOST/LOG (for an entire session)

Misc-2

System Management, Operations, and Programming Tools
“How-To” Instructions for Useful Tasks

MISC.2

Utilities Without DCL Commands

NOTE: Utilities invoked by their own DCL commands are included in the DCL
section of this manual.

MiSC.2.1 RUN AUTHORIZE
Interactive Commands:
ADD
/[NO]ACCESS[=(range[,...])]
/ACCOUNT=account-name
/[NO]ADD_IDENTlFlER
/ASTLlM=value
/ ATTRlBUTES=(keyword[,...])
/[NO]BATCH[=(range[,...])]
/B10LM=value
/BYTLM=value
/CLl=cli-name
/CLlTABLES=clitable-name
/CPUTlME=time
/DEFPRlVlLEGES=([NO]privname[,...])
/DEVlCE=name
/[NO]DlALUP[=(range[,...])]
/D10LM=value
/DIRECT OR Y=directory-name
/ENQLM=value
/EXPIRAT10N=time
/FlLLM=value
/FLAGS=([NO]option[,...])
/GENERATE _P ASSWORD[=keyword]
/[NO]lNTERACTlVE[=(range[,...])]
/JTQUOTA=value
/LGICMD=file-spec
/[NO]LOCAL[=(range[,...])]
/MAXACCTJOBS=value
/MAXDETACH=value
/MAXJOBS=value
/[NO]NETWORK[=(range[,...])]
/OWNER=owner-name
/[NO]PASSWORD=(password[,password2])
/PFLAGS=([NO]option[,...])
/PGFLQUOTA=value
/PRCLM=value

System Management, Operations, and Programming Tools
utilities Without DCL Commands

/P_RESTRICT=(range[,...])
/PRIMEDAYS=([NO]day[,...])
/PRIORITY=value
/PRI VILEGES=([NO]privname[,...])
/[NOJPWDEXPIRED
/[NO]PWDLIFETIME=time
/PWDMINIMUM=value
/QUEPRIORITY=value
/[NO]REMOTE[=(range[,...])]
/SFLAGS=([NO]option[,...])
/SHRFILLM=value
/S_RESTRICT=(range[,...])
/TQELM=value
/UIC=uic
/WSDEFAULT=value
/WSEXTENT=value
/WSQUOTA=value
ADD/IDENTIFIER
/ATTRIBUTES=(keyword[,...])
/USER=user-spec
/VALUE=value-specifier
ADD/PROXY
COPY
(Same qualifiers as ADD)
CREATE/PROXY
CREATE/RIGHTS
DEFAULT
(Same qualifiers as ADD)
EXIT
GRANT/IDENTIFIER
/ATTRIBUTES=(keyword[,...])
HELP
(All commands and qualifiers)
LIST
/BRIEF
/FULL
LIST/IDENTIFIER
/BRIEF
/FULL
/USER=user-spec
/VALUE=value-specifier
LIST/PROXY
LIST/RIGHTS
/USER=user-spec

MISC-3

Misc-4

System Management, Operations, and Programming Tools
utilities Without DCL Commands

MODIFY
/[NO] ACCESS[=(range[,...])]
/ ACCOUNT=account-name
/ASTLM=value
/[NO]BATCH[=(range[,...])]
/BIOLM=value
/BYTLM=value
/ CLI=cli-name
/CLITABLES=clitable-name
/CPUTIME=time
/DEFPRI VILEGES=([NO]privname[,...])
/DEVICE=name
/[NO]DIALUP[=(range[,...])]
/DIOLM=value
/DIRECT ORY=directory-name
/ENQLM=value
/EXPIRATION=time
/FILLM=value
/FLAGS=([NO]option[,...])
/GENERATE -PASSWORD
/[NO]INTERACTIVE[=(range[,...])]
/JTQUOTA=value
/LGICMD=HIe-spec
/[NO]LOCAL[=(range[,...])]
/MAXACCTJOBS=value
/MAXDETACH=value
/MAXJOBS=vaIue
/[NOjMODIFY-IDENTIFIER
/[NOjNET WORK[=(range[,...])]
/OWNER=owner-name
/PASSWORD[=(password[,password2])]
/PFLAGS=([NO]option[,...])
/PGFLQUOTA=value
/PRCLM=value
/P_RESTRICT=(range[,...])
/PRIMED AYS=([NO]day[,...])
/PRIORITY=vaIue
/PRIVILEGES=([NO]privname[,...])
/[NO]PWDEXPIRED
/[NO]PWDLIFETIME=time
/PWDMINIMUM=value
/QUEPRIORITY=value
/[NO]REMOTE[=(range[,...])]
/SFLAGS=([NO]option[,...])

System Management, Operations, and Programming Tools
Utilities Without DCL Commands

/SHRFILLM=value
/S_RESTRICT=(range[,...])
/TQELM=value
/UIC=uic
/WSDEFAULT=value
/WSEXTENT=value
/WSQUOTA=value
MODIFY/IDENTIFIER
/ATTRIBUTES=(keyword[,...])
/HOLDER=holder-name
/NAME=id-name
/VALUE=value-specifier
MODIFY/SYSTEM _P ASS W ORD=system-password
REMOVE
/[NOJREMOVE -IDENTIFIER
REMOVE/PROXY
RENAME
/PASSWORD[=(password[,password2])]
/[NO]MODIFY_IDENTIFIER
RENAME/IDENTIFIER
REVOKE/IDENTIFIER
SHOW
/BRIEF
SHOW/IDENTIFIER
/BRIEF
/FULL
/USER=user-spec
/VALUE=value-specifier
SHOW/PROXY
SHOW/RIGHTS
/U SER=user-spec

MISC.2.2 DELTA Debugger
Interactive Commands:
I RETURN I (Close Current Location)
iLiNEFEEDi (Close Current Location and Open Next)
I ESC I (Open and Display Previous Location)
= (Display Value of Expression)
;E (Execute Command String)
;G (Go)
/ (Open Location and Display Contents in Prevailing Mode)
! (Open Location and Display Contents in Instruction Mode)

MtSC-5

Misc-6

System Management, Operations, and Programming Tools
Utilities Without DCL Commands

iTABi (Open Location Specified by Q, the Current Value)
;P (Proceed from Breakpoint)
" (Set ASCII Mode)
;X (Set Base Register)
;B (Set, Clear, or Display Breakpoint)
[ (Set Display Mode)
S (Step Instruction)
O (Step Instruction Over Subroutine)
;M (Set All Processes Writeable)
'string' (Deposit ASCII String)

MISC.2.3 RUN SYS$SYSTEM:DISKQUOTA
Interactive Commands:
ADD
/PERMQUOTA =quota
/OVERDRAFT =quota-plus
CREATE
DISABLE
ENABLE
EXIT
HELP
MODIFY
/PERMQUOTA =quota
/OVERDRAFT =quota-plus
REBUILD
REMOVE
SHOW
USE

MISC.2.4 $ RUN SYS$SYSTEM:DTSEND
Interactive Commands:
CONNECT
/NODENAME =node-id
/[NO]PRINT
/SPEED =number
/TYPE =test-type
/RETURN =retum-option

System Management, Operations, and Programming Tools
utilities Without DCL Commands

DATA
/NODENAME =Tiode-id
/[NOJPRINT
/[NOJSTATISTICS
/[NO]DISPLAY=number
/SPEED =number
/TYPE =test-type
/SIZE =number
/[test-duration]
/FLOW =flow-control
/RQUEUE =number
/SQUEUE “number
/[NOJNAK “number
/[NO]BACK “number
DISCONNECT
(same as for CONNECT)
INTERRUPT
/NODENAME “node-id
/[NOJPRINT
/[NOJSTATISTICS
/[NOpiSPLAY
/SPEED “number
/TYPE “test-type
/SIZE “number
/[test-duration]
/FLOW “flow-control
/RQUEUE “number
/SQUEUE “number

MISC.2.5 INSTALL
Interactive Commands:

ADD
/[NO]ACCOUNTING
/[NO]EXECUTE_ONLY
/[NO]HEADER_RESIDENT
/[NO]LOG
/[NOJOPEN

/[NO]PRIVILEGED [“(priv-name[,...])]
/[NO]PROTECTED
/[NO]PURGE
/[NOjsHARED
/[NojwRITEABLE

MISC-7

Misc-8

System Management, Operations, and Programming Tools
utilities Without DCL Commands

CREATE
/[NOJACCOUNTING
/[NO]EXECUTE_ONLY
/[NO]HEADER_RESIDENT
/[NO]LOG
/[NOPPEN
/[NOJPRIVILEGED [=(priv-name[,...])]
/[NOJPROTECTED
/[NOJPURGE
/[NOJSHARED
/[NOjWRITEABLE
DELETE
EXIT
HELP
LIST
/FULL
/GLOBAL
/STRUCTURE
/SUMMARY
PURGE
REMOVE
REPLACE
/[NOJACCOUNTING
/[NOJEXECUTE _ONLY
/[NO]HEADER_RESIDENT
/[NOJLOG
/[NO]OPEN
/[NO]PRIVILEGED [=(priv-name[,...])]
/[NOjPROTECTED
/[NOJPURGE
/[NOJSHARED
/[NOJWRITEABLE

System Management, Operations, and Programming Tools
utilities Without DCL Commands

MISC.2.6 RUN SYS$SYSTEM:NCP
Interactive Commands:
CLEAR/PURGE CIRCUIT
CLEAR/PURGE EXECUTOR
CLEAR EXECUTOR NODE
CLEAR/PURGE LINE
CLEAR/PURGE LOGGING
CLEAR/PURGE LOGGING EVENTS
CLEAR/PURGE LOGGING NAME
CLEAR/PURGE MODULE X25-ACCESS
CLEAR/PURGE MODULE X25-PROTOCOL
CLEAR/PURGE MODULE X25-SERVER/X29-SERVER
CLEAR/PURGE NODE
CLEAR/PURGE NODE CIRCUIT
CLEAR/PURGE OBJECT
CONNECT NODE
CONNECT VIA
COPY KNOWN NODES
DISCONNECT LINK
HELP
LOAD NODE
LOAD VIA
LOOP CIRCUIT
LOOP EXECUTOR
LOOP LINE
LOOP NODE
PURGE MODULE CONFIGURATOR
SET CIRCUIT ALL
SET/DEFINE CIRCUIT
SET EXECUTOR ALL
SET/DEFINE EXECUTOR
SET EXECUTOR NODE
SET LINE ALL
SET/DEFINE LINE
SET LOGGING ALL
SET/DEFINE LOGGING EVENTS
SET/DEFINE LOGGING STATE
SET/DEFINE MODULE CONFIGURATOR
SET/DEFINE MODULE X25-ACCESS
SET/DEFINE MODULE X25-PROTOCOL
SET/DEFINE MODULE X25-SERVER/X29-SERVER
SET NODE ALL

MISC-9

Misc-10

System Management, Operations, and Programming Tools
utilities Without DCL Commands

SET/DEFINE NODE
SET/DEFINE NODE CIRCUIT
SET OBJECT ALL
SET/DEFINE OBJECT
SHOW AREA
SHOW/LIST CIRCUIT
SHOW/LIST EXECUTOR
SHOW/LIST LINE
SHOW LINKS
SHOW/LIST LOGGING
SHOW/LIST MODULE CONFIGURATOR
SHOW/LIST MODULE X25-ACCESS
SHOW/LIST MODULE X25-PROTOCOL
SHOW/LIST MODULE X25-SERVER/X29-SERVER
SHOW/LIST NODE
SHOW/LIST OBJECT
TELL
TRIGGER NODE
TRIGGER VIA
ZERO CIRCUITS
ZERO EXECUTOR
ZERO LINE
ZERO MODULE X25-PROTOCOL
ZERO MODULE X25-SERVER/X29-SERVER
ZERO NODE

MISC.2.7 RUN SYS$SYSTEM;SYSGEN
Interactive Commands:
AUTOCONFIGURE adapter-spec
/EXCLUDE=(device-name[,...])
/LOG
/SELECT=(device-name[,...])
CONFIGURE
/INPUT=file-spec
/OUTPUT=file-spec
/[NO]RESET
CONNECT/ADAPTER=adapter-spec
/CSR=csr-addr
/CSR-.OFFSET=value
/DRIVERNAME=driver
/MAXUNITS=max-unit-cnt
/NUMVEC=vector-cnt

System Management, Operations, and Programming Tools
utilities Without DCL Commands

/SYSIDHIGH=value
/SYSIDLOW=value
/ VECT OR=vector-addr
/VECTOR_OFFSET=value
CONNECT/NOADAPTER
/DRIVERNAME=driver
CONNECT CONSOLE
CREATE file-spec
/[NO]CONTIGUOUS
/SIZE=block-count
DISABLE CHECKS
ENABLE CHECKS
EXIT
HELP
INSTALL file-spec
/INPUT=file-spec
/OUTPUT=file-spec
/PAGEFILE
/SWAPFILE
LOAD file-spec
MSCP
/BUFFER=value
/HOST=value
/MAXIMUM=value
/MINIMUM=value
/PACKETS=value
/PRIORITY=value
/TIMEOUT=value
RELOAD file-spec
SET/OUTPUT[=] file-spec
SET parameter-name value
SET/STARTUP[=] file-spec
SHARE/CONNECT
/MAXCEFCLUSTERS=max-cef
/MAXGBLSECTIONS=max-gbl
/MAXMAILBOXES=max-mail
SHARE/INITIALIZE
/CEFCLUSTERS=cef
/GBLSECTIONS=gbl
/MAILBOXES=mail
/MAXCEFCLUSTERS=max-cef
/MAXGBLSECTIONS=max-gbl
/MAXMAILBOXES=max-mail
/POOLBCOUNT=block-cnt

MISC-11

Misc-12

System Management, Operations, and Programming Tools
Utilities Without DCL Commands

/POOLBSIZE=block-size
/PRQCOUNT=prq-cnt
SHOW/ADAPTER
SHOW/CONFIGURATION
/ADAPTER=nexus
/COMMAND-FILE
/OUTPUT=file-spec
SHOW/DEVICE=device-driver
SHOW/DRIVER=device-driver
SHOW [parameter]
/AGP
/ALL
/CLUSTER
/DYNAMIC
/GEN
/HEX
/JOB
/LGI
/MAJOR
/NAMES
/PQL
/RMS
/SCS
/SPECIAL
/SYS
/TTY
SHOW/STARTUP
SHOW/UNIBUS
/ADAPTER[=nexus]
TERMINAL/ECHO
USE file-spec
WRITE file-spec

AI-Y

READER'S
COMMENTS

Note: This form is for document comments only
DIGITAL will use comments submitted on this fo
the company's discretion. If you require a written
and are eligible to receive one under Software Pe
Report (SPR) service, submit your comments on
form.

Did you find this manual understandable, usable, and well organized? Plea
suggestions for improvement.

Did you find errors in this manual? If so, specify the error and the page nu

Please indicate the type of user/reader that you most nearly represent;
□
□
□
□
□
□

Assembly language programmer
Higher-level language programmer
Occasional programmer (experienced)
User with little programming experience
Student programmer
Other (please specify) _

Name _Date_

Organization _

Street ___

City _State_Zip Code
or Countr

^DQSD

United States

BUSINESS REPLY MAIL
FIRST CLASS PERMIT N0.33 MAYNARD MASS.

POSTAGE WILL BE PAID BY ADDRESSEE

SSG PUBLICATIONS ZK1-3/J35
DIGITAL EQUIPMENT CORPORATION
110 SPIT BROOK ROAD
NASHUA. NEW HAMPSHIRE 03062-2698

liiiiilliiliiiil

Do Not Tear - Fold Here

.I.II

AI-Y

READER'S
COMMENTS

Note: This form is for document comments only
DIGITAL will use comments submitted on this for
the company's discretion. If you require a written
and are eligible to receive one under Software Per
Report (SPR) service, submit your comments on a
form.

Did you find this manual understandable, usable, and well organized? Plea
suggestions for improvement.

Did you find errors In this manual? If so, specify the error and the page nu

Please indicate the type of user/reader that you most nearly represent:
□
□
□
□
□
□

Assembly language programmer
Higher-level language programmer
Occasional programmer (experienced)
User with little programming experience
Student programmer
Other (please specify) _

Name _Date_

Organization _

Street _

City _State_Zip Code
or Country

mmn

United States

BUSINESS REPLY MAIL
FIRST CLASS PERMIT N0.33 MAYNARD MASS.

POSTAGE WILL BE PAID BY ADDRESSEE

SSG PUBLICATIONS ZK1-3/J35
DIGITAL EQUIPMENT CORPORATION
110 SPIT BROOK ROAD
NASHUA, NEW HAMPSHIRE 03062-2698

I..I.I
Do Not Tear - Fold Here

Commands and
Utilities