Digital PDFs

AA-Y539B-TC

June 1985

508 pages

Original

15MB

Document:	Micro/RSX User's Guide Volume 1
Order Number:	AA-Y539B-TC
Revision:	0
Pages:	508
Original Filename:	http://bitsavers.org/pdf/dec/pdp11/rsx11m_s/Micro_RSX_3.0_Jul85/AA-Y539B-TC_Micro_RSX_V3.0_Users_Guide_Jun85.pdf

OCR Text

Mic'ro/RSX User's
Guide
Order No. AA-Y5398-TC

Micro/RSX Version 3.0

Digital Equipment Corporation

Maynard, Massachusetts

First Printing, December 1983
Revised, June 1985
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 ©1983, 1985 by Digital Equipment Corporation
All Rights Reserved.
Printed in U.S.A.
The postpaid USER'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
EduSystem
UNIBUS
VAX
DEC/CMS
lAS
DEC/MMS
MASSBUS
VAXcluster
MicroPDP-11
VMS
DECnet
DECsystem-10
Micro/RSX
VT
DECSYSTEM-20
PDP
DECUS
PDT
DECwriter
RSTS
DIBOL
RSX

tDDrnDDElD

ZK-2544

This document was prepared using an in-house documentation production system. All page composition
and make-up was performed by TE", the typesetting system developed by Donald E. Knuth at Stanford
University. TE" is a registered trademark of the American Mathematical Society.

HOW TO ORDER ADDITIONAL DOCUMENTATION
In Continental USA and Puerto Rico call

800-258-1710

In New Hampshire. Alaska. and Hawaii call
In Canada call

603-884-6660

613-234-7726 (Ottawa-Hull)
800-267-6215 (all other Canadian)

DIRECT MAIL ORDERS (USA & PUERTO RICO)"
Digital Equipment Corporation
PO. Box CS2008
Nashua. New Hampshire 03061

DIRECT MAIL ORDERS (CANADA)
Digital Equipment of Canada Ltd.
100 Herzberg Road
Kanata, Ontario K2K 2A6
Attn: Direct Order Desk

DIRECT MAIL ORDERS (INTERNATIONAL)
Digital Equipment Corporation
PSG BUSiness Manager
clo Digital's local subsidiary or
approved distributor

• 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, Northboro, Massachusetts 01532

Contents

Volume 1

Preface

xvii

Summary of Technical Changes

xxiii

Chapter 1 Welcome to Micro/RSX
1.1

1.2

What's It For? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
1.1.1
The Real-Time Control Environment. . . . . . . . . . . . . . . 1-2
1.1.2
The Applications Environment . . . . . . . . . . . . . . . . . . 1-2
1.1.3
The General Purpose Timesharing Environment . . . . . . . 1-3
1.1.4
The Purpose of the Operating System . . . . . . . . . . . . . . 1-3
How the User's Guide is Organized . . . . . . . . . . . . . . . . . . . . . 1-5

Chapter 2 How to Use DCl
2.1
2.2
2.3

Micro/RSX and DCL: Basic Concepts . . . . . . . . . . . . . . . . . . . . 2-2
DCL Command Descriptions . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
2.2.1
System Programmer Commands . . . . . . . . . . . . . . . . . 2-3
The DCL Command Line . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
2.3.1
Prompting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.3.2
Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
2.3.3
HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6
2.3.4
Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
2.3.5
Numbers and Dates . . . . . . . . . . . . . . . . . . . . . . . . 2-10

iii

2.4
2.5

2.3.6
Multiple Parameters .. ' . . . . . . . . . . . . . . . . . . . . . . 2-10
2.3.7
Underscore Character . . . . . . . . . . . . . . . . . . . . . . . 2-11
2.3.8
Colon and Equal Sign . . . . . . . . . . . . . . . . . . . . . . . 2-11
2.3.9
Quoting Strings . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11
2.3.10 DECnet and DCL . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12
2.3.10.1 SET HOST . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13
2.3.10.2 SHOW HOST . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
2.3.11
Command Line Continuation . . . . . . . . . . . . . . . . . . 2-15
2.3.12 Comments in Command Lines . . . . . . . . . . . . . . . . . 2-15
2.3.13 Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-16
Using the Queue Manager: PRINT and BATCH Jobs . . . . . . . . . 2-17
Indirect Command Files in DCL . . . . . . . . . . . . . . . . . . . . . . 2-18

Chapter 3
3.1

3.2

3.3
3.4

3.5
3.6
3.7

Using Your Terminal

Logging In and Logging Out . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
LOGIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
3.1.1
LOGOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
3.1.2
The Keyboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
3.2.1
RETURN and Command Line Length . . . . . . . . . . . . . 3-11
3.2.2
Line Terminators . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
DELETE Versus BACK SPACE . . . . . . . . . . . . . . . . . 3-12
3.2.3
CAPS LOCK and SHIFT . . . . . . . . . . . . . . . . . . . . . 3-13
3.2.4
NO SCROLL or HOLD SCREEN . . . . . . . . . . . . . . . . 3-13
3.2.5
Other Keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
3.2.6
The Keypad . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
The CTRL Key and Control Characters . . . . . . . . . . . . . . . . . . 3-15
3.4.1
CTRL/C . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
CTRL/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
3.4.2
CTRL/Z . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
3.4.3
3.4.4
CTRL/U . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
CTRL/G. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
3.4.5
HELP
3-18
BROADCAST.................................. 3-21
SET and SHOW TERMINAL . . . . . . . . . . . . . . . . . . . . . . . . . 3-25
SET TERMINAL . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26
3.7.1

3.7.2

Chapter 4
4.1

4.2
4.3

4.4
4.5

SHOW TERMINAL . . . . . . . . . . . . . . . . . . . . . . . . . 3-27

EDT

Introduction to the EDT Editor . . . . . . . . . . . . . . . . . . . . . . . . 4-1
4.1.1
Starting an Editing Session . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.2
Choosing an Editing Mode . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.2.1 Keypad Mode . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
4.1.2.2 line Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
4.1.2.3 Nokeypad Mode . . . . . . . . . . . . . . . . . . . . . . . . 4-7
4.1.3
Moving Among Editing Modes . . . . . . . . . . . . . . . . . . 4-8
4.1.4
Getting Help from EDT . . . . . . . . . . . . . . . . . . . . . . . 4-9
4.1.5
Ending an Editing Session . . . . . . . . . . . . . . . . . . . . 4-10
4.1.6
Recovering from a Lost Editing Session . . . . . . . . . . . . 4-11
Using EDT Buffers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
4.2.1
EDT'S Permanent Buffers . . . . . . . . . . . . . . . . . . . . . 4-13
Using Keypad Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
4.3.1
Using the GOLD Key . . . . . . . . . . . . . . . . . . . . . . . 4-14
4.3.2
Moving the Cursor . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
4.3.3
Inserting Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
4.3.4
Deleting and Undeleting Text . . . . . . . . . . . . . . . . . . 4-17
4.3.5
Locating Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20
4.3.6
Moving Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
4.3.7
Substituting Text . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
4.3.8
Five More Keys to Use with the GOLD Key . . . . . . . . . 4-26
How to Use line Mode . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
4.4.1
Line Numbers and Ranges . . . . . . . . . . . . . . . . . . . . 4-27
Advanced Editing Features . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
4.5.1
Defining Macros . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
4.5.2
Defining Key Functions . . . . . . . . . . . . . . . . . . . . . . 4-33
4.5.3
Creating a Personal Editing Environment. . . . . . . . . . . 4-36
4.5.3.1 Using SET Commands . . . . . . . . . . . . . . . . . . . 4-37
4.5.3.2 Using SHOW Commands to See What is Set. . . . . 4-38
4.5.3.3 Startup Command Files . . . . . . . . . . . . . . . . . . 4-39
4.5.3.4 Using Indirect Command Files with EDT . . . . . . . 4-42
4.5.4
Structured Tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-43

4.5.5

4.6

4.7

More on EDT Buffers . . . . . . . . . . . . . . . . . . . . . . . 4-44
4.5.5.1 How To Create and Move Between Buffers ...... 4-44
4.5.5.2 How To Copy Text from a File into a Buffer ..... 4-46
4.5.5.3 How To Copy Text from One Buffer to Another
Buffer . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 4-46
4.5.5.4 How To Copy Text from a Buffer to a File ...... 4-48
4.5.5.5 Ways to Use Buffers . . . . . . . . . . . . . . . . . . . . . 4-48
EDT Summary. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-50
4.6.1
Range Specifications . . . . . . . . . . . . . . . . . . . . . . . . 4-50
4.6.2
Editor Control Commands . . . . . . . . . . . . . . . . . . . . 4-54
4.6.3
Line-Mode Editing Commands . . . . . . . . . . . . . . . . . 4-60
4.6.4
Editing Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63
4.6.5
Keypad Commands. . . . . . . . . . . . . . . . . . . . . . . . . 4-65
4.6.6
Nokeypad Commands . . . . . . . . . . . . . . . . . . . . . . . 4-70
EDIT Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-74

Chapter 5
5.1
5.2
5.3
5.4
5.5
5.6

5.7

5.8

Files on Micro/RSX Systems

File Ownership and Location . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
File Specification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Defaults in File Specifications . . . . . . . . . . . . . . . . . . . . . . . . . 5-5
Wildcards in File Specifications . . . . . . . . . . . . . . . . . . . . . . . . 5-8
Date-Related Qualifiers . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-11
Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
5.6.1
File Protection . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-12
5.6.2
Directory Protection . . . . . . . . . . . . . . . . . . . . . . . . 5-16
5.6.3
Volume Protection . . . . . . . . . . . . . . . . . . . . . . . . . 5-17
Creating Directories and Sequential Files . . . . . . . . . . . . . . . . . 5-18
CREATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-18
5.7.1
5.7.2
CREATE/DIRECTORY . . . . . . . . . . . . . . . . . . . . . . 5-20
Maintaining a Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
5.8.1
DIRECTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-23
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
5.8.2
PURGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-35
5.8.3
5.8.4
COPY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-37
5.8.5
RENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-40

5.9

5.10

More File-Related Commands . . . . . . . . . . . . . . . . . . . . . . . . 5-42
5.9.1
TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42
5.9.2
PRINT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-44
5.9.3
Queue Manager Commands . . . . . . . . . . . . . . . . . . . 5-53
5.9.3.1 DELETE/ENTRy . . . . . . . . . . . . . . . . . . . . . . . 5-55
5.9.3.2 SHOW QUEUE and SHOW PROCESSOR . . . . . . . 5-56
5.9.3.3 SHOW QUEUE . . . . . . . . . . . . . . . . . . . . . . . . 5-56
5.9.3.4 SHOW PROCESSOR . . . . . . . . . . . . . . . . . . . . 5-59
5.9.3.5 SET QUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . 5-60
5.9.3.6 STOP/ABORT . . . . . . . . . . . . . . . . . . . . . . . . 5-62
5.9.3.7 HOLD/ENTRY and RELEASE/ENTRY . . . . . . . . 5-63
5.9.4
UNLOCK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-64
SET and SHOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-65
5.10.1 SET DEFAULT . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-66
5.10.2 SHOW DEFAULT . . . . . . . . . . . . . . . . . . . . . . . . . . 5-68
5.10.3 SET UIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-68
5.10.4 SHOW UIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-70
5.10.5 SET PROTECTION . . . . . . . . . . . . . . . . . . . . . . . . . 5-71
5.10.6 SET PROTECTION/[NO]DEFAULT . . . . . . . . . . . . . . 5-74
5.10.7 SHOW PROTECTION . . . . . . . . . . . . . . . . . . . . . . . 5-77

Chapter 6 Devices and Volumes
6.1

6.2
6.3
6.4
6.5

Devices on Micro/RSX Systems . . . . . . . . . . . . . . . . . . . . . . . . 6-2
6.1.1
Physical Devices, Pseudo Devices, LUNs, and Logical
Names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4
6.1.2
Summary of Device and Volume Use Commands ...... 6-4
MOUNT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
DISMOUNT................................... 6-14
INITIALIZE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-18
SET and SHOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24
6.5.1
SHOW DEVICES . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24

vii

Chapter 7 Running Tasks
7.1

7.2
7.3
7.4
7.5

Two Kinds of RUN Command . . . . . . . . . . . . . . . . . . . . . . . . 7-2
RUN Command for Task Image Files . . . . . . . . . . . . . . 7-2
7.1.1
RUN Command for Installed Tasks . . . . . . . . . . . . . . . 7-5
7.1.2
ABORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6
INSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8
REMOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-10
SET and SHOW . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
SHOW TASKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-12
7.5.1
7.5.1.1 SHOW TASKS/ACTIVE . . . . . . . . . . . . . . . . . . 7-12
7.5.1.2 SHOW TASKS/INSTALLED . . . . . . . . . . . . . . . 7-13
SET PRIORITY . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-14
7.5.2

Chapter 8
8.1
8.2

8.3

8.4
8.5
8.6

Preparing a User Batch Job

How a User Batch Job Works . . . . . . . . . . . . . . . . . . . . . . . . . 8-1
How to Prepare a User Batch Job . . . . . . . . . . . . . . . . . . . . . . . 8-2
8.2.1
The Batch Command line . . . . . . . . . . . . . . . . . . . . . 8-3
8.2.1.1 Comments............................ 8-3
8.2.1.2 Continuation Lines . . . . . . . . . . . . . . . . . . . . . . 8-4
8.2.1.3 Indirect Command Files . . . . . . . . . . . . . . . . . . . 8-4
Batch-Specific Command Descriptions . . . . . . . . . . . . . . . . . . . . 8-5
8.3.1
Login and Logout Commands . . . . . . . . . . . . . . . . . . . 8-5
8.3.2
Data Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7
8.3.3
Sequence Control Commands . . . . . . . . . . . . . . . . . . 8-10
Allocating Devices and Mounting Volumes from Batch Jobs ..... 8-15
SUBMIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17
Queuing Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22
8.6.1
How to Use the Queue Manager for Batch Jobs . . . . . . 8-22
DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24
8.6.2
SHOW QUEUE and SHOW PROCESSOR . . . . . . . . . . 8-25
8.6.3
8.6.3.1 SHOW QUEUE. . . . . . . . . . . . . . . . . . . . . . . . 8-25
8.6.3.2 SHOW PROCESSOR . . . . . . . . . . . . . . . . . . . . 8-27
SET QUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28
8.6.4

viii

8.6.5

8.7
8.8

Holding and Releasing Jobs . . . . . . . . . . . . . . . . . . . 8-30
8.6.5.1 HOLD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-31
8.6.5.2 RELEASE............................ 8-31
The Batch Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-32
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-35
8.8.1
Error Messages in Batch Logs . . . . . . . . . . . . . . . . . . 8-35
8.8.2
Error Messages to the Operator's Console . . . . . . . . . . 8-37

Chapter 9 The Indirect Command Processor
9.1
9.2
9.3
9.4

9.5
9.6

Indirect Command Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1
The Indirect Command Processor. . . . . . . . . . . . . . . . . . . . . . . 9-3
Summary of Indirect Directives . . . . . . . . . . . . . . . . . . . . . . . . 9-6
Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10
9.4.1
Special Symbols . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-11
9.4.1.1 Special Logical Symbols . . . . . . . . . . . . . . . . . . 9-11
9.4.1.2 Special Numeric Symbols . . . . . . . . . . . . . . . . . 9-14
9.4.1.3 Special String Symbols . . . . . . . . . . . . . . . . . . . 9-25
9.4.2
Numeric Symbols and Expressions . . . . . . . . . . . . . . . 9-32
9.4.3
String Symbols, Substrings, and Expressions . . . . . . . . . 9-35
9.4.4
Reserved Symbols . . . . . . . . . . . . . . . . . . . . . . . . . 9-36
9.4.5
Symbol Value Substitution . . . . . . . . . . . . . . . . . . . . 9-36
9.4.5.1 Substitution Format Control . . . . . . . . . . . . . . . . 9-38
Switches...................................... 9-40
Description of Indirect Directives . . . . . . . . . . . . . . . . . . . . . . 9-43
9.6.1
Define a Label (.label) . . . . . . . . . . . . . . . . . . . . . . . 9-44
9.6.2
Ask a Question and Wait for a Reply (.ASK) . . . . . . . . 9-45
9.6.3
Ask for Definition of a Numeric Symbol (.ASKN) ..... 9-47
9.6.4
Ask for Definition of a String Symbol (.ASKS) . . . . . . . 9-50
9.6.5
Begin Block (.BEGIN) . . . . . . . . . . . . . . . . . . . . . . . 9-51
9.6.6
Continue Processing Using Another File (.CHAIN) .... 9-52
9.6.7
Close Secondary File (.CLOSE) . . . . . . . . . . . . . . . . . 9-53
Output Data to Secondary File (.DATA) . . . . . . . . . . . 9-53
9.6.8
9.6.9
Decrement Numeric Symbol (.DEC) . . . . . . . . . . . . . . 9-55
9.6.10 Delay Execution for a Specified Period of Time (.DELAY) 9-55
9.6.11
Disable Option (.DISABLE) . . . . . . . . . . . . . . . . . . . . 9-56

9.6.12 Enable Option (.ENABLE) . . . . . . . . . . . . . . . . . . . . 9-57
9.6.13 End Block (.END) . . . . . . . . . . . . . . . . . . . . . . . . . . 9-62
9.6.14 Delete Symbols (.ERASE) . . . . . . . . . . . . . . . . . . . . . 9-62
9.6.15 Exit Current Command File (.EXIT) . . . . . . . . . . . . . . 9-64
9.6.16 Call a Subroutine (.GOSUB) . . . . . . . . . . . . . . . . . . . 9-65
9.6.17 Branch to a Label (.GOTO) . . . . . . . . . . . . . . . . . . . . 9-66
9.6.18 Logical Test (.IF) . . . . . . . . . . . . . . . . . . . . . . . . . . 9-66
9.6.18.1 Test if Symbol Meets Specified Condition (.IF) .... 9-67
9.6.18.2 Test if Task is Active or Dormant (.IFACTj.IFNACT) 9-68
9.6.18.3 Test if Symbol is Defined or Not Defined
(.IFDF jIFNDF) . . . . . . . . . . . . . . . . . . . . . . .. 9-69
9.6.18.4 Test if Task is Installed or Not Installed
(.IFINSj.IFNINS) . . . . . . . . . . . . . . . . . . . . . . 9-70
9.6.18.5 Test if Mode is Enabled or Disabled
(.IFENABLEDj.IFDISABLED) . . . . . . . . . . . . . . . 9-70
9.6.18.6 Test if Driver is Loaded or Not Loaded
(.IFLOAj.IFNLOA) . . . . . . . . . . . . . . . . . . . .. 9-71
9.6.18.7 Test if Symbol is True or False (.IFTj.IFF) . . . . . . . 9-72
9.6.18.8 Compound Tests . . . . . . . . . . . . . . . . . . . . . . . 9-73
9.6.19 Increment Numeric Symbol (.INC) . . . . . . . . . . . . . . . 9-73
9.6.20 Define Logical End-of-File (j) . . . . . . . . . . . . . . . . . . 9-74
9.6.21
Branch to Label on Detecting an Error (.ONERR) ..... 9-74
9.6.22 Open Secondary File (.OPEN) . . . . . . . . . . . . . . . . . . 9-76
9.6.23 Open Secondary File for Append (.OPENA) . . . . . . . . . 9-77
9.6.24 Open File for Reading (.OPENR) . . . . . . . . . . . . . . . . 9-79
9.6.25 Parse Strings into Substrings (.PARSE) . . . . . . . . . . . . 9-80
9.6.26 Pause for Operator Action (.PAUSE) . . . . . . . . . . . . . . 9-82
9.6.27 Read Next Record (.READ) . . . . . . . . . . . . . . . . . . . . 9-83
9.6.28 Return from a Subroutine (.RETURN) . . . . . . . . . . . . . 9-84
9.6.29 Set Symbol to True or False (.SETTj.SETFj.SETL) .... 9-84
9.6.30 Set Symbol to Numeric Value (.SETN) . . . . . . . . . . . . 9-85
9.6.31 Set Symbol to Octal or Decimal (.SETOj.SETD) ...... 9-86
9.6.32 Set Symbol to String Value (.SETS) . . . . . . . . . . . . . . 9-86
9.6.33 Terminate Command File Processing (.sTOP) . . . . . . . . 9-88
9.6.34 Test Symbol (.TEST) . . . . . . . . . . . . . . . . . . . . . . . . 9-88
9.6.35 Test Device (.TESTDEVICE) . . . . . . . . . . . . . . . . . . . 9-90
9.6.36 Test a File (.TESTFILE) . . . . . . . . . . . . . . . . . . . . . . 9-92

9.7

9.8

9.6.37 Test a Partition (.TESTPARTITION) . . . . . . . . . . . . . . 9-94
9.6.38 Translate a Logical Name Assignment (.TRANSLATE) .. 9-95
9.6.39 Wait for a Task to Finish Execution (.WAIT) . . . . . . . . . 9-95
9.6.40 Initiate Parallel Task Execution (.XQT) . . . . . . . . . . . . 9-96
Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-97
9.7.1
Invoking Indirect Interactively and Displaying Symbols . 9-97
9.7.2
Using an Indirect Command File . . . . . . . . . . . . . . . . 9-97
9.7.3
Asking for a Device Specification . . . . . . . . . . . . . . . . 9-98
9.7.4
Asking for the Type and Unit Number of the Terminal . 9-99
9.7.5
Initializing and Mounting a Volume, and Copying Files to That
Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-101
9.7.6
Editing, Purging, Printing, and Formatting Files ..... 9-103
Indirect Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-105
9.8.1
Information-Only Messages . . . . . . . . . . . . . . . . . . 9-105
9.8.2
Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . 9-106

Chapter 10 Quick Reference
ABORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
ALLOCATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2
ANALYZE/CRASH-DUMP . . . . . . . . . . . . . . . . . . . . . . . . . 10-3
ANALYZE/ERROR-LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4
ANALYZE/MEDIA. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5
APPEND . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6
APPEND/ERROR-LOG . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
ASSIGN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
ASSIGN/QUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-7
ASSIGN/REDIRECT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
ASSIGN/TASK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
BACKUP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-8
BROADCAST .. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 10-10
CANCEL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .. 10-10
CONTINUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
CONVERT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11
COPY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-12
CREATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-13

CREATE/CFL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
CREATE/DIRECTORY . . . . . . . . . . . . . . . . . . . . . . . . . . .
DEALLOCATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DEASSIGN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DEASSIGN/QUEUE. . . . . . . . . . . . . . . . . . . . . . . . . . . ..
DEFINE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
DELETE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
DELETE/DIRECTORY. . . . . . . . . . . . . . . . . . . . . . . . . . ..
DELETE/ENTRY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
DELETE/JOB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
DELETE/processortype . . . . . . . . . . . . . . . . . . . . . . . . . ..
DELETE/QUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DIRECTORY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
DISMOUNT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
EDIT[/EDT] . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
FIX . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HELP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HOLD/ENTRY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
HOLD/JOB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
INITIALIZE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
INITIALIZE/processortype (Input) . . . . . . . . . . . . . . . . . . ..
INITIALIZE/processortype (Output) . . . . . . . . . . . . . . . . . ..
INITIALIZE/QUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
INITIALIZE/UPDATE . . . . . . . . . . . . . . . . . . . . . . . . . . . .
INSTALL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
LIBRARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIBRARY /COMPRESS . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIBRARY/CREATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIBRARY/DELETE . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
LIBRARY/EXTRACT . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIBRARY/INSERT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIBRARY/LIST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIBRARY/REMOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
LIBRARY/REPLACE . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
LINK. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
LOGIN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

xii

10-13
10-13
10-14
10-14
10-14
10-15
10-15
10-16
10-16
10-16
10-16
10-17
10-17
10-18
10-19
10-19
10-19
10-20
10-20
10-20
10-21
10-22
10-23
10-23
10-24
10-24
10-25
10-25
10-26
10-26
10-26
10-27
10-27
10-27
10-28
10-30

LOGOUT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
MESSAGE/ERROILLOG . . . . . . . . . . . . . . . . . . . . . . . . .
MOUNT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
PRINT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
PURGE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RELEASE/ENTRY ... . . . . . . . . . . . . . . . . . . . . . . . . . ..
RELEASE/JOB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
REMOVE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RENAME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
REQUEST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
RUN Installed Task . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
RUN Uninstalled Task. . . . . . . . . . . . . . . . . . . . . . . . . . ..
SET [DAY]TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SET DEFAULT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET DEVICE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SET ERROILLOG . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET FILE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SET HOST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET LIBRARY/DIRECTORY . . . . . . . . . . . . . . . . . . . . . . ..
SET [NO]PARTITION . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET PASSWORD . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET PRIORITY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET PROTECTION . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET PROTECTION/[NO]DEFAULT . . . . . . . . . . . . . . . . . ..
SET QUEUE/ENTRY . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET QUEUE/JOB. . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SET SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SET TERMINAL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SET UIC. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW ACCOUNTING . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW ASSIGNMENTS. . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW CACHE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW CLOCICQUEUE . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW COMMON . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW [DAY]TIME . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW DEFAULT. . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..

xiii

10-30
10-30
10-30
10-32
10-33
10-34
10-34
10-34
10-34
10-35
10-35
10-36
10-36
10-37
10-37
10-38
10-38
10-39
10-39
10-39
10-39
10-40
10-40
10-40
10-41
10-41
10-42
10-42
10-45
10-45
10-46
10-46
10-46
10-47
10-47
10-47

SHOW DEVICES . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW ERROILLOG . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW HOST . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW LIBRARY . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW LOGICALS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW PARTITIONS . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW PROCESSOR. . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW PROTECTION . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW QUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW SYSTEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW TASKS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW TERMINAL. . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
SHOW UIC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SHOW USERS. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
START . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
START/ERROILLOG . . . . . . . . . . . . . . . . . . . . . . . . . . . .
START/processortype . . . . . . . . . . . . . . . . . . . . . . . . . . . .
START/QUEUE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
START/QUEUE/MANAGER . . . . . . . . . . . . . . . . . . . . . . .
START/UNBLOCK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
STOP / ABORT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
STOP /BLOCK . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
STOP /ERROILLOG . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
STOP /processortype . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
STOP/QUEUE. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
STOP/QUEUE/MANAGER . . . . . . . . . . . . . . . . . . . . . . . .
SUBMIT . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
TYPE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
UNFIX. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..
UNLOCK .' . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ..

Index

xiv

10-47
10-48
10-48
10-49
10-49
10-49
10-50
10-50
10-50
10-51
10-52
10-52
10-54
10-55
10-55
10-55
10-56
10-56
10-57
10-57
10-57
10-57
10-58
10-58
10-58
10-59
10-59
10-60
10-60
10-60

Figures
3-1
4-1
4-2
4-3
4-4
5-1
5-2
5-3

VT200-Series Terminal Keyboard and Keypad . . . . . . . . . 3-2
VT100-Series Keypad . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
VT200-Series Keypad . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Three EDT Buffers Used for Deleting and Un deleting Text 4-18
Two EDT Buffers Used for Substituting Text . . . . . . . . . 4-24
File Organization on a Volume . . . . . . . . . . . . . . . . . . . 5-2
Job Flag Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-49
File Flag Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-50

Tables
4-1
4-2
4-3
4-4
4-5
4-6
4-7
4-8
4-9
4-11
4-12
4-13
4-14
4-15
4-16
4-17
5-1
6-1

Moving Between Editing Modes . . . . . . . . . . . . . . . . . . 4-8
Ending an EDT Session . . . . . . . . . . . . . . . . . . . . . . 4-11
Moving the Cursor in Keypad Mode . . . . . . . . . . . . . . 4-14
Deleting Text in Keypad Mode . . . . . . . . . . . . . . . . . . 4-18
Five Gold Key Functions in Keypad Mode . . . . . . . . . . 4-26
Ranges for Line Mode . . . . . . . . . . . . . . . . . . . . . . . 4-28
Symbols and Words Used in Line Mode . . . . . . . . . . . 4-29
SET and SHOW Commands For Line Mode . . . . . . . . . 4-38
Key Definitions for EDT . . . . . . . . . . . . . . . . . . . . . . 4-41
Range Specification . . . . . . . . . . . . . . . . . . . . . . . . . 4-51
Editing Entities . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-64
Keypad Commands . . . . . . . . . . . . . . . . . . . . . . . . . 4-66
Keyboard Commands . . . . . . . . . . . . . . . . . . . . . . . . 4-70
Commands for Format 1 . . . . . . . . . . . . . . . . . . . . . . 4-71
Commands for Format 2 . . . . . . . . . . . . . . . . . . . . . . 4-72
Commands for Format 3 . . . . . . . . . . . . . . . . . . . . . . 4-74
File Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6
Devices on Micro/RSX Systems . . . . . . . . . . . . . . . . . . 6-2

Preface

Manual Objectives
The Micro/RSX User's Guide provides information needed to do work
on a Micro/RSX system. Important system concepts are introduced and
explained, including how to use the DIGITAL Command language (DCl)
to communicate with the system. DCl is based on English words and is
designed for ease in issuing commands to the system. The manual also
gives instruction in using the EDT editor and many other useful system
facilities.

Int'ended Audience
This manual is intended for any user of a Micro/RSX system. The manual
is a reference manual with many tutorial elements, but new users should
read the Introduction to Micro/RSX first.

Associated Manuals
If you are entirely new to computers, or to DCl, or to the RSX family
of operating systems, you should read the Introduction to Micro/RSX and
follow its instructions before proceeding to the User's Guide.
If you will be managing the Micro/RSX system, you should see the

Micro/RSX System Manager's Guide.
Other manuals related to Micro/RSX are described in the book Programming
on Micro/RSX. You should read this book even if you are not planning to
do any programming, in order to learn more about how the system works
and what other information is available.

xvii

Structure of This Manual
The Micro/RSX User's Guide is in two volumes. In general, Volume 1
should cover any questions that come up in your day-to-day use of the
computer system. Volume 2 includes reference information on all parts of
the operating system and is considerably more detailed. In many cases,
Volume 2 duplicates information that appears in simpler form in Volume
1. The manual is organized around the major operating system functions.
Chapters 1 through 10 are in Volume 1 of the Users's Guide.
Chapter 1
Welcome to Micro/RSX, is a general introduction to
Micro/RSX.
Chapter 2

How to Use DCL, introduces the basic concepts of DCL
and includes many hints on using DCL.

Chapter 3

Using Your Terminal, covers terminal operations, including logging in and logging out, keyboard terminology
and functions, setting and displaying important terminal
attributes, broadcasting messages, and using the system
HELP commands.

Chapter 4

EDT, documents EDT, the standard DIGITAL editor.

Chapter 5

Files on Micro/RSX Systems, introduces file handling
operations, including commands that create and delete
files, list directories, and rename, copy, type, and print
files. Wildcards and defaults are explained.

Chapter 6

Devices and Volumes, covers common peripheral devices
and introduces the system I/O (input/output) terminology.
The chapter describes commands affecting devices and
software volumes.

Chapter 7

Running Tasks, explains how tasks run in the system. In
addition, the chapter describes commands to abort tasks
and to display information about tasks in the system.

Chapter 8

Batch Processing, explains how to prepare and submit a
batch job. With batch processing, you can schedule less
urgent work, or work that uses lots of computer resources,
for some later time when the system is not being heavily
used. You need not be present to do batch processing.

xviii

Chapter 9

Indirect Command Processor, explains how to prepare and
execute indirect command files. With Indirect, you can
expedite the entry of a complex sequence and preserve it
in an indirect command file; you can execute the sequence
of commands any time you like.

Chapter 10

Quick Reference, is the alphabetical listing of all DCL
commands and their formats, including comments to
remind you of specific points about many commands and
command elements. Each entry in Chapter 10 includes a
cross-reference to the full command description elsewhere.

Chapters 11 through 16 are in Volume 2 of the User's Guide.
Chapter 11
More About Using Your Terminal, provides additional
information on terminal operations, including logging in
and logging out, keyboard terminology and functions,
setting and displaying terminal attributes, broadcasting
messages, using the system HELP commands, and writing
a help file.
Chapter 12

More About Files on Micro/RSX Systems, goes into more
detail about commands that list directories and that create,
delete, rename, copy, type, and print files. Wildcards and
defaults are explained.

Chapter 13

More About Devices and Volumes, discusses peripheral
devices and explains the system I/O terminology. The
chapter explains the relationship between hardware devices
and the software file system, and describes how to prepare
scratch disks and magnetic tapes for use on the system.
Commands affecting devices and software volumes are also
described.

Chapter 14

LINK and LIBRARY Commands, is for programmers. It
documents the program development facilities included on
the Micro/RSX Base Kit. The chapter briefly explains the
RSX Task Builder and the LIBRARY command, which is
used to maintain libraries.

Chapter 15

More About Running Tasks, explains how tasks run in
the system, and how they are named, installed, fixed in
memory, and controlled while running. In addition, the
chapter describes commands that abort tasks, place tasks
in the clock queue, and display information about tasks in
the system.

xix

Chapter 16

Common Error Messages, explains error messages common
to several DCL commands. Other command-specific error
messages are explained in the full command descriptions.

Conventions Used in This Manual
A number of conventions are used in the command descriptions in this
manual:

Convention

Meaning
The vertical ellipsis shows where elements of command
input have been omitted because they are irrelevant to
the point being discussed.

[/ qualifier]

Any command field enclosed in brackets is optional. If
the brackets include syntactical elements, such as dots
( .) or slashes (/), those elements are required for the
field. If the field appears in lowercase, you are to
substitute a legal command element if you include the
field.

[g,m]

This signifies a Vser Identification Code (VIC). The g is
a group number and the m is a member number. Where
a VIC is required, only one set of brackets is shown, as
[g,m]. Where the VIC is optional, two sets of brackets
are shown, as [[g,m]]. The VIC identifies a user and is
used mainly for controlling access to files and privileged
system function.

[directory]

This signifies a directory, which is the location of files.
Most directories have 1- to 9-character names, but some
are in the same [g,m] form as the VIC. Where a directory
name is required, only one set of brackets is shown, as
[directory]. Where the directory is optional, two sets of
brackets are shown, as [[directory]].

VPPERCASE

Any command field in uppercase indicates the legal
form of the command. If you type it in that form, it
will work as described. Most DCL commands also have
abbreviations.

Convention

Meaning

lowercase

Any command field in lowercase is to be substituted
for. Usually the lowercase word identifies the kind of
substitution expected, such as filespec, which indicates
that you should fill in a file specification .

/qualifier

.Any command element preceded by a slash (/) is a
DCL qualifier. Command qualifiers alter the action of
a command they are attached to. Parameter qualifiers
modify the action of the command as it affects that
parameter.

parameter

Required command fields are generally called parameters. The most common parameters are file specifications. Parameters are preceded by blanks or DCL
prompts.

:argument

Some parameters and qualifiers can be altered by the
inclusion of arguments preceded by a colon. An argument can be either numerical (COPIES:3) or alphabetical (NAME:QIX). The equals sign (=) can be substituted
for the colon to introduce arguments. COPIE5=3 and
COPIES:3 are the same.

filespec

A full file specification includes device, directory, file
name, file type, and version number, as in the following
example:
DB1:[COTTONTAL]HIPPITY.HOP;2

Full file specificationss are rarely needed. If you do not
give a version number, the highest numbered version
will be used. If you do not give a directory, the default
directory will be used. Some system functions default to
particular file types. See Chapter 5 for more information
on file specifications. See also the individual command
descriptions.
Some commands accept a filespec with a DECnet node
name. See Chapter 2 for more information.
red ink

All user input in examples is printed in red ink to
distinguish it from system output. That is, what you
type is shown in red.

xxi

Convention

Meaning
A rectangular symbol with a 2- to 6-character abbreviation indicates that you are to press the corresponding
key on your terminal. For example, @IT] indicates that
you are to press the RETURN key, and IDELI means that
you are to press the DELETE key.

{A I B}

A number of options between braces and separated by
vertical bars means that you are to choose one from the
options listed.
The rectangular symbol ICTRL/a I means that you are to
press ,he ~eG marked CTRL while pressing another key.
Thus, CTRL Z indicates that you are to press the CTRL key
and the Z key together in this fashion. ICTRL/Z I is echoed
on your terminal as AZ. Not all control characters echo.
See Chapter 3 for more information.

GOLD aaa

In Chapter 4, EDT, the word GOLD followed by other
key names means press the keys in that order.

See Chapter 2 for more information on DCL conventions.

xxii

Summary of Technical Changes

New Commands and Qualifiers
The following table lists the new commands and qualifiers to DCL.
ASSIGN[/ quallfter[ s]]
/GROUP:[g]
/FINAL

New qualifiers.
COPY[/ quallfter[ s]]
/ ALLOCATlON:n[.]

New qualifier.
DEASSIGN[! quallfter[ s]]
/GROUP[:g]

New qualifier.
DELETE/DIRECTORY

New command. Deletes a directory on a Files-II volume and removes
its name from the volume's Master File Directory (MFD).

xxiii

INITIALlZE[j quallfler[ s]]
/BAD_BLOCKS:arg
NOAUTOMATIC
(AUTOMATIC ,MANUAL)
(OVERRIDE ,MANUAL)
/DENSITY:arg
HIGH
LOW

New qualifiers.
INST ALL[j quallfler[ s]]
/ [NO ]RESIDENT_HEADER
/[NO]WRITE_BACK

New qualifiers.
LlNK[jqualifler[s]]
/CODE:(arg[s])
CLI
FAST_MAP
/[NO]PRINT

New qualifiers.
MOUNT[j quallfler[ s]]
/PROCESSOR:arg
UNIQUE
/OVERRIDE:arg
IDENTIFICATION

New arguments to existing qualifiers.
SET HOST

New command. Connects your terminal to another system.
SET PASSWORD

New command. Allows nonprivileged users to change their passwords.
SET PROTECTION[j qualifier]
/[NO]DEFAULT

New qualifier.

xxiv

SET TERMINAL[/ quallfter[ s]]
/INQUIRE
/DTCOl
/LA210
/LN03
/LQP02
/LQP03

/PRO_SERiES
/[NO]HOSTSYNC
/PRINTEILPORT
/[NO]TTSYNC

New qualifiers.
SHOW ASSIGNMENTS[! quallfter[ s]]
/GROUP[:g]
/TERMINAL:ttnn:

New qualifiers.
SHOW HOST

Displays the name of the processor to which your terminal is currently
connected.
SHOW PROTECTION

New command. Displays your personal default file protection code.
SHOW TASKS[ :taskname]/ quallfter[ s]
/DEVICE:ddnn:

New qualifier.
SHOW TERMINAL[ :ttnn][/ qua lifter]
/[NO]DTCOl
/[NO]LA210
/[NO]LN03
/[NO]LQP02
/[NO]LQP03
/[NO]PRO_SERIES
/[NO]HOSTSYNC
/PRINTEILPORT
/[NO]TTSYNC

New qualifiers.

xxv

New Device Support
The following table lists the new devices supported by Micro/RSX:
New terminal types:
DTCOl

LA2l0

LN03

LQP02

LQP03

PRO_Series

New disk device:
RA60

RA80

RA8l

RC25

RD52

RD53

New magnetic tape devices:
TK50

TK25

xxvi

Chapter 1
Welcome to Micro/RSX
Micro/RSX is an operating system. The operating system is the fundamental
software for a computer. Operating systems make it possible for all other
programs to run on a computer.
The Micro/RSX Operating System is the latest member of the RSX family of
operating systems. The MicroPDP-ll is a member of the PDP-II family
of computers. RSX operating systems run on all PDP-II computers. VAX11 RSX provides the RSX environment on VAX/VMS systems. This means
that the same program can run under RSX on a wide variety of DIGITAL
minicomputers and microcomputers, large and small. RSX systems allow
several users and their programs, or tasks as they are called on RSX
systems, to use the computer both independently and cooperatively.
Micro/RSX was designed to provide the capabilities of RSX systems on the
MicroPDP-ll computer. In general, you'll find that Micro/RSX is very
close to the RSX-IIM-PLUS system in its behavior.
Micro/RSX is a real-time system. Real-time systems respond rapidly to
input from users and to input from tasks.
Micro/RSX systems are multiuser systems. More than one user can have
access to the system at any time without interfering with each other.
This combination, a real-time, multiuser system, allows the most rapid
possible response for a variety of users. One important real-time feature is
the ability to assign priority to different tasks. A task with a high priority
can move a lower priority task out of the way temporarily in order to
respond to the more urgent need.

Welcome to Micro/RSX 1-1

All RSX systems feature DeL, the DIGITAL Command Language. DCL is
based on English words and is designed for easy use. As you become more
experienced, you can use DCL abbreviations to save yourself typing effort.
DeL is used on many DIGITAL operating systems, including VAX/VMS.
See Chapter 2 for more information on DCL.

1. 1 What' 5 It For?
You wouldn't have either a MicroPDP-ll or a Micro/RSX system unless
you had some application for which you need a computer. Typically,
commercial and industrial data-processing applications fall into three
categories: real-time control, applications processing, and general purpose
time-sharing. Micro/RSX can handle all three types.

1. 1. 1 The Real-Time Control Environment
In the real-time control environment, the principal function of the operating
system is to handle rapid data movement with little human interaction.
Typical examples of such environments are steel rolling mills, oil refineries,
and communications switching centers. When certain conditions are meta thickness, a temperature, a delay-the system must respond rapidlyclosing a valve, slowing a motor, throwing a switch.
The operating system, naturally, does not know about steel rails or long
distance calls or gasoline. The principal function of the system in a realtime control environment is to receive, verify, reply to, and move data
messages rapidly and without error.

1. 1.2 The Applications Environment
In the applications environment, Micro/RSX is used for running tasks.
These tasks can be office automation, communications systems, education
programs, games, you name it. Sometimes these applications are available
as tasks that you simply run with the DCL RUN command, but often
terminal users have no direct contact with the operating system at all. All
they see is the application. Terminal users communicate directly with the
task rather than with the operating system. They may not even log in.
Terminal users enter data, for processing by the applications task. The
task itself opens and closes files, updating and altering information as it is
entered.

1-2 Welcome to Micro/RSX

In the applications environment, the greatest part of the system's resources
is given over to continuous, high-volume data handling. Again, rapid,
error-free handling of data messages is the principal function of the system,
but instead of controlling a process, the messages update a data base under
the control of an applications task.

1. 1.3 The General Purpose Timesharing Environment
The general purpose time sharing environment is often a mixture of the
other two environments with the addition of program development and
testing as important activities. Terminal use is heavy in this kind of
environment. There may be several users at one time, but usually they are
thinking, looking up commands, or otherwise between keystrokes most of
the time. Micro/RSX can get a lot accomplished between keystrokes.
In the general purpose time sharing environment, the system's interactive
facilities are heavily used. These include DCL, EDT, and other tools.
Many of the program development tools of the RSX family are part of
the Micro/RSX Advanced Programmer's Kit, which is available separately.
Also available separately are a number of programming languages and
other products for programmers. Micro/RSX systems are often used to
develop programs to be run on another system. These programs might
be for real-time control or applications tasks. On the other hand, the
programs may perform special computations, such as modeling, statistical
analysis, or forecastirig, that are intended to be run on the same system
they were developed on.
Micro/RSX can be used in any combination of these three environments.
If you want to understand your Micro/RSX system fully, you'll want to
understand any applications that use the system in your installation.

1. 1.4 The Purpose of the Operating System
The purpose of the operating system is to make the computer hardware
easier to use.
The Executive controls the operating system.
The Executive is a
set of routines that coordinate all activities in the system, including
supervision of input and output, allocation of resources, task execution,
and communications.

Welcome to Micro/RSX

1-3

The operating system manages the hardware and software resources of
your system. This management requires that the operating system do four
things:
1. Keep track of all resources
2.

Enforce a policy on who gets what resources, when, and to what
extent

Allocate the resources according to system policies

Reclaim the resources when they are no longer needed

There are four basic resources under the control of the operating system:
1.

Memory, the system's workspace, where active tasks, active data, and
the Executive itself are located

2. Central Processing Unit, or CPU, the part of the computer that executes
instructions or computes

3. Peripheral devices, including terminals and disks, the line printer, if
any, and any other hardware attached to the system

4. Stored information, the file system, the organization of files into
directories and directories into volumes
Each task has different resource requirements. Involved scientific and
statistical calculations, often called unumber-crunchers, n need a great deal
of CPU time and memory, but make few demands on the system's devices
or file system. Conversely, printing a long file can tie up a line printer for
hours while using little memory and only a few seconds of CPU time.
In general, because there is an operating system, individual users don't
need to concern themselves about such matters.
System managers need to be aware of what is happening on their systems
and how to control it. See the Micro/RSX System Manager's Guide for more
information on system management.

1-4 Welcome to Micro/RSX

1.2 How the User's Guide is Organized
Because the Micro/RSX system can be used in so many different ways, it
includes a wide choice of commands, many of which have only specialized
uses. To help you tell the difference between commonly used commands
and qualifiers and rarely used specialized commands, the Micro/RSX User's
Guide is divided into two volumes. In general, Volume 1 describes the
commonly used commands and procedures. The help fiies describe aU
commands, common and uncommon, and Chapter 10, Quick Reference,
in Volume 1 also lists them all.
You will probably find that you use most of the common commands and
a few of the uncommon ones. The wide choice of commands, although
it may be confusing at first, gives you (and your system manager) a great
deal of control over how the operating system does things. Often, you
may not understand the purpose of a command or qualifier until you run
into a situation where you need it.
Most users will be able to do most of their work successfully using Volume
1 only.
You should read over Chapters 1 through 6 in Volume 1 of the Micro/RSX
User's Guide so that you will be familiar with the material if you ever
need it. If you have questions about the material, you'll probably find the
answers in the parallel, but more detailed, chapters in Volume 2. In any
case, look at the tables of contents for the Micro/RSX User's Guide volumes
and read anything that appeals to you.
If you are interested in programming, or if you are interested in what
lies beneath the surface of Micro/RSX, you should read the separate book
Programming on Micro/RSX. Among other things, this book describes the
other Micro/RSX and RSX documentation that is available separately and
as part of the Micro/RSX Advanced Programmer's Kit.

The Micro/RSX Advanced Programmer's Kit includes both documentation
and some additional software.

Welcome to Micro/RSX 1-5

Chapter 2
How to Use DCL
DCL is the DIGITAL Command Language. DCL gives users an extensive
set of commands for dealing with the operating system. DCL commands
provide for interactive program development, device and file manipulation,
and interactive program execution and control.
If you are new to computers, or if you wish a quick review of DCL
and the operating system, you should read the Introduction to Micro/RSX.
This book includes a guided tour of the operating system, including an
interactive terminal session that introduces all of the most commonly used
DCL commands.

DCL commands are full words that describe the action to be taken, not
abbreviations or mnemonics. Thus, if you wish to set a terminal to lowercase, you type SET TERMINAL/LOWERCASE. Because DCL commands
and command elements are full words, they are self-documenting.
You are not required to use the full form of DCL commands at the terminal,
however. Usually, you need type only the command elements required to
form a unique command. For instance, the abbreviation SET TERM/LOW
will also set a terminal to lowercase, but SET TERM/LO will not work
because there is also a command SET TERMINAL/LOCAL. See Section 2.3
for more information on how DCL commands are parsed.
This chapter introduces the rules of DCL. The examples are intended to
illustrate these rules, not to illustrate the full capabilities of the command.
For more detail, see the individual command descriptions.

How to Use DeL 2-1

2. 1 Micro/RSX and DCl: Basic Concepts
Commands in DCL are English or English-like words and follow welldefined syntax rules. Full commands are self-documenting. DCL is
designed for consistency and ease of use.
DCL is the command language used on many DIGITAL operating systems.
In particular, Micro/RSX DCL is designed for compatibility with future
releases of RSX-11M-PLUS and VAX/VMS DCL.

2.2 DCl Command Descriptions
Command descriptions are found throughout both volumes of the

Micro/RSX User's Guides, where chapters are organized according to the
major functions of the operating system.
Command descriptions can have five parts:
1. A brief statement of the function of the command.
2. A full description of the format of the command, including prompts,
defaults, acceptable values for arguments, and the effects of each
qualifier.

3. Examples of the command in use. These examples often illustrate less
obvious aspects of the use of the command.

4. Notes, including warnings about side effects, counteracting commands,
recommendations for further reading, and so forth. Some command
descriptions do not have notes.

5. Error messages, including an explanation and a suggested user action for
each error. Only error messages specific to the command are included
in the command descriptions. General error messages, such as those
relating to syntax, are described in Chapter 16.
In addition, the formats of all Micro/RSX DCL commands are presented
in the alphabetical listing in Chapter 10.
Nonprivileged commands are those commands needed by all users in
everyday use of the system. Many privileged commands are also included
in DCL. Privileged commands are those commands that affect system
operations. For instance, the SHOW TIME command is a nonprivileged
command, but the SET TIME command is privileged.

2-2 How to Use DCL

2.2. 1 System Programmer Commands
Micro/RSX systems accept a few commands that are not in DCL format.
They do not prompt. They are often not English words. In general,
these commands are for the use of system programmers, not average
users. You'll find these commands described in the Micro/RSX System
Manager's Guide and in the Micro/RSX Advanced Programmer's Kit, which
is available separately.

2.3 The DCl Command line
A command consists of a command name (usually a verb) specifying the
action the system is to take. Most commands also include one or more
parameters and qualifiers to further define the action of the command.
Qualifiers are preceded by a slash (/) and parameters are preceded by
a space or prompt. Both qualifiers and parameters can take arguments.
Arguments are preceded by a colon (:), or an equals sign (=). This book
documents only the colon.
Here is an example:
• DIRECTORY/OUTPUT: UNCLE. DAT SOLO.. IRET I

In this case, the elements of the command line are as follows:
•

DIRECTORY is the command name.

•

OUTPUT, which is preceded by a slash (/), is a qualifier. This qualifier
indicates that you want the output from the DIRECTORY command to
go somewhere other than your terminal screen, which is the default.

•

UNCLE.DAT, which is preceded by a colon (:), is the argument to the
/OUTPUT qualifier. This argument is the name of the file where you
want the output from the command to go.

•

SOLO .•, which is preceded by a blank, is a parameter. This parameter
is the name of the file(s) of which you are taking a directory listing.
Most DCL parameters are file specifications, as is this one. The asterisk
(.) indicates a wildcard file type. See Section 5.4 for information on
wildcards.

Note that after you type in a command, you must pass it to the operating
system by pressing the RETURN key. See Section 2.3.11 for a discussion of
command lines that are too long to fit on one line of your terminal.

How to Use DeL 2-3

Some commands require parameters or arguments as part of the command
line. If you fail to supply a required command element, DCL prompts
you with one or two words indicating the general nature of the required
element. If you do not understand the prompt, type a question mark (?)
for help. (In some cases, an omission causes an error message rather than
a prompt.)

2.3.1 Prompting
The prompts teach you the form of a command by requesting that you
supply required command elements.
For example, the RENAME command works as follows:
• RENAME ~
Old file name?
New file name?

BROWNS. STL ~
ORIOLES.BLT ~

The one-line format for RENAME is as follows:
• RENAME BROWNS.STL ORIOLES.BLT ~

The formats can be mixed. DCL prompts for whatever you leave out. For
example:
• RENAME BROWNS. STL ~
New file name? ORIOLES. BLT ~

There are no defaults for prompts. You must supply a response to any
prompt. If you do not wish to continue with the command, press CTRL/Z.

2.3.2 Qualifiers
Qualifiers modify the action of the command and are generally optional.
Qualifiers always start with a slash (/).
Qualifiers are either command qualifiers or parameter qualifiers. Most
qualifiers are command qualifiers. In this manual, command qualifiers are
always shown as modifying the command name, as in this example:
• TYPE/TODAY *. HLP ~

However, most command qualifiers can appear anywhere in the command
line. They are also called IIfloating qualifiers." The following examples
illustrate how command qualifiers can float:

2-4 How to Use DeL

• TYPE *. OAT /TODA Y [Bill

rnrn

• TYPE
File(s)? *.DAT/TODAY [Bill

rnrn

• TYPE
File(s)? /TODAY nmJ
File(s)? *.DAT

rnrn

You can mix formats and get exactly the same results, as in the following
examples:
• TYPE/TODAY [Bill
File (s)? * . OAT/EXCLUDE: ILLYA . OAT; * [Bill

rnrn

• TYPE/TODAY
File(s)? *.DAT/ [Bill
Qualifier? EXCLUDE:ILLYA.DAT;* IRETI

or
• TYPE/TODAY [Bill
File(s)? /
Qualifier? EXCLUDE: ILLYA. OAT; * [Bill
File (s)? *. OAT

rnrn

Note that you are prompted for a qualifier when a slash with no qualifier
attached appears on the command line. When you supply the qualifier,
do not type the slash again.
Almost all command qualifiers can float. In a few cases, however, the
command qualifier must appear directly after the command it modifies.
Whenever two similar commands are described separately, such as ASSIGN
and ASSIGN/REDIRECT or CREATE and CREATE/DIRECTORY, the
distinguishing qualifier cannot float. Other qualifiers to such commands
can still float, however, as in this example:
• CREATE/DIRECTORY [Bill
Device and UFO? [JENA] / ALLOCATION: 5 [Bill

which is the same as the following example:
• CREATE/DIRECTORY/ALLOCATION:5 [JENA] [Bill

How to Use DeL 2-5

Parameter qualifiers, sometimes called file specification qualifiers, cannot
float. Usually a parameter qualifier must be attached to a file specification,
because most DCL parameters are file specifications.
Many qualifiers can be negated by prefixing NO or-(minus) to the qualifier
name. Thus, the command
• DELETE/LOG *. TXT; * [Rill

deletes all files with the type .TXT and prints a list of the deletions on
your terminal, while the command
• DELETE/NOLOG *. TXT; * [Rill

or
• DELETE/-LOG *. TXT; * [Rill

simply deletes all the files without printing a list. (This action is in fact
the default behavior, but the example is given to illustrate the use of the
negative form of qualifiers.)

2.3.3 HELP
HELP is available from the system for all DCL commands and also for
many other aspects of the system. You can get help through the HELP
command or by typing a question mark (?) in response to any DCL
prompt.
For instance, if you need help on the TYPE command, type the following:
• HELP TYPE [Rill
TTPE[/qualifier[s]] filespec[s]
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy/THROUGH:dd-mmm-yy
/TODAY
/EXCLUDE:filespec
The TYPE command displays the contents of text files on your
terminal.
To obtain help on the above qualifiers, type the following:
HELP TYPE qualifier

•

The HELP text consists of the command syntax, showing that TYPE accepts
one or more file specifications and one or more qualifiers, followed by a
brief explanation.

2-6 How to Use DeL

You can also type a HELP command naming the qualifier to get more
information on that qualifier, as in this example:
• HELP TYPE TODAY [EIT1
TYPE/TODAY filespec[s]
The /TODAY qualifier specifies that you wish the TYPE
command to type only files created today.

If you want help while being prompted by the TYPE command, use the
following procedure:
• TYPE [EIT1
File (s)? ? [EIT1
TYPE[/qualifier[s]] filespec[s]
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy/THROUGH:dd-mmm-yy
/TODAY
/EXCLUDE:filespec
The TYPE command displays the contents of text files on your
terminal.
To obtain help on the above qualifiers, type the following:
HELP TYPE qualifier
File(s)?

The same help text is printed on your terminal, but the prompt returns,
meaning the TYPE command is still waiting for you to list the files you
want typed.
You can also get help on a specific subtopic while being prompted by a
command by responding to the prompt with a question mark (?) followed
by the subtopic. For example, after getting help on SET, you can also get
help on a specific function of SET:
• SET [EIT1
Function? ? [EIT1
The SET command establishes or changes the following:
[DAY] TIME DEFAULT
DEVICE
ERROR_LOG
GROUPFLAGS
HOST
LIBRARY
[NO]PARTITION PRIORITY
PROTECTION
PROTECTION/DEFAULT
QUEUE
SYSTEM
TERMINAL
For information on the above commands, type HELP SET commandname.

How to Use DeL 2-7

To get help on a specific topic, enter a question mark followed by the topic
as follows:
Function? ? DEFAULT IRETI
SET DEFAULT [ddnn:] [directory]]
The SET DEFAULT command sets your default directory or device,
or both.
Function?

xou can also get help by typing a question mark in response to the dollar
sign prompt ($).
If you should decide after reading the help text that you have chosen
the wrong command, enter a CTRL/Z in response to the prompt to end
the execution of the command. (A CTRL/Z pressed before entering the
command always cancels the command.)

There may also be help files providing information on special aspects of
your installation. In addition, you can create local help files for your own
use. See Chapter 3 for more information on the HELP command. For
information on how to write your own help files, see Chapter 11.

2.3.4 Abbreviations
It is rarely necessary for you to type either the complete command name or

the complete qualifier name. You only need to type the characters needed
to distinguish the command or qualifier from all others.
For example:
•

TYPE can be abbreviated T because it is the only command beginning
with that character.

•

INITIALIZE can be abbreviated INI, but not IN.

•

INSTALL can be abbreviated INS, but not IN.

Three letters will usually be enough; four letters will always be enough.
You can often omit other parts of commands as well. You should
experiment to find how short you can abbreviate various commands. For
instance, the following command:
$ SET TERMINAL/VT100 [BITJ

2-8 How to Use DeL

is the documented format for the command that sets a terminal as a VT100.
The same command to VAX/VMS DCL does the same thing. However,
the Micro/RSX version of DCL permits you to type the following:
• SET VT100

rnm

to achieve the same result. This second form does not work on VAX/VMS
systems.
These briefer forms should be used interactively only, and not used when
you are making a permanent record or creating an indirect command file
(or batch job).
For your convenience, some frequently used commands have special brief
forms as follows:
Command

Brief Form

Command

Brief Form

ABORT

HELP

BROADCAST

HELP

COpy

LOGOUT

DIRECTORY

LINK

DEALLOCATE

DEAL

MACRO

DEASSIGN

DEAS

EDIT

RUN

FORTRAN

SHOW

TYPE

To save time and typing, use these brief forms to replace the command
names when you are entering commands.
Note
As new commands are added in future releases, abbreviations may change.

How to Use DeL 2-9

2.3.5 Numbers and Dates
DCL recognizes both octal and decimal numbers. You usually do not have
to identify a number as octal or decimal, as DCL takes care of it. In
rare cases, the command description directs you to add a decimal point to
identify a decimal number.
DCL recognizes dates in two forms:
dd-mmm-yy as in 21-JUN-85

or
mm/dd/yy as in 06/21/85

System displays are always in the first format.

2.3.6 Multiple Parameters
Some commands permit you to enter a list of parameters instead of just
one. If you are entering a list of parameters, each parameter must be set
off by commas. For example,
$ PRINT JANE. TXT [Hill

causes a single file to be printed, while
• PRINT JANE. TXT. CHRIS. TXT. MULP.TXT [Hill

causes three files to be printed. You have the option of including spaces
on either side of the comma in lists.
If you end the list with a comma, DCL prompts you for further parameters.
For instance:
• PRINT JANE. TXT. CHRIS. TXT. [Hill
File(s)? MULP. TXT [Hill

Some commands for program development accept a list of arguments to
a single qualifier or parameter. In such cases, the list of arguments must
be enclosed in parentheses, with the elements set off by commas. For
example:
$ LINK/CODE; (PIC. FPP) HIYA mIT]

If you need to enter only a single argument, you do not need the
parentheses. For example:
• LINK/CODE: PIC HIYA [Hill

2-10 How to Use DeL

2.3.7 Underscore Character
The underscore character (_) is used to make OCL commands more
readable where two words are needed to name a single command element,
such as PRINT/FLAGJAGE. However, you need not type the underscore
to enter the command. PRINT /FLAGP AGE is the same as PRINT /FLAG_
PAGE. However, PRINT/FLAG PAGE will not work. You cannot include
a space in a command field.

2.3.8 Colon and Equal Sign
The command descriptions in this manual show arguments set off by a
colon (:), such as follows:
• PRINT/COPIES: 2 IZZY. TXT rnn:l

You can usually replace such colons with an equal sign (=), as in this
example:
• PRINT /COPIES=2 IZZY. TXT rnn:l

Colons in device names, such as OU1:, cannot be replaced by equal signs.

2.3.9 Quoting Strings
If you wish to include an exact string in a OCL command, put the string
in quotation marks. For instance, the message
• BROADCAST/ALL Rock and roll will never die ffi[D

is broadcast as
11-MAY-85 13:55
From PRINCE: :WRlTERS (TT64) to ALL
ROCK AND ROLL WILL NEVER DIE

while
• BROADCAST/ALL "Rock and roll will never die"

rnfU

is broadcast as
11-MAY-85 13:56
From PRINCE: :WRlTERS (TT64) to ALL
"Rock and roll will never diel!

You need quotation marks when passing commands to tasks using the
/PARAMETERS qualifier to MOUNT or the /COMMANO qualifier to
RUN or INSTALL.

How to Use DeL 2-11

2.3.10 DECnet and DCl
Your system may include the optional DEC net networking software. If so,
you'll need the following information.
DECnet is a DIGITAL product that enables two or more systems to "talk"
to each other. These systems are linked together physically to form a
network. The purpose of a network is to allow the users on different
systems to share information and resources. See the Introduction to DECnet
for more information about this product.
Each system in a network is called a node. The system that you originally
log in to is your local node. All other systems in a network are called
remote nodes.
Some DCL commands accept DECnet node names as part of a file
specification. They are the following:
COPY
CREATE DELETE
APPEND
DIRECTORY

RENAME

TYPE

Several other DCL commands accept node names in the file specifications.
However, DECnet modifies the basic syntax of these commands. These
commands are: PRINT, SUBMIT, SET PROTECTION, and SET FILE. Be
sure to check the RSX DECnet Guide to User Utilities before attempting to
use these commands.
If the node you select is part of your network, you can simply add the

node name to the file specification in the appropriate DCL command. Note
that your terminal remains connected to your local node when you issue
these commands to a remote node.
In the following example, you issue a command to type on your terminal
the file ROMAN.TXT, which is located on remote node PRINCE and device
DB2:, in directory [PETER].
$ TYPE PRINCE: : DB2: [PETER] ROMAN. TXT

IEITJ

All the usual rules about file and volume protection are maintained, of
course. See Section 5.6.
If the remote node you specify has a different style of file specification from

Micro/RSX, you must enclose the file specification in quotation marks, as
shown:
$

TYPE NEMO: : "DISK$USERDISK: [DALTON]DESPERADO_READERS.DIS"

2-12 How to Use DCL

IEITJ

In addition to transmitting commands between nodes, DECnet also allows
you to connect your terminal to a remote node. See the SET HOST
command, described in the following section.

2.3.10.1 SET HOST
After you have logged in to a system, you can use the SET HOST command
to connect your terminal to a different system.
Both your current system and the remote system must run DECnet
software. In addition, you need to have an account on the remote system.
Otherwise, you will not be able to log in to the remote system after you
issue the SET HOST command.
Format
SET HOST nodename
Parameters
nodename

Specifies the name of the remote system that you want to connect your
terminal to.
A node is one system within a network of systems. The system that
you originally log in to is called a local node; all other systems in a
network are called remote nodes.
Once you have connected to the remote node, that operating system
responds with a prompt. After you log in, use commands that the remote
operating system accepts.
Type the LOGOUT command to log out of a remote node. After typing
this command, you are located on your local node.
You can only use SET HOST to connect to one remote node at a time. For
example, suppose you want information located at two different remote
nodes, KING and JUNE. You cannot connect first to remote node KING,
and then execute SET HOST again to connect to remote node JUNE. You
must first log out of KING, which relocates you on your local node, then
use SET HOST to connect to JUNE.
See the RSX DECnet Guide to User Utilities for a full explanation of this
command.

How to Use DCL 2-13

Example
• SET HOST TOOTSI ~
Connected to "TOOTSI" , System type = Micro/RSX
System 10: RSX TIMESHARING
• LOGIN ~
Account or Name: Erin ~
Password:

•

This SET HOST command connects your terminal to the remote node
TOOTSI. The remote system identifies itself, then prompts you. You log
in to the remote system, using the name and password of your account on
that system.

2.3.10.2 SHOW HOST
The SHOW HOST command displays the name of the processor to which
your terminal currently is connected. The display also shows you the name
and version number of the operating system running on the processor.
The SHOW HOST command is most useful after you have connected
your terminal to a remote system with the SET HOST command.
However, SHOW HOST works whether or not your system runs DECnet
software. Without DECnet on your system, this command simply displays
information about your local operating system.

Format
SHOW HOST
Example
• SHOW HOST ~
HOST=TOOTSI Micro/RSX V3.0 BL24

This example indicates the display from SHOW HOST. The name of
your current processor is TOOTSI, which is running Version 3.0 of the
Micro/RSX operating system.

2-14 How to Use DeL

2.3. 11 Command Line Continuation
Sometimes a command will not fit all on one line. In that case you can
continue the line by using a hyphen ( -). When you end a command line
with a hyphen and a RETURN, the DCL continuation prompt ( - > ) indicates
that you can continue entering the command line. If you are continuing a
line from a prompt, such as Task?, that prompt is the indication that the
line is being continued.
This feature permits you to enter command lines including more characters
than your terminal has room for on one line.
DCL commands are limited to 80 characters in all. When you type a
continuation line, count the hyphen and the two times you press the
RETURN key as three of the 80 characters. Of course, each blank, as well
as each punctuation mark, counts as one character.
Here is an example of line continuation:
• PRINT/COPIES:2/FLAG_PAGE/AFTER:(04-JUN-85) OZY.TXT.-@[U
->IZZY. TXT. FIZZY. TXT @[U

The command is not entered until DCL encounters a line ending with
a RETURN that is not preceded by a hyphen. In the example, the first
RETURN does not enter the command. Only the second RETURN, with no
hyphen, enters the command. The RETURN can be on a line by itself.

2.3. 12 Comments In Command Lines
You may want to include comments in command lines if you are keeping
a permanent record, such as a batch job or command file, or simply an
interactive session on a hardcopy terminal. You can include a comment in
a DCL command line by preceding it with an exclamation point (!).
If the comment ends the command line, you need only a single exclamation
point, as in this example:
• PRINT OZY. TXT

! Poem by Shelley @[U

If the comment is within the command line, you need two exclamation
points to set it off, as in this example:
• PRINT! Parody of Shelley!

IZZY . TXT @[U

These comments are ignored and not interpreted in any way by DCL.

How to Use DeL 2-15

Comments can be placed at any natural break in the command line:
between qualifiers, between parameters, even as part of a response to a
prompt. Another example:
$ PRINT/FORMS:2!Letter-quality printer! IZZY.TXT ffi[U

2.3.13 Errors
You can correct typing errors or change the line completely by using the
DELETE key or CTRL/U, provided you have not terminated the line.
You can get rid of any DCL command by pressing a CTRL/Z, provided
you have not terminated the command.
If the system detects an error in the command line input, it returns the
appropriate error message at the issuing terminal.

Here are some examples of incorrect commands and the error messages
they produce:
$ PRIJT IZZY. TXT ffi[U
DeL -- Illegal command
$ PRINT/PURPLE IZZY. TXT mill
PRINT -- Illegal or contradictory qualifier
PRINT/PURPLE IZZY.TXT

$ PRINT/COPIES:TWELVE IZZY.TXT
PRINT -- Numeral expected
PRINT/COPIES:TWELVE IZZY.TXT

mill

In the first case, the error was detected by DCL, as indicated by the first
part of the error message. There is no DCL PRI}T command. The entire
command was rejected.
In the second case, the command was entered correctly, but the qualifier
was incorrect. The first part of the message shows that the error was
detected within the PRINT command itself. The command is reprinted
and a circumflex C) points to the error.
In the third case, the command and the qualifier were correct, but the
argument was in error. The message explains the error and the circumflex
points to the error.

2-16

How to Use DeL

Sometimes the circumflex does not point directly at the error, but at the
point at which the command started to go wrong, which may be several
characters before or after the actual error. Typing mistakes are by far
the most common cause of errors. Retyping the command is often all
you need to do to eliminate the error. Other common causes of errors
are omitting a space or other delimiter in a command line, specifying
invalid devices or nonexistent files, issuing privileged commands from a
nonprivileged terminal, and failing to type a sufficient number of characters
to distinguish the command or command element.
The command descriptions include the most common errors produced by
the commands and suggestions for correcting the errors. All the DCL error
messages are listed and explained in Chapter 16.

2.4 Using the Queue Manager: PRINT and BATCH

Jobs
The Micro/RSX Queue Manager provides facilities for printing files on
line printers or other output devices. Files can be printed under user
control or under the control of a system task or applications task. See the
description of the PRINT command in' Chapter 5. The description includes
information on how to display and alter jobs in the print queues. A full
description of Queue Manager commands for the user is in Chapter 12.
In addition, the Queue Manager provides a batch processing facility. Batch
jobs allow you to use the system without requiring you to be present. This
means that jobs that take a long time to run, or otherwise tie up system
facilities, can be run when there are fewer demands on the system, such
as at night or on weekends.
How to write and submit a batch job is explained in Chapter 8, Batch
Processing. The chapter includes information on how to display and alter
jobs in the batch queues.
The Micro/RSX System Manager's Guide includes a complete description
of the process of setting up the Queue Manager and other commands
affecting the Queue Manager.

How to Use DeL 2-17

2.5 Indirect Command Files in DCL
In addition to batch processing, Micro/RSX provides the Indirect Command
Processor (Indirect) as a means of automatically passing commands to the
operating system. If you have a series of commands to be executed in the
same or similar fashion every time, you can include these commands in a
file to be run by Indirect.
Indirect accepts not only DCL commands, but also directives. You use
these commands and directives to program indirect command files that
control your use of the system. Indirect is described in full in Chapter 9.

2-18

How to Use DeL

Chapter 3
Using Your Terminal
The terminal is your main channel of communication with the computer
system. This chapter gives you basic information on how to use a terminal
to communicate with the Micro/RSX Operating System. For a quick
review of basic operations at a terminal, see the Introduction to Micro/RSX.
For complete details on terminal operations, see the Micro/RSX User's
Guide, Chapter 11.
The discussions in this chapter generally assuJlle you have one of two
DIGITAL terminals: the VT100- or VT200-series video terminals. If you
are using another type of terminal, check with your system manager to
make sure the information in this chapter applies. In any case, you should
read the manual shipped with your terminal to get full use of your terminal
on the system. The VT100- and VT200-series terminals have many features
that can be set either by users or by programs.
A typical terminal keyboard is shown in Figure 3-1. A keyboard is a set of
alphanumeric keys, similar to the set on a typewriter. The keypad shown
in the illustration is a set of special keys. Where pertinent, the functions
of these keys will be explained in this chapter. All terminals will have
some form of a keyboard; some terminals will not have the keypad.
Each terminal on a Micro/RSX system has a number. Your terminal
number is displayed when you log in. Your terminal number is also used
by the system to identify tasks run from your terminal.

Using Your Terminal 3-1

o
a.

'0
c:

o
o
.a
>CD

C
c:

E
CD

e---;

CI)

CD
a::::
CD
en
I
o
o
N

-..
I

C")

:::J

u::

3-2 Using Your Terminal

You can always use the pseudo device name TI: to refer to the terminal
you are currently using. You do not need a specific number. In most
cases, when a system task requires you to name an output file, you can
specify TI: and the output will be printed on your terminal.

3.1 Logging In and Logging Out
Logging in informs the system that you are using a terminal. Logging out
informs the system that you are through using the terminal.
Most terminals have an accessible on-off switch. This switch supplies
power to the terminal, but it has no bearing on whether the terminal is
logged in. If you tum the power switch off, a logged-in terminal remains
logged in.
You can test whether a terminal is turned on and available by pressing
RETURN. The RETURN key causes the dollar sign prompt ($) to appear. If
the prompt does not appear, the system may need to be rebootstrapped.
See the Micro/RSX System Manager's Guide for more information.
The SHOW DEFAULT command tells you whether the terminal is logged
in or not. If it is not logged in, the command produces an error message.
You can then log in. If the terminal is logged in, the command displays
the current default device and directory as well as other information.
It is not good practice to take over a terminal while another person is using

the terminal, as you may interfere with the other user's work. Check with
SHOW DEVICES to see if the other user has devices allocated or volumes
mounted and with SHOW TASKS/ACTIVE to see if the other user is
executing a task. If the other user has no significant activity under way,.
use your own judgment as to whether you should log the other user out,
by typing the following:
• LOGOUT

rnrn

Then, after you log out the terminal, log yourself in.
If you are not sure how to log in, type HELP for help in logging in.

All Micro/RSX systems are multiuser protection systems. This means that
the system includes features such as LOGIN and LOGOUT and private
devices that enable several users to use the system without interfering with
each other's work.

Using Your Terminal 3-3

3.1.1 LOGIN
LOGIN grants access from a terminal to the system. LOGIN also establishes
certain characteristics of your terminal session. HELLO is a synonym for
LOGIN.

Format
LOG[IN]
Account or name: userid
Password: password
LOGIN userid
PASSWORD: password
LOGIN useridlpassword

Parameters
userld

Identifies the user logging in. It is easiest to log in by name. However,
this command also accepts four forms of User Identification Code
(UIC):
[g,m]
g,m
[g/m]
glm

Each user has a unique UIC, which the system manager assigns when
setting up your account. The g is your group number, and the m is
your member number.
If you log in using a comma in the UIC-for example, [303,17]-or
your name, a file called LB:[l,2]LOGIN.TXT normally prints on your
terminal. Your system manager puts information about the system and
other announcements in this file.

You can suppress LOGIN. TXT messages by using a slash (I) instead
of a comma (,) between the group and member numbers of your UIC
when you log in.
Your system manager can set up your account so that messages will
not print on your terminal when you log in or log out. If your system
manager selects this option, you will not receive LOGIN. TXT messages,
regardless of how you log in.

3-4 Using Your Terminal

password
Your password can have up to 39 characters. These can be letters,
numbers, periods ( . ), dollar signs ( $ ), exclamation points ( !), quotation
marks ('), or hyphens (-). When you enter your password in response
to the Password: prompt, your password will not print on the screen.
However, if you type in your password on the same line as your
name, the password does print. Your system manager establishes your
password as part of setting up your account. You may change your
password after you log in by using the SET PASSWORD command.
See Chapter 11.

Examples

S LOGIN [RIT1

Account or name : KAFKA [RIT1
Password:
[RIT1
Micro/RBI V3.0 BL24
[1.54] System THEFLU
15-MAY-85 10:28
Good Morning
April 20. 1985
System Manager
** System will be down tonight from 21:00 to 24:00 **

** BACKUP TIME! **
Please purge your files!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
March 12. 1985
Sam Spade
Softball Practice Monday afternoon
S

In this example, full login text is automatically printed on the terminal
because the user logged in with a name (KAFKA). The full login text is
also printed if you log in with a UIC entered with a comma [g,m]. See
next example.
The dollar sign prompt ($) signifies the completion of logging in.

S LOGIN 303/5 [RIT1
Password:
[RIT1
Micro/RSI V3.0 BL24
15-APR-85 10:28

[1.54] System THEFLU

Using Your Terminal 3-5

Good Morning
March 20, 1985
System Manager:
** System will be down tonight from 21:00 to 24:00 **

** BACKUP TIME' **
Please purge your files"""""'" "" """""'"

•

This example shows the first login of the day for this user. The VIC
was entered with a slash (303/5). The printing of the system LOGIN. TXT
file in full was therefore suppressed. Only the first message (defined as
being a priority message by the system manager) was printed. The priority
message is printed only on the first login of the day. This ensures that
users who habitually log in with the slash do not miss anything. See next
example.

• LOGIN 303/5 IRETI
Password:
~
Micro/RSI V3.0 BL24
15-APR-85
11:32
Good Morning

[1,54] System THEFLU

•

This example shows a subsequent login on the same day by the same user.
Note that no system messages are displayed.

• LOGIN ~
Account or name: 301/370 ~
Password:
~
Micro/RSI V3.0 BL24
[1,54] System THEFLU
15-APR-85
19:36
Good Evening
• GLOGIN.CMD
• SET TERMINAL/INQUIRE
• SET PROTECTION: (S:RWED,O:RWED,G:R,W:)/DEFAULT
• ASSIGN DU1: RS:
• G <EOF>

•

This user has prepared a LOGIN.CMD file in his directory to set up
the terminal, establish a default protection code, and make a logical
assignment. The operating system runs the LOGIN.CMD file each time the
user logs in. The commands shown are issued by the indirect command
file LOGIN.CMD; the @ <EOP> marks the end of this command

3-6 Using Your Terminal

file. See Chapter 9, Indirect Command Processor, and the Introduction
to Micro/RSX for more information on indirect command files.
Your system manager may have established your account so that you do
not receive login messages, regardless of how you log in. If this is the
case, none of the information that usually appears between the Password:
prompt and your LOGIN.CMD file prints on your terminal. Therefore,
you do not see the system identification or messages from the system
manager's LOGIN.TXT file.
Notes

HELLO is identical to LOGIN.
LOGOUT, or BYE, counteracts LOGIN.
When you log in, the system's Account File Maintenance Program (ACNT)
establishes many characteristics of the terminal session you are beginning.
These include your default device (where your files are located), whether
your account is privileged or not, and so forth.
Your system may have a file called LB:[l,2]SYSLOGIN.CMD. This file
usually contains system-level commands that your system manager wants
the operating system to execute each time a user logs in.
You can create a file called LOGIN.CMD. You keep this file in your
directory, and the operating system executes it each time you log in. A
LOGIN.CMD file usually includes commands for setting up your terminal
and your account for regular use, although this file may contain any
commands you want. See the examples. See also Chapter 9 and the
Introduction to Micro/RSX for more information on indirect command files.
It is wise to log in occasionally with either your name or a comma in

your UIC. This way you can be sure you have not missed any important
messages.
Error Messages
MCR-Not logged In
DCl-Not logged In

Explanation: The terminal is not logged in.
User Action: Log in using LOGIN.

Using Your Terminal 3-7

LOG-Account nle open failure

Explanation: The system could not access the account file for some
reason.
User Action: Try again. Wait and try again. If the message recurs, see
your system manager.
LOG-Invalid account

Explanation: The name or UIC, or the password, given in the command
is not recorded in the account file.
User Action: Retype the command using correct data.
LOG-Loglns are disabled

Explanation: The system is being shut down, or a privileged user has
issued SET NOLOGINS for some other reason.
User Action: You cannot log in. Try again later. Often, when logins
are enabled again, the operator sends a message to all terminals.
LOG-Other user logged on

Explanation: Another user is logged in. Only one user at a time can
log in on a terminal.
User Action: Issue SHOW USERS to find out who is logged in. Issue
SHOW TASKS ACTIVE to find out what tasks are active on the
terminal. At your discretion, issue LOGOUT and then log yourself in.
LOG-Terminal allocated to other user

Explanation: The terminal has been allocated (made private) by another
user. You cannot log in on an allocated terminal.
User Action: Go to another logged in terminal. Issue SHOW DEVICES
TT: and find out which terminal has your terminal allocated.

3-8 Using Your Terminal

3. 1.2 LOGOUT
LOGOUT logs the user off the system.
LOGOUT also aborts any active nonprivileged tasks running from the
terminal, as well as dismounting any private volumes and deallocating any
private devices allocated from the terminal.

Format
LO[GOUT][/HOLD]
Command Quallfter
/[NO]HOLD

The /HOLD qualifier is for use on remote or DECnet host terminals. If
you include the qualifier, the terminal is logged out but the line is not
disconnected. This means you can log back in without reconnecting
the line. The default is /NOHOLD, meaning that when you log out,
the line is also disconnected.

Examples
• LOGOUT [BTI]
Connect time:
0 hrs 44 mins 0 sees
CPU time used:
0 hrs 6 mins 36 sees
Task total:
gO
Have a good afternoon
08-MAY-86 16:68 TT10: Logged off PRINCE

In this example, a user logs out of a Micro/RSX system. The information
on system use only prints on systems that have Resource Accounting
running. (PRINCE is a DECnet node name. DECnet is a DIGITAL product
that allows the users of different computer systems to share information
and resources. A node is the name of one of these systems.)
Your system manager may have set up your account so that you do not
receive system information when you log out. In this case, the operating
system simply prints a dollar sign prompt ($) to indicate that you have
successfully logged out.

Using Your Terminal 3-9

$ LOGOUT [Rill
DMO -- TTl: Dismounted from DU1:
Connect time:
o hrs 32 mins 0 secs
CPU time used:
o hrs 0 mins 12 secs
Task total:
21
Have a good morning
08-MAY-85 11:17 TT10: Logged off ROMPER

In this example, the user had a volume mounted on device DU1:. The
LOGOUT command dismounted the volume, as the message states. If the
device was allocated, the LOGOUT command will deallocate it, but will
not issue a message.
$ LOGOUT [Rill

13:29:36 Task "TT10 "Terminated
Aborted via directive or CLI
$

Have a good afternoon
19-JUN-85 13:13 TT10:

Logged off

In this example, the user had a task running from the terminal at the
time the LOGOUT command was issued. The command caused the task
to be aborted. The system did not include Resource Accounting, so no
system-use statistics were printed.
Notes

BYE is identical to LOGOUT.
LOGIN, or HELLO, counteracts LOGOUT.
You need type only LO to log out.

3.2 The Keyboard
Most of the keys on the main keyboard are self-explanatory. They function
much the same as they do on a typewriter. Only the most important
differences from typewriter operation are noted here.
You should remember that a computer terminal is not a typewriter. A
computer terminal has two functions: transmitting input to the computer
and receiving output from the computer. Usually, when you press a key,
the letter appears immediately on your terminal. When you pressed the
key, you sent a character to some system task or program. One of the
actions the system normally takes upon receiving a character is to send
it back to your terminal as an echo. This usually happens so fast that it
appears that you are typing on your terminal, but you are not. You are

3-10 Using Your Terminal

sending input to the system and it is sending output to your terminal. A
terminal is an input/output device.
Occasionally, when heavy demands are being made on the system, there
may be a noticeable lag between the input and the echo.
You should also remember that keys may behave differently when sending
output to some task other than DeL. Fer instance, all the keypad keys,
plus the ENTER, BACK SPACE, and LINE FEED keys, have special meanings
when you are running the EDT editor. Special applications software at
your installation may also use special meanings for certain keys. This
chapter covers key use for DCL (also called monitor level).

3.2. 1 RETURN and Command Line Length
The RETURN key has two functions. It is used in the conventional way
to supply a line feed and a carriage return, but the key is also used to
signal the system that you have finished typing a command. Commands
can be quite varied in length; the RETURN key defines the length of the
is used in this manual to signify that you press
command. The symbol
the RETURN key. Thus,

• PRINT IZZY. TXT lBITl

is a complete command, and so is
• PRINT/COPIES: 2 IZZY. TXT lBITl

If you must enter a command that is longer than a single line on your
terminal, you can override the effect of the RETURN key by ending the
line with a hyphen before pressing the RETURN key. This works as
follows:
• PRINT/COPIES:2/FORM:1/DELETE IZZY.TXT. OXY.TXT.-lBITl
->MADISON.AVE. FUZZY. TXT; 12. GUNGA.DIN;2 lBITl

The hyphen tells the system to postpone execution of the command until
it receives a RETURN not preceded by a hyphen. In the example given,
the user had more files to be printed together than could be specified
on a single line. The hyphen called for the special continuation prompt
(-> ) rather than execution of the command. The RETURN without the
preceding hyphen then called for execution of the full command. For more
information on command lines continuation, see Chapter 2.

Using Your Terminal 3-11

Note
In most examples and command formats in this manual,
the RETURN at the end of a line containing a command
or command element is assumed and is not shown.

3.2.2 Line Terminators
To enter a command, terminate the command line with the RETURN key.
To cancel a command you do not want to enter, terminate the command
line with CTRL/Z or CTRL/C.
The ENTER key on the keypad is identical with RETURN at DCL monitor
level. (The two keys function differently in EDT, however.)
When you terminate a command line with the RETURN key, as soon as
the command is processed, the dollar sign prompt ($ ) reappears, ready for
another command. For example:
• SHOW TIME [EITJ

09:69:21 13-MAR-86

•

3.2.3 DELETE Versus BACK SPACE
You should avoid using the BACK SPACE key. This key is included on
terminals for compatibility with other systems but is not used in DCL. The
BACK SPACE key does not produce an echo, but it can have confusing
results when used in a file or when entering a command. When you make
a typing mistake, use the DELETE key (on the VT100-series terminals) or
<Xl key (on the VT200-series terminals) to correct it, not BACK SPACE.
(The BACK SPACE key may be used for special functions within tasks, as
it is in EDT.)
The DELETE key erases the character immediately to the left of the cursor.

3-12 Using Your Terminal

3.2.4 CAPS LOCK and SHIFT
On most video terminals, the CAPS LOCK key (on the VT100-series
terminals) and the LOCK key (on the VT200-series terminals) causes all
letters to be typed in uppercase. This key affects only letters, not numbers
or symbols. You can engage CAPS LOCK and type 'PDP-II' without
disengaging it, even though the apostrophes, numbers, and the hyphen
are lowercase.
The SHIFT keys set your terminal to uppercase for the keys not affected by
CAPS LOCK, as well as for individual alphabetic characters.
Different terminal models vary widely in their treatment of CAPS LOCK
or the equivalent key. You should experiment on your terminal.

3.2.5 NO SCROLL or HOLD SCREEN
The NO SCROLL key on the VT100-series terminals and the HOLD SCREEN
on the VT200-series terminals control the flow of information on your
terminal screen. These keys are useful when you want to read text on
your terminal screen at a rate slower than the terminal presents it. Press
NO SCROLL or HOLD SCREEN to stop information from moving upward
and off your screen; you press the key again to resume the flow of
information.
Note that you do not lose any information when you use the NO SCROLL
or HOLD SCREEN keys.
If your terminal appears to be doing nothing, you may have inadvertently
pressed NO SCROLL or HOLD SCREEN. If your terminal does not have
either a NO SCROLL or HOLD SCREEN key, see the discussion of CTRL/S
and CTRL/Q in Chapter 11.

3.2.6 Other Keys
See Chapter 11, More About Using Your Terminal, for more complete
information on keys, character names, and other terminal specifics.

Using Your Terminal 3-13

3.3 The Keypad
The VT100-series terminals have a second set of keys to the right of the
main keyboard, arranged much like a calculator's keypad. These keys
make up the alternate keypad.
The keys of the alternate keypad are available for special functions. When
you use EDT, the DIGITAL standard editor, you can use these keys to
easily edit text. In addition, some functions of the operating system use
these keys. They may be used in many other ways, depending on the
other applications your operating system is running.
The following list describes only the uses of the alternate keypad while
you are in DCL. See Chapter 4 for a description of how you use these
keys to execute EDT editing commands.
Keypad Key

Function

NUMBERS

Work in the same way as the numbers on the regular
keyboard.

PERIOD

Works in the same way as the period on the regular
keyboard. It can be used for including the decimal
point in numbers.

ENTER

Works the same as the RETURN key on the main
keyboard.

PF KEYS

Reserved for special functions. They are not used at
monitor level.

ARROW KEYS

Used for cursor control by EDT, but are otherwise
available for special functions.

The VT200-series terminals have both the alternate keypad and, between
it and the keyboard, another keypad with editing functions printed on the
keys. The middle set of keys make up the editing keypad.
The six labeled keys on the editing keypad are available for special
functions. They are defined by EDT as well as by many applications.
The keys of both keypads can have odd effects if pressed accidentally.
These keys each send an ESCAPE character plus one or more other
characters to the operating system. The ESCAPE is a nonprinting character,
but the associated printing characters may be echoed on the terminal
causing an error, such as

asl -- Illegal function
3-14 Using Your Terminal

No harm is done by this.

3.4 The CTRL Key and Control Characters
The key marked CTRL is called the control key. It is used much like the
shift key on a regular typewriter. If you hold down the CTRL key and then
press another key, you are sending a command to the operating system.
The CTRL key alone has no effect.
The combination is designated by CTRL/a, where a is the chosen letter
key.
When the combination is echoes on your terminal, the CTRL key is
represented by the circumflex (A). Press a CTRL/U and you see a AU
on your terminal.
Micro/RSX recognizes 11 letters combined with the CTRL key. Only the
most important are discussed here. See Chapter II, for information on the
others.
With the exception of CTRL/Z, the control characters are commands directed
to the operating system and not to any task you may be running from
your terminal. This means that they usually work without interfering with
such tasks. For instance, CTRL/O is used to skip over terminal output. It
skips over any output, whether sent by DCL, the Task Builder, an editor,
or any other system function. It only skips output. It does nothing else.
Note
Although you must press two keys to enter a control
character, the system considers a control character as a
single character.

3.4. 1 CTRL/C
On most Micro/RSX systems, CTRL/C aborts a task running from your
terminal. At any time that you want to stop a task from running, simply
press CTRL/C. This does no harm to the task itself. You should remember,
however, that the task has stopped whatever it was doing and therefore
may have left some file or job in an incomplete state. In general, this will
not be a problem, but you should be aware of the situation.
More sophisticated users can alter CTRL/C's behavior. See Chapter 11,
for more information.

Using Your Terminal 3-15

3.4.2 CTRL/O
This control character is used to skip over unwanted output to your
terminal. It is analogous to the fast-forward control on a tape recorder.
If you type a single CTRL/O in response to undesired output, the output
stops appearing on your terminal, but the system continues to generate the
output. It can do this much faster when it does not have to print it on the
terminal. If you type another CTRL/O, the output picks up at the point
the operating system has reached, not the point at which you typed the
last CTRL/O. If you do not type another CTRL/O, the system continues to
generate the output until it reaches the end, whereupon a prompt appears
and you may continue in response to the prompt.
If you are printing multiple files on your terminal, the CTRL/O will be
canceled at the end of each file. For example, if you have typed
$ TYPE *. LST [Bill

the system will start with the first file of the type .LST in your directory.
If you suppress this output with a CTRL/O ~ the system will start printing
again as soon as it reaches the beginning of the next file of the type .LST.

3.4.3 CTRL/Z
A CTRL/Z in response to a prompt or at the end of a command line cancels
the command.
CTRL/Z is also used as a command within many system tasks.

If your terminal does not respond, a CTRL/Z will often clear it.

A CTRL/Z in response to a request for input from an indirect command
file cancels the execution of the remainder of the file.
Fundamentally, CTRL/Z signals the system that you have finished typing
input.

3-16 Using Your Terminal

3.4.4 CTRL/U
CTRL/U deletes the current line on your terminal. It is as if the line had
never been typed. The system responds with a carriage return and a line
feed so that the line can be retyped.
If you use CTRL/U with a CREATE command to delete a line, the line you
have deleted will appear as a blank line within the fHe.

In three instances, a AU may appear on your terminal without your having
entered a CTRL/U.
1. The system automatically sends a CTRL/U to any terminal that has
been awaiting input past a 4-minute time-out limit. This means that
any line that is not terminated within the 4-minute limit is wiped out,
as indicated by the CTRL/U that appears at the terminal. If you have
typed in a line and then deleted it with the DELETE key, the system
still interprets this as a line awaiting input and sends the CTRL/U when
the time-out limit passes.
2. If you try to type more than 80 characters on a line without using
a hyphen to continue the line, the system automatically cancels
the command and indicates this by sending a AU to the terminal.
See Chapter 2, How To Use DCL, for more information on line
continuation.
3. Finally, if there is no available pool space when you type in a
command, the system sends a AU to your terminal informing you
that your command has been canceled. Pool is the section of the
computer memory where Micro/RSX keeps track of what it is doing.
When the system is very busy, the system may run out of available
pool space and refuse to accept your command. If this happens, the
condition will probably be corrected shortly. Try typing the command
again. If this does not work after some reasonable interval, you may
want to consider rebootstrapping the system. See the Micro/RSX System
Manager's Guide for more information.

3.4.5 CTRL/G
CTRL/G inserts a beep (buzz, bell) in a file or message. CTRL/G cannot
be the first character in a line. See Chapter 4, EDT, for more information
on including this signal in your files.

Using Your Terminal 3-17

3.5 HELP
HELP displays information about DCL commands and other information
about the operating system. Users can easily add to the information shown
by HELP.
HELP is the only command that you can issue without logging in.

Format
HELP[! OUTPUT:filespec][/ qualifier] [%] [parameter 1] [... parameter9]
Command Qualifiers
/OUTPUT:filespec
/LOCAL
/GROUP
/DCL
/FILE:filespec
/filename

Parameters
No parameters are required for the HELP command and there are
no prompts. You can get help on any given DCL command or
subtopic, however, by typing a question mark (?) in response to the
prompts from DCL. You can also get help by typing a question mark
in response to the dollar sign prompt ($). Examples follow at the end
of this section.
The HELP command without qualifiers or parameters displays the list
of commands for which help is available. This display also contains
information on getting more help.
The displays for all forms of the HELP command are stored in help
files, which are text files in help file format. See Chapter 11, for
information on writing help files. Users can write help files for their
entire system, for a group of users, or for themselves alone.
parameter 1
If you include a parameter in the HELP command, you will jump over

the initial HELP display to a display concerning the parameter you
have included. Examples follow at the end of this section.
Usually this parameter will be a command name. When seeking help
on a command, you should always start with a single parameter. The
display always includes directions for getting any available further
help.

3-18 Using Your Terminal

parameter9

There can be up to nine levels of help. In any case, the number of
parameters you enter determines the display shown; you always jump
over intervening displays.

Command Qualifiers
/OUTPUT:ftlespec

Permits you to name an output file where the requested help text is to
be saved. Use this feature to make your own library of help files that
you have found useful. You must be logged in to use this qualifier.
The following qualifiers are mutually exclusive. These qualifiers have the
effect of naming a file where the requested help text is located. No matter
which qualifier you use, you can still include up to nine parameters.
/LOCAL

Specifies that the help text is in the file HELP .HLP in the default
directory on the default volume. You can specify a local help file in
two ways: HELP /LOCAL or HELP%. You must be logged in to use
this qualifier.
/GROUP

Specifies that the help text is in the file HELP .HLP in the directory
[current group,I] on the default volume. All users with the same group
number have access to this file by typing HELP/GROUP. Examples
follow at the end of this section. You must be logged in to use this
qualifier.
/OCL

Specifies that you want help on a DCL command. For this qualifier,
the help text begins in the file LB:[1,2]DCL.HLP. This is the default for
Micro/RSX systems.
/FILE :ftlespec

Specifies any file where help text is located. If you do not give a
complete file specification, the defaults are LB:[1,2]filename.HLP. You
must be logged in to use this qualifier.
/ftlename

Specifies that the help text begins with LB:[1,2]filename.HLP. When
using this qualifier, you cannot specify the device, directory, or
extension, only the file name. You must be logged in to use this
qualifier.

Using Your Terminal 3-19

Examples
• HELP [@]
For help on logging in, type: HELP LOGIN
Help is available for DCL commands, utilities, and system features.
You can receive help by typing either HELP or ? in response to the
DCL prompt, followed by the desired topic. For example, for help on
the COPY command type either HELP COPY or ? COPY. To simplify HELP
text, the HELP files indicate only the first of these two formats.
Also note that you can type HELP requests in either upper or lower case.
Help is available for the following DCL commands:
ABORT
ALLOCATE
ANALYZE APPEND
ASSIGN
BACKUP BROADCAST
BYE
CANCEL
CONTINUE
CONVERT COPY
CREATE
DEALLOCATE DEASSIGN
DEBUG
DEFINE
DELETE
DIFFERENCES DIRECTORY
DISMOUNT EDIT
FIX
HELLO
HELP
HOLD
INITIALIZE INSTALL LOGIN
LIBRARY
LINK
LOGOUT
MOUNT
PRINT
PURGE
RELEASE RENAME
REQUEST RUN
SET
SHOW
START
STOP
SUBMIT
TYPE
UNFIX
UNLOCK
For information on a command, type HELP commandname.
Additional help on a particular qualifier is often available
by typing:
HELP commandname qualifier.
For information on utilities and system features, type HELP MORE.
For the short forms of some commands, type HELP BRIEF.
In addition, your Micro/RSX system may include other software, such
as BASIC or FORTRAN and HELP will be available for those features.
For information on utilities, system tasks, and other system
information, type HELP MORE. For the short forms of some commands,
type HELP BRIEF. For help on logging in, type HELP LOGIN.

This example shows the initial display from HELP. The user typed HELP
without parameters or qualifiers at a DCL terminal.
• TYPE [@]
File(s)? ? @IT]
TYPE[qualifier[s]] filespec[s]
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mm-yy/THROUGH:dd-mmm-yy
/TODAY
/EXCLUDE:filespec

3-20 Using Your Terminal

The TYPE command displays the contents of text files on your terminal.
File(s)?

This example shows the display that results from typing in a question
mark (?) in response to a prompt from DCL. The same display results
from typing HELP TYPE.

S SHOW !Bill

Function? ? !Bill
SHOW thing
The SHOW command can be used to show something. The following
things can be shown with this command:
ACCOUNTING
[DAY] TIME
LIBRARY
QUEUE
TERMINAL
ASSIGNMENTS
DEFAULT
PARTITIONS
SYSTEM
UIC
CLOCK_QUEUE
DEVICES
PROCESSOR
TASKS
USERS
COMMON
ERROR_LOG
PROTECTION
Abbreviation: S
Function ? ? TIME !Bill
SHOW DAYTIME
SHOW TIME
The SHOW TIME command displays the current time and date. The time
is in 24-hour format and the date is formatted as dd-mmm-yy.
Function?

This example shows the display that results from typing a question mark
( ?) and a parameter in response to a prompt from the SHOW command.
The same display results from typing HELP SHOW TIME.

3.6 BROADCAST
BROADCAST displays a specified message at one or more terminals.

Format
BROADCAST
To? [ttnn:]
Message? message
BROADCAST / qualifier
Message? message
BROADCAST usemame message
BROADCAST @filespec

Using Your Terminal 3-21

Command Qualifiers
/ALL
/LOGGED-IN

Parameters
ttnn:

Specifies the terminal to which you want the message to be sent.
Terminals need not be logged in to receive messages, but they must
be turned on (powered).
If you do not specify a destination for the message, the message is
sent to pseudo device CO:, the operator's console.
message

The message must fit on a single line, but the final character can go in
column 80. The message can include any printing character. Lowercase
letters are converted to uppercase unless enclosed in quotation marks
(" ).

username

Specifies the user to whom you want the message to be sent. The
message goes to all terminals the user is logged in on. The username
must be the same as that shown by the SHOW USERS command.
If SHOW USERS does not display any names, you cannot send a
message by name.
If you have two users on your system with the same last names, you
can separate the usernames by preceding their last name with their
first initial immediately followed by a period (for example, P.ROBUST
and M.ROBUST).
@ftlespec

Specifies the name of an indirect command file. All users can send
multiple messages or multiple copies of the same message using this
method. See the example. The file should contain messages in the
following format:
TTnn:message
Privileged users can also use the privileged qualifiers in the following
formats to send messages to multiple terminals:
ALL:message
LOGGED-IN :message

3-22 Using Your Terminal

The indirect command file cannot include any Indirect directives or
labels, only destinations and messages. The destination cannot be
preceded by tabs or blanks.

Command Qualifiers
fALL

This privileged qualifier sends the same message to all powered
terminals, excluding slaved terminals.
fLOGGED_IN

This privileged qualifier sends the same message to all logged-in
terminals.

Examples
• BROADCAST @ill
To? TT2: @ill
Message? Meet me in the alley behind the barn.

The message is printed on TT2:.
30-MAY-86
From FEDERICO (TTt:)
MEET ME IN THE ALLEY BEHIND THE BARN.

To: TT6:

•

As the message arrives, the terminal's audio signal (beep, buzz, or bell)
sounds. Notice that the message is printed in uppercase characters on the
receiving terminal.
• BROADCAST TT2:

"This is a one-liner." @ill

This is the one-line form of the command. Because the message was
included within quotation marks ("), it appears on the terminal in exactly
the same form as it was sent:
30-MAY-86
From FELLINI (TTt:)
"This is a one-liner."

TO TT2:

•

• BROADCAST/LOGGED_IN @ill
Message? Everybody take the rest of the day off. @ill

The message is printed on all logged-in terminals. This is a privileged
command.

Using Your Terminal 3-23

• BRO ODAILY ~

The file DAILY.CMD contains the following messages:
TTl :"Where is the Ditko contract?"
TT3:"Meet me for lunch at 11:30"
TT7:"The quick brown fox jumped over the lazy dog"
TT5:"Get back to work"
TT4:"I lost the Pearson account. Have you seen it?"
The messages are sent to the designated terminals. Privileged users can
also include messages preceded by ALL: and LOGGED-IN:.
Notes

B is the short form of BROADCAST.
Only terminals can receive messages. You can send a message to yourself
to test the BROADCAST command, using the form BROADCAST TI:.
If you want your message to include lowercase characters when printed,
enclose the message in quotation marks (").

All messages include one beep (buzz or bell, depending on the terminal).
If you want your message to include extra beeps, simply press CTRL/G to
add them.
If the message cannot be broadcast within 10 seconds, the system displays
the following message at the initiating terminal:
BRO---Terminal is busy---TTnn:

If a user specifies multiple destinations, the system returns an error message
for each busy terminal.

The BROADCAST command uses the write-breakthrough feature of the
terminal driver. This means the message breaks through any kind of I/O
at the destination terminal. If you are editing, for instance, the message
may appear in the middle of your text, but in fact it has no effect on the
text you are editing. You can issue a SET TERMINAL/NOBROADCAST
command if you do not want to receive broadcasts. See Chapter 11.

3-24 Using Your Terminal

Error Messages
BRO-Command Input error

Explanation: The BROADCAST task did not receive the command line.
User Action: Often, this message results from a missing indirect
command file. Locate the file, or check for proper syntax and enter
the command again.
BRO-Command syntax error

Explanation: The command syntax was not correct.
User Action: Check for proper syntax and enter the command again.
BRO-lilegal device speclfted

Explanation: The destination device was not a terminal.
User Action: Check for proper device and enter the command again.
BRO-Prlvlleged command

Explanation: Nonprivileged users cannot send messages to all connected or logged-in terminals.
User Action: Use an indirect command file to send messages to multiple
terminals from a nonprivileged terminal.
BRO-User not receiving messages
BRO-TTnn:message

Explanation: The message was sent to a terminal set to NOBROADCAST.
User Action: Wait and try again.

3.7 SET and SHOW TERMINAL
SET TERMINAL and SHOW TERMINAL are complementary commands. SET TERMINAL establishes terminal characteristics, and SHOW
TERMINAL displays information about terminal characteristics.
Only a few of these characteristics are described here. See Volume 2,
Chapter 11, for much more information. Also, for detailed information
about these characteristics, see the discussion of the full duplex terminal
driver in the Micro/RSX I/O Drivers Reference Manual, available separately
and included in the Micro/RSX Advanced Programmer's Kit.

Using Your Terminal 3-25

3.7.1 SET TERMINAL
SET TERMINAL establishes various attributes of your terminal.
This command description covers the /INQUIRE qualifier, which sets the
appropriate attributes of your terminal for you based on the type of terminal
you are using. In addition, this section describes one other frequently used
qualifier for setting terminal characteristics, /[NO]BROADCAST.
See Volume 2, Chapter II, or the help files, for the complete list of
attributes you can set, particularly if you are a programmer or privileged
user.
Format
SET
Function? TERMINAL
Terminal Attribute? /attribute[s]
SET TERMINAL/attribute[s]
Attributes
/[NO]BROADCAST
/INQUIRE
Attributes
/[NO]BROADCAST

Establishes whether you want to receive broadcast messages on your
.
terminal. The default, /BROADCAST, is to receive broadcasts.
The /NOBROADCAST qualifier limits the messages that appear on
your terminal. This command prevents messages from appearing
on your terminal that another user sends with the BROADCAST
command. The operating system notifies senders that you are not
receiving messages. In addition, this command restricts messages from
the system shutdown task when it is shutting down the operating
system. Your terminal does not display any messages about the
impending shutdown of the system except those issued in the last five
minutes. However, your terminal still receives messages from other
tasks.
/INQUIRE

Tells the operating system to set all appropriate attributes for that type
of terminal. The /INQUIRE qualifier is perhaps the most useful of
all qualifiers to SET TERMINAL. It is good practice to include SET

3-26 Using Your Terminal

TERMINAL/INQUIRE in your LOGIN.CMD file if you do not always
log in to the system with the same terminal.
These attributes are described in detail in Chapter 11, Volume 2, and
include all the attributes listed there under Terminal Setup. In addition,
SET TERMINAL/INQUIRE sets the terminal width at 80 columns.
SET TERMINAL/INQUIRE sends a Querv to the terminal to find out
what model it is imd then issues the SET TERMINAL command for that
terminal model. The following DIGITAL terminals are set explicitly:
VT52, VT62, the VT100-series (VT100, VT101, and VT105 are all set
VT100; VT102 is set VT102), the VT200-series, the DECmate II and the
Rainbow 100-series (these two types are set VT102), the Professional
300-series, LA34, LA38, LA100, and LA120. All other terminals are
set /HARDCOPY, WIDTH:80, and considered Nunknown" models.

Note
You can find how all attributes are set for your terminal with an unadorned
SHOW TERMINAL command. See the next section.

3.7.2 SHOW TERMINAL
SHOW TERMINAL displays information about your terminal. The display
from this command includes all the attributes of your terminal. Most of
these are set automatically and will be of no interest to you. For a full
description of the meaning of all attributes, see Volume 2, Chapter 11.

Format
SHOW
Function? TERMINAL[ :TTnn:]
SHOW TERMINAL[:TTnn:]
Qualifiers
/[NO]PRIVILEGED
/HT
/RT
/TI:

/[NO]BROADCAST
/TT
/VT

Using Your Terminal 3-27

Command Option
TTnn:
Identifies the terminal about which you want to display information.
The default is your terminal, TI:.
An unadorned SHOW TERMINAL command, such as the following:
• SHOW TERMINAL

llim

or
• SHOW TERMINAL: TT6:

llim

displays all the attributes set for your terminal or the terminal you
name. See the examples.
SHOW TERMINALI ALL displays information about all terminals on
the system.

Qualifiers
Each SHOW TERMINAL qualifier directly relates to a SET TERMINAL
qualifier. The meaning of each qualifier, including I[NO]PRIVILEGED
and I[NO]BROADCAST, is discussed under SET TERMINAL in
Volume 2, Chapter 11.

IHT
IRT
ITI:

ITT

IVT
These qualifiers display information about particular types of terminals
on the system. The IHT and IRT qualifiers display a list of DEC net
host terminals. The ITI: qualifier displays information about your
terminal and is the same as SHOW TERMINAL without any qualifier.
The ITT qualifier displays a list of real terminals on the system.
The IVT qualifier displays a list of virtual terminals, which are used
in batch processing.

3-28 Using Your Terminal

Examples
• SHOW [BIT!
Function?" TERMINAL [BIT!
TT3:
[MCHEARTY]
09-APR-86 1
B. MCHEARTY
CLI = DCL
BUF
80.
HFILL = 0
SPEED=(9600.9600)
LINES = 24.
TERM = VT220
OWNER = SELF
BRO
NOABAUD
LOWER NOPRIV NOHOLD NOSLAVE NOESC NOCRT NOFORM NOREMOTE
ECHO
NOVFILL NOHHT NOFDI
WRAP
NORPA NOEBC TYPEAHEAD
CTRLC AVO
ANSI
DEC
NOEDIT NOREGIS NOSOFT NOBLKMOD
SERIAL NOHSYNC NOPASTHRU
TTSYNC

This example displays all the attributes for the user's own terminal. The
command is the equivalent of SHOW TERMINAL:TI:. The attributes
include the terminal number, the default directory, plus all the attributes
that can be set with SET TERMINAL. See Volume 2, Chapter 11 for a full
explanation of all these attributes.
• SHOW TERMINAL:TT6: [BIT!
TT6:
[THEFROG]
09-APR-86
1
K. THEFROG
CLI = DCL
BUF
80.
HFILL = 0
SPEED=(9600.9600)
LINES = 24.
TERM = VT100
OWNER = none
BRO
NOABAUD
LOWER PRIV
NOHOLD NOSLAVE NOESC CRT
NOFORM NOREMOTE
ECHO
NOVFILL NOHHT NOFDI
WRAP
NORPA NOEBC
TYPEAHEAD
CTRLC AVO
ANSI
DEC
NOEDIT NOREGIS NOSOFT NOBLKMOD
SERIAL NOHSYNC NOPASTHRU
TTSYNC

This example displays all the attributes for another terminal.
• SHO TERM/PRIVILEGED [BIT!
PRIV=TT7:

• SHO TERM/NOPRIVILEGED [BIT!
NOPRIV=TTO:

• SHO TERM/PAGE_LENGTH [BIT!
LINES=TT7:24

This example displays the page size (screen size) of the terminal from
which the command was issued. A nonprivileged user cannot display the
page size of another terminal with this command. Use the unadorned
SHOW TERMINAL and name the terminal about which you want the
information.

Using Your Terminal 3-29

$ SHO TERM/REMOTE @[B
REMOTE=TTl :
$ SHO TERM/LOCAL @[B
NOREMOTE=TT12:

$ SHO TERM/NOLOCAL @[B
REMOTE=TTl :
$ SHO TERM/NOREMOTE @[O
NOREMOTE=TT12:

This command shows which terminal numbers are assigned to telephone
lines so that callers with terminals and modems can log in from elsewhere.
Remote terminals access the system through dial-up lines while local
terminals are hard-wired to the computer.
This attribute has nothing to do with the LOCAL/REMOTE switch found
on some terminals. This attribute has nothing to do with DECnet host
terminals either.
The LOCAL/REMOTE switch on a terminal sets a terminal as a typewriter
or terminal, respectively.

3-30 Using Your Terminal

Chapter 4

EDT

4. 1 Introduction to the EDT Editor
EDT is an interactive text editor. You can use EDT to edit many kinds of
text files-letters, memos, or complex computer programs. With EDT you
can create new files, insert text into them, and edit that text. You can also
edit text in existing files.
EDT offers many features to make text editing easier and more effiCient.
These features include the following:
•

Three methods of editing: keypad, line, and nokeypad.

•

On-line HELP. You can use HELP any time during your editing session
without affecting your work.

•

Journal facility. This feature allows you to recover edits lost during a
system interruption.

•

Multiple buffers. You can place different pieces of text in separate
storage areas, allowing you to more easily organize modular programs
and documents.

•

Start up command files. These files enable you to personalize the
characteristics of your editing sessions.

•

Key definition facility. You can define keys to perform your most
frequent types of edits.

EDT

4-1

•

EDT macros. You can create a series of editing commands to automate
your editing work.

•

Tabbing facility. This feature enables you to create layered text formats.
It is particularly useful for writing structured programs.

The best way to familiarize yourself with EDT is to follow the examples
presented in the Introduction to Micro/RSX. These examples are intended
for those who have never used an interactive editor, although even
experienced users who do not know EDT can speed up the learning
process by reading and trying them as well. Another way to learn about
EDT is to use the help text available from EDT itself and try out the
various operations described there.
This chapter adds to the information on EDT presented in the Introduction
to Micro/RSX. It tells you how you can extend and customize EDT in
a number of ways, and how you can use all its features. If you want
even more information about EDT, see the EDT Editor Manual, which is
available separately.
The rest of this section presents basic concepts of EDT. The following
sections discuss the three types of editing available, including the linemode commands you use to control EDT's actions and displays. Also
described are advanced editing features such as macros, key definitions,
startup command files, and structured tabs. Finally, there is a summary of
all the EDT commands and a section that describes the EDIT command as
well.
Note the following conventions used in this chapter:
•

Capital letters indicate the portion of an editing command that you
must type. For instance, EXit means that you only need to type EX to
execute this command. Likewise, Insert indicates that you need only
type the I.

•

The expression "press the PASTE keypad function (GOLD 6)" means
to press first the GOLD key (PF1) and then the 6 key. The keypad
keys of the alternate keypad have numbers and symbols on them.
However, the text in this chapter describes editing functions rather
than keypad numbers or symbols. The keypad numbers are provided
along with a description of a function to help you execute your edit.
This convention is used in keypad mode.

4-2 EDT

4. 1. 1 Starting an Editing Session
To create a new text file or to edit an existing file, you type the command
EDIT followed by a file specification. (After you have familiarized yourself
with EDT by reading through to Section 4.6, you may want to refer
to Section 4.7 for more detailed information about the EDIT command.)
Note that EDT does not destroy the contents of any existing file that you
edit; it simply produces a new version, leaving the oid version intact.
(See Chapter 5 for an explanation of how to name a file.)
The following example shows how you invoke EDT to edit a file that you
named MEMO.TXT:
•

EDIT MEMO. TXT [Rill

If MEMO.TXT is a new file, you will see the message NInput file does not
exist" followed by the end of buffer sign ([EOB» and the asterisk prompt
( .). (A buffer is a temporary storage area for your text. The [EOB] sign
with no text preceding it indicates that there is no text in this file.) If
MEMO.TXT is an existing file, a copy of the first line of text appears on
the screen followed by the asterisk prompt (.).

The asterisk prompt (.) indicates that EDT is ready to accept a command.
You are now ready to select one of EDT's three editing methods.

4. 1.2 Choosing an Editing Mode
Once you enter EDT, you can choose among three different editing
methods-also called modes. These three modes are called line, keypad,
and nokeypad (which is briefly discussed only in Sections 4.1.2.3 and 4.6.6).

4. 1.2. 1 Keypad Mode
After you enter EDT, you can enter keypad mode (or character mode) by
typing the CHANGE command after the asterisk prompt (.).
In keypad mode, you enter text by typing at the keyboard. You execute
editing commands by pressing one or two keys on the terminal's numeric
keypad. Unlike line mode, you can edit individual characters in the text.
You move the cursor to the exact point in the file at which you want to
edit the text, and you see your editing revisions as they happen.
Using keypad editing commands, you can move the cursor over entities
of text-such as words, paragraphs, and pages-delete and undelete these
entities, change the case of letters, move text around, and locate specific text
in the file. In addition, you can enter line-mode commands, and you can

EDT

4-3

define nokeypad commands to be executed when you press certain keys.
See Section 4.3.8 for information on how to enter line-mode commands
from keypad mode, and Section 4.5.2 for information on defining keys.
The advantages of keypad editing are the speed with which you can enter
text and the continual display of the text you have created. You enter
text by simply typing it, rather than preceding it with an Insert command,
as you must do in either line or nokeypad editing. Entering commands
through the keypad is fast and easy, requiring only that you press one
or two keys to execute an edit. The continual display of text as you edit
it means that you generally have fewer errors (you catch more of them
as you enter them) and you spend less time reworking what you have
already entered. These advantages make keypad mode the most popular
editing style.
The only major disadvantage of keypad editing is that you cannot use it
conveniently on hardcopy terminals. Almost all users of video terminals
prefer keypad editing.
The format of the command keypad is different for the VT100- and VT200series terminals. The VT200-series terminals have an additional editing
keypad, which does not execute EDT editing commands. Figures 4-1
and 4-2 show the layout of the keypads for these two terminals.

4. 1.2.2 Line Mode
When you enter EDT, you enter line mode by default. You know you are
in line mode when you see the asterisk prompt (.).
Line mode commands accomplish three types of editing tasks:
1. Editing lines of text
2.

Controlling the display and automatic actions of EDT

Performing complex editing functions, when you use a series of these
commands to define a macro

Line editing refers to an editing style in which the smallest unit of text
you can handle is a line. You enter text into a file by typing first the Insert
command and then your text. EDT numbers these lines of text for you.
You revise the text by typing EDT commands after the asterisk prompt ( • ).
Frequently, you also type line numbers to indicate the range of text you
want the EDT command to affect. EDT executes your editing command,
then-once the edit is complete-displays your revisions one numbered
line at a time.

4-4

EDT

Figure 4-1:

VT 1~O-Series Keypad

J1.J f-,J ~J

ZK-1377-83

The advantages of line editing are its ease of use and its flexibility.
EDT's line-mode commands are simple English words that have obvious
functions. There are only a few commands, so you can learn and remember
them easily. Line editing is especially handy for dealing with large blocks
of text. In addition, you can work on either a video terminal or a hardcopy
terminal using the same editor commands.
The disadvantages of line editing are its limited range of functions and
the lack of display. For example, key definitions perform useful and
often complex operations on files, but they do not work in line mode.
In addition, your inability to see what you are editing may increase the
number of errors in your text. Because of these disadvantages, most
users who have video terminals use keypad mode, with a few line-mode
commands entered from keypad mode. See Section 4.3.8 for information
on how to enter line-mode commands from keypad mode.
In addition to editing lines of text, you use line-mode commands to
control the automatic actions of EDT and to display information about
your editing operations. For example, these line-mode commands will
change you from one editing mode to another, then display for you the
mode you are currently in. They can also set terminal characteristics, such

EDT

4-5

Figure 4-2:

VT200-Serles Keypad

G
INSERT
HERE

FIND

RE·
MOVE

SELECT

PREV
SCREEN

NEXT
SCREEN

~
15

l'
1

~
13

ZK-1380-83

as screen width, as well as copy other text files into your current editing
session. See Section 4.4, which describes some frequently used line-mode
commands for controlling EDT.
You also use line-mode commands to build macros. Macros are groups
of line editing commands which perform complex functions that a single
command cannot provide-such as deleting a line and inserting a new line
all at once. See Section 4.5.1 for more information on defining macros in
EDT.

4-6

EDT

4. 1.2.3 Nokeypad Mode
After you enter EDT, you invoke nokeypad mode by typing the following
commands after the asterisk prompt (.):
*SET NOKEYPAD
*CHANGE lliITJ

lliITJ

If your terminal is not a VT52, VT100- or VT200-series, EDT assumes it has
no keypad. In this case, if you enter a Change command after invoking
EDT, you go into nokeypad editing. If you issue the SEt NOKeypad
command on any terminal, any editing that follows is in nokeypad mode.

Nokeypad editing combines features of line and keypad editing. Nokeypad
editing is designed for a terminal that has a video screen but no keypad.
Like line editing, you do not need a keypad because you type the names
of the editing commands on the keyboard. Also, you enter text into the
file by typing the Insert command followed by the text you want to enter.
However, nokeypad editing resembles keypad editing in two respects: you
can edit individual characters in the text, and EDT displays your editing
revisions as they happen.
Using no keypad commands, you can execute such standard editing
operations as deleting and un deleting text, moving text around, moving
the cursor over entities, substituting one string for another, and inserting
structured tabs. (See Section 4.5.4 for information on using structured
tabs.) In addition, you use nokeypad commands to construct special key
definitions to customize your keypad editing environment. You can also
enter line-mode commands by using the EXTend command followed by
the line-mode command you want.
The advantages of nokeypad editing are its power in dealing with entities
of text and its use in constructing key definitions for keypad editing. Unlike
line and keypad editing, nokeypad editing can work not only on lines,
words, and characters, but on defined entities such as pages or paragraphs
as well. This gives you great flexibility in dealing with a complex editing
task, since you can refer to pieces of text more precisely. Constructing
strings of nokeypad commands to use as key definitions in keypad editing
allows you to use this power and flexibility along with the simplicity of
keypad editing.
The disadvantages of nokeypad editing are the relatively complicated
command formats and the necessity of entering text by using the Insert
command. Since many of the nokeypad commands work on entities, you
must remember the names of the entities as well as the commands. The

EDT

4-7

command formats often accept repetition counts and directions, further
complicating the process of entering commands.
Unless you have a terminal with no keypad, you will find that the nokeypad
commands are most often used in constructing key definitions to be used
with conventional keypad editing. All the keypad keys, plus many other
keyboard keys, can be defined or redefined to perform editing functions of
your own choice. See Section 4.5.2 for more information on key definition.

4. 1.3 Moving Among Editing Modes
Once you become familiar with the three modes of EDT, you will want
to travel between them. Table 4-1 lists the commands you need to
know to move between the line and keypad modes.
Table 4-1: Moving Between Editing Modes
From

Command

Line Mode

Keypad Mode

*CHANGE

Line Mode

Nokeypad Mode

* SET NOKEYP AD
* CHANGE

Keypad Mode

Line Mode

CTRL/Z
or GOLD/7

Keypad Mode

Nokeypad Mode

CTRL/Z
*SET NOKEYPAD
*CHANGE

Nokeypad Mode

Line Mode

Nokeypad Mode

Keypad Mode

EX
EX
*SET KEYPAD
*CHANGE

The following example demonstrates how to invoke EDT to create a new
file named WHY.NOT, enter line mode, enter keypad mode, return to line
mode, and finally enter nokeypad mode.

4-8

EDT

• EDIT WHY. NOT [E§!J 0

Input file does not exist ~

[EOB]
* CHANGE [E§!J.
[EOB]

ICTRl/Z I

e
mm

* SET NOKEYPAD [E§!J.
"'CHANGE

o You type the EDIT command to invoke EDT line mode.
~

"Input file does not exist" appears because you are creating the new
file WHY.NOT.

e EDT responds with the asterisk prompt ( ... ), indicating that you are in
line mode. You type the Change command after the prompt to invoke
keypad mode.

e You press CTRL/Z to return you to line mode.
•

The asterisk prompt ( ... ) indicates line mode. After this prompt, you
type two commands to invoke nokeypad mode: the SEt NOKeypad
command followed by the Change command.

4. 1.4 Getting Help from EDT
EDT help describes all the commands available and presents information
on many concepts of EDT as well.
Each editing mode provides a method for getting help. If you are editing
in line mode, you can type HELP for a list of topicS on which help
is available, or HELP [topic] for information on a particular topic. For
instance, you can get information on how to include another file within
the file you are editing by typing:
*HELP INCLUDE [E§!J

The following command gets information on the definition of EDT linemode macros:
*HELP DEFINE MACRO [E§!J

In keypad editing, you press the HELP key PF2 to get help on keypad
functions. EDT responds with a diagram showing the layout of the
keypad commands for your terminal type. You then can get information
on a particular command by pressing the key that executes the command.

EDT

4-9

In keypad editing, you can also press the COMMAND keypad function
(GOLD 7) to get help. After executing this function, you respond to the
"Command:" prompt by typing HELP [topic], then pressing the keypad
ENTER key. For example, after pressing the COMMAND function, you can
type the following text:
Command: HELP CHANGE

This causes EDT to display the information it has on the CHANGE
command by scrolling the text of your buffer up the screen and replacing
it with the help text. When you finish reading the help text, press RETURN
to resume editing.
If you are doing nokeypad editing, you must type the EXTend command

followed by HELP [topic], using the format for line-mode HELP to get
information. (The EXTend command allows you to execute a line-mode
command from nokeypad mode.) For example:
EXT HELP CHANGE

4. 1.5 Ending an Editing Session
Both the EXit and QUIT commands terminate an editing session; however,
only EXit saves your edits. Note that you enter these commands from line
mode.
When you enter the EXit command, EDT creates an output file containing
the edited version of the input file. By default, the output file has the
same name and type as the input file. (The version number is incremented
by one.) The following example demonstrates how you invoke and then
terminate EDT to create a file named OUTPUT.DAT. The output file has
the same name as the input file, and the version number increases by one.
S EDIT OUTPUT. OAT mill

*EXIT mill
DUO: [SCHEDULE]OUTPUT.DAT;5

2 lines

If you want to override the default, and specify a different output file

name, type the EXit command followed by the new file name. In the
following example, you invoke EDT to edit a file named OUTPUT. OAT
and specify INPUT.DAT as the new file name when you terminate the
session.

4-10

EDT

• EDIT OUTPUT. OAT

ffiill

.EXIT INPUT. OAT ffiill
DUO: [SCHEDULE] INPUT.DAT; 1

2 lines

If you do not want to save your edits when you end an editing session,
type the QUIT command. All the edits you made to the file are lost, and
no new output file is created.

Table 4-2 shows the three modes of EDT, and the commands you enter
to terminate each mode.
Table 4-2: Ending an EDT Session

Mode

Commands to Terminate EDT

Line

• EXit or QUIT
$

Keypad

CTRL/Z
• EXit or QUIT

$
Nokeypad

EX
• EXit or QUIT
$

4. 1.6 Recovering from a Lost Editing Session
While you are editing or inserting text, EDT is keeping track of every
keystroke you enter at your terminal. EDT records this information in a
file called a journal file. If you leave an editing session normally, using
either the EXit or QUIT commands, EDT deletes the journal file. However,
when you experience a system interruption, the journal file is saved so
that you can recover your lost edits.
The journal file does not contain a version of your text. Rather, it contains
a record of the keystrokes you entered during the session. By combining
the journal file with the text that you had at the beginning of your session,
you can recover your session to a point just before the interruption.

EDT

4-11

Note
Sometimes, the last few keystrokes are missing. This is
normal. No work from earlier in your session will be
omitted.

To recover an editing session, use the same command line that you used
to start the session originally, including the same file specification and any
qualifiers you used the first time. Finally, add the /RECOVER qualifier.
This tells EDT to read the journal file and execute the commands that are
recorded in it. EDT reads commands from the journal file and executes
them as you watch. See the examples for the EDIT command in Section 4.7.
The following example demonstrates how to recover a file named
MAILLIST.TXT after the editing session was interrupted. Note that you
had begun the session that was interrupted with the command EDIT
MAILLIST.TXT.
$ EDIT/RECOVER MAILLIST. TXT

lliill

When you work with journal files, you will notice that they have a file
type of JOU. The file name is the same as the file you were editing. The
journal file for MAILLIST.TXT is MAILLIST.JOU. And, the journal file for
HAMMER. LIS is HAMMER.JOU. When you enter the EDIT/RECOVER
command,_ you enter the name of the file with its original file type, not
the .JOU file type. Otherwise you will edit the journal file.

4.2 Using EDT Buffers
Buffers are temporary holding areas for text. You can use the buffers in
EDT to do the following:
•

Move part or all of another file into your editing session

•

Create a file from part or all of the text in a buffer

•

Divide one or more files into sections

See Section 4.5.5.5 for specific examples of how to use buffers.

4-12

EDT

4.2.1 EOrS Permanent Buffers
At the beginning of an editing session, EDT automatically provides a buffer
called MAIN. If you are creating a new file, you insert and edit text in the
MAIN buffer. If you are editing a file that already exists, EDT puts a copy
of the contents of the file into this MAIN buffer.
MAIN e>rists during your entire editing session. Also, you can delete only
the contents of this buffer, and not the buffer itself.
. The other buffer that EDT provides automatically is called the PASTE
buffer. The CUT keypad function (6) deletes text and places it in the
PASTE buffer. You then can use the PASTE keypad function (GOLD6) to
copy the text in the PASTE buffer to other locations, either elsewhere in
your current buffer or into another buffer. Every time you perform a new
CUT operation, EDT clears the PASTE buffer and replaces its contents
with the newly deleted text.
Like the MAIN buffer, you can edit or delete the contents of the PASTE
buffer (You cannot delete the buffer itself. See Section 4.5.5.1 for
information on how to move from the MAIN buffer to an alternate buffer.

4.3 Using Keypad Mode
Keypad editing is available on VT200- and VT100-series terminals. In
keypad editing, the contents of a file are displayed on the screen as you
edit. You can see the changes you make to a file as they take place.
In keypad editing, you press keys to perform editing functions instead of
'
typing commands (as is done in line and nokeypad editing).
The following sections guide you through the many keypad functions. To
understand how each function works, invoke EDT to create a file called
TEST.EDT (Section 4.1.1) and enter keypad mode (Section 4.1.2.1). As you
read each section, follow the examples and experiment with the various
keypad functions in the file you just created.

EDT 4-13

4.3. 1 Using the GOLD Key
You can use the GOLD key for two purposes:
1.

To use the alternate of two functions on a keypad key

To execute a function a specified number of times

To use an alternate function, press the GOLD key followed by the desired
key. (You do not need to hold down the GOLD key.) For example, to use
UND C, you press the GOLD key first, and then the UND C key.
If you want to execute a function a specified number of times (for example,
to use DEL C twelve times), press the GOLD key, type the number 12
(on the main keyboard), and press DEL C. Try it and see how much time
you save. The following steps show how to repeat any keypad function a
specified number of times:
1.

Press the GOLD key.

Type a number.

Press the desired function.

4.3.2 Moving the Cursor
There are many ways to move the cursor in keypad mode. Table 4-3 lists
the 15 keypad functions that move the cursor.
You can use the ADVANCE and BACKUP keypad functions to set the
cursor in a forward or backward direction, respectively. By specifying the
direction of the cursor, you affect eight of the keypad functions: LINE,
EOL, WORD, CHAR, SECT, PAGE, FIND, FNDNXT.
Table 4-3: Moving the Cursor In Keypad Mode

4-14

Function Key

Destination of Cursor

TOP

Beginning of buffer

BOTTOM

End of buffer

LEFT arrow

One character to the left

UP arrow

Up one character

RIGHT arrow

One character to the right

DOWN arrow

Down one character

EDT

Table 4-3 (Cont.):

Moving the Cursor In Keypad Mode

Function Key

Destination of Cursor

LINE

One line up or down (depending on the current
direction of the cursor)

EOL

End of the current or previous line (depending on
the current direction of the cursor)

WORD

Beginning of the next or previous word (depending
on the current direction of the cursor)

CHAR

One character to the right or left (depending on the
current direction of the cursor)

SECT

Across a 16-line section of text (up or down,
depending on the current direction of the cursor) or
if there are fewer than 16 lines, across the number
of existing lines

PAGE

Across a page of text (by default, the text between
form feeds)

FIND

Next or previous specified string of text depending
on the current direction of the cursor

FNDNXT

Next or previous occurrence of search string depending on the current direction of the cursor

BACKSPACE

Beginning of the current line

The following example demonstrates how to move the cursor to the
beginning (or top) and to the end (or bottom) of the buffer using the
TOP and BOTTOM keypad functions.
Insert the following three lines of text:
Five golden rings,
four calling birds,
three french hens,

1. Press the GOLD key followed by TOP to move the cursor to the "F"
in the word "Five".
2. Press the GOLD key followed by BOTTOM. Notice the cursor moving
to the left bracket of the end-of-buffer sign [EOB].
3. Press the GOLD key followed by TOP again, moving the cursor back
to the "F".

EDT

4-15

Repeat these steps to become familiar with the TOP and BOTTOM keypad
functions.
The following example demonstrates how to move the cursor using the
four arrow keys: UP, DOWN, LEFT, RIGHT. Insert the following four lines
of text:
Under a toadstool crept a wee elf.
Out of the rain to shelter himself.
Under a toadstool all in a heap.
Sat a big doormouse. fast asleep.

Press the TOP keypad function (the GOLD key followed by TOP) to
move the cursor to the letter "U" in the word "Under".

Press the RIGHT arrow 9 times, then press the DOWN arrow once,
moving the cursor to the "e" in the word "the".

Press the LEFT arrow 5 times, then press the DOWN arrow once,
moving the cursor to the "r" in the word "under".

Press the RIGHT arrow 8 times, then press the DOWN arrow once,
moving the cursor to the second "0" in the word "doormouse".

Press the LEFT arrow 6 times, then press the UP arrow 3 times, moving
the cursor to the word "a".

The following example demonstrates these keypad functions:
TOP
LINE
EOL
WORD
CHAR
Enter the following four lines of text:
ONE TWO THREE FOUR FIVE
SIX SEVEN EIGHT NINE
TEN ELEVEN TWELVE THIRTEEN
FOURTEEN

4-16

Press TOP to move the cursor to the first letter of the word "ONE".

Press LINE once, moving the cursor to the "5" in the word "SIX".

Press WORD twice, moving the cursor to the "E" in the word "EIGHT".
Then press EOL. The cursor will move to the end of the line.

EDT

4. Press WORD three times, moving the cursor to the uT in the word
MTWELVEH. Then press EOL. The cursor will move to the end of the
line.
H

5. If you are using a VT100- or VT200-series terminal, press CHAR four
times. The cursor will move to the uR in the word uFOURTEEN
H

•

Note that the PREV SCREEN and NEXT SCREEN keys (on an LK201
keyboard) work like the SECT keypad function, moving the cursor back or
ahead by 16 lines.

4.3.3 Inserting Text
You can insert text simply by typing the text on the keyboard. No
command is required. Whatever you type becomes part of the file. Your
insertion appears on the screen as you type it and the surrounding text
moves as necessary to accommodate it. The cursor marks the starting
location for the insertion. When you want to begin a new line, press
RETURN to move the cursor to the beginning of the next line and continue
typing your text.
As you type new text, you may notice errors in sUlTounding text. You can
move the cursor to these errors and correct them at any time, and then
move the cursor back and continue to insert text.

4.3.4 Deleting and Undeletlng Text
You can delete text by character, word, and line. DELETE and DEL C
delete characters. DEL Wand LlNEFEED delete words or parts of words.
DEL l, DEL EOl, and CTRl/U delete lines or parts of lines. The deleted
text is stored in one of three buffers so that you can restore it using the
UNO commands (UNO C, UNO W, UNO L). (A buffer is a temporary
holding area for text. See Section 4.2 for more information on buffers.)
The character buffer contains the last character deleted; the word buffer
contains the last word deleted; and the line buffer contains the last line
deleted. Only the most recent deletion can be restored; you can restore
this unit of text numerous times to any location.
Figure 4-3 shows the three buffers that EOT fills when you use the delete
and undelete keys.

EDT

4-17

Figure 4-3:

Three EDT Buffers Used for Deleting and Undeletlng
Text

CHARACTER
BUFFER

WORD
BUFFER

DAY KEEPS THE

LINE

BUFFER
ZK-1260-83

Table 4-4 lists the keypad functions used to delete text:
Table 4-4: Deleting Text In Keypad Mode
Keypad Function

Effect

DELETE

Deletes the preceding character.

DEL C

Deletes the current character.

DELW

Deletes to the end of the word.

LINE FEED

Deletes to the beginning of the previous word.

DEL L

Deletes to the next line.

CTRL/U

Deletes from the beginning of the line to the cursor.

DEL EOL

Deletes from the cursor to the end or beginning of
the line, depending on the current cursor direction.

CUT

Deletes the selected string from the current file and
stores it in the PASTE buffer. The selected string
is all the text between the cursor location when
you pressed the SELECT keypad function and the
position to which you moved the cursor. (Note
that the REMOVE key on the LK201 keypad works
like the CUT keypad function.)

Enter the following three lines of text. Then follow the steps to learn how
to use the delete keypad functions.

4-18

EDT

CHARACTER

WORD WORD WORD WORD WORD
LINE LINE LINE LINE LINE LINE LINE LINE

Move the cursor to the first C in the word "character". Press DEL C.
The C will disappear.

2. Press the GOLD key followed by UND C. The C will reappear.
3. Move the cursor to the H. Press DEL C to make it disappear.
4. Then press the GOLD key followed by UND C. The H is restored.
5. Press the GOLD key followed by UND C again, another H will appear.
Notice that the DEL C keypad function deletes the character directly at the
cursor and the DELETE key (on the main keyboard) deletes the character
immediately to the left of the cursor. You can use the UND C keypad
function to restore the most recently deleted character in either case. Press
the DELETE key and the DEL C keypad function to see the difference
between the two.
1. Move the cursor to the W in "WORD".
"WORD" will disappear.
2.

Press DEL W. The word

Press the GOLD key followed by UND W to restore the word.

3. Press the GOLD key followed by UND W again, another "WORD" will
appear.
Notice that the DEL W keypad function deletes to the end of the current
word, and the LINE FEED key (on the main keyboard) deletes to the
beginning of the preceding word. Press the LINE FEED key to see the
difference between the DEL W keypad function and the LINE FEED key.
Again, you can use the UND W keypad function to restore the deleted
word in either case.
1. Move the cursor to the beginning of the line of LINES. Press the DEL
L keypad function. The entire line will disappear.
2.

Press the GOLD key followed by UND L to restore the line.

3. Press the GOLD key and UND L several times to create multiple lines.
Use the CTRLjU command to delete text from the cursor to the beginning
of the line. Notice that the cursor moves to the beginning of the line.
Press UND L to restore the line.

EDT

4-19

4.3.5 Locating Text
Use the FIND and FNDNXT keypad functions to locate strings of text. When
you press the GOLD key followed by FIND you will see the following
prompt on the screen:
Search for:

Type the string of text you are looking for and press one of the following
keys:
•

ADVANCE

•

BACKUP

•

ENTER

• DO
If you press ADVANCE, EDT will search in a forward direction for the
specified string. If you press BACKUP, EDT will search in a backward
direction. If you press ENTER or DO, EDT will search in the direction
already set.

Note
The ADVANCE and BACKUP keys set the direction for
subsequent EDT commands.
Enter the text below. Press the GOLD key followed by the FIND keypad
function. When you are prompted for a search string, enter the word
Uticket". Then press BACKUP. The search will start at the end of the text
(where the cursor is located) and continue toward the beginning of the
text until it finds the word uticket".
Ella will not be able to attend the concert tonight.
She has a sore throat. Perhaps you could give the ticket
to somebody in your music class. Ella wants to see the
program when she is feeling better.
Search for: ticket

Now search for the word Uprogram". Press the GOLD key followed
by FIND. When you are prompted for the search string, enter the word
"program". If you press BACKUP again, you will see the response "String
was not found" because the word Uprogram" is located after the word
"ticket". Try it. Now press ADVANCE followed by FNDNXT. EDT will find
the string.

4-20

EDT

Ella will not be able to attend the concert tonight.
She has a sore throat. Perhaps you could give the ticket
to somebody in your music class. Ella wants to see the
program when she is feeling better.
Search for: program

Remember the following three items when you are entering a search string:
1. EDT ignores diacritical marks and the case of letters while making
searches (unless you enter the SET SEARCH EXACT command).
2.

DELETE is the only key you can use to edit an incorrectly typed search
string.

3. To cancel a search string, press CTRL/U.
If you want to find the next occurrence of the string you are searching for,
use the FNDNXT keypad function. EDT will search in the direction already
set. If EDT cannot find the string, it will give you the message "String was
not found". You can reverse the direction of the search by pressing either
ADVANCE or BACKUP before pressing FNDNXT.

Enter the text below. Press GOLD and FIND. Enter the search string
"little" when prompted. Because the cursor is at the end of the text, you
must press the BACKUP keypad function to set the search in a backward
direction. Now press FNDNXT nine times. EDT will find each occurrence
of the search string. When the cursor arrives at the first "little", press
the ADVANCE keypad function to reverse the direction of the search.
Every time you press FNDNXT, the cursor will move forward to the next
occurrence of the word "little".
One little, two little, three little chickadees,
four little, five little, six little chickadees,
seven little, eight little, nine little chickadees,
ten little chickadees feeding.
Search for: little

EDT

4-21

4.3.6 Moving Text
You can move text using three different groups of keypad functions:
1.

RETURN and OPEN LINE

DEL L, UNO L, DEL W, UNO W, DEL C, and UNO C

CUT and PASTE (or REMOVE and INSERT HERE)

Using the first method, you press RETURN to move text (with the cursor)
and OPENLINE to move text (without the cursor) down the screen line
by line. Using the second method, you delete a unit of text (character,
word, or line) from one location, move the cursor to another location, and
undelete the text there. (See Section 4.3.4 for more information about
deleting and un deleting text.) You can use the third method, which is
described in this section, to move larger units of text.
Use the following three keypad functions to move text:
1. SELECT
2.

CUT (or REMOVE)

PASTE (or INSERT HERE)

Press SELECT to mark one end of a string of text that you want to delete
or move. Then move the cursor either backwards or forwards, to the other
end of the string and press CUT. Before you press CUT, you can correct a
mistake by pressing the GOLD key followed by RESET to cancel the select
range and start over.
You press CUT to delete the selected string of text from the current file and
store it in the PASTE buffer. (See Section 4.2 for more information about
the PASTE buffer.) The selected text is all the text between the cursor
location when you pressed SELECT and the position to which you moved
the cursor.
If you press CUT before you press SELECT, you will see the message "No
select range active".

You press GOLD followed by PASTE to insert the contents of the PASTE
buffer to the left of the cursor position.
To summarize, use the following steps to move text:

4-22

Place the cursor at the beginning of the text you want to move.

Press SELECT to mark the location.

EDT

3. Move the cursor to the end of the select range.
4. Press CUT to delete the text from its current position.
5. Move the cursor to the character just beyond where you want the text
inserted.
6.

Press the GOLD key followed by PASTE.
Note
If you want to restore the select string to its original location
after you perform Step 4 above, press the GOLD key
followed by PASTE.

Enter the following text:
january february march april
may june july november
december august september october

In order to move the string "august september october" after "july", move
the cursor to the "a" in "august". Press SELECT. Then move the cursor
to the "r" in "october". Press CUT. The selected string will disappear into
the PASTE buffer. Now move the cursor after the word "july" and press
PASTE. A copy of the selected string in the PASTE buffer will appear on
the screen between the words "july" and "november".
If you press PASTE again, you will get another copy of the contents of the
PASTE buffer. Try it. Every time you press PASTE, you will get another
copy of the string "august september october". Once you perform another
SELECT and CUT operation, specifying a different string, the contents of
the PASTE buffer will change. You can always get as many copies of the
PASTE buffer as you want by pressing PASTE.
If you want to add to the text in the PASTE buffer, retaining the text
already there, use APPEND. APPEND deletes the select range from the
current buffer and adds it to the end of the PASTE buffer.

For example, if your PASTE buffer contains the text "Wolfgang Amadeus"
and you want to add the text "Mozart", follow the steps below:
1.

Press SELECT.

Type the word" Mozart". (Precede the word with a space.)

Press APPEND.

EDT 4-23

Now the PASTE buffer contains the text:
Wolfgang Amadeus Mozart

4.3.7 Substituting Text
You can use the SUBS keypad function or the REPLACE keypad function
to replace one string of text with another. The following four steps
demonstrate how to use SUBS to make substitutions:
1. Press SELECT and enter the replacement text.
2.

Press CUT. (The select range will disappear into the PASTE buffer.)

Press the GOLD key followed by FIND and enter the search string.

Press SUBS to exchange the existing text for the replacement text.

When you make substitutions using SUBS, you are using both the PASTE
buffer and the search string buffer. You use CUT to put the replacement
string in the PASTE buffer and FIND to put the string you want to find
and delete in the search string buffer. Figure 4-4 shows both buffers.
Figure 4-4:

Two EDT Buffers Used for Substituting Text

CUT KEYPAD FUNCTION

FIND KEYPAD FUNCTION

REPLACEMENT
STRING

STRING TO BE
DELETED

PASTE
BUFFER

SEARCH
STRING
BUFFER
ZK-1261-83

When you use SUBS, EDT performs the substitution first and then moves
to the next occurrence of the search string. If EDT cannot find another
occurrence of the search string, it prints the message uString was not
found". If you do not want to make a particular substitution, press the
FNDNXT keypad function. The cursor will move to the next occurrence of
the search string. If you want to change that one, press SUBS again. Thus,
you can move through the buffer pressing SUBS each time you want to

4-24

EDT

make a replacement and pressing FNDNXT when you want EDT to leave
the search string alone.
Note
You must use the FIND keypad function when you are
making substitutions with SUBS because you are replacing
text that matches the search string with the contents of the
PASTE buffer. SUBS will not work correctly if you do not
use FIND.

Enter the following text:
Susanne grabbed the red apple and gobbled it down. Suddenly
her face turned quite red. Glancing towards the red house
she saw the huge tree bathed in red leaves.

Now perform the following steps to substitute the word Ugreen n for the
word ured":
1.

Press SELECT and enter the word Ugreen n •

Press CUT. (The word Ugreen n will disappear into the PASTE buffer.)

3. Press GOLD ~ollowed by FIND and enter the word ured n •
4. Press SUBS to exchange the word Ured" for the word Ugreen n •
5. Press SUBS three more times.
Your resulting text should look like this:
Susanne grabbed the green apple and gobbled it down. Suddenly
her face turned quite green. Glancing towards the green house
she saw the huge tree bathed in green leaves.

REPLACE deletes the text in the select range and replaces it with the
contents of the PASTE buffer.

For example, if your PASTE buffer contains the words upaste paste paste",
and your select range contains the words uselect select select", press
REPLACE to make your select range contain the words upaste paste paste".
The following steps demonstrate this example:
1. Press SELECT.
2. Type the words upaste paste paste n •
3. Press CUT. Now your PASTE buffer contains the words upaste paste
paste".
4. Press SELECT again.

EDT

4-25

5. Type the words "select select select".
6.

Press REPLACE. Now your select range contains the words "paste paste
paste".

4.3.8 Five More Keys to Use with the GOLD Key
Five keypad functions associated with the GOLD key are summarized in
Table 4-5:
Table 4-5: Five Gold Key Functions In Keypad Mode

4-26

Keypad Function

Effect

COMMAND

Enables you to enter a line mode
command from keypad mode.

CHNGCASE

Reverses the case of letters in your text.
Uppercase letters become lowercase;
lowercase letters become uppercase.

FILL

Reorganizes the select range so that
the maximum number of whole words
can fit within the current line width.

RESET

Changes the following conditions of
your editing session:

EDT

•

Cancels an active select range.

•

Empties the search buffer so that
there is no current search string.

•

Sets EDT's current direction to
ADVANCE.

•

Sets EDT to the default DMOV
state. (DMOV is a Nokeypad command that returns your editing session to EDT's default state, where
EDT does not alter the case of letters during move operations.)

Table 4-5 (Cont.):

Five Gold Key Functions In Keypad Mode

Keypad Function

Effect

SPEC INS-special insert

Enables you to insert any character from the DIGITAL Multinational
Character Set into your text using the
character's decimal equivalent value.
For information about the DIGITAL
Multinational Character Set, see the
EDT Editor Manual, which is available
separately.

For more information about all the available keypad keys, see the EDT
Editor Manual, which is available separately.

4.4 How to Use Line Mode
You can use EDT's line editing facility with any interactive terminalhardcopy or screen. Line editing uses the line as its point of reference.
EDT moves through the text line by line, not character by character as
in the two other editing modes. Line editing commands are particularly
useful for manipulating large blocks of text.

4.4. 1 Line Numbers and Ranges
To help you locate and edit text, EDT assigns line numbers. These line
numbers are not part of the text and are not kept when you end an editing
session. To see the line numbers of an already existing file, enter the TYPE
WHOLE command after the asterisk prompt (.). You will notice that the
text you enter is indented 12 spaces.
The following example demonstrates how to display your line numbers:

*TYPE WHOLE [Effi
1
2
3
4
5

oneoneoneoneoneoneone
twotwotwotwotwo
threethreethree
fourfourfourfour
fivefivefivefive

[EOB]

EDT 4-27

Line numbers have the following characteristics:

•

They are assigned to every line in every buffer in every editing session,
including newly inserted lines and text added with the INCLUDE
command.

•
•
•
•

They start with 1 and increment by 1.
They are decimal numbers if newly inserted.
They are removed by the EXIT command, unless otherwise specified.
They can be renumbered in increments of 1 or more with the
RESEQUENCE command.

When you want a line mode command to affect a specific part of the
buffer, you must enter a range. Ranges can specify one or more lines. In
addition, the multiple-line ranges can be contiguous or noncontiguous.
Table 4-6 lists and describes the different ranges you can specify when
editing in line mode.
Table 4-6: Ranges for Line Mode

Range Type

Description

period (:)

Current line

number

EDT line number

'string'

Next line containing the quoted string

BEGIN

First line of the buffer

END

After the last line in the buffer ([EOB])

LAST

Last line EDT was at in the previous buffer

WHOLE

Entire buffer

BEFORE

All lines in the buffer before the current line

REST

All lines in the buffer starting with the current line and
ending with the last line

You can use the symbols and words listed in Table 4-7 with the range
types listed in Table 4-6 while editing in line mode.

4-28

EDT

Table 4-7:

Symbols and Words Used In Line Mode

Symbol/Word

Description

, or AND

Used to join noncontiguous ranges in a list;
only single lines can be joined in this way

: or THRU

Indicates a orOUp of lines starting with the
first range specifier and ending with the
second

Indicates the number of lines from the
current line

# n or FOR n

Indicates the next "n" number of lines

+ Mstring" or "n"

Indicates that "string" or "n" refers to a line
or lines after the current line

- Mstring" or Mn"

Indicates that "string" or "n" refers to a line
or lines before the current line

ALL Mstring" or Mn"

Indicates that the command applies to all
lines containing "string"

The following examples demonstrate some of the range types, symbols,
and words listed above.
Examples

TYPE

This command displays the current line.
2.

TYPE 35

This command displays line 35.

TYPE "December"

This command displays the first line it encounters containing MDecember."

TYPE BEGIN

This command displays the first line of the current buffer.
5.

TYPE END

This command displays the [EOB] mark.

EDT

4-29

TYPE WHOLE

This command displays every line in the current buffer.
7.

TYPE 3,6,8

This command displays lines 3, 6, and 8.
8.

DELETE 4 AND 13

This command deletes lines 4 and 13.
9.

DELETE 4#3

This command deletes line 4 and the three lines following line 4.
10. TYPE. FOR 10
This command displays the current line and the next ten lines; the number
10 refers to the tenth line after the current line.
11. TYPE BEGIN +6
This command displays the seventh line of the current buffer.
12.

DELETE -3 THRU .

This command deletes the current line and the three lines preceding it; the
number -3 refers to the third line before the current line.
13. TYPE. THRU 1000 ALL "Date:"
This command displays every line containing the string "Date:" that appears
in the group of lines starting with the current line and ending with line
number 1000.

4.5 Advanced Editing Features
This section describes some features that EDT provides to help you do
more complex tasks. These features include the following:

4-30

•

Defining macros-EDT macros are groups of line-mode commands to
be executed at once. You place a series of commands in a buffer and
then the buffer name becomes a command to perform that series of
commands.

•

Defining keys-EDT key definition is similar to creating a line-mode
macro. You can define a key to perform a series of character-mode
commands, both keypad and nokeypad.

EDT

•

Startup command files-You can define keys or macros in a startup
command file and the key and macro definitions are automatically
ready for use in your editing session. You can also use the startup
file to set your own choice of editor characteristics. You can also use
startup command files to perform batch-style editing.

•

Structured tabs-For programmers writing in structured languages,
such as Pascal, EDT provides structured tabs for easy editing. This
section explains this feature.

•

EDT buffers-You can use EDT buffers to easily move text from one
buffer to another buffer, from a buffer to a file, and from a file to a
buffer. This section explains how to manipulate EDT buffers.

You can do fairly complex operations with macros, and even more complex
operations with key definitions, both of which are simple to write and use.
Finally, you may well accumulate a number of macros and key definitions
you want to save and reuse; the startup command file provides a method
for doing this.

4.5. 1 Defining Macros
You can group line-mode commands and name the group, using the name
as a line-mode command to execute the commands. This process is called
defining and executing a macro. EDT handles macros by creating a buffer
with the same name as the macro and holding the commands in that
buffer. When you enter the macro name, EDT pulls the commands out of
the buffer with that name and executes them.
To define a macro, use the DEFINE MACRO line-mode command. This
command tells EDT to create a buffer with the same name as the macro.
Because the macro name and the buffer name must be the same, the
rules for macro names are the same as those for buffer names: the names
can be 1 to 30 characters in length and may include alphabetic and
numeric characters and underscores (_). Next, enter that buffer (with a
FIND =buffer, CHANGE =buffer, or =buffer command) and insert text that
consists of line-mode commands. You can use any editing mode to insert
the line-mode commands. When all the line-mode commands you want
to execute are in the buffer, return to the buffer in which you want to use
the macro and enter the macro name as a line-mode command.

EDT

4-31

The following example illustrates this process. The macro searches through
the buffer MAIN for the next occurrence of the string uSales Record". When
an occurrence is found, the macro backs up one line and inserts several
lines of text.
S EDIT EXAM. TXT mTI]
1 This file contains sales and shipping records
*DEFINE MACRO DISCLAIM mTI]
*=DISCLAIM mTI]
* INSERT
FIND I I Sales Record I I
-1

INSERT
Sales records include sales
for which bills have been paid
and for which bills have been
outstanding less than 90 days.
AZ

AZ
*=main mTI]

Note that the first CTRL/Z in the example closes the INSERT in the
macro and the second CTRL/Z closes the INSERT that puts the text in the
buffer. Now, each time you type the newly created line-mode command
DISCLAIM, EDT searches for the string uSales Record", backs up one line,
and inserts the text given.
One advantage of using macros is that you can define large numbers of
them and access them with ease. The number of buffers you can maintain
(and therefore the number of macros you can access) is limited only by
available memory. Another advantage is that you can use macros from
any editing mode; the keypad command COMMAND and the nokeypad
command EXT (EXTend) allow you to use line-mode commands and
macros. You can even include macro names in key definitions with
EXT, but they must be the last thing in the key definition.
The disadvantage of using macros is that the macros can only include
line-mode commands. This means that you have less flexibility and power
than you would in character mode. Only a relatively small number of
commands are available in line mode.
Once you have defined macros, you often want to save them so that
you can reuse them later. The startup command file is provided for this
purpose. Section 4.5.3.3 contains more information on this topic.

4-32

EDT

4.5.2 Defining Key Functions
You can group nokeypad commands into units (called command strings)
and define character editing keys which you press to execute the group of
commands as one command. To distinguish them from macros these units
are called key definitions. Since you can execute line-mode commands from
nokeypad mode, key definitions can include any legal line or nokeypad
editing command.
You can create key definitions in either line-editing or keypad-editing
mode. In line editing you use the DEFINE KEY command. In keypad
editing, you use CTRL/K. When you press CTRL/K, EDT asks you to press
the key you want to define. When you have done this, EDT prompts you
for the string of nokeypad commands. As you are entering this string, you
can use the DELETE key to delete characters, or CTRL/U to erase the entire
line and cancel the key definitions.
There are two important differences in these two means of defining keys:
1. With the DEFINE KEY command, you include the key definition within
quotation marks ("), while with CTRL/K there are no quotation marks
around the key definition.
2. With the DEFINE KEY command, you type in the key definitions using
only nokeypad commands, while with CTRL/K, you can either type in
the nokeypad command, or press the key that performs that nokeypad
command, if there is one. That is, if you want to define a key using
CTRL/K that would delete three word.s, you could either type in D3W
to the CTRL/K prompt, or you could press the DEL WORD key three
times.
There are several control characters that have specific uses and cannot be
redefined:
•

CTRL/Z exits to line-editing mode.

•

CTRL/S and CTRL/Q are characters used by terminals in buffering text
(called XOFF and XON).

•

CTRL/O skips over terminal output.

•

CTRL/C kills the current EDT command.

•

CTRL/H is the same as BACK SPACE, which in EDT moves the cursor
to the beginning of the line.

•

CTRL/I is the same as TAB.

EDT

4-33

•

CTRL/J is the same as LINE FEED, which in EDT deletes to the beginning

of the previous word.
•

CTRL/L inserts a form feed, which causes a line printer to move up
one page when you print the file.

•

CTRL/M is the same as RETURN.

You should not redefine these characters. In some cases the redefinitions
would not take effect, while in others your keyboard would not work as
you expected (the TAB key would not insert a tab, and so forth).
The GOLD key can precede any key for a key definition. You can define
GOLD M or GOLD CTRL/B, for instance.
Key functions are strings of nokeypad commands with some additional
rules:

4-34

•

If you define a key with the DEFINE KEY command, you must enclose
the string of nokeypad commands in quotation marks (1/).

•

If you end a string of commands with a period (.), the commands are
executed as soon as you press the key. In most cases, you should end
the command definition with a period. If you do not end the string of
commands with a period, EDT does not execute the commands until
you enter the key with ENTER. In other words, the period in the
definition enters the command string for you.

•

If you enclose a command definition in parentheses, you can give
repeat counts by pressing GOLD followed by a number from the
keyboard to specify the count before pressing the defined key. If you
do not enclose the string in parentheses, the repeat count applies only
to the first command in the definition, not the entire definition.

•

If you precede a string with a question mark (?), EDT prints the string
as a prompt when the command is executed, and accepts input from
the terminal in response to the prompt. EDT then substitutes the typed
input for the question mark in the command string and executes the
string. There is an example of this below.

•

When you need to insert a CTRL/Z or a RETURN (CTRL/M) in a key
definition, you can enter a circumflex (A) followed by either Z or M. In
particular, you can perform the Open Line function (which creates a
blank line) with the command sequence AM-C, which inserts a carriagereturn/line-feed combination and backs up one character, placing the
cursor on the newly created empty line. If you have a key definition
that inserts more than one line of text, the text must be between an I

EDT

and a AZ, but the AM cannot be before the AZ. Try the following key
definition to see how it works:
*DEFINE KEY CONTROL A AS "iNameAZAMiAddressAZAMTown and StateAZAM."

Every time you press CTRL/ A while in character mode, the following
text is inserted:
Name
Address
Town and State

The advantage of key definitions is that you can perform complex editing
functions by using the powerful nokeypad commands. Because you can
deal with entities and the editing operations are done at the character
level, you can write key definitions that perform functions impossible to
do with macros.
The disadvantage of key definitions is that you must use them in character
mode. While this is usually not a restriction, you may want to create a
command file that uses EDT to edit text; however, you cannot use the
key definitions you have created because the command file must use line
editing. That is, you cannot do character editing except on a terminal.
Just as with macros, you will probably want to save the most useful key
definitions you create. You can do so with a startup command file. See
Section 4.5.3.3 for more information on startup command files.
The following string of nokeypad commands does a global query replace
operation from the cursor position to the end of the buffer. That is, the
definition prompts you for a string to find and another to replace the first.
The macro then searches for an occurrence of the first string and prints
the line containing the string. If you want that occurrence replaced, you
enter Y; if not, you enter N.
There are two ways to define this key. From line mode, use the DEFINE
KEY command:
*DEFINE KEY CONTROL A AS "EXT S/?'Replace: II?' With: '/REST/QUERY."

From character mode, press CTRL/K. This produces the prompt Press the
key you wish to define. Press CTRL/A. This is followed by the prompt
Now enter the definition terminated by ENTER. Type in the definition,
without quotation marks, but with the period (.) at the end.

EDT 4-35

You have defined a key to use the line-mode command SUBSTITUTE with
the slash character (I) as a delimiter. The question marks tell EDT to
request input for the strings to delete and insert. When you press the key
to which this definition is assigned, EDT prints Replace: at the bottom
of your terminal. When you enter a string (it must not contain I, the
delimiter character) and press ENTER, EDT prompts With: to the right of
the string you entered. When you enter the string to be inserted and press
ENTER, EDT searches for the first string, displays the line in which it finds
the string, and asks you if you want to replace the first string with the
second. The legal replies are described in Section 4.4.
This key definition prompts you for a procedure name and places your
cursor at the procedure heading for that procedure.
BR ADY 'PROCEDURE ?'Procedure name: ".

The BR command places the cursor at the beginning of the current buffer.
ADV sets the current direction to forward, and the quoted string moves
the cursor to the first occurrence of the string. The question mark tells
EDT to print the string in the inner quotes as a prompt and accept text
to replace the inner quoted string. If, for example, you type the string
"Write_Output" in response to the prompt Procedure name:, EDT actually
executes the following command:
BR ADY 'PROCEDURE Write_Output'.

4.5.3 Creating a Personal Editing Environment
EDT provides many features for creating a personal editing environment.
You can change the appearance of your screen display, the behavior of
lines of text as you insert them, and the mode in which you are working.
The following sections discuss some of the SET and SHOW commands
provided by EDT and how to use these commands and indirect command
files to create a personal startup command file. See the EDT Editor Manual,
which is available separately, for descriptions of all the available SET
commands.

4-36 EDT

4.5.3. 1 Using SET Commands
You can use the SET commands to change the way EDT works. Some
SET commands affect the display of text on your screen. For example, you
can specify the number of lines you want displayed and whether or not
the lines have line numbers (in line mode). You can also specify that EDT
make an exact search. See the following SET commands:
SET LINES number
SET [NO]NUMBERS
SET SEARCH EXACT
By default, your screen contains 22 lines. If you want to decrease the screen
display to 5 lines, enter the command SET LINES 5. If you are editing
at slow data rates, you can increase your editing speed by decreasing the
number of lines displayed on your screen.
When you are working in line mode, EDT displays line numbers by default.
If you do not want the, numbers to appear on the screen or paper, enter

the command SET NONUMBERS.
By default, when you press the GOLD key followed by the FIND key,
EDT searches for the specified string, disregarding the case of letters. For
example, if you enter the search string course", EDT will. find every
occurrence of the word (for example, "course N, "Course N, "COURSEN). But,
when you enter SET SEARCH EXACT, EDT will only find occurrences of
the word that exactly match the specified string (" courseN).
II

You can use the following line mode commands to determine which mode
you enter:
SET KEYPAD
SET NOKEYP AD
In a start up command file, you would use the following SET commands
to determine which mode you enter:
SET MODE LINE
SET MODE CHANGE
For example, to enter nokeypad mode from keypad mode, enter the
following command after pressing GOLDCOMMAND:
Command: SET NOKEYPAD

One SET command, SET QUIET, even controls the sound of your terminal.
You can use this command to suppress the terminal bell that signals an
error.

EDT 4-37

4.5.3.2 Using SHOW Commands to See What Is Set
EDT provides the SHOW commands to enable you to see what is set and
what is not set. For every SET command there is a SHOW command.
If you want to see the number of lines on your screen, enter the SHOW
LINES command. If you want to see whether EDT is performing an exact
search, enter the SHOW SEARCH command.
For example, if you want to check the number of lines displayed on your
screen, enter the following command:
*SHOW LINES
22

Or, if you want to see whether line numbers will be displayed in line
mode, enter the following command:
*SHOW NUMBERS
numbers

Table 4-8 lists the SET commands discussed so far with their corresponding
SHOW commands:
Table 4-8: SET and SHOW Commands For Line Mode

SET Command .

SHOW Command

SET KEYPAD

SHOW KEYPAD

SET NOKEYPAD
SET LINES

SHOW LINES

SET MODE LINE

SHOW MODE

SET MODE CHANGE
SET NUMBERS

SHOW NUMBERS

SET NONUMBERS
SET QUIET

SHOW QUIET

SET NOQUIET
SET SCREEN

SHOW SCREEN

SET TRUNCATE

SHOW TRUNCATE

SET NOTRUNCATE

4-38 EDT

Table 4-8 (Cont.):

SET and SHOW Commands For Line Mode

SET Command

SHOW Command

SET WRAP

SHOW WRAP

SET NOWRAP
For a complete list of the SHOW commands provided by EDT see the EDT

Editor Manual, which is available separately.

4.5.3.3 Startup Command Flies
EDT provides the ability to store macros, key definitions, and editor control
commands in a file to be read and executed each time you start EDT. This
file is called the EDTINI file (for EDT initialization). The more common
name is startup command file. If you have a file in your default directory
called EDTINI.EDT, EDT reads the file when it starts.
A startup command file can have any file specification. If it is called
EDTINI.EDT it is executed every time you invoke EDT. If it has some other
name, it must be called explicitly by using the /COMMAND qualifier to
the EDIT command either interactively or in an indirect command file.
The default file type for EDT startup command files is .EDT. For example:
• EDIT/COMMAND:SCAN TIZZY. TXT

IRETI

EDT executes the file called SCAN .EDT and then is ready to edit
TIZZY.TXT.
Following is a sample startup command file. Note that you can include
comments in the file by preceding them with an exclamation point (!).
The comments follow the key definition they explain.

EDT

4-39

DEFINE KEY CONTROL A AS 'BACK C DC ADV C UNDC.'
! CTRL/A transposes the two characters to the left of the cursor.
DEFINE KEY CONTROL E AS "EXT CHANGE=?'To buffer: ' "
! CTRL/E moves you from buffer to buffer.
DEFINE KEY CONTROL V AS "I-?'Mark as: ,-AZ."
! CTRL/V marks your location in the text so you can find your
! way back to it with CTRL/B.
DEFINE KEY CONTROL B AS "BR ADV S/-?'Find mark: '-//."
! CTRL/B finds the location marked by CTRL/V.
DEFINE KEY CONTROL 0 AS "CUT'?'Delete to: "."
! CTRL/D deletes to the target string you type in. Text is
! removed to PASTE buffer and can be pasted back.
DEFINE KEY CONTROL G AS "7ASC."
! CTRL/G inserts a bell. beep. or buzz in your text. When you
! type the file. you hear the sound.
DEFINE KEY CONTROL R AS "REF."
! CTRL/R refreshes the screen.
DEFINE KEY CONTROL F AS "EXT WRITE ?'Write file: ' "
! CTRL/F writes the current buffer out as a file.
DEFINE KEY CONTROL T AS "EXT INCLUDE ?'Read file: '."
! CTRL/T reads a file in from outside EDT to the current position.
DEFINE KEY CONTROL X AS "EXT EX."
! CTRL/X causes an EXIT from change mode.
DEFINE KEY GOLD 10 AS "EXT HELP ?'Help on topic: '."
! GOLD PF2 prompts for line-mode help.
SET MODE CHANGE
! This command puts EDT directly into CHANGE mode upon startup.
SET QUIET
! This command eliminates the beep that normally comes with
! EDT error messages.
SET WRAP 70
! This command causes automatic wrapping at column 70. You
! must SET WRAP to use the FILL key (GOLD 8) on a Select Range.

Try out these key definitions interactively, using the line-mode command
DEFINE KEY or the character-mode CTRL/K. Almost all EDT startup files
for use on video terminals include the command SET MODE CHANGE.
Several of the keys defined in this example are defined differently by EDT.
Press the HELP key while in character mode for a list of keys defined by
EDT. You can usually redefine EDT keys that you do not use, but some
keys cannot normally be defined, CTRL/K, for instance. If you want to
define one of these keys, but also keep the normal EDT function as well,
you can DEFINE KEY GOLD CONTROLS K AS "...". Then, if you wish
to use the defined key, press GOLD CTRL/K.
You can also use GOLD to redefine most letter keys, as in the command
DEFINE KEY GOLD D AS "... ".

4-40

EDT

Always try out key definitions with CTRL/K before putting them in a
startup command file. EDT informs you of undefinable keys. If the
CTRL/K does define the key, then press it to make sure it does what you
meant it to do.
To define keys on the keypad, use the key number, or GOLD and the
number. The keypad keys without numbers printed on them have the
numbers as listed in Table 4-9:
Table 4-9: Key Definitions for EDT
Keypad Key

Key Number

Keypad Key

Key Number

UP-ARROW

.(dot)

DOWN-ARROW

RIGHT-ARROW

LEFT-ARROW

PFI

GOLD

PF2

PF3

PF4

_( underscore)

,(comma)

ENTER

For even more information on key definition, see the EDT Editor Manual,
which is available separately.

EDT 4-41

4.5.3.4 Using Indirect Command Flies with EDT
You can write an indirect command file to combine the features of macro
definition, key definition, and EDT startup command files to help you
create a personal editing environment.
Here is an indirect file:
.ENABLE SUBSTITUTION
.ASKS FI File
EDIT/COMMAND;INI 'FI'
.ASK PU Purge it
.IFT PUT PURGE 'FI'

This command file enables you to use a specially named EDT startup file
(INI.EDT) instead of the default (EDTINI.EDT).
The startup file can contain key definitions.
You can also include macro definitions in a startup file. Keep in mind
that macro definitions are stored in a separate buffer. You can insert the
macro definition as part of your startup file, or you can do as shown in
this example:

DEFINE MACRO PELF
! Creates buffer PELF and enters name in
! line-mode command list.
INCLUDE PELF.FIL =PELF
! Finds file PELF.FIL, which includes
! the macro definition.
FIND =MAIN
Takes you back to MAIN buffer so you won't
start out in PELF.

You can do as many of these as you need for special applications of EDT.
Many EDT users have several startup files, one for programming, one for
text editing, and one for special formats, such as memos.
See Chapter 9 for more information on the Indirect Command Processor.

4-42

EDT

4.5.4 Structured Tabs
Most structured programming languages use tabs to indicate nested blocks
of code and other structures. EDT provides a structured tab facility to assist
you in this process. Skip this section if you are not writing structured code.
When you use the structured tab facility, you define the space between
tabs with the SET TAB command. You can execute this command in line
mode or with a startup command file. (See Section 4.5.3.3 for details on
the startup command file.) For instance, SET TAB 4 tells EDT to put four
spaces between two characters that have a tab between them. Once you
have executed this command, you can press the TAB key to get four spaces.
Pressing TAB again positions the cursor eight characters to the right, and
so forth. Thus, you can set the tab stops with the SET TAB command.
EDT keeps track of the current level of indentation using its indentationlevel counter. You can increment, decrement, and set the counter with the
appropriate commands (described in the following paragraphs) When you
type a TAB, EDT multiplies the value you gave with the SET TAB command
by the current value of the indentation-level counter to determine the
number of spaces and tabs to insert. Suppose, for example, you press TAB
before a WHILE statement; the WHILE statement starts at character position
4 (assuming you have entered the command SET TAB 4, as described in
the previous paragraph). EDT sets the indentation-level counter to 1. You
can now increment the counter, making its value 2, and when you press
a TAB at the beginning of the next line, EDT inserts eight spaces. When
you have introduced all the code that goes under the WHILE statement,
you can decrement the counter, after which pressing TAB causes only four
spaces to be inserted. Thus, code that is part of the WHILE statement
is indented eight spaces, and code following the WHILE is indented only
four spaces.
Three commands affect the indentation-level counter. You can increment
the level count with CTRL/E in keypad mode or the TI (Tab Increment)
command in nokeypad mode. CTRL/D or TO (Tab Decrement) decrements
the level count. CTRL/A and TC (Tab Compute) cause EDT to compute
the indentation level that corresponds to the cursor position and store it as
the current indentation level. To execute this command, your cursor must
be positioned to a column that is an even multiple of the SET TAB value;
otherwise you get an error message.

EDT

4-43

You can use the Tab Compute command to help in editing a program that
already exists. If you want to type some code that should be indented
twelve spaces, for example, you can move the cursor to character position
twelve and execute the Tab Compute command. Assuming that you
have previously executed the SET TAB command with a value of 4, EDT
computes that the current indentation-level counter value should be 3.
You can then proceed to type TAB at the beginning of a line to get twelve
spaces in front of the line, just as required.
EDT also has a command to move a region of text left or right. CTRL/T or
TABJ (Tab ADJust) moves the Select Range to the right if the repeat count
is positive, or to the left if the count is negative. EDT inserts or deletes
a number of tabs and spaces corresponding to the repeat count times the
SET TAB value.

4.5.5 More on EDT Buffers
This section briefly explains the more advanced features of EDT buffers.
These features include the following:
•

Creating buffers

•

Moving between buffers

•

Copying text from a file into a buffer

•

Copying text from one buffer to another buffer

•

Copying text from a buffer to a file

•

Using buffers

For more information on buffers, see the EDT Editor Manual, which is
available separately.

4.5.5.1 How To Create and Move Between Buffers
To create a buffer, type the Find command followed by an equals sign
( =) and then the buffer name. A buffer name must be between 1 and

30 alphanumeric characters, but cannot start with a number. The only
punctuation character you can use in a buffer name is an underscore (_).
For example, to create a buffer named OSCAR while in line mode, enter
the following command line after the asterisk prompt (.):
*FIND=OSCAR

4-44 EDT

lliTIJ

EDT creates the buffer OSCAR and moves you into that buffer. If you
press RETURN, you will see the [EOB] symbol followed by an asterisk
prompt (.), indicating that both the buffer OSCAR is empty and EDT is
ready for your commands to affect this buffer. You now can insert and
edit text as you did in the MAIN buffer.
To create a buffer from keypad mode, press the COMMAND keypad
function (GOLD 7). When EDT prompts you with "Command:," type Find
followed by an equals sign (=) and then the buffer name of your choice.
Terminate the command by pressing the keypad ENTER key. EDT creates
the specified buffer, then moves you into it. The screen clears except for
the [EOB] symbol, indicating that the current buffer is empty. You can
now begin entering and editing text just as you did in the MAIN buffer.
To create a buffer in nokeypad mode, type ·EXT followed by the line-mode
command indicated earlier in this section.
To return your previous location in the MAIN buffer, use the command
Find=MAIN. Include the period after the buffer name. If you omit the
period, you will return to the top of the MAIN buffer. When you leave
the alternate buffer, it remains intact until you exit from EDT. Unless you
command EDT to save the text of a buffer other than MAIN, that text is
destroyed when you leave EDT. (See Section 4.5.5.4 on how to save the
contents of a buffer by copying it into a file.)
Note that you can return to a buffer that you previously created. Just use
the Find=buffername command, terminating this command with a period
if you want to return to the exact location in buffername that you had
previousl y left.
The line-mode command SHOW BUFFERS displays a list of the existing
buffers and some information about the contents of each. An equals sign
( =) appears in the SHOW BUFFERS display next to the name of the current
buffer.

EDT

4-45

4.5.5.2 How To Copy Text from a File Into a Buffer
To copy text from a file located outside of EDT into an EDT buffer, use
the INClude command. While in line mode, for example, you type the
following command to copy the contents of a file named OUTSIDER.DAT
into your MAIN buffer:
*INCLUDE OUTSIDER. OAT =MAIN

mIT!

The text of OUTSIDER. OAT is copied above the current line in the MAIN
buffer. If you do not specify a buffer name, EDT copies the text above the
current line in your current buffer.
Note that OUTSIDER. OAT is located in your own directory. You can copy
a file from another directory into an EDT buffer, providing you have access
to that file. See Chapter 5 for information about file specification and file
protection.
To copy text from a file into buffer while in keypad mode, you execute the
COMMAND keypad function (GOLD 7), then type after the "Command:"
prompt:
Command: INCLUDE OUTSIDER.DAT =MAIN

You press the keypad ENTER key to terminate this command.
In nokeypad mode, type EXT followed by the line-mode command
indicated earlier in this section.

4.5.5.3 How To Copy Text from One Buffer to Another Buffer
To copy text from one buffer to another while in line mode, you use the
COpy command. For example, to copy the contents of a buffer named
OSCAR to a buffer named YORICK, type:
*COPY =OSCAR TO =YORICK

mIT!

When you complete this operation, the entire contents of the buffer OSCAR
is copied to the top of the buffer YORICK, and you are located in the buffer
YORICK.
Using the COpy command, you also can copy a portion of one buffer to
a specific location in another buffer. For example:
*COPY =OSCAR 5: 20 TO =MAIN 45

mIT!

This command copies lines 5 through 20 of the buffer OSCAR to the
location immediately above line 45 of the MAIN buffer. Your current
buffer is MAIN at the end of this operation.

4-46

EDT

When you are in keypad mode, you also can use the COpy command
to copy the entire contents of one buffer into another. First press the
COMMAND keypad function (GOLD 7), then type after the IICommand:
prompt:
1P

Command: COPY =OSCAR TO =MAIN

Press the keypad ENTER key to terminate this command.
However, if you are going to copy a portion of one buffer into a specific
location in another buffer, use Find command along with the CUT and
PASTE keypad functions. For example, to move a paragraph from buffer
OSCAR to a particular location in MAIN:
1. Move to buffer OSCAR, using the FIND-OSCAR command.
2.

Move your cursor to the desired paragraph.

3. Use the CUT keypad function (6) to select this paragraph from buffer
OSCAR.
4. Move back to buffer MAIN, using the FIND=MAIN command. (To
return to your previous position in MAIN, type a period (.) after
MAIN.)
5. Move your cursor to the position in MAIN that you want the paragraph
to appear.
6.

Use the PASTE keypad function (GOLD 6) to copy the paragraph into
the buffer MAIN. The text is copied immediately in front of the cursor
position.

See Section 4.3.6 for a detailed description of how to use the CUT and
PASTE keypad functions.
To copy text from one buffer to another while in nokeypad mode, type
EXT followed by the line-mode command indicated earlier in this section.

EDT

4-47

4.5.5.4 How To Copy Text from a Buffer to a File
To copy text from a buffer to a file, use the Write command. You can
use this command to copy text to a new file without affecting your editing
session.
The Write command followed by a file name copies the entire contents of
your current buffer into the specified file. You can also copy only a portion
of your current buffer into a file. For example, the following line-mode
command puts a copy of lines 23 through the end of the current buffer
into a file that you name EMT.DAT .
... WRITE EMT. OAT 23: END

illITJ

In keypad mode, to copy only a portion of your current buffer into a file
called EMT.DAT:
1. Use the CUT keypad function (6) to place the selected text for the
new file in the PASTE buffer.
2. Execute the COMMAND keypad function (GOLD 7), then type after
the "Command:" prompt:
Command: WRITE EMT.DAT =PASTE

This Write command copies the contents of the PASTE buffer into the
new file EMT.DAT.
3. Use the PASTE keypad function (GOLD 6) to copy the text back into
your current buffer, if you want to keep it in your current file also.
In nokeypad mode, to copy text from a buffer into a file, type EXT followed
by the line-mode command indicated earlier in this section.

4.5.5.5 Ways to Use Buffers
Here are some ways to use EDT buffers:
1.

Suppose you have to send a letter to 10 people, whose names and
addresses are in a file. The letter is basically the same for each person
but requires some minor editing to personalize the contents. You might
do the following:
•

Invoke EDT to type the basic letter in the MAIN buffer.

•

Use the Find command to create a separate buffer and move there.

•

Use the INClude command to copy the file with the address list
into this separate buffer.

4-48 EDT

•

Use the CUT keypad function to select the address from the list that
you want to use in your letter. (See Section 4.3.6 for information
on how to move text from one location to another using the CUT
and PASTE keypad functions.)

•

Move back to your MAIN buffer, which contains your basic letter.

•

Use the PASTE keypad function to add the address to the letter.

•

Use the Write command to create a file containing this copy of the
letter.

You are now ready for the second letter. Delete the old address and,
using the preceding procedure, move the next one into place. Edit
the letter so that it reflects this new recipient and then use the Write
command to copy that version to another file. Repeat the process until
all 10 letter are finished.
2. When you write computer programs, you often use elements from
other programs in the one you are currently creating. You might do
the following:
•

Invoke EDT to type the new program in the MAIN buffer

•

Use the Find command to create a separate buffer and move there

•

Use the INClude command to copy into this buffer the file
containing the other program

•

Use the CUT keypad function to select the portion of this other
program that you want to include in your new program

•

Move back to your MAIN buffer, which contains your new program

•

Use the PASTE keypad function to move the section of the other
program into your new program

3. If you are writing a large computer program with several modules,
you may want to create each module in a separate buffer. When you
are ready to assemble your modules into one program, you can use
either the COpy command or the Find command along with the CUT
and PASTE keypad functions to move your text from one buffer into
another.
4. If you are in the middle of an EDT session and need to get some
information or text from another file, you can create another buffer
and use the INClude command to copy this file there. Once you find

EDT 4-49

the item you need, you can move back to your original buffer and
resume editing there.

4.6 EDT Summary
This section summarizes EDT. There are brief descriptions of range
specifications, editor control commands, and line and character editing
commands. The editing entities on which character editing commands
can operate are also included. For a more detailed description of the
commands and specifications presented here, see the EDT Editor Manual,
which is available separately.
Command names are given in full with the abbreviated form printed
in UPPERCASE. Square brackets ([ ] ) enclose an optional parameter
or qualifier; in these cases, the default value is specified in the text
accompanying the command. A vertical bar ( I) separates options; two
forms with a vertical bar between them are mutually exclusive. You can
choose one or the other, or, in some cases, neither. Lowercase words
indicate information you supply, such as file specifications, beginning line
numbers, range specifications, and so forth.
Remember that any line-mode command can be included in a key definition
using EXT and that any line-mode command can be entered from character
mode by using GOLD 7 and typing the command in response to the
Command: prompt.

4.6. 1 Range Specifications
Range specifications can designate single lines, contiguous ranges, or
noncontiguous ranges. You specify a range as shown in Table 4-11.

4-50 EDT

Table 4-11:

Range Specification

Description

Single line ranges
The current line-the cursor position in
character editing.
Example: *TYPE .
Types the current line.
number

The line specified by the number.
Example: *1536
line pointer moves to line 1536.

'string' I "string"

The next line containing the string (if preceded by a minus sign, the preceding line
containing the string). Two quotation marks
with nothing between them, as "", default
to the last string entered.
Example: *'False Aralia'
line pointer moves to next line containing
"False Aralia".

[range] + [number]

The line specified by adding the number to
the range (if you use a minus sign instead of
a plus sign, the line specified by subtracting
the number from the range). The range
defaults to the current line, number defaults
to 1.
Examples:
line pointer moves down 25
*. + 25
lines

BEGIN

*+25

Line pointer moves down 25
lines

*237-25

Line pointer moves first to 237
and then up 25 lines

The first line in the buffer.
Example: *FIND BEGIN
line pointer moves to beginning of the
buffer.

EDT

4-51

Table 4-11 (Cont.):

Range Specification

Description

END

An empty line following the last line in the
buffer.
Example: • FIND END-l
Line pointer moves to the last line in the
buffer.

LAST

The line position in the most recent text
buffer before entering the current buffer.
Example: .FIND LAST
EDT switches back to the last position in the
previous buffer. If you use this command
in a key definition, such as DEFINE KEY
GOLD L AS HFIND LAST. n and then press
GOLDL while in character mode, you can
jump back and forth between two buffers
with ease.

ORIGINAL number

The line specified by the number in the
buffer MAIN before any edits changed line
numbers in this editing session.
Example: .TYPE ORIGINAL 15
Types the line originally numbered IS,
regardless of how many lines you've added
to the file.

Contiguous line ranges
[range-I] : [range-2]

4-52

EDT

The lines between range-1 and range-2.
Both ranges must be single lines. If either is
omitted the current line is the default. You
can use either: or THRU in this expression.
Example: .15:36
Lists lines 15 through 36 on your terminal.

Table 4-11 (Cont.):

Range Speclftcatlon

Range Specification

Description

[range] # number

The specified number of lines starting with
range, which must be a single line; if range
is omitted it defaults to the current line (you
can also use FOR instead of #).
Example: ",TYPE 13 5
Types line 13 and the next four lines, five
lines in all.

BEFORE

All lines in the buffer preceding the current
line.
Example: ",DELETE BEFORE
Deletes everything in the buffer above the
line pointer.

REST

All lines in the buffer after and including
the current one.
Example: ",SUBSTITUTE/Molly/Dolly/REST
Performs the substitution in the current line
and the rest of the buffer.

WHOLE

All lines in the current buffer.
Example: .TYPE WHOLE
lists the entire buffer.

Noncontiguous line ranges
[range-l,range-2, ... ]

All lines specified by range-I, range-2, and
so on. Each range must be a single line (you
can also use AND instead of,).
Example: .12, 16, 14,
Types lines 12, 16, and 14, in that order.
Example: .COPY 12,2 TO END
Copies line 12 and line 2, in that order, to
the end of the buffer.

EDT

4-53

Table 4-11 (Cont.):

Range Specification

Description

[range]ALL 'string'

All lines in the range containing the string.
If you do not supply a range the default is
all lines in the current buffer containing the
string.
Example: .COPY ALL 'log' to = BOY
Copies all lines containing the string log to
a buffer named BOY, which becomes the
current buffer.

Ranges that include buffer names
=buffer [range]

The specified range in the specified buffer.
The range defaults to the entire buffer, with
the cursor placed at the top of the buffer
(you can also use BUFFER instead of =).
Whenever you name a buffer with the = or
BUFFER, that buffer becomes the current
buffer. In the output from the SHOW
BUFFER command, the current buffer is
indicated by the =.

4.6.2 Editor Control Commands
Editor control commands affect the way in which EDT does its work and
the way in which it displays the results. The following list shows the
minimum abbreviation for the commands in UPPERCASE. You can enter
anything between the minimum abbreviation and the entire keyword when
you issue a command.
Change [[ =bufler] range]

CHANGE places you in character editing mode, either keypad or
nokeypad according to the last SET KEYPAD /NOKEYP AD command,
or according to the terminal model. The default is keypad editing for
VT100- and VT200-series terminals. For other terminals, the default
is nokeypad. The range can include a buffer name and a single line
specification where the cursor is positioned in character editing mode.
You can express this single-line range as the dot (.), meaning "where
I last was in this buffer," or as a line number, or as a quoted string.

4-54

EDT

EXit [filespec ][/SEQuence[[: Initial: Increment]][ [/SAve ]]]

EXIT ends an editing session and writes the contents of buffer MAIN
to the file whose name you specify (the file specification defaults to the
input file specification). The /SEQUENCE qualifier requests EDT to
include line numbers in the output file. The initial value is the starting
number and the increment value is the increment between numbers.
The /SAVE qualifier tells EDT to save the journal file (called input-filename.jOU). Normally, the journai fHe is deieted after you successfuHy
exit from EDT.
Help topic subtopic

HELP displays information on the requested subject. The values
for Utopic" and Nsubtopic" can be either alphanumeric strings or the
wildcard symbol (.). HELP with no qualifiers produces a list of all
topics for which EDT is prepared to give help.
Qult[!SAve]

QUIT ends an editing session without saving the text in any buffer.
The /SA VE qualifier requests EDT to save the journal file (called
input-file-name.JOU).
SEt CAse (Upper I Lower I None)

SET CASE tells EDT to flag any characters of the specified type by
printing an apostrophe before the character. This command is mainly
used on terminals that do not display both upper- and lowercase.
SEt Cursor top:bottom

SET CURSOR defines the points at which EDT scrolls the text on
a display terminal in character editing. When you move the cursor
outside the range specified by top:bottom (where top and bottom are
line numbers on the screen), EDT scrolls the text up or down to
accommodate the cursor movement. The default setting for the cursor
is 7:14. The screen does not start scrolling until you move the cursor
up to line 7 or down to line 14. If you issue the command SET
CURSOR 14:14, the screen starts scrolling whenever you start to move
off line 14.
SEt ENTity (Word I Sentence I PAGe I PARagraph) 'string'

SET ENTITY allows you to define character strings to be recognized
as entity delimiters. WORD and SENTENCE entities end with any
one of the string of characters you specify. PAGE and PARAGRAPH
end with the entire string. Default delimiters are space, LF, TAB, FF,
and RET for WORD; period, question mark, and exclamation point for
SENTENCE; FF for PAGE; and RET RET for PARAGRAPH. Although
all these entities are defined, there are no EDT commands that affect

EDT

4-55

sentences or paragraphs. There are several commands that affect
words: DEL W, UNO W, WORD. There is one EDT command that
affects a page: PAGE. The SET ENTITY command makes it possible to
define keys (or enter nokeypad commands) that affect all these entities,
but you have to do it yourself. If you have a text formatting program,
you may want to use SET ENTITY to define paragraphs and pages
using the same rules as the text formatter.
SEt Keypad I NOKeypad

SET KEYP AD /NOKEYP AD tells EDT whether you wish to enter
keypad or nokeypad editing mode when you issue the CHANGE
command or the SET MODE CHANGE command from your startup
command file. See Section 4.5.3.3 for more on startup command files.
The default is keypad editing for VT100- and VT200-series terminals
and nokeypad for all others. If your terminal has a keypad and is not
one of the DIGITAL models, you can probably include SET KEYPAD
in your startup file and it will probably work. If this is your situation,
you should check to make sure the key definitions for your terminal
match what is shown in the EDT help files. You should also check
your terminal manual.
SEt Lines number

SET LINES tells EDT how many lines to display on your screen in
character-editing modes. You can speed editing tasks on slow terminals
by reducing the number of lines displayed. The default number of
lines is 22. If you are editing on a slow terminal, try SET LINES
12. This reduces the time it takes to change the screen when you
edit something. If you do change this setting, you should also SET
CURSOR 0:8.
SEt Mode {Line I Change}

The SET MODE command is used in the startup file (Section 4.5.3.3) to
control the mode in which EDT starts editing. If you put SET MODE
CHANGE in your startup file, you go directly into character editing
when you start EDT. The default for EDT is line mode.
SEt NUmbers I NONumbers

SET NONUMBERS tells EDT not to display line numbers in lineediting mode. The default is NUMBERS. EDT displays line numbers
along with text in line editing.
SEt Quiet I NOQuiet

SET QUIET tells EDT not to ring the terminal bell when an error
occurs in character editing. SET NOQUIET is the default. SET QUIET
is commonly included in startup files.

4-56

EDT

SEt SCreen width

SET SCREEN defines the number of characters EDT displays on
each line. What happens to the remaining characters on the line
is determined by the TRUNCATEINOTRUNCATE setting (see SET
TRUNCATE, below): the extra characters are either wrapped around
to the next line, or they are not displayed.
The default screen width is 80 characters. The VT100- and VT200series terminals can be set to either 80 columns or 132 columns. If
you are editing a file that is in 132-column format, you should reset
your terminal before entering the EDIT command. See Chapter 3, the
description of the SET TERMINAL command, for more information.
Once you have done that, then enter the EDIT command and SET
LINES 132 to make EDT match up with the file.
Another method of dealing with lines wider than the screen-and
EDT lines can be up to 250 characters long-is to use the nokeypad
commands SHL (shift left) and SHR (shift right) in a key definition. See
EDT Editor Manual, which is available separately, for an explanation
of these commands. See also EDT help files under HELP CHANGE
SUBCOMMAND SHIFT.
SEt SEarch {Begin I End}

SET SEARCH BEGINlEND tells EDT where to leave the cursor after
locating a search string. The default is BEGIN. EDT leaves the cursor
at the beginning of the search string.
SEt SEarch {BOunded I Unbounded}

SET SEARCH BOUNDED tells EDT to stop searching when it reaches
the next page delimiter. This does not work if you do not have
any page delimiters in your text. The default is UNBOUNDED; EDT
searches the whole buffer in the current direction.
SEt SEarch {General I EXact}

SET SEARCH EXACT tells EDT to accept a match for a search string
only if the case matches exactly for each character in the string.
GENERAL, which is the default, allows strings to match whatever
the case. If you SET CASE EXACT, you can tell the difference
between Mongo and mongo. The case setting affects the SUBSTITUTE
command and SUBS key as well as searches.
SEt TAb n I NOTab

The SET TAB command, in conjunction with the tab manipulation
commands (CTRL/A, CTRL/D, CTRL/E, and CTRL/T in keypad editing;
TC, TO, TI, and TADJ in nokeypad editing), allows you to format your

EDT 4-57

text, especially structured programs, very easily and quickly. For a
description of how to use structured tabs, see Section 4.5.4.
SEt TErmlnal{HCPV I VT52 I VT 1OO}
{SCROLL I NOSCROLL}
{EDIT I NOEDIT}
{EIGHTBIT I NOEIGHTBIT}

The SET TERMINAL command overrides the terminal definition that
EDT obtains from the operating system. Micro/RSX takes care of
all terminal settings for you when you issue the EDIT command. It
is rarely necessary to override these settings if you have a DIGITAL
terminal. If you have to do so, it may indicate that Micro/RSX does not
know your terminal model. Issue a DCL SET TERMINAL/INQUIRE
command to make sure your terminal is set properly.
The EDT SET TERMINAL COMMAND offers four choices:
•

The first choice is between HCPY, VT52, and VT100. HCPY
means hardcopy. This is the default for all terminals except VT52s,
the VT100-series, and the VT200-series; nokeypad editing is the
default. VT52 sets the terminal as a VT52; keypad definitions
match the VT52 keypad; keypad editing is the default. VT100
sets the .terminal as a VT100- or VT200-series terminal; keypad
definitions match the keypads on those terminals; keypad editing
is the default.

•

The second choice is between SCROLL and NOSCROLL. All
DIGIT AL video terminals default to SCROLL, meaning that they
support scrolling regions that EDT can use. Other video terminals
default to NOSCROLL; some support scrolling regions and can be
set to SCROLL.

•

The third choice is between EDIT and NOEDIT. VT102 terminals
support certain screen editing features; EDIT is the default for
VT102 terminals. NOEDIT is the default for all others.

•

The fourth choice is between EIGHTBIT and NOEIGHTBIT.
Terminals that support the DEC Multinational Character Set, such
as the VT200-series, default to EIGHTBIT. All others default to
NOEIGHTBIT.

SEt {TRuncate I NOTRuncate}

SET NOTRUNCATE tells EDT not to truncate lines that are longer
than the current screen width. If you specify NOTRUNCA TE, EDT
displays the extra characters on subsequent lines. TRUNCATE is the
default setting; EDT displays a diamond on the edge of the screen to
indicate that the display does not include the entire line.

4-58

EDT

SEt Verify I NOVerify

SET VERIFY tells EDT to print the text of macros and command files
when you execute them. This can be helpful in debugging macros and
key definitions, but otherwise you probably can skip it. The default
setting is NOVERIFY.
SEt Wrap n I NOWrap

SET WRAP does two things: it causes EDT to insert a RETURN in your
file when the word you are typing causes the line length to exceed the
value of n. It also tells EDT what to use for the right margin when
you execute the FILL command. NOWRAP is the default setting. If
you have issued SET WRAP, you can then mark out a Select Range
and press FILL (GOLD 8) and all the lines in the Select Range are
rearranged to match the value you set.
SHow BUtler

SHOW BUFFER lists the buffers in use and the number of lines of
text in each buffer. The current buffer has an equals sign (-) in front
of its name. Any buffer for which EDT has not read all the text has
an asterisk after the line count, showing that the count for that file
may not be correct. EDT sometimes reads in only part of a file when
starting up, but it reads in the rest without any explicit action on your
part as you work your way down in the file.
SHow CAse

SHOW CASE displays the current case setting-UPPER, LOWER, or
NONE. The default is NONE.
SHow Cursor

SHOW CURSOR displays the range the cursor can move in without
EDT scrolling the text up or down. The default setting is 7:14.
SHow ENtity {Word I Sentence I PAGe I PARagraph}

SHOW ENTITY displays the delimiter(s) for the specified entity.
Default delimiters are LF, TAB, FF, and RET for WORD; period, question
mark, and exclamation point for SENTENCE; FF for PAGE; and RET
RET for PARAGRAPH.
SHow Key {CONtrol letter I [Gold] number}

SHOW KEY displays the definition of the specified key in character
editing, whether you have redefined the key or not.

EDT

4-59

SHow SCreen

SHOW SCREEN displays the current setting for the width of the
screen. The default setting is 80.
SHow SEarch

SHOW SEARCH shows the current search parameters. The default
settings are GENERAL, BEGIN, and UNBOUNDED.
SHow TErminal

SHOW TERMINAL displays the type of terminal EDT thinks you are
using.
SHow VErsion

SHOW VERSION shows the version of EDT you are using.

4.6.3 Line-Mode Editing Commands
You use line-mode commands for standard line-mode editing, and from
character mode using the GOLD 7 key.
The /QUERY qualifier can be used with several commands (COPY,
DELETE, MOVE, and SUBSTITUTE). In each case, EDT displays the line it
is currently on, and prompts you with a question mark. The legal replies
are Y, N, A, and Q. Y (for Yes) tells EDT to perform the operation as
requested. N (No) tells EDT not to perform the operation. A (All) allows
EDT to perform the indicated operation for the rest of the range. Q (Quit)
tells EDT to quit the operation without doing anything further.
CLear buffername

CLEAR deletes the entire contents of a buffer you name, whether you
are currently editing in that buffer or not. The buffer no longer exists
after you clear it.
COpy range-l TO [range-2][/Query][/Dupllcate:n]

COpy copies the range of lines specified by range-I to the position
specified by range-2 without deleting the original text. Range-2 can
be another buffer. The default for range-2 is the current line. If you
use the /QUERY qualifier EDT asks you about copying each line of
range-I. The responses to the /QUERY command are described at
the beginning of this section. The /DUPLICATE qualifier tells EDT to
perform the copy a number of times, thereby inserting several copies
of the text at range-2.

4-60

EDT

DEFine Key [CONtrol I Gold] x AS "string"

DEFINE KEY associates a keypad key or a control character with a
string of nokeypad commands. If you use CONTROL, x must be a
keyboard character other than 0-9, !, 'Yo, " and ". If you use GOLD,
or if you do not include GOLD or CONTROL, x must be a number.
(For a display of the number associated with each keypad key, enter
HELP DEFINE KEY VT100. The VT200-series is the same for the
numerical keypad. The numbers for the VT200-series editing keypad
are E1 through E6.) The "string" must be a quoted string of nokeypad
commands. For more information on constructing these strings, see
Section 4.5.2.
DEFine Macro macro-name

DEFINE MACRO assigns a name to a series of commands. Each macro
is associated with a buffer in which reside a number of line-mode
commands (the macro). When you enter macro-name as a line-mode
editing command, these commands are executed. The macro-name
can be 1 to 30 characters in length and may include alphabetic and
numeric characters and underscores (_). See Section 4.5.1 for more
information on defining macros.
Delete [range][/Query]

DELETE tells EDT to delete the lines in the specified range. The range
defaults to the current line. If you enter the /QUERY qualifier, EDT
asks you about each line before deleting it. The responses are listed
at the beginning of this section.
Find range

FIND locates the specified range (which must be a single line) and
places the cursor at the beginning of the line.
INClude ftlespec [range]

INCLUDE inserts the file whose name you specify into the buffer
specified by range. The default for range is the current buffer. EDT
inserts the file in front of the first line of range.
Insert [range]

INSERT allows you to insert text at the point specified by range, which
must be a single line. EDT inserts the text you type in front of the
line indicated by range. You terminate the text to be inserted with a
CTRL/Z. However, if you wish to insert only one line of text, you can
follow the range with a semicolon; any text typed on the same line
after the semicolon is inserted at range.

EDT

4-61

Move [range-l] TO [range-2][!Query]

MOVE moves the text specified by range-l to the point indicated
by range-2. The default for range-l and range-2 is the current line.
Range-2 must be a single line. MOVE deletes the original copy of the
text and moves it in front of the point indicated by range-2.
Print nlespec [range]

PRINT writes a file called filespec to the line printer, if any.
default for range is the current buffer.

The

Replace [range]

REPLACE is the equivalent of a DELETE command followed by an
INSERT command. EDT deletes the text specified by range and allows
you to insert text to replace it. The default for range is the current
line. Replacement text is inserted at the point from which the deleted
text was taken. You can insert a single line of text by following the
range with a semicolon. EDT inserts any text between the semicolon
and the RETURN after deleting the text indicated by range.
RESequence [range ][/SEquence[[:lnltlal: Increment]]]

RESEQUENCE assigns new sequence numbers to the lines in the range.
Range must specify a contiguous set of lines, and the default for range
is the entire current buffer. If you use the ISEQUENCE qualifier, EDT
starts the sequencing with the value of initial and adds the value of
increment to get the next line number. If you omit the ISEQUENCE
qualifier, initial defaults to the first line number of range and increment
defaults to 1.
Substitute /strlng-l/strlng-2[!][range][/Brlef[[:n]][[/NOType]][[!Query]]]

SUBSTITUTE replaces occurrences of string-l with string-2. Range
specifies where EDT may look for string-I. If you omit range, it
defaults to the current line. (You can use any character as a string
delimiter provided you use the same delimiter in all places.) EDT
displays the line after it makes the substitution. The IBRIEF qualifier
tells EDT to display only n characters of the line. The INOTYPE
qualifier tells EDT not to display the line. The IQUERY qualifier tells
EDT to ask before doing each substitution. The possible responses are
described at the beginning of this section.
Notice that the slash (I) is part of the command. If you wish to
use SUBSTITUTE on a string that includes a I, you can replace the
I with another delimiter chosen from the shifted number keys on the
keyboard. For example, the following command substitutes Micro/RSX
(with I) for MicroPDP-ll:
*SUBSTlTUTE$MicroPDP-11$Micro/RSX$WHOLE/QUERY

4-62

EDT

Notice that the $ is not substituted for the / in front of QUERY.
[Substitute] Next [/strlng-l/strlng-2[[/]]]

SUBSTITUTE NEXT replaces the next occurrence of string-1 with
string-2. The command is especially useful after you have used the
SUBSTITUTE command, since string-1 and string-2 default to the
strings specified in your last SUBSTITUTE command. When EDT
makes a substitution on a line, that line becomes the current line. The
same rule about the / holds.
[Type][range][/BRlef[[:n]][[/STay]]]

TYPE is the default line-mode command and need not be specified.
TYPE displays the specified range of lines. Range can be a single line
or multiple lines, and the multiple lines need not be contiguous. If you
include the /BRIEF qualifier, EDT displays only the first n characters
from each line (n defaults to 10). If you specify the /STAY qualifier,
EDT does not move the current line.
Write filespec [range][/SEQuence [[:Inltlal:lncrement]]]

WRITE writes the text specified by range to a file called filespec. If
you use the /SEQUENCE qualifier, EDT includes the line numbers,
starting with initial and increasing by increment, in a fixed field in
the output file. If you omit the /SEQUENCE qualifier, EDT uses the
line numbers it obtained from the input file. In other words, use this
command to create a file without leaving EDT.

4.6.4 Editing Entities
Some character editing commands operate on pieces of text that EDT
recognizes by special names. These pieces are called entities of text. The
names are used in nokeypad commands, but some of the entities are used
in keypad commands as well. Table 4-12 summarizes the EDT entities.

EDT 4-63

Table 4-12:

4-64

Editing Entities

Entity

Description

A single character, which may be any of the alphabetic, numeric,
or special keys on the keyboard. Control characters, such as
CTRL/M, are considered single characters.

A word, which is a string of characters delimited by one of a set
of delimiter characters. The default delimiters are space, RET,
TAB, and FF, but you can change these with the SET ENTITY
command.

The string of characters from the cursor position to the beginning
of the word; if the cursor is at the beginning of a word, BW is
the previous word.

The string of characters from the cursor to the end of the word,
including the character at the cursor position.

A single line of text.

The string of characters from the cursor to the beginning of the
line, or, the previous line, if the cursor is at the beginning of a
line.

The string of characters from the cursor to the end of the line,
including the character at the cursor position.

The string of characters from the cursor position to the beginning
of the next line.

PAR

A string of characters between paragraph delimiters; the default
delimiter is a pair of RETURNs, but you can change these with
the SET ENTITY command.

BPAR

A string of characters from the cursor to the beginning of the
paragraph, or the previous paragraph, if the cursor is at the
beginning of a paragraph.

EPAR

A string of characters from the cursor to the end of the
paragraph, not including the paragraph delimiter, but including
the character at the cursor position.

SEN

A string of characters between sentence delimiters; the default
delimiters are period, question mark, and exclamation point, but
you can change these with the SET ENTITY command.

EDT

Table 4-12 (Cont.):

Editing Entities

Entity

Description

BSEN

A string of characters from the cursor to the beginning of the
sentence.

ESEN

A string of characters from the cursor to the end of the sentence,
not including the sentence delimiter; but including the character
at the cursor position.

PAGE

The text between page delimiters, including the second delimiter;
the default delimiter for a page is a form feed (CTRL/L), but you
can change this with the SET ENTITY command.

BPAGE

The text from the cursor to the beginning of the page, or the
previous page, if the cursor is at the beginning of the page.

EPAGE

The text from the cursor to the end of the page, not including
the page delimiter, but including the character at the cursor
position.

The text between the cursor and the beginning of the current
buffer.

The text between the cursor and the end of the current buffer.

The text between the cursor and the same column position on
the next line, or the end of the next line, if the next line does
not contain enough characters to reach the same column.

'xyz'

A string of characters that is used in search operations; when
you use this entity with the D (delete), CUT, or R (replace)
functions, the entity includes the text between the cursor and
the string.

The text in the Select Range, which is everything between
the cursor position and the place in the buffer where the SEL
command was last executed; if you have entered no select
command (or you have canceled the last one) SR defaults to the
search string, or to a single character in the current direction for
the CHGC (change case) command.

4.6.5 Keypad Commands
This section provides a brief description of the function of each keypad
command, in Table 4-13. For further information on these commands, use
the keypad HELP key.

EDT

4-65

Table 4-13:

Keypad Commands

Couunand

Function

ADVANCE

Sets the current direction to be forward (toward the end
of the current buffer). This is the default setting, and it
remains in effect until you give the BACKUP command.
This is keypad key 4.

APPEND

Deletes the Select Range and stores it at the end of the
paste buffer, leaving the previous contents of the paste
buffer untouched. This is keypad key 9.

BACKUP

Sets the current direction to be backward (toward the
beginning of the current buffer). This setting remains in
effect until you give the ADVANCE command. It is quite
confusing to be pointing back when you think you are
pointing forward. All commands implying a direction are
affected. This is keypad key 5.

BLINE

Moves the cursor over a BL in the current direction.

BOTTOM

Places the cursor at the end of the current buffer. This is
keypad key GOLD 4.

CHNGCASE Changes the case of letters in the Select Range (UPPERCASE
letters become lowercase and vice versa). If there is no
Select Range this command operates on one character in
the current direction. This is keypad key GOLD 1.
COMMAND Prompts you to enter a line-editing or editor-control command. This is GOLD 7 on the keypad.

4-66

CUT

Deletes the Select Range from the current buffer and places
the text in the paste buffer. This is key 6 on the keypad.
On VT200-series terminals, the REMOVE key also performs
a cut.

DELC

Deletes the character the cursor is on and places it in the
character buffer. This is the comma (,) on the keypad.

DEL EOL

Deletes the text between the cursor and the next line
terminator, including the character at the cursor but not
the terminator, and places it in the line buffer. This is
keypad key GOLD2. Compare this key with DEL L.

EDT

Table 4-13 (Cont.):

Keypad Commands

Command

Function

DEL L

Deletes the text between the cursor and the next line
terminator, including the terminator and the character at
the cursor, and places it in the line buffer. This is PF4 on
the keypad. Compare this key with DEL EOL. You can
delete the line with one command, undelete it with UND
L (GOLD PF4), and then delete it with the other command
and notice the difference.

DEL W

Deletes the text between the cursor and the next word
terminator, including the character at the cursor but not the
word terminator, and places it in the word buffer. This is
the underscore (_) on the keypad.

DOWN

Moves the cursor to the same position on the next line
down, or to the end horizontal position if the next line
contains enough characters, otherwise the end of the next
line. This is the DOWN-ARROW.

ENTER

Causes the command to be executed when you enter a linemode command (using COMMAND); terminates text strings
you enter when searching (using FIND); terminates key
definitions you enter when redefining keys (using CTRL/K).

EOL

Moves the cursor to the end of the current line. This is key
2 on the keypad.

FIND

Searches in the current direction for the search string. You
are prompted for the string, which you must terminate with
ENTER, ADVANCE, or BACKUP. (If you use ADVANCE or
BACKUP, you may change the default direction.) FIND also
stores the search string in the search buffer. This is GOLD
PF3 (and also the FIND key on the VT200-series terminals).

FNDNXT

Searches in the current direction for the search string, which
is the text stored in the search buffer. Text is entered in the
search buffer when you use the FIND command or execute
a line-editing or nokeypad command that specifies a search
string. FNDNXT is PF3 on the keypad.

GOLD

Causes the next keypad key pressed to perform the alternate
function. You can also enter repeat counts for commands by
pressing GOLD, then a number, using the keyboard keys.
GOLD is PF1.

EDT 4-67

Table 4-13 (Cont.):

4-68

Keypad Commands

Command

Function

HELP

Displays a picture of the keypad on the terminal screen and
asks what key you would like described, then displays a
short description of the function of the key you specify.
HELP is PF2.

LEFT

Moves the cursor one character position to the left; if the
cursor is at the beginning of a line, LEFT moves it to the
end of the previous line. This is the LEFT-ARROW.

OPEN LINE

Inserts a line terminator after the cursor position; this either
creates a blank line or moves the text to the right of the
cursor to a new line. This is GOLD 0 on the keypad.

P AGE

Moves across a PAGE in the current direction. PAGE is 7
on the keypad.

PASTE

Inserts a copy of the text in the paste buffer at the cursor
position, leaving the paste buffer intact. PASTE is GOLD 6
on the keypad.

REPLACE

Deletes the Select Range and replaces it with the contents
of the paste buffer. REPLACE is GOLD 9 on the keypad.

RESET

Cancels the current Select Range or cancels the GOLD key
if you have pressed it and changed your mind about using
it. RESET is GOLD . (M dot") on the keypad.

RIGHT

Moves the cursor one character position to the right; if the
cursor is at the end of a line, RIGHT moves the cursor to
the beginning of the next line. This is the RIGHT-ARROW.

SECT

Moves the cursor sixteen lines in the current direction,
leaving it at the left margin. SECT is 8 on the keypad.
On the VT200-series terminals, PREV SCREEN moves back
one section and NEXT SCREEN advances one section.

SELECT

Marks a position in the buffer as being one end of a Select
Range. The Select Range is everything between this marked
position and the current cursor position. You can move the
cursor in all the usual ways. SELECT is. (dot) on the
keypad. The VT200-series terminals have a second SELECT
key on the editing keypad.

EDT

Table 4-13 (Cont.):

Keypad Commands

Command

Function

SPECINS

Allows you to insert a character into the buffer by specifying
its ASCII value. First, press the GOLD key, then the numeric
value using the keyboard keys and then press SPECINS.
This is GOLD 3 on the keypad.

SUBS

Deletes the search string, replaces it with the contents of
the paste buffer, and finds the next occurrence of the search
string. This is GOLD ENTER on the keypad. Read the
keypad help for information on using this key. Many users
use the line-mode SUBSTITUTE command in conjunction
with GOLD 7.

TOP

Positions the line the cursor is on at the top of the screen.
This is GOLD 5 on the keypad.

UND C

Places the character in the character buffer at the cursor
position, leaving the character buffer unchanged. That is,
you can undelete the same character repeatedly. This is
GOLD, (comma) on the keypad.

UND L

Places the text in the line buffer at the cursor position,
leaving the line buffer unchanged. You can undelete the
same line repeatedly. This is GOLD PF3.

UND W

Places the text in the word buffer at the cursor position,
leaving the word buffer unchanged. You can undelete the
same word repeatedly. This is GOLD _ (underscore).

Moves the cursor to the same cursor position in the line
above if it exists; if not, to the end of the line above. This
is the UP-ARROW.

WORD

Moves the cursor to the next W in the current direction,
past the next word delimiter. This is the 1 on the keypad.

In addition to these functions which are accessible from the keypad, several
functions are available on the keyboard itself, as shown in Table 4-14.
Keypad and keyboard keys that you never use are good candidates for
redefinition.

EDT

4-69

Table 4-14:

Keyboard Commands

Command

Function

BACK SPACE Moves the cursor to the beginning of the line
LINE FEED

Deletes the previous word and puts it in the word buffer

CTRL/A

Sets tab indentation level to current cursor position (cursor
position must be an even multiple of the SET TAB value)

CTRL/D

Decreases the tab level one unit

CTRL/E

Increases the tab level one unit

CTRL/F

Fills the selected range to the line width

CTRL/K

Accepts a definition for a keypad key or control character

CTRL/T

Moves selected range a tab stop left for a minus argument,
right otherwise

CTRL/U

Deletes text between the cursor and the beginning of the
line

CTRL/W

Refreshes the screen

CTRL/Z

Returns to line editing

4.6.6 Nokeypad Commands
Nokeypad commands are important not only for users who use nokeypad
editing, but also for writing key definitions. Many powerful functions
can be performed by strings of these commands (see Section 4.5.2 for a
detailed discussion of key definitions).
Nokeypad commands must be entered exactly. Abbreviations are not
allowed. The commands may be strung together without delimiters if you
wish, or you may include spaces. You can repeat a string of commands
by enclosing the string in parentheses. When a command in the string
fails (for instance a search command does not find its object), EDT stops
executing commands. All these rules also hold for a command string of
nokeypad commands used in key definitions.
Nokeypad commands consist of one or more of the following elements: a
nokeypad command, a count of actions or entities, a direction, an entity,
and a buffer name. The count either tells EDT how many times to perform
an action, or how many entities to handle. The direction is either + for

4-70

EDT

forward (towards the end of the buffer) or - for backward (toward the
beginning of the buffer). Entities are summarized in Section 4.6.4. The
buffer name is used in CUT, PASTE, and APPEND commands to tell EDT
where to store pieces of text.
There are three possible formats for nokeypad commands, each formed
from combinations of the above-mentioned elements.
The legal formats are described with the commands using that format.
Syntax for Format 1
command

Format 1 commands specify EDT's actions. You cannot modify the action
of these commands, so there are no qualifiers possible. See Table 4-15.
Table 4-15: Commands for Format 1
Command Function
ADV, +

Both ADV and the + set the current direction to forward
(towards the end of the buffer, which is to the right and
down), unless you override it with the minus (-) or BACK in
your command string.

BACK, -

Both BACK and - set the current direction to backward
(towards the beginning of the buffer, which is to the left
and up), until you override it with the plus (+) or ADV.

Exits nokeypad editing and returns to EDT line mode.

EXT

Tells EDT that the rest of the line consists of line-mode
commands; when EDT has finished executing the line-mode
commands, it returns to character editing. The GOLD 7 key
uses this function.

Opens the current buffer to allow you to insert text in front of
the cursor position. You terminate the insertion with CTRL/Z,
or follow the I with a semicolon (;) to insert the rest of the
line into the buffer as text. The INSERT key on the VT220
editing keypad also performs this function.

QUIT

Exits from EDT and returns you to the system command level
without saving any files.

REF

Refreshes the screen.

EDT

4-71

Table 4-15 (Cont.):

Commands for Format 1

Command Function
SEL

Selects a range of text when you enter the command at one
end of a piece of text; then positions the cursor at the other
end. The SELECT keys use this function.

TAB

If you have set a tab size (with the SET TAB editor-control
command) and the cursor is at the beginning of a line, this
command inserts enough tabs and spaces to set the cursor
position to the SET TAB value times the indentation level
count. See Section 4.5.4 for more on the level counter. If you
have not set a tab size, or the cursor is not at the beginning
of a line, this command inserts a tab character.

Computes the current indentation level count by dividing the
current cursor position by the value you gave with the SET
TAB command. If the cursor position is not divisible by the
tab value, EDT issues an error message. See Section 4.5.4 for
more on the level counter.

TOP

Places the current line at the top (beginning) of the buffer.

Syntax for Format 2
[ +

I - ] [count] command

Format 2 commands have variable count and direction parameters. The
default count for these commands is 1 in the current direction. Only two
commands using this format allow you to vary the direction, SUBSTITUTE
and SUBSTITUTE NEXT. See Table 4-16.
Table 4-16: Commands for Format 2

4-72

Command

Function

ASC

Allows you to enter arbitrary ASCII characters into a buffer
by entering the ASCII value of a character before the ASC
command. The SPECINS key uses this function.

S/sl/s2/

Replaces string sl with string s2; if you give a count, that
many substitutions are performed, and if you give a minus
( -) the search goes backward (note that any nonalphabetic
character can be used as a delimiter).

EDT

Table 4-16 (Cont.):

Commands for Format 2

Command

Function

Uses the strings defined in the last S (Substitute) command
to replace the next occurrence of string s1 with string s2; if
you give a count, that many substitutions are performed, and
if you give a minus (-) the search goes backward.

SHL

Tells EDT to shift the image it displays on the screen to
the left. The number of characters shifted is eight times the
count entered with the SHL command. This command does
not work if you have SET NOTRUNCATE.

SHR

Tells EDT to shift the image it displays on the screen to
the right; the number of characters shifted is eight times the
count entered with the SHR command. This command does
not work if you have SET NOTRUNCATE.

Decreases the indentation level count; if the count is zero,
this command has no effect. See Section 4.5.4 for more on
the level counter.

Increases the indentation level count. See Section 4.5.4 for
more on the level counter.

UNDC

Un deletes a character by copying it from the character buffer
into the current text buffer in front of the cursor (leaving the
character buffer untouched). If you give a repeat count, EDT
inserts that many copies of the character in the buffer.

UNDW

Undeletes a word by copying it from the word buffer into the
current text buffer in front of the cursor (leaving the word
buffer untouched). If you give a repeat count, EDT inserts
that many copies of the word in the buffer.

UNDL

Undeletes a line by copying it from the line buffer into the
current text buffer in front of the cursor (leaving the line
buffer untouched). If you give a repeat count, EDT inserts
that many copies of the line in the buffer.
Inserts control characters into your text buffer when you enter
a letter following the circumflex. This does not work inside
an insert block, between an I and the CTRL/Z.

Syntax for Format 3
[ +
[ +

I - ] [repeat-count] command [ + I -] [entity-count]
I - ] entity [ = buffer]

EDT

4-73

Format 3 commands specify an action on an entity. These commands
permit variable count and direction parameters, and some can operate in a
buffer other than the current one. You can place the direction sign in any
of the indicated positions. If you include counts in both places, they are
multiplied by each other. For example, the command string 3D3C deletes
nine characters. See Table 4-17.
Table 4-17: Commands for Format 3

Command

Function

APPEND

Deletes the specified entities and moves them to the end of the
specified buffer. If you do not include a buffer specification
in the command, EDT uses the paste buffer. Compare with
CUT.

CUT

Deletes the specified entities and moves them to the specified
buffer. If you do not include a buffer specification, EDT uses
the paste buffer. EDT copies over the previous contents of
the receiving buffer. Compare with APPEND.

Deletes the specified entities.

FILL

Fills the specified text inside the margin defined by the SET
WRAP command. All the text that fits inside the bounds set
by the SET WRAP command is placed on each line, with the
rest dropped to the next line. Text is broken only between
words.

PASTE

Copies the contents of the specified buffer in front of the
cursor, leaving the specified buffer unchanged. If you omit a
buffer specification, EDT uses the paste buffer.

Deletes the specified entities and places you in insert mode,
allowing you to replace the deleted text. Press CTRL/Z to exit
insert mode.

TADJ

Moves the Select Range the specified number of tab stops in
the specified direction. See Section 4.5.4.

4.7 EDIT Command
EDIT invokes EDT, the DEC standard Editor. See the EDT Editor Manual
for more information.

4-74 EDT

Format
EDIT[/EDT][/ qualifier[s]] infile
or
ED IT[/ qualifier[s]] infile
Command Qualifiers
I[NO]CO~Y1~Y1~A~ND[:filespec]

/[NODOURNAL[ :filespec ]
/[NO]OUTPUT[:filespec]
/[NO]READ_ONLY
/[NO]RECOVER

Parameter
Inftle

Specifies the file to be edited. If the file does not exist, EDT creates it.
You must supply a file name, but the type can be null.

Command Quallfters
I[NO ]COMMAND[ :ftlespec]

Controls whether an EDT initialization file is read by EDT before
editing begins. These files contain commands that alter the default
setup for EDT, such as custom line-mode commands and change-mode
key definitions.
The default is /COMMAND:EDTINI[.EDT].
If you use this qualifier and EDTINI.EDT or some other file you name
does not exist, EDT issues no error message and continues with the
editing session.
If you have a file EDTINI.EDT and do not want to use it, use the
/NOCOMMAND qualifier.
I[NO ]JOURNAl[ :ftlespec]

Controls whether EDT creates a journal file for the editing session.
The default is to create a journal file with a file name the same as that
of the input file with the type .JOU. You can specify a different name
by including a file specification.
The journal file consists of all editing commands and text entered
during the session. If the editing session ends abnormally, such as
through a system crash, or your inadvertently typing three CTRL/Zs
in succession, the journal file is saved. In such a case, you invoke EDT
again, with the same command line as before plus the /RECOVER

EDT

4-75

qualifier.
restored.
deleted.

Your editing session is repeated and all your editing is
If the editing session ends normally, the journal file is

If you specify /NOJOURNAL, no journal file is created and no recovery

is possible.
/[ NO ]OUTPUT[ :fllespec]

If you do not specify this qualifier, the default is to create a file of

the same name and type as the input file with a version number one
higher than the input file. If the file is new, EDT creates version
number 1. You can alter the name of the output file by including a
file specification with the /OUTPUT qualifier. Otherwise, the qualifier
need not be included.
If you specify /NOOUTPUT, you cannot exit EDT without including

a file specification in your EDT EXIT command.
/[NO]READ_ONL Y

Specifies whether you want simply to read the file or to edit it. If your
command line includes /READ_ONLY, you can use the full facilities
of EDT, but you cannot exit without including a file specification
in your EDT EXIT command. Normally, you would use the EDT
QUIT command if you had specified /READ_ONLY. The /READ_
ONLY qualifier is equivalent to a combination of /NOOUTPUT and
/NOJOURNAL. You can use /READ_ONLY to look at files to which
you have no write access.
The default is /NOREAD_ONLY, which need never be specified.
/[NO]RECOVER

Specifies whether EDT reads commands from a journal file prior to
starting the editing session. With a journal file, your editing session
can be restored if interrupted by a system crash or other problem. The
default is /NORECOVER, which need never be specified.
The /RECOVER qualifier requests EDT to open the input file and
then read EDT commands and text from the file with the same file
name as the input file and the file type .JOU. The command line with
/RECOVER added to it must be identical to the command line that
initiated the original failed editing session. This means that if you
specified an EDT initialization file, you must specify the same file in
the /RECOVER command line. And, if you specified a name for the
journal file other than infile.JOU, you must include the /JOURNAL
qualifier with the appropriate file specification. If journaling was not
enabled on the original command line, you cannot recover the editing
session.

4-76

EDT

Examples

S EDIT [ID]
File? HORNBLOW.TXT [ID]
Input file does not exist
[EOB]

*
This example shows the EDiT command in its simplest form. The file
HORNBLOW.TXT is created during the editing session.

S EDIT HORNBLOW.TXT [ID]
This is the one-line form of the same command.

S EDIT/OUTPUT:UMPIRE.MAC WEAVER.MAC [ID]
1

. TITLE WEAVER

*
In this example, the user takes an existing file as input and edits it to
create a new file.

S EDIT/COMMAND:FORMAT RAMBLE.RNO [ID]
Input file does not exist
[EOB]

*
In this example, the user prepared an EDT initialization file called
FORMAT.EDT. This file contains EDT command definitions designed to
be used with a text formatting program. See next example.

S EDIT/COMMAND:FORMAT/RECOVER RAMBLE.RNO [ID]
This is FORMAT. EDT. Version 2.4

Ambrose Bierce, Maintainer

During the editing session started in the previous example, the system
crashed. Once it was back on the air, the user duplicated his original
command exactly, naming the same EDT initialization file and then added
the /RECOVER qualifier. EDT begins reproducing the entire editing
session, beginning with reading in the initialization file, the first line
of which is seen in the example. All the editing commands and text
entered during the session have been recorded in the file RAMBLE.JOU,
which is also read back in by EDT. The result is that the entire editing
session is repeated up to within a few keystrokes of the crash.

EDT

4-77

If you want to test the recovery procedure, start editing a file and then
enter three CTRL/Zs as line-mode commands. This causes an unnatural
exit from EDT, so the journal file is saved. You can then duplicate the
original command line, add the /RECOVER qualifier, and watch yourself
edit.

Notes
See the EDT Editor Manual, which is available separately, for more
information on journaling, initialization files, command and key definitions,
and the other editing functions of EDT.
The qualifiers used with EDIT/EDT will not work with other forms of the
EDIT command. If you use the /EDT qualifier, it must appear immediately
after EDIT on the command line. Other qualifiers can float.
You can use the MCR command to invoke EDT in a different format that
some users may find more convenient. See the EDT Editor Manual for the
alternate command format.

4-78 EDT

Chapter 5
Files on Micro/RSX Systems
The commands in this chapter are used to create files, list them in
directories, remove them from directories, print copies of them on your
terminal or the line printer, and alter their contents in various ways. For a
quick review of file-handling commands, see the Introduction to Micro/RSX.
For complete detail on these commands, see the Micro/RSX User's Guide,
Volume 2, Chapter 12, More About Files on Micro/RSX Systems.
All files are stored on volumes. A volume is a disk, diskette, or tape with
data written on it in a form that Micro/RSX can use. Once the volume is
mounted, you can access the files on the volume. For more information
about volumes and devices, see Chapter 6, Devices and Volumes, or
Volume 2, Chapter 13, More About Devices and Volumes.
Within each disk volume, files are organized in directories. For the entire
volume, there is a Master File Directory (MFD). The MFD is a file named
[OOOOOO]OOOOOO.DIR. Most files listed in the MFD are User File Directories
(UFDs). In general, UFDs are simply called directories. Each directory is a
file with a name based on the name of the directory and the type .DIR.
See Figure 5-1 for an illustration of the relationship between volume,
MFD, and directory.

Files on Micro/RSX Systems 5-1

Figure 5-1:

File Organization on a Volume
MFD
[000000]

DIRECTORY
[USER]

I
HIYA.M AC;1

----

DIRECTORY
[303005]

FLY.TXT;1

I
IllY.TXT;1

I
OlY.TXT;1

-----

ZK-3078-84

5. 1 File Ownership and Location
When you log in, you identify yourself with a User Identification Code
(UIC). You log in to your default device and directory. The default directory
has a name (or number) assigned by the system manager at the time your
account is set up. Nonprivileged users can change their default device and
directory, but not their UIC. Privileged users can change both. The UIC
identifies the user; the directory identifies the location of the files.
If you issue the SHOW DEFAULT command, you can find out your
default device (SY:), your default directory, and your UIC. The SHOW
UIC command gives you your UIC. Both these commands are described
in Section 5.10.

The default device is actually a volume mounted on a device. Most
Micro/RSX users have their main accounts on a fixed disk, but you can
also have accounts on diskettes as well.
Regardless of whether it is DUO:, DU1:, or some other device, your default
device can always be called either by its name or by the name SY:. This
is a logical assignment made each time you log in. Information on your
default device is kept by ACNT, the Account File Maintenance Program,
and picked up from there each time you log in. See the Micro/RSX System
Manager's Guide for more information on ACNT.

5-2 Files on Micro/RSX Systems

When you create a file, the system places the file name in a directory along
with a UIC. The UIC indicates the ownership of the file.
Each directory is a file with a name based on the name of the directory
and the type .DIR. Thus, directory [KIZZY] is a file listed in the Master File
Directory (MFD) named KIZZY.DIR, and directory [200001] is a file listed
in the MFD named 200001.DIR.
Directory entries consist of the names of files and pointers to file headers.
The file header holds information about the file's owner and the location
of the file on the mass-storage medium. Thus, a full file specification not
only identifies the file, but locates it as well.

5.2 File Specification
A file specification uniquely identifies a file, indicating its location and its
contents. Many DCL commands require file specifications.
The format of a file specification is as follows:
ddnn:[directory]name.type;ver

Parameters
ddnn:

Specifies the type of device and unit number on which the volume
containing the file is mounted. A full device name consists of two
alphabetical characters followed by one or two numbers, each from 0
through 7, followed by a colon. Examples include DUO:, DU1:, MSO:.
[directory]

Specifies the name of the directory in which the files are located.
Micro/RSX accepts either named directories or numbered directories. The
format for a named directory is as follows:
[directory]
where directory is from one to nine of the following
characters: the 26 letters from A through Z, and the
numbers from 0 through 9.
Examples of named directories include [MINGUS], [RITTENBRG],
[001002], and [A1B2C3].
The format for a numbered directory is as follows:
[g,m]
where g and m are octal numbers from 1 through
377.
Examples of numbered directories include [1,2] and [303,17].

Files on Micro/RSX Systems 5-3

See Volume 2, Chapter 12 for a description of the /NONAMED_
DIRECTORY qualifier for the SET DEFAULT command. When your
terminal's default is /NONAMED_DIRECTORY, then you can specify
only numbered directories in the SET DEFAULT command.
name

Specifies the name of the file, which can be from zero through nine
of the following characters: the 26 letters from A through Z, and the
numbers from 0 through 9 .
.typ

Specifies the file type. The type can be from zero through three of
the following characters: the 26 letters from A through Z, and the
numbers from 0 through 9. In general, the file type indicates the file
contents. For example, .FTN is the file type for FORTRAN source
programs. Null file types (0 length) are acceptable.
Always separate the name from the file type with a period (.).
There are no other restrictions on file types, but many system tasks
use default file types for input and output files. These defaults and
some system conventions on file types are summarized in Table 5-1.
:ver

Specifies the version number, a decimal number from 1 through 32767.
The version number identifies different versions of the same file. When
you create a file without specifying a version number, the system
assigns the file version number 1. Each time you create a new version
of a file-by editing it, for instance-the system adds one to the version
number.
You must separate the file type and version number with a semicolon.
You can also create a file with an explicit version number.
If you create a file with version number 32767, you can be sure
that file will not be inadvertently superseded by a file with a higher
number; 32767 is the highest possible version number. Under normal
circumstances, if you create a file with the same name and type as an
existing file, the new file's version number is one higher than the old
one. This cannot happen with the version number 32767. This feature
is useful where you must have a particular version of a file for some
reason.

In addition, you can use version 0 or version -1 in commands. Version

o is the most recent version of a file. Version -1 is the oldest version
of a file.

5-4 Files on Micro/RSX Systems

In most cases, Micro/RSX systems do not require you to enter the full file
specification. Defaults are supplied for all fields of the file specification
except the name (see Section 5.3). In addition, you can use wildcards to
specify groups of related files (see Section 5.4).

5.3 Defaults in File Specifications
Except for the file name, if you omit a field of the file specification, the
system automatically supplies the field as described here:
Field

Default

ddnn:

The system establishes your default device when you
log in. SY: is always your default device. Logging in
assigns SY: to some physical device. You can use SET
DEFAULT to change the assignment of SY:; you can
display the assignment with SHOW DEFAULT (see
Section 5.10). You do not have to use the unit number
for devices numbered o. DU: is the same as DUO:, for
instance.

[directory]

The system manager specifies your default directory
when establishing your account. Your default directory
can be any legal directory name. Normally, your
default directory is either your last name or a directory
whose numbers are identical to your User Identification
Code. You can change the default directory with SET
DEFAULT (Section 5.10.1); you can display the default
directory with SHOW DEFAULT (Section 5.10.2).

.typ

Standard file types (see Table 5-1) are used as defaults .
There is not a default file type in every situation.
Neither EDT nor the CREATE command assigns a
default file type. If you create a file without specifying
a file type, the file type is null, meaning only the dot
(.) is there. For instance, the following command:
$ CREATE NOFILTYPE IRET!
creates a file named NOFILTYPE.;l.

;ver

For input files, the default is the highest numbered
version; for output files, it is the next higher version
number, or 1 if no previous version exists.

Files on Micro/RSX Systems 5-5

The defaults make it possible for you to specify files without having to
type in the full file specification.
Suppose, for example, that your default device is DUO:, which the operating
system assigns the logical device name SY:, and your default directory
is [PISMO]. Assume further that there are three sequentially numbered
versions of a file called CLAM.TXT in the directory. If you want to print
the highest numbered version of this file (version 3) on your terminal, you
can use any of the following forms of the TYPE command, as they all
produce the same result:
• TYPE CLAM. TXT
• TYPE CLAM.TXT;3
• TYPE CLAM.TXT;O
• TYPE [PI8MO]CLAM.TXT;3
• TYPE DUO:CLAM.TXT
• TYPE DUO: [PI8MO] CLAM. TXT
• TYPE 8Y:CLAM.TXT
• TYPE 8Y: [PI8MO]CLAM.TXT;3
• TYPE 8Y: [PI8MO]CLAM.TXT;O

In most cases, you will use the first form, but if you want to keep a
permanent record of the terminal session, you may choose one of the
more explicit forms. In any case, the final form given is what the system
uses, as that form has all the defaults supplied. (Note that version 0 is
always assumed to be the highest numbered version, which is number 3
by definition in this example.)
Table 5-1: File Types
File Type

Use

.BAT

File containing batch processing commands. System convention. See Chapter 8 for more information about batch
processing.

.BLO

Indirect command file used by the System Generation
procedure to create files needed to build system tasks.
System default.

.B2S

BASIC-PLUS-2 source program. System default. BASICPLUS-2 is available separately as a software option.

.CBL

COBOL source program. System default.
available separately as a software option.

5-6 Files on Micro/RSX Systems

COBOL is

Table 5-1 (Cont.):

File Types

File Type

Use

.CMD

Indirect command file. System default. See Chapter 9 for
more information about indirect command processing.

.DAT

File containing data, as opposed to code. System convention .

.DIR

File is either Master File Directory or User File Directory .
System default.

.DMP

Dump file created by DMP, the File Dump Utility. System
DMP is part of the Micro/RSX Advanced
default.
Programmer's Kit.

.FTN

FORTRAN-77 source program. System default. FORTRAN77 is available separately as a software option.

.LOG

Log of batch processing session. System default. See
Chapter 8 for more information about batch processing.

.LST

Listing file. System default.

.MAC

MACRO-II source program.
System default.
The
MACRO-II Assembly Language is available in the
Micro/RSX Advanced Programmer's Kit as a software option.

.MAP

Task Builder map file. System default. See Volume 2,
Chapter 14, LINK and LIBRARY Commands, for more
information. See also the RSX-IIM/M-PLUS and Micro/RSX
Task Builder Manual, available separately, and as part of the
Advanced Programmer's Kit.

.MLB

Macro library.
System default.
See the Advanced
Programmer's Kit for more information.

.OB}

Object module output from assembler or compiler. System
default. See the Advanced Programmer's Kit, or separate
language documentation for more information.

.ODL

File containing Overlay Descriptor Language to be used by
Task Builder. System default. See the RSX-IIM/M-PLUS
and Micro/RSX Task Builder Manual, available separately,
and as part of the Advanced Programmer's Kit, for more
information about overlays.

.OLB

Object module library. System default.

Files on Micro/RSX Systems 5-7

Table 5-1 (Cont.):

File Types

File Type

Use

.PMD

File containing Postmortem Dump of interrupted task.
System default. See the Advanced Programmer's Kit for
more information.

.SYS

A bootable system image. System default .

.TMP

A temporary file. System convention .

.TSK

Task image file. System default.

.TXT

A text file. System convention .

.ULB

Universal library. System default.

5.4 Wildcards in File Specifications
In addition to the regular defaults for the current device, the current
directory, and the most recent version, you can use wildcards with the
commands in this chapter to set up temporary defaults for every part of
the file specification except the device name.
Simple wildcarding uses the asterisk (.) to replace any or all fields in the
file specification except the device name.
For instance, the following command:
• DIRECTORY [ *]

IBITl

lists all files in all directories on the default volume. The [.] means "all
directories. "
The following command:
• DIRECTORY [100.*] IRETI

lists all files in any numbered directories that have a group number of 100.
The following command:
• DIRECTORY [*] TEXT . TXT lID]

lists the most recent versions of all files named TEXT. TXT, regardless of
the directory.
Likewise, the • in place of the version number means "all versions."

5-8 Files on Micro/RSX Systems

The following command:
• DIRECTORY WON.BAT;*

IBm

lists all versions of the file WOM.BAT in the default directory.
The asterisk (.) can also be used to replace an entire file name or file type
in much the same way.
The following command:
• DIRECTORY *. BAT

IBm

lists the most recent versions of all files with the type .BAT in the default
directory.
All the examples that follow assume that you want a listing for files on
the default volume and default directory.
The following command:
• DIRECTORY COMMON. * [Rffi

lists the most recent versions of all files with the name COMMON and
any type.
The examples thus far have demonstrated the simple form of wildcarding,
using the asterisk character (.) to replace an entire field in a file
specification. Simple wildcarding works with all the commands in this
chapter. The PRINT command accepts simple wildcarding, as does the
SUBMIT command for batch processing.
For the commands DIRECTORY, DELETE, PURGE, COPY, RENAME,
TYPE, APPEND, UNLOCK, and SET PROTECTION, a more elaborate
form of wildcarding also is available. In these commands, within file
names and file types, the • can be used in a more complex manner. The
• actually means Hmatch zero or more characters in this position."
Wildcards are safest to use with DIRECTORY than any other command
because the DIRECTORY command does not manipulate the contents of
the files. They are most difficult to use with RENAME and COPY. They
are most dangerous to use with DELETE and PURGE. It is always a good
idea to check your wildcard specifications with the DIRECTORY command
before you do anything drastic.
Therefore, the following command:
• DIRECTORY L*. TXT

IBm

Files on Micro/RSX Systems 5-9

lists the most recent versions of all files with the type .TXT whose names
start with "L".
And the following command:
$ DIRECTORY *L*. TXT

mill

lists the most recent versions of all files with the type .TXT whose names
include an "L".
The same substitutions can also be used in file types, so that the following
command:
$ DIRECTORY SNOBLO. L*

mill

lists the most recent versions of all files with the name SNOBLO and the
type beginning with an "L".
You can use more than one wildcard in file names and file types.
The following command:
$ DIRECTORY *F*D*. TXT

mill

lists the most recent versions of all files with the type .TXT whose names
include an "F" and a "D" in that order.
In addition, the same commands permit the percent sign (%) to be used
as a wildcard, but only within file names and file types. The % means
"match exactly one character in this position."
The following command, for instance:
$ DIRECTORY %. TXT [EITJ

lists all files with the type .TXT and a single-character file name.
The following command:
$ DIRECTORY NOV%%85. TXT

mill

lists all files with the type .TXT and a file name consisting of NOV and 85
separated by two characters.
Both kind of wildcards can be combined in a single file specification.
The following command:
$ DIRECTORY %L*T. TM% [EITJ

lists all files whose names begin with a single character followed by an
ilL" and end with a "T" and with a file type consisting of .TM and another
single character.

5-10 Files on Micro/RSX Systems

Wildcarding, combined with systematic policies of directory assignments,
file names, and file types can add considerable flexibility and convenience
to your use of the system.

5.5 Date-Related Qualifiers
The commands DIRECTORY, DELETE, PURGE, COPY, RENAME, TYPE,
APPEND, UNLOCK, and SET PROTECTION also accept several other
qualifiers that add further flexibility to these commands.
First, there are the date-oriented qualifiers:
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy /THROUGH:dd-mmm-yy
/TODAY
These qualifiers all depend on the creation date of the file as shown in
the DIRECTORY listing. /DATE limits the operation of the command
to files created on the specified date. /SINCE limits the operation of the
command to files created on or after the specified date. /THROUGH limits
the operation of the command to files created before or on the specified
date. /SINCE and /THROUGH can be combined to limit the operation
of the command to files created within a given range of dates. /TODA Y
limits the operation of the command to files created on the same day the
command was issued.
You can enter the date in either of the following two forms:
dd-mmm-yy
as in 25-MAY-85
or
mm/dd/yy

as in OS/25/85

The system always displays dates in the first form.
These same commands also accept the following qualifier:
/EXCLUDE:filespec
The /EXCLUDE:filespec qualifier allows you to exclude a file or files
from the operation of the command. The file specification argument to
/EXCLUDE must include a version number, but the version number can
be •. Wildcards are accepted for all parts of the file specification argument
to /EXCLUDE.

Files on Micro/RSX Systems 5-11

The /EXCLVDE qualifier makes it possible to do the following:
$ DELETE/EXCLUDE: MICHAEL. TXT; * IBrn
File (8)? *. TXT; * IBrn

This command deletes all files with the type .TXT, except those named
MICHAEL.TXT.

5.6 Protection
Micro/RSX is a multiuser system. Each user is able to work without
interference from any other user. One way Micro/RSX provides data
privacy and system security is through restrictions on access to volumes
and the files on the volumes.
The best protection for sensitive files is to put them on a diskette, and
then lock that diskette away. The following section explains how files
and volumes can be protected by software on Micro/RSX systems. No
protection is completely safe, just as no lock is a defense against a
determined and resourceful burglar.
In order to access a file, you must have access to the volume, access to the
directory, and access to the file. Protection can be specified for all these
entities.

5.6. 1 File Protection
Each user has a unique Vser Identification Code (VIC) that the system
manager assigns while setting up your account. Your VIC identifies you
to the system.
When you create a file, you usually own it. Your VIC is an attribute of
the file, identifying you as the owner. Each file also has a protection code.
A protection code controls who can access a file and in what ways. You,
as the file's owner, control this protection code.
VICs look like the following:
[303,5]
The VIC consists of two numbers: the first number is your group number,
and the second is your member number. Group and member numbers are
octal and range from 1 through 377.

5-12 Files on Micro/RSX Systems

Generally, all users working on a particular project have the same group
number. As you will see in the following description of file protection
codes, a common group number can allow group members to share files
easily. In addition, group numbers indicate whether or not you are a
privileged user. A privileged user can look at or change any file on the
system. Privileged users have group numbers of 10 or less; nonprivileged
users have group numbers from 11 through 377.
The second number of your VIC identifies you as a particular member of
a group. The combination of the group and member numbers uniquely
identifies an individual user of the system.
Note that, if you are a privileged user, you can change your VIC. See
Section 5.10.3 for a description of SET VIC.
A file protection code specifies four categories of users, as well as four
kinds of file access that each category of user can have. When you attempt
to access a file, the operating system checks your VIC to determine which
of the four user categories you belong to. Your ability to access the file is
limited to the types of access that the file's protection code grants to those
categories.
The four categories of users in a file protection code are as follows:
SYSTEM
The operating system itself, and privileged users. A privileged
user has a VIC with a group number of 10 or less.
OWNER

The file owner who is the user having the same VIC as the
one the file was created under-that is, your VIC.

GROVP

All users having a VIC with the same group number as the
one the file was created under.

WORLD

All other users.

The four kinds of file access that you can grant to the user categories are
as follows:
READ
The user, or the user's tasks, may read, copy, print, or type
the file. If the file is a task image file, READ access means
you may run it. If you deny READ access to a class of users,
they can't run the task.
WRITE

The user, or the user's tasks, may add new data to the file by
writing to it. You can't edit a file without WRITE access, nor
can you use the COpy command to write a file to a directory
where you have no WRITE access.

Files on Micro/RSX Systems 5-13

EXTEND

The user, or the user's tasks, may change the amount of disk
space allocated to the file. In practice, you always specify
EXTEND access along with WRITE access in the protection
code.

DELETE

The user, or the user's tasks, may delete the file. You can't
delete a file without DELETE access.

Your UIC relates to the user categories in a file protection code in the
following ways:
•

Your UIC establishes you as either a privileged or nonprivileged user.
If you are a privileged user, you have the file access rights granted to

the SYSTEM category. Also, as a privileged user, you can change the
protection code of any file. By changing a file protection code for the
SYSTEM category, therefore, you can access any file in any way.
•

When you create a file, the operating system gives your unique UIC to
the file. Your UIC, then, becomes one of a file's attributes, establishing
you as the file's owner. As the owner of a file, you can change its
protection code to suit your needs. Also, you have the file access rights
granted to the OWNER category.

•

The first number in your UIC establishes you as a member of a group.
As a member of a group, you have the file access rights granted to the
GROUP category.

•

You are always a member of the WORLD category.

Ordinarily, the operating system assigns the system's default protection
code to files. In a protection code, the four types of file access are
designated by their first letters. The default protection is as follows:
SYSTEM:RWED.OWNER:RWED.GROUP:RWED.WORLD:R

Note that under this default protection scheme any user can read your files,
because the WORLD category has READ access. Furthermore, everyone
in your GROUP category and all privileged users have full READ, WRITE,
EXTEND, and DELETE access. They can all delete your files.
If you have files that you particularly want to protect against deletion, or
if you want to limit the access people have to your files, use the SET
PROTECTION or the SET PROTECTION/DEFAULT commands described
in Sections 5.10.5 and 5.10.6. Be aware, though, that there is no way
to protect your files from privileged users, because they can change the
protection code for any file.

5-14 Files on Micro/RSX Systems

You can display the protection for any file with the SHOW PROTECTION
command. The DIRECTORYIFVLL command also displays file protection,
in the following form:
[RWED.RWED.RWED.R]

In the DIRECTORY display, the groups are not given, but they appear in
the same order as before: SYSTEM, OWNER, GROUP, \-\'ORLD. In the
previous example, then, WORLD has READ privileges.
A number of DCL commands include qualifiers that help you use file
protection. The most important is the IOWN qualifier to the COpy
command. If you don't specify otherwise, when you copy one of your
files to send it to someone else, you are the owner of the copy, even if it
isn't in your directory.
Assume you have VIC [303,5] and you are placing a copy of a file you
own into a directory called [MOONDOG], which is owned by VIC [200,2].
You use the following command:
• COPY RAMP. TXT [MOONDOG] RAMP. TXT ill.ITl

The file RAMP.TXT is in both directories, but its owner in both cases is
[303,5]. The owner of [MOONDOG] has only WORLD READ access to
her copy of RAMP.TXT, as seen in the following directory listing, where
the file owner is the first item on the second line of each file listing:
• DIRECTORY/FULL RAMP. TXT. [MOONDOG] RAMP. TXT
Directory DUO: [THEFLU]
3-MAR-85 15:49
RAMP.TXT;52
(7516.5)
2./2.
[303.5] [RWED.RWED.RWED.R]
Total of 2./2. blocks in 1. file

mm
1-JAN-85 13:12

Directory DUO: [MOONDOG]
3-MAR-85 15:49
RAMP. TXT; 1
(14343.6)
2./2.
3-MAR-85 15:48
[303.5] [RWED.RWED.RWED.R]
Total of 2./2. blocks in 1. file
Grand Total of 4./4. blocks in 2. files in 2. directories

The IOWN qualifier to the COpy command specifies that the recipient of
the copy is the owner, not the sender. The following commands illustrate
this:

Files on MicrolRSX Systems 5-15

mru

$ COPY/OWN RAMP.TXT [MOONDOG]RAMP.TXT
$ DIRECTORY/FULL RAMP. TXT. [MOONDOG] RAMP. TXT
Directory DUO: [THEFLU]
3-MAR-85 15:50

RAMP.TXT;52
(7516.5)
[303.5] [RWED.RWED,RWED.R]
Total of 2./2. blocks in 1. file

2./2.

m.m
1-JAN-85 13:12

Directory DUO: [MOONDOG]
3-MAR-85 15:50
RAMP.TXT;2
(14343.6)
2./2.
3-MAR-85 15:49
[200.2] [RWED.RWED.RWED.R]
Total of 2./2. blocks in 1. file
Grand Total of 4./4. blocks in 2. files in 2. directories

You do not need the /OWN qualifier if you are copying a file hom
somewhere else. Normally, when you create a file, you own it. When
you copy a file to some other place, you are creating the file, so you must
override your default ownership with the /OWN qualifier.

5.6.2 Directory Protection
Because a directory is a file, it has a protection code like that of a file.
READ access is the right to list the directory, and WRITE access is the
right to create files in the directory. If you do not have EXTEND access
to a directory, you may be denied the right to create more than a certain
number of files in the directory. DELETE access means the right to delete
the directory file.
The default access for directory and file protection is the protection code
the disk was mounted with. The default for mount protection is the
protection code the volume was initialized with. See the discussion of
CREATE/DIRECTORY in Section 5.7.2 and also Chapters 6 and 13 for
more information.
The CREATE/DIRECTORY command includes a /PROTECTION qualifier
that provides a means of overriding the default system protection. This
qualifier sets the protection for the directory file itself, not for files in the
directory.
Here is an example:
$ CREATE/DIRECTORY/PROTECTION: (SYSTEM: .OWNER:RWED.GROUP: .WORLD:)
Device and UFD? DU1: [RAGBAG]

mru

5-16 Files on Micro/RSX Systems

This example creates a directory called [RAG BAG] on the volume mounted
on device DUl:. The protection code is the protection code applied to
the actual directory file DUl:[OOOOOO]RAGBAG.DIR. The protection code
specifies that the owner (the person issuing the command) has full access
to the directory and the files in it and that SYSTEM, GROUP, and WORLD
have no access. These three groups may not list the directory (no READ
privilege), nor can they create files in the directory (no WRITE or EXTEND
privilege), or delete the directory itself (no DELETE privilege). That is,
only the owner can do anything with the directory.
Remember that this command does nothing to the protection of the
individual files in the directory. If a sophisticated user knows the file
ID numbers of your files, they're still accessible. Remember also that
although you can protect your files against SYSTEM access by privileged
users, a privileged user can still issue a SET PROTECTION command and
change the protection to SYSTEM:RWED, whereupon the privileged user
has complete access.
You can display the protection of a directory file in much the same way
as any other file. The following command displays the protection for the
directory created in the previous example.
.
• DIRECTORY/FULL DU1:[OOOOOO]RAGBAG.DIR IRETI

5.6.3 Volume Protection
A disk, diskette, or tape with files in Micro/RSX format on it is called a
Files-II volume. Volume protection works in much the same way as file
protection except it affects the entire volume.
You can specify the volume protection at the time you initialize the volume
or at the time you mount it. Both the INITIALIZE command and the
MOUNT command (see Chapters 6 and 13) include a/PROTECTION
qualifier and an /OWNER qualifier for setting volume protection. In
addition, both MOUNT and INITIALIZE include a /FILEJROTECTION
qualifier that permits you to specify the protection for any new files created
on that disk volume. The INITIALIZE/UPDATE command enables you
to change the default protection on an existing volume. See Volume
2, Chapter 13 for more information.
Volume protection codes differ from file protection codes in that EXTEND
protection is called CREATE protection. The function of the code is the
same. Either EXTEND protection or CREATE protection refers to the right
to allocate space on a volume. CREATE under volume protection refers

Files on Micro/RSX Systems 5-17

to your ability to allocate space for a new file, while EXTEND under file
protection refers to your ability to allocate space within an existing file.
The default protection applied to all volumes on the system that have not
been otherwise protected is as follows:
SYSTEM:RWCD.OWNER:RWCD.GROUP:RWCD.WORLD:RWCD

(In fact, you can use a HC" in a file protection code or an HE" in a volume
protection code and the command will be accepted, but it is good practice
to use the correct protection category.)
If you need to know the protection of a volume (and the default file
protection for new files created on the volume), include the /SHOW
qualifier in your MOUNT command. See Chapter 6 for more information.

As shipped, the fixed disk uses the default volume protection and
file protection. These can be changed with the INITIALIZE/UPDATE
command. See Volume 2, Chapter 13, More About Devices and Volumes.
The odds are that no one has changed the protection on the fixed disk.
There is no simple way to display the protection of the fixed disk.

5.7 Creating Directories and Sequential Files
The CREATE command without a qualifier enables you to create a
sequential file directly at your terminal. The CREATE/DIRECTORY
command permits a user to create a directory.

5.7.1 CREATE
CREATE creates a sequential file and enables you to type text directly into
the file from your terminal without using an editor.
Format
CREATE
File? filespec

CREATE filespec
Parameter
nlespec

Specifies the name of the file to be created.
As soon as the command is entered, the cursor moves down a line.
The file is open for input. Any text you type goes into the file.

5-18 Files on Micro/RSX Systems

When you have finished entering text, press CTRL/Z to close the file.
If you want to create an empty sequential file, simply press CTRL/Z
first. See the examples.

Examples
• CREATE ~
File? COPY.CMD ~
; Command file to move files from Hank's directory to my directory ~
~
.ENABLE SUBSTITUTION ~
.LOOP: ~
.ASKS FI What file ~
COPY DU2: [HCWII] 'FI' 'FI' ~
.GOTO LOOP ~

In this example, the user wanted to move a number of files from one
directory to another. With CREATE, the user created an indirect command
file at the terminal. After entering the CREATE command and file
specification, the cursor (or print head) moves to the left margin: The
terminal is attached for input to CREATE. Note that while CREATE is
executing, the RETURN key acts only as ·a carriage return, and not as a
means of entering commands to the system. No commands are accepted
by DCL until after you press CTRL/Z (echoed as AZ).
• CREATE JOE. TXT ~
Joe called at 4:30 on Monday. He'll be back from Switzerland on~
Thursday. but he won't be in the office until Friday afternoon. RET
ICTRLjzl

•

In this example, the user used CREATE to take notes on a phone call.

• SHOW DEFAULTS ~
DUO: [POGO] TT3 :
• MOUNT/NOSHAREABLE ~
Device? DU1: ~
Label? OKEFENOKE ~
• CREATE/UFD ~
File? DU1: [ALBERT] ALLIGATOR. TXT ~
I declare a good-looking man looks good in anything. ~
I CTRLjZ I

•

In this example, the user wanted to create a file on a diskette and create
a directory to put it in. The user placed a diskette that already had some

Files on Micro/RSX Systems 5-19

files on it in diskette drive DUl: and issued the MOUNT command with
the /NOSHAREABLE qualifier. This qualifier makes the diskette private.
No one else can access it and the user who mounted it is privileged as far
as that diskette goes. The user then issued the CREATE command with
the /UFD qualifier, named a file including a directory name, and entered
text into the file, all without changing the default directory.
• CREATE CHURCHYLA. FEM IRET I

ICTRL/ZI

In this example, the user used CREATE to create an empty file for later
use. There are times when you need to have a file present, but the file
need not have any contents.

Notes
CREATE differs slightly in batch jobs.
information.

See Chapter 8 for further

If you create a file without specifying a version number and no file of
that name and type already exists, the file is version 1. If a file of that
name and type exists and you give no version number, the new file has a
version number pne higher than the highest numbered previous version.
If you specify a version number when creating the file, the system creates
a file with the version number you give.
If you use CTRL/U when creating a sequential file, the text on the line is
eliminated, but not the line itself. In other words, CTRL/U leaves a blank
line behind when it deletes a line. CTRL/U, CTRL/R (refresh the line),
and the DELETE key are the only editing facilities available to you when
creating sequential files at the terminal.

5.7.2 CREATE/DIRECTORY
CREATE/DIRECTORY creates a directory on a Files-II volume and
enters the directory into the volume's Master File Directory (MFD).
Privileged users can create directories on volumes mounted on any device.
Nonprivileged users can create directories only on volumes mounted on
their own private (allocated or nonshareable) devices.

5-20 Files on Micro/RSX Systems

Format
CREATEjDIRECTORY(jqualifier[s]]
Device and UFO? [ddnn:][[directory]]
CREATE jDIRECTORY(jqualifier[s]][ddnn:][[directory]]
Command Qualifiers
/

I"
T T ~,...." ""T~1\o.T._
l"\.LLU~l"\.llUl";ll

jLABEL:volumelabel
jNOWARNINGS
jOWNElLUIC:[uic]
jPROTECTION:(code)

Parameters
[ddnn:][[ directory]]

You must specify at least one of these parameters. If you specify
one parameter, the default volume or directory is used for the other
parameter. You cannot create a directory that matches both your
default device and your default directory.
ddnn:

Specifies the disk on which you want to create a directory.
parameter defaults to your default device.

This

The volume must be a Files-II volume mounted with the
jNOSHAREABLE qualifier (or allocated) if you are not privileged.
[directory]

Specifies the name of the directory you want to create. This parameter
defaults to the current default directory.
Directory names are from one to nine of the following characters: the
26 letters from A through Z, and the numbers from 0 through 9.
To retain compatibility with other RSX systems, MicrojRSX also accepts
numbered directory names. The format for a numbered directory is
[g,m], where g and m are octal numbers from 1 through 377.

Command Qualifiers
/ ALLOCATION:n

Specifies the number of directory entries (file names) for which space
is to be initially allocated. The value n is rounded up to the next
multiple of 32.
The default is j ALLOCATION :32.

Files on MicrojRSX Systems 5-21

/LABEL:volumelabel

Specifies that the volume label that you supply be compared with the
label on the volume. If the names match, a directory can be allocated.
If they do not match, the command is rejected.
If you do not specify this qualifier, the volume label is not checked.
/NOWARNINGS

Suppresses error messages resulting from the command.
/OWNEILUIC:[ulc]

Specifies the User Identification Code (UIC) of the directory's owner. A
UIC establishes the protection status of the directory. See Section 5.6.2
for more information. The default is for the directory to be owned by
you. You can specify any UIC as the owner. However, a nonprivileged
user cannot always create files in a directory that is owned by a UIC
different from his own.
/PROTECTlON:(code)

Specifies the protection code for the directory file, not for the files in
the directory. See Section 5.6.2 for more information.

Examples

S CREATE/DIRECTORY lRETl
Device and UFO? DU2: [JRICE] ffi[d
This example creates directory [JRICE] on the diskette volume mounted on
device DU2:. Nonprivileged users can create directories only on volumes
mounted with the jNOSHAREABLE qualifier. Privileged users can create
directories on volumes mounted on any device.

S CREATE/DIRECTORY DU2: [JRICE]ffi[d
This example is identical in effect to the previous one.
S CREATE/DIRECTORY ffi[d
Device and UFO? [BURLESON] ffi[d

This example creates directory [BURLESON] on the default device.

S CREATE/DIRECTORY ffi[d
Device and UFO? DU1: [Rill
This example creates a directory on the volume mounted on DU1: with
the same name as the default directory.

5-22 Files on MicrojRSX Systems

• DELETE/DIRECTORY [BDENT]BDENT.DIR ~

This example deletes the directory [BDENT) from the current device. All
directory files are in [000000). You must have DELETE access to the
directory file to delete it. The files in the directory are no longer accessible.

5.8 Maintaining a Directory
The following commands provide you with the means for maintaining
your directory. Disk space is an important resource, particularly on the
fixed disk. You will probably want to have only a limited number of your
most immediately useful files on line on the fixed disk. You should not
keep files that you do not need. Files that you want to save, but do not
need to have immediate access to, should be copied onto a diskette or tape
and kept off line.

5.8. 1 DIRECTORY
DIRECTORY displays information on files in directories.

Format
DIRECTORY[lformat-qual)[/destination-qual) [£ilespec[s))

Command Qualifiers
Format Qualifiers
/BRIEF
/FREE[ :ddnn:)
/FULL
/SUMMARY
Destination Qualifiers
/OUTPUT:filespec
/PRINTER

Files on Micro/RSX Systems 5-23

Other Qualifiers
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy /THROUGH:dd-mmm-yy
/TODAY
/EXCLUDE:filespec
/REWIND
Parameter
ftlespec[ s]
Specifies the file or files for which information should be displayed. If
you do not supply a file specification, a complete directory listing of
the default directory is displayed.

You can supply one or more file specifications, separated by commas.
Directory information on the files you name is displayed.
You can use wildcards in place of any file specification field except the
device field. If you do. not supply a version number, only information
on the most recent versions is displayed. However, if you do not
supply a file type, the operating system assumes the file has no type
at all, as if its file specification were something like FILE.;1. If you do
not know the file type, use a wildcard.
You can display a listing of another directory by supplying the directory
name in this field. You can also specify device names in the form
ddnn: in this field.
If you name files in more than one directory or device, you should
name files for the default directory first. If you name files from another
device or directory first, the defaults are canceled. See the examples.

Command Quallfters

Command qualifiers are in the following three groups:

1. Format qualifiers control the appearance and detail of the
directory list.

2. Destination qualifiers control where the command output
is sent.

3. Other qualifiers modify the list of files by creation date or
exclusion.

5-24 Files on Micro/RSX Systems

If you do not supply a format qualifier, the display is in
standard format, giving the file name, type, and version
number, the number of blocks the file occupies, and the date
and time of creation.
If you do not include a destination qualifier, the display
appears on your terminal.
If you do not include any of the other qualifiers, the display
includes all files that otherwise qualify.

Format Qualifiers
/BRIEF

Specifies that the display give file names, types, and version numbers
only.
/FREE [ddnn:]

Specifies that the display give the free space and number of free file
headers on the default device or a specified device.
/FULL

Specifies that the complete directory entry be displayed, including file
ID number, blocks used and allocated, the owning VIC, and protection
status of the file, in addition to all the information in the standard
display.
/SUMMARY

Specifies that the display give only the total number of blocks allocated
and used for the specified files. If you give no file specifications in the
command, the display shows the total blocks allocated and used for
the default directory.

Destination Qualifiers
These qualifiers direct output to an output file or to the line printer.
/OUTPUT:tllespec

Specifies that the output of the DIRECTORY command be placed in a
file having the file specification you supply.
/PRINTER

Specifies that the output of the DIRECTORY command be printed on
your system's line printer, if you have one.

Files on Micro/RSX Systems 5-25

Other Quallfters
/REWIND

Specifies that you want the tape to be rewound to the beginning before
listing the directory. This qualifier is for magnetic tapes only.
Examples
S DIRECTORY @ill
Directory DUO: [BLOCKHEAD]
l-MAY-85 14:16
A.A;l
1.
AZ.CMD;5
1.
BYE.CMD; 1
1.
CLEAN.CMD;l
1.
DUN.CMD;4
1.
EDT.CMD;22
1.
LOX.CMD;l
1.
LOGIN.CMD;6
1.
TI.CMD;4
1.

25-SEP-84 12:29
02-APR-86 13:03
26-SEP-84 12:29
10-JAN-86 08:29
23-JAN-85 08:06
07-NOY-84 16:66
27-APR-86 10:21
06-APR-86 16:56
30-APR-85 08:36

F.TSK;l
4.
C 26-SEP-84 12:30
G.TSK;l
4.
C 26-SEP-84 12:30
PONG.TSK;2
12.
C 25-SEP-84 12:31
BUZZ.TXT;2
4.
12-MAR-86 09:13
IZZY.TXT;l
2.
06-MAR-86 14:33
JIVE. TXT; 1
1.
16-NOY-84 13:23
Total of 2906./3043. blocks in 160. files

This example shows a directory listing in the standard format.
The device and directory are named at the head of the listing, along with
the date and the time. All files in the directory are listed because the user
did not supply any file specifications. The files shown with a C in column
3 are contiguous files, in this case, task images. You may see files in a
directory with an L in this position, signifying that the files are locked.
Files are locked when they are closed improperly. See Section 5.9.4 for
information on the UNLOCK command.

S DIRECTORY/SUMMARY @ill
Storage used/allocated for Directory DU1: [RSTONES]
l-MAY-85 14:16

5-26 Files on Micro/RSX Systems

Total of 2892./3033. blocks in 160. files

This example displays the output produced by the jSUMMARY qualifier.
If the user had supplied one or more file specifications in the command,
the summary would cover the blocks used and allocated for the specified
files only.
• DIRECTORY/FREE @[B
DU1: has 383. blocks free, 417. blocks used out of 800.
Largest contiguous space = 203. blocks
17. file headers are free, 31. headers used out of 48.

This example displays information about the default device, which is one
of the diskettes in this case. Most files need not be contiguous, so you
probably don't need that information. The display also informs you that
you cannot add more than 17 files totaling 383 blocks to the diskette. Both
of these figures are absolute limits. That is, if you add one file totalling
383 blocks, that's it, or, if you add 17 files totalling only 17 blocks, you
have reached the limit. See the description of the INITIALIZE command,
Section 6.4, for more information on the capacity of the fixed disk and
diskettes.
• DIRECTORY/FREE LBO: @[B
DUO: has 6074, blocks free, 16626. blocks used out of 21600.
Largest contiguous space = 3620. blocks
397. file headers are free, 3603. headers used out of 4000.

This example displays information about the pseudo device LBO:. Notice
that the display identifies pseudo device LBO: as being DUO:. All systems
in the RSX family run off the same pseudo device, LBO:, which can be
many different physical devices. Most MicrojRSX systems run off DUO:,
which is the fixed disk.
• DIR TI.CMD @[B
Directory DUO: [PANCHO]
1-MAY-86 14:17
TI.CMD;4
1.
30-APR-86 08:36
Total of 1./6. blocks in 1. file

This example displays information on the most recent version of the file
named because the most recent version is the default. See next example.
• DIR TI.CMD;* @[B
Directory DUO: [PANCHO]
1-MAY-86 14:17

Files on MicrojRSX Systems 5-27

TI.CND;4
1.
30-APR-85 08:36
TI. CMD; 3
1.
27-APR-85 16:32
1.
TI.CMD;2
27-APR-85 16:29
TI.CND; 1
1.
27-APR-85 16:28
Total of 4./20. blocks in 4. files

This example displays information on all versions of the file named because
the user supplied a wildcard for the version number, overriding the default
of the most recent version.
$ DIR/FULL TI.CND ~
Directory DUO: [PANCHO]
l-MAY-85 14:17
TI.CND;4
(300.56)
1./5.
30-APR-85 08:36
03-MAY-85 09:58(2.)
[303.5] [RWED.RWED.RWED.R]
Total of 1./5. blocks in 1. file

This example displays full information on the most recent version of the
file named. The number in parentheses is the file identification number
assigned by the system when the file is created. The first number is the
file number, and the second is the sequence number of the file. The UIC
is the UIC of the owner, the protection status of the file, and the final
column on the second row is the last revision date and revision level.
The revision date is the date the file was last manipulated without a new
version being created (for example, appending one file onto another). See
the notes.
Protection status is listed in the order SYSTEM, OWNER, GROUP,
WORLD. See Section 5.6 for an explanation of protection. You can change
file protection with the SET PROTECTION command; see Section 5.10.5.
$ DIRECTORY/BRIEF *.CMD IRETI
Directory DUO: [PANCHO]
ADV.DND;2
AZ.CND;5
BYE.CND;l
CLEAN. CND ; 1
DAY.CND;l
DTC.CMD;l
DUN .CND;4
EDT .CND;22
LOX.CND;l
VTILCND; 1
TI.CND;4

5-28 Files on Micro/RSX Systems

This example displays brief information on the most recent version of all
files of the type .CMD in the default directory.

S DIRECTORY/TODAY ~
Directory DUO: [PANCHO]
6-MAY-86 13:44
Day of 6-MAY-86
06-MAY-86 10:11
2061CH4.MEM;1
339.
NEWINSDC3.RNO;7
10.
06-MAY-86 10:06
06-MAY-86 10:12
2061CH4.MEM;2
320.
06-MAY-86 13:06
FUT.MAI;l
1.
06-MAY-86 09:66
NEWINSDC3.RNO;6
9.
NEWINSDC3.RNO;10
10.
06-MAY-86 10:39
NEWINSDC4.RNO;3
7.
06-MAY-86 11:46
FRK.CMD;6
1.
06-MAY-86 13:43
NEWINSDC4.RNO;4
11.
06-MAY-86 13:43
06-MAY-86 13:43
LOG.LOG;l
O.
Total of 708./736. blocks in 10. files

In this example, the user asked for a directory of all files created the same
day the command was issued. Note that the directory listing includes the
date. See the next example.

S DlRECTORY/TODAY/EXCLUDE:*.RNO;* ~
Directory DUO: [PANCHO]
6-MAY-86 13:46
*.RNO;* excluded
Day of 6-MAY-86
2061CH4.MEM;1
339.
06-MAY-86 10:11
2061CH4.MEM;2
320.
06-MAY-86 10:12
FUT.MAI;l
1.
06-MAY-86 13:06
FRK.CMD;6
1.
06-MAY-86 13:43
LOG.LOG;l
O.
06-MAY-86 13:43
Total of 672./693. blocks in 6. files
In this example, the user listed all files created the day the command
was issued but excluded all files with the .RNO file type. Note that the
file specification argument to /EXCLUDE has a wildcard version number.
Observe also that the exclusion is noted in the heading of the directory
listing.

S DIR *.TSK, [BADGE]*.TXT ~
Directory DU1: [CREAM]
20-MAY-86 09:39

Files on Micro/RSX Systems 5-29

CLOCK.TSK;3
8.
C 15-MAY-85 08:55
4.
F.TSK;l
C 25-APR-85 12:30
G.TSK;l
4.
C 25-APR-85 12:30
TICTAC.TSK;4
19.
C 01-MAY-85 12:07
TREK.TSK;l
54.
C 25-APR-85 12:31
Total of 89./89. blocks in 5. files
Directory DU1: [BADGE]
20-MAY-85 09:39
FRONT. TXT; 1
3.
16-JAN-85 11: 23
EDITNEWS.TXT;12
25.
11-MAR-85 10:50
OZY.TXT;3
2.
11-MAR-85 10:50
TEXT. TXT; 1
151.
11-MAR-85 10:50
NEW. TXT; 1
O.
L 27-APR-85 14:36
AWARE. TXT; 2
2.
27-APR-85 13:48
IZZY.TXT;10
2.
12-MAY-85 13:42
Total of 184./205. blocks in 7. files
Grand total of 273./294. blocks in 12. files in 2. directories

In this example, a user with the default directory of [CREAM] requested
directory information on files in two directories. The default directory was
applied to the first files named, the •. TSK files; these were listed first in
the display. The second set of files displayed, the •. TXT files, were from
directory [BADGE], which was explicitly specified in the command. Note
the locked file. Compare this example with the next one.

S DIR [BADGE]*.TXT, *.TSK ~
Directory DU1: [BADGE]
20-MAY-85 09:40
FRONT. TXT; 1
3.
16-JAN-85 11:23
EDITNEWS.TXT;12
25.
11-Mia-85 10:50
OZY.TXT;3
2.
11-MAR-85 10:50
TEXT. TXT; 1
151.
11-MAR-85 10:50
NEW.TXT;l
O.
L 27-APR-85 14:36
AWARE. TXT; 2
2.
27-APR-85 13:48
IZZY.TXT;10
2.
12-MAY-85 13:42
C 13-MAY-85 14:12
ADVENT.TSK;l
151.
242.
C 21-FEB-85 09:08
DUNGEON.TSK;2
12.
PONG.TSK;2
C 13-MAY-85 14:13
9.
C 08-APR-85 12:17
YCLOCK.TSK;6
102.
C 13-APR-85 09:07
STAR.TSK;2
TICTAC.TSK;5
19.
C 01-FEB-85 11:31
26.
C 06-FEB-85 15:39
VTCHS.TSK;12
9.
C 03-JAN-85 16:48
XCLOCK.TSK;6
4.
C 03-APR-85 13:28
LIFE.TSK;10
Total of 758./780. blocks in 16. files

5-30 Files on Micro/RSX Systems

The command in this example is quite similar to the command used in
the previous one, but notice the difference in results. The same user,
with default directory [CREAM], issued the command but this time the
directory [BADGE] was specified first, for the •. T5K files. Even though no
directory was specified for the •. T5K files, these files were also listed from
directory [BADGE]-not from [CREAM]. This demonstrates that specifying
a directory in a DIRECTORY command resets the default directory for the
rest of the command or until another directory is specified.
Notes

The full format for directory listings may include two dates. The first
is the creation date of the file. The second date indicates the last time
the file was revised by the system or a task for write access, such as for
editing. The decimal number in parentheses following the second date is
the number of times the file has been changed in this fashion.
Your directory is a file that you own, but which is kept in directory [000000]
on the same volume as your directory. In directory [000000] you will find
the Master File Directory (MFD), which is a file named OOOOOO.DIR. The
MFD is the directory for directory [000000]. All directories on the volume
appear in this directory in the same form. The directory file for [303005]
is called 303005.DIR; the directory file for [PANCHO] is PANCHO.DIR,
and so forth.
These directory files have file protection like all other files. The protection
is for the directory file, not for files in the directory. Because the directory
is a file, READ access is the right to list the directory, and WRITE access
is the right to create files in the directory. If you do not have EXTEND
access to a directory, you may be denied the right to create more than a
certain number of files in the directory. DELETE access means the right
to delete the directory file. Because you own your directory file, you can
usually delete it, but do not do so unless you're sure of what you are
doing.

Files on Micro/RSX Systems 5-31

5.8.2 DELETE
DELETE deletes specified files and releases the storage space the files
occupy.
Format
DELETE[/ qualifier]
File(s)? filespec[s]

DELETE[/qualifier] filespec[s]
Command Qualifiers
/EXCLUDE:filespec
/LOG
/NOWARNINGS
/QUERY
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy/THROUGH:dd-mmm-yyy
/TODAY
Parameter
fllespec[ s]

Specifies the file or files to be deleted.
You must supply the name, type, and version number fields of the file
specifications of the files you want to delete. Device and directory fields
default to your current device and directory. You can use wildcards in
any file specification field except the device field. You need not supply
a file type to delete a file with a null file type.
You can only delete files to which you have DELETE access.
To name more than one file for deletion, separate their file specifications
with commas.
Command Qualifiers
flOG

Specifies that a list of the files deleted be displayed on your terminal.

5-32 Files on Micro/RSX Systems

/QUERY

Specifies that you want to decide which files should be deleted on an
individual basis. Each file that is specified in the command is named.
You may enter one of six characters:
Y
Deletes file named and goes on to next file.
N

Does not delete file named and goes on to next
file.

(Go) Deletes the file and goes on to delete all other
files specified.

(Quit) Does not delete the file and exits the task.
No more files are deleted.

CTRL/Z

Same as Q (Quit).

RETURN

Same as N (No).

Remember that you can specify files by default or wildcard. See the
examples. If you do not specify a version number, /QUERY is the
default. See the examples.

Examples
S DELETE IRET I
File(s)? *.DAT;* IRETI

This exampl~ deletes all versions of all files of the type .DAT.

S DELETE FlLE.FIL;1. ;3 •. TXT;6 IRETI
This example deletes versions 1 and 3 of FILE.FIL, and version 5 of
FILE.TXT. Note that no file name or type is specified for version 3, and no
name for .TXT;5.
S DELETE/QUERY rEm
File(s)? *.TMP;* IBIT1
Delete file
DU1: [GOETHE]OGRE.TMP
Delete file
DU1:[GOETHE]TROLL.TMP;1
Delete file DU1:[GOETHE]ORC.TMP;1
Delete file
DU1: [GOETHE]ELF.TMP;1
Delete file DU1:[GOETHE]HOBBIT.TMP;1
Delete file
DU1: [GOETHE]SNIPE.TMP;1
The following files have been deleted:
DU1:[303.5]SNIPE.TMP;1
DU1: [303.5]SNOPE.TMP;2

[Y/N/G/Q]? Y
[y /N/G/Q]? Y
[Y/N/G/Q]? Y
[Y/N/G/Q]? N
[Y/N/G/Q]? N
[Y/N/G/Q]? G RET

Files on Micro/RSX Systems 5-33

In this example, the user specified all files having the type .TMP in the
DELETE command. Three files were deleted at the user's choice, and two
were retained. The user then directed that all remaining files with the
type.TMP be deleted. There were two more files, which were deleted and
listed.
$ DELETE *.DOC @[D
Delete file
DUO: [MABON]WITCH.DOC;2
Delete file
DUO: [MABON]DRY.DOC;4
Delete file
DUO: [MABON]PAYCHECK.DOC;l
Delete file
DUO: [MABON] LOADING. DOC; 3
Delete file
DUO: [MABON]LOADING.DOC;4
Delete file
DUO: [MABON]LOADING.DOC;5
Delete file
DUO: [MABON]LOADING.DOC;6

[Y /N/G/Q]? Y RET
[Y/N/G/Q]? N
[Y/N/G/Q]? Y
[Y/N/G/Q]? Y
[Y/N/G/Q]? Y
[Y/N/G/Q]? Y
[Y/N/G/Q]? N RET

In this example, the user specified the file type .DOC and a wildcard
for the file name. Because no version number was given, the DELETE
command defaulted to the /QVERY qualifier, enabling the user to choose
which files to delete.
$ DELETE/LOG *.LST;* @[D
The following files have been deleted:
DU1:[JIMP]RANGER.LST;1
DU1: [JIMP]TONTO.LST;1
DU1: [JIMP]REID.LST;l
DU1:[JIMP]SILVER.LST;1
DU1: [JIMP]SCOUT. LST;1
DU1:[JIMP]HORNET.LST;1
DU1: [JIMP]KATO.LST;l

In this example, the user specified all files with the type .LST in the
DELETE command and asked for a log of all files deleted.
Notes

You must have DELETE access to delete a file.
If you want to delete using wildcards, it is wise to get a directory listing

using the same file specifications you plan to delete. In this way, you can
be sure you are not deleting more files than you intend to delete.
Remember that under the default file protection on Micro/RSX systems,
you have DELETE access to your own files and all files in directories with
the same group number in the VIC.

5-34 Files on Micro/RSX Systems

See Section 5.9.3.1 for DELETE commands directed to the Queue Manager.

5.8.3 PURGE
PURGE deletes all but the latest versions of files, and releases the storage
space the deleted files occupy.

Format
PURGE[/qualifier[s]]
File(s)? filespec[s]
PURGE[/qualifier[s]] filespec[ s]

Command Qualifiers
/EXCLUDE:filespec
/KEEP:n
/[NO]LOG
/NOWARNINGS
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy/THROUGH:dd-mmm-yy
/TODAY
Parameter
ftlespec[s]

Specifies the file group or file groups to be purged.
Multiple file specifications must be separated by commas. Wildcards
can be substituted for directory, name, and type fields.
You can purge any files to which you have DELETE access.

Command Qualifiers
/KEEP:n

Specifies that the n latest versions of a file be retained. The value for
n can be any number.
If you do not use this qualifier, all versions but the most recent of

a given file are deleted. That is, the default form of the command
includes the qualifier /KEEP: 1. With the qualifier explicitly stated, all
but the n highest numbered versions are deleted. PURGE assumes
that version numbers are in numerical sequence and without missing
numbers. See the examples.

Files on Micro/RSX Systems 5-35

If more than one file specification is given with the /KEEP qualifier,
all but the latest n versions of all files listed are deleted.
/[NO]LOG

Specifies that the files deleted by PURGE be listed on your terminal.
The default is /NOLOG.

Examples
• PURGE [gIT]
File(s)? TEMPER.TSK @[D

In this example, all versions of TEMPER.TSK but the latest are deleted.
• DIRECTORY ASDIC.TM1;*. ELPASO.TEX;* @[D
DIRECTORY DB1: [303.5]
20-MAY-85 13:44
ASDIC.TM1;1
1.
20-MAY-86 13:41
ASDIC.TM1;2
1.
20-MAY-85 13:41
ASDIC.TM1;3
1.
20-MAY-85 13:41
O.
ASDIC.TM1;4
20-MAY-85 13:41
ASDIC.TM1;5
1.
20-MAY-86 13:42
ELPASO.TEX;l
20-MAY-85 13:42
1.
1.
ELPASO.TEX;2
20-MAY-85 13:42
1.
ELPASO.TEX;3
20-MAY-85 13:42
ELPASO.TEX;5
1.
20-MAY-86 13:43
1.
ELPASO.TEX;6
20-MAY-85 13:43
Total of 9./46. blocks in 10. files
• PURGE/LOG/KEEP:3 ASDIC.TM1 [gIT]
The following files have been deleted:
DB1:[303.5]ASDIC.TM1;1
DB1:[303.5]ASDIC.TM1;2

•

• PURGE/LOG/KEEP:3 ELPASO.TEX @[D
The following files have been deleted:
DB1:[303.5]ELPASO.TEX;1
DB1:[303.5]ELPASO.TEX;2
DB1: [303. 5]ELPASO.TEX; 3

•

• DIRECTORY ASDIC.TM1;*. ELPASO.TEX;* @[B
Directory DB1:[303.5]
20-MAY-85 13:46
ASDIC.TM1;3
1.
20-MAY-86 13:41
ASDIC.TM1;4
O.
20-MAY-86 13:41

5-36 Files on Micro/RSX Systems

ASDIC.TM1;6
ELPASO.TEX;6
ELPASO.TEX;6

20-MAY-86 13:42
20-MAY-86 13:43
20-MAY-86 13:43
Total of 4./20. blocks in 6. files
1.
1.
1.

In this example, the user started with two sets of five files. The five files
named ASDIC.TMI have version numbers in order. The five files named
ELPASO.TEX are numbered 1;2;3;5;6, The user issued a PURGE command
with the qualifier /KEEP:3. Versions 3, 4, and 5, of ASDIC.TMI were kept,
but only versions 5 and 6 of ELPASO.TEX were kept. This is because
the /KEEP:3 qualifier does not save the three highest numbered files,
but rather the highest numbered file and the next two lower numbered
files of the same name in numerical sequence. If there had been a file
ELPASO.TEX;4, it would have been saved. Because there was none, the
PURGE command task exited, its work done.

Note
You can purge any file to which you have DELETE access.

5.8.4 COpy
COpy copies files.
COPY creates a sequential file copy of one or more sequential fil~s, or of
records with either indexed or relative file organization.

Format
COPY[/qualifier[s]]
From? infile[s][/ qualifier]
To? outfile
COPY[/qualifier[s]] infile[s][/ qualifier] outfile
Command Qualifiers
/OWN
/REPLACE
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy /THROUGH:dd-mmm-yy
/TODAY
/EXCLUDE:filespec

Files on Micro/RSX Systems 5-37

Parameters
Inftle[s)

Specifies the input file or files to be copied.
You must have READ access to a file to copy it.
Multiple file specifications, separated by commas, are accepted. If
you specify multiple input files and a explicit output file, they will be
concatenated to the output file in the order that you specify them.
outftle

Specifies a single output file to which the input file or files are copied.
You must have WRITE access to the directory to which you want to
send a copy. Vnder the default protection, you have WRITE access to
your directory and to all directories with the same group number for
their owner's VIC. That is, a user with the VIC [303,5] can normally
copy to directories whose owners also have the group number 303,
such as [303,26].
You can change the name, type, and version number of the file when
you enter this pCl:rameter. Wildcards in the place of the name and the
type leave the name and type unchanged,
The output file can be created by COPY. The output file need not exist
when you issue the command. If a file of the same name and type
already exists, then the file you create has a version number one higher
than the highest existing version. If you specify a version number for
the output file field, then a file of that version number is created. If
such a file already exists, the operation fails unless you specify the
jREPLACE qualifier, which causes the existing file to be replaced by
the input file.
Wildcards are acceptable for output files if the destination is another
directory. If you have multiple input files and use wildcards for the
output file, you create multiple output files, each with the name and
type of the corresponding input file.
You can send copies to devices as well as to directories. See examples.
You can also use the COPY command to create multiple copies of the
same file with the same or different names.

5-38 Files on MicrojRSX Systems

Command Qualifiers
/OWN

Changes the ownership of the file being copied to the destination
directory. After execution, both directories own their respective copies.
If you do not specify IOWN, the original UIC owns both copies. This
can lead to confusion later when you try to edit or delete the file and
find that you do not have access because of conflicts in file ownership.
If you are copying from another directory to your own, use this
qualifier.
/REPLACE

If the output file has the same name, type, and version number as an
already existing file at the destination, the first file is deleted and the
file you have sent replaces it. The name, type and version number
stay as they were.

Examples
• COpy [Eill
From? [KERMIT]TSKBLD.CMD [Eill
To? TSKBLD. CMD ~

This example copies TSKBLO.CMO from [KERMIT] to the current directory
and device. The file is still owned by the original· owner, from whom it
was copied.
• COpy *. BAS DU1: [Eill

This example copies all files with the file type .BAS from the current
device and directory to the same directory on the volume mounted on
device nUl:.
• COPY/OWN TSKBLD.CMD [KERMIT]BLDFIL.CMD [Eill

This example copies TSKBLD.CMO from the current directory and device to
[KERMIT], assigns ownership to the owner of [KERMIT], and also changes
the file name to BLDFIL.CMD.
• COPY OLD1.FIL,OLD2.FIL [Eill
To? NEW. ONE [Eill

This example copies two previously existing files into one new file.
• COpy CHARLA. DMP TT4: [Eill

This example prints a copy of CHARLA.DMP on TT4:. This is a convenient
means of sending messages longer than one line. If the terminal is busy

Files on MicrolRSX Systems 5-39

at the time you send the copy, the copy is held until the terminal is clear
and then sent.
• COPY FLY.TXT SPIDER. TXT IRETI

This example creates the file SPIDER. TXT with the same contents as
FLY.TXT, both on the current device and directory.

Notes
C is the short form of copy.
COpy does not affect file organization. If you want to change file
organization, use the CONVERT command, which is explained in Volume
2, Chapter 12, More About Files on Micro/RSX Systems.
Usually, READ access is much broader than WRITE access. Under the
default protection setup, your READ access covers the whole system, but
your WRITE access is limited to other directories with the same group
number. Thus, you can copy from many places that you cannot copy to.
Also, when you copy a file, you do not copy its protection code. Your
copy has the default protection code. Use SET PROTECTION if you want
to change the protection code of the copy. See Section 5.6 for more
information on protection and Section 5.10.5 for more information on the
SET PROTECTION command.

5.8.5 RENAME
RENAME changes the name, type, or version number of an existing file.

Format
REN AME[/ qualifier[s]]
Old file name? infile
New file name? outfile
REN AME[/ qualifier[ s]] infile outfile
Command Qualifiers
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy /THROUGH:dd-mmm-yyy
/TODAY
/EXCLUDE:filespec

5-40 Files on Micro/RSX Systems

Parameters
Intlle

Specifies the file to be renamed.
You may give a wildcard for either the file name or the file type, or
both. If you use a wildcard in these fields, you must supply an entry
in the version number field. This may be a wildcard.
If you give a wildcard for version number, all versions retain their old
version numbers. If no version number is supplied, only the highest
version of the named file is renamed. It has the same version number
as the old file. If other files having the new name exist, then you
receive an error message.
outtlle

Specifies the new name for the file.
Wildcards leave that portion of the file specification the same as before.
No wildcard is needed for the version number.

Examples
• RENAME [Rill
Old file name? INTRO.TXT [Rill
New file name? APPENDIX. TXT [Rill

In this example, the most recent version of INTRO.TXT becomes
APPENDIX.TXT;1.
• RENAME IZZY.TXT;4 FIZZY.* [Rill

In this example, IZZY.TXT;4 becomes FIZZY.TXT;1.
IZZY. TXT are not affected.

Other versions of

• RENAME AMA.DOC;4 *.*;11 ~

In this example, AMA.DOC;4 becomes AMA.DOC;11.
• RENAME MAIN.T8K;* EXTRA.T8K [Rill

In this example, all files named MAIN. TSK are renamed EXTRA. TSK. The
version numbers remain the same, regardless of sequence and order of file
creation.
• RENAME MAIN.T8K;* SUB.* ~

In this example, all versions of MAIN.TSK are renamed SUB.TSK. Versions
are in the order of creation, with numbers unchanged.

Files on Micro/RSX Systems 5-41

• &EN EXHAUST. * ; * REFRESH. * [Rffi

In this example, all files named EXHAUST of whatever type are renamed
REFRESH. Their file types remain the same. Note that a wildcard is given
for the input file type. This makes an entry in the version number field
mandatory.
Notes
You cannot rename files across devices.
Using wildcards is tricky. Experiment before committing yourself.

5.9 More File-Related Commands
The commands in this section perform varied actions on your files. The
TYPE command displays files on your terminal. The PRINT command
prints files on the system line printer. The APPEND command alters
the contents of certain files. The DIFFERENCE command displays the
differences between two files. The UNLOCK command unlocks locked
files.

5.9.1 TYPE
TYPE prints selected files on your terminal.
Format
TYPE[/ qualifier[ s]]
File(s)? filespec[s]
TYPE[/ qualifier[s]] filespec[ s]
Command Qualifiers
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy /THROUGH:dd-mmm-yy
/TODAY
/EXCLUDE:filespec

5-42 Files on Micro/RSX Systems

Parameter
ftlespec[ s]

Specifies the file or files to be printed on your terminal.
You can specify any file to which you have READ access.
The file name and type must be specified explicitly or with a wildcard
( .). If no version is specified, the most recent version is printed. A
Wiidcard in any field prints every file that matches otherWise. Both
the • and the % wildcards are accepted.
You can also specify a device and directory. If you do not, these fields
default to the current device and directory.
Multiple file specifications must be separated by commas.

Examples
• TYPE [Rill
File(s)? ROMEO. TXT [Rill
Everybody loves a lover.

This example prints the file ROMEO. TXT from the current device and
directory on your terminal.
• TYPE [SHAKEY]ROMEO.TXT [Rill
A Rose by any other name might not be Pete.

This example prints the file ROMEO.TXT from the current device and
directory [SHAKEY] on your terminal.
• TYPE [*] *. FIL; * [Rill
This is the beginning of a file named ARTHUR.FIL.
It goes on for several lines.

THIS MARKS THE INITIATION OF A FILE CALLED ALBERT.FIL.
IT TOO CONTINUES AT SOME LENGTH.

Now comes a file that starts like this called Z.FIL.
And some more.

At last, we reach the beginning of a file named FILLIE.FIL.
Again some more text and then

Files on Micro/RSX Systems 5-43

The last two lines of FILLIE.FIL.
ZZZZZZZZZZZZZZZZZZZZZZZZZZZZ

•

This example prints on your terminal all versions of all files having the
type .FIL located on the current device.

Notes
In general, Micro/RSX documentation uses the term "print" to refer to any
output sent to a terminal and "type" to refer to any user input from a
terminal. The name of the TYPE command is an exception to this rule.
If you are typing multiple files, the CTRL/O feature works in a slightly
different fashion. When you enter a CTRL/O, output is descarded until you
press another CTRL/O or until the beginning of the next file is reached,
whereupon output is sent to your terminal again. This leaves you free to
use CTRL/O on a file-by-file basis.

You can type any file, but generally only ASCII text files are readable.

5.9.2 PRINT
PRINT queues files for printing on a line printer, if any. It can also be
used to queue jobs for other output devices that are serviced by the Queue
Manager.

Format
PRINT[/ qualifier[s]]
File(s)? filespec[/ qualifier[ s]][,filespec(s]]
PRINT(/qualifier[s]] filespec[/ qualifier( s]][,filespec[s]]
Command Qualifiers
/ AFTER:TOMORROW
/ AFTER:(dd-mmm-yy hh:mm)
(mm/ dd/yy hh:mm)
/COPIES:n
/DEVICE:ddnn:
/(NO]FLAGJ AGE
/FORMS:n
/JOB_COUNT:n
/[NODOBJ AGE
/LENGTH:n

5-44 Files on Micro/RSX Systems

/NAME:jobname
/PRIORITY:n
/QUEUE:queuename
File Qualifier
/COPIES:n
POiometei
ftlespec[s]

Specifies the file or files to be printed on the line printer.
Multiple file specifications must be separated by commas.
The asterisk character (*) can be used in directory, name, type,
and version number fields, but only to stand for the entire field.
Wildcarding of the form L*. TXT is not accepted by PRINT, nor is the
percent sign (%) wildcard accepted.
If your file specification includes no file type, the default file type is
.LST.

Command Qualifiers
/ AFTER:TOMORROW

Specifies that you want the job printed after midnight.
This qualifier is particularly useful in command files or batch jobs that
are run every day. If your job or command file includes a PRINT
command, the / AFTER:TOMORROW qualifier makes whatever job
you specify the first print job of the next day.
/ AFTER:(dd-mmm-yy hh:mm:[ss])
(mm/dd/yy hh:mm:[ss])

Blocks the job until after the specified time. Depending on the print
queues at that time, your job may be run immediately, or later, when
its tum comes up in the queue.
The parentheses, hyphens (or slashes), colons, and the space between
the calendar and clock fields are all necessary syntax. Note that a
space is used only between the calendar and clock fields. The space is
not necessary if either field is omitted.

Files on Micro/RSX Systems 5-45

You can specify the calendar field in either of the following two
formats:
dd-mmm-yy Uses a 1- or 2-digit number for the day, the first 3 letters
for the month, and 3 numbers for the year.
mm/dd/yy

Uses a 1- or 2-digit number for the month, a 1- or
2-digit number for the day, and 2 numbers for the year.

If you leave out the calendar field, the day defaults to the current date.

The argument yy must be between 77 and 92. If you leave it out, the
year defaults to the current year.
The argument hh:mm:ss is the hour, minute, and second.
If you leave out the clock field, the time defaults to 00:00:00 on the
given date.

The argument ss need not be given because it defaults to 00. In fact,
the field is not actually used; if you do specify this argument, it is
checked for syntax only. The Queue Manager always takes a few
seconds to start the job.
Specifying a .time using I AFTER is equivalent to issuing a PRINT
command at that time. The job may still have to wait in its queue to
be printed.
/COPIES:n

Specifies the number of copies to be printed. The default is ICOPIES:l.
If your PRINT command includes this qualifier and specifies more than
one file, the resulting QMG print job consists of the specified number
of copies of the first file named, followed by that many copies of the
second file, and so on. If you want to print multiple copies of files by
sets, use the IIOB_COUNT qualifier. See the examples.
The ICOPIES:n qualifier to the file specification can be used to override
this qualifier for a given file in a list of file specifications.
/DEVICE:ddnn:

The IDEVICE qualifier specifies that you want the file printed on a
particular device.
/[NO ]FlAG_PAGE

Adds flag pages to each file in your print job. With IFLAGJ AGE,
the number of flag pages is equal to the number of job flag pages that
precede the job.

5-46 Files on MicrolRSX Systems

With /NOFLAGJ AGE (the default), your job is still preceded by a
job flag page, but the files in the job are printed without any file flag
page, separated only by form feeds. You can suppress the job flag
page with the /NOJOBJAGE qualifier. Figures 5-2 and 5-3 show
the difference between the job flag page and the file flag page.
/FORMS:n

Specifies the type of form on which the job must be printed. 1 ne
argument n can have a value from 0 through 256. The default is O.
See your system manager for details on how to specify the particular
forms used at your installation.
/ JOB_COUNT:n

Specifies the number of sets of files you want printed. The default is
/JOB_COUNT: 1. If your PRINT command includes this qualifier and
specifies more than one file, the resulting QMG print job consists of
a set consisting of the files named in order, followed by another set,
and so on. If you want to print multiple copies of one or more files,
but not in sets, use the /COPIES qualifier. See examples.
/[NO]JOB_PAGE

Specifies whether you want a job flag page printed at the beginning of
the QMG print job. The default is /JOBJ AGE. Use /NOJOBJ AGE
when you are printing on special forms, or for some other reason
do not want to include a job flag page. See the /[NO]FLAGJAGE
qualifier for controlling file flag pages. Figure 5-2 and 5-3 show the
difference between job flag pages and file flag pages.
/LENGTH:n

Sets the length of a logical page; n can be any number from 0 through
255. The default is n=O. If you set a length, a form feed is automatically
generated if one is not found within n lines. If your line printer has
perforations for 66-line pages, it will not print on the perforations in
the paper if you set /LENGTH:60.
When you set the length at 0, the default, the logical page length is
unlimited.
This qualifier has no effect on how the printer handles form-feed
characters. A form feed still moves the printer to the top of the next
physical form, such as the perforation in a sheet of line printer paper.
This qualifier simply adds the requirement that the printer move to the
top of the next physical page if no form-feed character is encountered
within n lines. See the example using /LENGTH.

Files on Micro/RSX Systems 5-47

/NAME:jobname

Specifies a name for the print job.
alphanumeric characters.

Your job name can be nine

If you specify a job name, that name appears on the flag page at the
beginning of the printed output. Otherwise, the file name of the first
file is used as the job name.

The job name also appears in the SHOW QUEUE display. The job
name includes the UIC under which it was entered.
There can be more than one job of the same name, but each job has
a unique entry number which appears in the SHOW QUEUE display.
/PRIORITY:n

Sets the queue priority of the print job. For nonprivileged users, n can
be from 0 through 150. Privileged users can set n up through 250.
The default is 50.
The Queue Manager prints the highest priority jobs first. When two
jobs have the same priority, the job that has been in the queue longest
is printed first.
/QUEUE :queuename

Specifies the name of the print queue in which the job is to be placed.
The default is the PRINT queue.
File Qualifier

File qualifiers override the corresponding command qualifier when you
have given multiple file specifications as parameters to the PRINT
command. See the examples. See Volume 2, Chapter 12 for several
more file qualifiers to the PRINT command.
/COPIES:n

Overrides the /COPIES command qualifier when attached to a
particular file specification.
Examples
$ PRINT l@il
File(s)? PASHA.CMD ~
PRI -- Job 305, name "PASHA

", submitted to queue "PRINT"

This example prints the most recent version of PASHA.CMD from the
default device and directory on the line printer. The Queue Manager
returns a message confirming that the job has been submitted and assigned

5-48 Files on Micro/RSX Systems

Figure 5-2:
M cro/RSX
M cro/RSX
M cTo/RSX
M cro/RSX

SSSS Y
y

S
S
SSS
S
S
SSSS

y y
Y
Y
Y
Y

V3.0
V3.0
V3.0
V3.0

[1,10]LOGIN
- NO PAGE LIMIT
FORM .0 - NORMAL HARDWARE FORMS
NO IMPLIED FORM FEED
JOB CONTAINS ONE FILE

15-APR-85
15-APR-85
15-APR-85

15-APR-8~

17 07 43
17 07 43
17 07 43
17 07 43

15-APR-85
15-APR-85
15-APR-85
15-APR-85

17 07 43
17 07 43
17 07 43
17 07 43

M GGGG RRRR
Y SSSS M
y S
R
HH MH G
R
R
MMMG
R
RRRR
M MG
S M M G GGG R R
G R R
S M MG
R
SSSS M M GGG R
S
SSS

GGGG
000
L
0
L
0 G
0 G
0
L
0
L
0 G
0 G GGG
L
0
0 G
L
0
G
LLLLL 000
GGG

M cro/RSX
M cro/RSX
M cro/RSX
M cro/RSX

Job Flag Page

V3.0
V3.0
V3.0
V3.0

III
I
I
I
I
I
III

N
N

N
N
N
N N N
N NN
N
N
N
N
NN

[1,10]LOGIN
- NO PAGE LIMIT
FORM .0 - NORMAL HARDWARE FORMS
NO IMPLIED FORM FEED
JOB CONTAINS ONE FILE

ZK-4072-85

Files on Micro/RSX Systems 5-49

Figure 5-3:

File Flag Page

V3.0
V3.0
V3.0

M cro/RSX
t1 cro/RSX
M cro/RSX

DUO:[1,2)LOGIN.TXT;1
COPY 1 OF 1
DELETION NOT SPECIFIED

GGGG
G
G
G
G GGG
G
G
GGG

III
I
I
I
I
I
III

N
N
NN N
N
N
N
N NN
N
N
N
N

TTTTT X
X TTTTT
X
X
T
T
T
T
X X
T
X
T
T
T
X X
X
T
T
X
X
T
T
X

,,
,,

L
L
L
L
L
L
LLLLL

000
0
0
0
0
0

0
0
0

0
0
000

M c:ro/RSX
M cro/RSX
M cro/RSX

V3.0
V3.0
V3.0

15-APR-85
15-APR-85
15-APR-85

17:07:48
17:07:48
17:07:48

15-APR-85
15-APR-85
15-APR-85

17:07:48
17:07:48
17:07:48

N
N

1
1
1
1
1
111

DUD:[1,2)LOGIN.TXT;1
COpy 1 OF 1
DELETION NOT SPECIFIED

ZK-4073-85

5-50 Files on Micro/RSX Systems

an entry number. You can use this entry number in QMG commands. See
the next section.
• PRINT/COPIES:20 ~
F11e(8)? PASHA.CMD
PRI -- Job 706. name "PASHA

rnm

". 8ubmitted to queue "PRINT"

This example prints 20 copies of PASHA.CMD. They are printed end-toend with no flag page except at the beginning.
• PRI/COP:20/FLAG_PAGE PASHA.CMD ~
PRI -- Job 321. name "PASHA
". 8ubmitted to queue "PRINT"

This example prints 20 copies of PASHA.CMD, each with a flag page.
• PRIN/COPIES:2 DAVID. TXT. DAN.TXT ~
PRI -- Job 18. name "DAVID
". 8ubmitted to queue "PRINT ..

This example prints two copies of DAVID.TXT followed by two copies of
DAN.TXT. It does not print two sets of one copy of each file. If you want
to print sets of files, see the next example.
• PRINT/JOB_COUNT:2 DAVID. TXT. DAN.TXT ~
PRI -- JOB 311. NAME "DAVID
". 8ubmitted to queue "PRINT"

This example prints a set consisting of a copy of DAVID.TXT followed by
a copy of DAN.TXT, and then prints another set of DAVID.TXT followed
by DAN.TXT.
• PRl/FLAG PASHA.CMD. RAJAH.CMD. SHEIK.CMD IRETI
PRI -- Job 999. name "PASHA ". 8ubmitted to queue "PRINT"

This example prints one copy of each file, each with its own flag page.
• PRI/NAME:ARABY/FLAG PASHA.CMD. RAJAH.CMD. SHEIK.CMD ~
PRI -- JOB 806. NAME "ARABY". 8ubmitted to queue "PRINT"

This example prints one copy of each file, each with its own flag page, and
gives the name ARABY to the job as a whole. The name ARABY appears
in the print queue and at the head of the entire printed output.
• PRINT/LENGTH:60 GLADRAG.MAC IRETI
PRI -- Job 22. name "GLADRAG ". 8ubmitted to queue "PRINT ..

This example prints a single copy of the file GLADRAG.MAC. This is a
source program file without form-feed characters in it. The user wants
to print it on line-printer paper, a physical form 66 lines long. To avoid
printing over the perforations, the user has specified a logical length of 60

Files on Micro/RSX Systems 5-51

lines. Each time 60 lines have been printed, the logical page is complete
and the printer moves to the top of the next physical page.
If the file has form feeds in it, the printer moves to the top of a physical
page each time it encounters a form feed and each time it prints 60 lines
without encountering a form feed.

S PRI/COPIES:20 MOB.COR. RIFF.COR. RAB.COR/COP:19. PRO.COR ~
PRI -- Job 77. name "MOB

", submitted to queue "PRINT"

This example prints 20 copies each of MOB. COR and RIFF.COR, 19 copies
of RAB.COR, and then 20 copies of PRO.COR.

S PRI/AFTER:(4-JUL-84 13:13) CONST.CON ~
PRI -- Job 809, name "CaNST

", submitted to queue "PRINT"

This example blocks the job in its queue until the specified date and time.
The file itself remains in its directory. Deleting the file from its directory
does not take it out of the queue, but does prevent it from being printed.

S PRI/AFTER:(17:00) GUNGA.DIN IRETI
PRI -- Job 766, name "GUNG!

". submitted to queue "PRINT"

This example prints the file after 5 p.m. on the day the command is
entered. If the command is entered after the specified time, the file is
printed immediately.

Notes
P is the short form of PRINT.
The PRINT command does not accept the percent (%) wildcard. The
asterisk (.) wildcard can only be used to substitute for a complete part of
the file specification and not for part of a file name or file type as most of
the file-related commands do.
For more information on the PRINT command, see Volume 2, Chapter 12.
There are several additional qualifiers to PRINT described there.
See the next section for a description of the SHOW QUEUE command,
which displays information about print jobs in queues.
PRINT is to print jobs as SUBMIT is to batch jobs.
Once your job is in a queue, you can modify some job attributes with SET
QUEUE. See the next section.
The Queue Manager automatically deletes .PMT and .DMP files after they
are printed.

5-52 Files on Micro/RSX Systems

The flag pages and the job pages have different formats for the banner
text. The job name page shows the UIC the PRINT command was issued
under on the first line and a 9-character job name (derived from an explicit
job name or the file name of the first file in the job) on the second line.
The flag page shows the full 9-character file name on the first line and the
file type and version number on the second line. See Figures 5-2 and 5-3.
Entry numbers run from 1 through 999 and are unique. Various QtvfG
commands permit you to identify your job either by this number or by job
name. The job name includes your UIC. See the next section and also the
expanded material in Volume 2, Chapter 12.

5.9.3 Queue Manager Commands
The PRINT command sends jobs to the line printer by way of the Queue
Manager (QMG). The Queue Manager is a system task that also distributes
jobs for batch processing. Passing jobs to the Queue Manager is called
queuing jobs."
II

The Queue Manager distributes print jobs queued by user tasks, by system
tasks that output listings such as MACRO listings or task builder maps,
and jobs queued by the PRINT command.
Once jobs are in queues, you can display queue information with the
SHOW QUEUE command. You can alter the status of jobs in queues with
the SET QUEUE command. You can hold jobs in queues with the HOLD
/ENTRY command, release them from queues with the RELEASE/ENTRY
command, or delete jobs in queues with the DELETE/ENTRY command.
Once you have issued a PRINT command, you may want to alter the way
that file is processed or you may decide that you did not want to process
that file at all. This section explains how to make these changes.
For example, you issue the following PRINT command to queue the file
ANTRIM. TST to the line printer:
• PRINT ANTRIM. TST mill
PRI - Job 22. name "ANTRIM

". submitted to queue "PRINT"

However, you did not want to print that file. The file you wanted to
print is ANTRIM.TXT. To prevent ANTRIM.TST from printing, you must
remove that file from the queue. To do this, you use the SHOW QUEUE
command and either the DELETE/ENTRY command or the STOP/ABORT
command depending upon the status of your job.

Files on Micro/RSX Systems 5-53

The SHOW QUEUE command shows you the position of your job on
the queue (as well as that of other jobs) and whether or not your job is
currently being processed. The following example explains about SHOW
QUEUE and the output it gives:
• SHOW QUEUE ffiill
** PRINT QUEUES **
PRINT => LPO
[303,3]
ANTRIM
ENTRY:22
>
1 DUO: [MARK]ANTRIM.TST;1
LPO
=> LPO
** BATCH QUEUES **
BATCH => BPAO

ACTIVE ON LPO

ANTRIM.TST is entry number 22 in the PRINT queue. The Queue Manager
assigns an entry number to each job as a means for keeping track of which
jobs are processed when. Usually, this is done on a first-come, first-serve
basis. Also, note that ANTRIM.TST is currently being printed on line
printer LPO: as shown in the third line of the display. To stop your
currently printing job, you have to issue the STOP/ABORT command.
This command stops your job on the line printer immediately.
Use the STOP/ABORT command in the following manner:
• STOP/ABORT LPO:

•

ffiill

When the dollar sign prompt ($ ) returns, your job has stopped printing.

If your job has not started printing, issue the SHOW QUEUE command
as in the previous example. This time, the output this command gives is
slightly different from before, notably, the ACTIVE ON LPO is missing.
For example:
• SHOW QUEUE IRET I
** PRINT QUEUES **
PRINT => LPO
[303,3]
ANTRIM
ENTRY: 22
1 DUO: [MARK]ANTRIM.TST;1
LPO
=> LPO
** BATCH QUEUES **
BATCH => BPAO

To delete this job from the PRINT queue, you use the DELETE/ENTRY
command and the job's entry number (described in the previous example)
as follows:
• DELETE/ENTRY: 22 ffiill

•

5-54 Files on Micro/RSX Systems

Your job has been removed from the PRINT queue and will not be printed.
Once ANTRIM.TST is removed from the PRINT queue, reissue the PRINT
command with ANTRIM. TXT as the file you want processed.
The following sections detail the various commands that use the QMG,
their qualifiers, and examples on how the commands are used.

5.9.3.1 DELETE/ENTRY
The DELETE/ENTRY command deletes jobs from a queue or files from a
job by specifying the job's entry number.

Format
DELETE/ENTRY:nnn[/FILEJOSITION :n]
Command Qualifiers
/ENTRY:nnn

Deletes a queue entry by number. This number is always unique.
/FILE_POSITION:n

Identifies the file by the file's position in the job.

Examples
• DELETE/ENTRY: 301 lEm

This command deletes the job from queue by referencing the job's unique
entry number (in this example, job number 301) .
• DELETE/ENTRY:301/FILE_POSITION:2 lEm

This example deletes only the second file appearing in job 301. You
may only refer to the file you want to delete by the file's position in the
print job (the numbered order in which you entered the file specification).
You cannot specify the file you want to delete by referring to its file
specification.

Note
You see the entry number for a job when you issue the PRINT command.
You can also find the entry number, and the file position for files in the
job, with the SHOW QUEUE command.

Files on Micro/RSX Systems 5-55

5.9.3.2 SHOW QUEUE and SHOW PROCESSOR

Use the commands described in this section to display information about
queues, the jobs in the queues, and spooled devices.
An unadorned SHOW QUEUE command lists all jobs in all queues.
Qualifiers can be used to limit the display to specific queues, specific
jobs, and the like.
You may examine the contents of your system's queues (in decreasing
degree of detail) by entering one of the following command qualifiers:
/FULL
/FILES
/BRIEF
5.9.3.3 SHOW QUEUE

SHOW QUEUE displays information about QMG print jobs.

Format
SHOW QUEUE [queuename][/qualifier[s]]
Command Qualifiers
/BRIEF
/DEVICE
/ENTRY:nnn
/FILES
/FORMS[:n]
/FULL
/OWNElLUIC:uic
/PRINT

Parameter
queuename
Displays QMG information for a single queue, either print or batch.
The main print queue is called PRINT. Other print queues have names
determined by the system manager.

Command Qualifiers
/BRIEF
Displays only queues, queue assignments, and jobs in queues.

You may examine specific attributes of queues by entering one of the
following qualifiers.

5-56 Files on Micro/RSX Systems

/DEVICE

limits information to print queues.
/ENTRY:nnn

limits information to a particular job entry referenced by the job's
unique entry number.
/FILES

Displays information about queues, queue assignments, jobs in queues,
and files that compose jobs in queues. The attributes of the jobs are
not displayed. This display format is the default of SHOW QUEUE.
/FORMS[:n]

Limits information to jobs that are to be printed on a specified form.
If the argument n is omitted, the display shows all jobs that are other
than Form O.
/FULL

Displays detailed information about queues, queue assignments, jobs,
the attributes of jobs in queues, and files that compose jobs in queues.
/OWNEILUIC:ulc

limits information to jobs owned by the specified uic.
/PRINT

limits "information to Print queues. This qualifier produces the same
information as the /DEVICE qualifier.

Examples
The following examples show the three different output displays (FULL,
FILE, BRIEF).
• SHOW QUEUE/FULL [EITJ

** PRINT QUEUES **
PRINT => LPO
[7.26] MARK
ENTRY: 22
FORM: 0
ACTIVE ON LPO
PRI:60 LEN:O PAGE:O NORESTART FLAG:JOB NOLOWER COP:1
> 1 DUO: [GREGG]MARK.LST;1
COP:1
NODELETE
[7.40] ANITA
ENTRY: 24
FORM: 0
PRI:60 LEN:O PAGE:O NORESTART FLAG:JOB NOLOWER COP:1
1 DUO: [LAKE]ANITA.MEM;12
COP:1
NODELETE
LPO
=> LPO
** BATCH QUEUES **
BATCH => BAPO

•

Files on Micro/RSX Systems 5-57

This display shows all information about the queues and jobs in queues.
In this example, the queue PRINT sends jobs to LPO:.
There are two print jobs in the queue PRINT:
•

[7,2S]MARK, entry number 22, which is currently being printed on
LPO:

•

[7,40]ANITA, entry number 24, which is waiting to be printed

The attributes of the job are indicated in the display, and the files that
make up each job are also listed. The angle bracket (> ) indicates which
file of a job is currently being processed.
S SHOW QUEUE/FILE @TI]
** PRINT QUEUES **
PRINT => LPO
[7.25] MARK
ENTRY: 22
> 1 DUO: [GREGG]MARK.LST;l
[7.40] ANITA
ENTRY: 24
1 DUO: [LAKE]ANITA.MEM;12
LPO
=> LPO
** BATCH QUEUES **
BATCH => BAPO

ACTIVE ON LPO

This display, the default format, shows the queues in the same state. It
does not show the attributes of the job. It only shows the form number of
the job and the attributes of the files if other than the default values were
specified. Because /FILE is the default, you need not specify it.
S SHOW QUEUE/BRIEF @TI]

** PRINT QUEUES **
PRINT => LPO
[7.25] MARK
ENTRY: 22
[7.40] ANITA
ENTRY:24
LPO
=> LPO
** BATCH QUEUES **
BATCH => BAPO

ACTIVE ON LPO

This display only shows the names, entry numbers, and status of the jobs
in the queues. Also, if a form other than Form 0 is specified for a print
job, the form will appear in the display.

5-58 Files on Micro/RSX Systems

5.9.3.4 SHOW PROCESSOR
SHOW PROCESSOR displays information about the initialized characteristics of spooled devices and batch processors, printers, and other output
devices under control of the Queue Manager.

Format
SHOW PROCESSOR [processomame]
Displays information about all processors.
SHOW PROCESSOR/PRINT or SHOW PROCESSOR/DEVICE
Shows all print processors.

Example
Enter the following command on your terminal:
• SHOW PROCESSOR IRET I

Information about print processors, batch processors, and spooled input
devices will be displayed at your terminal:

** SPOOLED DEVICES **

LPO

<= PRINT LPO

LOWER
FORM:O FLAG: 2
CURRENT JOB: [CRAZED]FUP
** BATCH PROCESSORS **
BAPO <= BATCH

ENTRY: 69

This display shows all information about spooled devices and batch
processors. In this example, spooled device LPO: can receive jobs from
queues PRINT and LPO:.
The only batch processor, BAPO, can receive jobs only from the queue
BATCH.
LPO: is currently printing job [CRAZED]FUP, entry number 59.

Files on Micro/RSX Systems 5-59

5.9.3.5 SET QUEUE
SET QUEUE modifies attributes given to either print jobs, or files that
compose jobs in queues. Such jobs and files have been entered in queues
by the PRINT command. You cannot change the attributes of an active
job.

Format
SET QUEUE/ENTRY:nnn/qualifier[jqualifier[s]]
Command Qualifiers
/ AFTER:(dd-mmm-yy hh:mm)
/FORMS:n
/JOB_COUNT:n
/LENGTH:n
/PRIORITY:n

File Format
SET QUEUE/ENTRY:nnn/FILE-POSITION:n/qualifier[jqualifier[s]]
File Qualifiers
/COPIES:n

Command Qualifiers
/ AFTER:(dd-mmm-yy hh:mm)

Changes the time after which your job will be printed. The job will
be BLOCKED until the time and date you specify. The job will not
necessarily be printed at exactly the time you state but will be eligible
after the time you state.
If you do not supply the calendar field, the default is the current date.
If you do not supply the clock field, the default is midnight on the
date given in the calendar field.
If you supply both the clock and calendar fields, you must separate
them with a space.
/FORMS:n
Changes the FORMS attribute of your print job. See Section 5.9.2 for
an explanation of the /FORMS qualifier to the PRINT command.

5-60 Files on Micro/RSX Systems

/JOB_COUNT:n

Changes the number of copies of a job you want to have printed.
See File Qualifiers for an explanation of how to modify the number
of copies of a file contained inside of a job. See Section 5.9.2 for an
explanation of the /COPIES qualifier to the PRINT command.
/LENGTH:n

Changes the length of a logical page (number of lines per printed page)
of your print job. A line printer will move to the top of a physical
page every time n lines have been printed on a page or a form feed is
encountered. See Section 5.9.2 for an explanation of the /LENGTH
qualifier to the PRINT command.
/PRIORITY:n

Changes the queue priority of a print job. Nonprivileged users may
set priorities up through 150. Privileged users may set priorities up
through 250. See Section 5.9.2 for an explanation of the /PRIORITY
qualifier to the PRINT command.

File Quallfters
/FILE_POSITION:n

Changes the operation of /COPIES:n or /[NO]DELETE as they apply
to a file contained in a job in queue. The number n refers to the file
position in the job. Use SHOW QUEUE to determine its position.
/COPIES:n

Changes the number of copies of a file you want to have printed
within a single printing of a print job.

Examples
• PRINT/JOB_COUNT:2 JILL.TXT.JOHN.TXT/COPIES:3 IRETI

The SHOW QUEUE/FULL command output might look like this:

** PRINT QUEUES **
PRINT => (LPO)
[304.1]
JILL ENTRY:696
FORM: 0
PRI:50 LEN:O PAGE:O NORESTART FLAG:JOB NOLOWER COP:2
1 DU1: [DICK] JILL. TXT; 1
COP:1
NODELETE
2 DU1:[DICK]JOHN.TXT;1
COP:3
NODELETE
LPO => LPO
To print two copies of the file JOHN.TXT instead of the three copies
specified in the initial print command, you would type the following SET
QUEUE command on your terminal and enter it:

Files on Micro/RSX Systems 5-61

• SET QUEUE/ENTRY:696/FILE_POSITION:2/CO:2 @[U

The SHOW QUEUE/FULL command output on your terminal then would
look like this:

** PRINT QUEUES **
PRINT => (LPO)
[304.1]
JILL ENTRY: 696
FORM:O
PRI:50 LEN:O PAGE:O NORESTART FLAG:JOB NOLOWER COP:2
1 DU1: [DICK] JILL. TXT; 1
COP:1
NODELETE
2 DU1: [DICK] JOHN.TXT;1
COP:2
NODELETE
LPO
=> LPO
Note that the file in position 2, JOHN.TXT, will have two copies instead
of three printed.

Notes
When you issue the PRINT command, you specify attributes of the QMG
job through command qualifiers. SET QUEUE command qualifiers change
the matching attributes.
You cannot change the attributes of an active job.
You can delete files or change the number of copies to be printed by
specifying /FILEJOSITION:n in your SET QUEUE command line.

5.9.3.6 STOP/ABORT
The STOP/ABORT command stops the current job on a line printer
immediately. Privileged users can stop any job. Nonprivileged users
can stop their own jobs.

Format
STOP / ABORT printer
Parameter
printer

Specifies the line printer whose active job you want to stop.

Example
• STOP/ABORT LPO: @[U

•

This command stops the currently active print job on LPO:. This job i~
deleted from the queue and the next eligible job is queued.

5-62 Files on Micro/RSX Systems

Note
As soon as the active job is deleted, QMG passes the next eligible job
to the processor. The processor has not been aborted or killed, only the
active job on that processor.

5.9.3.7 HOLD/ENTRY and RELEASE/ENTRY
You can specify that a print job be HELD in a queue when you issue the
PRINT command, or you can hold it with the HOLD command.
You can release such jobs with the RELEASE command.
Note that when a system crashes, the Queue Manager automatically holds
those jobs in the queues so that the jobs are not lost. However, when the
system is restored, you must release those held jobs with the RELEASE
command.

Format
HOLD /ENTRY:nnn
Blocks a job in its queue until it is explicitly released.
RELEASE/ENTRY:nnn
Unblocks a job that has been held in queue.

Examples
• PRINT/HOLD/NAME:MARY MUSE. TXT IRETI

The SHOW QUEUE/FULL command output might look like this:

** PRINT QUEUES **
PRINT => LPO
[231.66]
MARY ENTRY: 20
FORM:O
HELD
PRI:60 LEN:O PAGE:O NORESTART FLAG:JOB NOLOWER COP:1
1 DU1:[AMUSED]MUSE.TXT;1
COP:1
NODELETE
LPO
=> LPO
To unblock MUSE.TXT, you would type the following RELEASE command
on your terminal:
• RELEASE/ENTRY: 20 !Bill

The SHOW QUEUE/FULL command output would look like this:

** PRINT QUEUES **
PRINT => LPO
[231.66]
MARY ENTRY: 20

FORM:O

ACTIVE ON LPO

Files on Micro/RSX Systems 5-63

PRI:60 LEN:O PAGE:O NORESTART FLAG:JOB
> 1 OU1: [AMUSED] MUSE. TXT; 1
COP:1
=> LPO

LPO

NOLOWER COP:1
NOOELETE

Note
The HELD status of the job in the previous example was first changed to
WAITING, and then, since there were no jobs in queue, became ACTIVE.

5.9.4 UNLOCK
UNLOCK unlocks locked files. Locked files are files that have been
improperly closed because a task aborted or stopped execution while the
file was open. Locked files are identified by an L in the directory listing.

Format
UNLOCK[/ qualifier[s]]
File(s)? filespec[s]
UNLOCK[j qualifier[s]] filespec[ s]

Command Qualifiers
/DATE:dd-mmm-yy
/SINCE:dd-mmm-yy
/THROUGH:dd-mmm-yy
/SINCE:dd-mmm-yy /THROUGH:dd-mmm-yy
/TODAY
/EXCLUDE:filespec
Parameter
filespec

Identifies the locked file(s) that you want to unlock.

Example
• Directory TOPEKA.KAN ~
Directory OBO:[303.6]
29-MAY-86 13:13
TOPEKA.KAN;3
32.
26-MAY-86 12:29
L
Total of 32./40. blocks in 1. files

••

• UNLOCK TOPEKA. KAN ~

5-64 Files on Micro/RSX Systems

••

• DIRECTORY TOPEKA.KAN ~
Directory DBO: [303.6]
29-MAY-86 13:14
26-MAY-86 12:29
TOPEKA.KAN;3
32.
Total of 32./40. blocks in 1. files

In this example, the user found a locked file, perhaps through an error
message stating that the file could not be opened. The locked state is
indicated by the L in the third column of the directory listing. After the
user issues the UNLOCK command, the file is no longer locked.

Notes
In many cases, a locked file has no contents because the task that opened
the file aborted before writing to the file. In this case, you do not need to
unlock the file before deleting it.
Another common case of file locking is a data file that has been opened
by some task that aborted or exit~d without closing the file. In this case,
you have to unlock the data file before running the task again. If the file
is written to by the task, it may have been corrupted.

5. 10 SET and SHOW
You can type SET commands to establish your default device, directory,
and User Identification Code, and SHOW commands to display what these
defaults are. You can change the protection code for any existing file
in your directory with the SET PROTECTION command. In addition,
you can establish your own default file protection code with SET
PROTECTION/DEFAULT and use SHOW PROTECTION to display the
default protection.
See Section 5.9.3 for SET and SHOW commands for the Queue Manager.

Files on Micro/RSX Systems 5-65

5.10.1 SET DEFAULT
SET DEFAULT changes where the operating system looks for information
from your current device and directory to those indicated in the command.
SET DEFAULT establishes your default device or directory, or both. That
is, when you do not indicate a device or a directory in a file specification
or command, the operating system supplies these defaults.
The protection codes for the directory and its files control your activity in
the directory. If you are a nonprivileged user, you have the directory and
file access rights of the WORLD category, and-depending upon your User
Identification Code (UIC)-the GROUP category. If you are a privileged
user, you have the access rights of the SYSTEM category. Of course, if
your UIC matches the directory owner's, then you have the privileges of
the OWNER category.
Note that a privileged user can change his UIC with the SET UIC command.
If you intend to create or alter files in a directory other than your own, it
is good practice to change your UIC to match the directory owner's. See
Section 5.10.3.
SET DEFAULT works differently if you previously set your terminal's
default to /NONAMED_DIRECTORY. See Volume 2, Chapter 12 for more
information.

Format
SET DEFAULT[/qualifier] [default]]
Command Qualifier
/[NO]NAMED_DIRECTORY

Parameters
default

Specifies a device and/or directory or logical name to be used as the
default device or directory in file specifications.
If you specify a physical device name, terminate the device name with
a colon.
If you specify a directory name, you must enclose it in the square
brackets. (Note that if your terminal's default is /NONAMED_
DIRECTORY, the directory field accepts only numbered directories
in the form [g,m].)

5-66 Files on Micro/RSX Systems

If you specify a logical name, the logical name must translate to an
existing physical device and/or directory. If the logical name is to
translate to a physical device, be sure that when you make the logical
name assignment, you terminate the physical device name with a
colon. When you issue the SHOW DEFAULT command, the system
displays the actual physical device, not the logical name.

Command Quallfter
/[NO]NAMED_DIRECTORY

SET DEFAULT/NAMED_DIRECTORY is the default on Micro/RSX.
This command allows SET DEFAULT to accept either named or
numbered directories. The format for a named directory is [directory],
where directory is one to nine of the following characters: the 26 letters
from A through Z, and the numbers from 0 through 9. Examples of
named directories include [MAG], [DIDDLYBOP], and [lPOTAT02].
The format for a numbered directory is [g,m], where g and m are octal
numbers from 1 through 377. Examples of numbered directories are
[100,2] and [202,10].
If you issue SET DEFAULT/NONAMED_DIRECTORY, you can
only specify numbered directories in the SET DEFAULT command.
Operating with /NONAMED_DIRECTORY has some subtle side
effects. Its use is recommended only for experienced users of other
systems in the RSX family who need to maintain compatibility with
older versions.

Some application programs do not recognize named directories. See
Volume 2, Chapter 12 for some suggested solutions to this problem.
Examples
•

SET DEFAULT DU1: [GRAMPUS]

[EIT]

This example sets DU1: as the default device and [GRAMPUS] as the
default directory. All subsequent commands default to this device and
directory unless you explicitly state otherwise.
[Bill
[Bill

•

SET DEF DU1:

•

ASSIGN DU1: SY:

The two commands in this example are equivalent. In each case, the
default device becomes DU1:. When you set the default device, SET
DEFAULT actually assigns SY as a logical name for the device you want.
SY is the logical device name that represents your default device.

Files on Micro/RSX Systems 5-67

5.10.2 SHOW DEFAULT
SHOW DEFAULT displays the current default device and directory for
your terminal. It also shows whether you are operating with /NAMED_
DIRECTORY or /NONAMED_DIRECTORY as your default, and your
User Identification Code (UIC).

Format
SHOW DEFAULT
Example
• SHOW DEFAULT ~
DU1:[HUSKY]
Named TT6:
Protection Ule: [16.20]

This example shows the display from SHOW DEFAULT, giving the default
device, DU1:, and directory, [HUSKY], for your terminal, TT6:. Named
indicates that your default is /NAMED_DIRECTORY-that is, you can
specify either a named or numbered directory in all file specifications and
commands. Your User Identification Code (UIC) identifies you to the
operating system and controls your ability to access files.

5.10.3 SET UIC
SET UIC is a privileged command that changes your User Identification
Code (UIC). A UIC is an attribute of a directory and its files, establishing
ownership. If you intend to create or alter files in a directory other than
your own, you can use this command to change your UIC to that of the
directory's owner.
A UIC controls the protection codes of both a directory and its files. These
protection codes determine who can access the directory and its files, and
in what ways. See Section 5.6.1 for a description of how UICs relate to
file protection codes.
If you change directories, but do not change your UIC to match that of
the directory's owner, the following problems can occur:
•

If you create a file in the directory of a non privileged account-that
is, in a directory with a UIC group number greater than 10-the
owner of that directory cannot easily change or delete that file. Most
file protection codes restrict access in the WORLD category to READ,
which is the operating system default for this category. Because your

5-68 Files on Micro/RSX Systems

UIC owns the file, the owner of the directory may fall into the WORLD
category, and therefore can only read the file.
•

Several system command files, as well as the command files of some
users, set the UIC of the file's owner to match the UIC of the directory's
owner. This matching of UICs gives the command file full access to
all the files in the directory. If the files in that directory are owned by
!:II rHUo1"onf- ,

""'.1..&..&"'.&. .... .& .. "

""''&'-/

f-ho 1".'u'W'\ft'\!:IInA filo ft'\!:11'" t!:llH
".&.Il'-'

""" ....&.'... .&LIo&.I.I."""

............

'&''&LW]

... "" .......

Note that SET UIC does not change your directory. Typically, after
executing this command, you issue the SET DEFAULT command to change
your directory to the one belonging to the owner of the new UIC.
SET UIC acts differently if your terminal's default is /NONAMED_
DIRECTORY. See Volume 2, Chapter 12 for more information.

Format
SET UIC [uic]
Parameter
[ulc]

Specifies the User Identification Code (UIC) that you want to make
your default. The format of a UIC is [g,m], where the first number is
the group number, and the second is the member number. Group and
member numbers are octal and range from 1 through 377.
Group numbers indicate privilege status. The UICs of privileged
accounts have group numbers of 10 or less.

Examples
• DIRECTORY/FULL [OOOOoo]GIDEON.DIR IRETI
Directory DUO: [000000]
12-MAY-86 14:12
GIDEON.DIR;1
(676.6040)
1./1.
[200.1] [RWED.RWED.RWED.R]
Total of 1./1. blocks in 1. file

C 12-MAY-86 07:28

•
•

• SET UIC lEill
UIC? [200.1] lEill
• SET DEFAULT [GIDEON] lEill

Assume that you want to create or alter files in [GIDEON], another directory
located on your current device. A full listing of the directory file itself,
located in [OOOOOO]GIDEON.DIR, shows that the UIC of the directory's

Files on Micro/RSX Systems 5-69

owner is [200,1]. You then issue the SET UIC command to change your
current UIC to that of the directory's owner. Finally, you type the SET
DEFAULT command to move to the other directory.

Notes
As a privileged user, you can manipulate the files of another directory in
any way. Note that you need only issue the SET UIC command if you
intend to create or alter files (WRITE) in another directory. However, when
you are working with the files of another directory, it is good practice to
always use this command.
If you change your UIC to that of a non privileged account, you can change
back to a privileged account by issuing the SET UIC command again.

You can type either the SET UIC or the SET DEFAULT command first;
the sequence does not matter.

5.10.4 SHOW UIC
SHOW UIC displays your User Identification Code (UIC). Your UIC is
unique and identifies you to the operating system. In addition, your UIC
determines whether you are a privileged or nonprivileged user.
Each file and directory has a UIC associated with it, which identifies the
owner. Each file and directory also has a protection code. The way in
which your UIC relates to both the UIC and protection code of a file
or directory controls your ability to access that file or directory. See
Section 5.6 for a description of protection.
Nonprivileged users always have the same UIC, but privileged users can
change their UIC with the SET UIC command.

Format
SHOW UIC

5-70 Files on Micro/RSX Systems

Example
• SHOW UlC @IT]
Protection UlC: [303.17]

This example shows the display from SHOW VIC. The first number is
the group number, and the second is the member number. Group and
member numbers are octal and range from 1 through 377.
Generally, all users working on a particular project have the same group
number. Each user account has a unique member number, however.
Group numbers indicate privilege status. The VICs of privileged accounts
have group numbers of 10 or less. The user issuing this SHOW VIC
command, therefore, is nonprivileged.

5.10.5 SET PROTECTION
SET PROTECTION changes the protection code of an existing file or files.
The protection code determines which users may access a file, and in what
ways.
Nonprivileged users can change the protection of any files in their own
directory. Privileged users can change the protection of any file.
Format
SET PROTECTION:(code)[/qualifier[s]] filespec[s]

SET PROTECTION[jqualifier[s]]
File? filespec[s]
Code? (code)
SET PROTECTION[jqualifier[s]] filespec[s] (code)
Command Qualifiers
/DATE:dd-mmm-yyy
/SINCE:dd-mmm-yy
/THROVGH:dd-mmm-yy
/SINCE:dd-mmm-yy /THROVGH:dd-mmm-yy
/TODAY
/EXCLVDE:filespec

Files on Micro/RSX Systems 5-71

Parameters
nlespec[s]

Specifies the file or files for which you are changing the protection.
Multiple file specifications, separated by commas, and wildcards are
permitted.
(code)

Specifies which user categories can access a file and what each user
category may do to the file. The parentheses are required.
There are four categories of users in a file protection code, as follows:
SYSTEM
The operating system itself, and privileged users, those with
group numbers of 10 or less.
OWNER

The user having the same UIC as the one the file was created
under.

GROUP

All users with the same UIC group number as the one the
file was created under.

WORLD

All other users.

There are also four kinds of access to files as follows:
READ
The user, or the user's tasks, may read, copy, print, type the
file, or ru\l it, if it is a task image.
WRITE

The user, or the user's tasks, may add new data to the file
by writing to it.

EXTEND

The user, or the user's tasks, may increase the amount of
disk space allocated to the file.

DELETE

The user, or the user's tasks, may delete the file.

The system default protection code is expressed as follows:
(SYSTEM:RWED,OWNER:RWED,GROUP:RWED,WORLD:R)
Under this code, the system, and privileged users, have full access to your
files. You, as well as others with your group number, also have full access
to your files. Other nonprivileged users can only read your files.
All files have the system default protection, unless you change their
protection code using the SET PROTECTION command, or establish
an alternative default protection using the SET PROTECTION/DEFAULT
command.

5-72 Files on Micro/RSX Systems

You specify the code in the SET PROTECTION command using the same
format as shown in the previous example. Note, however, that you need
to name only the user groups whose access rights you want to change and
the types of access you want to grant to those groups. If you want to deny
all access to a group, simply name the group and omit the colon (:) and
the code for the access form.

Examples
• SET [EITl
FUNCTION? PROTECTION [EITl
CODE?(SYSTEM:RWED.OWNER:RWED.GROUP.WORLD) [EITl
File(s)? SANTONE.TEX [EITl

•

• SHOW PROTECTION SANTONE.TEX IRETI
System:RWED. Owner:RWED. Group:No Access. World:No Access

This example changes the protection of the file SANTONE.TEX so that
privileged users and the owner have full access to the file and all others
have no access to the file. The SHOW PROTECTION command displays
the protection of the file. Issuing the SHOW PROTECTION command is
a good way of checking that you have changed the file's protection code
correctly.
• SET PROTECTION *.*:* (SYS:RWE.OWN:RWE.GRO:R.WOR:R) [EITl

This example sets the protection for all files in the current default directory.
No class of user can delete the files in the directory; other nonprivileged
users cannot alter files in the directory.

Notes
You must have access to the volume, the directory, and the file before you
can access a file. See Section 5.6.1 for more information.
Although you can protect your files against access by privileged users,
privileged users can change the protection status of any file. Thus, you
can prevent privileged users from inadvertently accessing your files, but
you cannot prevent them from deliberately changing the protection status
and doing what they will with your files.
If you deny READ access to a task image file, the task cannot be run.

Other commands accepting a protection code include INITIALIZE,
INITIALIZE/UPDATE, MOUNT, and CREATE/DIRECTORY.

Files on Micro/RSX Systems 5-73

Other commands with qualifiers associated with file ownership include:
•

INITIALIZE/OWNEILUIC-See Volume 2, Chapter 13.

•

INITIALIZE/UPDATE/OWNEILUIC-See Volume 2, Chapter 13.

•

INSTALL/UIC-See Volume 2, Chapter 15.

•

LINK/OPTION:UIC-See Volume 2, Chapter 14 and the RSX-llM
/M-PLUS and Micro/RSX Task Builder Manual (which is available
separately and as part of the Advanced Programmer's Kit).

•

MOUNT/OWNER-See Volume 2, Chapter 13.

•

RUN/UIC-See Volume 2, Chapter 15.

•

SHOW QUEUE/OWNEILUIC-See Volume 2, Chapter 12.

•

SHOW TASK/DYNAMIC/OWNER-See the Advanced Programmer's
Kit.

5.10.6 SET PROTECTION/[NO]DEFAULT
SET PROTECTION/DEFAULT establishes your personal default protection
code for all files that you create after issuing this command. A file
protection code controls the types of access that other system users have
to your files.
Note that this command establishes your default file protection only for the
current terminal session. To set your default file protection for all future
terminal sessions, place the SET PROTECTION/DEFAULT command in
your LOGIN.CMD file.
SET PROTECTION/NODEFAULT removes your personal default file
protection. After issuing this command, the files you create receive the
volume default protection. Although a volume can have any default
file protection, this default is usually the same as the system default of
(SYSTEM:RWED ,OWNER:RWED ,GROUP:RWED, WORLD:R).
To change the protection code for existing files, see the description of SET
PROTECTION in Section 5.10.5.

5-74 Files on Micro/RSX Systems

Format
SET PROTECTION:(code)/DEFAULT
SET PROTECTION/NODEFAULT
SET PROTECTION/DEFAULT
Code? (code)

Parameter
(code)

Specifies which user categories are permitted access to the file and what
each user category may do to the file. The parentheses are required.
The file protection code has four user categories and four types of access
allowed for each user category. See Section 5.10.5 for a description of
the protection code format.
The first time you issue SET PROTECTION/DEFAULT in a terminal
session, you must specify all four user categories. If you want to deny
access to a category, omit the colon and the access code after the
category name.
If you issue SET PROTECTION/DEFAULT again during the terminal
session, you only need to specify the categories for which you want
to change the access code. When you omit a user category in the
protection code, you keep the current default protection for that
category.

Examples
• SET PROTECTION/DEFAULT ~
CODE?(SYSTEM:R,OWNER:RWED,GROUP:R,WORLD) ~

This example establishes your default file protection. Because you are
issuing this command for the first time in the terminal session, you
specify all four user categories. The code limits users in the SYSTEM
and GROUP categories to READ access. You retain the standard volume
default protection for the OWNER category of READ, WRITE, EXTEND,
and DELETE. You deny all file access to the WORLD category by omitting
the colon and access code after the category name .
• SET PROTECTION: (GROUP)/DEFAULT ~

Assume that you type this command later in the same terminal session
that you executed the command in the first example. Here you change
your default protection for the GROUP category, denying these users any
access to your files. Your default protection for the other three user

Files on Micro/RSX Systems 5-75

categories remains unchanged. Note that you only needed to specify the
user category for which you wanted to change the file access .
• SET PROTECTION/NODEFAULT @[D

This command removes your personal default file protection. The files
that you create after issuing this command receive the volume default
protection.

Notes
If you place SET PROTECTION/DEFAULT in your LOGIN.CMD file, you
must specify all four user categories.

The system manager can use the Account File Maintenance Program
(ACNT) to establish a default file protection for your account. This method
has the same effect as placing SET PROTECTION/DEFAULT in your
LOGIN.CMD file: both methods establish your default file protection for
each terminal session. Note, however, that you can modify your default
file protection for any portion of a terminal session by typing the SET
PROTECTION /[NO]DEFAULT command.
If both SET PROTECTION /DEFAULT and ACNT set your default file
protection, then the protection indicated in SET PROTECTION/DEFAULT
is your default.

SET PROTECTION/NODEFAULT removes your personal default protection, regardless of whether SET PROTECTION/DEFAULT or ACNT established it.

Error Messages
Illegal user default protection code

Explanation: You did not specify all four user categories when issuing
SET PROTECTION/DEFAULT the first time during a terminal session.
User Action: Reenter the command line, specifying all four user
categories in the protection code.

5-76 Files on Micro/RSX Systems

No protection speclfted for any fteld.

Explanation: You attempted to set your default file protection code to
deny file access to all four user categories-that is, you specified a file
protection code that looks like (SYSTEM,OWNER,GROUP,WORLD).
User Action: The minimum default file protection code is READ access
for one user category. Reenter the command line, specifying at least
the minimum file access.

5.10.7 SHOW PROTECTION
SHOW PROTECTION displays your personal default file protection code.
Your default file protection can be established in two ways: either by
issuing the SET PROTECTION/DEFAULT command, or by using the
Account File Maintenance Utility (ACNT) to enter a protection code for
your account. See the description of SET PROTECTION/DEFAULT in
Section 5.10.6.
If you do not set your own default file protection, then SHOW
PROTECTION issues the following message:
No user default protection specified.

Format
SHOW PROTECTION
Example
• SHOW PROTECTION ~
System:RWED. Owner:RWED. Group:R. World:No Access

This example shows the display from SHOW PROTECTION, indicating
that your default file protection grants full access to the SYSTEM and
OWNER categories, READ access to the GROUP category, and no access
to the WORLD category.

Files on Micro/RSX Systems 5-77

Chapter 6
Devices and Volumes
Peripheral devices are the actual hardware elements that, with the
computer, make up a computer system. In general, a peripheral device is
anything that is not part of the CPU or main memory. Peripherals include
terminals, disks, and line printers.
Peripheral devices handle all input to and output from the system. One
primary function of the operating system is to manage efficiently all the
peripheral devices in the system.
On Micro/RSX systems, the primary peripheral devices are the terminals,
the fixed disk, and the cassette drives, but many Micro/RSX systems also
have magnetic tape devices or other disks, particularly RL02 drives.
In Micro/RSX terminology, a file is an owner-named area on a volume. A
volume is a collection of files stored on a magnetic medium, such as a disk
or magnetic tape. This medium must be physically placed on a drive and
logically mounted before the system can access the data on the volume.
This chapter briefly introduces the important concepts concerning devices
and volumes. In addition, the chapter describes the DCL commands that
deal with devices and volumes. See Volume 2, Chapter 13, More About
Devices and Volumes, for more information.

Devices and Volumes 6-1

6. 1 Devices on MicrojRSX Systems
Table 6-1 lists the devices found on Micro/RSX systems. Each installation
has a different configuration of physical devices. Each physical device has
an associated hardware controller, which serves as an interface between
the device hardware and the CPU. In addition, each device has a device
driver, which is the software interface between the operating system and
the device controller.
The table also lists pseudo devices found on Micro/RSX systems. A pseudo
device is an entity the system or user treats as an I/O (input/output) device,
although it is not actually any particular physical device. A pseudo device
name is a pseudonym through which actual physical devices can always
be reached. See Volume 2, Chapter 13 for more information on pseudo
devices.
Individual devices are identified by a 2-letter mnemonic and an octal unit
number, terminated by a colon. If you omit the unit number, the system
defaults to unit number O. That is, if you want to specify DUO: in a
command, DU: will do.
Table 6-1: Devices on Mlcro/RSX Systems

Mnemonic Device
CL:

Console listing pseudo device

CO:

Console output pseudo device

DD:

DECtape II (TU58)

DL:

RLOI/RL02 disk drives

DU:

RA60/RA80/RA81 disk drives
RC25 disk drive
RD51/RD52 disk drives
RX50 diskette drive

DY:

RX02 diskette drives

LB:

System default pseudo device

LP:

Une printer

MS:

TK25 /TS05 /TS 11 tape drives

6-2 Devices and Volumes

Table 6-1 (Cont.):

Devices on Mlcro/RSX Systems

Mnemonic Device
MU:

TKSO tape drive

NL:

Null device

RD:

Reconfiguration driver

SP:

Spooling pseudo device

SY:

User default pseudo device

TI:

Terminal input pseudo device

TT:

Terminal

VT:

Virtual terminal

WK:

Workfile pseudo device

Micro/RSX systems support a variety of devices including the terminal,
line printer, disk, and tape unit. The line printer is called a unit record
device. Disks and magnetic tapes are mass-storage devices. Disks are
random-access devices and magnetic tapes are sequential-access devices.
Each of these device types is discussed in more detail elsewhere in this
chapter and in Volume 2, Chapter 13.
Devices are informally identified by the 2-letter mnemonic identifying the
device driver (such as DL: for RL02), but you should remember that the
driver may support more than one device. For instance, the DU: driver
supports the RDS1 and RDS2 fixed disks and the RXSO diskettes.
Magnetic tapes are a sequential-access medium. Random-access media,
such as disks, are used when speed is the most important virtue. Magnetic
tapes are used when economy and transportability are more important
than speed.
The Micro/RSX Base Kit includes a magnetic tape device driver, but all
other tape software is on the Micro/RSX Advanced Programmer's Kit. Tape
use on the Base Kit is limited to tapes used for backup and tapes mounted
as foreign volumes. See the Micro/RSX System Manager's Guide for more
information on backing up files and volumes.

Devices and Volumes 6-3

On Micro/RSX systems, the information contained on the magnetic medium
is called a volume. To be used directly on the system, disk volumes must
be in Files-II format. With Files-II volumes, you can list directories, type
files, create new files, and so forth. All other disk volumes are considered
foreign. To be used directly on the system, magnetic tape volumes must
be ANSI standard. All other tape volumes are considered foreign.
The /FOREIGN qualifier to the MOUNT command (Section 6.2) allows
you access to foreign volumes. Before being initialized, tapes and disks are
foreign; they must be mounted foreign to be initialized. For information
on initializing disk volumes, see the INITIALIZE command in Section 6.4.
For information on initializing tapes, see Volume 2, Chapter 13. Unless
you have the Micro/RSX Advanced Programmer's Kit, you can only mount
tapes foreign or use them for backup.

6. 1. 1 Physical Devices, Pseudo Devices, lUNs, and logical
Names
The purpose of devices of any kind is to handle I/O from tasks. Micro/RSX
systems offer you a number of ways to name and access physical devices.
You can directly access to the physical devices by naming them in
commands or file specifications. However, you can use several forms
of indirect access to physical devices as well.
The operating system often accesses physical devices as pseudo devices.
Tasks access physical devices through logical unit numbers (LUNs). LUNs
establish a relationship between the I/O done by the task and the devices
on the system that the task needs to access. Finally, you can give any
physical device a logical name. See Volume 2, Chapter 13, More About
Devices and Volumes, for more information.

6. 1.2 Summary of Device and Volume Use Commands
All volumes, Files-II or foreign, must be mounted for any access. Foreign
volumes are mounted with the MOUNT/FOREIGN command.
Multiple users can mount a volume on a shareable device. The volume
remains mounted until all users who have mounted it dismount it.
Ownership of a device on a system with multiuser protection is of four
kinds:
•

A private volume is a volume mounted on a private device. A private
device is a device that has been allocated, or mounted with the
/NOSHAREABLE qualifier, and can be mounted by the owner only.

6-4 Devices and Volumes

•

A shareable volume is a volume mounted /SHAREABLE by the first
user to mount it and can be mounted by any other user who knows
the volume label. The volume stays mounted until the last user to
mount it dismounts it.

•

A public volume is a volume mounted on a public device. Devices are
made public by the privileged SET DEVICE/PUBLIC command or the
privileged jPUBLIC qualifier to the tvfOUNT command. The system
owns public devices. Mounting a public device means other users can
access the device without mounting it. Only a privileged user can set
a device public or nonpublic. Public devices cannot be allocated.

•

An unowned volume is a volume on a device that has not been allocated
or mounted by anyone. An unowned volume can be mounted by
anyone.

Any user who mounts a volume has full access to that volume within
the limits of privilege and volume and file protection. Privileged users
have privileged access. Nonprivileged users have nonprivileged access.
However, nonprivileged users do have privileged access to volumes
mounted on their private (allocated) devices.
A mounted device cannot be set public or nonpublic, and cannot be
allocated or deallocated.
The LOGOUT command issued by any user automatically dismountsany volumes mounted from that terminal and deallocates any devices
allocated from that terminal. A mounted public device is not dismounted
by LOGOUT, however.

6.2 MOUNT
MOUNT declares a volume to be known to the system, and sets the volume
on-line, and ready for use. Some qualifiers can be used with any MOUNT
command; some are limited to mounting disks and others are limited to
mounting magnetic tapes. All tape qualifiers to MOUNT are described in
Volume 2, Chapter 13, but unless you have the Advanced Programmer's
Kit you can only mount tapes foreign or use them for backup.

Devices and Volumes 6-5

Format

For Disks and Other Random-Addressable Devices
MOUNT[/qualifier[s]] ddnn: volumelabel
Command Qualifiers
/FILEJROTECTION:(code)
/FOREIGN
/OVERRIDE:IDENTIFICATION
/OWNER:[uic]
/PROTECTION:(code)
/PUBLIC
/[NO]SHAREABLE
/SYSTEM (synonym for /PUBLIC)
/[NO]WAIT
/[NO]WRITE
Parameters
ddnn:

Specifies the device on which the volume is to be mounted. You can
mount only one disk or other random-addressable device.
volumelobel

Specifies the volume label, that is, the name associated with the
volume. Volume labels are mandatory for nonprivileged users. You
must supply a volume label for each volume you want to mount.
Disk and random-addressable volume labels can be as many as 12
characters.
Volume labels (or identifiers) can include any alphanumeric character
without restriction. If you are mounting an ANSI-standard magnetic
tape, you can also specify nonalphanumeric symbols such as the
following:
<space> ! " ~ _ ' () * + , -

. /

< => ?

Labels including these characters must be enclosed in quotation marks
( 1/). If the label includes the quotation mark itself (1/), the quotation

mark must be followed by another quotation mark. The extra quotation
marks do not count in figuring the length of the label. See the
examples.
Note that the at sign (@), semicolon (;), and dollar sign ($) are not
accepted in volume labels.

6-6 Devices and Volumes

Command Qualifiers
/FILE_PROTECTlON:(code)

Specifies the default file protection for any new files created on the
volume while it is mounted. The file protection code is enclosed
in parentheses.
See Section 5.6 for more information on file
protection codes and the relationship between file protection and
volume protection. See also the /PROTECTION qualifier.
The default file protection can be overridden by specifying another
protection when the file is created.
If this qualifier is not included, the value specified at the time the
volume was initialized is applied.
/FOREIGN

Specifies that the volume being mounted is not in Files-11 format (if a
disk volume) or not in ANSI format (if a tape volume). This qualifier
is required for foreign volumes. Note that before a tape or disk has
been initialized, it is a foreign volume.
/OVERRIDE:IDENTIFICATlON

Allows privileged users to mount a volume without using the volume
label. IDENTIFICATION is the default argument for /OVERRIDE.
All other arguments to OVERRIDE are for tapes and are described in
Volume 2, Chapter 13.
/OWNER:[g,m]

Specifies the owner of the volume. The brackets are required syntax.
This qualifier overrides the OWNER value established when the volume
was initialized. The owner value is used with file and volume
protection. See Section 5.6.
/PROTECTION:(code)

Specifies the volume protection for Files-11 disks. This protection
overrides the volume protection established when the volume was
initialized. The /PROTECTION qualifier combines with the /OWNER
qualifier to control access to the volume. See Section 5.6 for more
information on volume protection.
/PUBLIC
/SYSTEM

These two qualifiers are synonyms. The /SYSTEM qualifier is included
for VAX/VMS compatibility.

Devices and Volumes 6-7

Specifies that the mounted volume be available to all users who are
allowed access under the volume protection and file protection codes
established for the volume when mounted. See the discussion on file
protection and volume protection in Section 5.6. These qualifiers are
privileged.
If you state this qualifier explicitly when mounting a volume on an
allocated (private) device, the device is automatically deallocated and
set public.
If you do not state this qualifier explicitly, and the device is already
set public, the mount defaults to /PUBLIC.

See the discussion of public, private, and shareable volumes in Volume
2, Chapter 13.
I[NO ]SHAREABLE

Specifies whether the volume is to be mounted shareable.
A volume mounted /SHAREABLE can be mounted multiple times by
the same or different users. Each user's access is determined by the
volume-protection and file-protection codes established for the volume
when mounted. See the discussion of file protection and volume
protection in Section 5.6.
If you mount the volume /SHAREABLE and the device is allocated or
set public, the device is automatically deallocated or set nonpublic.

A volume mounted /NOSHAREABLE is dedicated for your private use.
No other user can access the volume. For Files-II volumes mounted
/NOSHAREABLE, your privileges are SYSTEM privileges. See the
discussion of file protection and volume protection in Section 5.6.
Mounting a volume nonshareable is the equivalent of allocating
See Volume 2, Chapter 13
the device and then mounting it.
for a description of the ALLOCATE command. If you specify
/NOSHAREABLE explicitly when mounting a volume on a device,
the device is allocated and set nonpublic.
If the device is already allocated, the default is /NOSHAREABLE.
If the device is not allocated or set public, the default is /SHAREABLE.
If the device is set public, the default is /PUBLIC (synonym:
/SYSTEM).

See the discussion of public, private, and shareable volumes in
Section 6.1.2 and Volume 2, Chapter 13.

6-8 Devices and Volumes

/[NO]WAIT

Specifies whether you require operator assistance in performing the
mount. This qualifier is used mainly for batch jobs, indirect command
files, or terminals distant from the machine room. The default is
jWAIT for mounts in batch jobs and indirect command files, and
jNOWAIT for interactive mounts.
If the mount is included in a batch job or indirect command fJe, or if
you specify jWAIT in an interactive mount, a message concerning the
mount is sent to the operator's console and the mount is not completed
until the operator physically places the disk on the drive and spins it
up. If you specify jNOWAIT in a batch job or indirect command file,
or if the mount is interactive, no message appears. The medium must
have been placed on the device and readied for access (that is, spun
up and on line). (See the examples.)

For more information on mounts from batch jobs, see the discussion
of MOUNT in Chapter 8.
/[NO]WRITE

Specifies whether the volume is to be write-protected. The default
is jWRITE. If jWRITE is specified or implied, the volume can be
written to as permitted by the volume protection and file protection
codes established for the volume when mounted. See the discussion
of volume protection and file protection in Section 5.6. If a volume
is mounted with the jNOWRITE qualifier, no one may write to the
volume.

Examples
• MOUNT [gill
Device? DU1: [gill
Volume ID? HOTROD IRETI

This example mounts the volume labeled HOTROD on device DUl:. If
you are doing nothing more than mounting a volume to read from it
or write to it, you will probably not need a more complicated MOUNT
command than this.
The command sets a series of default values that do not concern the
everyday user. All default values for the mount come from the Volume
Home Block. This block is written when the volume is created by
INITIALIZE or by some other system task (such as a backup utility) that
creates a file structure on the volume. Most of the qualifiers to MOUNT
are used to override values in the Volume Home Block. You can also alter

Devices and Volumes 6-9

the Volume Home Block with the INITIALIZE/UPDATE command. These
operations are described in Volume 2, Chapter 13.
• MOUNT/WAIT DU1: WHIZZER IRET I

In this example, the user wants an operator to place the medium containing
the proper volume in place on DU1:. The command may appear in a batch
job, indirect command file, or interactive mount, perhaps from a user on
a remote termimal. The following message appears on CO: (TTO:), the
operator's console:
Please mount volume WHIZZER on DU1:
Type

OMS (DCL START) when ready
or
RES (DCL CONTINUE) to reject request.

The operator performs the requested operation and the mount takes place,
if the device was available and the operator typed START. (There is no
MCR on Micro/RSX systems.) If the device was not available and the
operator typed CONTINUE, the mount fails. The batch processor attempts
to continue the job. The same is true if the command appears in an
indirect command file.
Notes
You should not confuse mounting with physically placing the disk or other
magnetic medium on a drive. Naturally, you must place the medium on
a drive and spin it up (for a disk) or load it (for a tape) before you can
do anything else with it. However, mounting enables the system software
to access the medium, either to read or write data, or to establish a file
structure for the volume.
There are four states of device ownership:
Private
The device has been made private through the ALLOCATE
command or the /NOSHAREABLE qualifier to MOUNT.
Only you can access the volume.

6-10

Shareable

The device has been mounted /SHAREABLE. Any user can
mount the volume.

Public

The device has been made public through the SET DEVICE
/PUBLIC command or the /PUBLIC (or /SYSTEM) qualifier
to MOUNT. Only a privileged user can set a device public.

Devices and Volumes

Unowned

No one has mounted a volume on the device, nor is it
allocated or set public.

See the discussion of public, private, unowned, and shareable devices and
mounted volumes in Volume 2, Chapter 13.
You cannot put comments in a MOUNT command line.
DISMOUNT counteracts MOUNT. See Section 6.3 for a description of
DISMOUNT with examples.
See Volume 2, Chapter 13 for more information on how the operating
system controls devices and volumes. See also the description of the
INITIALIZE command in Section 6.4.
Error Messages
MOU-ACP not In system

Explanation: The task specified as the ACP, or the default ACP, is not
installed in the system.
User Action: See your system manager. Chapter 13 in Volume 2 has
more information about ACPs.
MOU-Oevlce not In system -ddnn:

Explanation: The command specified a device not present in the system.
User Action: Retype the command after checking the device list (SHOW
DEVICES) or see your system manager.
MOU-Oevlce specified twice

Explanation: The command specified the same device twice.
User Action: Retype command after checking for proper syntax.
MOU-Orlver not loaded

Explanation: The command named a device whose driver is not loaded.
User Action: See your system manager.

Devices and Volumes 6-11

MOU-Falled to attach device -ddnn:

Explanation: The command named a device that was attached by
another task and could not be mounted.
User Action: Check the device list (SHOW DEVICES) to find out if the
device is in use. See your system manager.
MOU-Home block I/O error

Explanation: An I/O error was detected in trying to read the Volume
Home Block. This message often indicates that the device is not ready,
or that the disk has not been initialized.
User Action: Try again. Switch the diskette to the other drive and try
again. If the error recurs, you may have the wrong disk, or one that
has not been initialized.
MOU-lIIegal keyword combination

Explanation: The command specified conflicting qualifiers.
User Action: Retype command after checking for proper syntax.
MOU-Index file I/O error

Explanation: MOUNT could not read either the index file header or the
storage allocation file.
User Action: See your system manager. See Volume 2, Chapter 13 for
more information.
MOU-No such device available

Explanation: The command named a device not present in the system.
User Action: Retype the command after checking the device list (SHOW
DEVICES) or see your system manager.
MOU-Not file-structured device

Explanation: The command named a device that is not supported as a
Files-I! device.
User Action: Retype the command after checking for proper device
name.

6-12 Devices and Volumes

MOU-Parameter conflicts with mounted volume

Explanation: An attempt was made to mount a previously mounted
volume using qualifiers that conflict with those specified when the
volume was originally mounted.
User Action: Check with SHOW DEVICES and confirm qualifiers with
other user. See your system manager. This may happen with a
MOUNT /SHAREABLE command.
MOU-Storage bit map file I/O error

Explanation: An I/O error was encountered while reading the storage
allocation file.

User Action: Check to be sure that you have the correct magnetic
medium, or the volume has not been initialized. See your system
manager.
MOU-Unlt allocated to or In use by another user.

Explanation: The command specified a device that is already in use.
User Action: Check on the status of the device with SHOW DEVICES
and take the appropriate action.
MOU-Unsupporfed file header format

Explanation: The Volume Home Block does not conform to Files-11
format. The volume may be corrupted.
User Action: The volume may already be mounted with the /FOREIGN
qualifier, or some other special condition is in effect. See your system
manager.
MOU-Volume already mounted -ddnn:

Explanation: An attempt was made to mount a volume on a device
that already had a mounted volume.
User Action: See your system manager.

Devices and Volumes 6-13

MOU-Wrong volume label

Explanation: The volume label on the label and the volume label in
the command do not match.
User Action: Retype the command after checking for proper volume
label. Privileged users can use the /OVERRIDE:IDENTIFICATION
qualifier.

6.3 DISMOUNT
DISMOUNT counteracts MOUNT. DISMOUNT marks the volume logically
off line and disconnected from the file system. Marking a volume for
dismount prevents programs from opening new files on the volume. After
all open files on the volume have been closed, the volume is dismounted.

Format
DISMOUNT[/qualifier[s))
Device? ddnn: [volumelabel]
DISMOUNT[/qualifier[s)) ddnn: [volumelabel]

Command Qualifiers
/All
/PUBlIC
/SAVE
/SYSTEM (synonym for /PUBlIC)
/TERMINAl:ttnn:
Parameters
ddnn:

Specifies the device on which the volume is mounted.
volumelabel

Specifies the volume label or File Set ID for magnetic tape. This
parameter is optional, but if it is specified, the label or File Set ID
is checked against the mounted volume. There is no prompt for this
parameter.

6-14 Devices and Volumes

Command Qualifiers
/All

Specifies that all volumes mounted from the terminal at which the
command is issued be dismounted. A message informs you of each
dismount as it takes place. No device name or volume label is accepted
with this qualifier. See the example.
/PUBLIC

/SYSTEM

Causes all users to be dismounted from a volume. This is a privileged
qualifier. A DISMOUNT/PUBLIC frees the device, no matter who has
mounted the volume on it. This is the only way to dismount a public
volume. The /SYSTEM qualifier is a synonym for /PUBLIC, included
for compatibility with VAX/VMS./SAVE

Specifies that the disk is to remain spinning in the drive and can be
accessed for read or write operations by privileged tasks. This is a
privileged qualifier.
The most common use of /SAVE is when saving or backing up the
system disk. If you simply want to leave the disk spinning, use the
/NOUNLOAD qualifier. Remember, these values can also be set with
the /DEFAULT qualifier to MOUNT. See Section 6.2.
/TERMINAl:ttnn:

Allows a privileged user to dismount a volume mounted from another
terminal.

Examples
• DISMOUNT lEm
Device? Dtn: lEm
DIS -- TT7: Dismounted from DU2: *** Final Dismount Initiated ***

This example dismounts a volume on device DU2:. No other user had the
volume mounted when the DISMOUNT command was issued.
• DISMOUNT DU1: HOTROD IRET I
DIS -- TT3: Dismounted from DU1:

This example dismounts a volume on device DU1:. The user specified the
label HOTROD to be sure the correct volume was mounted on the device.
The volume was mounted shareable and because another user also has it
mounted, the informational message does not include the notification of
final dismount.

Devices and Volumes 6-15

$ LOGOUT [@!]

DMO -- TTl: Dismounted from DU: *** Final dismount ***
Have a good morning
22-APR-85 TTl: Logged off

This example dismounts a volume as part of the LOGOUT procedure. The
user had the volume mounted on the device and had not dismounted it
before logging out. LOGOUT dismounted the volume. If the device had
been made private through the /NOSHAREABLE qualifier to MOUNT,
or the ALLOCATE command, LOGOUT also deallocated it. This is the
equivalent of DISMOUNT/ALL.
The informational message is headed by DMO rather than DIS for historical
reasons.
$ DISMOUNT/ALL [@!]
DIS -- TTl:
Dismounted from DU1:
DIS -- TTl:
Dismounted from DU2:

*** Final dismount ***

This example dismounts all volumes mounted from the terminal at which
the DISMOUNT was issued.
$ DISMOUNT/PUBLIC DU1: [@!]
DIS -- TT2:
Dismounted from DU1:
DIS -- TT4:
Dismounted from DU1:
DIS -- TT5:
Dismounted from DU1:

*** Final dismount ***

In this example, a privileged user dismounts all users who mounted the
volume on DU1:.
Notes

DISMOUNT counteracts MOUNT.
LOGOUT issues a DISMOUNT/ALL automatically. DISMOUNT / ALL
dismounts all volumes mounted from the terminal at which the command
is entered.
You cannot include comments in a DISMOUNT command line.
The messages to your terminal indicate only that the volume is marked
for dismount. The actual completion of the dismount is noted on the
operator's console.
CAUTION

When the dismount operation is complete, the ACP prints
the following message on the operator's console (CO:):

*** ddnn Dismount complete

6-16 Devices and Volumes

This message does not appear until all files that are open
on the volume are closed. Do not remove the medium
from the drive until this message appears on CO: (TTO:).
If you remove the medium before the message appears, the
present volume may be corrupted, and the next volume
mounted on that device will be corrupted.
Error Messages
DIS-Checkpoint file stili active

Explanation: The command attempted to dismount a volume that
contained an active checkpoint file. The volume cannot be dismounted
until the checkpoint file has been closed.
User Action: Wait, or, if privileged, you can issue a SET DEVICE:ddnn:
/NOCHECKPOINT and reissue the DISMOUNT after you receive the
system message indicating that the checkpoint file is no longer active.
DIS-Volume not mounted

Explanation: The command specified a device that was not mounted.
User Action: Retype command after checking SHOW DEVICES for
mounted devices.
DIS-Volume not mounted by TI:

Explanation: The command attempted to dismount a volume mounted
from another terminal.
User Action: Dismount the volume from the proper terminal, or have
a privileged user dismount the volume.
DIS-Wrong volume label

Explanation: The command included an incorrect volume label.
User Action: Reissue the command without specifying a volume label
or check the volume label to be sure you are dismounting the right
volume.

Devices and Volumes 6-17

6.4 INITIALIZE
INITIALIZE produces a volume in Files-II format.
initialized before you can do anything with them.

Diskettes must be

When you initialize a diskette, you erase all existing files. Initialization
also writes a dummy bootstrap and a Volume Home Block, and builds the
directory structure.
Several qualifiers to INITIALIZE and a great deal more information,
including tape initialization, is included in Volume 2, Chapter 13. If
you do not have the Advanced Programmer's Kit you have no need to
initialize tapes.
When initializing diskettes, you generally do not need any qualifiers.

Format
INITIALIZE[/ qualifier[s]]
Device? ddnn:
Label? volumelabel
INITIALIZE[/qualifier[s]] ddnn: volumelabel
Command Qualifiers
/BAD_BLOCKS:arg
AUTOMATIC
MANUAL
NOAUTOMATIC
/FILEJROTECTION:( code)
/OWNER:[g,m]
/PROTECTION:(code)

Parameters
ddnn:

Specifies the name of the device on which the magnetic medium to
contain the volume has been placed. In most cases, this is DUl: or
DU2:.
volumelabel

Specifies the label the volume is to be initialized with. The label
names the volume and must be specified by non privileged users when
they mount the volume. The volume label is, in effect, a password
controlling access to the volume. The volume label can be as many as
12 characters long.

6-18

Devices and Volumes

Command Quallfters
Defaults to INITIALIZE enable you to initialize a volume in a standard
fashion, but the qualifiers allow much more flexibility.
/BAD_BLOCKS:arg
AUTOMATIC
MANUAL
NOAUTOMATIC

AUTOMATIC reads the bad-block descriptor file created by the
ANALYZE/MEDIA command and automatically determines the badblock information for the volume. This is the default. See the
Micro/RSX System Manager's Guide for more information.
MANUAL specifies that bad-block information for the volume is to be
entered manually.
NOAUTOMATIC specifies that bad-block information is to be ignored.
/FILE_PROTECTlON:(code)

Specifies the default protection for all files on the volume being
initialized. See Section 5.6 for more information on file protection.
The default file protection code is as follows:
(SYSTEM:RWED.OWNER:RWED.GROUP:RWED.WORLD:R)
/OWNER:[g,m]

Specifies the owner of the volume. Group and member numbers range
from 1 through 377. The default volume owner is [1,1]. The /OWNER
value is used for checking volume protection. See Section 5.6 for more
information on volume and file protection.
/PROTECTION:(code)

Specifies the default protection for new files created on the volume.
See the discussion of volume protection in Section 5.6. The code for
volume protection is similar to that for file protection, except that the
liE" for EXTEND protection is replaced by a IIC" for CREATE protection.
The default volume protection is as follows:
(SYSTEM:RWCD.OWNER:RWCD.GROUP:RWCD.WORLD:RWCD)

Devices and Volumes 6-19

Example
• INITIALIZE @[B
Device? DU1:

@[B

Volume ID? HONOLULU @[B

This example initializes a volume with the volume label HONOLULU on
device DUl:. In most cases, this is all you will have to do.
Notes
Remember, when you initialize a disk volume, you are erasing all
information that was previously on the disk or diskette. Initialize with
care.
Before you can initialize a disk volume, you must issue a MOUNT
command with the /FOREIGN and /NOSHAREABLE qualifiers. The
/FOREIGN qualifier is required because the volume is considered not in
Files-II format before initialization. The /NOSHAREABLE qualifier is
required because you cannot initialize a disk volume if any other user has
access to it. See the explanation in the MOUNT command description in
Section 6.2.
INITIALIZE creates a Volume Home Block and five files used by the system.
Many of the qualifiers to INITIALIZE put values in the Volume Home
Block. Most of these values can be overridden through similar qualifiers
to MOUNT. You can change the values in the Volume Home Block with
the INITIALIZE/UPDATE command. See Volume 2, Chapter 13 for more
information on these operations.
Error Messages
INI-Allocatlon for system ftle exceeds volume limit

Explanation: The system was unable to allocate a system file from the
specified block because of intermediate bad blocks or end-of-volume.
User Action: Reenter command with different argument for the
/INDEX: qualifier. See Volume 2, Chapter 13.

6-20 Devices and Volumes

INI-8ad block tile corrupt - data Ignored

Explanation: Although the /BAD_BLOCKS qualifier was selected, or
defaulted to, the bad block data on the disk was not in the correct
format and was therefore ignored.
User Action: Process the medium with the ANALYZE/MEDIA command and initialize again. See Volume 2, Chapter 13 for more information.
INI-8Iock(s) exceed volume limit

Explanation: The specified block or blocks exceeded the physical size
of the volume.
User Action: Retype command after checking for proper qualifier
values. See Volume 2, Chapter 13.
INI-8oot block write error

Explanation: An error was detected in writing out the volume boot
block.

User Action: Reenter the command. If it still does not work, tell your
system manager.
INI-Checkpolnt tile header I/O error

Explanation: An error was detected in writing out the checkpoint file
header.

User Action: Reenter the command. If it still does not work, tell your
system manager. See Volume 2, Chapter 13 for information on the
checkpoint file.
INI-Command I/O error

Explanation: INITIALIZE encountered an I/O error while reading the
command line.
User Action: Retype command line.

If this fails, tell your system

manager.

Devices and Volumes 6-21

INI-Oata error

Explanation: The command specified a bad block number or contiguous
region that was too large.
User Action: Reenter command after checking proper syntax.
Volume 2, Chapter 13.

See

INI-Oevlce allocated to other user -ddnn:

Explanation: Command specified a private device not allocated to your
terminal. You can make a device private with the ALLOCATE
command or MOUNT/NOSHAREABLE.
User Action: Make sure you entered the correct device name. Find out
who has the device allocated and why before taking further action.
INI-Oevlce not In system

Explanation: Command specified a device not in the current system.
User Action: Retype command after checking SHOW DEVICES for
proper device name.
INI-Oevlce not ready -ddnn:

Explanation: The device was not up to speed (spun up).
User Action: Wait and try again.
INI-Orlver not loaded

Explanation: Command specified a device for which the driver is not
loaded.
User Action: Retype command after checking SHOW DEVICES for
proper device name.
INI-Falled to attach device -ddnn:

Explanation: INITIALIZE failed to attach the specified device.
User Action: Wait and try again. Check SHOW DEVICES. See your
system manager.

6-22 Devices and Volumes

INI-Falled to read bad block file

Explanation: Although the /BAD_BLOCKS:AUTOMATIC qualifier was
specified, or defaulted to, no bad-block data was found.
User Action: Process the medium through the ANALYZE/MEDIA
command and try again.
See Volume 2, Chapter 13 for more
information.
INI-Not file structured

Explanation: The system does not support the device named as a Files11 device.

User Action: Retype command after checking proper syntax.
Volume 2, Chapter 13.

See

INI-Publlc device -ddnn:

Explanation: Command attempted to initialize a volume on a public
device.

User Action: None. Nonprivileged users can only initialize volumes on
private devices.
INI-Storage bit map file error

Explanation: The system failed to read the header of the file
[OOOOOO]BITMAP .SYS.
User Action: See your system manager. A privileged user may be
able to fix the problem using the INITIALIZE/UPDATE command,
described in Volume 2, Chapter 13.
INI-Undeftned density selection

Explanation: Command specified an illegal density argument for the
device named.
User Action: Retype command after checking for proper density
argument. See Volume 2, Chapter 13.
IN I-Volume mounted Flles-ll

Explanation: Command attempted to initialize a volume mounted Files1l.

User Action: Check to make sure you have the right volume.

Devices and Volumes 6-23

INI-Volume mounted foreign with ACP

Explanation: Command attempted to initialize a volume mounted
/FOREIGN but with the / ACP qualifier.

User Action: Remount the volume without the / ACP qualifier.
INI-Volume name too long-volumelabel

Explanation: Command included a volume label that was too long.
User Action: Retype command but limit diskette volume label to 12
characters.

6.5 SET and SHOW
You can display assignments and set and display certain device characteristics. See Volume 2, Chapter 13 for information on device assignment
and the SET DEVICE command.

6.5. 1 SHOW DEVICES
SHOW DEVICES displays information about the devices included in the
system.

Format
SHOW DEVICES[:dd[nn: ][/ attribute]]
Device Attributes
/[NO]PUBLIC
/WIDTH:ddnn:
/[NO]SYSTEM

synonym for /PUBLIC

Argument
dd[nn:]

If you specify just the dd portion of the device name, as in the
following:
• SHOW DEVICE:DU

mill

the command displays information about all devices of that type on
the system. If you specify the full device name, as in the following:
• SHOW DEVICE:DU1:

mill

the display shows you information about DU1: only.

6-24 Devices and Volumes

Device Attributes
If you do not include an attribute or a device name, SHOW DEVICES
displays a list of all the devices on the system, including terminals and
pseudo devices.
/[NO]PUBLIC
/[NO]SYSTEM

Displays a list of all devices set (or not set) PUBLIC. The /[NO]SYSTE~Y1
qualifier is a synonym included for VAX/VMS compatibility.
/WIDTH

Displays the size of the I/O buffer (line length) for a particular device,
including a terminal.
Display Information
The display from SHOW DEVICES can include a number of messages.
See the examples.
ddnn:

A device name in the first column indicates the device or pseudo
device for which information is being displayed. A device name in the
second column indicates a device to which the corresponding device
in the first column has been redirected. See Volume 2, Chapter 13 for
more information.
TInn:

A terminal name in the second column, followed by the word
PRIVATE, indicates that the device named in the first column has
been allocated by the user logged in on the terminal in the second
column.
MOUNTED

Indicates that the device is mounted. For privileged users, the message
also includes the volume label.
BUF=

Indicates the line length (I/O buffer size).
PUBLIC

Indicates that the device has been set public.
If your command was SHOW DEVICES/PUBLIC, or /NOPUBLIC, the
display is PUB=ddnn: or NOPUB=ddnn:

Devices and Volumes 6-25

TYPE=

Indicates the device type by model name, for example, RD51, RX50.
MARKED FOR DISMOUNT

Indicates that a mounted device has been marked for dismount, but
that the dismount has not been completed, meaning that files are still
open on the volume. The volume cannot be remounted while it is
marked for dismount.
OFFLINE

Indicates that the system tables contain entries for the device, but that
the device is not included in the current configuration.
[directory] LOGGED ON

Indicates that the terminal is logged on and that your current directory
is [directory].
LOADED

Indicates that a loadable device driver is currently loaded.
UNLOADED

Indicates that a loadable device driver is currently not loaded.
SPOOLED

Indicates that a device is under the control of the Queue Manager.
WCHK=
NOWCHK=

Indicates a device with write-checking enabled or not enabled.
Examples
• SHOW DEVICES IRETI
TTO:
Loaded
TT1:
DUO: Spooled Loaded
TT2:
[BODDLY] - Logged in Loaded
TT3:
Loaded
TT4:
[JEROME] - Logged in Loaded
TT6:
Loaded
VTO:
Loaded
VT1:
Loaded
ROO:
Loaded
DUO:
Public Mounted Loaded Type=RD61
DU1:
TT2: - Private Mounted Loaded Type=RX60
DU3:
Offline Loaded Type=unknown
NLO:
Loaded

6-26

Devices and Volumes

TIO:

coo:

CLO:
SPO:
LBO:
SYO:

TTO:
TTO:
DUO:
DUO:
DUO:

This example shows the display from SHOW DEVICES. All devices and
pseudo devices are included. For terminals, the name in brackets is the
default directory. The only information shown for pseudo devices is the
name and the device to which they are redirected. Privileged users also
see volume labels.
• SHOW DEVICES DU: @to
DUO:
Public Mounted Loaded Type=RD6l
DU1:
TT2: - Private Mounted Loaded Type=RX60
DU3:
Offline Loaded Type=unknown

•

This example displays information about all devices of the type DU:. The
mnemonic (DUnn:) identifies the device controller. Both the fixed disk
and the diskettes use the same device controller, although the media are
very different.

• SHOW DEVICES/PUBLIC @to
PUB=DUO:
PUB=DU1:
PUB=LPO:

This example displays information about all public devices. Public devices
are accessible to all users. They may be mounted by any user to assure
continued access to the volume mounted on the device.
• SHOW DEVICE:LPO:/WIDTH @to
BUF=LPO:00132.
• SHOW DEVICE:TT1:/WIDTH @to
BUF=TTll:00080.

This example displays the line lengths of a line printer and a terminal.
The line length is determined by the size of the I/O buffer, which is why
the word BUF appears.

Devices and Volumes 6-27

Chapter 7
Running Tasks
Tasks on Micro/RSX are programs that can be run on the system. Tasks
that are used all the time can be installed, which makes them immediately
available when needed. Tasks that are used only occasionally can be kept
in a file in a directory and run from there. In general, the system manager
decides which tasks should be installed and which should be run from
task image files.
This chapter includes brief descriptions of the following commands: RUN,
ABORT, INSTALL, and REMOVE, as well as commands for displaying
information about running and installed tasks.
There is a great deal more information about task execution in Volume 2,
Chapter 15, More About Running Tasks.
For more information about what makes a task, see Volume 2, Chapter 14,
LINK and LIBRARY Commands, and also Programming on Micro/RSX.

Running Tasks 7-1

7 . 1 Two Kinds of RUN Command
Just as there are two kinds of tasks you can run on Micro/RSX systems,
there are two ways of using the RUN command:
1. Running tasks in task image files
2.

Running installed tasks

Tasks from directories are tasks included in task image files. To run these
tasks, the system must temporarily install them. To run such tasks, simply
type RUN followed by the file specification. See Section 7.1.1.
Installed tasks are always ready to run. You can see a list of installed
tasks with the SHOW TASKS/INSTALLED command. You cannot run all
installed tasks. Many are used by the system. For those you can run,
simply type RUN and give the task name. Most large applications run as
installed tasks. See Section 7.1.2.

7. 1. 1 RUN Command for Task Image Flies
When used to run an uninstalled task, RUN is actually a combination
command, encompassing INSTALL, RUN, and REMOVE. This command
is the only way a nonprivileged user can install or remove a task.

Format
RUN[/ qualifier[s]]
Task? [$]filespec
RUN[/ qualifier[s]] [$]filespec
Command Qualifiers
/TASLNAME:taskname
/TIMLLIMIT:n[u]
/UIC:[g,m]

Parameter
[$]ftlespec

Specifies a task image file on a mounted Files-II volume. This task is
installed, run, and then removed when it has finished executing.
The default file type is .TSK, but if you include the .TSK in the file
specification, then you can be sure that you are running the file from
the default directory, and not an installed task with the same name.
See the examples.

7-2 Running Tasks

The dollar sign ($) directs the system to search first for the file in
the system directory and then in the library directory. In this case,
the dollar sign specifies a device and directory and thus counts as an
element of a file specification.

Command Qualifiers
These qualifiers establish how the uninstalled task is to be installed.
/TASILNAME:taskname

Specifies the name under which the task is to be run. The default is
to run the task under a name derived from the name of the terminal
from which the RUN command was issued, as discussed in Volume
2, Chapter 15.
Use this qualifier when you want to run two tasks simultaneously using
the RUN command. Otherwise, the second RUN command causes the
following error message to appear on your terminal:
Run -- Task name already in use

See the examples.
Task names are restricted to six Radix-50 characters. The Radix-50
character set consists of the 26 uppercase letters, the 10 numerals, and
the period (.) and dollar sign ($).
/TlME_LlMIT:n[u]

Allows you to limit the amount of CPU time the task can run. The
default is jTIME_LIMIT:3M, which is quite a lot. The "M" stands for
minutes. If you give simply a number as an argument, the time unit
defaults to minutes, but you can also specify a time limit in seconds
by using a number and an "5", as in jTIME_LIMIT:30S.
/UIC:[g,m]

Specifies the default UIC for the task. This is a privileged qualifier.
This UIC determines in what protection class the task belongs and
thus determines file access.
The square brackets are required syntax.

Running Tasks 7-3

Examples

S RUN ROBOT.T8K ~
This example installs, runs, and removes upon completion the task
contained in the task image file ROBOT. TSK from the default directory on
the default device.

S RUN ROBOT ~
This example works differently depending on whether or not there is an
installed task named ROBOT. If there is an installed task named ROBOT,
this command runs it. If there is not such as task installed, this command
works the same as the previous example.
Obviously, it is best not to have both installed and uninstalled tasks using
the same name, but it can happen. If you include the file type, or any
other field of a file specification, including the dollar sign ($), you can
avoid running an installed task. See the notes for more information.
Notes

The default on Micro/RSX systems is to run only one task per terminal at
one time, but in fact Micro/RSX allows you to run many tasks from one
terminal at the same time. You can change this characteristic with the SET
TERMINAL/NOSE RIAL command, described in Volume 2, Chapter II,
More About Using Your Terminal.
For information about placing files in the system directory or library
directory so that users can run them with the dollar-sign ($) convention,
see Volume 2, Chapter 15, More About Running Tasks.
This section describes RUN as it works with any portion of a file
specification included. In general, you do not have to include the file
type, as .TSK is the default. In one unusual circumstance, however, you
must explicitly enter a file type. If there is a task already installed in the
system that has the same task name as the file name of the task image
file containing the task you want to run, the RUN command will run the
installed task rather than the one you want to run. In such an instance,
you must include the file type to force the RUN command to access the
task image file.
Some error messages resulting from RUN are labeled INS rather than
RUN because this form of RUN installs the task automatically and the
error occurs during the installation.

7-4 Running Tasks

7. 1.2 RUN Command for Installed Tasks
RUN also initiates the execution of installed tasks. Privileged users can use
RUN to initiate the execution of installed tasks on a schedule by creating
entries in the system clock queue. See Volume 2, Chapter 15.
Format
RUN[/ qualifier[s]]
Task? taskname

RUN[/ qualifier[s]] taskname
Command Qualifier
jUIC:[g,m]
Parameter
taskname
Specifies the name of the installed task to be run. The names of
installed tasks are one through six Radix-50 characters. If the System
Task Directory (STD) contains no entry under the task name you
supply, the system searches the default directory on the default device
for a file named taskname.TSK. If RUN finds such a file, it installs,
runs, and removes it.
Command Qualifier
/UIC:[g,m]

Specifies the default UIC for the task. This is a privileged qualifier.
The task's UIC determines what file protection class it belongs in, and
thus directly influences file access.
The square brackets are required syntax.
Notes

The dollar sign prompt ($) returns immediately after you issue a RUN
command for an installed task. This does not indicate that the task has
completed execution.
You can display entries in the clock queue with SHOW CLOCIC.QUEUE.
See Volume 2, Chapter 15.

Running Tasks 7-5

Error Message
RUN-Invalid time parameter

Explanation: Command specified an invalid time argument.
User Action: Check for proper syntax and reenter command.

7.2 ABORT
ABORT forces an orderly end to a running task or to the action of a specific
command. On most Micro/RSX systems, you can simply use CTRL/C to
abort any task running from your terminal.
Tasks can also be aborted by other tasks or by error-handling routines. If
this happens, some of the messages discussed below can appear on your
terminal without your having issued an ABORT command.
Nonprivileged users can abort any task running on their own terminal.
Privileged users can abort any task.

Format
ABORT[/COMMAND][I qualifier[s]] commandname
ABORT ITASK[/qualifier[s]] [taskname]
Command Qualifiers
ICOMMAND
ITASK
ITERMINAL:ttnn:

Parameters
The parameters differ depending on whether you are aborting a
command or a task.
The default is to abort a command. See the examples.
commandname

Specifies the command whose effect you want to cancel. This
parameter can be used only when the IT ASK qualifier is not present.
You must specify at least the first three characters of the command
verb.

7-6 Running Tasks

taskname

Specifies the name of the task you want to abort. This parameter
requires the presence of the IT ASK qualifier. If you use the IT ASK
qualifier and do not specify a task name, you will get an error message,
"Illegal task name."

Command Quallfters
/COMMAND

Specifies that you want to abort a command.
qualifier and need not be included.

This is the default

flASK

Specifies that you want to abort a task by name.
/lERMINAL:ttnn:

Specifies that a task from some terminal other than your own be
aborted. This is a privileged qualifier.

Examples
• ABO RUN

lBru

11:11:11 Task "TT10" terminated
Aborted via directive OR eLI

This example aborts a task initiated with the RUN command running on
your terminal. See the next example.

lBru

• RUN TREK
ORDERS: STAR DATE = 2000

You must destroy the Klingon invasion forces of 29 battle
cruisers. You have 40 solar years to complete your mission.
Ready? ICTRL/C I

In this example, the user installs the interactive task TREK by means of a
RUN command. Then, instead of providing the task with requested input,
the user issues a CTRL/C and aborts the task.
• ABORT/TASK MACT3 IRETI

This example aborts the task named MACT3. Nonprivileged users can
abort tasks running on their own terminals. Privileged users can abort
tasks running on any terminal by name.

Running Tasks

7-7

• DIRECTORY *. RNO ~
Directory DUO: [MONGO]
18-MAY-86 16:28
ALTCLI.RNO;3
213.
3.
ANNI.RNO;6
9.
APRCOM.RNO;4
BEST.RNO;6
40.
CATCH.RNO;4
7.
CHAPllSMG.RNO;13
49.
CHAP12SMG.RNO;61
223.
CHARSET.RNO;6
6.

•

27-APR-86 16:62
30-JAN-86 09:30
16-APR-86 10:36
28-APR-86 16:60
22-MAR-86 09:39
13-MAR-86 16:36
08-APR-86 13:16
16-FEB-86 11:671cTRL/CI

In this example, the user issues a DIRECTORY command and sees that
the file she was checking for is present. Rather than wait for the directory
listing to complete, the user types CTRL/C and the directory listing halts
immediately.
• ABORT/TERMINAL:TT3: ACRO ~

This example, issued by a privileged user, aborts the ACRO task running
on another terminal. Notification of the abort appears on TT3: but not on
the terminal from which the ABORT command was issued.
Notes

A is the short form of ABORT.
There can be a number of messages issued with the abort. These messages
are explained in Volume 2, Chapter 16.
LOGOUT also aborts nonprivileged tasks running from your terminal.
Tasks can also be aborted by Executive directives issued by other tasks, in
particular, by error-handling routines.

7.3 INSTALL
INSTALL includes a specific task in the System Task Directory, thus
making it known to the system. This is a privileged command. A number
of qualifiers and other information about INSTALL are discussed in Volume
2, Chapter 15.
This is a privileged command. Nonprivileged users install tasks temporarily
through RUN, which includes most of the same qualifiers as INSTALL.
See Volume 2, Chapter 15.

7-8 Running Tasks

Format
INSTALL[/ qualifier[s]]
File(s)? [$ Jfilespec
INSTALL[/qualifier[s]] [$Jfilespec
Command Qualifiers
/[NO]CHECKPOINT
/PRIORITY:n
/TASICNAME:taskname
/UIC:[g,mJ

Parameter
[$ ]ftlespec
Specifies the name of the task image file containing the task that you
want to install. The default file type is .TSK. The dollar sign ($), if
present, directs the system to search for the file first in the system
directory and then in the library directory. If you do not include
the /TASICNAME qualifier, the task will be installed under a name
based on the first six characters of the file name unless another name
was assigned through the TASK= option of the Task Builder. See the
examples for more information.
Command Qualifiers
/[NO]CHECKPOINT

Specifies whether or not the task is checkpointable. The default is set
at link time. This qualifier overrides the link-time checkpointability
specification.
/PRIORITY:n

Specifies the priority at which the task is to run. The default is set
at link time. This qualifier overrides the default set at link time. The
argument n can range from 0 through 250.
/TASILNAME:taskname

Specifies the name by which the task is to be referenced. The default
is set at link time. This qualifier overrides the link-time specification.
See the examples for more information.
/UIC:[g,m)

Specifies the default UIC for the task. This task UIC determines in
what protection class the task belongs and thus directly influences file
access. The brackets are required syntax.

Running Tasks 7-9

Examples
• INSTALL FATE ~

This example looks for a task image file named FATE. TSK on the default
device in the default directory and installs it as FATE in the STD, assuming
no other name was specified at link time.
• INSTALL .LATE IRETI

This example looks in the system directory (by convention, [1,54] and
the library directory (by convention, [3,54]) for a task image file named
LATE.TSK and installs it as LATE in the STD, assuming no other name
was specified at link time.
• INSTALL BUCKING IRETI

This example looks for a task image file named BUCKING.TSK on the
default device in the default directory, and installs it as BUCKIN in the
STD, assuming no other name was specified at link time.
• INSTALL/TASK_NAME:DOOR GATE ~

This example looks on the default device in the default directory for a
task image file named GATE.TSK and installs it as DOOR in the STD,
overriding any task name specified at link time.

Notes
REMOVE counteracts INSTALL See Section 7.4.
You can display the attributes of installed tasks with SHOW TASKS
/INSTALLED. See Section 7.5.1.2.
INSTALL can also install commons. See Volume 2, Chapter 15.

7.4 REMOVE
REMOVE takes a task name out of the System Task Directory. The task
is no longer installed.
REMOVE/REGION takes the name of a region out of the Common Block
Directory and the partition list. This is a privileged command.

7-10 Running Tasks

Format
RE MOVE [/qualifier]
Task? taskname
REMOVE[/ qualifier] taskname
Command Qualifier
/REGION

Parameter
taskname

Specifies the name of the task you want to remove.
If you want to remove a region, specify the /REGION qualifier and
the name of the region.

Command Qualifier
/REGION

Specifies that you want to remove a region from the Common Block
Directory.

Examples
• REMOVE WONTON [Bill

This example removes the task named WONTON from the System Task
Directory. The task is no longer installed .
• REMOVE/REGION DON JON [Bill

This example removes the common region named DONlON from the
Common Block Directory.

Notes
To remove an active task, you must first abort it.
If a task is fixed, REMOVE first unfixes it and then removes it. See Volume
2, Chapter 15 for information on fixed tasks and the FIX command.

REMOVE cancels all time-based requests for the task to run.
REMOVE de allocates all receive-by-reference and receive-data packets for
the task and detaches all attached regions. See the RSX-11M/M-PLUS and
Micro/RSX Executive Reference Manual in the Advanced Programmer's Kit
for more information.

Running Tasks 7-11

7.5 SET and SHOW
All users can display information about active and installed tasks.
Privileged users can change the priority of active tasks.
See Volume 2, Chapter 15 for other SET and SHOW commands having to
do with running tasks.

7.5.1 SHOW TASKS
SHOW TASKS displays information about active and installed tasks on
the system.
7.5.1.1 SHOW TASKS/ACTIVE
SHOW TASKS j ACTIVE displays information about active tasks in brief
and full formats.

Brief Format
SHOW TASKSj ACTIVE[:ttnn:][jqualifier[s]]

Command Qualifiers
jBRIEF

JALL
Argument
ttnn:
If you name a terminal in the command, the display shows in brief
form the tasks active at that terminal. If you do not name a terminal,
the display shows in brief form the tasks active at your terminal.

Command Qualifiers
/BRIEF

Specifies that you want to display information about active tasks in
the brief format. This is the default and need not be specified.
The brief format includes task names and the originating terminal in
parentheses next to each task name.
/All

Specifies that you want to display information about all tasks active
on the system. The default is to show information about tasks active
at your terminal only.

7-12 Running Tasks

Examples
• SHOW TASKS/ACTIVE @[U
MCR... (TT5:)
SHOT5
(TT5:)

This example shows the brief display from SHOW TASKS/ACTIVE. In this
case, the tasks are MCR ..., the central command dispatcher, and SHOTS,
the SHOW task itself.
• SHOW TASKS/ACTIVE/ALL @[U
LDR. . . (COO:)
RMDEMO (TTO: )
SHOH2
(HT2: )
NETACP (COO:)
SHOT5
(TT5:)
DBOFCP (COO:)

TT4
EDIT2
EDIT3

(TT4:)
(TT2:)
(TT3:)

This example shows the brief display from SHOW TASKS/ ACTIVE/ALL.
Full Format
SHOW TASK[:taskname]/ ACTIVE/FULL
Argument
taskname
If you include a task name, the display shows full information on that
task. If you do not name a task, the display shows full information

on all currently active tasks. See Volume 2, Chapter 15 for more
information on this form of the command.

7.5.1.2 SHOW TASKS/INSTALLED
SHOW TASKS/INSTALLED displays information about installed tasks in
either brief or full format.
Format
SHOW TASKS[ :taskname]/INSTALLED[/qualifier]

Command Qualifiers
/BRIEF
/FULL

Running Tasks

7-13

Argument
taskname

Specifies the task for which you want information displayed. If you do
not specify a task name, information on all installed tasks is displayed.

Command Qualifiers
/BRIEF
Requests information on installed tasks in a brief format. This is the
default and need not be specified. The format of the display is as
follows:
taskname ident parname priority size ddnn:-lbn [memstate]

The elements in this display are as follows:
taskname
The name of the task
ident

The task version identification (or the version of the
prototype task)

pamarne

The partition in which the task is installed

priority

The task's priority

size

The size of the task in bytes

ddnn:

The device from which it is to be loaded

Ibn

The logical block number of its disk address

memstate

The task memory state,
CHECKPOINTED, or blank

which can be FIXED,

If the task version identification is missing (with the rest of the line
moved left) or if it is garbage, the task was installed from a disk that
is no longer present. If the task version number is a date, such as
07JUL, the task was compiled on that day.
/FULL

Requests the full format of the SHOW TASKS IINSTALLED command.
See Volume 2, Chapter 15 for more information on this form of the
command.

7.5.2 SET PRIORITY
SET PRIORITY alters the priority of an active task. This is a privileged
command.

7-14

Running Tasks

Format
SET PRIORITY
Priority? pnum
Task? taskname
SET PRIORITY:n taskname

Parameters
pnum

Specifies the new priority you want to assign to the task. Priority
numbers can range from 1 through 250.
taskname

Specifies the name of the active task whose priority you want to alter.

Notes
Notice that SET PRIORITY changes both the running and default priority
of a task. A task can change its own priority through the ALTP$ Executive
directive. With this directive only the running priority is changed.
j

There is no SHOW PRIORITY command. You must use SHOW TASKS
/FULL instead.

Running Tasks

7-15

Chapter 8
Preparing a User Batch Job
A batch processor is a task that allows you to have a complete interactive
terminal session without being present. The commands and data that you
use to complete a session are contained in a user batch job. Each user
batch job is run on a software terminal called· a "virtual terminal." After
your batch job has run, a batch log is created, which is a record of the
activity on the virtual terminal.
This chapter discusses how to prepare a user batch job, how to queue batch
jobs, and how to read a batch log. This chapter also describes in detail
the batch-specific commands, as well as batch-specific error messages.
If you are creating a batch job for the first time, you should be familiar
with the various DCL commands and the Indirect Command Processor.

8.1 How a User Batch Job Works
To complete a user batch job, the batch processor creates a virtual terminal.
A virtual terminal passes the commands and data in your batch job to CLls
and other tasks. A user batch job completes the following functions:
1. Logs itself in
2. Issues commands
3. Supplies data for tasks
4. Responds to exit status codes returned by tasks
5. Logs itself out

Preparing a User Batch Job 8-1

You can queue one or more batch jobs using the SUBMIT command, and
this process is called a batch chain.
Each batch job that is submitted to the queue has the same UIC as the
terminal from which the SUBMIT command was entered. In other words,
the same default login UIC that is created when you log in to an interactive
terminal is created for you when your batch job is logged into a virtual
terminal.
Note
If you are a privileged user, you can run a batch job under
a UIC different from your login UIC.

When a batch job is complete, a batch log is created for your records by the
virtual terminal. The batch log includes the commands in the batch chain,
the time they were executed, the error messages received, comments, and,
optionally, login messages and the data blocks for the job. Once the batch
job is completed, the record is spooled to the line printer unless otherwise
specified. See Section 8.7 for more information on the batch log.

8.2 How to Prepare a User Batch Job
A user batch job is a file that contains commands and data that run from
a virtual terminal. The commands in a user batch job can consisit of
DCl commands or indirect command files, or they may be batch-specific
commands. The batch processor interprets these commands and processes
the information as if you were holding an interactive session.
The batch-specific commands include a login and a logout command, data
commands, and label and sequence control commands. The login and
logout controls enable the batch processor to log you in and out of each
session. The data control commands allow you to include user input in
your user batch job. User input is any data that would be input in an
interactive session. label and sequence control commands allow you to
program responses to errors that occur from within your user batch job.
Section 8.3 has descriptions of each of the batch-specific commands.

8-2 Preparing a User Batch Job

8.2. 1 The Batch Command Line
The general format of the batch command line is as follows:
S [label:] [command]

All commands in batch jobs must be preceded by a dollar sign ($). The
dollar sign informs the batch processor that the line is to be interpreted as
a command.
A label consists of from one to six characters terminated by a colon (:).
Labels, used with the GOTO command, perform error-handling functions.
The GOTO command may appear in any part of your batch job and does
not have to precede or immediately follow the label. See Section 8.3 for
a description of the GOTO command.
Commands include batch-specific commands, CLI commands such as DCL,
and indirect command files. All of these commands may be used together
in a user batch job. Note that the DCL LOGIN and LOGOUT commands
cannot be used in a user batch job because there are batch-specific
commands to perform those functions.
DCL commands are documented elsewhere in this manual. Batch-specific
commands are described in Section 8.3. Details on using indirect command
files are described in Section 8.2.1.3.

8.2. 1. 1 Comments
The exclamation point (!) is used to include comments in the user batch
job. Any information following a comment (!) is not processed by the
batch processor or issued to the CLI, but is recorded in the batch log.
Use the following format to enter comments:
S!comment

Comments (!) can include any alphanumeric character. For example:
S!SSSLet's talk cashSSS

The first dollar sign is recognized by the batch processor, but the dollar
signs and the text following the comment (!) are there for your reference
in the batch log.

Preparing a User Batch Job 8-3

8.2.1.2 Continuation Lines
DCL commands that do not fit on one line can be continued on the next
line by placing a hyphen (-) in the last character position on the line.
Continuation lines cannot begin with a dollar sign, a space, or a tab, and
they cannot be labeled. For example:
$DELETE BIG.MAC;2.JIMMY.MAC;1.LIZ.MAC;1.JAMES.MAC;2.MERRI.MAC;5

This command line executes as if it were on one line. You cannot use
continuation lines with batch-specific commands.

8.2. 1.3 Indirect Command Files
The at sign (@) invokes an indirect command file from within a batch job.
When the system accesses the indirect command file, the system executes
the commands in it. Use the following command line to include an indirect
command file in your user batch job:
$Gindirect[.CMD]

You must use the dollar sign to include indirect command files in your
batch job. The .CMD file type is optional. You may invoke the command
file from the default device and the default directory, or you may specify
a device and directory. For example, you c~n include indirect command
files in your batch job as follows:
$GBACKUP

This command line invokes the BACKUP.CMD file on the default device
and the default directory and passes it to the system to be processed.
$GDUO: [1.2]BACKUP

This command finds the file named BACKUP.CMD on DUO: in directory
[1,2] and passes it to the system to be processed.
Note that the default file type for indirect command files is .CMD. The
default file type for the SUBMIT command is also .CMD (see Section B.S.
You should be careful not to give batch jobs and indirect command files
the same file name because you could inadvertently submit an indirect
command file as a batch job. See Chapter 9 for more information about
indirect command files.

8-4 Preparing a User Batch Job

8.3 Batch-Specific Command Descriptions
This section describes batch-specific commands to be used for batch
processing. There are three groups of batch-specific commands:
1. Login and logout commands
2.

Data commands

3. Sequence control commands (for error handling)

8.3. 1 Login and Logout Commands
JOB

The JOB command marks the beginning of a user batch job and must
appear first in each file in a batch chain. Using the JOB command is
equivalent to the LOGIN command in DCL.

Format
JOB[/qualifier] [loglabel] [[uic]]
Command Qualifier
/TlME:(hh:mm)

or
/TIME:m

Limits the job to hours (hh) and minutes (mm or m) of CPU time. The
default is 3 minutes.

Parameters
loglabel

Specifies the name of your batch job. The loglabel can be up to six
alphanumeric characters. This loglabel appears in the batch log and
does not affect the processing of your job.
If no loglabel is entered, the corresponding spaces in the batch log are
left blank.
[ulc]

Specifies the UIC. When specifying a UIC, you must include the
brackets in the specification. Only privileged users can specify a UIC
different from the UIC under which they submit the batch job.

Preparing a User Batch Job 8-5

If you do not include a UIC, the. system defaults to the UIC under
which you submit your batch job.
The UIC and login messages appear in the batch log. If you want to
suppress login messages, use the slash format in your user batch job
(see the examples).

Examples
$JOB

This is the simplest form of the JOB command. It logs the user onto a
terminal. The UIC is the same as the UIC the SUBMIT command was
issued under. Any system information messages appear in the batch log.
$JOB [20/20]

This example logs the user in under UIC [20,20] and suppresses login
messages.
$JOB BAT JOB

In this example, the loglabel BATJOB appears in the user job heading in
the logfile. Note that the loglabel can be up to six alphanumeric characters
long.
$JOB/TIME:5

This example specifies that the job must not exceed 5 minutes of CPU
time. The job ends automatically after 5 minutes of CPU time has elapsed.
EOJ

The EOJ command marks the logical end of a user batch job.
command is equivalent to LOGOUT in DCL.

This

An EOJ command must be placed at the end of each user batch job in a
batch chain. The batch processor logs out each job before beginning the
next job in a batch chain.
Note that if an end-of-file is encountered before the EO} command, the
batch processor assumes an EOJ command.

Format
EO}

8-6 Preparing a User Batch Job

8.3.2 Data Commands
DATA
The DATA cornrnand rnarks the beginning of a data block included in the
batch job. A data block is any required user input other than DCL, indirect
cornrnands, or user-written cornrnands for the batch job.

Format
DATA[/ qualifier[s]]
Command Qualifiers
/[NO]COPV

Directs the batch processor to print data blocks in the batch log. Data
blocks include any block of information that a cornrnand in the batch
log file rnay require to execute. This data block rnust follow the
cornrnand line.
The /NOCOPY qualifier prevents printing of the data blocks in the
batch log.
The default is /COPY.
/DOLLARS[: "string"]

Allows you to include user input that is preceded by a dollar sign
($). Normally, when the batch processor encounters a dollar sign, it
assurnes this is the end of a data block.
To end a data block when using the /DOLLARS qualifier, you rnust
specify either an EOD cornrnand or a "string". A "string" rnay be up
to 15 characters in length and rnust be placed at the end of your data
block. This "string" does not appear in your batch log.
The default "string" is $EOD.
Note that if you use a "string" when specifying the /DOLLARS
qualifier, the batch processor ignores all EODs until the "string" is
encountered.

Preparing a User Batch Job 8-7

Examples
.RENAME
PETE. TXT
REPEAT.TXT
.PRINT REPEAT.TXT
.RENAME
.DATA
PETE. TXT
REPEAT.TXT
.PRINT REPEAT.TXT

These two examples are the same. Both examples rename PETE. TXT to
REPEAT.TXT and print REPEAT.TXT.
In the first example, the first line without the dollar sign is taken as
data because the previous line called for user input. In the second
example, the DATA command is used to identify the text following the
RENAME command as a data block. In both examples, the next dollar
sign encountered marks the end of the data block. Note that the DATA
command is optional unless one of its qualifiers is needed .
• SAM.TSK
.DATA/DOLLARS
.!The following information is a data block .
• 1 Foryou
.2 Forme
.3 Forsam
.!This is the end of the data block .

• EOD

In this example, the task SAM requires, as input, information beginning
with a dollar sign. To include data beginning with a dollar sign in the task
SAM, you must use the DATA command with the /DOLLARS qualifier.
Using the DATA command with the /DOLLARS qualifier allows data
beginning with a dollar sign to be passed to the task instead of the batch
processor. The information following the DATA/DOLLARS command is
a data block. An EOD command is required to end the data block.
.JOB NEWJOB
.!This file creates a batch command file called CAT.BAT within the
.!batch job NEWJOB

.COpy TI: CAT.BAT
.DATA/DOLLARS:"MOUSE"
.!The following information
.!is to be included in the file
.'CAT.BAT until the string

8-8 Preparing a User Batch Job

',RMOUSER is encountered.
'JOB
'RUN SPOT.TSK
'DATA/DOLLARS
t40.00 Vets
'20.00 Chow
'10.00 Grooming
'EOD
SEOj
MOUSE
'EOJ

In this example, a batch job is created called NEW]OB. When the batch
processor encounters another JOB command, another batch command file is
created called CAT.BAT. Information is read from the TI: (virtual terminal)
and copied to the file CAT.BAT. Because a Hstring" MOUSE was used in
the file CAT.BAT, the batch processor ignores all EOD commands until
the string HMOUSE" is encountered. The file CAT .BAT is a separate batch
command file with a batch job.
Note that the first EOD command and the first EO] command are ignored
by the batch processor, but are included in the file CAT.BAT. The last EO]
command ends the batch job. Remember, if a Hstring" is not used, the
batch processor ends the data block when it encounters an EOD command.
EOD

The EOD command marks the end of a data block. If you use the
DATA command with the /DOLLARS qualifier, the data block is closed
by default when an EOD is encountered. If you used a Hstring" with
/DOLLARS, the batch processor ignores all EOD commands until the
Hstring" is encountered.
Format
EOD

Preparing a User Batch Job 8-9

8.3.3 Sequence Control Commands
STOP
The STOP command stops the batch job. You can use it alone or with the
ON or IF commands.

Format
STOP
ON statuscode THEN STOP
IF statuscode THEN STOP
A STOP command stops the batch processor. This command may be used
alone or with an ON or IF command. the status codes are WARNING,
ERROR, and SEVEREERROR.
A STOP command without a qualifier or command following it is
interpreted by the batch processor. A STOP command followed by a
qualifier or any other command line is passed to the current eLI.
You may have more than one STOP command in a user batch job when
it is used with the ON or IF commands.
If you stop a user batch job in a batch chain, the batch processor continues
with the next batch job.

Example
IJOB
I!This is a test.

ISTOP

This is the simplest form of the STOP command. In this example, the
STOP command is equivalent to an EOJ command.
If you use a STOP command with the ON or IF command, the batch
processor does not halt the batch job, but rather performs the action
specified by these commands.

Note that if your batch job contains another batch job, the batch processor
continues with the next user batch job in the batch chain.

8-10

Preparing a User Batch Job

CONTINUE

The CONTINUE command can be used with the ON or IF commands. This
command allows the batch processor to continue processing jobs when it
encounters a status code other than SUCCESS.
The use of the CONTINUE command alone does not affect processing.
Format
CONTINUE
ON statuscode THEN CONTINUE
IF statuscode THEN CONTINUE

The status codes are WARNING, ERROR, and SEVEREERROR.
GOTO

The GOTO command instructs the batch processor to move to a line that
contains a specified label and begin processing from there. This command
can reference forward or backward. Use it alone or with the ON or IF
commands.
Format
GOTO label

label: [command]
Parameter
label:[ command]

The label can be up to six alphanumeric characters long. The referenced
label may precede or follow the GOTO command line. Note that the
referenced label must have a colon (:) following it. The command
following the label is optional.

Preparing a User Batch Job 8-11

Examples
.GOTO NEXJOB

.NEXJOB:DIR

In this example, the batch processor is instructed to skip to the label
NEXJOB. The NEXJOB reference uses the DIR command to display
directories .
• ON WARNING GOTO MOON

In this example, the batch processor is instructed to skip to the label
MOON if a WARNING or more severe error is encountered.
Note that your referenced label may precede or follow the GOTO command
line. Because of this, it is possible to get caught in an infinite loop. To
avoid looping, use the jTIME qualifier with the JOB command so that you
can specify a limit to your batch job.
ON

The ON command, when used with the STOP, CONTINUE, or GOTO
commands, specifies the action to be. taken by the batch processor if an
error occurs.

Format
ON statuscode THEN STOP
ON statuscode CONTINUE
ON statuscode GOTO label

Parameter
statuscode

The status codes are WARNING, ERROR, and SEVEREERROR.
The action taken by the batch processor depends on the status code
you use and the commands you use it with. For example, if you use
ON WARNING THEN STOP, the processor stops the batch job when
a message other than success is returned.

8-12 Preparing a User Batch Job

If you choose ERROR, the batch processor ignores all warning messages
in your batch job, but performs the specified action for all ERROR and
SEVEREERRORs encountered.
If you choose SEVEREERROR, the batch processor ignores both
warnings and errors encountered in your batch job and performs a
specified action when a SEVEREERROR is encountered.
If no warnings or errors are encountered, the batch processor assumes
a SUCCESS statuscode. ON SUCCESS is not a valid command,
however.

Note that if the status code is encountered, the ON command defaults
to ON WARNING THEN STOP until another ON or SET command
is encountered. You may set the ON command at any point in a user
batch job.

Examples
.ON WARNING THEN STOP

This is the default setting for the ON command. If you do not override it
with another ON command or a SET command, any WARNING or more
severe status return code will stop the batch job .
• ON ERROR THEN GOTO JEEPERS

Once the batch processor encounters this command, it ignores all
WARNINGs.
When the batch processor receives an ERROR or
SEVEREERROR code, it skips directly to the line labeled $JEEPERS: and
processes that command and all commands following that label.
SET

The SET command enables or disables the ON command setting.

Format
SET NO ON
SET ON
The SET NO ON command disables the ON command setting, including
the default. The batch processor ignores the status codes set by the ON
command until a SET ON or IF command is encountered. Any errors
detected while in a SET NO ON state are included in the batch log.

Preparing a User Batch Job 8-13

SET ON enables the ON command after a SET NO ON command has
been issued. The batch processor returns to the status set by the last ON
command.

IF
The IF command is used to check the status code of a given command
in a batch job. When an IF command is specified and the status code is
encountered, IF specifies the action to be taken by the batch processor.

Format
IF statuscode THEN STOP
IF statuscode CONTINUE
IF statuscode GOTO

Parameters

statuscodes
The status codes are WARNING, ERROR, and SEVEREERROR.
The IF command overrides an ON command if the status code in the
IF command line and the status code in the ON command line match.
Note that the IF command also overrides a SET command.

Example
tJOB KIDS
t! IF cOlllland example
tRUN PARENT.TSK
tIThe task PARENT.TSK uses three status codes to determine whether
tIthe batch job should continue. If any of the status codes are encountered,
tIthe job moves to the label specified in the IF command line.
tIF SEVEREERROR THEN GOTO DOOM
tIF ERROR THEN GOTO BED
tIF WARNING THEN GOTO ROOM
t!PARENT.TSK moves to the label PLAY if the exit status of the task
t!does not match the conditions set by the IF command.
tGOTO PLAY !If success assumed
t!If the status code SEVEREERROR is encountered, the job moves to the
t!label DOOM, broadcasts to the terminal and STOPS the batch jOb.
tDOOM:
tBRO TT21: "Severe error. Run ends".
tSTOP !If SEVEREERROR encountered.
t!If the status code ERROR is encountered, the job moves to the label
t!BED, broadcasts to the terminal, and starts a new task called

8-14 Preparing a User Batch Job

'!NEWKID.TSK. Once the NEWKID.TSK has completed. the job moves
'!to the label PLAY.

'BED:

'BRO TT21: "Error encountered. Running NEWKID.TSK"
'RUN NEWKID.TSK !If ERROR encountered.
'GOTO PLAY
'!If the status code WARNING is encountered. the job moves to the label
.!ROOM. broadcasts to the terminal, and moves to the label PLAY.
'ROOM:
'BRO TT21: "WARNING received. Job continues".
'GOTO PLAY
'!The label PLAY specifies an end-of-job command.
'PLAY:EOJ

In this example, three actions are given by the IF command. Should the
exit status of a task match the conditions set by the IF command, the
specified action is taken. Any ON command in effect is ignored.

8.4 Allocating Devices and Mounting Volumes
from Batch Jobs
Your user batch job may require allocating devices and mounting volumes.
If it does, running your batch job in your absence presents some problems,
because you may not be present physically to load the device or to mount
the volume. The batch processor cannot issue commands involving that
volume, if the device is not allocated and the volume is not mounted.
If you have an operator who can physically load the device and mount
the volume in your absence, you may use the ALLOCATE command and
the MOUNT command.

Because you will not know in advance which drive is available, the
ALLOCATE command uses a generic qualifier to allocate the first available
drive. Likewise, the MOUNT command has a qualifier that enables the
batch processor to pause until your volume is physically mounted.
Use the following format in your user batch job to allocate a drive:
• ALLOCATE [/TYPE: devtype] dd: ddn:

The qualifier /TYPE is necessary whenever a device name (dd) refers
to more than one kind of device. Once you have specified the above
command line, the ALLOCATE command allocates the first available drive
and assigns the logical name (ddn:) you specified.

Preparing a User Batch Job 8-15

The MOUNT command follows the ALLOCATE command in your batch
job. Use the MOUNT command with the /W AIT qualifier to notify the
operator (by sending a message to the console terminal) to load the volume
with the specified label on a specified drive. For example:
'MOUNT/WAIT ddn: label

The MOUNT command pauses until the operator loads the device
and restarts the MOUNT command. When the MOUNT command is
completed, the remaining commands in the batch job are executed.
Note that you must use the DEALLOCATE command and the DISMOUNT
command as you would in an interactive session.
Examples
'JOB
'!This batch job restores files from an RX51
,!disk pack labeled CHECK ME to the fixed disk.
'ALLOCATE/TYPE:RX50 DU: INO:'
'MOUNT/WAIT INO: CHECKME
'BACKUP/NOINI/DIR INO: DUO:
'DISMOUNT INO:
'DEALLO INO:
'EOJ

In this example, you do not know the physical device name, so you give
it a logical device name, INO:.
If you intend to load and allocate the device yourself on a specific drive,
you can use the MOUNT/NOSHAREABLE command, as shown in the
next example:
'JOB
'!This batch job will get a full directory listing
'!of an RX51 diskette that is already loaded and
'!spun up.
'MOU DU1:IMREADY/NOSHAREABLE
'DlRECTORY/PRINT DU1: [*]/FU
'DMO DU1:
'EOJ

8-16 Preparing a User Batch Job

8.5 SUBMIT
The SUBMIT command is used to enter user batch jobs into the batch
queue. If more than one batch job is submitted to the queue, it is called a
batch chain.
This section explains the qualifiers that are available with the SUBMIT
command to control the processing of your batch jobs.

Format
SUBMIT[/ qualifier[s]] filespec[ s][l filequalifier[ s]]
Command Qualifiers
I AFTER:(dd-mmm-yy hh:mm)
(mml dd/yy hh:mm)
I[NO]HOLD
INAME:jobname
I[NO]RESTART
IPRIORITY:n
IQUEUE:queuename
File Qualifiers
I[NO]DELETE
I[NO]TRANSFER
Batch Logfile Qualifiers
INAME:jobname
I[NO]LOGFILE
I[NO]PRINT
IPRINT:printqueue

Parameter
ftlespec[ s]

Specifies the file(s) containing the user batch job(s).
If you include multiple file specifications, separate them using commas.
You can use wildcards (.) in the directory, name, type, and version
fields of the file specifications.
If your file specification includes no file type, the default file type is
.CMD.

Preparing a User Batch Job 8-17

Command Qualifiers
/ AFTER:(dd-mmm-yy hh:mm)
(mm/dd/yy hh:mm)

Blocks the job until after the specified time. Depending on the status
of other jobs in the batch queue, your job may be run immediately or
at a later time.
You can specify the calendar filed in either of two formats:
dd-mmm-yy Uses a 1- or 2-digit number for the day, the first 3 letters
for the month, and a 2-digit number for the year.
mm/dd/yy

Uses a 1- or 2-digit number for the month, a 1- or
2-digit number for the day, and 2-digit number for the
year.

If you leave out the calendar field, it defaults to the current date.
If you leave out the clock field, the time defaults to 00:00:00.
/[NO]HOLD

Specifies that the job be held in its queue. You can release the job
with the RELEASE/JOB command.
/NAME:jobname

Specifies a job name for a batch job. The job name can be up to nine
alphanumeric characters in length.
If you specify a job name, that name appears in the output from the
SHOW QUEUE commands. If you do not specify a job name, the job
name defaults to the name of the first file specification submitted to
the queue.
If you specify /NOPRINT and a job name, the file name of the batch
log is the same. as the job name and the file type is .LOG.
Note that you can label individual jobs in a batch chain using the label
field of the JOB command.
/[NO]RESTART

Indicates whether or not a job should be restarted if it has been
interrupted.
/RESTART causes the batch job to be put in a held state if it has been
interrupted. To start the job again, you must use the RELEASE\jOB
command.

8-18 Preparing a User Batch Job

/NORESTART does not change the status of a batch job that has been
aborted. A job that has been aborted is deleted from the queue. This
is the default.
/PRIORITY:n

Sets the queue priority of the batch chain. The highest priority job
runs' first. For example, if two jobs have the same priority, the job that
has been in the queue longer runs first.
For nonprivileged jobs, n can be any number from 1 through 150.
Privileged users can set priority from 1 through 250.
The default for n is 50.
This qualifier does not affect the running priority of tasks included in
your batch job.
/QUEUE:queuename

Specifies the name of the batch queue in which the job is to be placed.
The default is the BATCH queue.
File Qualifiers
/[NO]DELETE

Indicates whether a user batch job(s) should be deleted or not from
the user's directory.
The /DELETE qualifier marks a user batch job(s) for deletion from
the user's directory after the job has completed processing. The batch
job(s) is always deleted from the batch queue.
The default is /NODELETE.
/[NO]TRANSFER

Specifies whether or not the system should make temporary copies of
batch command files that have been submitted from a volume mounted
on a non public device.
If you use the /TRANSFER qualifier, you may dismount volumes after
the SUBMIT command has completed processing. This is the default.

Note: if a volume has files such as task files that are needed to
complete a batch job, do not dismount the volume.
When you specify the /NOTRANSFER qualifier, no copies are made.
The volumes must remain mounted until batch processing is complete.

Preparing a User Batch Job 8-19

Batch Logflle Qualifiers
/NAME:jobname

Gives a name to the batch job and the batch log.
In the batch log file, this name appears in the page heading.
When you issue the SHOW QUEUE command, this name appears in
the display.
If you do not specify a name, the name defaults to the first file name

in your batch job.
/[NO]LOGFILE

Specifies whether a batch log file should be created or not.
/LOGFILE produces a batch log file.
/NOLOGFILE suppresses the creation of a batch log file.
The default is /LOGFILE.
/PRINT[: prlntqueue ]

Causes the batch log file to be queued to a line printer and deleted
after it is printed. The temporary file is ~reated in SP:[1,7].
Although the PRINT queue is normally used, you may spool the batch
log file to any print queue by specifying an optional queuename.
The default is /PRINT:PRINT.
/NOPRINT

Suppresses the automatic printing of the batch log, but creates a
permanent copy of the batch log file. The file can be found under the
same directory and device name as the first batch job in your batch
chain.
The batch log file name is the same as the batch job name with the
file type .LOG.
Examples
$ SUBMIT SUPER.BAT ~

In this example, the batch file SUPER. BAT is spooled to the default batch
queue BATCH. The name of the job is SUPER. The log file SUPER. LOG
will be printed and then deleted.

8-20 Preparing a User Batch Job

• SUBMIT/PRINT SUPER. BAT ~

In this example, the /PRINT qualifier is the default. The command is
equivalent to the previous one.
• SUBMIT/NOPRINT SUPER.BAT ~

In this example, a permanent log file is created in your directory. After the
batch job completes, you may examine the log file SUPER. LOG at your
terminal or use the PRINT command to spool it to a line printer.
• SUBMIT/NOLOGFILE SUPER. BAT IRETI

In this example, no log file is produced.
• SUBMIT CLARK.BAT,ROBIN.BAT,SUPER.BAT IRETI

The batch files in this example are processed in the order submitted. They
are processed by the default batch processor, without interruption. Each
file contains a user batch job. The three files when submitted in this
manner are a batch chain. The name of the batch chain is CLARK and
the name of the log file is CLARK.LOG. The log file contains a record of
each of the three user batch jobs.
• SUBMIT/NAME:POOH BEAR.BAT,TIGGER.BAT/DELETE,CHRIS.BAT ~

In this example, the name POOH is given to the batch chain. The batch
file TIGGER.BAT is deleted after it is processed.
• SUBMIT/QUEUE:BAT2/AFTER:(2-JUN-86) MOMSIE.BAT ~

In this example, the batch file MOMSIE.BAT is submitted to the queue
BAT2. MOMSIE.BAT will be processed on June 2, 1985 after midnight.
If you want to submit a batch file from a directory other than your own, you
must specify the directory and the file name. For example, if your directory
is [KOOL], you may submit a batch file from the directory [HEATWAVE]
as follows:
• SUBMIT/NOPRINT [HEATWAVE]BURN.BAT ~

In the above example, the batch file BURN.BAT is submitted from the
directory [HEATWAVE] with the /NOPRINT qualifier. The /NOPRINT
qualifier suppresses the automatic printing of the batch log, but creates a
permanent copy of the batch log file.

Preparing a User Batch Job 8-21

8.6 Queuing Jobs
The Queue Manager (QMG) is a system task that distributes jobs to output
devices or batch processors. Passing jobs to the Queue Manager is called
queuing jobs." When the Queue Manager releases jobs for processing, this
action is called "dequeuing jobs."
II

The Queue Manager distributes jobs to batch processors. These user batch
jobs are queued by the SUBMIT command and are called QMG batch
jobs. A QMG batch job is a chain of one or more user batch jobs to be
processed. The SUBMIT command specifies a QMG batch job.
Once jobs are in queues, you can display queue information with the
SHOW QUEUE command. You can alter the status of jobs in queues
with the SET QUEUE command. You can hold jobs in queues with the
HOLD /ENTRY command or release them from queues with the RELEASE
/ENTRY command.

8.6. 1 How to Use the Queue Manager for Batch Jobs
Once you have issued a SUBMIT command, you may want to alter how
that file is processed or you may decide that you did not want to process
that file at all. This section explains how to manipulate the QMG so that
your file is processed the way you want it to be.
For example, you issue the following SUBMIT command to process the file
ANTRIN.BAT to the line printer:
• SUBMIT ANTRIN. BAT mIT!
SUB - Job 22, name "ANTRIN

", submitted to queue "BATCH ..

However, you did not want to submit that file. The batch file you wanted to
process is ANTRIM.BAT. To prevent ANTRIN.BAT from being processed,
you must remove that file from the BATCH queue. To do this, you use
the SHOW QUEUE command and the DELETE/ENTRY command.
The SHOW QUEUE command shows you the position of your job on the
queue (as well as other jobs) and whether or not your job is currently being
processed. The following example shows you how to issue the SHOW
QUEUE command, and displays the resulting output.

8-22 Preparing a User Batch Job

• SHOW QUEUE IBm
** PRINT QUEUES **
PRINT => LPO
LPO
=> LPO
** BATCH QUEUES **
BATCH => BPAO
[303.3]
ANTRIN
ENTRY: 824
1 DUO: [QUAINT]ANTRIN.BAT;l

ACTIVE ON BAPO

•

ANTRIN.BAT has an entry number of 824 in the BATCH queue. The
Queue Manager assigns an entry number to each job as a means of
keeping track of which jobs are processed when. Usually, this is done
on a first-come, first-served basis. Also, ANTRIN.BAT is currently being
processed, as noted by the seventh line of the display. To stop your job
from processing further (or if your job has not begun to be processed), you
have to issue the DELETE/ENTRY command. This command stops your
job immediately. You use the DELETE/ENTRY command in the following
manner:
• DELETE/ENTRY: 824 IBm

•

Your job has been removed from the BATCH queue and will not be
processed any further. However, a batch log is still created even when
you abort the batch job. When your job is finished (or aborted), the batch
log is put on the PRINT queue to be printed on the line printer. (For
more information on the batch log file, see Section 8.7.) The output from
the SHOW QUEUE command after you delete your job from the batch
processor is as follows:
• SHOW QUEUE IRET I
** PRINT QUEUES **
PRINT => LPO
LPO
=> LPO
[303.3]
ANTRIN
ENTRY: 824
1 SPO: [1.7]ANTRIN.LOG;1
** BATCH QUEUES **
BATCH => BPAO

ACTIVE ON LPO
DELETE

•

Once ANTRIN.BAT is removed from the BATCH queue, reissue the
SUBMIT command with ANTRIM. BAT as the file you want processed.
The following sections detail the various commands for using the QMG,
their qualifiers, and examples of how the commands are used.

Preparing a User Batch Job 8-23

8.6.2 DELETE
The DELETE command is used to delete jobs from a queue or files from a
job.

Format
DELETE/ENTRY:nnn[/FILEJOSITION:n]
This command allows the deletion of a job in queue by specifying the job's
entry number. You can also delete a single file in a job by specifying the
/FILEJOSITION:n qualifier.

Parameters
/ENTRY:nnn

Deletes a queue entry by number. The number is unique.
/FILE_POSITION:n

Identifies the file by the file's position in the job.

Examples
• DELETE/ENTRY: 301 [BIT]

This command deletes the job from queue by referencing the job's unique
entry number (in this example, job number 301) .
• DELETE/ENTRY:301/FILE_POSITION:2 [BIT]

This example deletes only the second file appearing in job 301. You may
only refer to the file you wish to delete by the file's position in the print
job (the numbered order in which you entered the file specification). You
cannot specify the file you wish to delete by referring to its file specification.

Notes
Associating a particular file specification with the numbered order in which
it was entered into a queue can be accomplished by entering a SHOW
QUEUE command, and examining the output on your terminal.
DELETE/QUEUE works on all categories of jobs in any queue. You can
delete ACTIVE jobs, WAITING jobs, TIME-BLOCKED jobs, or HELD jobs.
There can be more than one job with the same name from the same UIC.
The DELETE/QUEUE command will delete the first job of a given name
in the queue.

8-24 Preparing a User Batch Job

8.6.3 SHOW QUEUE and SHOW PROCESSOR
You may use the commands described in this section to display information
about queues, the jobs in the queues, spooled devices, and batch processors.
The commands described in the following section allow you to access
information about QMG batch jobs.
A SHOW QUEUE command win show all jobs in all queues. Qualifiers
can be used to limit the display to specific queues, specific jobs, and the
like.
You may examine the contents of your system's queues (in decreasing
degree of detail) by entering one of the following command qualifiers:
/FULL
/FILES
/BRIEF
The commands described in Section 8.6.3.2 display information about
spooled devices and batch processors under the control of the Queue
Manager.

8.6.3. 1 SHOW QUEUE
SHOW QUEUE displays information about QMG batch jobs.

Format
SHOW QUEUE [queuename][/qualifier[s]]
Command Qualifiers
/FULL
/FILES
/BRIEF
/ENTRY:nnn
/NAME:jobname
/OWNEILUIC:uic
/BATCH

Command Qualifiers
/FUll

Displays detailed information about queues, queue assignments, jobs,
the attributes of jobs in queues, and files that compose jobs in queues.

Preparing a User Batch Job 8-25

/FILES

Displays only queues, queue assignments, and jobs in queues.
You may examine specific attributes of queues by entering one of the
following qualifiers.
SHOW QUEUE queuename

Displays QMG information for a single queue.
displayed may be for batch queues.

The information

/ENTRY:nnn

Limits information to a particular job entry referenced by the job's
unique entry number.
/NAME:jobname

Limits information to jobs with the specified job name.
/OWNEILUlC:ulc

Limits information to jobs owned by the specified uic.
/BATCH

Limits information to batch queues.

Examples
The following examples show the three different output displays (FILE,
FULL, BRIEF) .
• SHOW QUEUE @ill

** PRINT QUEUES **
PRINT => LPO
LPO
=> LPO
** BATCH QUEUES **
BATCH => BAPO
[7.40]MJRA
ENTRY: 23
> 1 DU1:[7.40]MJRA.BAT;1

•

ACTIVE ON BAPO

This display, the default format, shows the queues in the same state. It
does not show the attributes of the job. It only shows the form number of

8-26 Preparing a User Batch Job

the job and the attributes of the files if other than the default values were
specified.
• SHOW QUEUE/FULL llim
** PRINT QUEUES **
PRINT => LPO
LPO
=> LPO
•• BAT~rl QuirujgS ••
BATCH => BAPO
[7.40]MJRA
ENTRY: 23
ACTIVE ON BAPO
PRI:60 NORESTART LOG PRINT:PRINT
> 1 DU1: [7.40]MJRA.BAT;1
NODELETE

•

This display shows all information about the queues and jobs in queues.
In this example, the batch job [7,40]MJRA, entry number 23, is running on
batch processor BAPO.

The attributes of the job are indicated in the display, and the files that
make up each job, are also listed. The angle bracket (> ) indicates which
file of a job is currently being processed.
• SHOW QUEUE/BRIEF llim
** PRINT QUEUES **
PRINT => LPO
LPO
=> LPO
** BATCH QUEUES **
BATCH => BAPO
[7.40]MJRA
ENTRY: 23

ACTIVE ON BAPO

This display only shows the names, entry numbers, and status of the jobs
in the queues.

8.6.3.2 SHOW PROCESSOR
SHOW PROCESSOR displays information about the initialized characteristics of spooled devices and batch processors, printers, and other output
devices under control of the Queue Manager.

Format
SHOW PROCESSOR [processomame]
Displays information about all processors.
SHOW PROCESSOR/BATCH
Shows all batch processors.

Preparing a User Batch Job 8-27

Example

Enter the following command line on your terminal:
• SHOW PROCESSOR @[U

Information about print processors, batch processors, and spooled input
devices will be displayed at your terminal in the following manner:

** SPOOLED DEVICES **

LPO

<= PRINT LPO

BAPO

<= BATCH

** BATCH PROCESSORS **
CURRENT JOB:

•

[303.3]ENGINE

ENTRY:688

This display shows all information about spooled devices and batch
processors.
The only batch processor, BAPO, can only receive jobs from the Queue
BATCH.

8.6.4 SET QUEUE
SET QUEUE modifies attributes given to batch jobs or files that compose
jobs in queues. Such jobs and files have been entered in queues by the
SUBMIT command. You cannot change the "attributes of an active job.
Format

SET QUEUE/ENTRY:nnn/qualifier[/qualifier[s]]
Job Qualifiers
/ AFTER:(hh:mm dd-mmm-yy)
/PRIORITY:n
/[NO]REST ART
File Format

SET QUEUE/ENTRY:nnn/FILEJOSITION:n/qualifier[/qualifier[s]]
File Qualifiers
/FILEJOSITION :n
/[NO]DELETE

8-28 Preparing a User Batch Job

Job Qualifiers
/ AFTER:(dd-mmm-yy hh:mm)

Changes the time after which your job will be processed. The job
will be BLOCKED until the time and date you specify. The job will
not necessarily be processed at exactly the time you state, but will be
eligible after the time you state.
If you do not supply the calendar field, the default is the current date.
If you do not supply the clock field, the default is midnight on the
date given in the calendar field.
If you supply both the clock and calendar fields, you must separate
them with a space.
/PRIORITY:n

Changes the queue priority of a batch job. Nonprivileged users may
set priorities up through 150. Privileged users may set priorities up
through 250.
/[NO]RESTART

Changes the restartability of your job. If you specify /RESTART,
your job will start again from the beginning if it is interrupted while
ACTIVE. If you specify /NORESTART (the default) your job will pick
up where it left off, if it is interrupted while ACTIVE.

File Qualifiers
/FILE_POSITION:n

Changes the operation of /[NO)DELETE as it applies to a file contained
in a job in queue. The number n refers to the file position in the job.
Use SHOW QUEUE to determine its position.
/[NO]DELETE

Changes the delete status of a single file contained in a batch job.

Examples
• SUBMIT MEDSURG.BAT ~

The SHOW QUEUE/FULL command output might look like this:

** PRINT QUEUES **
PRINT => LPO
LPO => LPO
** BATCH QUEUES **
BATCH => BAPO
[303.3]
MEDSURG

ENTRY: 43

ACTIVE ON BAPO

Preparing a User Batch Job 8-29

•

PRI:50 NORESTART LOG PRINT:PRINT
>
1 DUO: [303.3]MEDSURG.BAT;1

NODELETE

To change the priority of the file MEDSURG.BAT from a priority of 50
to 100, you would type the following SET QUEUE command on your
terminal:

• SET QUEUE/ENTRY:43/PRIORITY:100 ~

The SHOW QUEUE/FULL command output on your terminal would look
like this:

** PRINT QUEUES **
PRINT => LPO
LPO

=> LPO

** BATCH QUEUES **

BATCH => BAPO
[303.3]
MEDSURG ENTRY:43
PRI:100 NORESTART LOG PRINT:PRINT
>
1 DUO: [303. 3] MEDSURG. BAT; 1

ACTIVE ON BAPO

•

NODELETE

Note that the file MEDSURG.BAT now has a priority of 100 instead of 50.

Notes
When you issue the SUBMIT command, you specify attributes of the QMG
job through command qualifiers. SET QUEUE command qualifiers change
the matching attributes.
You cannot change the attributes of an active job.
You can delete files by specifying the /FILEJOSTION:n qualifier in your
SET QUEUE command line.

8.6.5 Holding and Releasing Jobs
You can specify that a batch job be HELD in queue when you issue the
SUBMIT command.
You can release such jobs with the RELEASE command.

8-30 Preparing a User Batch Job

8.6.5. 1 HOLD
HOLD blocks a job in its queue until it is explicitly released.
Format
HOLD /ENTRY:nnn
Remember, jobs may share the same name but never the same entry number.

8.6.5.2 RELEASE
RELEASE unblocks a job that has been held in queue.
Format
RELEASE/ENTRY:nnn
Examples
• SUBMIT/HOLD LAYLA. BAT IBIT1

The SHOW QUEUE/FULL command output might look like this:

** PRINT QUEUES **
PRINT => LPO
LPO
=> LPO
** BATCH QUEUES **
BATCH => BAPO
[303.3]
LAYLA
ENTRY: 26
HELD
PRI:60 NORESTART LOG PRINT:PRINT
>
1 DUO: [303.3]LAYLA.BAT;1

•

NODELETE

To unblock LAYLA.BAT, you would type the following RELEASE command on your terminal:

• RELEASE/ENTRY: 26 IBIT1

The SHOW QUEUE/FULL command output would look like this:

** PRINT QUEUES **
PRINT => LPO
LPO
=> LPO
** BATCH QUEUES **
BATCH => BAPO
[303.3]
LAYLA
ENTRY: 26
ACTIVE ON BAPO
PRI:60 NORESTART LOG PRINT:PRINT
>
1 DUO: [303.3]LAYLA.BAT;1
NODELETE

•

Preparing a User Batch Job 8-31

Note, the HELD status of the job in the previous example was first changed
to WAITING, and then, since there were no jobs in queue, became ACTIVE.

8.7 The Batch Log File
A batch job creates a batch log file that contains a record of activity on the
virtual terminal. Unless otherwise specified, the batch log is automatically
printed on your system's line printer after batch processing is complete.
Note that if you have your batch log file spooled to a printer, the temporary
file is deleted after batch processing is complete.
The batch log contains the commands in the batch chain, the time the
commands were executed, the error messages received, any comments that
you placed in your batch job and, optionally, login messages and the data
blocks for the job. The log also includes all system output that would
normally appear on your terminal during an interactive session. Any
spooled output is also appended to the print job that contains the batch
log file. This is called the log file print job.
If you specify the /NOLOG qualifier, the batch log is not spooled to the

printer, but your system output is spooled as separate print jobs.
The batch log file is divided into three parts: the log file heading, the user
job flag information, and a printout of the user batch job activity.
The log file heading contains the following:
•

Title "QMG Batch Job"

•

Batch job name

•

Version number of the batch processor

•

Day, month, year, and time the batch job began

•

Batch log page number

•

Task name of the batch processor

The user job flag displays the following:
•

User job name

•

Device name of the logged-in virtual terminal

•

UIC under which the batch job was logged in

8-32 Preparing a User Batch Job

Note that the previous information is followed by system messages from
a successful login.
The remaining part of the batch log is a record of activity which includes
the following:
•

Command lines and comments preceded by a time stamp

Output from commands and tasks (normany written to your terminal)

•

Data for commands and tasks

•

Lines skipped by a GOTO statement

•

Exit status messages

TERM, DATA, and SKIP are line identifiers that appear in the spaces
between the time stamps and the command lines in the log file. TERM
identifies the line as output from a task to the virtual terminal, DATA
identifies the line as input data to a task, and SKIP indicates that the line
was skipped because of a GOTO command.
Periods that appear below an identifier indicate a continuation of that
particular line identifier.
Your batch log file may also contain the status code that an ON command
has met or exceeded when a task exited. A display is also included in the
batch log of each task's exit status.
Note that when data appears on the same line as a prompt, it causes the
line to be labeled TERM rather than DATA. If a GOTO is specified, with
the ON and IF commands enabled, the lines skipped are labeled as SKIP.

Example
'JOB ORWELL
'!Generate and print calendars for year 1986
'ON ERROR THEN GOTO BADCAL
'RUN CALENDAR
1986
'EOD
'GOTO SPOOL
'BADCAL: ON ERROR THEN GOTO NOFILE
'RUN NEWCAL
L

1986
'SPOOL:
'PRINT BIGSIS:=1986.CAL/CO:l0
'IF ERROR THEN GOTO DIFFQ
'DIFFQ: PRINT/COPIES:10 1986.CAL

Preparing a User Batch Job 8-33

'STOP
'NOFILE:
'!Could not create calendar file
'EOJ

In this example, a user batch job is created called ORWELL. The following
text shows the batch log file that the user batch job ORWELL produces:
QMCBatch Job - CALENDAR
BPR V1.0
Processor BAPO
11:03
'JOB ORWELL

23-MAY-85

11:03 Page 1

User Job - ORWELL
Terminal VT2:
UIC = [301.31]
==================================
TERM

Micro/RSX V3.0
11 :03:54
11 :03:54
11:03:55

'!Generate and print calendars for year 1985
'ON ERROR THEN GOTO BADCAL
'RUN CALENDAR
TERM

** Calendar generator program - Version 1.0

Enter year: 1985
Sorry. year must not exceed 1983
'ERROR' Exit status returned - enabling action "ON" command
SKIP 'EOD
'GOTO SPOOL
11:03:56
'BADCAL: ON ERROR THEN GOTO NOFILE
11:03:56
'RUN NEWCAL
TERM
** Calendar generator program - Version 1.5
Enter'S' for small format. 'L' for large format: 1
Enter year: 1985
File 1985.CAL has been created
11 :04 :01
11 :04:01

'SPOOL:
'PRINT BIGSIS:1985.CAL/CO:10
TERM PRI - Extraneous input
11:04:03
'IF ERROR THEN GOTO DIFFQ
SKIP 'STOP
11:04:04
'DIFFQ: PRINT/COPIES:10 1985.CAL
TERM PRI -Job 13. name "1985
".submitted to queue "LPO

8-34 Preparing a User Batch Job

$STOP
11:04:08 TERM Connect time:
CPU time used:
Task total:

0 brs
0 brs
16

1 mins
0 mins

0 secs
4 secs

8.8 Error Messages
The following sections describe error messages that occur from batchspecific commands. Commands in batch jobs can also create error messages
that appear in your batch log.
In addition, the batch processors themselves can send error messages
concerning your batch jobs. Some of these messages result from system
problems and are returned to the operator's console. Others reflect
difficulties in processing your batch job and are returned to your batch log.
Section 8.8.1 describes error messages which appear in your batch log.
Section 8.8.2 describes messages that are sent to the operator's console.

8.8.1 Error Messages In Batch Logs
BPR-Batch tile already open

Explanation: BPR (batch processor) attempted to open the specified file
when it was already open.

User Action: System problem. See your operator or system manager.
BPR-Batch tile close failure

Explanation: BPR failed to close the specified file.
User Action: The batch job should not be affected. Check the directory
to see if the file is locked. If so, issue the DCL UNLOCK command.
BPR-Batch tile deletion failure

Explanation: The /DELETE qualifier to the SUBMIT command failed
to execute.

User Action: Check the directory. The file may not be in the directory,
or the batch job may lack delete access to the file. Delete the file with
the DCL DELETE command.

Preparing a User Batch Job 8-35

BPR-CPU time limit exceeded, user job terminated

Explanation: The batch job ran longer than the /TIME qualifier to the
JOB command permitted.
User Action: Retry the batch job and increase the amount of CPU time
using the /TIME qualifier.
BPR-I/ 0 error

Explanation: The batch processor failed to read from or write to the
virtual teI1Tlinal, or the batch processor was unable to open the batch
file.
User Action: Retry the batch job. This may indicate a hardware error.
See your operator or system manager.
BPR-Vlrtual terminalI/O was aborted

Explanation: The task sending I/O to the virtual terminal was aborted.
User Action: None.
BPR-Label undeftned

Explanation: The batch job specified a label that was not in the job.
User Action: Check the job to see that the label is present in proper
form. The label must begin with a dollar sign ($) and end with a
colon (:).
BPR-Log "Ie directory not found - aborted batch job

Explanation: The SUBMIT command included the /NOPRINT qualifier,
but the batch job cannot find the directory for the batch log.
User Action: See your system manager.
BPR-Logon privilege violation

Explanation: The $JOB command gave an incorrect UIC.
User Action: Check the command for proper syntax and retry the job.
For nonprivileged users, the UIC in $JOB must match the login UIC
in effect when the SUBMIT command was entered.
BPR-Output request from incorrect virtual terminal

Explanation: System error.
User Action: See your operator or system manager.
8-36 Preparing a User Batch Job

BPR-Spawn failure

Explanation: System error.
User Action: See your operator or system manager.
BPR-Speclfled maximum CPU time too large

Explanation: The largest amount of CPU time that inay be specified is
65535 minutes (1092 hours, 15 minutes).

User Action: Specify less CPU time.
BPR-Syntax error

Explanation: A command line in the batch job does not start with a
dollar sign ($), or special batch commands have improper syntax.
User Action: Check the batch file for proper syntax and retry the job.
BPR-Syntax error-$JOB does not appear first

Explanation: $JOB logs in the user batch job on the virtual terminal
and must appear first in the batch file.

User Action: Edit the batch file so that $JOB appears first.
BPR-Vlrtual terminal output too long for buffer

Explanation: A stream of characters from the virtual terminal was too
long to fit in a storage buffer. .
User Action: Make sure that the task outputs RETURN and LINEFEED
characters when performing terminal I/O.

8.8.2 Error Messages to the Operator's Console
BPR-Batch file Input error

Explanation: BPR could not read from the batch file.
User Action: Check the batch file status. The file may not be in the
directory.
BPR-Batch job jobname stili In progress

Explanation: System error. QMG attempted to start the batch job while
another job was in progress.
User Action: Inform the system manager.

Preparing a User Batch Job 8-37

BPR-Error during send to QMG

Explanation: System error.
User Action: Inform the system manager.
BPR-Illegal error-severity code n

Explanation: System error.
User Action: Inform the system manager.
BPR-Incorrect Emit Status Block (ESB) address returned by spawned task

Explanation: System error.
User Action: Inform the system manager.
BPR-Log lie close failure

Explanation: BPR failed to close the log file.
User Action: Check the log file status. The device may not be available,
or the file may not be in the directory.
BPR-Log lie open error

Explanation: BPR failed to open the log file.
,
User Action: Check the log file destination. The device may be writelocked.
BPR-Log lie output error

Explanation: BPR failed to write to the log file.
User Action: Check the log file status. The device may not be available,
or the file may not be in the directory.
BPR-Output request from Incorrect virtual terminal

Explanation: System error.
User Action: Inform the system manager.

8-38 Preparing a User Batch Job

Chapter 9
The Indirect Command Processor
This chapter describes indirect command files and the Indirect Command
Processor (Indirect). Also included are descriptions of the processor
directives and symbols that control the execution of Indirect.

9. 1 Indirect Command Files
Indirect command files can be used for many different things-from doing
simple tasks to performing complex system-control and programming
functions.
An indirect command file is a text file containing DCl command lines and
special directives that allow you to control command file processing. The
Indirect Command Processor (which usually runs under the task name
AT.) reads the indirect command file, interprets the directives, and passes
the DCl commands to DCL.
For example, an indirect command file could contain the following
command lines:
.ENABLE SUBSTITUTION
.ASKS CONNAN Enter command name
HELP 'CONNAN'

With this file, Indirect processes the first two command lines and DCl
executes the HELP command line.

The Indirect Command Processor 9-1

To initiate an indirect command file, type in the file specification preceded
by an at sign (@). For example:
• GCOMMANDS. CMD

rnm

The default file type for indirect command files is .CMD. Thus, the
command line in the previous example could also be input as follows:
• GCOMMANDS

rnm

The name of the indirect command file can also be a logical name
assignment that translates into a vaild Files Control Services (FCS) file
specification. For example,if you have assigned the logical name TEST to
the string DUl:[USER]COMMANDS.CMD, the command @TEST invokes
the file COMMANDS.CMD.
If the catchall task (TDX) is installed on your system, you can give the
command file a 3-character name and execute the file without using the at
sign. For example:
• ABC

rnm

Indirect searches your directory for a command file called ABC.CMD.
See Chapter 2 of this manual and the Micro/RSX System Manager's Guide
for more information on the catchall task (TDX).
Indirect command files can also be nested. The maximum level of nesting
is four unless this value has been changed by your system manager. A
maximum level of four means that you can run one command file, which
can run another file, which can run a third file, which can run a fourth
nle, which can run a fifth file.
For example, the following command file executes a DCL command line
and then invokes another command file (COOKIE.CMD). When Indirect
is finished with COOKIE.CMD, it returns to the first file, which executes
more DCL commands.
SET TERMINAL/LOWER/SCOPE/WIDTH:80
GCOOKIE
SHOW DEVICES
SHOW USERS
SHOW TIME

For DCL commands and for questions displayed by the .ASKx directives,
the first character displayed is the DCL prompt. The default prompt is a
dollar sign followed by a space ($ ).

9-2 The Indirect Command Processor

9.2 The Indirect Command Processor
When processing an indirect command file, Indirect first reads the command
file and interprets each command line either as a command to be passed
directly to DCl or as a request for action by Indirect. The directives for
Indirect are distinguished by a period (.) as their beginning character.
The Indirect directives allow you to perform the following functions:
•

Define and assign values to logical, numeric, and string symbols (see
Section 9.4 for more information on symbols)

•

Substitute a symbols's value into any line of the command file

•

Perform arithmetic

•

Manipulate strings

•

Display text on the user's terminal

•

Ask questions of a user

•

Control the sequence of execution of a command file

•

Call subroutines

•

Detect error conditions

•

Test symbols and conditions

•

Create and access data files

•

Parse commands and data

•

Enable or disable any of several operating modes

•

Control time-based and parallel task execution

•

Expand logical name assignments

These functions are described throughout Section 9.6, Description of
Indirect Directives.
Two directives, .BEGIN and .END, allow you to block-structure the
command file and create Begin-End blocks. Modular, block-structured
command files are easier to debug and maintain. More importantly, BeginEnd blocks isolate local symbol definitions as well as labels and thus
conserve symbol table space.

The Indirect Command Processor 9-3

When you define a symbol, Indirect creates an entry for the definition
in an internal symbol table. Generally, symbol table entries retain their
definitions under the following conditions:
•

If defined locally, throughout the execution of the command file.

•

If defined globally, throughout the execution of all levels of nested
command files (a dollar sign ($) at the beginning of the symbol
indicates a global symbol).

When defined within a Begin-End block, however, local symbols retain
their definitions only throughout the execution of the commands within
that block. The symbols are erased from the symbol table when Indirect
encounters the .END directive at the end of the block.
One Indirect directive, .ENABLE GLOBAL (see Section 9.6.12), and a
switch, ILO (see Section 9.5), allow the definition of some symbols as
global to all file levels. If symbols are not global, each time Indirect enters
a deeper level, it masks out of the symbol table all symbols defined by
the previous level so that only the symbols defined in the current level
are available for use by that level. When control returns to a previous
level, the symbols defined in that level become available once again and
the ones from the lower level(s) are lost.
When Indirect reaches the end of the highest-level indirect command file,
it displays the message
• G <EOF>
and then exits. (The message is not displayed if the .DISABLE DISPLAY
directive is in effect. See Sections 9.6.11 and 9.6.12.)
Indirect displays on the requesting terminal every DCL command line as
it is executed. However, if Indirect is activated by @filename/NOCLI, the
DCL command lines are displayed but not executed. (See Section 9.5 for
information on the I[NO]CLI switch.)
A command file can also include comments. Comments can be placed
at different locations in the file and require different preceding characters
depending on how you want Indirect and DCL to treat them. Following
are the three formats for comments:
;comment
Comments at beginning of line to be displayed by DCL
!comment

Comments after the start of a DCL command line

.;comment

Comments that will not be displayed

9-4 The Indirect Command Processor

Indirect attaches the terminal while processing contiguous comment lines
that begin with a semicolon. This allows you to type CTRl/O and suppress
a lengthy comment. Output is resumed by typing another CTRl/O or is
resumed at the next DCl command line or Indirect directive statement in
the command file.
Note that no command or comment lines are displayed if .ENABlE QUIET
is in effect (see Section 9.6.12).
When Indirect processes a .ENABlE QUIET statement, it forces a
detachment (if detach mode is enable, which is the default) because it
no longer needs the terminal for processing. Once quiet mode has been
established, no attempts are made to reattach the terminal.
Any DCl command line issued by Indirect also causes an unconditional
detachment. This action prevents a task, which may need the terminal,
from suspending activity because the terminal is attached by Indirect.
A .DISABlE QUIET statement establishes terminal I/O but does not
attempt to detach the terminal. See Section 9.6.12 for more information.
If you do not specify a file name in the initial command line, Indirect
can construct the name of a default file to be opened. The default file is
named INDINlxxx.CMD, where xxx either is null or is the 3-character task
name under which Indirect is installed. Note, however, that this facility is
usually disabled. To enable it, the value in the build file for the Indirect
task must be changed.
If a specified command file cannot be found in the current directory,
Indirect can also search for the file in another directory. However, to
enable this facility, the value D$CUIC in the build file for the Indirect task
must be changed to be nonzero. If the new value is 1, Indirect searches
for the file in lB:[1ibuic]. If the new value is greater than 377(8), Indirect
considers it to be the octal equivalent of the UIC (on lB:) to be searched.
For example, if you issue the command @ABC.CMD but Indirect cannot
find the file in the current directory, then, if the value of D$CUIC is set to
[303,54], Indirect searches that directory for the file.

The Indirect Command Processor 9-5

9.3 Summary of Indirect Directives
The Indirect directives described later in this chapter are listed here by
category. A detailed description of each directive is given in alphabetical
order in Section 9.6.
Category

Function

Label Definition
.label:

Assigns a name to a line in the command file so
that the line may be referenced elsewhere within
the file by a .GOTO or .GOSUB directive.

Symbol Definition
.ASK

Prompts for user input to define or redefine a
logical symbol and assign the symbol a true or
false value.

.ASKN

Prompts for user input to define or redefine a
numeric symbol and assign the symbol a numeric
value.

.ASKS

Prompts for user input to define or redefine a string
symbol and assign the symbol a character string
value.

.ERASE

Deletes all local or global symbol definitions or a
single global symbol definition.

.SETT
.SETF

Defines or redefines a logical symbol and assigns
the symbol a true or false value .

.SETN

Defines or redefines a numeric symbol and assigns
the symbol a numeric value.

.SETD
.SETO

Redefines the radix of a numeric symbol.

.SETL

Defines or redefines a logical symbol and assigns
the symbol a true or false value.

.SETS

Defines or redefines a string symbol and assigns
the symbol a character string value.

.TRANSLATE

Expands a logical name translation into the special
symbol <EXSTRI>.

9-6 The Indirect Command Processor