Digital PDFs

AA-L670A-TC

April 1983

204 pages

Original

7.9MB

Document:	RSX-11M/M-PLUS RMS-11 Utilities
Order Number:	AA-L670A-TC
Revision:	0
Pages:	204
Original Filename:	http://bitsavers.org/pdf/dec/pdp11/rsx11m_plus/RSX11Mplus_V3.0_Jul85/AA-L670A-TC_RSX-11M-PLUS_V2.1_RMS-11_Utilities_Apr83.pdf

OCR Text

RSX-11 M/M-PLUS
RMS-11 Utilities
Order No. AA-L670A- TC

April 1983
This document describes the RMS-11 utility programs: RMSDES,
RMSIFL, RMSCNV, RMSDSP, RMSBCK, and RMSRST. RMSDEF,
which has been superseded by RMSDES, is also described in
an appendix.

SUPERSESSION/UPDATE INFORMATION:

This is a new manual for
this release. It replaces
Chapter 9 of the RMS-11
User's Guide, Version 1.8.

OPERATING SYSTEM AND VERSION:

RSX-11 M Version 4.1
and RSX-11 M-PLUS
Version 2.1

SOFTWARE VERSION:

RMS-11 Version 2.0

digital equipment corporation · maynard, massachusetts

First Printing, April 1983
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
licE~nse.

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.

The postpaid READER'S COMMENTS form on the last page of this document
requests the user's critical evaluation to assist in preparing future
documentation.
The following are trademarks of Digital Equipment Corporation:
DEC
DEC/CMS
DEC/MMS
DECnet
DECsystem-10
DECSYSTEM-20
DECUS
DECwriter

DIBOL
Edusystem
lAS
MASSBUS
PDP
PDT
RSTS

RSX
UNIBUS
VAX
VMS
VT

mamaama
ZK2l69

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-6146 (all other Canadian)

DIRECT MAIL ORDERS (USA & PUERTO RICO)·
Digital Equipment Corporation
P.O. Box CS2008
Nashua, New Hampshire 03061

DIRECT MAIL ORDERS (CANADA)
Digital Equipment of Canada Ltd.
940 Belfast Road
Ottawa, Ontario K1G 4C2
Attn: A&SG Business Manager

DIRECT MAIL ORDERS (INTERNATIONAL)
Digital Equipment Corporation
A&SG Business Manager
c/o 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

Pa.ge
PREE'ACE

vii

SUMMARY OF TECHNICAL CHANGES

CHAPTER 1

INTRODUCTION

CHAPTER 2

RMS-11 FILE DESIGN UTILITY:

2.1
2.1.1
2.1.2
2.2
2.2.1
2.2.2
2.2.3
2.2.4
2.2.5
2.2.6
2.2.7
2.2.8
2.2.9
2.2.10
2.2.11
2.2.12
2.3
2.3.1
2.3.1.1
2.3.1.2
2.3.2
2.3.2.1
2.3.2.2
2.3.3
2.3.3.1
2.3.3.2
2.3.4
2.3.4.1
2.3.4.2
2.4
2.5
2.6
2.6.1
2.6.2
2.6.3
2.6.4
2.6.4.1
2.6.5

RMSDES

INVOKING AND TERMINATING RMSDES
• . • •
• 2-2
Invoking RMSDES to Create a Data File from an
Existing File
• . • • . • • • •
• • 2-3
Invoking RMSDES Using Indirect Command Files • • 2-3
RMSDES COMMANDS
• 2-4
CLEAR Command
• 2-6
CREATE Command •
•• • •
2-7
CTRL/Z Command
. • • 2-9
ESC Command
2-9
EXIT Command •
• • • • • . 2-9
GET Command
• . • • •
2-10
HELP Command • •
2-11
QUIT Command •
• • • •
2-12
SAVE Command • . • • • •
2-13
SET Command
• . . • • • • • . • • • • • • • • 2-13
SHOW Command •
••• •
2-15
SHOW 10 Command
••••
2-16
USING THE RMSDES BUFFER TO DESIGN FILES
2-16
Setting Attribute Values • • . • • • •
2-20
Setting Individual Attribute Values
• • • .
2-21
Setting Attribute Values in Sections • • • •
2-21
Setting Attribute Values Using External Files
2-24
Setting Attribute Values from a Description
File . . . . . . . . . . . . . . . . . . . .
2-24
Setting Attribute Values from a Data File
2-25
Clearing Attribute Values
• • • • • • • • • • 2-25
Clearing Individual Attribute Values •
2-26
Clearing Attribute Values in Sections
2-26
Showing Attribute Values • • • • • • • •
2- 26
Showing Individual Attribute Values
2-:26
Showing Attribute Values in Sections • •
2-27
SAVING THE FILE DESIGN • • •
2-:27
CREATING AN EMPTY DATA FILE
2-:28
SECTIONS AND ATTRIBUTES
2-:29
System Section
2-:30
File Section •
2-31
Record Section
2-36
Key Section
2-38
Key Segments
2-'~1
Area Section •
2-42
iii

CONTENTS
Page
2.7
2.8
CHAPTER 3
3.1
3.2
3.3
3.3.1
3.3.2
3.3.3
3.4
3.4.1
3.4.2
3.4.3
3.4.4
3.4.5
3.4.6
3.5
3.6
CHAPTER 4
4.1
4.2
4.3
4.4
4.4.1
4.4.1.1
4.4.1.2
4.4.1.3
4.4.2
4.4.2.1
4.4.2.2
4.4.2.3
4.5
CHAPTER 5
5.1
5.2
5.3
5.4
CHAPTER 6
6.1
6.2
6.3
6.3.1
6.3.2
6.3.3
6.4
6.4.1
6.4.2
6.4.3
6.4.4
6.5

RMSDES EXAMPLES
RMSDES MESSAGES

2-47
2-52

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

INVOKING AND TERMINATING RMSIFL
• • • • •
RMSIFL COMMAND STRING
• • • •
RMSIFL SWITCHES
• • • •
Global Switch
• • • • • •
Output File Switches • • • • • •
• • • • •
Input File Switches
RMSIFL PROCESSING
• • • •
Checking the Command String
. • ••• •
Reading and Sorting the Input Records
Loading Records in the Output File • • • • • •
Sorting the Alternate Key Temporary File • • •
Building the Alternate Indexes . . . • • • • •
Terminating Processing • • • • • • • • •
CALCULATING TEMPORARY FILE WORK SPACE
RMSIFL EXAMPLES
• . . • • • . • • . • .
RMS-ll FILE CONVERSION UTILITY:

• 3- 2
• 3-3
3-5
• 3- 5
• 3- 5
3-7
• 3-9
• 3-9
• 3-9
3-10
3-11
3-12
3-12
3-12
3-14

RMSCNV

INVOKING AND TERMINATING RMSCNV
· • 4-3
RMSCNV COMMAND STRING
· 4-4
RMSCNV SWITCHES
•. . • • • • •
• 4-7
RMSCNV PROCESSING
4-14
Output File Organization and RMSCNV Processing 4-15
Sequential Output File Organization
•.••
4-15
Relative Output File Organization
••••.
4-15
Indexed Output File Organization . • • . • •
4-15
Input File Organization and RMSCNV Processing
4-16
Sequential Input File Organization .
4-16
Relative Input File Organization •
4-16
Indexed Input File Organization
4-16
RMSCNV EXAMPLES
. • • • • • • • • . . . • .
4-16
RMS-ll FILE DISPLAY UTILITY:

RMSDSP

INVOKING AND TERMINATING RMSDSP
RMSDSP COMMAND STRING
RMSDSP SWITCHES
• . . •
RMSDSP DISPLAYS
. • • •
THE RMS-ll FILE BACK-UP UTILITY:

· .
• • • •
• • • • • • • •
• • • •
•
RMSBCK

INVOKING AND TERMINATING RMSBCK
RMSBCK COMMAND STRING
RMSBCK SWITCHES
• • • •
•
Global Switches
·
Output File Switches .
Input File Switches
RMSBCK PROCESSING
• • • •
Explicit and Implicit Input File Specification
Data Integrity Checking
Extended Diagnostic Messages .
Summary Listing
RMSBCK EXAMPLES
•• . . • • • . .

5-2
5- 3
5- 4
5- 5

•
·
•
•

6-2
6-3
6-5
6-5
6-6
• 6-8
• 6-8
• 6-9
• 6-9
6-10
6-10
6-10

CONTENTS
Page
CHAPTER 7
7.1
7.2
7.3
7.3.1
7.3.2
7.3.3
7.4
7.4.1
7.4.2
7.4.3
7.4.4
7.4.5
7.4.6
7.5
APPENDIX A
A.l
A.2
A.3
A.3.1
A.3.2
A.4
A.4.1
A.4.2
A.4.3
A.4.4
A.4.5
A.4.6
A.4.7
A.4.S
A.5

RMS-ll FILE RESTORATION UTILITY:

RMSRST

INVOKING AND TERMINATING RMSRST
RMSRST COMMAND STRING
• • • • • .
RMSRST SWITCHES
Global Switches
•••• • •
Output File Switches •
Input File Switches
RMSRST PROCESSING
• • • •
Explicit and Implicit Input File
Choice of Restoration Account or
Intersystem File Transfer
Data Integrity Checking
Extended Diagnostic Messages
Summary Listing
RMSRST EXAMPLES
• • • • • • • • .

• • • 7-2
. . . . . 7-3
· . . . . 7- 5
• • • • ••
7- 5
• 7-7
• • • 7-S
• • 7-9
Specification 7-10
Volume
7-10
7-10
7-11
7-11
7-12
• • •
7-12

RMS-ll FILE DEFINITION UTILITY:

RMSDES AREA DEFINITION

APPENDIX C

RMS-ll COMMAND UTILITIES MESSAGES

C.l
C.2
APPENDIX D

RMSDEF

PURPOSE
•• • • • • • • • • • • •
EFFECT • • • • • • •
CALL AND TERMINATION •
Calling the Utility • • • • •
Terminating the Utility • • • •
PROCESS
••••• • • • • • • •
Command File • • •
File Specification • • • • • •
Data Structure •
••• •
Key Definition • •
File Structure • •
Data Allocation
Pro tect i on • •
File Creation
RMSDEF MESSAGES

APPENDIX B

• A-l
• • • • • A-l
• • • A-5
A-5
A-5
• A-5
• A-5
• A-7
• • • A-S

• • • •

A-IO

• • • •
• • • •

A-13
A-16
A-1S
A-19
A-20

RMSCNV, RMSDSP, RMSBCK, AND RMSRST ERROR MESSAGES C·-2
RMSIFL ERROR MESSAGES
••••••
• • • • C-17
SORT ROUTINE ERROR CODES

INDEX

EXAMPLES
EXAMPLE 5-1
5-2
5-3
5-4
5-5
5-6
5-7

RMSDSP Display
RMSDSP Display
RMSDSP Display
RMSDSP Display
Specified) • •
RMSDSP Display
RMSDSP Display
RMSDSP Display
Spec if i ed) • •

Format
Forma t
Format
Format

for
for
for
for

Disk Sequential Files
• 5-5
Rela t i ve Fi les • • • • • 5--6
Indexed Files
• • • • • 5-6
Indexed Files (with /FU
•

Format for Magnetic Tape Files
for Back-Up Files • • • • • • •
Format for Back-Up Files (with /FU

•

5-- 6

5--7
5--7
5--S

CONTENTS
Page
5-8

RMSDSP Display Format Using Wildcard Characters

• 5-8

FIGURES
FIGURE

4-1
A-1

Using RMSCNV with DECnet • •
RMSDEF Processing Flowchart

· • 4-2
• . • A-4

TABLES
TABLE

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

2-4
· · · · · · . . . . · · · · · · ·2-18
3-4
····
·····
4-6
····
5-4
· · · · · · · 6-4
.
.
······
. ·· ·· ·· · · ·· ·· 7-4
· · · ·

RMSDES Commands
RMSDES Section and Attribute Keywords
RMSIFL Switches
RMSCNV Switches
RMSDSP Switches
RMSBCK Switches
RMSRST Switches

PREFACE

MANUAL OBJECTIVES
This reference manual describes the utility programs supported
Record Management Services for PDP-II operating systems (RMS-ll).

INTENDED AUDIENCE
This manual is intended for users who either do not require or do not
have
access
to full
RMS-ll capabilities:
high-level
language
programmers, and nonprogramming users such as system managers and
operators.

STRUCTURE OF THIS DOCUMENT
This document is organized into seven chapters and four appendixes:

• Chapter 1, Introduction
• Chapter 2, RMS-ll File Design Utility: RMSDES
• Chapter 3, RMS-ll Indexed File Load Utility: RMSIFL
• Chapter 4, RMS-ll File Conversion utility: RMSCNV
• Chapter 5, RMS-ll File Display Utility: RMSDSP
• Chapter 6, RMS-ll File Back-Up Utility: RMSBCK
• Chapter 7, RMS-ll File Restoration Utility: RMSRST
• Appendix A, RMS-ll File Definition Utility: RMSDEF
• Appendix B, RMSDES Area Definition
• Appendix C, RMS-ll Command Utilities Messages
• Appendix D, Sort Routine Error Codes
ASSOCIATED DOCUMENTS
To use the RMS-ll utilities, you should be familiar with the concepts
and user information in RSX-IIM/M-PLUS RMS-ll:
An Introduction and
the RSX-IIM/M-PLUS RMS-ll User's GUIde.
The introductIon presents the
majoi concepts of RMS-ll, and the user's guide provides detailed user
information for programmers who want to use RMS-ll,
from eithE~r
high-level language programs or MACRO-II programs.

vii

PREFACE
In addition, RSX-llM/M-PLUS RMS-ll Macro Programmer's Guide provides
programmer informatlon on RMS-ll operations for MACRO-II programmers;
and the RSX-llM/M-PLUS RMS-ll Mini-Reference Insert summarizes,
for
easy reference, the RMS-ll utilities and error codes.

CONVENTIONS USED IN THIS DOCUMENT
Convention

Meaning

UPPERCASE WORDS
AND LETTERS

Uppercase words
and
letters
examples indicate that you should
word or letter exactly as shown.

lowercase words
and letters

Lowercase words and letters used in examples
indicate that you are to substitute a word or
value of your choice.

quotation marks (")
apostrophes (')

The term "quotation marks" refers to double
quotation marks ("). The term "apostrophe"
refers to a single quotation mark (').

[

Square brackets indicate
item is optional.

]

{}

that

Braces are used to enclose lists
one element is to be chosen.

used
type

the

in
the

enclosed

from

which

A horizontal ellipsis indicates that the
preceding item(s) can be repeated one or more
times.
For example:
file-spec[,file-spec •.• ]
A vertical ellipsis indicates that not all of
the statements in an example or figure are
shown.
DES: SHOW FILE
ATrrRIBUTE: NAME

In examples of commands you enter and system
responses, all output lines and prompting
characters that the system prints or displays
are shown in black letters.
All the lines
that you type are shown in red letters.
A
symbol
with
a
1to
3-character
abbreviation indicates that you press a key
on the terminal.
The symbol CTRL/x
indicates that you must
press
the
key
labeled CTRL while you
simultaneously
press
another
key
(for
example,
<CTRL/C>,
<CTRL/Y>, <CTRL/O».
In
examples, this control key sequence is shown
as AX (for example, AC, Ay , AO) because that
is how the system
echoes
control
key
sequences.

Unless otherwise noted, all numeric values are represented in
notation.
Unless otherwise specified, you terminate
RETURN key.

viii

commands

decimal

pressing

the

SUMMARY OF TECHNICAL CHANGES

The RMS-II File Design Utility (RMSDES) is a new utility that allows
you to interactively design and create files.
RMSDES supersedes the
RMS-II File Definition utility (RMSDEF).
The RMS-II File Display Utility
(RMSDSPY provides more information
about magnetic tape files and about back-up files on disk and on
magnetic tape (container files), and provides an optional detailed
display for back-up files.
The displays also appear in a more
readable format, and the size field shows both the allocated and used
sizes of the file.
The /DE switch to the RMS-II Indexed File Load Utility
(RMSIFL)
has
been enhanced to allow specification of a different device for
RMSIFL's temporary files.
The /SL switch to the RMS-II File Conversion utility
(RMSCNV),
the
File Back-Up Utility
(RMSBCK),
and the File Restoration Utility
(RMSRST) has been modified to append summary listings of processing to
a single file if that file exists.
Five switches have been added to the RMS-II File Conversion utility
(RMSCNV) :
the /CA switch,
the /EO switch, the /IM switch, the /KN
switch, and the /ML switch. The /CA switch creates an output file
with the attributes of an existing file;
the /EO switch changes ASCII
stream files that end with a CTRL/Z character to end with null
characters;
the /IM switch reads and writes records in block mode;
the /KN switch reads an indexed file using a key name;
and the /ML
switch explicitly sets the limit of memory allocation.
The /PD switch
no longer requires a number sign (#) before an octal padding character
or quotation marks around an ASCII padding character unless it is
lowercase, a space, or a tab.
In addition, RMSCNV file conversion operations can now specify files
on remote nodes.
On systems with DECnet network capabilities and on
which RMSCNV has Data Access Protocol
(DAP)
support,
RMSCNV file
conversions can take place not only locally, but over the network as
well.
You can convert files between a local and a
remote node, or
between two remote nodes.
One switch has been added to the RMS-II File Restoration utility
(RMSRST) :
/CV.
The /CV switch converts file version numbers from
octal to decimal for files created and backed up on RSX-IIM/M-PLUS
sysbems and restored to VAX/VMS systems;
and from decimal to octal
for files created and backed up on VAX/VMS systems and restored to
RSX-IIM/M-PLUS systems.
All utilities now display information in lowercase letters, and the
error message format for all utilities
(except RMSDEF) has been
changed (see Appendix C).

CHAPTER 1
INTRODUCTION

RMS-ll utilities allow you to define, manipulate, and maintain RMS-ll
files.
The utilities are provided as
independent tasks and are
designed for users -- for example, high-level language programmers,
system managers and operators -- who either do not require or do not
have access to the full RMS-ll capabilities.
The RMS-ll utilities are:
•

RMS-ll File Design utility (RMSDES)
RMSDES allows you to design and create indexed,
sequential,
and
relative
files.
You can either specify the file
attributes interactively or read
in the attributes of an
existing, external data file that you want to re-create with
little or no modification.

•

RMS-ll Indexed File Load utility (RMSIFL)
RMSIFL reads records from any type of RMS-ll
them into an indexed file.

•

file

and

loads

RMS-ll File Conversion Utility (RMSCNV)
RMSCNV reads records from an RMS-ll file of any type and loads
them into another RMS-ll file of any type.

•

RMS-ll File Display Utility (RMSDSP)
RMSDSP displays a concise description of any RMS-ll file,
including RMS-ll back-up files on disk or on magnetic tape
(container files).

•

RMS-ll File Back-Up Utility (RMSBCK)
RMSBCK transfers the contents of any RMS-ll disk file to
another disk or to magnetic tape to maintain the file should
the original file be lost or damaged.

•

RMS-ll File Restoration Utility (RMSRST)
RMSRST transfers, to disk,
files
that
magnetic tape or disk using RMSBCK.

•

were

backed

RMS-ll File Definition Utility (RMSDEF)
RMSDEF allows you to define the attributes of a file.
Although this utility has been superseded by the RMSDES
utility, it is available to users and
is documented in
Appendix A.

1-1

INTRODUCTION
Help Text and Error Messages. The interactive utilities
(RMSDES and
RMSDEF)
provide error messages and help text for each prompt for
input. The command utilities (RMSIFL,
RMSCNV,
RMSDSP,
RMSBCK, and
RMSRST)
each have a single help text and share a set of common error
messages.
The command utilities' error messages are documented in
Appendix C.
RMSDES and RMSDEF error messages are documented in
Chapter 2 and Appendix A, respectively.
Intersystem
File
Transfer. On
systems
with
DECnet
network
capabilities and on which RMSCNV has Data Access Protocol (DAP)
support, RMSCNV file conversions can take place not only locally, but
over the network as well. You can convert files between a local and a
remote node, or between two remote nodes.
For example, working on an RSX-llM/M-PLUS system, you can convert
files
to which you have access between your system and another
RSX-llM/M-PLUS system.
Or, you can convert
files
from
your
RSX-llM/M-PLUS system to either a RSTS/E or VAX/VMS system, or between
a RSTS/E system and a VAX/VMS system.
See the RSX-llM/M-PLUS RMS-ll User's Guide for more information on
RMS-ll remote access capabilities. See Chapter 4 for more information
on RMSCNV.
You can also use RMSBCK and RMSRST to transport files between
different systems.
RMSBCK preserves the RMS-ll file attributes when
you back up files to disk or magnetic tape;
the file can thus be
transported and restored, using RMSRST, to another operating system.
See Chapter 7 for more information on restoring files to different
operating systems.
Note that you can use RMSDSP to display an RMS-ll back-up file's
attributes and determine which operating system the file was created
and backed up on. See Chapter 5 for more information on RMSDSP.

1-2

CHAPTER 2
RMS-ll FILE DESIGN UTILITY:

RMSDES

The RMS-ll File Design Utility (RMSDES) is an interactive utility that
allows you to design and create RMS-ll files to contain data records.
You design a file by defining the file's attributes. When you create
a :Eile, a file is built that has those attributes and can store data
records as required by your program(s).
To design a file using RMSDES, you issue RMSDES commands to set,
resE~t,
clear, and display file attribute values in the RMSDES design
buffer.
This is called a design session. The attributes consist of
the standard RMS-ll attributes, such as file organization and record
format, plus some additional,
informational attributes required by
RMSDES, such as target system.
The design buffer is an RMSDES work space that you use to design your
files.
It is divided into five sections:
system, file, record, key,
and area.
Each section defines a group of file attributes.
For
example, in the file section, you define attributes such as file name,
organization, and owner~
in the record section, you define attributes
such as record size, format, and carriage control.
The functional grouping of attributes in the design buffer makes it
easy to define,
change, or display any attribute or group of
attl~ibutes.
See Section 2.6 for a complete description of each buffer
section and the file attributes defined in each section.
You gain access to the design buffer and initiate a design session
when you invoke RMSDES.
At the beginning of a design session, the
filE~ attributes are initialized to RMS-ll default values.
You can set
filE~
attributes either interactively from your terminal by using the
SET command, or from an external file by using the GET command.
If you are designing your file interactively, you can
either
explicitly set the attributes to values that you specify, or you can
accept the default values.
If you are designing an indexed file,
you
can either explicitly define areas or allow RMSDES to define them by
default.
If you use the SET command to design a file interactively, you will be
prompted for attribute values.
RMSDES prompting is conditional~
you
are prompted only for attributes that pertain to your file design.
For example, you will be prompted for cluster size only if you have
set the target system to RSTS/E.
If you are designing a file using an external file,
RMSDES sets the
attribute values
in the design buffer to match those in the external
filE~.
This is useful if you want to duplicate an existing file's
design.

2-1

RMS-ll FILE DESIGN UTILITY:

RMSDES

You can display file attributes by using the SHOW command.
You can
change attribute values at any time during the design session by using
either the SET command (to set a new value) or the CLEAR command
(to
restore the default value).
You can save the file design in a description file by using the SAVE
command, or you can create an empty data file by using the CREATE
command.
Throughout a design session, you can get online assistance by typing a
question mark (?) or the HELP command.
Sections 2.1 and 2.2 describe how to invoke and terminate RMSDES and
how to use the RMSDES commands.
Section 2.3 describes how to use the
design buffer to design a file.
Sections 2.4 and 2.5 describe saving
designs and creating empty data files.
Section 2.6 describes the
buffer sections and file attributes.
This chapter also provides examples (Section 2.7)
RMSDES messages (Section 2.8).

2.1

and

documents

the

INVOKING AND TERMINATING RMSDES

RMSDES can be either installed or
installed, invoke it with the command:

uninstalled.

RMSDES

DES
If RMSDES is uninstalled on RSX-IIM/M-PLUS systems, invoke it with the
MCR command:
RUN $RMSDES
RMSDES will respond with the prompt:
DES:
You can now type any of the RMSDES commands.
You can install RSMDES with another name as follows:
INS $RMSDES/TASK= •.• xxx
where xxx is a 3-character name that you chose for the
utility will then prompt:

utility.

The

xxx>
To terminate RMSDES, type one of the following commands in response to
the DES: prompt:
QUIT
<CTRL/Z>
EXIT file-spec
The QUIT and CTRL/Z commands terminate RMSDES, and the system prompt
is returned.
Unless you have saved the file design or created an
empty data file, the information in your design buffer will be lost.

2-2

RMS-11 FILE DESIGN UTILITY:

RMSDES

The EXIT command saves the file design in the specified
terminates RMSDES, and the system prompt is returned.

file,

Section 2.2 describes the RMSDES commands and their formats.

2.1.1

Invoking RMSDES to Create a Data File from an Existing File

You can also invoke RMSDES to create an empty data file from an
existing description or data file by typing the following in response
to the system prompt:
DES filename[.typ]

[kind]

The default file type is .DES. The file kind is either DES
(for a
description file)
or DAT (for a data file).
The default kind is DES
and need not be specified. After this command is executed, the system
prompt will be returned.
The file that is created will have the same attributes as the external
file.
If the external file is a description file, the newly created
file will have the same file name and type that are set in the
description file.
If no file name and type are specified in the
description file, the file will be created as FILE.DAT.
If the external file is a data file, the new data file will have the
same file name and type as the existing file and a version number 1
higher than the existing data file.
See also Sections 2.3.2 and 2.5 for more information on using external
files and on creating empty data files.

2.1.2

Invoking RMSDES Using Indirect Command Files

You can execute series of RMSDES commands by means of indirect command
filles.
The commands in an indirect command file are executed when an
at sign (@) followed by the file's name is specified to the utility.
The default file type of .CMD is assumed if none is provided.
Installed RMSDES will accept indirect command files either from the
system prompt or from the utility prompt. For example, to execute the
co~nands in the indirect command file DESCOM.CMD, you could type:
DES @DESCOM
or
DES: @DESCOM
Uninstalled RMSDES will accept indirect command files
utility prompt.
For example:
DES:

only

from

the

@DESCOM

RMSDES will access the indirect command file and execute the commands.
If you executed the indirect command file from the system prompt, the
system prompt will be returned.
If you executed the indirect command file from within RMSDES, the DES:
prompt will be returned, so you can continue the design session, if
desired.
Note, however, that any attributes that were set or reset as
a
result of executing the indirect command file from within RMSDES
will remain set in the design buffer.

2-3

RMS-ll FILE DESIGN UTILITY:

RMSDES

You can issue a SHOW ALL command after indirect command file execution
to determine the attribute settings in the design buffer.
You might
also want to include a CLEAR ALL command at the end of the
indirect
command
file
so that all the attributes are reset to their initial
default values at the end of indirect command file execution.
You cannot nest indirect command files run from RMSDES;
that
indirect command
file cannot contain a command calling
indirect command file.

is,
an
another

You can include comments, using semicolons (;) or exclamation points
(1),
in indirect command files run from either the system prompt or
the utility prompt.

2.2

RMSDES COMMANDS

Table 2-1 summarizes the RMSDES commands,
their formats,
and their
functions.
You can abbreviate commands as long as the characters
typed uniquely identify the command.
The sections that follow Table 2-1 describe
formats, in alphabetical order.
Table 2-1:
Command
CLEAR

the

commands

and

their

RMSDES Commands
Format and Function

CLEAR ALL
Restores all attribute
their default values.

values

all

sections

CLEAR section ALL
Restores all attribute values
section to their default values.

the

specified

CLEAR section attribute
Restores the specified attribute value
specified section to its default value.
CREATE

the

CREATE [filename[.typ]]
Creates an empty data file that has
the attribute
values specified
in the design buffer.
For indexed
files in which areas are not defined,
prompts
for
whether areas are to be defined by default.
If you do not specify a file name and
type,
the file
will have those specified in the design buffer.
If you
did not specify a file name and
type
in the design
buffer, the file will be created as FILE.DAT.

CTRL/Z

<CTRL/Z>
Terminates RMSDES without saving the design or creating
an empty data file.
(continued on next page)

2-4

RMS-11 FILE DESIGN UTILITY:
Table 2-1 (Cont.):
Command
ESC

RMSDES

RMSDES Commands

Format and Function
<ESC)
In response to any prompt, returns the
and preserves all attribute values
buffer.

EXIT

DES:
prompt
in the design

EXIT filename[.typ]
Stores the file design
in the description file
specified in the command line and terminates RMSDES.
The default file type is .DES.

GET

GET filename [ • typ]

[ki nd]

Reads the file design specified
in a description
file,
and sets the appropriate attribute values in
the design buffer.
Reads the attribute values of a
data file, and sets the appropriate attribute values
in the design buffer. The default file kind is DES.
If the file is a data file, kind must be specified:
OAT.
HELP
Lists all available help topics and gives
for displaying the text.

instructions

HELP COMMANDS
Lists the valid commands for which help is available.
HELP command
Displays help text for the specified command.
HELP SECTIONS
Lists all available help topics for all sections
gives instructions for displaying the text.

and

HELP section
Lists all available help topics for all
the specified section.

attributes

HELP section attribute
Displays help text for the specified attribute
specified section.

the

Displays help text for the section, attribute, or value
for which you are being prompted.
(continued on next page)
1. E'or any form of the HELP command, you can type a question mark
(?)
instead of HELP.
Note that you can type the HELP form only in
response to the DES:
prompt.
2-5

RMS-11 FILE DESIGN UTILITY:
Table 2-1 (Cont.):
Command
QUIT

RMSDES

RMSDES Commands

Format and Function
QUIT
Terminates RMSDES,
without storing
creating an empty data file.

SAVE

the

design

SAVE filename[.typ]
Stores the file design
in the description file
The default file type
specified in the command line.
is .DES.

SET

SET ALL
Prompts for setting all attribute values
in all
sections.
For
indexed files in which areas are not
defined, prompts for whether areas are to be defined
by default.
SET section ALL
Prompts for setting
specified section.

all

attribute

values

the

SET section attribute value
Sets the specified attribute value in
section.
SHOW

the

specified

SHOW ALL
Displays all attribute values in all sections.
SHOW section ALL
Displays
section.

all

attribute

values

specified

the

attribute

value

the

patch

level

SHOW section attribute
Displays the specified
specified section.
SHOW ID

SHOW ID
Identifies the current version
RMSDES.

2.2.1

and

CLEAR Command

The CLEAR command restores attribute values in the design buffer
to
their
initial default values.
You can clear attribute values for all
sections, for one section, or for one attribute.
You should clear all sections after you have saved or created a
file;
the buffer will then be ready to accept a design for another file.

2-6

RMS-ll FILE DESIGN UTILITY:

RMSDES

Format
CLEAR { ALL
}
section ALL
section attribute
ALL
Restores all attribute values in all sections
default values.

their

initial

section ALL
Restores all attribute values in the specified section to their
default values.
Section must be one of the section keywords
listed in Table 2-2 (Section 2.3).
Note that for
this form of
the command, you must type "ALL" in full ("AL" and "A" are legal
abbreviations for the Allocate attribute).
section attribute
Restores the specified attribute value in the specified section
to its initial default value.
Section and attribute each must be
one of the keywords listed in Table 2-2 (Section 2.3).
After RMSDES executes a CLEAR command, the DES:
prompt is returned.
If you omit any part of the command string, you will be prompted for
it.
Examples
DES: CLEAR
SECTION: FILE
ATTRIBUTE: ORGANIZATION
DES:
RMSDES prompts for the omitted section
When the keyword
is supplied,
the
(sequential) is restored.
DES:
DES:

and attribute keywords.
default file organization

CLEAR KEY 2 ALL
This command clears all the attribute values in key 2.
Note that
if you have defined multiple keys (or areas), and you issue the
CLEAR command, the keys (or areas) will be renumbered and you
will have one fewer keys (or areas).
For example, if you have defined keys 0 through 4 and you clear
key 2, key 3 will become key 2, and key 4 will become key 3.
Four keys, not five, will now be defined.
If you want to change
the attributes
in a key, you should use the SET command to
replace the previous attribute values with the new ones, without
altering key numbers.

2.2.2

CREATE Command

The CREATE command creates an empty data file that has the attribute
values specified in the design buffer.
The empty data file is capable
of containing data records for use by your programs.

2-7

RMS-ll FILE DESIGN UTILITY:

RMSDES

If you create an indexed file for which you defined areas and/or keys,
the areas and/or keys must be numbered in sequence, starting with o.
RMSDES will create only those areas and/or keys that are numbered
sequentially, starting with O.
For example, if you have defined areas
0, 1, and 3, only areas 0 and 1 will be created when you issue the
CREATE command.
No error will be returned.
You can allow RMSDES to define areas in an indexed file by default.
If you have not defined areas when you issue the CREATE command, you
will be prompted as to whether you want RMSDES to define areas by
default:
Areas defaulted:
If you respond YES or press RETURN (YES is the default),
RMSDES wiLl
prompt for additional
information and define areas based on your
responses and on the number of keys you specified in the key section.
See also Section 2.6.5.
Format
CREATE [filename[.typ]]
filename[.typ]
Names an empty data file that has the attribute values specified
in the design buffer.
If specified, the file name and type in
the command string will supersede those specified in the design
buffer.
The default file type is .DAT.
If you do not specify a file name, the data file will have the
If a file
file name and type specified in the design buffer.
name and type are not specified in either the design buffer or
the command line, the file will be created as FILE.DAT.
After RMSDES executes a CREATE command, the DES:
prompt is returned.
If you want to design another file, you should issue a CLEAR ALL
command to restore the attribute values in the design buffer to their
defaults.
Examples
DES:
DES:

CREATE
This command creates an empty data file, using the file name
type specified in the design buffer.

and

DES:
CREATE PER. lOX
Areas defaulted:
®]
Bucket Size (2):
®]
DES:
This command creates an empty indexed data file called PER.IDX.
Areas were not defined
in the design buffer, so the user is
prompted "Areas defaulted:" and presses RETURN in response.
RMSDES then prompts for bucket size and the user again takes the
default.
RMSDES will define the areas based on a bucket size of
2 and the number of keys specified in the design buffer.

2-8

RMS-ll FILE DESIGN UTILITY:
2.2.3

RMSDES

CTRL/Z Command

The CTRL/Z command terminates RMSDES without saving the file design or
creating an empty data file.
All attribute values in the design
buffer are lost.
Format
<CTRL/Z>
Examples
DES: SET RECORD ALL
Starting RECORD section
Size (0): 1000
Format (Var): 8Nm
The CTRL/Z command, typed in response to the format attribute
prompt, terminates RMSDES.
The system prompt is returned and all
attribute values in the design buffer are lost.

2.2.4

ESC Command

The ESC command, entered in response to any RMSDES prompt, returns the
DES:
prompt and preserves all attribute values in the design buffer.
Format
<ESC>
The ESC command is especially useful when you want to interrupt an
inte·ractive design session. For example, you may want to make changes
to previously set attributes or to resume your design session later.
Typing ESC will return the DES:
prompt and preserve all attribute
values in the design buffer. You can then enter any RMSDES command in
response to the DES:
prompt.
Examples
DES: SET RECORD ALL
Starting RECORD section
Size (0):
1000
Format (Var):
~
DES:
The ESC command,
typed in
prompt,
returns the DES:
design buffer are saved.

2.2.5

response to the format attribute
prompt.
All attribute values in the

EXIT Command

The EXIT command stores your file design in the description file
specified in the command string.
Then, it terminates RMSDES, and the
system prompt is returned.
Formlat
EXIT filename[.typ]

2-9

RMS-ll FILE DESIGN UTILITY:

RMSDES

filename [. typ]
Names the description file in which the
stored.
The default file type is .DES.

file

design

will

Examples
DES:

EXIT
File Name:
If you omit the file specification, you will be prompted for it.

DES:

EXIT PERS
This command stores your file design in a description file called
PERS.DES and terminates RMSDES.
Because the file type, .DES, is
the default, you can omit it from the command line.

2.2.6

GET Command

The GET command sets attribute values in the design buffer based on
the
information it reads from an external file;
that is, a
description file or a data file.
A description file contains a file
design.
A data file contains, or is capable of containing, data
records.
The GET command:
•

Reads the file design specified in a description file and sets
the corresponding attribute values in the design buffer.
(See
also Section 2.3.2.1.)

•

file and sets the
Reads the attribute values of a data
in the design buffer.
(See
corresponding attribute values
also Section 2.3.2.2.)

When you issue a GET command,
RMSDES first
initializes the file
attributes In the design buffer to their default values.
Thus, any
attributes that you may have set before issuing the GET command are
cleared.
Then, RMSDES sets the attribute values in the design buffer
to match those of the external file.
Note, however, that if you specify an indexed data file, RMSDES cannot
access the initial allocation for the areas:
the allocation attribute
for each area will be set to the number of blocks that remain
available in each area of the data file, not to the initial allocation
for each area in the data file.
You can use the SHOW command to
display the setting and then use the SET command to reset the
allocation attribute as necessary.
If the external file is a data file, the file name and type in the
design buffer will be set to those of the existing file.
If you issue
a CREATE command, the new data file will have the same file name and
type as the existing data file and a version number 1 higher than the
existing data file.
Format
GET filename[.typ]
filename[.typ]

[kind]

Reads the file attributes from a description file and sets the
corresponding attribute values in the design buffer.
The default
file type is .DES.
If the description file was created using
RMSDES, you need not specify kind (DES is the default kind).
2-10

RMS-ll FILE DESIGN UTILITY:

RMSDES

GET also reads the attribute values of a data file and sets the
corresponding attribute values
in the design buffer.
You must
specify kind as OAT.
After RMSDES executes a GET command, the DES:

prompt is returned.

Examples
DES :'
DES:

GET FOO
This command reads the file attributes in FOO.DES, a description
file created using RMSDES, and sets the corresponding attribute
values in the design buffer. Because the file type,
.DES, and
kind, DES, are the defaults, they can be omitted from the command
line.

DES::

GET
File Name:

FOO.BAR DAT

DES:
If you omit the file specification, you will be prompted for
it.
This command reads the file attributes in FOO.BAR, a data file,
and sets the corresponding attribute values in the design buffer.

2.2 .. 7

HELP Command

The HELP command displays help text.
You
the command only in response to the DES:
form in response to any other prompt.
In
the command, you can type a question mark
Formats

HELP

COMMANDS
command
SECTIONS
section
section attribute

can type the HELP form of
prompt.
You must type the?
addition, for any form of
(?) instead of HELP.

If you type HELP in response to the DES: prompt, all help topics
and instructions for displaying the text will be given.
COMMANDS
Lists the valid commands for which help is available.
command
Specifies a command for which help text is to be displayed.
Command must be one of the command keywords listed in Table 2-1
(Section 2.2).
SEc~nONS

Lists all section help
displaying the text.

topics

2-11

and

gives

instructions

for

RMS-ll FILE DESIGN UTILITY:

RMSDES

section
Specifies a buffer section for which help text
is to be
displayed.
Section must be one of the section keywords listed in
Table 2-2 (Section 2.3).
section attribute
Specifies an attribute and section for which help text is
displayed.
Section and attribute must each be one
keywords listed in Table 2-2 (Section 2.3).

to be
of the

Displays help text for the section, attribute, or value for which
you are being prompted.
After RMSDES executes any form of the HELP command,
which you issued the command is returned.

the

prompt

from

Examples
DES:

HELP SYSTEM

Section
Keyword
System

Attribute Keyword
and Variable

Default

Target argument
argument must be one of:
RSX
RSTS
Source 1

User's system
User's system

File Placement 2

logical

In response to the HELP SYSTEM command,
RMSDES displays the
system attributes and the default settings for those attributes.
DES:

HELP FILE NAME

Name string
Specifies the name
specification.

the

file.

In response to the HELP FILE NAME
information on the Name attribute.

2.2.8

For

string,

command,

type

RMSDES

file

displays

QUIT Command

The QUIT command terminates RMSDES without creating a description file
or an empty data file.
The attribute values in the design buffer are
lost.

1. Not user-settable;
system.

RMSDES automatically notes

2. Informational attribute.
2-12

the

user's

source

RMS-ll FILE DESIGN UTILITY:

RMSDES

Format
QUIT
After RMSDES executes the QUIT command, the system prompt is returned.

2.2.9

SAVE Command

The SAVE command stores the file
specified in the command string.

design

description

file

Format
SAVE filename[.typ]
filename [ • typ]
Names the description file in which the
saved.
The default file type is .DES.

file

design

will

If you omit any part of the command string, you will be prompted for
it.
After RMSDES executes the SAVE command, the DES: prompt is
returned.
If you want to design another file,
you should issue a
CLElI.R ALL command to restore the attribute values in the design buffer
to their defaults.
Examples
DES:

SAVE
File Name:

FOO.TYP

If you omit the file specification, you will be prompted for it.
DES:
DES:

SAVE Faa
This command stores the file design in the description file
FOO.DES.
Because the file type, .DES, is the default, it can be
omitted from the command line.

2.2.10

SET Command

The SET command sets attribute values in the design buffer.
You can
set an individual attribute value or you can set attribute values for
all sections or for one section.
Note that prompting for attributes
will be conditional based on the target system, file organization, and
record format that you specify (either explicitly or by default). For
example, you will be prompted for cluster size only if you have
specified the target system as RSTS/E.
Form.at
SET

ALL
}
{ sect~on ALL
sectIon attribute value

ALL
Specifies that you want to be prompted for all
in all sections.

2-13

attribute

values

RMS-ll FILE DESIGN UTILITY:

RMSDES

When you reach the area section, you will be prompted
whether you want RMSDES to define areas by default:

Areas defaulted:
If you respond YES or press RETURN (YES is the default),
RMSDES
will prompt for additional information and define areas based on
your responses and on the number of keys you specified in the key
section
(see Section 2.6.4).
Appendix B describes how RMSDES
defines areas by default.
section ALL
Specifies that you want to be prompted for all attribute values
in the specified section.
Section must be one of the section
keywords listed in Table 2-2 (Section 2.3).
Note that if you use
this form of the command, you must type "ALL" in full ("AL" and
"A" are legal abbreviations for the Allocate attribute).
For the key and area sections, you will be asked for the number
of keys or areas you want to define. After you specify the
number of keys or areas, you will be prompted for
the attribute
values of all the keys or areas you specified. See Sections
2.6.4 and 2.6.5.
section attribute value
Specifies that you are setting the specified attribute value
in
the specified section.
Section and attribute each must be
keywords and value must be one of the variables listed in Table
2-2 (Section 2.3).
After RMSDES executes the SET command, the DES: prompt is returned.
If you omit any part of the command string, you will be prompted for
it.
Examples
SET FILE NAME
DES:
VALUE:
If you omit the section or attribute keyword or
will be prompted for it.
DES:
DES:

the

value,

you

SET FILE NAME FOO.BAR
This command names the file FOO.BAR.

DES:

SET ALL
In response to this command, you will be prompted for all
attributes
in all sections.
Note that the prompting will be
conditional;
for example, if you type RSX in response to the
target prompt, you will not be prompted for a cluster size value,
which is required only if the target system is RSTS/E
(see
Section 2.6).

2-14

RMS-11 FILE DESIGN UTILITY:
DES:

RMSDES

SET FILE ALL
In response to this command, you will prompted for all attributes
in the file section.
Note that the prompting for file attributes
will be conditional based on the file organization and format
that you specify.
For example,
if you specify that the file
organization is indexed, you will not be prompted for a magnetic
tape block size value (see Section 2.6).

2.2.11

SHOW Command

The SHOW command displays attribute values.
You can display an
individual attribute value or you can display attribute values for all
sections or for one section.
Note that the display will
be
conditional;
that is, only the attributes for which you were prompted
by the SET command will be displayed
(see Section 2.2.10).
The
display also indicates whether attribute values were set explicitly or
by dlefaul t.
Form,at
SHOW

ALL
}
{ section ALL
section attribute

ALL
Displays all attribute values in all sections.
section ALL
Displays all attribute values in the specified section.
Section
must be one of the section keywords listed in Table 2-2 (Section
2.3).
Note that if you use this form of the command, you must
type "ALL" in full ("AL" and "A" are legal abbreviations for the
Allocate attribute).
section attribute
Displays the specified attribute value.
Section and
must be keywords listed in Table 2-2 (Section 2.3).

attribute

After RMSDES executes the SHOW command, the DES:
prompt is returned.
If you omit any part of the command string, you will be prompted for
it.
Examples
DES: SHOW FILE
AT'rRIBUTE:
If you omit the section, attribute, or value keyword, you will be
prompted for it.
DES:
SHOW FILE NAME
NA1'1E
FOO.BAR
DES:

(Explicit)

This command displays the name of the file,
indicates that the file name was set explicitly.

2-15

FOO.BAR,

and

RMS-11 FILE DESIGN UTILITY:

RMSDES

DES: SET FILE NAME INFILE.DAT
DES: SET FILE ORGANIZATION INDEXED
DES: SHOW FILE ALL
FILE
Name
INFILE.DAT
(Explicit)
Organization
INDEXED
(Explicit)
Allocation
o
Extension
o
Bucket Size
1
Protection
Owner
[303,24]
Max Record Number
o
ContiguousNO
Supersede
NO
This command displays attribute values in the file section.

2.2.12

SHOW ID Command

The SHOW ID command displays
the current version of the RMSDES
utility.
You can type SHOW ID with the DES command (in response to
the system prompt), or in response to the DES:
prompt (after you have
invoked RMSDES).
The last two digits of the version number are the patch level
utility.

the

which

you

Format
SHOW ID
After RMSDES executes the SHOW ID command, the prompt from
issued the command will be returned.
Examples
DES SHOW ID
%DES-I-ID, Version 2.000
Typed in response to the system prompt,
SHOW ID displays
the
RMSDES version number.
The last two digits (00 in this example)
are the patch level.
The system prompt will be returned after
the version number is displayed.
DES: SHOW ID
%DES-I-ID, Version 2.000
DES:
In this example, SHOW ID
is
typed
in response
to the
prompt, which is returned after the command is executed.

2.3

DES:

USING THE RMSDES BUFFER TO DESIGN FILES

The RMSDES design buffer is a work space that you use to design files
and to fine tune your designs.
The design buffer is divided into five
sect ions:
sys tern,
file,
record,
key,
and area.
Each of these
sections contains file attributes that can be set to specific values.

2-16

RMS-11 FILE DESIGN UTILITY:

RMSDES

Table~ 2-2 lists the
attributes grouped within each design buffer
section.
Section 2.6 describes the sections and attributes of the
design buffer in greater detail.

When you begin a design session, all design buffer attributes are
initialized to default values.
Most of the attributes in the design
buffer are RMS-Il file attributes and are initialized to RMS-ll
default values.
Some attributes, however, such as target system, are
informational attributes required by the RMSDES utility.
Table~ 2-2 lists the defaults assigned to each attribute when you begin
a design session and indicates whether the attribute is informational.
In de~signing a file, you can set these attributes to specific values
that you supply,
or you can accept the default values (by pressing
RETURN) •

You can set attribute values interactively by using the SET command.
You ~7ill be prompted conditionally so that you set only the attributes
that pertain to your file design.
For example, if you specify RSX as
your target system, you will not be prompted for cluster size (which
is required only if the target system is RSTS/E).
You can also set attribute values by using the GET command to load
into the design buffer either (1) a file design from a description
file or (2) the attribute values of a data file.
The attribute values
that you specify, either interactively or from external description or
data files, replace the initial RMSDES default values.
Section 2.3.1
describes setting attribute values
interactively.
Section 2.3.2
describes setting attribute values using external files.
Attribute values that are not replaced by user-set values (by use of
eithE!r the SET or GET command) retain default values.
You can also
allo~T RMSDES to automatically define areas in an indexed file.
If you issue a SET ALL command for indexed files, RMSDES will prompt
you when you reach the area section.
You will also be prompted if you
iSSUE! a CREATE command but have defined no areas for an indexed file:
Areas defaulted:
You can respond YES or NO:
•

To define areas explicitly, type NO.
If you issued a SET
or SET AREA ALL command, RMSDES will prompt you:

ALL

Number of areas:
Type a decimal number to specify the number of areas you want
to define.
RMSDES will prompt you for each attribute in every
area you are defining.
Areas will be numbered sequentially
starting with o.
If you define no areas but issue a CREATE command,
the
will be created with a single area (the RMS-ll default).
•

To define areas by default, type YES or press RETURN
the default).
RMSDES will prompt you:

file

(YES

Type a decimal number to indicate bucket size (the default

Bucket Size (2):
2) •

When you issue a CREATE command, RMSDES will define areas by
default based on this bucket size and the number of keys you
specified in the key section.
2-17

RMS-ll FILE DESIGN UTILITY:
See also Section 2.6.5 for more
define areas by default.

information

RMSDES
on

allowing

RMSDES

In addition, you can clear and display attribute values during a
design session by issuing a CLEAR or SHOW command.
See Sections 2.3.3
and 2.3.4.
At the end of the design session, to capture the file
that you have
designed
in the design buffer, you must save the design with the SAVE
or EXIT command (see Section 2.4) or create the data
file with the
CREATE command (see Section 2.5).
If you terminate the design session
with the QUIT or CTRL/Z command, the information in the buffer will be
lost.
Table 2-2:
Section
Keyword
System

RMSDES Section and Attribute Keywords
Default

Attribute Keyword
and Variable
TARGET l argument
argument must be one of:

File

RSX
RSTS

User's system

SOURCEl 2

User's system

FILE PLACEMENT l logical

NAME string

FILE.DAT

ORGANIZATION argument
argument must be one of:
SEQUENTIAL
RELATIVE
INDEXED

SEQUENTIAL

CLUSTER SIZE number

(RSTS/E only)

0 blocks

ALLOCATION number

0 blocks

EXTENSION number

0 blocks

BUCKET SIZE number

1 block

PROTECTION string

System protection

OWNER string

User's UIC

(RSX-IIM/M-PLUS only)

(continued on next page)

1. Informational attribute.
2. Not user settable;
system.

RMSDES automatically notes

2-18

the

user's

source

RMS-ll FILE DESIGN UTILITY:
Table 2-2 (Cont.):
Section
Keyword
File

Record

RMSDES

RMSDES Section and Attribute Keywords
Default

Attribute Keyword
and Variable
MAGTAPE BLOCK SIZE number

512 bytes

REWIND_MAGTAPE logical

MAX RECORD NUMBER number

o records

CONTIGUOUS logical

SUPERSEDE logical

SIZE number

o bytes

FORMAT argument
argument must be one of:
VARIABLE

VARIABLE
STREAM
FIXED
VFC
CONTROL FIELD SIZE number

2 bytes

BLOCK_SPAN logical

YES

CARRIAGE_CONTROL argument
argument must be one of:
CARRIAGE RETURN

CARRIAGE RETURN
FORTRAN
NONE
Key n l

NAME string

No name

TYPE argument
argument must be one of:
STRING
BIN2
BIN4
INT2
INT4
DECIMAL

STRING

NULL KEY logical

NO
(continued on next page)

1. You must specify a number (n)
area you define.

for each

2-19

key,

key

segment,

and/or

RMS-ll FILE DESIGN UTILITY:
Table 2-2 (Cont.):
Section
Keyword
Key n l

RMSDES

RMSDES Section and Attribute Keywords
Default

Attribute Keyword
and Variable
NULL VALUE argument
argument must be one of:

, ,

An ASCII character
A decimal number

(space)

DUPLICATES logical

NO (primary key)
YES (alternate key)

SEGn POSITION I number

Byte 0

SEGn LENGTH I number

o bytes

SEGO POSITION number

Byte 0

CHANGES logical

YES

DATA FILL number

100 %

DATA AREA number

Area 0

INDEX FILL number

100 %

LEVELl INDEX AREA number

Area 0

INDEX AREA number

Area 0

(alternate key)

Area n l ALLOCATION number

o blocks

EXTENSION number

o blocks

BUCKET SIZE number

o blocks

CONTIGUOUS logical

POSITION argument
argument must be one of:
NONE
VIRTUAL number
LOGICAL number

NONE
(RSX-IIM/M-PLUS only)

EXACT POSITIONING logical
1. You must specify a number
area you define.

2.3.1

(n)

(RSX-IIM/M-PLUS only) NO

for each key, key

segment,

and/or

Setting Attribute Values

You use the SET command (Section 2.2.10) to specify attribute values
in the design buffer individually, in one section, or in all sections.

2-20

RMS-11 FILE DESIGN UTILITY:

RMSDES

2.3.1.1 Setting Individual Attribute Values - When you issue the SET
command for an individual attribute, the command is executed to set
the specified attribute and the DES:
prompt ,is returned.
For
example:
DES:
DES:

SET FILE ORGANIZATION INDEXED

You can accept the default for an attribute by omitting the value from
the command string and pressing RETURN in response to the VALUE:
prompt. The following examples illustrate how to set the individual
attribute values for a I-segment primary key (key 0).
DES:
SET KEY 0 TYPE
VALUE:
@]
specifies

the

The SET command specifies that the first byte of the primary key
begin at byte 0 of the record.

will

Pressing RETURN in response
default for TYPE (STRING).
DES:
DES:

DES:
DES:

the

VALUE:

prompt

SET KEY 0 SEGO POSITION 0

SET KEY 0 SEGO LENGTH 5

The SET command specifies that the primary key will be 5 bytes long.

2.3.1.2 Setting Attribute Values in Sections - When you issue the SET
section command,
RMSDES will prompt you for attribute values in that
section only. When you issue the SET ALL command, RMSDES will prompt
you for attribute values in all sections.
on
your
Note that the prompting will be
conditional
based
specifications for
target system,
file organization, and record
format.
That is, you will not be prompted for attributes that do not
pertain to your file design;
for example, you will be prompted for
cluster size only if your target system is RSTS/E.
In response to each attribute prompt, you can either type a specific
value or press RETURN to accept the default.
Table 2-2 lists the
defaults for attributes.
If you are designing an indexed file, you can allow RMSDES to define
areas by default based on the number of keys you specified in the key
section;
see Section 2.6.5.
When you issue the SHOW ALL, SAVE, or CREATE command,
RMSDES will
assign the user-set and default attributes you specified in the design
buffer;
see Sections 2.3.4.2, 2.4, and 2.5.
While being prompted for attribute values, you may want to interrupt
your design session to change previously set attributes, or to save
your file design and resume the session later.
Typing ESC will
interrupt the design session, return the DES:
prompt, and preserve
all attribute values in the design buffer.
In response to the DES:
prompt, you can:
•

Reset previously set attributes -- Use the CLEAR command to
clear any section or attribute in the design buffer.
Then use
the SET command to reset them.

2-21

RMS-ll FILE DESIGN UTILITY:

RMSDES

•

Resume the design session -- Use the SET section command to
return to the section in which you were setting attributes.
Once the attribute prompt returns, press RETURN until you
reach the attribute at which you left the design session;
the
attribute values you set earlier will be preserved. Then set
attribute values as usual.

•

Save the design -- Use the SAVE command to store your design
in a description file.
To resume your design session later,
use the GET command to load the file design in the description
file into the design buffer.

Begin a new design session -- Use the CLEAR ALL command to
• clear
the whole buffer.
Then issue the appropriate SET
command and design your file.
When attribute prompting is completed, the DES:
You can then:

prompt

returned.

•

Use the SHOW command to display attribute values

•

Use the SET command to set or reset more attribute values

•

Use the CLEAR command to restore any
sections to their default values

•

Use the SAVE command to save the file design

•

Use the EXIT command to save the
RMSDES

•

Use the CREATE command to create an empty data file

•

Use the QUIT command to terminate RMSDES (attribute values
the design buffer will not be saved)

attribute,

file

design

section,

and

terminate

Example
The following example illustrates how you are prompted for and can set
attribute values using the SET ALL command.
It also illustrates the
use of the ESC command to interrupt the design session to reset an
attribute value.
DES:
SET ALL
Starting SYSTEM section
Target:
RSX
File Placement:
RIf)
Starting FILE section
Name:
PERS.DIS
Organization (Seq):

(RID

Pressing RETURN specifies the defaults:
sequential for file organization.
Allocation (0):
Extension (0):

for

file

placement

and

2
[@

DES:
You realize that you should have specified the default
(NO)
for
Allocation.
Typing ESC interrupts the design session, returns the
DES:
prompt, and preserves all previously set attribute values.
To
verify the Allocation setting, use the SHOW command:
DES: SHOW FILE ALLOCATION
ALLOCATION
2
(Explicit)

2-22

RMS-ll FILE DESIGN UTILITY:

RMSDES

The SHOW command displays the value set for the allocation
You specified 2 bytes instead of the default, O.
DES:
DES:

attribute.

CLEAR FILE ALLOCATION

The CLEAR command restores the default for Allocation, O.
DES:

SET ALL

The SET ALL command resumes the design session.
Starting SYSTEM section
Target: @]
File Placement: @]
Starting FILE section
Name: @]
Organization (Seq):
Allocation (O): @]

Pressing RETURN preserves the previously set values.

Rewind_Magtape

(NO):

You can now continue your design session, and will be prompted for the
remainder of the file section,
as well as for all other sections.
Note that in this example, you will be prompted for whether the
magnetic tape is to be rewound because you specified sequential file
organization earlier.
Pressing RETURN in response to this prompt
specifies the default, NO.
NOTE
When RMSDES
prompts
for
attribute
values,
it always displays the same
default value;
it does not show the
current value which you may have set in
the design buffer.
You must
issue a
SHOW command to determine the current
value.
In addition, note that a carriage return
in response to a prompt will not change
any existing value which has been set in
the design buffer.
Under these circumstances,
RMSDES will
prompt for a value, displaying a default
value.
Responding with
a
carriage
return will mean that a previously set
value is used by RMSDES, not the default
value that was displayed.

2-2~

RMS-ll FILE DESIGN UTILITY:
2.3.2

RMSDES

Setting Attribute Values Using External Files

You use the GET command (Section 2.2.6)
to direct RMSDES to read
attribute value
information from an external
file and to set the
corresponding attributes in the design buffer.
When you issue a GET command, RMSDES first initializes the attributes
in the design buffer to their original (default) values, and then
reads in the attribute value information from the external file.
RMSDES reads attributes from two kinds of external files:
•

Description file -- an ASCII sequential file that contains a
file design;
that is, it contains file attribute values set
in a design session.

•

Data file -- a file that contains or is capable of containing
data records.
RMSDES ignores any data records that the file
may contain, loading only the attributes of the data files
into the design buffer.

Sections 2.3.2.1 and 2.3.2.2 describe how description and
are used.

data

files

Reading attribute values from an external file into the design
allows you to:

buffer

•

Redesign some attributes of a file to improve its efficiency,
and then to save the design or create the empty data file.

•

Create an empty data file from the file design specified in
description file.

•

Create an empty data file from the attributes of a data file.
This allows you to use the data file as a template to copy the
structure of a file without copying the records.

•

Create a description file from the attributes of a data file.

Once the attribute values are set in the design buffer, you can:
•

Use the SHOW command to display the attribute
file

values

•

Use the SET command to redesign the file

•

Use the SAVE command to save the file design in a
file

•

Use the CREATE command to create an empty data file

the

description

2.3.2.1 Setting Attribute Values from a Description
File - The
following examples show how to load into the design buffer the file
design attributes contained in description files created using RMSDES.
DES:
DES:

GET Faa

This command loads the file design attributes of FOO.DES into the
design buffer.
(The default file type, .DES, and default file kind,
DES, need not be specified.)
DES:
DES:

GET FOO.BAR

2-24

RMS-ll FILE DESIGN UTILITY:

RMSDES

This command loads the file design attributes of FOO.BAR into the
design buffer.
The file type must be specified because it is not the
default. However, the kind, DES, need not be specified;
RMSDES will
assume that the file was created using RMSDES if no type is specified.

2.3.2.2 Setting Attribute Values from a Data File - Loading the
attributes of a data file into the design buffer makes it possible for
you to rapidly set attribute values in the design buffer without going
through the whole design sequence.
Once the attribute values are set
in the buffer, you can change the file design, save the design, or
create a new, empty data file.
Once the new data file is created, you
can store records in it.
Note, however, that if you specify an indexed data file, RMSDES cannot
access the initial allocation for the areas:
the allocation attribute
for each area will be set to the number of blocks that remain
available in each area of the data file, not to the initial allocation
for each area in the data file.
You can use the SHOW command to
display the setting and then use the SET command to reset the
allocation attribute as necessary.
If the external file is a data file, the file name and type in the
design buffer will be set to those of the existing file.
If you issue
a CREATE command, the new data file will have the same file name and
type as the existing data file and a version number I higher than the
existing data file.
Reading the attributes of a data file into the design buffer is useful
in the following cases:
•

A file that you use processes records efficiently.
As a
result, you want to duplicate its file design.
After loading
the attributes of that data file into the design buffer with
the GET command, you can save the design or create an empty
data file.
This procedure allows you to use the original data
file as a template to save or copy the structure of the file
without copying the records.

•

A file that you use is largely efficient, but a
few of the
attributes need to be reset.
After loading the attributes of
the data file into the design buffer, you can rapidly make
changes with the SET command.
You can then save the design or
create an empty data file.

For example:
DES:
DES:

GET FOO.BAR DAT

This command loads the attributes of FOO.BAR, a data
design buffer.

2.3.3

file,

into

the

Clearing Attribute Values

You use the CLEAR command (Section 2.2.1)
to restore the attribute
values of one attribute, of one section, or of all sections to their
default values.

2-25

RMS-ll FILE DESIGN UTILITY:

RMSDES

2.3.3.1 Clearing Individual Attribute Values - When you issue the
CLEAR command for an individual attribute, the attribute value is
resto~ed to its default.
You may want to restore an attribute value
to
its default if you find that the default value would improve your
file design.
For example:
DES:
DES:

CLEAR RECORD FORMAT

This command restores the record format to the default, VARIABLE.

2.3.3.2 Clearing Attribute Values in Sections - You clear user-set
attribute values
in sections when values you previously defined are
incorrect or no longer useful.
The following example restores all the attributes in the file
to their default values:
DES:
DES:

section

CLEAR FILE ALL

You can now use the SET command to reset the attributes
in the file
section.
The attributes in the other sections of the design buffer
will retain the values you have previously set.
You should also clear all sections after you have saved a file
or created a file, as follows:
DES:
DES:

design

CLEAR ALL

The buffer will now be ready to accept a design for another file.

2.3.4

Showing Attribute Values

You use the SHOW command (Section 2.2.11)
to display the attribute
values in the buffer individually, in one section, or in all sections.
Attribute values are displayed conditionally;
that
is,
only the
attributes that pertain to the file design are shown.
For example, a
cluster size value will be displayed only if you have specified RSTS/E
as the target system.

2.3.4.1 Showing Individual Attribute
useful when:

Values - The

SHOW

command

•

You are setting an attribute value that depends on
a
previously set attribute value.
Displaying the previously set
attribute value confirms what value is already defined.

•

You want to confirm that you have
correct value.

The following example shows
attribute value:

how

DES: SHOW FILE ORGANIZATION
INDEXED
ORGANIZATION
DES:
2-26

set

attribute

display

the

file

(Explicit)

the

organization

RMS-ll FILE DESIGN UTILITY:

RMSDES

2.3.4.2 Showing Attribute Values in Sections - The SHOW section
command displays user-set and default attribute values in one section.
The SHOW ALL command displays attribute values in all sections.
The SHOW command allows you to:
•

Confirm what attribute values you have set.

•

Inspect a file design that is stored in a description file.
Inspecting the attribute values of the file design gives you
an accurate profile of the file.

•

Inspect a file that you did not finish designing, but stored
as an incomplete design session In a description file.
Inspecting the attribute values of the file design informs you
what values are already set and defaulted, and where you
interrupted your design session.

•

Confirm that you are going to clear the right section.
For
example, if your file design contains multiple keys, you might
want to inspect the specific key section to make sure you are
going to clear the right key.

For example:
SET FILE ORGANIZATION INDEXED
DES:
SET FILE NAME INFILE.DAT
DES:
SHOW ALL
DES:
SYSTEM
Target
RSX
Source
RSX
FILE
Name
INFILE.DAT
(Explicit)
Organization
INDEXED
(Explicit)
Allocation
o
Extension
o
Bucket Size
1
Protection
Owner
[303,24]
Max Record Number
o
Contiguous
NO
Supersede
NO
RECORD
Size
o
Format
VARIABLE
Carriage Control
CARRIAGE RETURN

2.4

SAVING THE FILE DESIGN

When you have completed a design session, you can use the SAVE command
(Section 2.2.9) or the EXIT command (Section 2.2.5) to store the file
design in a description file.
If you issue a SAVE command, the RMSDES
prompt will be returned after the file design is stored and you can
continue the design session.
If you issue an EXIT command, RMSDES
will be terminated and the system prompt will be returned after the
file design is stored.
If, after you save a file design, you want to
design another file, you should issue a CLEAR ALL command to restore
the attribute values in the design buffer to their defaults.
Saving the file design is useful when you would prefer not to create
the empty data file,
but to store the file design for later use
instead.
You may need to interrupt your design session, or may want
to fine tune your design at a another time.
Saving the file design
allows you to resume your session later.
2-27

RMS-ll FILE DESIGN UTILITY:
For example, to save your file design in
type:
DES:
DES:

RMSDES
file

called

INFILE.DES,

SAVE INFILE

This command stores the file design in the file
INFILE.DES.
Because
the default file type is .DES, you can omit the file type from the
command line.
When you want to create the empty data file or resume the design
session, you use the GET command to load the file design stored in
INFILE.DES into the design buffer.
You can then resume your design
session or create the empty data file.
The description file is also a useful reference tool.
Because it is
an ASCII sequential file, the attributes of a file can be displayed or
printed.
If the attributes of the file have changed over time,
the
description file provides a record of those changes.
In addition, if
the data file is lost or destroyed, the description file can be used
to create an exact copy of the file
(without the original data
records) •

2.5

CREATING AN EMPTY DATA FILE

You can use the CREATE command (Section 2.2.2) to create an empty data
file,
based on the attribute values in the design buffer.
The empty
data file is capable of containing records for use by your programs.
If you are designing an indexed file but have defined no areas, you
will be asked, when you issue the CREATE command, whether RMSDES is to
define areas by default.
If you respond YES or press RETURN
(YES is
the default), RMSDES will define areas based on the number of keys you
specified in the key section.
If, after you create a file, you want to design another file,
you
should issue a CLEAR ALL command to restore the attribute values in
the design buffer to their defaults.
Note that if you define areas and/or keys for an indexed file,
they
must be numbered sequentially starting with 0 (0, 1, 2, ••. ) when you
issue the CREATE command (see Section 2.2.2).
As described in Section 2.1.1, an empty data file can also be created
from an existing description or data file.
The new data file will
have the attributes of the existing external file.
This method of
creating a file is the equivalent of issuing a GET command to set the
attributes in the design buffer to match those of an external file,
and then issuing a CREATE command to create an empty data file with
those attributes. See Section 2.3.2 for more information on using
external files.
The following examples show how to create an empty data file:
DES:
DES:

CREATE

This command creates an empty data file with the file
specified in the design buffer.

2-28

name

and

type

RMS-ll FILE DESIGN UTILITY:
DES:
DES:

RMSDES

CREATE NEWFIL

This command creates an empty data file with the name specified in the
command line,
NEWFIL.DAT.
Specifying a file name and type in the
command string is useful when you want to create many different data
files with the same attributes.
DES INFILE
This command is issued from your system prompt.
It creates an empty
data file based on the file design specified in the description file,
INFILE.DES.
The empty data file is given the file name and type
specified in the description file.

2.6

SECTIONS AND ATTRIBUTES

The RMSDES design buffer is divided into five sections:
•

System section contains attributes that define the operating
system on which you are using RMSDES and the operating system
on which the file be will be used.

•

File section contains attributes that define the
characteristics, such as name, organization, owner.

Record
section
contains
attributes
• characteristics
of the records within

file's

that
define
the
such as
the file,

format, size, carriage control.
Key
section
contains
• characteristics
of keys

attributes
that
define
the
and key segments in indexed files,
such as name and data type for keys, and position and length
for key segments.

section
• Area
characteristics

the
contains
attributes
that
define
of areas in indexed files, such as position,
allocation, contiguity.

Sections 2.6.1 through 2.6.5 describe the design buffer sections and
attributes.
For each attribute, the attribute keyword and variable
are qiven.
The description of each attribute gives the attribute's function,
the
default if you do not supply a value for the variable, whether the
attribute is informational, and whether the attribute is conditional.
Informational attributes are those required by RMSDES;
they are not
RMS-ll file attributes.
Some informational attributes, such as
source, are saved in the description file:
others,
such as file
placement, are only used by RMSDES to determine conditional prompting
and are not saved in the description file.
Conditional attributes are those for which you are prompted only if
you have given a particular response to some previous prompt.
For
example, you will be prompted for a control field size number only if
you have specified variable with fixed control as the record format.

2-29

RMS-11 FILE DESIGN UTILITY:
2.6.1

RMSDES

System Section

In the system section, you define the target system,
that
is,
the
operating system on which the file you are designing will be used.
The source system (the operating system on which you are using RMSDES)
is automatically set for you
in the design buffer.
You are not
prompted for this attribute.
Both the target and source attributes
are informational attributes.
In addition, if you issue a SET ALL command, you will be prompted
FILE PLACEMENT after the TARGET prompt, as follows:

for

DES: SET ALL
Starting SYSTEM section
Target:
@]
File Placement:
In response to the FILE PLACEMENT prompt, type either YES or NO to
indicate whether you will specify POSITION in the area section (see
Section 2.6.5):
•

YES -- indicates that you will specify POSITION in the area
section.
You will not be prompted for allocation, extension,
and bucket size in the file
section;
rather,
you will be
prompted
for
this information in the area section (area 0 is
automatically defined for sequential and relative files).

•

NO -- indicates that you will not specify POSITION in the area
section.
You will be prompted for allocation, extension, and
bucket size in the file section.

The default is NO.
FILE PLACEMENT is an informational attribute used
to
determine
conditional prompting;
it
is not saved
in the
description file.
TARGET argument
Specifies the operating system on which the data
file will be
created.
TARGET is an informational attribute and is saved in
the description file.
For argument, type one of the following:
•

RSX

•

RSTS

The default is the system on which the file is being designed.
Specifying a particular operating system does not necessarily
limit the use of the file
to that system.
As long as your
description or empty data file is not system specific,
the file
can be processed on other operating systems.
However, if your
description file or empty data file is system specific, the file
may not be usable on another operating system.
SOURCE
This attribute is not user set;
RMSDES automatically sets this
attribute to the operating system you are using to design the
file.
Source is an informational attribute and is saved
in the
description file.

2-30

RMS-ll FILE DESIGN UTILITY:
2.6.2

RMSDES

File Section

NAME string
Specifies the name
specification.

the

file.

For

string,

type

file

If you do not specify a file in response to the NAME prompt and
also do not specify a
file name and type when you issue the
CREATE command (see Section 2.2.2), the file will be created as
FILE.DAT.
ORGANIZATION argument
Specifies the organization of the file.
For argument, type one of the following:
You

can

store

•

SEQUENTIAL -- specifies a sequential file.
sequential files on disk or magnetic tape.

•

RELATIVE -- specifies a relative file.
files only on disk.

You can store relative

•

INDEXED -- specifies an indexed file.
files only on disk.

You can

store

indexed

The default is SEQUENTIAL.
CLUSTER SIZE number
Specifies the number of blocks in a cluster for this file.
You
are prompted for
this attribute only if you have specified the
target system as RSTS/E.
For number, type a value from 0 to 256 or
from -1 to -256
indicating the cluster size value in blocks.
See the RSTS/E
System User's Guide for more information on specifying cluster
SIze.
The default is 0 blocks which indicates that the pack cluster
size of the disk the file will be created on will be used.
ALLOCATION number
Specifies the initial size of the file in blocks.
You will not
be prompted for this attribute if you responded YES to the FILE
PLACEMENT prompt (see Section 2.6.1).
For number,
type a decimal value indicating the allocation
quantity in blocks.
The minimum allocation you can specify is 0
blocks;
the maximum depends on the amount of available space on
the disk or magnetic tape.
If you are allowing RMSDES to define areas for an indexed file by
default,
RMSDES will automatically calculate an allocation value
for each area it defines.
However, if you choose to define areas
explicitly and specify an allocation value for each area, accept
the default for
allocation in this section, and set
the
allocation attribute in each area section (see Section 2.6.5).
The default is 0 blocks.

2-31

RMS-11 FILE DESIGN UTILITY:

RMSDES

EXTENSION number
Specifies the number of blocks that should be added to the file
each time it
is extended.
You will not be prompted for this
attribute if you responded YES to the FILE PLACEMENT prompt
(see
Section 2.6.1).
For number,
type a decimal value indicating the extension
quantity in blocks.
This quantity should be a multiple of the
file bucket size value.
When RMS-ll extends a file on RSX-llM/M-PLUS systems, it requests
the number of blocks you have specified
from the operating
system.
When RMS-ll extends a file on RSTS/E systems,
it requests the
number of blocks you have specified from the operating system.
Then, it extends the file to the next full cluster
larger
than
the request.
If you are allowing RMSDES to define areas for an indexed file by
default,
RMSDES will automatically calculate an extension value
for each area it defines.
However, if you choose to define areas
explicitly and specify an extension value for each area, accept
the default for extension in this section and set the extension
attribute in each area section (see Section 2.6.5).
The default is 0 blocks.
BUCKET SIZE number
Specifies the number of blocks in a bucket for
the file.
This
number determines the number of blocks read into memory during
each file access operation, and
therefore affects processing
speed and the amount of memory a program accessing this file
requires.
You will not be prompted for
this attribute if you
responded YES to the FILE PLACEMENT prompt (see Section 2.6.1) or
if you specified sequential as the file organization.
If your target system is RSX-l1M/M-PLUS,
for
number,
type a
decimal value from 0 to 32, indicating the bucket size in blocks.
The minimum value permitted is the number of blocks that can
contain one record;
the maximum is 32 blocks.
If your target system is RSTS/E, for number, type a decimal value
from 0 to 15, indicating the bucket size in blocks.
The minimum
value permitted is the number of blocks that can contain one
record;
the maximum is 15 blocks.
In choosing a bucket size for RSTS/E files, you should consider
the file cluster size. Because file cluster size governs file
extension quantities and the way the RSTS/E file processor
handles
disk
read
operations, you can sometimes improve
performance by aligning buckets with clusters.
(See the RSTS/E
Programming Manual.)
If you are allowing RMSDES to define areas for an indexed file by
default,
RMSDES will automatically calculate an allocation value
for each area it defines.
However, if you choose to define areas
explicitly and specify a bucket size value for each area, you
should accept the default for bucket size in this section and set
the bucket size attribute in each area section (see Section
2.6.5) •
The default is 1 block.
2-32

RMS-ll FILE DESIGN UTILITY:

RMSDES

PROTECTION string
Specifies the type of access different categories
have to the file.

users

can

the
RSX-IIM/M-PLUS.
If your target system is RSX-IlM/M-PLUS,
protection code is expressed as a string of characters that
The categories of users
defines the legal categories of users.
are system, owner, group, and world.
For each category of user, you specify one or more of the letters
representing
the access types:
RWED (representing Read, Write,
Extend, and Delete).
The user categories
following format:

can

specified

any

order

the

(GROUP:RWED,OWNER:RWED,WORLD:RWED,SYSTEM:RWED)
To deny access to a
user category,
representing the access type:

simply

omit

the

letter

(GROUP:RWE,OWNER:RWED,WORLD:,SYSTEM:RWED)
The users in the group are denied access to delete the file.
World users are denied all access.
(For more information on
protection, see the RSX-llM/M-PLUS MCR Operations Manual and the
RSX-llM-PLUS Command Language ManuaT:)
You can set individual protection fields.
DES:

For example:

SET FILE PROTECTION (GROUP:RW)

The users in the group can read and write the
user categories have the default access.

file;

all

other

You can also set one protection field at one time and set another
later.
For example,
suppose you had previously set group
protection as above and now set world protection as follows:
DES:

SET FILE PROTECTION (WORLD:R)

The previously set group protection (RW) would remain set, world
users would have read access, and all other users would have the
default access.
If you use the SHOW command to display protection, only the
fields
that you explicitly set will be displayed.
For example,
suppose you made the settings in the above examples and then
issued the SHOW command to verify the settings:
DES:
SHOW FILE PROTECTION
( GROUP:RW , WORLD:R )
PROTECTION

Explicit

The CLEAR command restores all fields to their default values.
You cannot clear an individual field.
You can, however, use the
SET command to reset a field to a new explicit setting.
If you use the GET command and specify an external file,
RMSDES
will set the protection to correspond to the setting in the file.
If the external file is a data file and protection is set to the
system default
(the default for this attribute), the protection
will be displayed, if you issue a SHOW command, as if it had been
explicitly set.
However, if the external file is a description
file and protection is set to the system default, the protection
will not be displayed if you issue a SHOW command.
2-33

RMS-ll FILE DESIGN UTILITY:

RMSDES

RSTS/E systems.
If your target system is RSTS/E, the protection
code is expressed as a decimal number ranging from 0 to 255.
See
the RSTS/E System User's Guide for
more
information
on
calculating protectio~n number-s-.-The default is the

ta~get

system default.

OWNER string
Specifies the owner of the file.
If your target system is RSX-IIM/M-PLUS, you will be prompted for
file owner.
For string, type the User Identification Code (UIC)
of the user who will own the file.
The default is the Ule of the person using RMSDES.
If your target system is RSTS/E, you will
this attribute.
MAGTAPE BLOCK SIZE

not

prompted

for

numbe~

Specifies the number of bytes in each magnetic tape block.
This
attribute applies
to magnetic tape files
only.
You will be
prompted for this attribute only if you specified sequential as
the file organization.
For number, type a decimal value from 18 through 8192.
The default is 512 bytes.
REWIND MAGTAPE logical
Specifies that the magnetic tape is to be rewound, and
that
the
file
is to be stored at
the beginning of
the tape.
This
attribute applies to magnetic tape files
only.
You will
be
prompted
for
this attribute only if you specified sequential as
the file organization.
For logical, type YES or NO:
•

YES

specifies that the tape will be rewound.

•

specifies that the tape will not be rewound.

The default is NO.
MAX RECORD NUMBER number
Specifies the maximum number of records that a relative file will
contain.
If you are designing a sequential or indexed file, you
will also be prompted for this value;
RMSDES will use the number
you supply for information if you allow RMSDES to define areas by
default (area 0
is automatically defined
for
sequential and
relative files;
see the FILE PLACEMENT attribute,
Section
2.6.1) .
If you allow RMSDES to define
explicitly set this attribute.

2-34

areas

default,

you

must

RMS-ll FILE DESIGN UTILITY:

RMSDES

RMS-ll checks the maximum record number whenever a record access
operation is requested for
this file.
If the relative record
number specified for the access operation exceeds the maximum
record number, RMS-ll will issue an error message.
For number, type a decimal value indicating
number value.

the

Accepting the default value allows the file to
records as physically possible.

maximum
contain

record
as

many

The default is 0 records.
CONTIGUOUS logical
Specifies whether the disk space for this file will be allocated
in contiguous blocks.
File contiguity minimizes head movement
when the file is being accessed.
For logical, type YES or NO:
•

YES

specifies that the file will be contiguous.

•

specifies that the file will not be contiguous.

If you are defining areas explicitly, you should take the default
for
this attribute and specify contiguity in the area section
(see Section 2.6.5).
If you are defining areas for an indexed file and your target
system is RSX-llM/M-PLUS, it is possible that the areas will not
be contiguous. However, the records within each area will be
contiguous if you accept the default (NO) for this attribute and
set the contiguous attribute in the area section to YES.
(See
Section 2.6.5.)
If your target system is RSTS/E and you declare the file to be
contiguous,
it will not be able to be extended unless you
specifically make it non-contiguous.
To achieve both file
contiguity and extension, find contiguous space on your disk and
specify the logical block number where you want the file
to
begin.
The default is NO.
SUPERSEDE logical
Specifies whether you want the present version of the file to
supersede an earlier version with an identical file name, type,
and (if your target system is RSX-llM/M-PLUS) version.
For logical, type YES or NO:
•

YES -- specifies that this file
file.

•

NO
specifies that if RMSDES encounters a file with
identical file specification, it will not create the file.

The default is NO.

2-35

will

supersede

existing
an

RMS-ll FILE DESIGN UTILITY:
2.6.3

RMSDES

Record Section

SIZE number
Specifies the record size in bytes.
For number, type a decimal value from 1 to 16,384 indicating the
record size.
If you are allowing RMSDES to define areas for an
indexed file by default, you must explicitly set this attribute.
If you accept the default, RMS-ll will accept records of any
length up to 16K bytes into the file.
Note, however, that the
actual record length accepted by RMS-ll may depend on other
factors,
such as file organization,
record
format,
target
operating system.
If your target system is RSX-IIM/M-PLUS,
see
the RSX-11M/M-PLUS RMS-11 User's Guide;
if your target system is
RSTS/E, see the RSTS/~S-11 Userrs-Guide.
The meaning of the record size information depends on the
format:

record

•

For variable-length and stream records, the record size you
specify is a maximum length, the size of the largest possible
record for that file.
RMS-ll rejects any write operation
using a record size greater than the maximum.

•

For fixed-length records, the record size you specify is the
same length for every record in the file.
RMS-ll rejects any
write operation that specifies a record of the wrong size.

•

For variable-with-fixed-control records, there
specifications:

are

two

size

Maximum length of the variable area
Length of the fixed control area
Specifying the size attribute sets the maximum length of only
the variable area of your record.
To specify the length of
the fixed control area, set the CONTROL FIELD SIZE attribute
(described below).
RMS-11 treats the specifications for both the variable area
and the fixed-control
area the same way it treats the sizes
for variable-length
records
and
fixed-length
records,
respectively.
The default is 0 bytes.
FORMAT argument
Specifies the record format for the file.
For argument, type one of the following:
•

VARIABLE -- specifies that records
differing, or variable, lengths.

•

STREAM -- specifies that the records in the file will have no
specific
format,
but will be delimited only by record
terminator characters.
The stream format
is permitted for
sequential disk files only.

2-36

the

file

will

have

RMS-ll FILE DESIGN UTILITY:

•

RMSDES

FIXED -- specifies that the records in the file have the same,
fixed length.

-- specifies that each record in the file has a control
• VFC
area with a
fixed
length and a data area of no standard
length.
The default is VARIABLE.
CONTROL FIELD SIZE number
Specifies the size in bytes of the fixed control area of each
record in the file.
You will be prompted for this attribute only
if you specified the record format as variable with fixed
control.
For number, type a decimal value from 1 through 255.
The default control field size is 2 bytes.
BLOCK_SPAN logical
Specifies whether records can cross block boundaries.
You will
be prompted for
this attribute only if you specified the file
organization as sequential.
Spanning block boundaries maximizes use of space on
Otherwise, the size of a record is limited to 1 block.

disk.

For logical, type YES or NO:
specifies that records can cross disk block boundaries.

•

YES

•

NO
specifies
boundaries.

cannot

cross

disk

block

Specifies how your records are written to a
(terminal or printer).

unit

record

device

that

records

The default is YES.
CARR.IAGE_CONTROL argument

For argument, type one of the following:
•

CARRIAGE RETURN -- specifies that each record will be preceded
by a
lTne feed character and followed by a carriage return
character when it is written to a unit record device.

•

FORTRAN -- specifies that the first byte of each record is to
be interpreted as a FORTRAN forms-control character when the
record is written to a unit record device.

•

NONE -- specifies no carriage control.

The default is CARRIAGE RETURN.

2-37

RMS-ll FILE DESIGN UTILITY:
2.6.4

RMSDES

Key Section

The key section allows you to define keys for an
can define the following key characteristics:

indexed

•

Number of keys

•

Position, size, type, and name of each key

•

Whether records can have duplicate key values

•

Whether alternate
operations

•

Whether keys are segmented

•

Null key value for duplicate keys

•

Fill factors for keys

key

values

can

change

file.

during

You

update

If you are designing an indexed file, RMSDES will prompt you for
the
number of keys that the file will contain.
If you issue the SET ALL
command, RMSDES will prompt you for the number of keys when you reach
the key section.
If you issue the SET KEY ALL command, RMSDES will
prompt you immediately for the number of keys, as follows:
Number of keys?
There is no default response to this prompt.
Type a decimal number to
specify the number of keys you are defining for the area, and press
RETURN.
You can specify up to 255 keys per area;
RMSDES will number
them from 0 to 254.
You will be prompted for all of the key
attributes for every key you are defining.
Note that keys must be
numbered sequentially starting with 0 (0, 1, 2, ••• ) when you issue the
CREATE command (see Section 2.2.2).
If you are setting only one key, you must specify the key number to be
prompted for key attributes.
For example, to set a primary key, you
would use the following SET command:
SET KEY 0 ALL
If you are allowing RMSDES to define areas by default,
RMSDES will
define the areas based on the number of keys you specify in this
section (see Section 2.6.5 and Appendix B for more information on how
RMSDES defines areas).
NAME string
Specifies the name of the key.
For string, type a key name of up to 32 ASCII characters.
Accepting the default specifies that no name is assigned
key.
TYPE argument
Specifies the data type of the key.

2-38

the

RMS-ll FILE DESIGN UTILITY:

RMSDES

For argument, type one of the following:
STRING -- specifies that
• alphanumeric
characters.

string

the

key

value

-- specifies that the key
• BIN2
integer.

value

2-byte

unsigned

-- specifies that the key
• BIN4
integer.

value

4-byte

unsigned

•

INT2 -- specifies that
integer.

the

key

value

2-byte

signed

•

INT4 -- specifies that
integer.

the

key

value

4-byte

signed

•

DECIMAL
number.

packed

decimal

specifies that the key value is

The default is STRING.
NULL KEY logical
Specifies whether the file will contain some records that cannot
be accessed by this key.
These records will be assigned a null
value for
this key.
The null value
is specified
in the
NULL VALUE attribute, described below.
The null key attribute
applIes only to alternate keys.
For logical, type YES or NO:
•

YES -- specifies that this alternate key will contain
key value.

•

NO -- specifies that this alternate key will
null key value.

not

null

contain

The default is NO.
NULL._VALUE argument
This attribute applies to alternate keys only.
It specifies the
null
value for
this key;
that is, the file will contain some
records that cannot be defined by the key.
You will be prompted
for
this attribute only
if you have specified YES for the
NULL_KEY attribute, described above.
For argument, you can type:
•

An ASCII character -- to indicate a character null value, type
a character or a space, enclosed in apostrophes.
For example,
'X' indicates that the character X is a null value.

•

A decimal number -- to indicate a numeric null value,
number from 0 to 255.

The defaul t

is a space ('

').

2-39

type

RMS-ll FILE DESIGN UTILITY:

RMSDES

DUPLICATES logical
Specifies whether the file can contain more than one record
the same value for this key.

with

For logical, type YES or NO:
•

YES -- specifies that duplicate key values will
be allowed.
If you type YES for alternate keys and are allowing RMSDES to
define areas by default, you will be prompted for the average
number of duplicates per alternate key;
RMSDES uses this
value to calculate area allocation (see Section 2.6.5).

•

NO
specifies
allowed.

that

duplicate

The default for alternate keys is YES;

key

values

will

not

for primary keys, NO.

CHANGES logical
Specifies whether an alternate key can change values during an
update operation;
that is, whether the record can be read with
one value for the key and rewritten with another
value
for
the
same key.
This attribute applies only to alternate keys.
For logical, type YES or NO:
•

YES -- specifies that the value of this alternate key
changed.

can

•

NO -- specifies that the value of this alternate key cannot be
changed.

The default is YES.
DATA FILL number
Specifies the percentage of the data level bucket that should
filled when the file is initially loaded.

For number, type a decimal value from 50 to 100,
indicating
percentage to which each data bucket should be filled.

the

The default is 100 percent.
DATA AREA number
Specifies the area that will contain the data
records for
the
primary key and pointers
to the data records for an alternate
key.
For number, type a decimal value indicating the area.
If you are allowing RMSDES to define areas by default,
accept the default for this attribute.

you

must

Note that if you specify a data area, you also must specify the
allocation,
extension, bucket size, and contiguous attributes of
this area in the area section (see Section 2.6.5).
Otherwise, an
error message will be issued and the area will not be created.
The default is area O.

2-40

RMS-11 FILE DESIGN UTILITY:

RMSDES

INDEX FILL number
Specifies the percentage of the index level bucket that should be
filled when the file is initially loaded.
For number, type a decimal value from 50 to 100,
indicating
the
percentage to which each index level bucket should be filled.
Because the index level buckets contain only pointers rather than
actual
records,
you may want to specify a different fill factor
for the index level buckets than for the data level buckets.
The default is 100 percent.
LEVELl INDEX AREA number
Specifies the area that will contain the lowest-level index
for this key.

area

For number, type a decimal value indicating the area.
If you are allowing RMSDES to define areas by default,
accept the default for this attribute.

you

must

Note that if you specify a level-l index area, you must make sure
that the area
is defined by setting the allocation, extension,
bucket size, and contiguous attributes for the area in the area
section
(see Section 2.6.5).
If you have
issued a SET ALL
command, you will be prompted for these attributes automatically.
Otherwise, you can
issue a SET AREA command to be prompted for
them.
You can take the defaults
for any of the attributes.
However,
if the area
is not defined, an error message will be
issued and the area will not be created when you issue a CREATE
command.
The default is area O.
INDEX AREA number
Specifies the area that will contain
index for this key.

the

upper

levels

the

you

must

For number, type a decimal value indicating the area.
If you are allowing RMSDES to define areas by default,
accept the default for this attribute.

Note that if you specify an index area, you must make sure that
the area is defined by setting the allocation, extension, bucket
size, and contiguous attributes for the area in the area section
(see Section 2.6.5).
If you have issued a SET ALL command, you
will be prompted for these attributes automatically.
Otherwise,
you can issue a SET AREA command to be prompted for them.
You
can take the defaults for any of the attributes.
However, if the
area is not defined, an error message will be issued and the area
will not be created when you issue a CREATE command.
The default is area O.

2.6,.4.1 Key Segments - This part of the key section allows you to
define segments for
keys.
Note that only string keys can have more
than one segment.
Nonstring keys, by definition,
have one segment
(segment O).
2-41

RMS-ll FILE DESIGN UTILITY:

RMSDES

If you have specified a string key type,
and a~e defining keys
inte~actively, you will be prompted for the number of segments you are
defining fo~ your key, as follows:
Number of segments?
This prompt occu~s after the DUPLICATES prompt.
Type a decimal number
to specify the number of segments you want to define for that key, and
press RETURN.
You can specify up to eight segments, numbered
from 0
to 7.
You will be prompted for the SEGn POSITION and SEGn LENGTH attributes,
described below.
You must define all segments you have specified.
For example, if you have specified
that a key will have three
segments,
you will be prompted
for the position and length of all
three segments.
SEGn POSITION number
Specifies the position of the first byte of the segment
the record.
This attribute applies to string keys only.

within

For number, type a decimal value indicating the position of the
first byte of the segment within the ~ecord.
Bytes within a
record are numbered sequentially starting with O.
The default is byte O.
SEGn LENGTH number
Specifies the length, in bytes, of the segment within the record.
This attribute applies to string keys only.
For numbe~, type a decimal value from 0 to
length of the segment within the record.
Note that the maximum length of a
record size you have specified.

key

255

segment

indicating
depends

the
the

The default is 0 bytes.
SEGO POSITION number
Specifies the position of the first byte of of a
nonstring key
within the record.
Nonstring keys cannot have more than one
segment;
however, this attribute allows you to position position
a single-segment nonstring key (segment 0) within the record.
For number, type a decimal value indicating the position
first byte of segment 0 within the record.

the

The default is byte O.

2.6.5

Area Section

The area section allows you to define areas for an indexed file.
Areas are portions of an indexed file that are treated
independently
for
position,
initial allocation,
extension, bucket size,
and

2-42

RMS-ll FILE DESIGN UTILITY:

RMSDES

contiguity. Defining areas allows you to improve the performance of
your file by dividing indexed files into separate units for each index
and for the data levels.
Defining Areas Explicitly.
To define areas explicitly, you first
should accept the defaults for the contiguous, allocation, extension,
and bucket size attributes in the file section.
Note, however,
that
if you set these attributes in both the file and area sections, the
values set in the area section will override the values set in the
file section.
Then, you must specify which area will contain the data records and
which areas will contain the indexes of each key by setting the data
area, level-l index area, and index area attributes in the key section
(see Section 2.6.4).
FInally, you must set the attributes
setting values in this section.

each

area

explicitly

If you issue a SET ALL command, RMSDES will prompt you when you
the area section:

reach

Areas defaulted:
Since you are defining areas explicitly, type NO.
prompt you:

RMSDES

will

then

Number of areas:
If

you

issue a SET AREA ALL command,
RMSDES will prompt you
for the number of areas.
Type a decimal number to specify
the number of areas you are defining for the file.
You can specify up
to 255 areas;
RMSDES will number them from 0 to 254.
imrnE~diately

RMSDES will prompt you for each area attribute in every area you
define.
Note that areas must be numbered sequentially starting with 0
(0, 1, 2, ••. ) when you issue the CREATE command (see Section 2.2.2).
If you define no areas but issue a CREATE command, the file will be
created with a single area (the RMS-ll default);
if you issue a SHOW
ALL command, no area will be created.
Defining Areas by Default.
In most cases,
letting RMSDES define
areas by default is the best option.
To do so, first you should
accept the defaults for the allocation, extension, bucket size, and
contiguous attributes
in the file section (see Section 2.6.2), and
explicitly set the size attribute in the record section
(see Section
2.6.3) •
If you issue a SET ALL command, RMSDES will prompt you when you
the area section, as follows:

reach

Areas defaulted:
Type YES or press RETURN (YES is the default)
want RMSDES to define the areas.

indicate

that

you

You will also be prompted for bucket size:
Bucket Size (2):
TYPE~ a decimal number indicating
the bucket size in blocks.
The
minimum value that you should enter is the number of blocks that can
contain one record.
If your target system is RSX-IIM/M-PLUS, the

2-43

RMS-ll FILE DESIGN UTILITY:

RMSDES

maximum is 32 blocks.
If your target system is RSTS/E, the maximum is
15 blocks.
The default is 2 blocks for all target systems.
(See also
the description of the BUCKET_SIZE attribute below.)
These prompts will also appear if you issue a CREATE command but
defined no areas.

have

Based on your responses to the prompts, RMSDES will begin to define
the areas.
First,
it will construct the primary index and issue an
informational message:
The primary index has a depth of n
where n is the number of index levels, excluding the data level

(0).

If you have specified multiple keys, and answered YES to the
DUPLICATES prompt in the key section (see Section 2.6.4), RMSDES will
print the next alternate key number and prompt:
Average number of duplicates?
There is no default response to this prompt;
type a decimal number to
indicate the average number number of duplicates per record for this
key.
RMSDES will use the value you enter in its area calculations.
After you respond to the prompt, RMSDES will construct
index and issue an informational message:

the

alternate

The index for alternate key x
has a depth of n
where x is the alternate key number and
lsvels, excluding the data level (0).

The prompt and
alternate key.

will

informational

message

the
be

number

index

repeated

for

each

When you issue a CREATE command, RMSDES will define areas based on
your responses to the prompts and on the number of keys you specified
in the key section. See also Appendix B.
Note that you should issue the CLEAR command to clear any area
attributes you may have previously set.
If any area attributes are
set when you issue a CREATE command, you will not receive the "Areas
defaulted" prompt;
RMSDES will assume that you want to set areas
explicitly and will prompt you for the area settings.
ALLOCATION number
Specifies the initial size of the area in blocks.
For number,
type a
quantity in blocks.

decimal

value

indicating

the

allocation

If you specify an allocation value for this area, you should also
accept the default for allocation in the file section (see
Section 2.6.2).
If the allocation attribute is set in both the
file and the area sections, the value in the area section will
override the value in the file section.
If you are allowing RMSDES to define areas by default,
will automatically calculate this attribute value.
The default is 0 blocks.

2-44

RMSDES

RMS-ll FILE DESIGN UTILITY:

RMSDES

EXTENSION number
Specifies the number of blocks that will be
each time it is extended.

added

the

area

For number,
type a decimal value indicating the extension
quantity in blocks.
This extension quantity should be a multiple
of the area bucket size value.
If you are allowing RMSDES to define areas by default,
will automatically calculate this attribute value.
When RMS-ll extends
requests the number
operating system.

an
of

RMSDES

area on RSX-IIM/M-PLUS systems,
it
blocks you have specified from the

When RMS-ll extends an area on RSTS/E systems,
it requests the
number of blocks you have specified from the operating system.
Then, it extends the area to the next full cluster larger than
the request.
If the extension attribute is set in both the file and the area
sections,
the value in the area section will override the value
in the file section.
The default is 0 blocks.
BUCKET SIZE number
Specifies the number of blocks in a bucket for the area.
You are
prompted for
this attribute only if you specified relative or
indexed file organization in the file section
(see Section
2.6.1) •
The bucket size number determines the number of blocks read
into
memory during each area access operation, and therefore affects
processing speed and the amount of memory a program accessing
this area requires.
If your target system is RSX-IIM/M-PLUS,
for
number,
type a
decimal value from 1 to 32 indicating the bucket size in blocks.
The minimum value that you should enter is the number of blocks
that can contain one record;
the maximum is 32 blocks.
If your target system is RSTS/E, for number, type a decimal value
from 1 to 15 indicating the bucket size in blocks.
The minimum
value that you should enter is the number of blocks that contain
one record;
the maximum is 15 blocks.
In choosing a bucket size for RSTS/E files, you should consider
the file cluster size.
Because file cluster size governs file
extension quantities and the way the RSTS/E file processor
handles
disk
read
operations, you can sometimes
improve
performance by aligning buckets with clusters.
If the bucket size attribute is set in both the file section and
area section,
the value
in the area section will override the
value in the file section.
If you are allowing RMSDES to define areas by default,
RMSDES
will prompt you for
this attribute value;
note that, in this
case, the default
is 2 blocks
(see the discussion at the
beginning of this section titled Defining Areas by Default).

2-45

RMS-ll FILE DESIGN UTILITY:

RMSDES

The default is 0 blocks if you are explicitly defining areas;
blocks if you allow RMSDES to define areas by default.

CONTIGUOUS logical
Specifies whether the disk space for this area will be allocated
in contiguous blocks.
Area contiguity minimizes head movement
when the area is being accessed.
For logical, type YES or NO:
•

YES -- specifies that the records
contiguous.

will

•

NO -- specifies that the records within the area will not
contiguous.

within

the

area

If you declare area contiguity, the records within each area will
be
contiguous;
however,
the areas
themselves may not be
contiguous.
If you have specified area contiguity,
you should also have
accepted the default for contiguity (NO) in the file section (see
Section 2.6.2).
If the contiguous attribute is set in both
the
file and the area sections, the entire file will be contiguous.
The default is NO.
If indexed areas are present, and (a) no placement is specified,
(b)
contiguous areas are not desired,
and
(c) the file was
requested contiguous, the area sizes will be summed and the
file
created as one contiguous area.
The areas will be allocated from
that.
POSITION argument
Specifies file
placement,
that
is, where
the area will be
positioned on disk.
This attribute applies to disk files only.
You will be prompted for this attribute only if you responded YES
to
the FILE PLACEMENT prompt in the system section (see Section
2.6.1) .
For argument, type one of the following:
•

NONE -- specifies that the area is to be
there is space on the disk.

positioned

wherever

•

VIRTUAL number
specifies that the area will begin near
designated virtual block.

the

For number, type a decimal number indicating the virtual block
number (VBN).
•

LOGICAL numbex -- specifies that the area is to begin
designated logical block.

the

For number, type a decimal number indicating the logical block
number (LBN).
The default is NONE.

2-46

RMS-ll FILE DESIGN OTILITY:

RMSDES

EXACT_POSITIONING logical
Specifies whether the area will be positioned beginning exactly
at the logical block number
(LBN) specified for the POSITION
attribute.
You will be prompted for this attribute only if you
have specified an LBN for POSITION.
For logical, type YES or NO:
•

YES -- specifies that the area must begin at the specified
LBN.
If the area cannot be positioned there, RMSDES will not
create the file.

•

NO
specifies that if the area cannot be positioned exactly
at the specified LBN, RMSDES will create the file, positioning
it as close as possible to the specified LBN.

The default is NO.

2.7

RMSDES EXAMPLES

DES: SET ALL
Starting SYSTEM section
Target: RSX
File Placement:
Starting FILE section
Name: PAYROL.DAT
Organization (Seq):
INDEXED
Allocation (0): 3
Extension (0):
Bucket Size (1):
Protection:
Owner:
Max Record Number (0):
Contiguous-(NO) :
Supersede (No): YES
Starting RECORD section
Size (0):
Format (Var): VARIABLE
Carriage Control (CR): CARRIAGE
Number of keys: 2
Starting Key 0
Name:
Type (String): STRING
Duplicates (Yes if alternate): YES
Number of Segments: 1
SegO Position: 0
SegO-Length: 12
Data-Fill (100):
Data-Area (0):
Index Fi 11 (100):
Levell Index Area (0):
I ndex Area (0):
Starting Key 1
Name:
Type (String): STRING
Null Key (No): NO
ouplTcates (Yes if alternate): YES
Changes (Yes): YES
Number of Segments: 1
SegO Position: 0
SegO-Length: 17

2-47

RMS-ll FILE DESIGN UTILITY:

RMSDES

Da t a Fill ( 100) :
Data-Area (0):
Index Fill (100):
Levell Index Area (0):
Index Area (0):
Areas def~ulted:
NO
Number of areas:
1
Starting Area
a
Allocation (0):
3
Extension (0):
Bucket Size (1):
Contiguous (No):
position (None):
DES:
CREATE
DES:
SAVE PAYROL.DES
DES:
~Z

The SET ALL command is used in this example to create an indexed file,
PAYROL.DAT,
which
has
an
initial
allocation
of
3 blocks,
variable-length records with carriage-control, and
two string
keys.
One area is defined.
The contents of the design buffer are also
PAYROL.DES.

saved

file

called

DES:
SET FILE NAME STAT.DAT
DES:
SHOW ALL
SYSTEM
Target
RSX
Source
RSX
FILE
STAT. OAT
(Explicit)
Name
Organization
SEQUENTIAL
Allocation
a
Extension
a
Protection
Owner
[70,5]
Magtape Blocksize
512
Rewind Magtape
NO
Max Record Number
a
Contiguous
NO
NO
Supersede
RECORD
Size
a
VARIABLE
Format
Control Field Size
a
YES
Block Span
CARRIAGE RETURN
Carri~ge Control
DES:
CREATE
This example illustrates the default values which are
initialized
in
the design buffer.
The file
name
is
the only value which is
explicitly set;
the remaining values are the default values.
The sequential file, STAT. OAT, is created in the default account.
The
owner of the file is the default account, and the records are variable
length with
the carriage-control
attribute.
The file
is
not
contiguous and does
not supersede any existing file with the same
name.

2-48

RMS-ll FILE DESIGN UTILITY:

RMSDES

DES:
CLEAR ALL
DES:
SET FILE NAME EMPLY.DAT
DES:
SET FILE ORGANIZATION RELATIVE
DES:
SET RECORD FORMAT
VALUE:
?
Format argument
Specifies the record format for the file.
For argument, type one of the following:
•

VARIABLE -- specifies that
records
differing, or variable, lengths.

the

file

will

have

•

FIXED -- specifies that the records in the file have the same,
fixed length.

control
-- specifies that each record in the file has a
• VFC
area with a
fixed
length and a data area of no standard
length.
The default is VARIABLE.
VALUE:
VFC
DES:
SET RECORD SIZE 80
DES:
SET FILE BUCKET 2
DES:
SHOW ALL
SYSTEM
Target
RSX
RSX
Source
FILE
EMPLY.DAT
(Explicit)
Name
RELATIVE
(Explicit)
Organization
Allocation
o
Extension
o
2
(Explicit)
Bucket Size
Protection
Owner
[70,5]
Max Record Number
o
Contiguous
NO
NO
Supersede
RECORD
Size
80
(Explicit)
VFC
(Expl ici t)
Format
Control Field Size
o
Carriage Control
CARRIAGE RETURN
DES:
SET FILE ALLOCATION 30
DES:
CREATE
This example illustrates the interactive nature of RMSDES.
First, some design parameters are specified:
file name and
file
organization.
When
record
format
is specified, however, the help
facility is invoked in order to choose the VFC record format.

2-49

RMS-ll FILE DESIGN UTILITY:

RMSDES

Next, record size and file bucket size are specified.
Then, the SHOW
ALL command
is used
to display the entire contents of the design
buffer.
Finally, the CREATE command is used to create the EMPLY.DAT file.
DES: CLEAR ALL
DES:
S E'I' F I LEAL L
Starting FILE section
Name: ACCNT.DAT
Organization (Seq):
INDEXED
Allocation (0):
30
Extension (0):
Bucket Size (1):
3
Protection:
Owner:
Max Record Number (0):
?
Max Record Number number
Specifies the maximum number of records that a relative file will
contain.
If you are designing a sequential or indexed
file,
you supply this as an informational value if you allow RMSDES to
define areas by default. (Area 0 is automatically defined
for
sequential and relative files.)
If you allow RMSDES to define
explicitly set this attribute.

areas

default,

you

must

RMS-ll checks the maximum record number whenever a record access
operation
is
requested
for
this file.
If the relative record
number specified for the access operation exceeds the maximum
record number, RMS-ll will issue an error message.
For number, type a decimal value indicating
number value.

the

Accepting the default value allows the file to
records as physically possible.
The default is 0 records.
Max Record Number (0):
Contiguous-(No) :
Supersede (No):
YES
DES: SET RECORD ALL
Starting RECORD section
Size (0):
80
Format (Var): FIXED
Carriage Control (CR):
NONE
DES: SET KEf 0 ALL
Starting Key 0
Name:
Type (String):
STR NG
Duplicates (Yes if alternate):
Number of Segments:
1
SegO Position: 0
SegO-Length: 15
Data-Fill (100):
Data-Area (0):
Index Fi 11 (100):
Levell Index Area (0):
Index Area (0):

2-50

maximum
contain

record
as

many

RMS-ll FILE DESIGN UTILITY:
DES:
SHOW ALL
SYSTEM
Target
Source
FILE
Name
Orqanization
Allocation
Extension
Bucket Size
Protection
Owner
Max Record Number
Contiguous
Supersede
RECORD
Size
Format
Control Field Size
Carriag~ Contiol
KEY
0Name
Type
Null Key
Null-Value
DuplIcates
Changes
SegO position
SegO-Length
Data-Fill
Data-Area
Index Fill
Levell Index Area
Index Area
DES: CREATE
Areas defaulted:
?

RMSDES

RSX
RSX
ACCNT.DAT
(Explicit)
INDEXED
(Explicit)
30
(Explicit)

o
3

(Explicit)

[70,5]

NO
YES

(Explicit)

80
(Explicit)
FIXED
(Explicit)

NONE
STRING
NO

(Explicit)
(Explicit)

NO
NO

15
100

(Explicit)
(Explicit)

100

or a CREATE command on an
If you issue a SET ALL, a SET AREA ALL,
RMSDES will prompt you when
indexed file and have not defined areas,
you reach the area section:
Areas defaulted:
If you are defining areas explicitly, or do not want RMSDES to define
areas for you, type NO.
If you issued a SET ALL command, RMSDES will
prompt you for the number of areas you wish to define.
If you issued
a CREATE command, the file will be created with the RMS-ll default
area.
If you issued a SHOW ALL command, no action will be taken.
Type YES or press RETURN to indicate that you want RMSDES
to define
the areas.
The areas will be defined based on the number of keys you
specified in the key section.
Areas defaulted:
DES: QUIT

In this example, the design is completed
"section" at a time.

specifying

The SET FILE ALL command is used to define all
help facility is used to get more information on
attribute.
The SET RECORD ALL and SET KEY 0 ALL
definition of the file, and the SHOW ALL command
of the design buffer.

2-51

the

file

file attributes and
the MAX RECORD NUMBER
commands compl~te the
displays the contents

RMS-ll FILE DESIGN UTILITY:

RMSDES

The CREATE command is invoked to create the file;
since areas have
not been defined, RMSDES queries about defaulting the area definition.
In this case, the answer "NO" is given causing the file to be created
with the RMS-ll default area.

2.8

RMSDES MESSAGES

This section documents the error messages returned
message is displayed in the format:

RMSDES.

Each

?DES-F-xxx, message text
?DES
Identifies the message as an RMSDES message.
F

Severity code.
A severity code of F is "fatal":
the operation
will not be performed. After the error message is displayed, the
DES:
prompt will reappear.
Retry the operation.
xxx
Message code:

an abbreviation of the message text.

message text
Indicates the reason that the error occurred.
The RMSDES messages are listed below in alphabetical order by the
message code.
Each message is accompanied by an explanation of the
error and recommended user action to correct the error.
?DES-F-AMA, Ambiguous attribute specified
Explanation:
You entered an attribute
abbreviation that was not unique.

keyword

using

User Action:
Reenter the command using a valid abbreviation for
the attribute keyword.
?DES-F-AMC, Ambiguous command
Explanation:
You entered a command using an
was not unique.
User Action:

abbreviation

that

Reenter the command using a vaLid abbreviation.

?DES-F-AMS, Ambiguous section specified
Explanation:
You entered
a
abbreviation that was not unique.

section

keyword

using

User Action:
Reenter the command using a valid abbreviation for
the section keyword.

2-52

RMS-ll FILE DESIGN UTILITY:

RMSDES

?DES-F-ANS, Area not defined
Explanation:

You specified an area that has not been defined.

Reenter the command using the number of a defined
User Action:
area.
Use the SHOW AREA ALL command to display the defined
areas.
?DES-F-AOR, Area number out of legal range
Explanation:
Areas are numbered
from 1 through
specified an area number outside of this range.
User Action:
number.

Reenter

the

command

specifying

255.

You

valid

area

?DES-F-CSE, Syntax error
Explanation:
You entered a string in response to the Protection
or the Owner attribute prompt using incorrect syntax.
User Action:
Reenter the
string
using
Protection should be specified in the format:

correct

syntax.

(group:RWED,owner:RWED,world:RWED,system:RWED)
Owner should be specified as the UIC of the user who will own the
file:
[n,n]
The value n is an octal number.
?DES-F-IAN, Illegal area number
Explanation:

You entered an illegal value for an area number.

User Action:
Reenter the command specifying a
from 0 through 254.

positive

number

?DES-F-IBR, Illegal response given, must be YES or NO
Explanation:
You were prompted
requires a logical argument.
User Action:

for

attribute

value

that

Enter YES or NO.

?DES-F-ICL, Incomplete command line within a command file
Explanation:
You specified an incomplete command line within an
indirect command file.
Execution of the command file will stop
at that point.
User Action:
Correct the indirect command file
command line is complete and re-execute the job.

2-53

that

the

RMS-ll FILE DESIGN UTILITY:

RMSDES

?DES-F-IFT, Illegal file type value specified
Explanation:
You issued a GET command or
filename[.typ]
[kind]
form of invocation
specification for file kind.

you used the DES
and used an invalid

User Action:
Reenter the command with a valid file kind
specification:
DES
(the default) for description files created
using RMSDES, or DAT for data files.
?DES-F-IKV, Illegal key number
Explanation:

You specified an illegal value for a key number.

User Action:
Reenter the command specifying a
from 0 through 254.

positive

number

?DES-F-ILA, Illegal attribute specified
Explanation:
You specified an attribute keyword that is
valid attribute.
User Action:
Reenter the command using a valid
keyword; make sure the keyword is spelled correctly.

not

attribute

?DES-F-ILC, Illegal command
Explanation:

You entered an invalid command.

User Action:
Reenter the command using a valid
make sure the command is spelled correctly.

command

name;

response

?DES-F-ILN, Illegal response given, must be numeric
Explanation:
You entered a nonnumeric value in
prompt for number of keys, areas, or segments.

User Action:
Enter a valid numeric value in response to
prompt.
The range for keys and areas is I through 255.
range for segments is I through 8.

a
the
The

?DES-F-IPC, Illegal protection class
Explanation:

You specified an illegal category of user.

User Action:
Enter
GROUP, or WORLD.

valid

user

category:

SYSTEM,

OWNER,

?DES-F-IPO, Illegal protection option specified
Explanation:

You specified an illegal access type.

User Action:
Enter a valid access
(representing
Read, Write,
Extend,
systems, E represents Execute).

2-54

type:
R,
or Delete;

or D
VAX/VMS

RMS-ll FILE DESIGN UTILITY:

RMSDES

?DES-F-IRO, Illegal response, must be octal numeric
Explanation:
You used a non-octal number
in the
specified in response to the Owner attribute prompt.
User Action:

UIC

you

Enter a valid UIC.

?DES-F-ISE, Illegal section specified
Explanation:

You specified an invalid section keyword.

User Action:
Reenter the command using a valid section keyword;
make sure the keyword is spelled correctly.
?DES-F-IVS, Illegal value specified
Explanation:
You entered an illegal value
attribute prompt.

response

User Action:
Enter a legal value;
see Section
descriptions of the attributes and their legal values.

2.6

an
for

?DES-F-KMA, Key missing corresponding area
Explanation:
You defined keys and assigned key levels to areas
but did not define the areas.
When you issued the CREATE
command, RMSDES could not define the areas.
User Action:
definitions.

Define the

area(s)

correspond

your

key

?DES-F-KNS, Key has not been defined
Explanation:

You specified a key that has not been defined.

User Action:
defined key.
keys.

Reenter the command specifying the number of a
Use the SHOW KEY ALL command to display the defined

?DES-F-KOR, Key number out of legal range
Explanation:
Keys are numbered from
specified a key outside of this range.
User Action:

through

255.

You

Reenter the command specifying a valid key number.

?DES-F-NAN, No area number given
Explanation:
You issued a CLEAR, HELP, SET, or SHOW command for
an area but did not specify an area number.
User Action:
number.

Reenter

the

command

2-55

specifying

valid

area

RMS-ll FILE DESIGN UTILITY:

RMSDES

?DES-F-NKN, No key number given
Explanation:
You issued a CLEAR, HELP, SET, or SHOW command for
a key but did not specify a key number.
User Action:

Reenter the command specifying a valid key number.

?DES-F-NUS, Not a user settable attribute
Explanation:
You tried to set
attribute is not user settable.
User Action:
None.
(source) system.

RMSDES

the

Source

automatically

attribute.
notes

the

This
user's

?DES-F-VOR, Value out of legal range
Explanation:
prompt that
attribute.

You entered a value in response to an attribute
was not
in the legal
range of values for that

User Action:
Enter a value within the legal range;
see Section
2.6 for descriptions of the attributes and their legal values.

2-56

CHAPTER 3
RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

The RMS-ll Indexed File Load Utility (RMSIFL) reads records from any
type of RMS-ll file and loads them into an RMS-ll indexed file created
to store them.
In addition, you can use RMSIFL to reestablish areas
of contiguity to indexed files (that is, to compress indexed files)
and to convert ASCII stream files to RMS-ll indexed files.
Unlike RMSCNV (see Chapter 4), RMSIFL does not use the standard RMS-ll
access methods to build the output file.
Rather, RMSIFL exploits the
basic structure of indexed files (see the RSX-IIM/M-PLUS RMS-ll User's
Guide)
to quickly insert data records and construct indexes. As it
does -so, RMSIFL creates optimally dense buckets at all levels of each
index.
RMSCNV, on the other hand, optimizes only the primary index when the
input file is sorted by the output file's primary key.
However, you
must use RMSCNV, not RMSIFL, if you do not have room for RMSIFL's sort
work files.
RMSIFL reads records from an input file and loads them into an indexed
output file in six phases:
1.

RMSIFL examines the command string for errors and determines
whether the input file is to be sorted.
If the input file
resides on a serial, nondisk device
(magnetic tape,
for
example), RMSIFL will capture the input file on disk.

If the input file is to be sorted, RMSIFL will read the input
file
in sequential access mode, extract the value for the
primary key and the record's file address
(RFA)
for each
record,
and write the primary key and RFA to a temporary
file.
The key values will then be sorted in ascending order.

RMSIFL loads the ordered records
into the output file,
constructing level 0 of the primary index a bucket at a time
and examining each record for compatibility with the output
file.
Incompa t i ble record s are processed as "except ion
records" (see Section 3.4).
RMSIFL also extracts the values for each of the alternate
keys,
if any, defined for
the file and writes them to a
temporary file.
Finally, RMSIFL assembles the index levels
of the primary index.

RMSIFL sorts the values for each of the alternate keys in the
temporary file by key number and ascending key value.
The
keys are sorted one at a time into another temporary file.

RMSIFL builds the alternate indexes.

When processing is finished, RMSIFL prints
and terminates.

3-1

closing

messages

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

Sections 3.4 and 3.5 describe these six processing phases
detail.

greater

The following sections describe how to
invoke and terminate RMSIFL
(Section 3.1) and the RMSIFL command string and switches (Sections 3.2
and 3.3). Section 3.6 provides examples
illustrating the use of
RMSIFL.
Appendix ·c, Section C.2, documents RMSIFL messages.

3.1

INVOKING AND TERMINATING RMSIFL

The RMSIFL utility can be either installed or uninstalled.
is installed, invoke it with the command:

RMSIFL

IFL [command-string]
If you include a command string, RMSIFL will execute the
return the system prompt.

command

and

If you do not include a command string, RMSIFL will prompt for one:
IFL)
If RMSIFL is uninstalled on RSX-llM/M-PLUS systems, invoke it with the
MCR command:
RUN $RMSIFL
RMSIFL will respond with the prompt:
IFL)
In response to the prompt, you can type a command string or you can
type CTRL/Z to terminate the utility.
When RMSIFL has executed a
command string, it returns the IFL) prompt. Section 3.2 describes the
RMSIFL command string.
Indirect Command Files. You can execute series of RMSIFL command
strings by means of indirect command files.
The command strings in an
indirect command file are executed when an at sign (@) followed by the
file'S
name is specified to the utility.
The default file type of
.CMD is assumed if none is provided.
Installed RMSIFL will accept indirect command files either from the
system prompt or from the utility prompt.
For example, to execute the
command strings contained in the indirect command file IFLCOM.CMD, you
could type either of the following commands:
IFL @IFLCOM
or
IFL) @IFLCOM
Uninstalled RMSIFL will accept indirect command files
utility prompt.
For example:

only

from

the

IFL) @IFLCOM
If you executed the indirect command file from the system prompt,
the
system prompt will be returned.
If you executed the indirect command
file from within RMSIFL, the IFL) prompt will be returned.

3-2

RMS-ll INDEXED FILE LOAD UTILITY:
3.2

RMSIFL

RMSIFL COMMAND STRING

Form.at
outfile[/switch ••• ]=infile[/switch ••• ]
outfile
The specification of an RMS-ll indexed file that
the records of the input file.

receive

Wild card characters are not permitted
in any field of
specification;
the default version is the highest version.

the

The file must exist before you run RMSIFL, it must have no data
in it other than the prologue, and it must have no more than 20
keys defined.
Bucket size should generally be restricted to 5 or
fewer blocks;
however,
the actual bucket size supported by
RMSIFL will vary depending on such factors as number of keys,
size of keys, record size, amount of memory available.
Note that RMSIFL may build an output file that
is smaller than
the
input file (RMSCNV may do the same;
however, the same input
file processed by both RMSIFL and RMSCNV may
result
in
different-size output files because of the different algorithms
that the two utilities use to build files).
infile
The specification of the file from which records will be written
to the output file.
Wild card characters are not permitted in
any field of the specification.
The file can have any RMS-ll
file organization but must have no more than 20 keys defined.
You cannot use a back-up file produced by RMSBCK as the
input
file
(see Chapter 6).
RMSIFL ignores the fixed-control area of
variable-with-fixed-control (VFC) records in the input file.
NOTE
When RMSIFL opens the
input file,
it
allows the file
to be accessed
for
reading but not for writing.
Thus,
no
writing task can access the input file
during RMSIFL processing.
Iswitch
One of the switches listed in Table 3-1 and described in
3.3.

Section

In place of the command string, you can type HELP or
?
to display
help
text about RMSIFL, or lID to display the current version of the
utility.

3-3

RMS-ll INDEXED FILE LOAD UTILITY:
Table 3-1:
Type
Global

RMSIFL Switches

Switch

Description

/ID

Identify current version
Default:

Output
File

RMSIFL

/ER[:file-spec]

No identification

Write primary keys of exception
records to the
terminal
if no
file-spec;
or write exception
records into the specified file
Default: Write primary keys of
exception records to the terminal

/NOER [: S]

Stop processing if
is incompatible

input

record

Default: Write primary keys of
exception records to the terminal
/LO

Honor fill numbers
Default:

/PD[: [#] x]

Pad
input
records
record length
Default:
exception
lengths

/TR

/DE:dvnl: [dvn2: ••• dvn5:]

/KR:n

output

input
as
different

Handle
records

output

input
as
different

Reassign devices
files

for

sort

work

Default:
Create
work files on SY:

and

use

sort

Key of reference number
Default:

/NOSO

Handle
records

Truncate input records to
record length
Default:
exception
lengths

Input
FiLe

Fill buckets

Primary key (n=O)

Do not sort records before loading
Default:
Sort records
file before loading
3-4

input

RMS-11 INDEXED FILE LOAD UTILITY:
3.3

RMSIFL

RMSIFL SWITCHES

This section describes the global, output file,
and
input fi~e
switches that you can specify in RMSIFL command strings.
Global
switches are switches that can be specified anywhere in the command
string.

3.3.1

Global Switch

The global switch is lID.

lID
Displays the current version number of the RMSIFL
example:

utility.

For

IFL)OUTFIL.DAT/ID=INFILE.DAT
IFL -- Version 2.000
The last two digits of the version number (00
in this example)
are the patch level of the utility.
The lID switch can also be
specified by itself on the command line:
IFL)/ID
IFL -- Version 2.000

3.3.2

Output File Switches

The output file switches are IER, INOER, ILO, IPD, and ITR.
IER[:file-spec]
Directs RMSIFL to continue processing if it encounters a record
in the input file that cannot be written to the output file, that
is, an exception record (see Section 3.4).
If you specify a
file,
the exception records will be written into that file.
If
you do not specify a file, the primary key of each exception
record will be written to the terminal.
RMSIFL also issues error
messages noting the reason for the exception record.
If you specify a nondisk file or a terminal, RMSIFL will create
the file as an RMS-ll sequential file with variable-length
records when it encounters the first exception record.
Then,
RMSIFL will write both the error message and the exception
record's primary key to the file.
RMSIFL will do this for every
exception record until it finishes processing.
If you specify a disk file, RMSIFL will create the file as an
RMS-ll sequential file with variable-with-fixed-control (VFC)
records when it encounters the first exception record.
Then,
RMSIFL will write the exception record and a 4-byte exception
code into the fixed-control area of the record.

3-5

RMS-11 INDEXED FILE LOAD UTILITY:

RMSIFL

The codes are:
Code
001:
002:
003:
004:
005:
006:
007:

Meaning
Record
Record
Record
Record
Record
record
Record
Record

is out of primary key sequence
contains an invalid primary key
is too short to contain output primary key
is too long to fit in output bucket
is not correct size for output fixed-length
is too long for maximum record size
contains an invalid packed decimal key

See also the /NOER switch.
By default, if you do not specify /ER,
RMSIFL will
write
the
appropriate error message and the exception record's primary key
to your terminal.
/NOER [: S]
Directs RMSIFL to print an error message, delete the output
file
(unless you
specify the save argument,
:S),
and
terminate
processing immediately if it encounters an
input
record
that
cannot be written into the output file (an exception record;
see
Section 3.4).
If you specify the save argument (:S), RMSIFL will not delete the
output
file.
Termination at
this point, however, leaves the
output
file
incomplete:
it
is
not a
valid
file
of
any
organization and cannot be reused for any RMS-ll purpose.
Using
the save argument is useful, for example, when your
output
file
is
large and
contiguous and you do not want to lose any of the
contiguous space to other users.
By default, if you do not
specify /NOER,
RMSIFL will
respond
according to the form of the /ER switch specified (taking the /ER
default of writing the primary key of each exception
record
to
the terminal if /ER was not specified).
/LO
Directs RMSIFL to write records into buckets according
to
the
bucket
fill
size established when the file was created (see the
RSX-IIM/M-PLUS RMS-ll User's Guide for more information on
fill
numbers) •
By default, if you do not specify /LO, RMSIFL will insert as many
records as possible into each bucket.
/PD [ : [#] x]
Directs RMSIFL to pad records read from the
input
file
to
the
output
file's
record
length before writing them to the output
file.
Specify the padding character as follows:
Switch

Character

NULL

PD:x

x is an ASCII character A-Z,
character except #, ?, or @

PD:#x

x is an octal number 000-377 (for
example,
SPACE, 43 for #, 77 for ?, or 100 for @)

3-6

0-9,

any

special
40

for

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

You can use the /PD switch only if the output
for fixed-length records.

file

was

created

When both the input and output files contain fixed-length
records,
RMSIFL requires either the /PD or /TR switch if the
fixed-length records are not equal.
If neither switch is
specified, RMSIFL will terminate with the fatal error message:
?IFL -- Input and output fixed length record sizes unequal
When the input file contains variable-length records and the
output file contains fixed-length records, RMSIFL may require
both the /PD and /TR switches.
If both are not specified, RMSIFL
will terminate with the fatal error message:
?IFL -- /TR and/or /PD required with fixed length output records
By default, if you do not specify /PD and the
input file's
records are shorter than the output file's records, RMSIFL will
treat the input records as exception records (see Section 3.4.3,
and the /ER and /NOER switch descriptions in this section).
/TR
Directs RMSIFL to truncate records read from the
input file
to
the output file's maximum record size before writing the input
records to the output file.
The trailing bytes of the record are
truncated.
When both the
input and output files contain fixed-length
records,
RMSIFL requires either the /TR or /PD switch if the
fixed-length records are not equal.
If neither switch is
specified, RMSIFL will terminate with the fatal error message:
?IFL -- Input and output fixed length record sizes unequal
When the input file contains variable-length records and the
output file contains fixed-length records, RMSIFL may require
both the /TR and /PD switches.
If both are not specified, RMSIFL
will terminate with the fatal error message:
?IFL -- /TR and/or /PD required with fixed length output records
By default, if you do not specify /TR,
RMSIFL will treat the
input records as exception records (see Section 3.4.3, and the
/ER and /NOER switch descriptions in this section).

3.3.3

Input File Switches

The input file switches are /DE, /KR, /NOSO.
/DE :dvnl: [dvn2: ••. dvn5:]
Directs RMSIFL to reassign the devices on which it allocates the
three sort work files and the two primary and alternate key
temporary files (see Section 3.4.2).
The argument dvn:

is a physical device name and number.

3-7

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

If you specify /DE, RMSIFL will
reassign all
three
files and the two key temporary files, as follows:

sort

work

•

If you specify one device name, RMSIFL will reassign all
files to that device.

five

•

If you specify two device names, RMSIFL will reassign one work
file
to the first device and four files (two work and two
temporary) to the second.

•

If you specify three device names, RMSIFL will
reassign one
work file
to the first device, one work file to the second,
and three files (one work and two temporary) to the third.

•

If you specify four device names, RMSIFL wi 11 assign each of
the three work files
to
the first three devices and both
temporary files to the fourth.

•

If you specify five device names, RMSIFL will assign one
to each device.

file

For optimal performance, you should assign each sort work file to
a different device.
For example:
IFL>OUTFIL.DAT~INFILE.DAT/DE:DMO:DMl:DM2:DM3:DM4:

However, if you have only two devices, assign the first,
third,
and fifth files to one device and the second and fourth files to
the other device:
IFL>OUTFIL.DAT~INFILE.DAT/DE:DMO:DMl:DMO:DMl:DMO:

By default, if you do not specify /DE,
RMSIFL will
sort work files and the key temporary files to SY:.

assign

the

/KR:n
Directs RMSIFL to read an indexed input file according to the key
of reference specified by n:
n is 0 for the primary key, 1 for
the first alternate key, and so on up to 19.
The /KR switch can
eliminate the need for RMSIFL to sort the input file (see Section
3.4.1) .
You can specify /KR only with indexed
input
files.
RMSIFL will terminate with a fatal error message.

Otherwise,

By default, if you do not specify /KR and
the
input file
is
indexed,
RMSIFL will read the file using the primary key as the
key of reference.
/NOSO
Directs RMSIFL to bypass the primary key sorting phase of
processing
(see Section 3.4.1) because the input file is already
sorted.
If the input file is not
in ascending order by the
output file's
primary key,
RMSIFL's response will depend on
whether you have specified /NOER or a form of /ER with the output
file specification (see Section 3.3.2).
Note that RMSIFL will still sort the alternate keys even if /NOSO
is specified.
By default, if you do not specify /NOSO,
RMSIFL will sort all
records
from the
input file into the proper order (see Section
3.4.2) •

3-8

RMS-ll INDEXED FILE LOAD UTILITY:
3.4

RMSIFL

RMSIFL PROCESSING

(if necessary),
RMSIFL reads records from an input file, sorts them
and loads them into an empty indexed RMS-ll output file in six phases,
described in the following sections.

3.4,.1

Checking the Command Str ing

RMSIFL first examines the command string for syntax and other errors.
If
it finds an error, it will print an error message and prompt for a
new command string. When a valid command string
is entered,
RMSIFL
detE~rmines whether the input file must be sorted in ascending order by
the output file's primary key (the second phase of RMSIFL processing;
see Section 3.4.2).
RMSIFL will bypass the primary key sorting phase if you have specified
either
the /NOSO or /KR input file switch (see Section 3.3.3).
The
/NOSO switch directs RMSIFL to bypass sorting because you have already
sorted the input file.
The /KR switch specifies a key of reference for an indexed input file.
If
the key of reference specified is equal to or contains the output
primary key, based on position only, RMSIFL will bypass the sorting
phase.
Nonstring key types must match exactly in starting position
and length.
String keys must start in the same position, but the
output primary key can be the same length or shorter than the input
key of reference.
For example, if the 10-byte string input primary key starts at byte 0
and the 8-byte string output primary key starts at byte 3, RMSIFL will
sort the input file.
However, if the 10-byte string
input alternate
key starts at byte 0 and is specified as the key of reference, and the
8-byte string output primary key starts at byte 0,
RMSIFL will
not
sort the input file.
For another example, if the 3-byte packed decimal input alternate key
1 starts at byte 43 and is specified as the key of reference, and the
3-byte packed decimal output primary key starts at byte 42,
RMSIFL
will sort the input file.
RMSIFL notifies you that it has started
message:

processing

printing

the

mode,

depending

PRIMARY KEY

3.4.2

Reading and Sorting the Input Records

RMSIFL reads the input file in sequential access
the organization of the input file:
Input File
Organization

Processing

Sequential

RMSIFL reads the records
in sequential access
mode, starting with the first record in the file.

Relative

RMSIFL reads the records
in sequential
mode, starting with record cellI.

access

Indexed

RMSIFL reads the records
in sequential
mode, following the key of reference.

access

3-9

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

RMSIFL passes the primary key from each record to the sort routines,
which are provided with RMSIFL.
These routines sort the keys into
ascending order.
At the beginning of this phase,
RMSIFL initially
allocates disk space for
three sort work files (see Section 3.5).
(YOll can use the IDE input file switch to specify the disks to which
these files are assigned;
see Section 3.3.3.)
RMSIFL indicates the start and finish of this phase
messages:

printing

the

If an error occurs during the sorting, RMSIFL will terminate with
message:

the

SORT HAS STARTED
SORT MERGE PHASE HAS FINISHED

SORTS ERROR CODE IN OCTAL:nn
See Appendix D for a description of the sort routine error codes.
At the end of this phase, RMSIFL deletes the sort work files.
As
output from this phase, RMSIFL creates a file, IFLP.TMP, containing
the RFA from each record in the input file, sorted in ascending order
by primary key.
See Section 3.5.

3.4.3

Loading Records in the Output File

RMSIFL loads the ordered
input records
into the output
file,
constructing level 0 of the primary index (the data level) a bucket at
a time (see the RSX-IIM/M-PLUS RMS-ll User's Guide for information on
the primary index).
If the records were sorted in the previous processing phase,
RMSIFL
will
read the RFA for each record
from
IFLP.TMP, then read the
associated reco~d, by RFA, from the input file.
IFLP.TMP is deleted
at the end of this phase.
If the records were not sorted in the previous processing phase
(see
Section 3.4.1), RMSIFL will read the records in sequential order from
the input file.
RMSIFL examines each input record to ensure that it is compatible with
the output file.
If the record is not compatible, RMSIFL processes it
as an exception record according to the IER or INOER input file switch
specified
in the command string
(see Section 3.3.3).
Exception
records can occur for any of the following reasons:
•

You specified the INOSO input file switch and RMSIFL found
a
record that was not in ascending order by the output file's
primary key.

•

You did not allow duplicates in a key of the output file,
but
an
input file
record contains a duplicate value in that key
field.

•

An input record is not long enough to contain the primary
of the output file.

•

An input record is too long to fit in a bucket of
file.

3-10

the

key

output

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

input record is not compatible with the output file's
• An
fixed-length
record
and you did not specify the /PD
format
and/or the /TR switch.
An
input record
longer
is
• variable-length
maximum record

file's
than
the
output
size and you did not specify

the /TR switch.
•

An input record contains an invalid packed decimal key:
a
digit half-byte
is greater than 9 or the sign half-byte is
less than 10.

In all these cases,
RMSIFL issues
message noting
that an exception
continues processing.

an appropriate nonfatal error
record has occurred and why, and

If RMSIFL encounters an exception record while processing alternate
index(es),
it flags as deleted the data records in the primary index.
RMSIFL does not remove the record from the file.
The record can be
compressed
during
later
use
of
the
indexed
file
(see the
RSX-·IIM/M-PLUS RMS-ll User's Guide).
You can add corrected exception records
to the output file after
RMSIFL terminates by using either an application program or RMSCNV
(possibly using your terminal as the input device;
see Chapter 4).
If the record being read is compatible,
level-O bucket being built in memory.

RMSIFL

inserts

into

As RMSIFL places each record in the output file,
it extracts the
values for each of the alternate keys defined for the file, if any:
•

RMSIFL combines the alternate key value with the record file
address
(RFA)
of the user data record that supplied the key
value.
RFAs are 6 bytes long.
RMSIFL then appends a byte
with the key number.

•

RMSIFL writes the alternate key records
into a separate
temporary file,
IFLA.TMP,
which
is marked for deletion.
RMSIFL allocates disk space for
this file as described
in
Section 3.5.

During this phase, RMSIFL also assembles the
index
levels of the
primary index.
RMSIFL puts an index record into a level-l bucket for
each level-O bucket it writes to the file.
When it writes a
level-l
bucket,
RMSIFL inserts an index record in a level-2 bucket and so on
up to and including the root.
RMSIFL indicates the start and finish of this phase
messages:

printing

the

LEVEL-O LOADING HAS STARTED
LOADING HAS FINISHED

3.4.4

Sorting the Alternate Key Temporary File

RMSIFL sorts the alternate key temporary file by key number and
ascending key value, using the same sort routines as in phase 2 (see
Section 3.4.2).
Nonstring key data types are converted to
a
string-like representation for sorting only.

3-11

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

If there is more than one alternate key, RMSIFL will sort one at a
time,
building each alternate index after that index's keys have been
sorted (see Section 3.4.5).
For each alternate key, RMSIFL allocates the disk space for three sort
work files, as described in Section 3.5.
RMSIFL indicates the start and finish of this phase
message:

printing

the

ALTERNATE KEY(S)
At the end of each alternate key sort, RMSIFL deletes the sort work
files.
As output from each sort, RMSIFL creates a temporary file,
IFLA1.TMP, which contains the key values and RFAs for
an alternate
key.

3.4.5

Building the Alternate Indexes

RMSIFL builds the alternate indexes one at a time from level 0 up to
the root, using the sorted temporary file, IFLA1.TMP, for each key for
input.
RMSIFL prints the following message as it
index:

constructs

each

alternate

KEY nnn
The variable nnn starts at 1.

3.4.6

Terminating Processing

RMSIFL prints the
completely loaded,
string:

following messages when the output file
is
then terminates processing of the current command

NUMBER OF INPUT RECORDS:
nnnnnnnnn
NUMBER OF OUTPUT RECORDS:
nnnnnnnnn
NUMBER OF EXCEPTION RECORDS:
nnnnnnnnn
NOTE
RMSIFL extends the output file
if it
cannot contain the input records and the
index(es).
The utility minimizes this
overhead by extending the file a set
quantity each time it requires space.
This quantity
is the integral mUltiple
of bucket size less than or equal to 50.

3.5

CALCULATING TEMPORARY FILE WORK SPACE

If the input file is on a serial, nondisk device, RMSIFL must capture
the file on disk before it can process the file.
The file captured on
disk is the same size as the input file.
This file is deleted after
the primary index is built.

3-12

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

At the beginning of phase 2 (see Section 3.4.2), RMSIFL allocates disk
space for
three sort work files, calculating the space for each as
follows:
1.5

* NDRF *

(6 + PKS + PAD)/512.

or
1/8 the size of the input file, whichever is larger.
NRDF is the number of user data records in the input file.
PKS is the size of the primary
decimal keys).

key,

bytes

(plus

for

packed

PAD is the number of null bytes added to word-align the record:
PAD

a if PKS is an even number

PAD

1 if PKS is an odd number

The output from this phase,
follows:
6

IFLP.TMP,

allocated

disk

space

* NRDF/512.

In phase 3, if alternate keys are defined for
the output file
(see
Section 3.4.3), RMSIFL will create the temporary file IFLA.TMP with an
initial allocation of 100 blocks and a default extension quantity of
100 blocks.
The final size of this temporary file is calculated as
follows:
(NDRF

* NAK *

(7 + LKS + PAD»/512.

NDRF is the number of user data records in the input file.
NAK is the number of alternate keys defined for the output file.
LKS is the size of the largest alternate key defined
file, in bytes (plus 1 for packed decimal keys).

for

the

output

PAD is the number of null bytes added to word align the record:
PAD

a if PKS is an even number

PAD

1 if PKS is an odd number

In phase 4, RMSIFL sorts the alternate keys one at a time (see Section
3.4.4).
To sort each key,
RMSIFL creates three sort work files,
calculating the disk space for each as follows:
1.5

* NDRF * (6 + AKS + PAD)/512.

NDRF is the number of user data records in the input file.
AKS is the size of the alternate key, in
decimal keys)

bytes

(plus

for

PAD is the number of null bytes added to word align the record:
PAD

a if PKS is an even number

PAD

1 if PKS is an odd number

3-13

packed

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

The output from each alternate key sort, IFLAl.TMP,
space as follows:
NDRF

* (6

is allocated

disk

+ AKS)/512.

Note that if the /DE output file
switch is specified
(see Section
3.3.3),
IFLAl.TMP will be assigned
to the same device to which
IFLP.TMP was assigned.

3.6

RMSIFL EXAMPLES

>IFL

PAY~OL.DAT=PAYROL.SEQ

Primary key
Sort has started
Sort merge phase has finished
Level-O loading has sta~ted
Loading has finished
Alternate key(s)
Alternate key 1
Number of input records: 448
Number of output records: 448
Number of exception records: 0
In this example, RMSIFL loads a sequential input file
into an empty
output
indexed
file.
RMSIFL sorts the input records and reports the
total number of records processed.
>IFL VHC.INX/TR/NOER=VHC.SEQ
Primary key
Sort has started
Sort merge phase has finished
Level-O loading has started
Loading has finished
Alternate key(s)
Alternate key 1
Number of input records: 11
Number of output records: 11
Number of exception records: 0
RMSIFL sorts the input records from the file VHC.SEQ and
truncates
them to fit
the maximum record size of the output file records in
VHC.INX.
There are no exception records,
so the RMSIFL command
completes successfully.
>TYP VHCKRO.DES
GET VHC.INX DAT
SET FILE NAME VHCKRO.INX
SET FILE SUPERSEDE YES
SHOW ALL
CREATE
>DES @VHCKRO.DES
SYSTEM
Target
Source

RSX
RSX

3-14

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

FILE
Name
VHCKRO.INX
(Explicit)
Organization
INDEXED
Allocation
62
Extension
1
Bucket Size
4
(SYSTEM:RWED, OWNER:RWED, GROUP:RWED, WORLD:R
Protection
Owner
[70,5]
Max Record Number
o
Contiguous
NO
Supersede
YES
(Explicit)
RECORD
Size
80
Format
FIXED
Control Field Size
o
Carriage Control
CARRIAGE RETURN
KEY
0Name
NPANXX
Type
STRING
Null Key
NO
Null-Value
o
DuplIcates
NO
Changes
NO
SegO position
31
SegO-Length
6
Data-Fill
50
Data-Area
o
Index Fill
50
Levell Index Area
o
Index Area
o
KEY
I
Name
PLACE
Type
STRING
Null Key
NO
Null-Value
o
DuplIcates
YES
Changes
YES
SegO position
59
SegO-Length
12
Data-Fill
50
Data-Area
o
Index Fill
50
Levell Index Area
o
Index Area
o
AREA
0
Allocation
40
Extension
0
Bucket Size
4
Contiguous
NO
position
NONE 0
Exact Positioning
NO
>IFL VHCKRO.INX/ER:VHC.ERR=VHC.INX/KR:l/NOSO
Primary key
Level-O loading has started
Loading has finished
Alternate key(s)
Alternate key 1
Number of input records: 11
Number of output records: 6
Number of exception records: 5

3-15

RMS-ll INDEXED FILE LOAD UTILITY:

RMSIFL

First, RMSDES is used to create an indexed file, VHCKRO.INX.
Note that a RMSDES GET command is used to get the file
the VHC.INX file:
the contents of
the DES GET
initially, and then the DES file is invoked.

attributes of
file are shown

Next, RMSIFL takes the input records from the indexed file VHC.INX, in
thE~
order of
the
first
alternate key, and puts them in the output
indexed file.
Because the /NOSO switch is specified, RMSIFL assumes that the records
are ordered properly already.
In this case, five exception records
are generated and placed in the file VHC.ERR because the records are
actually out of sequence for the primary key.

3-16

CHAPTER 4
RMS-ll FILE CONVERSION UTILITY:

RMSCNV

The RMS-ll File Conversion utility
(RMSCNV)
reads records from an
RMS-·ll file of any type and loads them into another RMS-ll file of any
type.
For example, RMSCNV can:
•

Create a new sequential file from the records of
sequential, relative, or indexed file

existing

•

Supersede an existing sequential file with
another sequential file,
or the records
indexed ffle

•

Append the records of one sequential file
to
another
sequential file, or the records of a relative or indexed file
to a sequential file

•

Write the records of a sequential, relative, or
into another file of any organization

the records of
of a relative or

indexed

file

On operating systems with DECnet network capabilities and on which
RMSCNV has Data Access Protocol (DAP) support, RMSCNV file conversions
can take place over the network.
That is, in addition to local file
conversions, you can convert files between a local and a remote node,
or between two remote nodes.
In 1?igure 4-1, the user is running RMSCNV on an RSX-llM/M-PLUS system
to convert a
file on a
RSTS/E system to a new file on a VAX/VMS
system.
The /CA switch creates the output file on the VAX/VMS system
with the same attributes as the input file and copies the input file
records into it.
The /SL switch writes the summary listing to a file
on the RSX-llM/M-PLUS system under the user's UIC.
See Section 4.3 for more information about the /CA and /SL switches.
See the RSX-llM/M-PLUS RMS-ll User's Guide for more information about
file specIfIcations.
RMSCNV uses the standard RMS-ll access methods to build the output
filE~.
Unlike RMSIFL
(see Chapter 3),
RMSCNV optimizes only the
primary index when the input file is sorted by the
indexed output
fill~'s primary key.
However, RMSCNV allows you to add records from an
input file to an output file that already contains records
(RMSIFL
loads only empty output files).
In addition, RMSCNV can read and write records in block mode.

4-1

RMS-11 FILE CONVERSION UTILITY:

RMSCNV

NODEX

DECnet

SUM.LST

RSX-11 M/M-PLUS
SYSTEM
V AXIVMS SYSTEM
DECnetiE

DECnetlVAX

NODER

NODEV

DB1 :[100,1 OO]IN.DAT

DBA1 :[USER]OUT.DAT
ZK-1124-82

Figure 4-1:

Using RMSCNV with DECnet

You can use RMSCNV to perform the following operations:
any RMS-11 file to magnetic tape.
RMSCNV will conve.rt
• Copy
the file
to a sequential file.
You can recopy the file to
disk by redefining the original file using RMSDES (see Chapter
2)
and
then rerunning RMSCNV (or running RMSIFL for indexed
files) to load the records from the tape.
•

Print any RMS-11 file with carriage-return control.
RMSCNV
can convert the file for output directly to a line printer, or
it can convert the file's
records
to variable format with
carriage return control
so the file can be queued to a line
printer.
NOTE
RMS-ll does not convert
binary data to ASCII data.

•

numeric

Reestablish areas of contiguity to files restored by RMSRST.
Use RMSDES to create the file with the attributes you want and
use RMSCNV to populate the file with the
single-area,
noncontiguous
file produced by RMSRST (for indexed files, it
is suggested that you use RMSIFL;
see Chapter 3).

4-2

RMS-ll FILE CONVERSION UTILITY:
•

RMSCNV

Convert ASCII stream files to RMS-ll file organizations by
first creating the new file using RMSDES.
When possible, if
you are building a relative or indexed file,
sort the ASCII
file by relative record number or by primary key.
Then build
the new file using RMSCNV.

For example, one application of RMSCNV might be as
follows:
daily
processlng
is done using a small.file designed for that purpose.
At
the end of the day, RMSCNV can be used to add the records in the small
file
to a
larger, master
file.
In addition, RMSCNV's ability to
convert ASCII stream files to RMS-ll file organizations can be useful
in intersystem migration (for example, RSTS/E to RSX-llM).
All RMSCNV functions involve the movement of records from one file
to
another.
The manner in which RMSCNV reads records from the specified
input file and writes them to the specified output file depends on the
file organization of both the
input and output files and on the
switches you specify in the command string.
Section 4.4 describes
RMSCNV processing in greater detail.
The following sections describe how to
invoke and
terminate RMSCNV
(Section 4.1) and the RMSCNV command string and switches (Sections 4.2
and 4.3).
Section 4.5 provides examples
illustrating the use of
RMSCNV.
Appendix C documents messages.

4.1

INVOKING AND TERMINATING RMSCNV

The RMSCNV utility can be either installed or uninstalled.
is installed, invoke it with the command:

RMSCNV

CNV [command-string]
If you include a command string, RMSCNV will execute the
return the system prompt.

command

and

If you do not include a command string, RMSCNV will prompt for one:
CNV>
If RMSCNV is uninstalled on RSX-llM/M-PLUS systems, invoke it with the
MCR command:
RUN $RMSCNV
Note, however, that uninstalled RMSCNV will respond with a prompt that
reflects the current process name (abbreviated to 3 characters).
For
example:
RUN $RMSCNV
>TTl:
You can install RMSCNV with another name as follows:
INS $RMSCNV/TASK= ••• xxx
where xxx is a 3-character name that you chose for the
utility will then prompt:
xxx>
RMSCNV will respond with the prompt:
CNV>
4-3

utility.

The

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

In response to the prompt, you can type a command string or you can
type CTRL/Z
to
terminate the utility.
When RMSCNV has executed a
command string, it returns the CNV> prompt.
Section 4.2 describes the
RMSCNV command string.
Indirect Command Files.
You can execute series of RMSCNV command
strings by means of indirect command files.
The command strings in an
indirect command file are executed when an at sign (@) followed by the
file's
name
is specified
to the utility.
The default file type of
.CMD is assumed if none is provided.
Installed RMSCNV will accept indirect command files
either
from
the
system prompt or from the utility prompt.
For example, to execute the
command strings contained in the indirect command file CNVCOM.CMD, you
could type either of the following commands:
CNV @CNVCOM
or
CNV> @CNVCOM
Uninstalled RMSCNV will accept indirect command files
utility prompt.
For example:

only

from

the

CNV> @CNVCOM
If you executed the indirect command file from the system prompt,
the
system prompt will be returned.
If you executed the indirect command
file from within RMSCNV, the CNV> prompt will be returned.

4.2

RMSCNV COMMAND STRING

On systems with DECnet network capabilities and on which RMSCNV has
DAP support,
both the output
file and input file can be on remote
network nodes.
See the RSX-llM/M-PLUS RMS-ll User's Guide for more
information on file specifications.
If either the input file or the output file is relative or
indexed,
the bucket size should, in general, be no greater than 15 blocks.
The
actual allowable bucket size for either file, however, will depend on
many factors directly related to processing, such as:
maximum record
size for either file, number of keys
for either
file,
whether /SL
and/or /IM is specified,
whether the network is configured, and so
forth.
Note that if the maximum record sizes for the input and output files
are different,
you may have to specify the /PD or /TR switch or both
(see Section 4.3).
Format
[outfile[/switch ••. ]=]infile[/switch ... ]
outfile
The specification of the file that is to receive the records of
the
input
file.
Wild card characters are not permitted in any
field of the specification.
RMSCNV will automatically create a sequential output file if
does not already exist.

4-4

one

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

Note, however, that when you specify the lEO switch, an output
file specification is not allowed, and no output file will be
created.
See Section 4.3 for more information on the lEO switch.
The default version for existing sequential output files (those
specified with the lAP or ISU switch;
see Section 4.3),
for
relative files, and for indexed files is the highest version;
if
an existing sequential file is specified and neither the lAP nor
the ISU switch is specified, RMSCNV will use the highest existing
version number plus 1.
A relative or indexed output file must exist before RMSCNV is
invoked
(unless you specify the ICA switch;
see Section 4.3).
You can create the file using either an application program or
the RMSDES utility (see Chapter 2).
RMSCNV may build an output file that is smaller than the
input
file.
(RMSIFL may do the same;
however, the same input file
processed by both RMSCNV and RMSIFL may result in different-size
output files because of the different algorithms that the two
utilities use to build files.)
You can specify a unit record device, such as a
terminal or a
line printer,
as the output file.
Specify the current user's
terminal as TI:.
By default, if no output file is specified, the
records of the input file are written to your terminal (that is,
TI:
is the defaul t) •
infile
The specification of the file from which records will be written
to the output file.
Wild card characters are not permitted in
any field of the specification.
You cannot use a back-up file produced by RMSBCK as the input
file
(see Chapter 6), except to copy the file using the 11M
switch (see Section 4.3).
You can specify a unit record device, such as a card reader or
terminal, as the input file.
Specify the current user's terminal
as TI:.
End terminal input with CTRL/Z.
Iswitch
One of the switches listed in Table 4-1 and described in Section
4.3.
All switches are global;
that is, they can be specified
anywhere in the command string.
In place of the command string you can type HELP or? to display help
text about RMSCNV,
or IrD to display the current version of the
utility.

4-5

RMS-ll FILE CONVERSION UTILITY:
Table 4-1:

RMSCNV Switches

Switch
lAP

Description
Append
records
sequential file
Default:

IBL [ : n]

existing

No appending

Set magnetic tape block size
Default:

ICA [: file-spec]

RMSCNV

512 bytes

Create an output
file
with
the
attributes of an existing input file
Default:
Output file must exist or
sequential file will be created

lEO

Convert CTRL/Z end-of-file character
in an ASCII stream file to null and
pad the file with nulls
to
the
physical end of file
Default:
file

IFO:x

Sequential

(S)

No identification

Use standard

RMS-ll

access

Read an indexed file using the key
reference specified by keyname
Default:

IKR:n

stream

Process files in block mode
Default:
methods

IKN: ["] keyname ["]

null-filled

Identify current version
Default:

11M

Assume

Set output file organization, where
isS, R, or I
Default:

lID

Read file using primary key

Read an indexed file using the key
reference specified by n

Default:

key

Read file using primary

(0)

ILO

Honor bucket fill
size when
filling
buckets in the output indexed file
Default:

IMA

Fill buckets to capacity

Use mass-insertion mode
PUT operations

and

sequential

Default:
No mass insertion;
operations

random PUT

(continuted on next page)
4-6

RMS-ll FILE CONVERSION UTILITY:
Table 4-1 (Cont.):

RMSCNV Switches

Switch
/ML:n

Description
Explicitly
allocation

/PD [ : [#] ["] x [ " ] ]

/SL [: file-spec]

set

limit

Default:
Allow
the amount of
allocation

RMSCNV
memory

buffer

to calculate
available for

records

Default:

No record padding

output

Provide summary listing (in
specified)

record

file,

No summary

Supersede existing sequential file
Default:

/TR

No supersession

Truncate input
record length
Default:

/WF

records

output

No record truncating

Write or read fixed-control area
Default:

4.3

Pad input
length

Default:
/SU

RMSCNV

Ignore fixed-control area

RMSCNV SWITCHES

/AP
Directs RMSCNV to append records to an existing sequential output
file.
That is, RMSCNV adds the input file records to the end of
the output file.
You cannot specify /AP and /SU in the same
command string.
If the output file is not sequential, RMSCNV
will ignore the /AP switch.
By default, if you do not specify /AP,
RMSCNV
according to whether you have specified /SU:

will

respond

•

If you specified /SU,
sequential output file.

the

existing

•

If you did not specify /SU and the output file exists,
will create the next higher version of the file.

RMSCNV

supersedes

See also the description of the /SU switch.

4-7

RMSCNV

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

IBL[:n]
Specifies the physical block size of the output file when
it
is
being created on magnetic tape.
The argument n must be a number
from 18 to 8192 (decimal).
If you do not specify n, RMSCNV will
use a
tape block size of
512 (decimal) characters.
You can
specify IBL only with sequential tape files.
If you specify IBL
with other files, RMSCNV will return the following error message:
%CNV-F-IAS,

Illegal use of lAP, IBL, or ISU with file
organization

By default, if you do not specify IBL, RMSCNV
block size of 512 (decimal) characters.

will

use

tape

ICA[:file-spec]
Directs RMSCNV to create an output file with the attributes of an
existing file and to copy the records of the input file into it.
If you specify a file with ICA, RMSCNV will create
file with the attributes of the specified file.

the

output

If you do not specify a file with ICA,
RMSCNV will
output file with the attributes of the input file.

create

the

Note, however, that if the existing file is indexed and contains
multiple areas,
these areas will not be preserved in the newly
created file.
The new file will
be a
single-area
file.
Its
bucket size will be that of
the
largest bucket size in the
multiple-area file.
Bucket fill size also will not be preserved.
RMSCNV will insert as many records as possible into each bucket.
Two informational messages will be issued when this occurs:
%CNV-W-OOA, Output file will contain only one area
%CNV-W-FQL, Output indexed file fill quantities will not be
preserved
By default, if you do not specify ICA,
the
requirements and
defaults for output file specifications apply (see Section 4.2).
lEO

Converts a CTRL/Z end-of-file character in ASCII stream files
to
a null character (ASCII 000) and fills the remainder of the file,
to the physical end-of-file, with null characters.
Note that when you specify lEO, an output file specification
is
not allowed,
and no output file will be created. lEO operates
directly on the input file.
For example:
CNV>INFILE.DAT/EO
After processing, INFILE.DAT will be null-filled to end-of-file.
If the CTRL/Z signals both end-of-record and end-of-file,
CTRL/Z
is
retained as
the end-of-record character and
remainder of the file is null-filled.

4-8

the
the

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

NOTE
RMS-ll no longer recognizes CTRL/Z as an
end-of-file character. Therefore, ASCII
stream files that end with CTRL/Z should
be converted, using this switch, to the
format
recognized
by
RMS-ll
(null-filled) •
If you specify a file
that ends with CTRL/Z and do not specify
lEO,
the CTRL/Z character will become
part of the data in the file;
it will
no longer signal end-of-file.
By default, if you do not specify lEO, RMSCNV will assume that
the input stream file is padded with null characters from logical
to physical end-of-file.

IFO:}(
Specifies the organization of the output file.
must be one of the following:
S
R
I

The

argument

sequential file
relative file
indexed file

By default, if you do not specify IFO, RMSCNV will use sequential
organization and create an output file with the attributes of the
input file (see Section 4.4.1).

lID
Displays the current version of the RMSCNV utility.

For example:

CNV>OUTFIL.DAT/ID=INFILE.DAT
%CNV-I-ID, Version 2.000
The last two digits of the version number (OO
in this example)
are the patch level of the utility.
The lID switch can also be
specified by itself on the command line:

CNV>/ID
%CNV-I-ID, Version 2.000
11M
Directs RMSCNV to read the records of the input file and write
the records to the output file block by block, that is, in block
access mode.
You can use the IML switch with 11M to specify the number of
blocks to be processed in a single READ or WRITE operation.
See
the description of the IML switch.
By default, if you do not specify 11M, RMSCNV will convert
using the standard RMS-ll access methods.

4-9

files

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

/KN: ["] keyname [ "]
Directs RMSCNV to read an indexed file based on the key named
in
the
argument keyname
(key name assignment
is an optional
capability provided by RMSDES;
see Chapter 2).
The quotation marks are required only if the key
spaces, special characters, or lowercase letters.
You can specify /KN only for indexed
files.
will te~minate with the fatal error message:
?CNV-F-IAX,

name

contains

Otherwise,

RMSCNV

Illegal use of /KN, /KR, /LO, or /MA with file
organization

See also Section 4.4.2 for a way to use /KN to examine an indexed
input file at your terminal.
You cannot specify /KN and /KR in the same command string.
By default, if you do not specify /KN
(and you also have not
specified /KR)
and the input file is indexed, RMSCNV will read
the file using the primary key as the key of reference.
/KR:n
Directs RMSCNV to read an indexed input file based on the key
numbered n:
n is 0 for
the primary key,
1 for the first
alternate key, and so on.
You can specify /KR only with indexed
input
files.
RMSCNV will terminate with the fatal error message:
?CNV-F-IAX,

Otherwise,

Illegal use of /KN, /KR, /LO, or /MA with file
organization

See also Section 4.4.2 for a way to use /KR to examine an indexed
input file's contents.
You cannot specify /KR and /KN in the same command string.
By default, if you do not specify /KR
(and you also have not
specified /KN)
and
the input file is indexed, RMSCNV will read
the file using the primary key (0) as the key of reference.
/LO
Directs RMSCNV to write records into buckets of an
indexed
file
according
to the bucket fill sizes established when the file was
created.
See the RSX-llM/M-PLUS RMS-li User's Guide for more
information on bucket fill sizes.
You can specify /LO only with
indexed output files.
Otherwise, RMSCNV will terminate with
the
following error message:
?CNV-F-IAX,

Illegal use of /KN, /KR, /LO, or /MA with file
organization

By default, if you do not specify /LO, RMSCNV will insert as many
records as possible into each bucket.
/MA
Directs RMSCNV to use mass-insertion mode (see the RSX-llM/M-PLUS
RMS-ll User's Guide)
and sequential
PUT operations to insert

4-10

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

records into an indexed output file.
Your
indexed input file
must be sorted
in ascending order by the output file's primary
key.
Otherwise, RMSCNV will terminate with the fatal error
message:
?CNV-F-ER$SEQ, Record not in proper key sequence for file
<file-spec>
Mass-insertion mode provides improved performance only if records
are to be inserted at the logical end-of-file.
Therefore, either
the output file should be empty, or the input file should contain
records with primary key values greater than the primary key
value of the highest record that currently exists in the output
file.
If the input records do not meet this requirement, RMSCNV
will continue to process them.
However, it will not achieve the
improved performance otherwise possible with mass-insertion mode.
For example, suppose you have two indexed files,
IOX.IN and
IOX.OUT.
The primary key of IOX.IN is defined as bytes 0 through
15 of each record, and the primary key of IOX.OUT is defined as
bytes 0 through 8 of each record.
Because RMS-ll orders records
in indexed files according to primary key value, you can convert
IOX.IN to IOX.OUT using the /MA switch with the default key of
reference.
Note that if the primary key of
lOX. OUT is the same as an
alternate key of lOX. IN, you can still use the /MA switch if you
specify the proper alternate key with the /KR input file switch
(see Section 4.3.3).
You can specify /MA only with indexed output files.
Otherwise,
RMSCNV will terminate with the following error message:
?CNV-F-IAX, Illegal use of /KN, /KR, /LO, or /MA with file
organization
By default, if you do not specify /MA, RMSCNV will use random PUT
operations to insert each record in the output file.
/ML:n
If you are using block access mode
(that is,
also specifying
/IM), /ML specifies the number of blocks to be processed in a
single READ or WRITE operation.
(See also the description of the
/IM switch.)
If you are using the standard RMS-ll access modes, /ML specifies
the amount of memory available to be allocated to all buffers for
the conversion operations, where n specifies K words (lK=1024).
You can use this switch to override RMSCNV's memory
routines and explicitly specify memory allocation.

calculation

You can specify any positive number for n;
if n is too large for
the amount of memory available, RMS-ll will issue a fatal error
message:
?CNV-F-MLE, Block value of /ML switch exceeds limit or
available memory
If n is too small or if you specify /ML:l, RMS-ll will allocate
minimal
amounts
of memory.
If n is 0,
RMSCNV's memory
calculation routines will be used
(this
is the same as not
specifying /ML).

4-11

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

By default,
if you do not specify /ML,
RMSCNV's
memory
calculation routines will be used
to calculate the amount of
memory available for the conversion operations.
/PD [ : [#] ["] x [ II ] ]
Directs RMSCNV to pad records read from the input file.
You use
/PD when the output file has fixed-length records and a maximum
record size greater than the input file's maximum record size.
(The
input file's
records can be either variable or fixed
length.)
In addition, when the output file contains fixed-length
records,
the
input file contains variable-length records, and the output
file's maximum record size is less than the
input file's,
you
must specify both /PD and /TR.
If both are not specified, RMSCNV
will terminate with the fatal error message:
7CNV-F-TPM, Switch /TR or /PD or both are needed for this CONVERT
(See also the description of the /TR switch.)
Specify the padding character as follows:
Switch

Character

/PD[:]

NULL (byte value 000).

/PD: [#]x

x is an octal number 000 to 377 (43 for #, 77 for 7,
and 100 for
@).
The number sign (#) is optional;
RMSCNV will check first for an octal number.

/PD:["]X["]

x is an ASCII character A to Z,
a to 9, or any
special character.
The quotation marks are required
for #, lowercase letters, or a space;
otherwise,
the quotation marks are optional.
If the quotation
marks are not present, RMSCNV will check first
for
an octal number;
then it will check for an ASCII
character.

By default, if you do not specify /PD and
the
input
file's
records are shorter than the output file's records, RMSCNV will
terminate with the fatal error message:
7CNV-F-MRS, Input and output record sizes do not correspond
/SL [: fi Ie-spec]
Directs RMSCNV to produce a
summary
of
file
conversion
processing.
The summary listing consists of the following:
•

The options

(switches)

in effect

•

The input and output file organization,
record format, and record attributes

•

A summary of messages produced during RMSCNV execution

•

The number of input records read and output records written

•

The count of padded records If /PD was selected

•

The count of truncated records if /TR was selected

4-12

file

attributes,

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

If you specify a file as an argument to /SL, and a
file of the
same name and type already exists, RMSCNV will append the summary
to that file.
You can thus use one file to keep a record of all
conversions.
If you specify a file, and a file of the same name and type does
not exist, RMSCNV will create a new file and write the summary to
that file.
If you do not specify a file, the summary will be written to your
terminal.
Do not specify either the input file or the output
argument to ISLe

file

the

By default, if you do not specify /SL, no summary listing will be
produced.
The messages written to your terminal (if RMSCNV
encounters any errors) will be the only record of file conversion
processing.
/SU
Directs RMSCNV to supersede an existing sequential output file.
RMSCNV deletes the existing file, creates one of the same name,
type, and version, and writes the records of the input file
to
it.
You cannot specify /SU and /AP in the same command string.
By default, if you do not specify /SU,
RMSCNV
according to whether you have specified /AP:

will

respond

•

If you specified /AP, RMSCNV will append the input records
the output file.

•

If you did not specify /AP and the output file exists,
will create the next higher version of the file.

RMSCNV

See also the description of the /AP switch.
/TR
Directs RMSCNV to truncate records read from the input file to
the output file's maximum record size.
The trailing bytes of the
record are ignored.
You must use /TR when the input file's
greater than the output file's.

maximum

record

size

In addition, when the output file contains fixed-length records
and the input file contains variable-length records, you must
specify both /TR and /PD.
If both are not specified, RMSCNV will
terminate with the fatal error message:
?CNV-F-TPM, Switch /TR or /PD or both are needed for this CONVERT
(See also the description of the /PD switch.)
By default, if you do not specify /TR and the input file's
records are longer than the output file's records, RMSCNV will
terminate with the fatal error message:
?CNV-F-MRS, Input and output record sizes do not correspond

4-13

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

/WF
Directs RMSCNV to handle
variable-with-fixed-control
(VFC)
records in either the input or output file.
RMSCNV processes the
possible combinations of input and output file record formats, as
follows:
Input
File l

Output
File l

VFC

Processing
If the fixed-control
areas are the same size,
RMSCNV
will
perform
a straightforward copy
operation.
If the areas are not the same size,
RMSCNV will
terminate, without converting the
file, with the fatal error message:
?CNV-F-VFC, Input and output fixed control
sizes do not correspond

header

VFC

FIX
VAR
STM

The fixed-control
area of each
input record
is
written as the first
n bytes of each output
record;
n is the size of the fixed-control
area.
The variable portion of the input record completes
the output record.

FIX
VAR
STM

VFC

The first n bytes of each input record are written
into the fixed-control area of each output record;
n is the size of the fixed-control
area.
The
remaining data in the input record is written into
the variable portion of the output record.

If you specify /WF and neither file contains VFC records,
will terminate with the fatal error message:

RMSCNV

?CNV-F-IWF, Illegal use of /WF with record format
By default, if you do not specify /WF and one of the files
contains VFC records, RMSCNV will ignore the fixed-control area
of each record, processing the records as follows:

4.4

Input
File

Output
File

VFC

any

Only the variable portion of each record
is read
from the
input file and written to the output
file.

any

VFC

Data read from the input file is written only into
the variable portion of each output record.

Processing

RMSCNV PROCESSING

The manner in which RMSCNV reads and
organization of the files and on
command string.

writes files depends on the
the switches you specify in the

1. The expansions of the record format abbreviations used in the list
are:
variable with fixed control (VFC) , fixed (FIX), variable (VAR) ,
and stream (STM).
4-14

RMS-11 FILE CONVERSION UTILITY:
4.4.1

RMSCNV

Output File Organization and RMSCNV Processing

4.4.1.1 Sequential Output File Organization - If the output file
organization is specified as sequential (by default or by using the
switch IFO:S), and the lAP switch is not specified, RMSCNV will create
the output file with the attributes of the input file.
RMSCNV will
then read records from the input file and write them sequentially into
the new output file.
If the output file already exists, RMSCNV will create the next
version.

higher

(Fot' information on the IFO and lAP switches, see Section 4.3.)
If the output file organization is specified as sequential and the ISU
switch is specified, RMSCNV will .supersede an existing file with the
records of the input file.
If the output file does not exist,
RMSCNV
will create one with the attributes of the input file.
(For more
information on the ISU switch, see Section 4.3.)
If the output file organization is specified as sequential and the lAP
switch is specified, RMSCNV will append records to an existing file by
reading records from the input file and writing them sequentially into
the output file, starting with the record position following the last
record that is already in the output file.
If the output file does
not exist, RMSCNV will terminate with the fatal error message:
?CNV-F-ER$FNF, File <file-spec> not found
(Fot' more information on the lAP switch, see Section 4.3.)

4.4.,1.2 Relative Output File Organization - If
the output
file
organization is specified as relative (using the switch IFO:R), RMSCNV
will read records from the input file and write them into successive
record cells of the output file, beginning with cellI.
If RMSCNV
encounters a cell in the output file that already contains a
record,
it will terminate with the fatal error message:
?CNV-F-ER$REX, Relative record already exists for file <file-spec>
All records written up to that point are still
in the file.
You
should examine the input and output files to determine the extent of
processing.
If the relative output file does not exist, RMSCNV will terminate with
the fatal error message:
?CNV-F-ER$FNF, File <file-spec> not found

4.4.,1.3
Indexed Output File Organization - If the
output
file
organization
is specified as indexed (using the switch IFO:I), RMSCNV
will read each record from the input file and apply the output file's
record structure
(that
is,
key placement within the record) to the
data.
This structure is an attribute of the output file and
is not
dependent on input file organization.
The record is inserted into the
output file on the basis of the value in the primary key field.
Then,
RMSCNV will update the output file's primary and (if any) alternate
indexes to reflect the presence of the new record.

4-15

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

If the indexed output file does not exist, RMSCNV will terminate
the fatal error message:

with

?CNV-F-ER$FNF, File <file-spec> not found

4.4.2

Input File Organization and RMSCNV Processing

4.4.2.1 Sequential
Input File Organization - If the
input
file
organization is sequential, RMSCNV will read the records in sequential
access mode, starting with the first record in the file.

4.4.2.2 Relative Input File Organization - If
the
input
file
organization
is relative, RMSCNV will read the records in sequential
access mode, starting with record cell 1.

4.4.2.3
Indexed
Input File
Organization - If
the
input
file
organization is
indexed,
RMSCNV will read the records in sequential
access mode, following the key of reference specified by the /KR or
/KN switch
in the command string (the primary key is the default if
none is specified).
If a record in an indexed input file is shorter than the primary key
of an indexed output file, RMSCNV will terminate with the fatal error
message:
?CNV-F-ER$RSZ,

Illegal record size specified for file <file-spec>

Any records processed before the too-short record mayor may not have
been written to the output file, depending on such factors as buffer
sizes and I/O techniques.
You can use the /KR or /KN switch
(see
Section 4.3) to examine the input file at your terminal as follows:
TI:=INFILE.IDX/KR:l

4.5

TI:=INFILE.IOX/KN:NAME

RMSCNV EXAMPLES

>DES PAYROL.OES
>CNV PAYROL.DAT/FO:I/SL=PAYROL.SEQ
RMS-ll Convert -- Version 2.0 Summary Listing
Options in effect:
OBO: [70,5]PAYROL.SEQi2
File organization: Sequential
File attributes:
Allocation=3l, Extend=O
Record format:
Variable length
Record attributes: Carriage return
OBO: [70,5]PAYROL.DATi2
File organization: Indexed, using 2 key(s)
File attributes:
Allocation=3, Extend=O, Bucket size
Record format:
Variable length
Record attributes: Carriage return

4-16

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

Message summary:
Processing summary:
Records read:
Records written:

448
448

First, RMSOES is used to create a new indexed file, PAYROL.OAT. Then,
RMSCNV reads the input records from the input sequential file
PAYROL.SEQ and writes the records to the PAYROL.OAT file.
A summary
of the RMSCNV operations is printed on the terminal.
>CNV STAT.OAT/AP=STAT.INP
RMSCNV appends the records from the
output (sequential) file, STAT.OAT.

input

file,

STAT.INP,

the

>CNV EMPLY.OAT/FO:REL/TR/WF=EMPLY.INP
RMSCNV reads each record of the input file, EMPLY.INP, and writes the
records to the output file, EMPLY.OAT, which is a relative file with
VFC format records.
As each record is written, the first bytes of the
input record become the fixed-control area of the output record.
Since the maximum record size of the output file is 80 bytes, and the
input file record size is 132 bytes, trailing bytes are discarded.
>CNV ACCNT.OAT/FO:IOX/TR/PO:*=ACCNT.INP
RMSCNV reads each record of the input file and writes the record to
the indexed output file.
The input file has variable length records
and the output file has fixed length records.
If necessary, RMSCNV
truncates input records or pads them with the character "*"
>CNV VHC.KRO/CA/SL=VHC.INX/KR:O
RMS-ll Convert -- Version 2.0 Summary Listing
Options in effect:
Create copying attribute data
Select key by number (KR)

(CA)

o B0: [70, 5 ] VH C • I NX; 7
File organization:
File attributes:
Record format:
Record attributes:

Indexed, using 2 key(s)
Allocation=62, Extend=l, Bucket size
Fixed length 80 byte records
Carriage return

o B0 : [70 , 5 ] VH C • KR0 ; 1
File organization:
File attributes:
Record format:
Record attributes:

Indexed, using 2 key(s)
Allocation=40, Extend=l, Bucket size
Fixed length 80 byte records
Carriage return

Message summary:
%CNV-I-IKY, Input key of reference is #0
Processing summary:
Records read:
Records written:

11
11

4-17

(NPANXX)

RMS-ll FILE CONVERSION UTILITY:
RMSCNV creates an output
attributes.
Then,
RMSCNV
file, based on the primary
operations on the terminal.

file,
reads
key.

RMSCNV

VHC.KRO,
with
the
input file's
the records from the indexed input
RMSCNV lists
a
summary of
its

>CNV VHC.KRl/CA/SL=VHC.INX/KR:l
RMS-ll Convert -- Version 2.0 Summary Listing
Options in effect:
Create copying attribute data
Select key by number (KR)

(CA)

DBO: [70,5]VHC. INX;7
File organization: Indexed, using 2 key(s)
Allocation=62, Extend=l, Bucket size
File attributes:
Record format:
Fixed length 80 byte records
Record attributes: Carriage return

DBO: [70,5]VHC.KRl;1
File organization: Indexed, using 2 key(s)
Allocation=40, Extend=l, Bucket size
E'ile attributes:
Record format:
Fixed length 80 byte records
Record attributes: Carriage return

Message summary:
%CNV-I-IKY, Input key of reference is #1
Processing summary:
Records read:
Records wr i tten:

(PLACE)

11
11

RMSCNV creates an output
file,
VHC.KRl,
with
the
input
file's
attributes.
Then,
RMSCNV reads
the records from the indexed input
file, based on the first alternate key.
RMSCNV lists a summary of its
operations on the terminal.
>CNV T I: =VHC. KRO
0505801480
0507301348
0511101332
0498201417
0506901429
0500701457
0500701457
0500701457
0507301348
0508901466
0504801441

10060000201221
00060000201222
10060000201223
00060000201224
00060000201225
00060000201226
00060000201227
00060000201228
00060000201229
10060000201231
00060000201232

005415
002885
002885
006882
002885
005613
005613
005613
002885
005643
005613

070BERNARDSVLNJ060481
070LONGBRANCHNJ071578
070MANASQUAN NJOl1582
070CLIFFSIDE NJ060581
070METUCHEN NJ060481
070CALDWELL NJll1881
070CALDWELL NJll1881
070CALDWELL NJll1881
070LONGBRANCHNJ071578
070S0MERVILLENJ100679
070WESTFIELD NJll1881

In this example, RMSCNV reads the contents of the input
and writes the records to the current TI:
assignment.
>CNV CUST.FILjCA/SL=NODA"SMITH XUK9":: [70,5]CUST.DAT
RMS-ll Convert -- Version 2.0 Summary Listing
Options in effect:
Create copying attribute data

(CA)

4-18

indexed

00
00
00
00
00
00
00
00
00
00
00

file

RMS-ll FILE CONVERSION UTILITY:

RMSCNV

NODA"SMITH XUK9"::DBO: [70,5]CUST.DAT;1
File organization: Sequential
File attributes:
Allocation=20, Extend=O
Record format:
Variable length
Record attributes: Carriage return
DBO: [70,5]CUST.FIL;1
File organization:
File attributes:
Record format:
Record attributes:

Sequential
Allocation=20, Extend=O
Variable length
Carriage return

Message summary:
Processing summary:
Records read:
Records written:

124
124

RMSCNV creates an output file, CUST.FIL, from the attributes of the
output file.
The output file, CUST.DAT, is on a remote node, NODA.
Each record is read from the output file and written to the input
file, and a summary of the operations is displayed on the terminal.

4-19

CHAPTER 5
RMS-ll FILE DISPLAY UTILITY:

RMSDSP

The RMS-ll File Display Utility
(RMSDSP)
displays
a
concise
description
of any RMS-ll file,
including container files.
A
container file is a magnetic tape file that contains RMS-ll files that
were backed up using RMSBCK (see Chapter 6).
You can use RMSDSP to display a file's attributes so you can create a
file
like
it using
RMSDES,
or to determine what kind of file your
high-level language task created so you can match and/or enhance it
using RMSDES.
(See Chapter 2 for information on RMSDES.)
The basic display that RMSDSP produces for disk sequential,
and indexed files includes:
•

A complete file specification

•

Prologue version

•

File size

•

File owner

•

File identification

•

Creation and revision dates

•

File protection

•

File organization, including numbers of
indexed files

•

File attributes

•

Record format

•

Record attributes

The basic
includes:

display

that

relative,

(for relative and indexed files)

RMSDSP

produces

•

A complete file specification

•

File organization

•

File attributes

•

Record format

•

Record attributes

5-1

for

keys

and

magnetic

areas

tape

for

files

RMS-ll FILE DISPLAY UTILITY:

RMSDSP

The basic display that RMSDSP produces for RMSBCK
disk or on magnetic tape) includes:
•

A complete file specification

•

File size

•

Creation date

back-up

files

(on

In addition, for indexed files and back-up files, you can request a
more detailed display
(see Section 5.3).
For indexed files, RMSDSP
also displays information on areas, primary and alternate keys, and
allocation.
For back-up files, the detailed display includes file protection, file
organization,
record format,
contiguity, and whether the version
number is octal (for files created on RSX-IIM/M-PLUS systems)
or
decimal (for files created on VAX/VMS systems).
Although RMSDSP does not display allocation information for magnetic
tape files,
you can display this information by using the Peripheral
Interchange Program (PIP;
see the RSX-IIM/M-PLUS utilities Manual).
The following sections describe how to invoke and terminate RMSDSP
(Section 5.1) and the RMSDSP command string and switches (Sections 5.2
and 5.3).
Section 5.4 provides examples illustrating the RMSDSP
displays. Appendix C documents messages.

5.1

INVOKING AND TERMINATING RMSDSP

The RMSDSP utility can be either installed or uninstalled.
is installed, invoke it with the command:

RMSDSP

DSP [command-string]
If you include a command string, RMSDSP will execute the
return the system prompt.

command

and

If you do not include a command string, RMSDSP will prompt for one:
DSP)
If RMSDSP is uninstalled on RSX-IIM/M-PLUS systems, invoke it with the
command:
RUN $RMSDSP
RMSDSP will respond with the prompt:
DSP)
In response to the prompt, you can type a command string or you can
type CTRL/Z to terminate the utility. When RMSDSP has executed a
command string, it returns the DSP) prompt. Section 5.2 describes the
RMSDSP command string.
Indirect Command Files. You can execute series of RMSDSP command
strings by means of indirect command files.
The command strings in an
indirect command file are executed when an at sign (@) followed by the
file's name is specified to the utility.
The default file type of
.CMD is assumed if none is provided.

5-2

RMS-ll FILE DISPLAY UTILITY:

RMSDSP

Installed RMSDSP will accept indirect command files either from the
system prompt or from the utility prompt. For example, to execute the
command strings contained in the indirect command file DSPCOM.CMD, you
could type either of the following commands:
DSP @DSPCOM
or
DSP> @DSPCOM
Uninstalled RMSDSP will accept indirect command files
utility prompt.
For example:

only

from

the

DSP> @DSPCOM
If you executed the indirect command file from the system prompt,
the
system prompt will be returned.
If you executed the indirect command
file from within RMSDSP, the DSP> prompt will be returned.

5.2

RMSDSP COMMAND STRING

Format
[outfile=] infile[/switch .•. ] [,infile[/switch ••• ] ••• ]
outfile
The specification of a file that RMSDSP creates to write the
attributes or list the contents of the specified input file(s).
Wild card characters are not permitted in any field of the
specification.
The default version is the highest existing
version number plus 1.
By default, if you do not specify an output
display the information on your terminal.

file,

RMSDSP

will

infile
The file specification of any RMS-ll file whose attributes you
want displayed or a container file whose contents you want
listed.
For container files, you must specify the /BP switch
(see Section 5.3). Wild card characters (*) are permitted in any
field of the specification.
RMSDSP requires ANSI-standard labels on magnetic tapes.
You must
mount a tape volume to
inform your operating system's file
processor that you are accessing an ANSI-standard tape.
See the RSX-IIM/M-PLUS RMS-ll User's Guide for
on RMS-ll magnetic tape handling.

information

If you do not mount your tape volume, RMSDSP will not accept wild
card characters
in the specification and will respond to an
explicit file name with the tape device's attributes.
/switch
One of the switches listed in Table 5-1 and described in Section
5.3.
All switches are global;
that is, they can be specified
anywhere in the command string.
In place of the command string you can type HELP or? to display help
text about RMSDSP,
or /ID to display the current version of the
utility.

5-3

RMS-ll FILE DISPLAY UTILITY:
Table 5-1:

RMSDSP Switches

Switch

Description

/BP

List contents of back-up file(s)
Default:

/FU

/10

Provide basic display only

Provide detailed display
files or back-up files
Default:

for

indexed

Provide basic display only

Identify current version
Default:

5.3

RMSDSP

No identification

RMSDSP SWITCHES

/BP
Directs RMSDSP to read
the specified
input files
as
RMSBCK
back-up files (see the description of the RMSBCK utility, Chapter
6) and to display the names, sizes, and creation dates of the
RMS-ll files
backed up to tape or disk (see Example 5-6 in
Section 5.4).
If you specify /BP with both back-up and
non-back-up files,
RMSDSP will provide displays for the back-up files only.
It will
ignore the non-back-up files.
By default, if you do not specify /BP, RMSDSP will provide the
basic display for disk or magnetic tape files:
file organization
and attributes, and record format and attributes (see Example 5-5
in Section 5.4).
/FU
Directs RMSDSP to provide the detailed display for
indexed file or a back-up file (when used with /BP).

either

If you specify /FU with an indexed file, the display will include
information on the individual keys and areas, and on allocation
(see Example 5-4 in Section 5.4).
If you specify /FU with /BP for a back-up file, the display will
include information on the owner, protection, file organization,
record format, whether the file is contiguous,
and whether
the
version number is octal (for a file created on an RSX-llM/M-PLUS
system) or decimal (for a file created on a VAX/VMS system).
See
also Example 5-7 in Section 5.4.
Knowing whether the version number is octal or decimal is useful
in transferring RMS-ll files among operating systems using RMSRST
(see Chapter 7).
If the file
is displayed with no version
number, it was created and backed up on a RSTS/E system.

5-4

RMS-ll FILE DISPLAY UTILITY:

RMSDSP

Under RSTS/E systems, the decimal project-programmer number (PPN)
fields
are the reverse of the octal User Identification Code
(UIC) fields under VAX/VMS and
RSX-llM/M-PLUS.
Thus,
in the
owner's field of the display for files created under RSTS/E, the
PPN fields will be reversed and shown in their octal equivalents.
By default, if you do not specify /FU, RMSDSP will provide the
basic displays for indexed files (see Example 5-3 in Section 5.4)
and container files (see Example 5-6 in Section 5.4).
/ID
Displays the current version of the RMSDSP utility.

For example:

DSP>OUTFIL.DAT/ID=INFILE.DAT
%DSP-I-ID, Version 2.000
The last two digits of the version number (00
in this example)
are the patch level of the utility.
The /10 switch can also be
specified by itself on the command line:
DSP>/ID
%DSP-I-ID, Version 2.000

5.4

RMSDSP DISPLAYS

Examples 5-1 through 5-8 illustrate the RMSDSP display formats.
NOTE
The File 10 field of the displays
for
disk sequential,
relative, and indexed
files is in octal
for
RSX-llM/M-PLUS
systems.
Example 5-1:

RMSDSP Display Format for Disk Sequential Files

)OSP PAYROL.SEQ
OBO: [70,5]PAYROL.SEQ;2

File protection:
File organization:
File attributes:
Record format:
Record attributes:

Size:
31./31.
Created: l-APR-1983 05:45
Owner:
[070,005]
Revised: l-APR-1983 14:11 (3)
File IO: (11766,3,0)
System:RWEO, Owner:RWEO, G~oup:RWEO, World:R
Sequential
Allocation=3l, Extend=O
Variable length, no maximum defined
Carriage return

5-5

RMS-ll FILE DISPLAY UTILITY:
Example 5-2:

RMSDSP

RMSDSP Display Format for Relative Files

>OSF EMPLY.DAT
SY: [070,005]EMPLY.DATil

File protection:
File organization:
File attributes:
Record format:
Record attributes:

Example 5-3:

RMS Prologue Version=l
Size:
30./30.
Created: 2-APR-1983 01:43
Owner:
[070,005]
Revised: 2-APR-1983 01:45
File 10: (6343,55,0)
System:RWED, Owner:RWEO, Group:RWED, World:R
Relative, no maximum record number defined
Allocation=30, Extend=O, Bucket size=2
VFC, 2 byte header, maximum 80 bytes
Carriage return

(2)

RMSDSP Display Format for Indexed Files

>DSP PAYROL.DAT
OBO: [70,5]PAYROL.OATi2

File protection:
File organization:
File attributes:
Record format:
Record attributes:

Example 5-4:

RMS Prologue Version=l
Size:
63./63.
Created: 2-APR-1983 01:44
Owner:
[070 ,005]
Revised: 2-APR-1983 01:47
File 10: (27743,10,0)
System:RWED, Owner:RWED, Group:RWED, World:R
Indexed, using 2 key(s) with 1 area(s)
Allocation=63, Extend=O, Bucket size=l
Variable length, no maximum defined
Carriage return

(2)

RMSDSP Display Format for Indexed Files
(with /FU Specified)

>DSP PAYROL.OAT/FU
DBO: [70,5]PAYROL.DATi2

File protection:
File organization:
File attributes:
RE!cord format:
Record attributes:

RMS Prologue Version=l
Created: 2-APR-1983 01:44
Size:
63./63.
Revised: 2-APR-1983 01:47
Owner:
[070,005]
File 10: (27743,10,0)
System:RWED, Owner:RWEO, Group:RWEO, World:R
Indexed, using 2 key(s) with 1 area(s)
Allocation=63, Extend=O, Bucket size=l
Variable length, no maximum defined
Carriage return

Area number 0:
Bucket size=l
Allocation remaining=l, Extend=O
Primary key:
Name=(not specified>, Minimum record length=12
Key information:
Type=String, Length=12, Duplicates, No changes
Position(s) and size(s):
Segment=O, position=O, length=12
Area information:
Index:
Area number=O
Lowest level area=O
Bucket size=l, Fill factor=512

5-6

(2)

RMS-11 FILE DISPLAY UTILITY:
Example 5-4 (Cont.):

RMSDSP

RMSDSP Display Format for Indexed Files
(with /FU Specified)

Data:

Area number=O
Bucket size=l, Fill factor=512
Allocation information:
Root virtual block number=4, Root level=l
First data bucket virtual block number=5
Alternate key number 1:
Name=(not specified>, Minimum record length=17
Key information:
Type=String, Length=17, Duplicates, Changeable
position(s) andsize(s):
Segment=O, position=O, length=17
Area information:
Index: Area number=O
Lowest level area=O
Bucket size=l, Fill factor=512
Data:
Area number=O
Bucket size=l, Fill factor=512
Allocation information:
Root virtual block number=7, Root level=l
First data bucket virtual block number=8

Example 5-5:

RMSDSP Display Format for Magnetic Tape Files

>DSP MMO:*.*;*
MMO:PAYROL.CON;l
File organization:
File attributes:
Record format:
Record attributes:

Sequential
Magnetic tape, Block size=2064
Undefined
None

MMO:MASTER.BCK;l
File organization:
File attributes:
Record format:
Record attributes:

Sequential
Magnetic tape, Block size=2064
Undefined
None

Example 5-6:

RMSDSP Display for Back-Up Files

>DSP MMO:*.*;*/BP
Contents of container file MMO:MASTER.BCK;l
[070,005]PAYROL.DAT;2
[070,005]STAT.DAT;1
[070,005]EMPLY.DAT;1
[070,005]ACCNT.DAT;1

63./63.
20./20.
30./30.
30./30.

2-APR-1983
2-APR-1983
2-APR-1983
2-APR-1983

01:44
01:43
01:43
01:43

Contents of container file MMO:PAYROL.CON;l
[070,005]PAYROL.DAT;2
[070,005]PAYROL.LOG;1
[070,005]PAYROL.DES;2
[070,005]PAYROL.SEQ;2
[070,005]PAYROL.MST;1

63./63.
294./294.
4./4.
31./31.
3./3.

5-7

2-APR-1983 01:44
l-APR-1983 05:45
14-JAN-1983 08:36
1-APR-1983 05:45
14-JAN-1983 08:43

RMS-ll FILE DISPLAY UTILITY:
Example 5-7:

RMSDSP

RMSDSP Display Format for Back-Up Files
(with /FU Specified)

)DSP MM1:*.*/BP/FU
Contents of container file: MM1:RSX11M.CON;1
[100,101]HART.SEQ;1
0./0.
lS-JAN-1982
[100,101]
[RWED,RWED,RWED,R]
lS-JAN-1982
Organization=Sequentia1, Record format=Variable
Not contiguous, Version number=Octal
[100,101]HOGAN.REL;1
1./1.
lS-JAN-1982
[100,101]
[RWED,RWED,RWED,R]
lS-JAN-1982
Organization=Relative, Record format=Fixed
Not contiguous, Version number=Octal
[100,101]SIEMBO.IDX;1
100./200.
lS-JAN-1982
[100,101]
[RWED,RWED,RWED,R]
lS-JAN-1982
Organization=Indexed, Record format=Fixed
Not contiguous, Version numb~r=Octal
[100,101]RMSDSP.TSK;11
162./162.
lS-JAN-1982
[100,101]
[RWED,RWED,RWED,R]
lS-JAN-1982
Organization=Sequentia1, Record format=Fixed
Contiguous, Version number=OctaI
[100,101]DEMO.CMD;1
1./S.
lS-JAN-1982
[100,101]
[RWED,RWED,RWED,R]
lS-JAN-1982
Organization=Sequentia1, Record format=Variable
Not contiguous, Version number=Octal
Example S-8:

14:06
14:06
14:06
14:06
14:12
14:12
14:12
14:12
14:28
14:28

RMSDSP Display Format Using Wildcard Characters

)OSP PAYROL.*
SY: [070,005]PAYROL.OAT;2

File protection:
File organization:
File attributes:
Record format:
Record attributes:

RMS Prologue Version=l
Created: 2-APR-1983 01:44
Size:
63./63.
Revised: 2-APR-1983 01:47 (2)
Owner:
[070,005]
File ID: (27743,10,0)
System:RWEO, Owner:RWEO, Group:RWEO, World:R
Indexed, using 2 key(s) with 1 area(s)
Allocation=63, Extend=O, Bucket size=l
Variable length, no maximum defined
Carriage return

SY: [070,005]PAYROL.OES;2

File protection:
File organization:
File attributes:
Record format:
Record attributes:

Created: l4-JAN-1983 08:36
Size:
4./4.
Revised: 2-APR-1983 01:44 (7)
Owner:
[070,005]
File 10: (11342,13,0)
System:RWED, Owner:RWED, Group:RWED, World:R
Sequential
Allocation=4, Extend=O
Variable length, no maximum defined
Carriage return

SY: [070,005]PAYROL.SEQ;2

File protection:
File organization:
File attributes:
Record format:
Record attributes:

Created: l-APR-1983 05:45
Size:
31./31.
Revised: l-APR-1983 14:11 (3)
Owner:
[070,005]
File 10: (11766,3,0)
System:RWED, Owner:RWED, Group:RWED, World:R
Sequential
Allocation=3l, Extend=O
Variable length, no maximum defined
Carriage return

S-8

CHAPTER 6
THE RMS-ll FILE BACK-UP UTILITY:

RMSBCK

The RMS-ll File Back-Up Utility (RMSBCK) transfers the contents of any
RMS-ll disk file to another disk or to a container file.
A container
file is a magnetic tape file that contains RMS-ll files
that were
backed up using RMSBCK.
When RMSBCK transfers RMS-ll files,
the back-up copy retains the
source file's attributes:
account number, creation and revision
dates, protection code, contiguity, and so on, with the exception of
plac,ement.
A file cannot be restored to the same physical place on
the device from which it was backed up.
The back-up files are specially formatted so that they can be accessed
only by the RMSRST utility (see Chapter 7);
they cannot be read or
modified by user programs or other utility programs.
RMSDSP, however,
can display information about RMSBCK back-up files (see Chapter 5).
You can use RMSBCK and RMSRST to protect your data against hardware or
software failure.
When you back up files on a regular basis, files
lost or damaged can be restored from the back-up copies.
You can also use RMSBCK and RMSRST to transfer files between different
operating systems,
for example, between RSX-IIM/M-PLUS and VAX/VMS,
and between RSTS/E and RSX-IIM/M-PLUS or VAX/VMS.
See Chapter 7 for
more information on using RMSRST to restore files
to different
operating systems.
RMSBCK backs up files to magnetic tape volumes with ANSI-standard
labels only.
However,
the back-up data written to the volume by
RMSBCK need not comply with ANSI standards.
Note that RMSBCK cannot back up a system disk as a bootable volume.
RMSBCK provides four processing features:
•

Explicit and implicit input file selection -- You can specify
one or more input files with or without wild card characters.

•

Data integrity checks -- You can check the reliability of
backed up data files.

•

Extended diagnostic messages
Query mode gives you the
option of continuing processing if RMSBCK encounters an error
condition.

•

Summary listing
processing.

You

can

create

record

RMSBCK

Section 6.4 describes these processing features in greater detail.

6-1

the

THE RMS-ll FILE BACK-UP UTILITY:

RMSBCK

The following sections describe how to
invoke and
terminate RMSBCK
(Section 6.1) and the RMSBCK command string and switches (Sections 6.2
and 6.3).
Section 6.S provides examples
illustrating the use of
RMSBCK.
Appendix C documents messages.

6.1

INVOKING AND TERMINATING RMSBCK

The RMSBCK utility can be either installed or uninstalled.
is installed, invoke it with the command:

RMSBCK

BCK [command-string]
If you include a command string, RMSBCK will execute the
return the system prompt.

command

and

If you do not include a command string, RMSBCK will prompt for one:
BCK)
If RMSBCK is uninstalled on RSX-llM/M-PLUS systems, invoke it with the
MCR command:
RUN $RMSBCK
RMSBCK will respond with the prompt:
BCK)
In response to the prompt, you can type a command string or you can
type CTRL/Z to terminate the utility. When RMSBCK has executed a
command string, it returns the BCK) prompt.
Section 6.2 describes the
RMSBCK command string.
Indirect Command Files.
You can execute series of RMSBCK command
strings by means of indirect command files.
The command strings in an
indirect command file are executed when an at sign (@) followed by the
file's
name
is specified to the utility.
The default fiLe type of
.CMD is assumed if none is provided.
Installed RMSBCK will accept indirect command files either
from the
system prompt or from the utility prompt.
For example, to execute the
command strings contained in the indirect command file BCKCOM.CMD, you
could type either of the following commands:
BCK @BCKCOM
or
BCK) @BCKCOM
Uninstalled RMSBCK will accept indirect command files
utility prompt.
For example:

only

from

the

BCK) @BCKCOM
If you executed the indirect command file from the system prompt,
the
system prompt will be returned.
If you executed the indirect command
file from within RMSBCK, the BCK) prompt will be returned.

6-2

THE RMS-ll FILE BACK-UP UTILITY:
6.2

RMSBCK

RMSBCK COMMAND STRING

Before you issue a command string to RMSBCK, the back-up medium
or ANSI-labeled magnetic tape) must be online and mounted.

(disk

Format
outfile[/switch ••• ]=infile[/switch ••• ] [,infile[/switch ••• ] ••• ]
outfile
The specification of a disk or magnetic tape file to be created
by RMSBCK.
If the back-up medium is disk, both the file name and
type must be wild card characters
(*.*).
The file names and
types of the container files will be the same as the associated
input data files.
You can omit the version;
RMSBCK will use the
version of the associated input file.
If you do not use wild card characters in specifying
file, RMSBCK will terminate with the error message:

the

output

%BCK-W-NRN, No rename allowed
If the back-up medium is magnetic tape, multiple input files will
be backed up
in a single container file.
You must explicitly
name the output container file in the command string, but the
name need not correspond to the name of any input file.
You can
omit the version;
a value of 0 will be used.
If you do not
explicitly name the container file, RMSBCK will terminate with
the fatal error message:
%BCK-W-NDM, Explicit container filename necessary
RMSBCK does not prevent you from putting multiple container files
with the same file specification on the same magnetic tape
volume.
Therefore, you should specify unique file names,
types,
and versions
for
output container files written to the same
volume.
(You can use RMSDSP to display information about back-up
files;
see Chapter 5.)
infile
The specification of a disk file from which a back-up copy is to
be created.
You can use wild card characters (*) to implicitly
specify a collection of files.
If you specify a nondisk device, RMSBCK will terminate
fatal error message:

with

the

?BCK-F-ER$DEV, Bad or inappropriate device type for file <device>
<devi~e>

is the device name and unit you specified.

If you specify a file that
is
listed
in several accounts by
means,
for
example,
of
the PIP/ENTER command
(see the
RSX-llM/M-PLUS utilities Manual), RMSBCK will copy the entire
file even though it exists in another account.
However, when you
restore the file with RMSRST, the link to the other accounts will
be broken.

6-3

THE RMS-ll FILE BACK-UP UTILITY:

RMSBCK

For example, you have a file of names, ACCTSRECV.DAT,
stored
in
account
[30,1]
which is pointed to by the directory entry
[lO,l]CLIENTS.DAT (by means of the PIP/ENTER command).
If you
back up
[lO,l]CLIENTS.DAT,
RMSBCK will copy the file
from
[30,l]ACCTSRECV.DAT. When you restore the file,
RMSRST will
write the file
into account [10,1].
The restored file will no
longer be linked with the file of names
in
[30,l]ACCTSRECV.DAT;
rather, it will be a duplicate of that file.
/switch
One of the switches listed in Table 6-1 and described in
6.3.

Section

In place of the command string, you can type HELP or
?
to display
help text about RMSBCK, or /10 to display the current version of the
utility.
Table 6-1:
Type
Global

RMSBCK Switches

Switch
/10

Description
Identify current version
Default:

/[NO]QU

Enable or disable query mode
Default:

/SL[:file-spec]

/RA

/RW

Input
File

/CD:dd-mmm-yy[:v]

integrity

No checking

No rewinding

No supersession

Back up files based on creation date
Default:

/RD:dd-mmm-yy[:v]

data

No reading

Supersede existing file
Default:

No date checking

Back up files based on revision date
Default:

6-4

integrity

Rewind magnetic tape before writing
Default:

/SU

file,

data

Check-after-writing
checking
Default:

(in

No summary

Read-after-writing
checking
Default:

/RC

Enable query mode

Provide summary listing
specified)
Default:

Output
File

No identification

No date checking

THE RMS-ll FILE BACK-UP UTILITY:
6.3

RMSBCK

RMSBCK SWITCHES

This section describes the global,
output file,
and
input file
switches that you can speqify In RMSBCK command strings.
Global
switches are switches that can be specified anywhere
in the command
string.

6.3~l

Global Switches

The global switches are lID, IQU, and ISL.

lID
Displays the current version of the RMSBCK utility.

For example:

BCK)OUTFIL.DAT/ID=INFILE.DAT
%BCK-I-Ib, Version 2.000
The last two digits of the version (00 in this example)
are the
patch level of the utility.
The lID switch can also be specified
by itself on the command line:

BCK)/ID
%BCK-I-ID, Version 2.000
I[NO]QU
Enables or disables query mode.
If you specify IQU, RMSBCK will
allow you to chose to continue or to terminate processing when
one of the following occurs:
•

A read error occurs on an input file.

•

A read-after-write error occurs on an output file when the IRA
switch is specified (see Section 6.3.2).

•

A read-after-write error occurs on an output file when the IRC
switch is specified (see Section 6.3.2).

•

The table allocated internally for data
integrity
for automatic retry of read errors is full.

checks

When one of these errors occurs,
RMSBCK prints a diagnostic
message specifying the type of error and the name of the file
being processed.
It also prompts you, asking whether you want to
continue processing.
If you answer Y,
RMSBCK will continue
processing the current file and command string.
If you answer N,
RMSBCK will terminate processing immediately, without processing
the rest of the command string.
For example:
BCK)OUTFIL.DAT/QU=INFILE.DAT
?BCK-F-WCE, Check after write error on output file <file-spec)
VBN 1 to 2.
Continue (Yes or No)?
Y
?BCK-F-TER, Integrity check table full.
Continue (Yes or No)?
You can disable query mode with the INOQU switch.
print a diagnostic message when it encounters
terminate processing.
By default, if you do not specify IQU or INOQU, query
be enabled.

6-5

RMSBCK will
an error and
mode

will

THE RMS-ll FILE BACK-UP UTILITY:

RMSBCK

ISL[:file-spec]
Directs RMSBCK to produce a summary of file
The summary listing consists of:

back-up

processing.

up,

associated

•

The command string

•

The names of files successfully backed up

•

The names of files that were not backed
error messages

•

The diagnostic messages produced in query mode
was enabled)

•

A summary of any input errors and a
summary of any errors
remaining
in output back-up files after automatic retry of
data integrity checks (if you specified IRA or IRC)

with

(if query

mode

If you specify a file as an argument to ISL, and a
file of the
same name and type already exists, RMSBCK will append the summary
to that file.
You can thus use one file to keep a record of all
file conversions.
If you specify a file, and a file of the same name and type does
not exist, RMSBCK will create a new file and write the summary to
that file.
If you do not specify a file, the summary will be written to your
terminal.
Do not specify either the input file or the output
argument to ISL.

file

the

By default, if you do not specify ISL, RMSBCK will write messages
to your terminal if it encounters errors (see Appendix C).

6.3.2

Output File Switches

The output file switches are IRA, IRC, IRW, and ISU.
IRA
Directs RMSBCK to read the back-up file after writing it.
RMSBCK
reads back each block of the back-up file.
If the device
hardware detects a read error, RMSBCK will respond according to
whether query mode is enabled (see the description of the I[NO]QU
switch in Section 6.3.1).
Note that you cannot specify IRA and IRC
in the same
string.
RMSBCK terminates with the fatal error message:

command

?BCK-F-CSW, Conflicting switch specified - Isw
The value Isw is IRA or IRC depending on which appears second
the command string.
By default, if you do not specify IRA, RMSBCK
read-after-writing data integrity checking.

6-6

will

not

perform

THE RMS-ll FILE BACK-UP UTILITY:

RMSBCK

IRC

Directs RMSBCK to check the back-up file after writing it.
After
the file has been completely backed up, RMSBCK reads it back into
memory, block by block.
At the same time,
it reads the input
file back
into memory,
block by block.
RMSBCK compares the
corresponding blocks as it reads them.
If an error occurs during
the comparison
(a hardware read error or a mismatch between the
contents of the two blocks), RMSBCK will
respond according to
whether query mode is enabled (see the description of the I[NO]QU
switch in Section 6.3.1).
Note that you cannot specify IRC and IRA in the same
string.
RMSBCK terminates with the fatal error message:

command

?BCK-F-CSW, Conflicting switch specified - Isw
The value Isw is IRA or IRC depending on which appears second
the command string.
By default, if you do not specify IRC, RMSBCK
check-after-writing data integrity checking.

will

not

perform

IRW
Directs RMSBCK to rewind a magnetic tape before writing a
container file
to it.
Rewinding logically deletes any existing
files on the tape.
This switch can be specified only if the back-up medium is a
magnetic tape.
If the back-up medium is a disk and you specify
IRW, RMSBCK will terminate with the fatal error message:
?BCK-F-LSW, Illogical switch in context of command - IRW
By default, if you do not specify IRW,
RMSBCK will add
container file to the logical end of the magnetic tape.

new

ISU

Directs RMSBCK to supersede an existing disk output file with
records of the input file.
RMSBCK does not create a new version
of the output file:
it deletes the existing file, creates one of
the same name, type, and version, and writes the records of the
input file to it.
This switch can be specified only if the back-up medium is a
disk.
If the back-up medium is a magnetic tape and you specify
ISU, RMSBCK will terminate with the fatal error message:
?BCK-F-LSW, Illogical switch in context of command - ISU
By default, if you do not specify ISU, RMSBCK will not supersede
the files on the output device.
If RMSBCK encounters a file with
the same file name, type, and version as an input file,
it will
print the following error message and continue processing:
?BCK-F-ER$FEX, File <file-spec> already exists

6-7

THE RMS-ll FILE BACK-UP UTILITY:
6.3.3

RMSBCK

Input File Switches

The input file switches are /CD and /RD.
/CD:dd-mmm-yy[:v]
Directs RMSBCK to back up files based on their creation date.
If
you use wild card characters in the input file specification, you
can identify a group of files, depending on the value of the
argumentv.
If you do not specify v, RMSBCK will back up all
files that satisfy the wild card specification and were created
on the date specified.
If you specify the value A for the
argument v, RMSBCK will back up all files that satisfy the wild
card specification and were created after the date specified.
If
you specify the value B for v, RMSBCK will back up all files that
satisfy
che wild card specification and were created before the
date specified.
If a file has no or a null creation date, RMSBCK will treat it as
though it had been created before January 1900.
By default, if you do not specify lCD, RMSBCK will back up all
files
that satisfy the
input file specification (unless you
specified /RD;
see the description of the /RD switch in this
section) •
/RD:dd-mmm-yy[:v]
Directs RMSBCK to back up files based on their
revision dates,
that
is,
the dates they were last accessed for writing.
If you
use wild card characters in the input file specification, you can
identify a group of files, depending on the value of the argument
v.
If you do not specify v, RMSBCK will back up all files
that
satisfy the wild card specification and were revised on the date
specified.
If you specify the value A for the argument v, RMSBCK
will back up all files that satisfy the wild card specification
and were revised after the date specified.
If you specify the
value B for v,
RMSBCK will back up all files that satisfy the
wild card specification and were revised before the
date
specified.
If a file has no or a null revision date, RMSBCK will treat it as
though it had been revised before January 1900.
By default, if you do not specify /RD, RMSBCK will back up all
files
that satisfy the
input file specification (unless you
specified /CD;
see the description of the /CD switch in this
section) •

6.4

RMSBCK PROCESSING

RMSBCK copies standard RMS-II data files from one medium to another
(disk to disk or disk to magnetic tape) so that, if the original data
files are lost or damaged, you have the back-up copies from which you
can restore the original data.
You must use ANSI-labeled magnetic tapes
if the back-up medium is
magnetic tape.
However, the back-up data written to the tape need not
comply with ANSI standards.
RMSBCK translates the data into a special
format;
back-up files can be accessed properly only by RMSRST (see
Chapter 7).
User and other utility programs, therefore, cannot read
or modify back-up data.

6-8

THE RMS-11 FILE BACK-UP UTILITY:

RMSBCK

When the back-up medium is magnetic tape, RMSBCK uses 2064-character
blocks
(representing 16 bytes of container file overhead and 4 disk
blocks as a record to the container file).
You cannot alter the block
size used by RMSBCK.
You can use multivolume magnetic tapes;
this
capability
is
implemented by means of the magnetic tape ancillary control process
(ACP) interface.
NOTE
For multivolume backup sets, the IRA and
IRC switches will not function properly
since
tape
positioning
cannot
be
accomplished on those files which span
tape volumes.
RMSBCK handles unused blocks in a file according to file organization:
•

If the file is sequential or relative, RMSBCK
the unused blocks.

•

If the file is indexed, RMSBCK will copy the unused blocks.

RMSBCK provides four
following sections.

6.4.1

processing

features,

will

described

not

copy

the

Explicit and Implicit Input File Specification

The RMSBCK command string allows you to specify input files either
explicitly
or
implicitly.
File specifications with wild card
characters (*) implicitly identify a collection of files.
When you
use wild card characters, you can restrict the number of files
selected for processing by including one of the date switches, ICD or
IRD
(see Section 6.3.3).
A date switch directs RMSDCK to examine
either the creation or the revision date of each file selected as a
result of the wild card specification:
RMSBCK will back up a file
only if its creation or revision date matches the date specified with
the switch.

6.4.2

Data Integrity Checking

You can direct RMSBCK to check data integrity as each file is created.
If you specify the IRA output file switch, RMSBCK will read back the
file contents after they are written to the back-up file.
If you
specify the IRC output file switch, RMSBCK will read back, block by
block, the contents of the output (back-up) file and the contents of
the original file and compare them.
RMSBCK automatically retries read
errors if processing continues to normal termination.

6-9

THE RMS-ll FILE BACK-UP UTILITY:

RMSBCK

Thus, you have three choices in data integrity checking:
•

You can specify neither IRA nor IRC and rely on software
hardware accuracy, backing up your files in minimum time.

and

•

You can specify IRA and verify, that the files can be read from
the back-up medium, adding reading time to the minimum time.

•

You can specify IRC and verify that the back-up files can be
read and
that they exactly match the original input files,
adding reading and comparison times to the minimum time.

See Section 6.3.2 for descriptions of the IRA and IRC switches.

6.4.3

Extended Diagnostic Messages

Query mode allows you to specify that processing continues or
terminates when RMSBCK encounters an error condition.
By default,
query mode is enabled. When RMSBCK encounters an error, it issues a
diagnosti~ message to your terminal and prompts you:
Continue (Yes or No)?
Depending on your response, RMSBCK continues or terminates processing.
With this feature,
you can ensu~e that RMSBCK does not terminate
processing of a group of files if errors are encountered in only one
fil '2 .
You can disable query mode with the INOQU output file switch.
If
RMSBCK encounters an error, it will issue a diagnostic message to your
terminal and terminate processing automatically.
See Section 6.3.1 for a description of the I[NO]QU switch.

6.4.4

Summary Listing

You can use the ISL switch to produce a summary listing of RMSBCK
processing,
including data
integrity checks and error messages.
RMSBCK will either write the summary to your terminal or into a
file
that
you specify,
creating a permanent record of the back-up
processing.
See the description of the ISL switch
example summary listing in Section 6.S.

6.5

Section

6.3.1,

and

RMSBCK EXAMPLES

>MOU MMO:PAYROL
>BCK MMO:PAYROL.CON=PAYROL.*/QU/SL
%BCK-I-FPC, Processing complete for
%BCK-I-FPC, Processing complete for
%BCK-I-FPC, Processing complete for
%BCK-I-FPC, Processing complete for
%BCK-I-FPC, Processing complete for

file
file
file
file
file

6-10

SY: [070,00S]PAYROL.DAT;2
SY: [070,00S]PAYROL.LOG;1
SY: [070,00S]PAYROL.DES;2
SY: [070,00S]PAYROL.SEQ;2
SY: [070,00S]PAYROL.MSTil

the

THE RMS-ll FILE BACK-UP UTILITY:

RMSBCK

RMSBCK backs up, on ANSI-labeled magnetic tape, all
PAYROL files
in
the default account on SY:, into a container file named PAYROL.CON.
Query mode is explicitly enabled;
therefore,
any error condition
causes RMSBCK to issue a diagnostic message and query the user as to
whether processing should continue. While RMSBCK processes the input
files, it writes a summary to the terminal.
>BCK MMO:MASTER.BCK=*.OAT/CO:30-MAR-83:A/SL:BACKUP.LST
RMSBCK backs up, on ANSI-labeled magnetic tape, all
files
in the
default account on SY:
that were created after March 30, 1983 and
have a file type of .OAT.
Query mode is enabled by default;
therefore,
any error condition
causes RMSBCK to issue a diagnostic message and query the user as to
whether processing should continue.
RMSBCK also creates a summary
listing file named BACKUP.LST in the default account on SY:.
The file
contains a listing of the files processed and the diagnostic messages
and queries (and responses) that occurred during processing.
>BCK OBO: [70,1]*.*;*/SU=OBO: [70,10]*.*;*/RO:Ol-APR-83:B/NOQU
RMSBCK backs up all files
in account
[70,10]
on OBO:
that were
revised before April 1,
1983.
The back-up copies are written into
account [70,1] on the same disk (OBO:),
superseding files with the
same file names and types.
Query mode is disabled;
therefore, if RMSBCK encounters an error,
will issue a diagnostic message and terminate processing.

Note:
Examples 5-5 and 5-6
in the RMSDSP chapter
illustrate the
contents of the tape,
after the completion of the above backups.
Examples showing restores of these files are in the RMSRST chapter.

6-11

CHAPTER 7
RMS-ll FILE RESTORATION UTILITY:

RMSRST

The RMS-ll File Restoration Utility (RMSRST) transfers, to disk, files
that were backed up on magnetic tape or disk using RMSBCK.
The form,
structure, contents, and attributes (except file placement)
of the
restored files are those of the original files when they were backed
up.
File placement will not be restored.
A file cannot be restored to the
same physical place on the device from which it was backed up.
You can use RMSBCK and RMSRST to protect your data against hardware or
software failure:
files lost or damaged can be restored from back-up
copies.
You can also use RMSBCK and RMSRST to transfer files between different
operating systems,
for example, between RSX-llM/M-PLUS and VAX/VMS,
and between RSTS/E and RSX-llM/M-PLUS or VAX/VMS (see Section 7.4.3).
Files backed up using RMSBCK can be accessed properly only by RMSRST.
RMSBCK translates data
into a special format that cannot be read or
modified by user programs or other utility
programs.
RMSRST
translates the specially formatted data on the back-up files back into
standard RMS-ll files.
See Chapter 6 for information on RMSBCK.
RMSRST cannot restore a system disk as a bootable medium.
RMSRST provides six processing features:
•

Explicit and implicit input file selection -- You can specify
one or more input files with or without wild card characters.

•

Choice of restoration account and/or volume -- You can restore
files
into any account on any disk device to which you have
access privileges.

•

File transfer to different operating systems
You can
restore files created and backed up on one operating system to
another operating system.

•

Data integrity checks -- You can check the reliability of
restored data files.

•

Extended diagnostic messages
Query mode gives you the
option of continuing processing if RMSRST encounters an error
condition.

•

Summary listing
processing.

You

can

create

record

RMSRST

Section 7.4 describes these processing features in greater detail.

7-1

the

RMS-ll FILE RESTORATION UTILITY:

RMSRST

The following sections describe how to
invoke and
terminate RMSRST
(Section 7.1) and the RMSRST command string and switches (Sections 7.2
and 7.3).
Section 7.5 provides examples
illustrating the use of
RMSRST.
Appendix C documents messages.

7.1

INVOKING AND TERMINATING RMSRST

The RMSRST utility can be either installed or uninstalled.
is installed, invoke it with the command:

RMSRST

RST [command-string]
If you include a command string, RMSRST will execute the
return the system prompt.

command

and

If you do not include a command string, RMSRST will prompt for one:
RST>
If RMSRST is uninstalled on
MCR command:

RSX-IIM/M~PLUS

systems, invoke it with the

RUN $RMSRST
RMSRST will respond with the prompt:
RST>
In response to the prompt, you can type a command string or you can
type CTRL/Z to terminate the utility.
When RMSRST has executed a
command string, it returns the RST> prompt.
Section 7.2 describes the
RMSRST command string.
Indirect Command Files.
You can execute series of
RMSRST command
strings by means of indirect command files.
The command strings in an
indirect command file are executed when an at sign (@) followed by the
file's
name is specified to the utility.
The default file type of
.CMD is assumed if none is provided.
Installed RMSRST will accept indirect command files either
from the
system prompt or from the utility prompt.
For example, to execute the
command strings contained in the indirect command file RSTCOM.CMD, you
could type either of the following commands:
Rsr @RSTCOM
or
RST> @RSTCOM
Uninstalled RMSRST will accept indirect command files
utility prompt.
For example:

only

from

the

RST> @RS'rCOM
If you executed the indirect command file from the system prompt,
the
system prompt will be returned.
If you executed the indirect command
file from within RMSRST, the RST> prompt will be returned.

7-2

RMS-ll FILE RESTORATION UTILITY:
7.2

RMSRST

RMSRST COMMAND STRING

Forma,t
outfile [/switch ••• ] =infile [/switch ••• ] [,infile [/switch ••• ] ••• ]
outfile
The specification of a disk file to which back-up files
restored by RMSRST.
The file name and type must be
characters (*.*);
you cannot rename files as they are
by RMSRST.
You can omit the version or use a
character;
RMSRST will use the version of the original

are to be
wild card
restored
wild card
file.

If you omit the account field of the file specification,
RMSRST
will
restore the files to your default account.
If you specify
[*,*], RMSRST will restore the files to the original accounts
from which they were backed up.
If you explicitly specify an
account, RMSRST will restore the files to that account.
infile
The specification of a back-up file on disk or a container file.
A container file
is a magnetic tape file that contains RMS-ll
files that were backed up using RMSBCK."", You can use wild card
characters (*) to specify multiple contarner files.
If you omit the version and the input file is a
RMSRST applies the following defaults:

container

file,

•

If wild card characters appear in either or both the container
file name and type, RMSRST will restore all versions of the
container file that satisfy the wild card specification.

•

If both the container file name and the type are explicitly
specified,
RMSRST will restore the first container file that
it encounters that satisfies the specification and has a
version of O.

To restore a specific data file
from magnetic tape,
you must
specify the container file name and specify the data file name
with the /SE input file switch (see Section 7.3.3).
(You can use
RMSDSP to display information about the files in a container
file;
see Chapter 5.)
/switch
One of the switches listed in Table 7-1 and described in
7.3.

Section

In place of the command string, you can type HELP or
?
to display
help text about RMSRST, or /ID to display the current version of the
utility.

7-3

RMS-ll FILE RESTORATION UTILITY:
Table 7-1:
Type
Global

RMSRST

RMSRST Switches

Switch

Description

/ID

Identify current version
Default:

No identification

Enable
or
disable
file
version number conversion

/[NO]CV

Default:
Conversion enabled,
if appropriate
Enable or disable query mode

/[NO]QU

Default:

Provide summary listing
file, if specified)

/SL[:file-spec]

Default:
Output
File

(in

No summary

Change protection code

/FR

Default:

Original protection

Read-after-writing
integrity checking

/RA

Default:

data

No reading
data

Check-after-writing
integrity checking

/RC

Default:

No checking

Supersede existing files

/SU

Default:
Input
File

Query mode enabled

No supersession

Restore disk files
back-up date

/BD:dd-mmm-yy

Default:
/OA:[act nbr]l

based on

No date checking

Restore
files
original account

based

Defaul t:
No
criterion applied
/SE:file-spec or
/SE: (file-specl,file-spec2
[, ••. ,file-speclO])

account

Restore specified files from
container file
Default:
Restore
on container file

all

1. Square brackets are required with the act nbr argument.

7-4

files

RMS-ll FILE RESTORATION UTILITY:
7.3

RMSRST

RMSRST SWITCHES

This section describes the global,
output file,
and
input file
switches that you can specify in the RMSRST command string.
Global
switches are switches that can be specified anywhere
in the command
string.

7.3.1

Global Switches

The global switches are /CV, /10, /QU, and /SL.
/[NOJCV
Enables or disables file-version number conversion:
from decimal
to octal for VAX/VMS files being restored to RSX-llM/M-PLUS
systems.
You can use RMSDSP to display information about files backed up
using RMSBCK,
including the radix of the version number;
see
Chapter 5.
For more information about file transfer to different
operating systems, see Section 7.4.3.
For back-up files created using RMSBCK Version 1.8 or earlier,
the default
is /NOCV.
You must specify /CV explicitly to force
the conversion;
RMSRST will assume that the
file
is from a
"foreign" system (from RSX-llM/M-PLUS if RMSRST is being run on a
VAX/VMS system, or from VAX/VMS if RMSRST is being run on an
RSX-llM/M-PLUS system) and convert the file version number to the
correct radix for
the system on which the
fil~s
are being
restored.
If the file was originally created and backed up on a
RSTS/E
system,
it will have no version number, and the /CV switch will
have no effect.
If the back-up file is not from a foreign system and you specify
/CV,
the file version numbers may be converted to incorrect
values.
For back-up files created using RMSBCK Version 2.0,
the default
is /CV.
The file attributes preserved by RMSBCK include the
radix of the version number.
Version numbers will be converted
automatically,
if necessary, to the correct radix for the system
on which the files are being restored.
You can override the
conversion with /NOCV.
/10

Displays the current version of the RMSRST utility.

For example:

RST>OUTFIL.DAT/ID=INFILE.DAT
%RST-I-ID, Version 2.000
The last two digits of the version number (00
in this example)
are the patch level of the utility.
The /10 switch can also be
specified by itself on the command line:
RST>/ID
%RST-I-ID, Version 2.000

7-5

RMS-ll FILE RESTORATION UTILITY:

RMSRST

I[NO]QU
Enables or disables query mode.
If you specify IQU, RMSRST will
allow you to chose to continue or to terminate processing when
one of the following occurs:
•

A read error occurs on an input file.

•

A read-after-write error occurs on an output file when the IRA
switch is specified (see Section 7.3.2).

•

A read-after-write error occurs on an output file when the IRC
switch is specified (see Section 7.3.2).

•

The table allocated internally for data
integ~ity
for automatic retry of read errors is full

checks

When one of these errors occurs,
RMSRST prints a diagnostic
message specifying the type of error and the name of the file
being processed.
It also prompts you, asking whether you want to
continue processing.
If you answer
Y,
RMSRST will continue
processing the current file and command string.
If you answer N,
RMSRST will terminate processing immediately, without processing
the rest of the command string.
For example:
RST)OUTFIL.DAT/QU=INFILE.DAT
?RST-F-WCE, Check after write error on output file OUTFIL.DAT
VBN 1 to VB2.
Continue (Yes or No)?
Y
?RST-F-TER, Integrity check table full.
Continue (Yes or No)?
You can disable query mode with the INOQU switch.
print a diagnostic message when
it encounters
terminate processing.
By default, if you do not specify IQU or INOQU, query
be enabled.

RMSRST will
an error and
mode

will

ISL[:file-spec]
Directs RMSRST to produce a
summary of
file
restoration
processing.
The summary listing consists of the following:
•

The command string

•

The names of files successfully restored

•

The names of files that were
error messages

•

The diagnostic messages produced in query mode
was enabled)

•

A summary of any input errors and
a
summary of any errors
remaining
in restored output files after automatic retry of
data integrity checks (if you specified IRA or IRC)

not

restored,

with

associated

(if query

mode

If you specify a file as an argument to ISL, and a
file of the
same name and type already exists, RMSRST will append the summary
to that file.
You can thus use one file to keep a record of all
file conversions.
If you specify a file, and a file of the same name and type does
not exist, RMSRST will create a new file and write the summary to
that file.
7-6

RMS-ll FILE RESTORATION UTILITY:
If you do not specify a file,
terminal.

RMSRST

the summary will be written to your

Do not specify either the input file or the output
argument to ISL.

file

the

By default, if you do not specify ISL, RMSRST will write messages
to your terminal if it encounters errors (see Appendix C).

7.382

Output File Switches

The output file switches are IFR, IRA, IRC, and ISU.
IFR
Directs RMSRST to change the protection code of a
file when
it
restores
it to disk.
If the file is restored to the operating
system from which it was backed up, RMSRST changes the protection
code so that the default account (the account under which RMSRST
is running) becomes the owner of the file.
If the file being restored was created and backed up on another
operating system,
RMSRST will
set the protection code to the
system default.
For more
information on
intersystem
file
transfer, see Section 7.4.3.
If the file is restored to an account other
than
the one from
which
it was backed up and IFR is not specified, RMSRST will
interpret the account field as described in the definition of the
outfile
specification
in Section 7.1.
In this case,
the
protection code will not be changed:
the original owner will
remain the owner, and so on.
By default, if you do not specify IFR, RMSRST will not change the
protection code from the value copied when the file was backed
up.
IRA
Directs RMSRST to
read
the
restored
file
after writing
it.
RMSRST reads back each block of the file after it has been
completely restored.
If the device hardware detects a
read
error,
RSMRST will
respond according to whether query mode is
enabled (see the description of the I[NO]QU switch
in Section
7.3.1).
Note that you cannot specify IRA and IRC
in the same
string.
RMSRST terminates with the fatal error message:

command

?RST-F-CSW, Conflicting switch specified - Isw
The value Isw is IRA or IRC depending on which appears second
the command string.
By default, if you do not specify IRA, RMSRST
read-after-writing data integrity checking.

will

NOTE
For multivolume backup sets, the IRA and
IRC switches will not function properly
since
tape
positioning
cannot
be
accomplished on those files which span
tape volumes.
7-7

not

perform

RMS-ll FILE RESTORATION UTILITY:

RMSRST

IRC
Directs RMSRST to check the restored
file
after writing
it.
After the file has been completely restored, RMSRST reads it back
into memory block by block.
At the same time it reads the
input
(back-up)
file back into memory block by block.
RMSRST compares
corresponding blocks of the files as it reads them.
If an error
occurs during the comparison (a hardware read error or a mismatch
between the contents of the blocks),
RMSRST will
respond
according
to whether query mode is enabLed (see the description
of the I[NO]QU switch in Section 7.3.1).
Note that you cannot specify IRC and IRA in the same
string.
RMSRST terminates with the fatal error message:

command

?RST-F-CSW, Conflicting switch specified - Isw
The value Isw is IRA or IRC depending on which appears second
the command line.
By default, if you do not specify IRC, RMSRST
check-after-writing data integrity checking.

will

not

perform

ISU
Directs RMSRST to supersede an existing output
file with
the
records of the
input file.
RMSRST deletes the existing file,
creates one of the same name, type, and version, and writes
the
records of the input file to it.
By default, if you do not specify ISU and an output file already
exists with the same name, type, and version, RMSRST will print
the following error message and continue processing (RMSRST does
not restore duplicate files):
?RST-F-ER$FEX, File <file-spec> already exists

7.3.3

Input File Switches

The input file switches are lBO, lOA, and ISE.

IBD:dd-mmm-yy
Directs RMSRST to restore disk files based on their back-up date.
If you use wild card characters in the input file specification
and specify this switch, you can restore specific files within a
group of disk
files.
RMSRST will restore only the files that
satisfy the wild card specification and were backed
up on
the
specified date.
Note that you cannot use the IBD switch if the
input
files
are
stored on magnetic tape;
RMSRST cannot access the creation date
of a file on magnetic tape.
If the input
file
is on magnetic
tape and you specify lBO, RMSRST will terminate with the fatal
error message:
?RST-F-LSW,

Illogical switch in context of command - IBD

By default, if you do not specify lBO, RMSRST will apply no date
criterion
in
restoring files:
all files that satisfy the input
file specification will be restored.

7-8

RMS-ll FILE RESTORATION UTILITY:

RMSRST

lOA: [act nbr]
Directs RMSRST to restore files based on the account from which
the original files were backed up.
The [act nbr] argument is the
User Identification Code (UIC).
The square brackets are required
with the UIC.
If you use wild card characters in the input file specification
and specify this switch, you can restore specific files within a
group of disk or magnetic tape files.
RMSRST will
restore only
the files
that satisfy the wild card specification and were
backed up from the specified account.
By default, if you do not specify lOA,
RMSRST will apply no
account criterion in restoring files:
all files that satisfy the
input file specification will be restored.
ISE:file-spec
ISE: (file-specl,file-spec2[, ••• ,file-speclO])
Direct RMSRST to restore the specified data files
from magnetic
tape container files.
You can specify from 1 to 10 files;
multiple file specifications must be enclosed in parentheses and
separated by commas.
The file specification can contain only a file name,
type, and
version.
Wild card characters are permitted.
If you omit the
version, RMSRST will apply the following defaults:
•

All versions of the file will be restored if anyone
following conditions exists:

the

The file name or type is a wild card character.
The lOA switch is not specified for the container file.
The lOA switch is specified for
contains wild card characters.
•

the

container

file

but

The first version of the file that RMSRST encounters will
restored if either of the following conditions exists:

Neither the file name nor type is a wild card character.
The lOA switch is specified and contains
characters in the file specification.
By default, if you do not specify ISE, RMSRST
the files in the specified container file.

7.4

will

wild

card

restore

all

RMSRST PROCESSING

RMSRST restores data files that were backed up on disk or magnetic
tape
(container files)
using the RMSBCK utility (see Chapter 6).
RMSRST translates the container files into standard RMS-ll data files
with the form, structure, contents, and attributes (with the exception
of file placement) of the original data files when they were backed
up.
RMSRST provides six processing features, as described in the following
sections.

7-9

RMS-ll FILE RESTORATION UTILITY:
7.4.1

RMSRST

Explicit and Implicit Input File Specification

ThE? RMSRST command string allows you to specify input files either
explicitly
or
implicitly.
File specifications with wild card
characters (*) implicitly identify a collection of
files.
When you
use wild card characters, you can restrict the number of files
selected for processing by including the /BD input file switch
(see
Section 7.3.3), which selects disk files on the basis of their back-up
date.

7.4.2

Choice of Restoration Account or Volume

You can use the lOA input file switch to select specific data files
from the back-up files based on the account in which the data file
originally resided (see Section 7.3.3).

7.4.3

Intersystem File Transfer

You can use RMSBCK and RMSRST to transfer files
between different
operating systems,
for example,
between RSX-llM/M-PLUS and VAX/VMS
systems, and between RSTS/E and RSX-llM/M-PLUS or VAX/VMS systems.
Note, however, that VAX/VMS file versions are numbered in decimal and
RSX-llM/M-PLUS file versions are numbered in octal.
RMSBCK preserves
the radix of the file's version number:
a file that was created and
backed up on an RSX-llM/M-PLUS system has an octal version number;
a
file that was created and backed up on a VAX/VMS system has a decimal
version number.
RMSRST uses this information to determine whether the
version number should be converted to decimal or octal.
If the files you are restoring (with RMSRST Version 2.0)
were backed
up using RMSBCK Version 2.0, the version numbers will be converted
automatically to the proper radix.
RMSBCK Version 2.0 preserves the
attributes of the files backed up, including the radix of the version
number.
You can override the conversion by specifying /NOCV.
If, however, the files were backed up using
RMSBCK Version 1.8 or
earlier, the version numbers will not be converted automatically.
You
can specify the /CV switch to ensure that the version numbers are
converted to the proper radix.
For example, if you are restoring
files to RSX-llM/M-PLUS that were backed up using RMSBCK Version 1.8
or earlier on VAX/VMS,
you can specify /CV to convert the version
numbers from decimal to octal.
RSTS/E does not support file version numbers.
No conversion is
necessary,
therefore,
for
files created and backed up on RSTS/E and
restored to RSX-llM/M-PLUS or VAX/VMS.
The /CV switch has no effect
for these files.
See Section 7.3.1 for more information on the

/ev switch.

You can use RMSDSP (with the /FU switch) to display the attributes of
files backed up by RMSBCK;
see Chapter 5, Example 5-7.
The display
will indicate the radix of the version number for
RSX-LlM/M-PLUS and
VAX/VMS
files.
If
no
version
number appears
in the file
specification, the file was created on a RSTS/E system.

7-10

RMS-ll FILE RESTORATION UTILITY:

RMSRST

NOTE
Be careful when restoring files created
on RSTS/E systems to RSX-IIM/M-PLUS and
VAX/VMS
systems.
Files
marked
"Record format=Stream (RSTS/E)"
in the
RMSDSP display were not created using
RMS-ll and have no attributes.
RMS-ll
can
process
these
files
on
RSX-IIM/M-PLUS
and
VAX/VMS systems;
however,
because
RSTS/E
does
not
maintain
information on the largest
record written in a
file,
these files
may not be restored properly to other
operating systems.
For
information on restoring files created and backed
up
on
RSX-llM/M-PLUS and VAX/VMS systems to RSTS/E systems, see the RSTS/E
RMS-l1 utilities manual.

7.4.4

Data Integrity Checking

You can direct RMSRST to check data
integrity as each file
is
restored.
If you specify the /RA output file switch, RMSRST will read
back the contents of the restored file.
If you specify the /RC output
file switch,
RMSRST will read back, block by block, the contents of
the output (restored) file and the contents of the
input file and
compare them.
RMSRST automatically retries any read errors if
processing continues to normal termination.
Thus, you have three choices in data integrity checking:
•

You can specify neither /RA nor /RC and rely on software
hardware accuracy, backing up your files in minimum time.

and

•

You can specify /RA and verify that the restored files can
read, adding reading time to the minimum time.

•

You can specify /RC and verify that the restored files can be
read and that they exactly match the back-up files, adding
reading time and comparison time to the minimum time.

See Section 7.3.2 for descriptions of the /RA and /RC switches.

7.4.5

Extended Diagnostic Messages

Query mode allows you to specify that processing continues or
terminates when RMSRST encounters an error condition. By default,
query mode is enabled. When RMSRST encounters an error, it issues a
diagnostic message to your terminal and prompts you:
Continue (Yes or No)?
Depending on your response, RMSRST continues or terminates processing.
With this feature,
you can ensure that RMSRST does not terminate
processing of a group of ~iles if errors are encountered in only one
file.

7-11

RMS-ll FILE RESTORATION UTILITY:

RMSRST

You can disable query mode with the INOQU output file switch.
If
RMSRST encounters an error, it will issue a diagnostic message to your
terminal and immediately terminate processing.
See Section 7.3.1 for a description of the I[NO]QU switch.

7.4.6

Summary Listing

You can use the ISL switch to produce a summa:ry listing of RMSRST
processing,
including data
integrity checks and error messages.
RMSRST will either write the summary to your te:rminal or into a file
that
you
specify,
creating a permanent record of restoration
processing.
See the description of the ISL switch
example summary listing in Section 7.5.

7.5

Section

7.3.1,

and

the

RMSRST EXAMPLES

)f'tOU MMO: PAYROL
)RST *.*;*/SU/SL=MMO:PAYROL.CON
%RST-I-FPC, Processing complete
%RST-I-FPC, Processing complete
%RST-I-FPC, Processing complete
%RST-I-FPC, Processing complete
%RST-I-FPC, Processing complete

for
for
for
for
for

file
file
file
file
file

DBa: [70,5]PAYROL.DAT;2
DBa: [70,5]PAYROL.LOG;1
DBa: [70,~]PAYROL.DES;2
DBa: [70,5]PAYROL.SEQ;2
DBa: [70,5]PAYROL.MST;1

RMSRST searches the magnetic tape volume mounted on MMO:
for
the
container file,
PAYROL.CON.
The files
in the container file are
restored to their original form in the default
(user's)
account on
SY: .
Because the ISU switch is specified, if the current account contains a
file with the same file name and extension, RMSRST will supersede the
existing file with the file being restored.
)RST *.*;*=MMO:MASTER.BCK/SE: (STAT.DAT,ACCNT.DAT)
%RST-W-ER$FEX, File DBa: [70,5]STAT.DATil already exists
%RST-W-ER$FEX, File DBa: [70,5]ACCNT.DATil already exists
)RST *.*;*/SU=MMO:MASTER.BCK/SE: (STAT.DAT,ACCNT.DAT)
In both examples, RMSRST searches the volume mounted on MMO:
for
the
first occurrence of
the container file MASTER.BCK.
RMSRST searches
this file for the files STAT.DAT and ACCNT.DAT.
RMSRST then attempts
to restore these files to their original form in the default account
on SY:.
In the first example, the files cannot be restored because files with
the same name already exist in the default.
In the second example,
the ISU switch is specified so that the files in the default account
(on SY:) are superseded by the files restored from tape.

7-12

RMS-ll FILE RESTORATION UTILITY:

RMSRST

)RST [70,2]*.*;*/SU/SL:RESTOR.LOG=OBO: [70,1]*.*;*/BO:02-APR-83,MMO:*.*;*
)TYP RESTOR. LOG
RMSRST VERSION 2.000 02-APR-1983 01:49:43
[70,2]*.*;*/SU/SL:RESTOR.LOG=OBO: [70,1]*.*;*/BO:02-APR-83,MMO:*.*;*
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,
RST-I-FPC,

Processing
Processing
Processing
Processing
Processing
Processing
Processing
Processing
Processing
Processing
Processing

complete
complete
complete
complete
complete
complete
complete
complete
complete
complete
complete

for
for
for
for
for
for
for
for
for
for
for

file
file
file
file
file
file
file
file
file
file
file

OBO: [70,2]CUST.FIL;1
OBO: [70,2] CUST. SEQ; 1
OBO: [70,2]PAYROL.OAT;2
OBO: [70,2]STAT.OAT;1
OBO: [70,2]EMPLY.OAT;1
OBO: [70,2]ACCNT.OAT;1
OBO: [70,2]PAYROL.OAT;2
OBO:[70,2]PAYROL.LOG;1
OBO: [70,2]PAYROL.OES;2
OBO: [70,2]PAYROL.SEQ;2
OBO: [70,2]PAYROL.MST;1

RMSRST reads all files in the account [70,1] on OBO:
that were backed
up on April
2,
1983, and restores them to account [70,2] on SY:.
Then, RMSRST restores the files within all container files on MMO:.
As it writes the files to SY:, RMSRST supersedes any existing files
having the same file name and extension with the file being restored.
RMSRST also writes a summary listing to RESTOR. LOG;
the contents of
this file are displayed.

7-13

APPENDIX A
RMS-II FILE DEFINITION UTILITY:

A.I

RMSDEF

PURPOSE

The interactive RMS-II File Definition Utility (RMSDEF) creates RMS-II
files,
allowing you to control all attributes of the files being
created.

A.2

EFFECT

You specify file attributes by responding to requests
for data and
questions from RMSDEF.
The method of questioning is outlined in
Figure A-I.
The figure shows the general flow of processing while
Section A.4 shows actual messages and valid responses as well as the
meaning of each attribute.
You can also get help from the utility by
typing a question mark (?) in response to any question or request for
data.
RMSDEF can also build an indirect command file while you operate the
utility.
This command file can be used thereafter to (re)create
file(s) and can be modified to create other similar files.
See
Sections A.3.1 and A.4.1.
NOTE
Command files generated by RMSDEF are
not compatible across operating systems.
RMSDEF, however, does not write records into the file.
The actual
data contents of the file must be loaded after the RMSDEF utility
creates the file.
You can use either an application program,
the
RMSCNV utility, or the RMSIFL utility to write records into the file.
NOTE
RMSDEF interprets all quantities
enter as decimal numbers.

A-I

you

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

The following
list
indicates
the
information that
RMSDEF always
requests as well as the requests that depend on specifications typed.
1.

Command File?
a.

If yes, file specification

If yes, create only command file or
and command files?

File Specification and Supercession

Data Structure
a.

File organization

Record format

Maximum record size

CARRIAGE RETURN control?

RMS-11

Info~mation

possible
1.

Size of fixed control area for VFC records

Maximum number of records in a relative file

Block-spanning records in a sequential file?

FORTRAN character
control?

control

CARRIAGE

(indexed files only)

Mi nimum
1.

Position of key

Size of key

Data type

Name of key

Duplicate keys?

possible
1.

Change keys if duplicatable?

Null key value?

if alternate key

Null key character if null key value

if alternate key

File Structure
a.

both

Minimum

Key Definition
a.

create

Minimum
(indexed files only)

Areas?

Placement control?

A-2

RETURN

RMS-ll FILE DEFINITION UTILITY:

Initial allocation quantity

Default extension quantity

Contiguous?

possible
1.

Location if placement control

Exactly if placement control?

Type of alignment if placement control and areas

Data Allocation
a.

RMSDEF

(indexed files only)

Minimum
1.

Number of bytes in data buckets filled

Number of bytes in index buckets filled

possible
1.

Area containing index level 0 for each key if areas

Area containing index levels 2+ for each key if areas

Area containing index level 1 if areas

Protection

A-3

RMS-II FILE DEFINITION UTILITY:

RMSDEF

YES

Figure A-I:

RMSDEF Processing Flowchart

A-4

RMS-ll FILE DEFINITION UTILITY:
A.3

RMSDEF

CALL AND TERMINATION

A.3.l

Calling the utility

The RMSDEF utility can be either installed or uninstalled.
is installed, invoke it with the command:

RMSDEF

DEF [command-string]
whe.re command-string is one of the following:
@file-spec

if you want RMSDEF to read a command file named file-spec
that was previously generated by RMSDEF (see Section
A.4.l).
The utility processes the
file,
printing
messages only when it comes to the file creation phase
(see Section A.4.8).

HELP or ?

if you want an introductory HELP message for
utility.

/ID

if you want the version number of the RMSDEF utility
installed on your system.
RMSDEF prints the following
message:

the

RMSDEF

THIS IS THE RMS DEFINE UTILITY, VERSION 2.000
where nn is the patch level of the utility.
If you do not include a command string, the utility prints:
DO YOU WANT TO GENERATE A COMMAND FILE FOR FUTURE USE (NO)?
See Section A.4 for the complete dialog sequence.
If RMSDEF is uninstalled
command:

RSX-lIM/M-PLUS

systems,

type

the

MCR

RUN $RMSDEF
The utility prints:
DO YOU WANT TO GENERATE A COMMAND FILE FOR FUTURE USE (NO)?
See Section A.4 for the complete dialog.

A.3.2

Terminating the Utility

You may terminate RMSDEF at any time by typing a CTRL/Z.
The
keyboard monitor or command
interpreter resumes control
interface.

A.4
A.4.l
1.

current
of your

PROCESS
Command File
The terminal prints:
DO YOU WANT TO GENERATE A COMMAND FILE FOR FUTURE USE (NO)?

A-5

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

Type one of the following:
if you want to enter a file-spec
for
an
indirect
command
file
and RMSDEF to write entries into the
file as you move through the utility.
Go to step
2.

N or

(Am

if you do not want to build a command file.
Section A.4.2.

@file-spec

if you have already built a
command
file with
RMSDEF and want
RMSDEF to read it now and create
the specified file.
Go to Section A.4.8.

/ID

if you want the utility to identify itself with a
version
number.
RMSDEF prints
the
following
message:
THIS IS THE RMS DEFINE UTILITY, VERSION 2.0
where:
nn

is the patch level of the utility.

The terminal prints:
ENTER FILE SPECIFICATION FOR COMMAND FILE:
Type a file specification.
See the RSX-IIM/M-PLUS RMS-II User's
Guide
restrictions on file
specifications defined by your
operating system documentation.

The terminal prints:
DO YOU WANT TO CREATE THE FILE YOU WILL BE DESCRIBING (NO)?
Type one of the following:
if you want RMSDEF to create the RMS-II file
specified as well as the command file.

N or

ffiITl

being

if you do not want to create the RMS-il file,
only
the command
file
that can be used to create the
file later.
NOTE
The command file created by RMSDEF takes
the
following
form shown.
The utility
follows
each
comment
with
the
appropriate sequence of your entries,
each on a
separate
line.
Where you
press
RETURN to accept the default
value, RMSDEF places the CR/LF character
sequence on a
separate line
in
the
command file.

iTHE FIRST QUESTION ASKS FOR THE FILE SPECIFICATION.
iTHE NEXT
ATTRIBUTES

QUESTIONS

DEAL

WITH

FILE

iTHE FOLLOWING QUESTIONS DEAL WITH KEYS

A-6

ORGANIZATION

RECORD

(for indexed files only)

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

;THE NEXT QUESTIONS DEAL WITH ALLOCATION AND PLACEMENT ATTRIBUTES
;THE NEXT QUESTIONS ASK ABOUT FILL SIZES FOR
files only)

KEYS

(for

indexed

;THE FOLLOWING QUESTIONS DEAL WITH FILE PROTECTION

A.4.2
1.

File Specification
The terminal prints:
ENTER FILE SPECIFICATION:
Type one of the following:

file-spec

if you want to create (or simulate the creation of;
see Section A.4.l, step 3) an RMS-ll file.
Type a
file specification as defined by your
operating
system documentation;
see also the RSX-llM/M-PLUS
RMS-ll User's Guide for RMS-ll restrictions on file
specifications.
Go to Section A.4.3.

@file-spec

if you have built a
command
file
(see
"Command
File,"
Section A.4.1) and want RMSDEF to use it and
create the file specified.
Go to Section A.4.8.

The terminal prints:
IF THE FILE ALREADY EXISTS, DO YOU WANT TO SUPERSEDE IT
(NO)?
It
is possible
that a
file
already exists with the
file
specification you entered in step 1.
Note that a conflict will
result if you specified a version number
in
that
specifiction.
You must tell RMSDEF what to do if such a conflict occurs when it
tries to create the file you describe during
this
interactive
session.
Type one of the following:
if you want RMSDEF to supersede an existing file.

Y
N or

if you do not want RMSDEF to create the
file
you
will describe by superseding a file that exists.
CAUTION
1.

If you say "N" here, and

If you are
file, and

If you describe other
files
after
this one in that command file, and

If, when you use the command file, a
file with
the
file
specification
entered in step 1 exists:

generating

command

RMSDEF prints
the
following
error
message and terminates processing of the
command file.
A FILE WITH THE FILE SPECIFICATION YOU ENTERED ALREADY EXISTS
A-7

RMS-ll FILE DEFINITION UTILITY:
A.4.3

RMSDEF

Data Structure
The terminal prints:
ENTER FILE ORGANIZATION (SEQ):
Type one of the following:
SEQ or

rBDl

for sequential organization

REL

for relative organization

lOX

for indexed organization
NOTE
If you indicated a magnetic tape device
in the file specification, RMSDEF does
not request a file organization.
Since
a magnetic tape file requires sequential
organization, the utility prints:
SINCE YOU SPECIFIED
A
NON-DISK
ORGANIZATION MUST BE SEQUENTIAL!

DEVICE,

YOUR

FILE

have

differing,

same,

The terminal prints:
ENTER RECORD FORMAT (VAR):
Type one of the following:
VAR or (BDl

if the records in the
variable, lengths.

FIX

if the records in the file have the
fixed, length.

VFC

if each record in the file has a control area
with a
fixed
length and a data area of no
standard length, that
is,
variable with fixed
control.

STM

if the records
in the file
have no specific
format,
but
are
delimited only by record
terminator characters.
The stream format
is
permitted for sequential disk files only.

UDF

if there are no records
(or you do not want
RMS-ll to recognize records) in the file;
this
format is used only for block I/O files, such as
RMS-ll back-up files.
The undefined format is
permitted for sequential disk or tape files only.

file

RMSDEF rejects a format that conflicts with the file organization
specified, for instance, STM for indexed files.
3.

If you specified VFC in step 2, the terminal prints the following
message;
otherwise, go to step 4.
ENTER SIZE OF FIXED CONTROL AREA (2):
Type the decimal number of bytes in the fixed
control area of
each record
in the file.
The minimum size is 1 byte;
the
maximum size is 255 bytes;
the default is 2 bytes.

A-8

RMS-ll FILE DEFINITION UTILITY:
4.

RMSDEF

The terminal prints:
ENTER MAXIMUM RECORD SIZE:
or
ENTER MAXIMUM RECORD SIZE (0):
Type a decimal number indicating the maximum number of bytes
in
any record
in the file.
RMS-Il checks this value whenever a
record access operation is
requested for
this file:
if the
record specified exceeds the maximum size, RMS-ll returns an
error.
A size of zero disables the RMS-ll check, but a nonzero
value
is required
for
all
relative files and all files with
fixed-length records.

If you specified REL in step 1, the terminal prints the following
message;
otherwise, go to step 6.
ENTER MAXIMUM NUMBER OF RECORDS (0):
Type a decimal number indicating the maximum number of records
that this relative file will contain.
RMS-ll checks this value
whenever a record access operation is requested for
this file:
if the relative record number specified exceeds the maximum
record number, RMS-ll returns an error.
Pressing RETURN sets the
number to zero, which disables the RMS-ll check.
The zero allows
the file to contain as many records as
is physically possible
(the technical maximum is 2.14748 x 10**9 or 2,147,800,000).

If you specified SEQ in step 1, the terminal prints the following
message;
otherwise, go to step 7.
WILL YOU ALLOW RECORDS TO CROSS BLOCK BOUNDARIES (YES)?
Type one of the fOllowing:
Y or

(BIT)

if you want records to cross block boundaries.
if you do not want records to span blocks.
If you
specified FIX in step 2 and a maximum record size
greater than 512 in step 4, the terminal prints:

SINCE YOU SPECIFIED FIXED LENGTH RECORDS, YOU MUST HAVE A
MAXIMUM RECORD SIZE LESS THAN 512 BYTES (THE SIZE OF ONE
BLOCK) OR YOU MUST ALLOW RECORDS TO CROSS BLOCK BOUNDARIES.
PLEASE CHANGE ONE OF THESE.
RMSDEF repeats steps 4 and 6.
Change either your maximum
size or the answer to crossing block boundaries.
7.

record

The terminal prints:
DO YOU WANT CARRIAGE RETURN CONTROL (YES)?
Type one of the following:
Y or

(BIT)

if you want each record to be preceded by a
line
feed character and
followed by a carriage return
character when it
is written to a
unit record
device
(printer,
terminal,
and so on).
See the
following note and go to appropriate section.
if you do not want CARRIAGE RETURN control and/or
you do want FORTRAN character control.
Go to step
8.

A-9

RMS-ll FILE DEFINITION UTILITY:
8.

RMSDEF

The terminal prints:
DO YOU WANT FORTRAN CHARACTER CONTROL

(NO)?

Type one of the following:
if you want the first byte of each
record
to
be
interpreted
as
a
FORTRAN forms control character
when the record is written to a unit record device.

N or

(BBJ

if you do not want FORTRAN character control.

NOTE
If you indicated a magnetic tape device
in the file specification, at this point
RMSDEF requests:
ENTER MAGTAPE BLOCK SIZE (512):
Type a decimal
number
between
18 and
8192 representing the number of bytes in
each tape block.
The number should be a
multiple of
4;
if
it is not, RMS-ll
rounds
the
number
up
to
the
next
multiple of
4 before writing it as an
attribute.
Pressing
RETURN sets
the
size to the default of 512 bytes.
The
utility
then
bypasses
other
processing
and
immediately requests
protection
information
(see
Section
A.4.7).

A.4.4

Key Definition

As indicated by Figure A-I,
this
section applies
only to
files.
RMSDEF begins this portion of dialog with the message:

indexed

IT'S TIME TO DEFINE THE PRIMARY KEY
1.

The terminal prints:
ENTER DATA TYPE

(STR):

Type one of the following:
STR or (BIT)

if your key value is
characters.

INT

if your key
integer.

BIN

if your key value is
binary number.

PAC

if your key value is a packed decimal number.

value

a
is

a
a

22-

See the RSX-IIM/M-PLUS RMS-ll User's Guide for
key data types.

A-IO

string

alphanumeric
4-byte

4-byte

signed
unsigned

discussion

RMS-ll FILE DEFINITION UTILITY:
2.

RMSDEF

The terminal prints:
ENTER POSITION OF KEY:
Type a decimal number indicating the position of the first byte
of the key within each record.
For instance, if the key starts
with the first byte of the record, its position is 0.
The second
byte has position 1 and so on.
A position number must be specified for
each segment of a
segmented string key;
the numbers are separated by commas and
enclosed in parentheses.
Integer,
binary,
and packed decimal
keys cannot be segmented.
For example,
if a key has three
segments that start at the first,
fourth,
and
sixteenth
positions, they are described as follows:
(0,3,15)

The terminal prints:
ENTER SIZE OF KEY:
Type the decimal number of bytes in the key, that is, its length.
Valid lengths depend on the data type entered in step 1:
Data Type

Length Restrictions

STR

Minimum
Maximum

1 byte
255 bytes

INT

2 or 4 bytes

BIN

2 or 4 bytes

PAC

Minimum
Maximum

1 byte
16 bytes

A length must be specified for each segment of a segmented string
key;
the numbers are separated by commas and enclosed in
parentheses.
A length must be typed
for each position number
specified
in step 1, but the sum of all lengths cannot exceed
255.
Integer,
binary,
and packed decimal keys cannot
be
segmented.
For example,
the lengths of the keys in the step 2
example would be entered as follows:
(2,2,16)
4.

The terminal prints:
ENTER NAME OF KEY (NONE):
Type one of the following:
if you do not want to specify a key name.
name

if you want to name the key being
ASCII characters are allowed.

The terminal prints:
WILL YOU ALLOW DUPLICATE KEYS

A-ll

(NO)?

defined;

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

Type one of the fOllowing:
Y

if the file may contain more than one record with
the
same
value
for
this
key.
Alternate keys must be specified as
duplicatable before they can be specified as changeable
(in
step 6).

if each record in the file must have a unique value for this
key.
RMS-ll
returns an error if duplication is attempted;
that is, put or update operations fail when the record has a
value in this key field exactly like a record already in the
file.

Defaults and the values of dflt are:
Primary Key

Alternate Keys

Yes

When defining the primary key, go to step 10.
step 6.

Otherwise,

If you specified Yes in step 5, the terminal prints the following
message;
otherwise, go to step 7.
WILL YOU ALLOW KEYS TO CHANGE

(YES)?

Type one of the following:
Y or

ffi)

if this alternate key can change values during
an
update operation;
that is, the record may be read
with one value
for
the key and
rewritten with
another value for the same key.
if this alternate key must not
record is originally created.

change

after

the

The terminal prints:
DO YOU WISH TO DEFINE A NULL KEY VALUE

(NO)?

Type one of the following:
if you want the file to contain some records
that
cannot
be
accessed
via
this
key.
See
the
RSX-llM/M-PLUS RMS-ll User's Guide.
Go to
step 8
only
if you
specified a
string
key
(step 1).
Otherwise, go to step 9;
the other key data
types
have a null key value of O.

N or

ffi)

if you do not want to specify a null value for this
key.
Go to step 9.

The terminal prints:
ENTER NULL KEY VALUE CHARACTER:
Type one of the following:

the single character itself,
SPACE.

#40

for SPACE.

#43

for the reserved character #.

A-12

if it is not

RMS-ll FILE DEFINITION UTILITY:

#77

for the reserved character ?

#100

for the reserved character @.

#nnn

any octal byte value

RMSDEF

(000-377), specified by nnn.

The terminal prints:
JUST FINISHED ALTERNATE KEY nnn
where:
nnn

10.

starts with 1 and is incremented when you
the next question (step 10).

answer

Yes

The terminal prints:
DO YOU WANT TO DEFINE MORE KEYS

(NO)?

Type one of the following:
if you want to define more keys for the file.
may define up to 254 alternate keys;
however:

You

•

The RMSIFL and RMSCNV utilities do not read
higher
than the ninth alternate key;
that
is, the /KR switch must be
less
than or
equal to nine (see Chapters 3 and 4).

•

Your application language may not support
that many keys.
See your language manual.

RMSDEF then requests the information (in steps 1-9)
for each alternate key indicated;
the alternate
keys are defined in order, beginning with the first
alternate after the primary key is defined.
N or (BIT)

A.4.S

if all keys for this file are defined.

File Structure
If you specified lOX for indexed file organization, the
prints the following message;
otherwise, go to step 2.
DO YOU WANT TO DEFINE AREAS

terminal

(NO)?

Type one of the following:
Y

if you want parts of this
file
to be
logically
different,
with different attributes.
See the
RSX-llM/M-PLUS RMS-ll User's Guide.
The
following
questions (steps 2-9) are asked for each area.

N or (BIT)

if you want this indexed file located in one area.
RMSDEF requests
the
following information (steps
2-9) for the file once.

A-13

RMS-ll FILE DEFINITION UTILITY:
2.

RMSDEF

The terminal prints:
DO YOU WANT PLACEMENT CONTROL (NO)?
Type one of the following:
if you want to specify an exact location
for this file or area.
Go to step 3.

or ffiTI)

disk

if you do not want to specifically locate this file
or area.
Go to step 6: ·

On RSX-IIM systems, the te~minal prints
only for areas 1+ in indexed files.
ENTER TYPE OF ALIGNMENT

the

following

message

(LBN):

Type one of the following:

LBN or (B:U)

if the location you will specify in step 4 is
logical block number (LBN) on the disk volume.

VBN

valid only for areas 1+ in indexed files, if the
location you will specify in step 4 is a virtual
block number (VBN) already established within the
file;
that
is, you are trying to closely align
this area with a defined area.

The terminal prints:
ENTER LOCATION:
Type the decimal number location of the first block for this file
area.
There is no default.
For the first area defined, this
number is a logical block number.

The terminal prints:
EXACTLY (NO)?
Type one of the following:
if this file or area must start in
the exact LBN
location specified in step 4.
If this location is
not available, RMSDEF prints an error message after
it tries to create the file.
Exact VBN locations
are already taken, by definition.

or (B:U)

if you will accept the closest approximation of the
LBN or VBN location specified in step 3, when the
exact location is not available.

The terminal prints:
ENTER INITIAL ALLOCATION IN BLOCKS (0):
Type a decimal number indicating the initial size of the file or
area
in blocks.
Pressing RETURN sets the value to zero:
the
area will be created, but it must be extended before any records
can be written into it.
Since automatic file extension is time
consuming, the file should be fully allocated when it is created
(see the RSX-IIM/M-PLUS RMS-ll User's Guide).

A-14

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

NOTE
If you have specified placement control
(step 2), you should type a nonzero
allocation
quantity.
An
initial
allocation of zero blocks essentially
nullifies placement control:
the file
processor does not allocate any blocks
to the file, so it does not use the
placement
control
information.
For
example, you can place multiple files at
the same LBN location, even answering
YES to EXACTLY?
(step 5), as long as
you use zero allocation quantities for
all but one.
7.

If you specified REL or IDX for file organization,
the
prints the following message;
otherwise, go to step 8.

terminal

BUCKET SIZE (1):
Type a decimal number indicating the number of blocks in a bucket
for
this file or area.
The minimum is the number of blocks that
can contain one record (according to the size specified;
see
Section A.4.3,
step 4);
the maximum is 32 blocks;
the default
is 1. This number determines the number of blocks read
into
memory during each file access operation and therefore affects
processing speed and the amount of memory a program accessing
this file requires.
See the RSX-IIM/M-PLUS RMS-11 User's Guide.

The terminal prints:
ENTER DEFAULT EXTENSION QUANTITY IN BLOCKS (0)
Type a decimal number indicating the number of blocks that should
be added to the file or area each time RMS-ll extends it.
The
default extension quantity (DEQ) should be a multiple of the
bucket size.
RMS-11 requests this number of blocks from the
operating system when it extends the file or area.
Pressing RETURN sets the value to zero:
RMS-ll adds only the
minimum space required each time it expands the file or area.
A
definite, but reasonable extension quantity speeds processing.

The terminal prints one of the following messages:
DO YOU WANT A CONTIGUOUS AREA (NO)?
or
DO YOU WANT A CONTIGUOUS FILE (NO)?
Type one of the following:
Y

if you want the disk space for this file or area allocated
in contiguous blocks.
If the file processor cannot find
that many contiguous blocks, it will not create the file,
even if enough noncontiguous blocks are available.
A contiguous file or area may be extended although the disk
space
added may not be contiguous with the original
allocation.

A-15

RMS-ll FILE DEFINITION UTILITY:

10.

If you answered Yes in step 1 (you have an
terminal
prints
the following messages;
next appropriate section.

RMSDEF
indexed
file),
the
otherwise, go to the

JUST FINISHED WITH AREA NUMBER nnn
DO YOU WANT TO DEFINE MORE AREAS (NO)?
Type one of the following:
if you want to specify attributes for another
area
of your
file.
Areas are numbered sequentially,
starting with zero.
The areas are associated with
the index and data portions of the file in the next
section of the utility.
Go to step 2.

N or

11.

(ffi)

if you have defined enough areas for this file.
to step 11.

If you defined one or more areas with a DEQ of zero, the terminal
prints the following message;
otherwise, go to the next section.
ENTER FILE DEFAULT EXTENSION QUANTITY (0):
Type a decimal number indicating the number of blocks that should
be added to the file each time RMS-ll extends it.
The DEQ should
be a mUltiple of the bucket size.
Pressing RETURN sets the value
to
zero:
RMS-ll will add only the minimum space required each
time it e~pands the file.
A definite, but reasonable extension
quantity speeds processing.

A.4.6

Data Allocation

As indicated by Figure A-I,
this
section applies only to
files.
RMSDEF begins this portion of dialog with the message:

indexed

IT IS TIME FOR AREA NUMBERS AND FILL FACTORS FOR KEYS.
The questions are asked for each key defined
(see
RMSDEF begins the first session with the message:

Section

A.4.4).

THESE QUESTIONS ARE FOR THE PRIMARY KEY
Any further sessions begin with the message:
THESE QUESTIONS ARE FOR ALTERNATE KEY NUMBER nnn
where:
nnn

starts with 1.

The terminal prints:
ENTER AREA NUMBER FOR DATA BUCKETS FOR THIS KEY (0):
Type an integer (O-n) indicating the area already defined
(see
Section A.4.4) that should contain the data portion (level 0) of
this key's index.

A-16

RMS-II FILE DEFINITION UTILITY:
2.

RMSDEF

The terminal prints:
THE BUCKET SIZE IS nn
ENTER FILL NUMBER FOR DATA BUCKETS (0):
Type a decimal number of bytes in each of this key's data buckets
that should be used during the original population of the file.
This number is honored by the RMSCNV and RMSIFL utilities and may
be honored by MACRO-II programs.
See the RSX-IIM/M-PLUS RMS-ll
User's Guide.
Pressing RETURN sets the number to zero, indicating that buckets
will be filled and that no free space will be available in
existing buckets for records added after the file is populated.

The terminal prints:
ENTER AREA NUMBER FOR INDEX BUCKETS FOR THIS KEY (0):
Type an integer (O-n) indicating the area already defined
(see
Section A.4.4) that should contain the upper portions (levels 2+)
of the index for this key.

The terminal prints:
THE BUCKET SIZE IS nn
ENTER FILL NUMBER FOR INDEX BUCKETS (0)
Type a decimal number of bytes in each of this key's index
buckets that should be used during the original population of the
file.
This number is honored by the RMSCNV and RMSIFL utilities
and may be honored by MACRO-II programs.
Pressing RETURN sets the number to zero, indicating that buckets
will be filled and that no free space will be available in
existing buckets for records added after the file is populated.

The terminal prints:
ENTER AREA NUMBER FOR THE LOWEST INDEX LEVEL FOR THIS KEY (0):
Type an integer (O-n) indicating the area already defined
(see
Section A.4.4) that should contain the lowest index level (level
1) portion of this key's index.
If the area you specified for the upper portions of the index
(levels 2+) and the area you specified for level 1 have different
bucket sizes, RMSDEF prints the following message and returns to
step 3:
THE AREA ASSOCIATED WITH THE LOWEST LEVEL INDEX BUCKET
HAS A DIFFERENT BUCKET SIZE THAN THE AREA ASSOCIATED WITH
THE HIGHER INDEX BUCKET. TRY BOTH AGAIN.

A-17

RMS-ll FILE DEFINITION UTILITY:
A.4.7

RMSDEF

Protection
The terminal prints:
SPECIFY PROTECTION BY CLASS:
OWNER (RWED ALLOWED):
Type one of the fOllowing:
if you want this file
available
to
access
(Read,
Write, Extend or Execute, Delete) by
the
account
current when
the
file
is
created.
NONE

R, W,

if you do not want the file
owner
to have
access to this file after it is created.
E, and/or D

if you want to specify a level of protection
between none
and all.
You may specify one
or more of the
letters
representing
Read,
Write,
Extend,
and
Delete
without
separation.

The terminal prints:
GROUP

(RWED ALLOWED):

Type one of the following:
if you want this file
available
to
access
(Read,
Write, Extend or Execute, Delete) by
accounts with
the
same group or
project
number as the owner's account.

NONE

if you do not want the group members to have
access to this file after it is created.

R, W, E, and/or D

if you want to specify a level of protection
between
none
and all.
You may specify one
or more of the
letters
representing
Read,
Write,
Extend,
and
Delete
without
separation.

The terminal prints:
SYSTEM (RWED ALLOWED):
Type one of the following:
if you want this file
available
to
access
(Read,
Write, Extend or Execute, Delete) by
system privileged accounts.
NONE

privileged
accounts
if you do not want
this
file
after
it
have
access
to
created.

R, W, E, and/or D

if you want to specify a level of protection
between
none
and all.
You may specify one
or more of the
letters
representing
Read,
Write,
Extend,
and
Delete
without
separation.

A-18

to
is

RMS-ll FILE DEFINITION UTILITY:
4.

RMSDEF

The terminal prints:
WORLD (R ALLOWED):
Type one of the following:
if you want this file available for
Read
access only by all accounts outside the
owner, group, and privileged accounts.

A.4.B

NONE

if you do not want other accounts to have
access to this file after it is created.

R, W, E, and/or 0

if you want to specify a level of protection
other than none and Read only.
You may
specify one or
more
of
the
letters
representing Read, Write, Extend, and Delete
without separation.

File Creation

The RMSDEF utility attempts to create the file.
Success -- If RMS-ll does not return an error, the utility prints:
YOUR FILE HAS BEEN CREATED -- file-spec
If you chose to create a command file (See Section A.4.1), RMSDEF also
prints the following message. Otherwise, the utility requests you to
enter another file specification (Section A.4.2).
YOUR FILE HAS BEEN PROCESSED AND A COMMAND FILE GENERATED -- file-spec
DO YOU WANT TO CLOSE THE COMMAND FILE (NO)?
Type one of the following:
if you are finished specifying files
for
the command
file.
The utility returns to the question about command
file generation (see Section A.4.1).

or (BIT)

if you want to specify another RMS-ll file and you want
the
command
file
to
include your
input.
RMSDEF
continues to use the command file originally specified
and to obey your answer to the DO YOU WANT TO CREATE THE
FILE YOU WILL BE DESCRIBING?
question
(see Section
A.4.1,
step 3).
The utility returns to the request for
a file specification (see Section A.4.2).

You may start the process to create another file
terminate the utility.

type

CTRL/Z

Errolr -- RMSDEF allows you to recover from one type of creation error.
The terminal prints an error description, followed by:
DO YOU WISH TO REENTER THE ENTIRE FILE SPECIFICATION (YES)?

A-19

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

Type one of the following:
Y or @]

if you know how to correct the error and/or want to
enter another file specification.
The utility requests
the file specification and attempts to create the file
using it.

if you do not know how to correct the error and/or
to
start
again.
RMSDEF
returns
to
the
specification request (Section A.4.2).

want
file

Other errors result in one of the following messages:
•
•

THIS FILE CANNOT BE CREATED
RMS STATUS CODE = nnnnnn

SYSTEM CODE

= nnnnnn

THIS FILE CANNOT BE CREATED SINCE THE FILE ALREADY EXISTS
YOU DID NOT SPECIFY SUPERSEDE.

The RSX-llM/M-PLUS RMS-ll User's Guide defines the
by nnnnnn.

codes

The utility returns to the file specification request
restart the definition process (see Section A.4.2).

A.5

AND

represented
to

let

you

RMSDEF MESSAGES

BAD UIC, TRY AGAIN
Explanation:
The account number in the file specification is not
valid for your operating system for one of the following reasons:
•

Either one or both parts of the account number exceeds the
maximum value allowed;
the range is 1 through 377 (octal).

•

The specified account has
manager.

User Action:
number.

not

been

set

Type the file specification with

by
a

the

system

valid

account

THE DEFAULT EXTENSION QUANTITY MUST BE A MULTIPLE OF THE BUCKET SIZE
Explanation:
You typed a decimal number of blocks for default
extension quantity,
but that number is not an integral multiple
of the bucket size you specified.
User Action:
Type the next higher multiple of
default extension quantity.

A-20

bucket

size

for

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

** DEVICE IS FULL **
Explanation:
RMSDEF attempted to create the file you defined,
but could not allocate the number of blocks you specified in the
way you specified for one of the following reasons:
•

There exist insufficient free clusters to allocate the
file.

•

There exist insufficient free contiguous clusters to allocate.

•

There is insufficient free space in the User File
(UFO) to map all allocated clusters of the file.

•

The allocation is too large for the device.

User Action:
Determine the cause of the error.
can be altered to compensate.

The

entire

Directory

parameters

** DEVICE NOT AVAILABLE **
Explanation:
RMSDEF attempted to create the file you defined,
but could not access the specified device because it was not
ready or online.
User Action: Make the specified device ready or specify
device;
and try again.

another

DIRECTORY NOT FOUND
Explanation:
RMSDEF attempted to create the file you defined,
but the file processor indicates that the specified account has
not been set up.
User Action:
Specify another account number
system manager to create the specified account;

or request the
and try again.

ERROR IN LUN ASSIGNMENT
Explanation:

RMSDEF assigned a logical channel erroneously.

User Action:

Recall the utility and try the dialog again.

ERROR WITH INDIRECT FILE
Explanation:
You directed RMSDEF to read an indirect file,
but
the utility detected an error in the file that is not covered by
other error messages.
User Action:

Recall the utility and respecify the indirect file.

FILE SPECIFICATION IS TOO LONG
Explanation:
You directed RMSDEF to read an indirect file,
but
the specified file contains either a file specification longer
than 120 bytes or a line (record) longer than 80 bytes.
User Action:
Edit the indirect
specification or line.
Recall
indirect file.

A-21

file,
shortening
the utility and

the
file
specify the

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

I/O ERROR IN PROCESSING INDIRECT FILE
Explanation:
You directed RMSDEF to read an indirect file,
the utility detected an I/O error during its processing.

but

User Action:
Recall the utility and respecify the indirect file.
If this error recurs, re-create the indirect file.
ILLEGAL DEVICE, TRY AGAIN
Explanation:
RMSDEF attempted to create the
file you defined,
but encountered an error:
either the specified device is not on
your computer system or the utility has erroneously assigned
its
logical channel to another device.
User Action:
If the device is not on your system and
logical name, specify another device and try again.

not

ILLEGAL FILE SPECIFICATION, TRY AGAIN
Explanation:
RMSDEF
specification.
User Action:
ILLEGAL KEY SIZE.

detected

syntax

error

the

Retype the file specification correctly.
TYPE?

FOR HELP.

Explanation:
You typed a key size that is not valid for the
data type you specified.
User Action:
Type a question mark (?)
showing the size restrictions
for
Then, type a valid key size.
ILLEGAL VALUE.

file

TYPE?

key

to print a
HELP message
the different data types.

FOR HELP.

Explanation:
You typed a value that is not a proper reply to the
current question or request.
User Action:
Type a question mark (?) to print a
HELP message
that should help you determine the proper values.
Then type a
proper value for the question or request.
INVALID DATA IN COMMAND FILE
Explanation:
You directed RMSDEF to read an indirect
file,
but
the a
line
in
that
file did
not satisfy the utility's data
requirements.
If you specified
the
indirect
file
at command
level,
RMSDEF returns to that level.
However, if you specified
the indirect file after the utility printed
its prompt,
RMSDEF
continues its dialog with you rather than the indirect file.
User Action:
Correct or re-create the
indirect
again, or continue the interact,ive dialog.

A-22

file

and

try

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

KEY EXCEEDS MAXIMUM RECORD SIZE.
Explanation:
You typed a size for the key being defined
extends the key beyond the end of the record you defined.

which

User Action:
Type a smaller size or terminate the current
session with a CTRL/Z and start again, defining a larger maximum
record size.
MAXIMUM NESTING DEPTH EXCEEDED IN INDIRECT FILE
Explanation:
An indirect command file contains an indirect
command.
RMSDEF does not permit nesting of indirect commands.
User Action:
Type the contents of one or both of the indirect
command files as a sequence of individual command strings.
OPEN ERROR IN INDIRECT FILE
Explanation:
You directed RMSDEF to read an indirect file,
but
the utility could not open the file.
The file may not exist as
specified;
it may be locked;
or there
is some other problem
with the file.
User Action:

Correct the problem and try again.

** PRIVILEGE VIOLATION **
Explanation:
RMSDEF attempted to create the file you
but the operating system denied the utility access.
User Action:

defined,

Correct the problem and try again.

SEGMENTS ARE NOT ALLOWED WHEN THE KEY IS NUMERIC
Explanation:
You attempted to indicate segments for a key
defined as numeric (integer, binary, or packed decimal).
User Action:

you

Enter one size or position.

SUM OF SEGMENTED KEY SIZES IS GREATER THAN 255.
Explanation:
You typed a series of sizes for a segmented key.
However,
the sum of those sizes is greater than 255 bytes, the
maximum size for one key.
User Action:
Type the series of sizes again, making one or more
of the segments smaller so that their total is 255 or less.
You
could make two keys out of the one you are attempting to define:
reduce the segments in this key and when RMSDEF asks if you have
more keys to define, type Y and specify another key containing
the rest of the segments.
SYNTAX ERROR IN INDIRECT FILE SPECIFICATION
Explanation:
You typed a
file
specification for
command file, but there was a syntax error in it.
User Action:

Type the file specification correctly.

A-23

indirect

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

THE BUCKET FILL SIZE IS GREATER THAN THE ACTUAL BUCKET SIZE.
Explanation:
You typed a decimal
number of bytes as a
fill
number.
However, that number is greater than the total bytes in
the bucket you specified for the current area.
User Action:

Type a fill number smaller than the bucket size.

THE NUMBER OF VIRTUAL BLOCKS PER BUCKET IS NOT BIG ENOUGH GIVEN
THE MAXIMUM RECORD SIZE YOU SPECIFIED.
Explanation:
You typed a bucket size that would not contain
the
largest record you indicated in the maximum record size question.
User Action:
Enter a
utility,
recall
it,
maximum record size.

larger bucket size;
or
terminate
the
and
redefine the file with no or a larger

TOO MANY AREAS
Explanation:

You typed Y in response to the question:

DO YOU WANT TO DEFINE MORE AREAS

(NO)?

However, you have defined 255 areas, the maximum for one file.
User Action:
Continue with the RMSDEF
complete the file definition.

interactive

session

and

TOO MANY KEYS
Explanation:

You typed Y in response to the question:

DO YOU WANT TO DEFINE MORE KEYS

(NO)?

However, you have defined 255 keys, the maximum for one file.
User Action:
Continue with the RMSDEF
complete the file definition.

interactive

session

and

TOO MANY SEGMENTS
Explanation:
You are defining a
segmented key.
However,
the
series of positions or the series of sizes you typed contained
more than eight numbers, the maximum segments for one key.
User Action:
Type the number series again, using
eight values.

A-24

than

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

WARNING - BE AWARE THAT THE FILENAME HAS BEEN TRUNCATED.
Explanation:
In the file specification you
just typed,
you
specified a
file name longer
than nine characters.
RMSDEF
continues the interactive sessjon, but the utility uses only the
maximum number of characters allowed in the file name when it
tries to create the file.
For example,
you type the file
specification:
ACCOUNTING.DAT
RMSDEF uses only ACCOUNTIN.DAT when it tries to create the file.
User Action:
Continue the session unless you cannot
file name truncation.

the

WARNING - BE AWARE THAT THE FILE TYPE HAS BEEN TRUNCATED.
Explanation:
In the file
specification you
just typed,
you
specified a
file
type longer
than three characters.
RMSDEF
continues the interactive session, but the utility uses only the
first
three characters in the file type when it tries to create
the file.
For example, you type the file specification:
PAYDAY.FILE
RMSDEF uses only FIL when it tries to create the file.
User Action:
Continue the session unless you cannot
shorter type.
YOU ENTERED A
QUESTION.

DIFFERENT

NUMBER

SEGMENTS

THE

KEY

the

POSITION

Explanation:
You are defining a segmented key.
However,
the
series of key sizes you typed does not contain the same number of
segments as the series of key positions you typed
for
the last
question.
User Action:
Type the key size series again, specifying the same
number of segments that you used in the key position series.
YOU HAVE SPECIFIED A VIRTUAL BLOCK NUMBER
BOUNDARIES OF THE FILE.

WHICH

NOT

WITHIN

THE

Explanation:
You are using virtual block number (VBN)
alignment
to place a file area other than area O.
However, the number you
typed in response to the LOCATION:
request is not a valid VBN
for the file you have defined to this point.
User Action:
Recalculate the extent of the file you have defined
to this point by adding the initial allocation quantities for all
the areas defined, starting with area O.
Use the sum to help you
type a valid VBN.

A-25

RMS-ll FILE DEFINITION UTILITY:

RMSDEF

YOU ORIGINALLY GAVE A BAD FILE SPECIFICATION WHICH WAS OUTPUT TO
COMMAND FILE.
YOU MUST EDIT THE CHANGE IN YOURSELF.

YOUR

Explanation:
When you typed a file specification
for
the
file
you were defining,
you made an error.
RMSDEF allowed you to
retype the file specification at
the end
of
the
interactive
session,
after
it failed to create the file.
However, you also
directed the utility to create an
indirect
file during
the
session.
That
indirect
file
now has
an
incorrect
file
specification at its beginning.
User Action:
Before you can use
the
indirect
file,
you
change the invalid file specification with a file editor.

A-26

must

APPENDIX B
RMSDES AREA DEFINITION

One option in using RMSDES is to allow the utility to define areas by
default.
In most cases,
this
is the best option and will provide
optimal area definitions.
RMSDES bases its area calculations on the number of keys specified
the key section:
•

•

If you specify 1 key (the primary key), RMSDES will define
areas:
Area 0

data level for primary key

Area 1

level-l index

Area 2

level-2 index

If you specify 2 keys, RMSDES defines areas 0, 1, and
above, plus 2 additional areas:
Area 3

all index levels

Area 4

data level for first alternate key

in
3

If you specify 3 or more keys, RMSDES defines areas 0 through
4,
as above, plus 1 new data-level area for each additional
key specified.
For example, if you specify 4 keys,
RMSDES
will define areas 0 through 4, as above, plus 2 new
data-level areas for keys 3 and 4 (or 7 areas total) •
All
index levels will be in area 3.

Note that the data area for alternate keys contains a set of
from the alternate index to the user data records.

pointers

In defining areas, RMSDES automatically calculates default allocation,
bucket size, and extension values for each area.
RMSDES calculates allocation using
the maximum record number
(see
Section 2.6.2)
and the record size (see Section 2.6.3).
If you are
allowing RMSDES to define areas by default, you must set these
attributes in the file and record sections of the design buffer.
Otherwise, RMSDES will calculate an allocation that may not be
appropriate for your file.
RMSDES allocation calculations also take into
account
whether
duplicate key values are allowed, based on your response to the prompt
for the average number of duplicates (see Section 2.6.5).

B-1

RMSDES AREA DEFINITION
You will be prompted for bucket size when you allow RMSDES
to define
areas by default
(see Section
2.6.5).
You can respond with an
explicit bucket size for RMSDES to use in defining areas, or you can
take the default.
By default, RMSDES sets bucket size to 2 blocks, or
to a size great enough to contain 1 record if record size
is greater
than 2 blocks.
RMSDES calculates the default extension as
5 percent
calculation, rounded to a multiple of bucket size.

B-2

the

area

APPENDIX C
RMS-ll COMMAND UTILITIES MESSAGES

Section C.l of this appendix documents error messages
issued by the
RMSBCK,
RMSRST, RMSCNV, and RMSDSP command utilities.
RMSIFL command
utility messages are documented in Section C.2.
Messages
issued by
the
interactive utilities RMSDES and RMSDEF are documented in Chapter
2 and Appendix A, respectively.
The following conventions are observed in the messages
this appendix.
Convention

documented

Meaning

A question mark, appearing as the first character of a
message,
indicates a
fatal
error condition. When a
fatal error condition occurs,
the utility terminates
processing
at
the point at which the error was
encountered.

A percent sign, appearing as the first character of a
message,
indicates a
nonfatal error, warning, or an
informational
message.
The
utility
terminates
processing of only the file causing the error.
The
utility continues processing any other
files specified
in the command string.

A character representing the severity level for
the
error.
A severity code of F is fatal, a severity code
of I is informational, and a severity code of W is a
warning.

utI

The 3-character name of
error.

the

utility

encountering

the

<date>

A date you specified within the command string.

A device specification.

<file-spec>

A file specification.

A numeric value representing a
file processor error
code.
When an error message contains a fipcode, refer
to the description of the code in the error code
appendix of the
IAS/RSX-Il
I/O Operations Heference
Manual.

<nn>

A numeric value.

A numeric value representing an RMS-II error code. When
an
error
message contains a code,
refer
to the
description of such codes
in
the
RMS-Il
Macro
Programmer's Guide.

RMS-ll COMMAND UTILITIES MESSAGES
<status-val>

A status value representing either a fipcode or detailed
information about an operation (for example, a status
subcode) •

A command or fragment of a command.

A switch appearing within the command string.

<value>

A switch value appearing within the command string.

<vbn>

A virtual block number.

C.l

RMSCNV, RMSDSP, RMSBCK, AND RMSRST ERROR MESSAGES

This section lists all RMSCNV,
RMSDSP,
RMSBCK,
and RMSRST error
messages.
An explanation and the appropriate user action is indicated
for each message.
?utl-s-ANA, Argument not allowed Explanation:

The specified switch does not accept arguments.

User Action:
Refer to the appropriate chapter and verify the
usage for the switch you specified.
Retype the command line.
?utl-s-APR, File <file-spec> is not empty, lAP switch is required
Explanation:
The output file exists, the file was not empty, and
the ISU switch was not specified.
User Action:
To supersede, specify the ISU switch.
specify the lAP switch.

append,

values

?utl-s-BFS, Too many selective file specifications
Explanation:
More than 10 file specifications appear
of the ISE switch.

User Action:
Type the command string specifying no more than 10
file specifications as values of the ISE switch.
Use multiple
command strings to select additional files.
?utl-s-CDE, Unable to restore special attributes for file <file-spec>
Explanation: When RMSRST created the output
file,
the write
attributes QIO failed.
The utility cannot restore the file with
one or more of the following attributes from the original file:
•

One or more of its original data attributes

•

Its original protection specification

•

Contiguity

•

Placement control

•

Areas

User Action:
Use the RMSDSP
utility
attributes of the file were not restored.
C-2

determine

which

~S-ll

UT~LITIES

COMMAND

MESSAGES

?utl-s-COR, Not enough memory available
Explanation:
Not enough memory is available in the image to
This could be
process the files specified in the command string.
caused by one or more of the following:

• Too many keys were specifie4 in the output file.
• Too many keys were specifiej in the input file.
bucket size in either t e input or output
• The
large.

file

was

too

User Action:
Use a smaller bucket size or fewer keys
in the
output file.
If this is not possible, copy the input file to a
sequential file using RMSCNV and use this sequential file as
input to RMSIFL.
?utl-s-CRP, Output volume corrupt -

<file-spec>

Explanation:
The internal structure of an RMS-ll file
is
corrupted, and RMS-ll cannot read or write records in the file.
User Action:
Move the disk pack to another device and try the
command
string again.
If the utility processes the file
normally, there was a read error on the first attempt;
you
should notify your system manager.
However,
if the utility
prints this error message again, you must recreate the indicated
file:
1.

·Use RMSDES to define and create a file, then use RMSIFL
RMSCNV to populate the new file from the corrupted one.

Use the last
utility.

back-up

copy

the

file

with

the

RMSRST

?utl-s-CSE, Syntax error <string>
Explanation:
The format of the command string does not conform
to the syntax rules.
The utility prints the command string from
the point of the error to the end of the line.
Refer to the appropriate utility description in
User Action:
Chapters 4 through 7.
Type the command string with the correct
syntax.
?utl-s-CSW, Conflicting switch specified - <switch>
Explanation:
The indicated switch contradicts a previous switch
within the same command string (scanning from left to right).
User Action:

Type the command string with the correct switch.

C-3

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-DOL, Device off line - <device>
Explanation:
The indicated device is on the system,
is prohibited for one of the following reasons:

but

•

The device is not ready.

•

No volume is mounted on the device.

•

The device requires privileges for use and
those privileges.

•

The device is disabled.

•

The device on which the file is contained is off line.

User Action:

you

access

not

have

Correct the problem and retype the command string.

?utl-s-DWP, Device write protected - <device>
Explanation:
The utility cannot access the
operations for one of the following reasons:

device

for

write

•

The device is characteristically read-only.

•

Read-only access (by file protection code or hardware/software
write locking) is allowed.

•

On a write operation, the error IE.WER or IE.WLK may have been
returned.

User Action:

write-enable the device.

%utl-s-EOE, EOF (Control/Z) established at VBN <vbn>, byte <nn>
Explanation: When using
character
(CTRL/Z)
has
location.
User Action:
?utl-s-ESA,

if the EOF
the RMSCNV /EO switch,
the utility displays its
been found,

None.

Incomplete output file remains -

<file-spec>

Explanation:
An error has occurred which resulted
in
the
suspension of a file backup (RMSBCK) or restore (RMSRST).
This
message appears after the appropriate error message has been
displayed,
and
indicates that although the output file has been
created, the contents are not complete.
User Action:

If possible, correct the problem and try again.

C-4

RMS-ll COMMAND UTILITIES MESSAGES
%utl-s-EXC, Exception record:

--reason code-- <notes>

Explanation: An exception record has been produced by RMSCNV.
This message will appear only if you specified the /ER switch,
and your target output file
is a record unit
(terminal or
printer) device.
One of the following reason codes is listed:

• Record out of sequence
• Duplicate key where not allowed
• Record too short for primary key
• Record too long for bucket size
• Record doesn't fit fixed length
• Record too long for maximum record size
• Record contains an illegal data type
In addition, one of the following notes may also be listed:
•

Truncated display

indicating that the

the

key

was

too

•

Nonprinting - indicating that the key contained
characters, which RMSCNV changed to a"?"

large

nonprinting

User Action:
You may fix the exception records and re-run RMSCNV
to load them.
?utl-s-EXF, Multiple output files not allowed
Explanation:
utility.

Multiple output files

are

not

allowed

User Action:
Break the command line into several
having single output files.

for

this

commands

each

?utl-s-FNA, File <file-spec> not available
Explanation:
Either the file could not be shared
(for RMSDSP),
or write access could not be obtained to process the file.
User Action:
released.

Retry

the

command

string

until

the

file

%utl-s-FPC, Processing complete for file <file-spec>
Explanation:
The utility displayed an informational message
indicating that the backup
(RMSBCK) or restore (RMSRST) for a
file was completed successfully.
User Action:

None.

C-5

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-FPL, File position lost - <file-spec>
in the
Explanation:
An
internal
inconsistency was detected
possible
back-up set,
and processing cannot be continued.
reasons include:
•

On IRC (read
properly.

check),

the

internal

EOF

was

•

A rewritten VBN is out of place within the back-up file.

•

A preamble (internal header)
check
internal structures are in error.

failed,

not

processed

indicating

that

User Action:
Determine from the output account or
summary
listing file
the extent of the processing that was completed
before the error occurred.
Type the command string,
eliminating
specifications of
files successfully processed.
Use a new tape
volume andlor a different tape drive.
?utl-s-FQL, Output file fill quantities will not be preserved
Explanation: When using the RMSCNV ICA (copy attributes)
switch
with multiarea
indexed
files
that are not empty,
the fill
quantities will not be copied to the new output file.
User Action:
To preserve multiareas, use RMSDES to create
Use RMSCNV or RMSIFL to populate the indexed file.

them.

?utl-s-FTL, Fatal RMS error; PC=<nn>, STS=<rmscode>, STV=<status-val>,
file=<file-spec>
Explanation:
An unexpected fatal error return occurred
RMS-ll operation.
The error returns are octal values.

For RMSCNV and RMSDES, this indicates that the
internal error
processor cannot
identify .the error code.
This may indicate a
mismatch between the version of the utility and the RMS-ll access
methods.
User Action:
See the RMS-ll Macro Programmer's
descriptions of the STS and STY codes.

for

Guide

?utl-s-FTO, Illegal file specification - <file-spec>
Explanation:
The file specification does not conform to the
syntax rules or the expanded string cannot fit within the
internal buffer allocated.
User Action:

Type the command string with the correct syntax.

?utl-s-IAC, File <file-spec> is locked
Explanation: ~he specified file was improperly closed
time it was accessed and remains in a locked state.

the

last

User Action:
Use the IUN switch or the lEaF
switch
(if
appropriate)
with PIP to unlock the file (see the RSX-llM/M-PLUS
Utilities Manual).

C-6

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-IAS, Illegal use of /AP, /BL, or /SU with file organization
Explanation:
You combined one of the switches illogically with a
file organization, as follows:
•

/AP or /SU with a nonsequential file

•

/BL with a disk file

User Action:

Type the command string without the switch.

?utl-s-IAX, Illegal use of /KN, /KR, or /LO with file organization
Explanation: The RMSCNV /KN, /KR,
3nd /LO switches require
You specified an output file that is not
output indexed files.
indexed.
User Action:
You cannot use any of the switches
/LO) unless the output file is indexed.

(/KN,

/KR,

%utl-s-ID, Version <nn>
Explanation: This message displays the version number and
level of the utility.
User Action:

patch

None.

?utl-s-IFL, Incorrect file organization for file <file-spec>
Explanation: The RMSCNV /FO switch argument value does not match
the real organization for the output file.
User Action:
Type the
organization.

command

string

with

the

correct

file

?utl-s-IKN, Missing or illegal key name argument
Explanation:
There is an error in the key name argument to the
RMSCNV /KN switch.
You specified either a key that is null, or a
key that contains illegal characters.
User Action: Specify RMSDSP using the /FU
what the key names are.

switch

determine

?utl-s-IKR, Invalid /KN or /KR value
Explanation:
The key specified as the argument to the RMSCNV /KN
or /KR switch is not defined for this input indexed file.
User Action:
Enclose the name in quotation marks if the name
lower case or contains spaces.

?utl-s-IKY, Input key of reference is <nn> <key-name>
Explanation:
The utility displays this message to
key of reference for input indexed files.
User Action:

None.

C-7

identify

the

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-ILF, Error insert too big, code= <rmscode>
Explanation:
This message indicates that either a command line
from an indirect command file is too long, or that the parameters
passed to the error processor exceed the provided buffer space.
The code field contains the octal error code.
User Action:
Notify your system manager who should submit a
Software Performance Report
(SPR)
documenting the conditions
under which the error occurred.
?utl-s-ILS, Illegal switch on input file - <switch>
Explanation:
The indicated switch is
switch for the utility.

not

valid

input

file

User Action:
Type the command string with the correct switch
without the indicated switch.

?utl-s-INP, Multiple input files not allowed
Explanation:
You specified multiple input files
that accepts only a single input file.
User Action:
file.

Type the command string specifying a

for

utility

single

input

%utl-s-IOI, I/O error encountered on input file <file-spec>
VBN <vbn> to <vbn>.
Continue (Yes or No)?
Explanation:
The virtual blocks cannot be read
from the file.
If the file
is input to RMSBCK, the utility cannot back up the
data records within the blocks.
If the file is input to RMSRST,
the utility cannot restore the data within the blocks.
User Action:
despite the
terminate.

Type "Y"
if you want the utility to continue
if you want the utility to
error.
Type "N"

?utl-s-IOO, I/O error encountered on output file Explanation:

One of the following conditions exists:

•

The device is not on line.

•

The device is not mounted.

•

The hardware failed.

•

The volume is full.

User Action:

<file-spec>

Correct the problem and retype the command string.

C-8

RMS-ll COMMAND UTILITIES MESSAGES
?utl--s-IOR, I/O error on command line input
Explanation:

The utility cannot read:

•

The command string you· typed at the terminal

•

A line within an indirect file

User Action:
Retype the command string or recreate the
file and retry the command.

indirect

?utl-s-IOS, Illegal output option - <switch>
Explanation:

The switch is not a valid output file switch.

User Action:
Type the command string with the correct switch
without the indicated switch.
?utl-s-ISP,

Illegal argument value -

<value>

Explanation:
The value specified in the switch is either null,
the incorrect data type, or inappropriate for the specific file.
User Action:
value.
?utl-s-ISS,

Type the command string

with

the

correct

switch

Illegal switch specified - <switch>

Explanation:
recognize.

You specified a switch that the

utility

User Action:

Retype the command string correctly.

does

not

?utl-s-IWC, Illegal use of wildcards on input file
Explanation:
The utility does not permit
(asterisks) in an input file specification.

wildcard

characters

User Action:
Type the command string without wildcard characters
in the input file specification.
?utl-s-IWF,

Illegal use of /WF with record format

Explanation:
You specified the /WF switch in an RMSCNV command
string, but neither the
input nor
the output file contains
variable-with-fixed-control (VFC) records.
User Action:

Type the command string without the /WF switch.

?utl-·s-LSW, Illogical switch in context of command -

Explanation:
Either the switch appears multiple times on the
command line,
or the specified switch does not have any meaning
with the files being processed.
User Action:

Type the command string with appropriate switches.

C-9

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-LUN, TI:

LUN assignment error

Explanation:
An attempt to assign the terminal LUN
line and error text processing has failed.

for

command

User Action:
Notify your system manager who should submit a
Software Performance Report
(SPR)
documenting the conditions
under which the error occurred.
?utl-s-MDE, Command file nesting depth exceeded
Explanation:
An indirect command file contains an
indirect
command.
RMS-ll does not permit nesting of indirect commands.
User Action:
Type the contents of one or both of
command files as a sequence of command strings.
?utl-s-MLE, Block value of
memory

/ML

switch

exceeds

limit

the

indirect

available

Explanation:
The RMSCNV
/ML
(memory
limitations)
switch
specifies a numeric argument which is not in the allowable limit
(0-63 for image copy), or specifies allocation of more memory
than is available to the task image.
User Action:
Reenter the command line specifying a smaller value
for the /ML switch.
?utl-s-MLF, Read error or inconsistent data.

May have lost files.

Explanation:
The utility encountered an error
back-up or container file.

while

reading

User Action:
Retry the command string,
specifying the
/RC
switch.
If the error recurs, determine, from the summary listing
produced when the back-up or container file was created, which
files cannot be completely restored.
If you have other back-up
copies of these files, use them with the command.
?utl-s-MMQ, Mismatched quotes <string>
Explanation:
An odd number of quotation characters is present on
the command line.
Quotation characters must be used in pairs.
User Action:
Determine where
the unpaired quote
is
in the
command line and either ~emove it or place the second quote in
the appropriate place.
Reenter the command line.
?utl-s-MOV, Missing option value - <switch>
Explanation:
switch.

You did not

supply

value

with

the

indicated

User Action:
Type the command string specifying a value for
indicated switch.

C-lO

the

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-MRS,

Input and output record sizes do not correspond

Explanation:
The input and output
record
sizes
do
not
correspond.
Typically,
this
is due to the output file being
fixed format, and the input MRS
(fixed or variable size)
not
matching the output MRS {fixed size).
User Action:
You may need to specify the /PD and/or
/TR
switches.
This will allow RMSCNV to pad short records and/or
truncate long records to conform to the output MRS.
?utl-s-MSF, Output file specification required
Explanation: You did not provide an output file specification on
the command line, when one was expected and required.
User Action:
Supply an output file specification that output
records can be written to.
The device is utility-specific (see
the appropriate chapter) and may be restricted to a certain
category.
?utl-s-NBK, Input file <file-spec> is not container file
Explanation:
The utility requires the input file to be a back-up
file.
You have specified a file that is not in back-up format.
User Action: Type the
specification.

command

string

with

the

correct

file

?utl-s-NDM, Explicit container filename necessary
file
Explanation:
The output file must
be
an
explicit
specification.
No wildcard file name and
type fields are
allowed.
User Action:
Retype the command line providing an explicit
specification.

file

?utl-s-NRN, No rename allowed
Explanation:
During backup
(RMSBCK)
or restore
(RMSRST)
of
disk-based back-up files, the file specifications of the output
files were not wildcarded.
RMSBCK and RMSRST output file name
and type fields must be wildcarded if the medium is disk.
User Action:
Type the command string specifying wildcards
the name and extension components of the output file.
?utl-s-NSD, Not a shareable device -

Explanation:
The command string you typed requires
of a nonshareable device.
User Action:
Type the
specification.

command

C-ll

for

string

with

the

sharing

correct

device

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-OOA, Output file will contain only one area
Explanation:
The file used as input to the RMSCNV /CA switch (or
the
input file
if no argument was specified to the /CA switch)
contained multiple areas.
User Action:
If the output indexed file is to contain multiple
Then, use
areas,
use RMSDES to define' and create the file.
RMSCNV or RMSIFL to populate it.
?utl-s-OPR, Failure to open command file
Explanation: An I/O or file system error, such as a privilege
violation,
an attempted write operation to a locked unit, or a
parity error occurred when the utility attempted to open an
indirect command file.
User Action:

Correct the problem and retry the command string.

?utl-s-OWC, Illegal use of wildcards on output file
Explanation:
The utility does not permit wildcard
(asterisks) in the output file specification.

characters

User Action:
Type the command string without wildcard characters
in the output file specification.
?utl-s-PRV, Privilege violation on file <file-spec>
Explanation:
You do not have the privileges necessary to
the indicated file.

access

User Action:
Ask the owner of the file to change the protection
code, or use the utility from a more privileged account.
?utl-s-RAE, Error reading attributes for file <file-spec>
Explanation:
errors:

This message results from one

sveral

possible

•

An inconsistency in the preamble of a back-up file

•

An error attempting to read the attributes of a back-up file

•

An error reading the preamble of a new
RMSBCK /RC (read check) pass

•

A mismatch between the copied data and the
the RMSBCK /RC (read check) pass

User Action:

back-up

file

the

original

file

Use RMSDSP to determine the file's protection:

•

If you are forbidden access to the file by its protection
code,
request that
its protection be changed or use a more
privileged account.

•

If you are allowed access to the file by its protection
use the VFY utility to check the volume for corruption.

C-12

code,

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-RAM, Required argument missing - <switch>
Explanation:
You did not
switch you specified.

provide

User Action:
Retype the command line
value for the switch.

argument
and

value

provide

for

the

argument

%utl-s-RCE, Read after write error on output file <file-spec>,
VBN <vbn> to <vbn>.
Continue (Yes or No)?
Explanation: During data
integrity
checking,
the
utility
encountered a read error while attempting to read virtual blocks
vbnl through vbn2 of the indicated file.
User Action:
Type "y" if you want the utility to stop processing
the indicated
file, but process the rest of the command string.
Type "N" if you want the utility to stop processing the command
string.
?utl-s-RCR, Release core error
Explanation:
corrupted.

The utility's

internal

dynamic

memory

has

been

User Action:
The utility finished processing the current command
string.
If you want to continue using the utility, you should
terminate it with CTRL/Z (if necessary) and then reinvoke it.
%utl-s-REC, <string>
Explanation: This message is displayed after the EXC message and
when the RMSCNV /ER switch is selected and the exception record
device is unit oriented
(terminal or printer).
The message
displays the contents of the key section of the record that
caused the error.
If the minimum record size (based upon the key
positions and sizes) is larger than 68 characters for terminals
or 120 characters for
line printers,
the EXC message will
indicate that the record fragment was truncated.
If nonprinting
characters are present, the EXC message will also indicate this,
and
the
nonprinting
characters will be replaced by"?"
characters.
User Action:

None.

?utl-s-RET, Read error, integrity check table and rewrite data may
have been lost
Explanation:
The RMSBCK or RMSRST utility was unable to read the
internal rewrite table of the current back-up file.
This can
occur on a RMSBCK verification of the output file,
or a RMSRST
read of the rewrite table.
User Action:
Retry the command string, specifying the
/RC
switch.
If the error recurs, determine, from the summary listing
produced when the back-up or container file was created, which
files cannot be completely restored.
If you have other back-up
copies of these files, use them with the command.

C-13

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-RLG, Error in prologue of file <file-spec>
Explanation:
The utility detected an error in
the relative or indexed file.

the

prologue

This file may be corrupt;
the prologue may contain
User Action:
This implies that the file must be recreated.
invalid data.
?utl-s-RPL, Error reading prologue of file <file-spec>
Explanation:
An error occurred when RMS-ll attempted to read and
verify the prologue of a relative or indexed file.
User Action:
Determine if the hardware is at fault (for example,
if there are read errors).
If the hardware is not at fault, the
prologue may be corrupt and the file may have to be recreated.
?utl-s-RSM, Required file specification(s) missing
Explanation:
You entered a command string with either
or output file specification missing.

input

User Action:
Retype the command
output file specifications.

input

and

string

with

?utl-s-RWC, Error during wildcard lookup <file-spec>.

both

Code=<fipcode>

Explanation:
A wildcarding directive failed.
The code
contains the octal error code returned by the executive.
Determine if
User Action:
errors),
or verify that
command line.

the
the

device
is at
fault
directory is intact.

field

(hardware
Retry the

?utl-s-RWE, Rewind or space error on file <file-spec>
Explanation: While processing a magnetic tape, either an illegal
operation
was
attempted or
the device
returned a device
positioning error.
User Action:
Retry the command string.
If the condition recurs,
mount the volume on another drive and retry the command string.
?utl-s-SLT, Select error -

Explanation:
The magtape specified in the device
field
of
the
file specification is not accessible.
It is probably off line.
User Action:

Correct the problem and retype the command string.

?utl-s-SLW,
Wildcards
specification

not

permitted

summary

listing

file

Explanation:
You used asterisks in a file specification as
the
argument of an /SL switch.
RMS-ll does not permit wildcard
characters in this context.
User Action:
Type the command string without wildcard characters
in the summary listing file specification.

C-14

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-SSO, Illegal use of lEO with organization or record format
Explanation:
You attempted to use the lEO
(end-of-file)
switch
on a file that was not sequential organization with stream record
format.
The file is not acceptable input for lEO processing.
User Action:

None.

%utl-s-TER, Integrity check table full.

Continue (Yes or No)?

Explanation: The table, allocated internally by the utility to
monitor
input read errors, exceeded its capacity. The file or
volume can be assumed to be either corrupt, or produce too many
errors for
the back-up data to be considered intact.
This
suggests hardware faults.
User Action:
Type "Y" to continue processing.
Type "N" to
terminate processing.
Also, check the system error log, or clean
the (tape) device or unit.
?utl-S-TMP, Error processing temporary file.

Code= <fipcode>

Explanation: The wildcard processor called by the
utility
encountered
an error while creating a
temporary file for
resolution of wildcards in a file specification.
The code field
contains the octal error code.
User Action:
Type successive command
result wildcards would produce.
?utl-s-TNF, No EOF (Control/Z)

strings

achieve

the

found in file

Explanation: The RMSCNV utility could not find
the CTRL/Z
character in the sequential stream file specified with the lEO
switch. The data within the file remains unaltered.
User Action:

None.

?utl-s-TOO, Command line too long
Explanation:
The command string you typed
is longer than the
utility's command string buffer (158 characters).
Therefore, you
have typed too many continuation lines.
User Action:
Use several command strings
to
perform
the
functions of the original command string.
If the condition
occurs repeatedly, notify your system manager who should submit a
Software Performance Report (SPR).
?utl-s-TPM, Switch ITR or IPD or both are needed for this CONVERT
Explanation:
The record sizes of the files
RMSCNV are not compatible.

being

processed

User Action:
Refer to Chapter 4 for the use of the ITR and IPD
switches.
Then,
retype the command string using one or both of
the switches.

C-15

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-UER, Uncorrectable error, VBN <vbn> to <vbn>, reason= <reason>
Explanation:
Uncorrectable errors have been detected by the
RMSBCK or
RMSRST utility.
This message indicates the cause of
the problem, and the range of virtual blocks
involved.
The
message is one of the following:
Read check error
Write check error
Input error
Output uncheckable
User Action:
Record the ranges of erroneous
the file and notify your system manager.
?utl-s-UIC, Destination UICs may only be [*,*]
Explanation:
You typed an
invalid account number.

output

file

virtual

blocks

with

[X,Y]

specification

User Action: When specifying wildcarded UICs, both the group and
member fields must be wildcards.
Either both group and member
fields are wildcarded, or neither one can be.
?utl-s-UIF, CNV internal fault
Explanation:
utility.

internal

error

was

detected

the

RMSCNV

User Action:
Notify your system manager who should submit a
Software Performance Report
(SPR)
documenting the conditions
under which the error occurred.
?utl-s-UTL, utility input error
Explanation: An internal initialization
the execution of the indicated utility.

error

occurred

during

User Action:
Retype the command string.
If the
condition
recurs,
notify your system manager who should submit a Software
Performance Report (SPR) documenting the conditions under which
the error occurred.
?utl-s-VFC, Input
correspond

and

output

fixed

control

header

sizes

not

Explanation:
You attempted to write records
from one file
to
another.
Both files contain variable-with-fixed-control (VFC)
records, but the sizes of the fixed areas are different.
This is
not allowed when using the /WF (write fixed headers) switch.
User Action:
string.

Redefine the output file

C-l6

and

retype

the

command

RMS-ll COMMAND UTILITIES MESSAGES
?utl-s-WAE, Error writing attributes of file <file-spec>
Explanation:
The volume is corrupted or you
necessary privileges to write to the file.
User Action:

not

have

the

verify access to file.

?utl-s-WCD, Error with wildcards
Explanation:
The wildcard processor returned an error to the
utility during resolution of wildcards in a file specification.
User Action:
Type the command string again.
If the condition
recurs,
use successive command strings to achieve the result
wildcards would produce.
%utl-s-WCE, Check after write error on output
<vbn> to <vbn>.
Continue (Yes or No)?

file

<file-spec>,

VBN

Explanation:
This diagnostic error message is displayed on your
terminal if query mode is enabled and the /RC switch (check after
writing) is specified.
During data
integrity checking, the
utility found
that the contents of virtual blocks vbnl through
vbn2 in the indicated output file are not
identical to the
associated virtual blocks of the input file.
User Action:
Type "Y" to continue processing despite the error.
Type "N" to terminate processing of the indicated output file and
bypass the processing of any remaining files.
?utl·-s-WET, write error on integrity check table on output file <file-spec>
Explanation:
The utility cannot write internal
checking tables in the output back-up file.
User Action:
If
different tape
output medium is
will not attempt

C.2

data

integrity

the output medium is magnetic tape,
use a
volume and
retry the command string.
If the
disk, rename the output file so that the utility
to use the space, and retry the command string.

RMSIFL ERROR MESSAGES

This section lists all RMSIFL error messages.
An explanation and
appropriate user action is indicated for each message.

the

?IFL -- Block I/O read error on <file-spec>
Explanation:
output file.

RMSIFL could not read the

index

bucket

from

the

User Action:
Retype the command string.
If the error recurs,
check with your system manager to see if there have been other
errors reported for that device.
If not, move the file
to a
different disk or specify a different device for the file and
retry the operation.

C-17

RMS-ll COMMAND UTILITIES MESSAGES
?IFL -- Block I/O write error on file <file-spec>
Explanation:

RMSIFL could not write a block to the output file.

User Action:
Retype the command string.
If the error recurs,
check with your system manager to see if there have been other
errors reported for that device.
If not, move the file to a
different disk or specify a different device for the file and
retry the operation.
?IFL -- Close error on <file-spec>
Explanation:
The specified input or output
properly closed.

file

could

not

User Action:
Retype the command string.
If the error recurs,
run a validity check of the file structure using the VFY utility
on the volume to determine whether it is corrupted.
?IFL -- Command file nesting depth exceeded
Explanation:
An indirect command
file contains an
indirect
command.
RMS-II does not permit nesting of indirect commands.
User Action:
Type the contents of one or both of
command files as a sequence of command strings.

the

indirect

?IFL -- Create error on <file-spec>
Explanation:
The specified file could not be created by RMSIFL.
This condition can occur for one of the following reasons:
•

The /ER switch was specified on the command
could not open the Exception Record file.

line

and

RMSIFL

•

RMSIFL could not create the alternate key temporary file.

•

RMSIFL could not create the temporary file into which to write
the sorted records from SORT.

User Action:
•

Check the file specification that you supplied with the
switch to be sure that it is a legal file specification.

/ER

•

Check the available space on the disk and make sure that there
is enough space to create the files.
Refer to Chapter 3 for
file size calculations.

•

If the error occurred on a work file used in
RMSIFL sorting,
retype the command
line specifying the /DE switch to assign
the temporary work files to another device.

?IFL -- Error terminated input before expected, but continuing
Explanation:
RMSIFL encountered a read error in the input file.
RMSIFL will finish processing with as many records as it was able
to read from the input file.
User Action:
The input file cannot be read.
using the last back-up version of the file.

C-IB

Retry the operation

RMS-ll COMMAND UTILITIES MESSAGES
?IFL -- Error with logical unit device
Explanation:

RMSIFL assigned a logical channel erroneously.

User Action:
Invoke RMSIFL again and retype the command line.
If this message recurs,
submit a Software Performance Report
(S PR) •
?IFL -- Extend error on output file <file-spec>
Explanation:
The output file you provided was not large enough
to contain the
input records, or a temporary file could not be
extended.
RMSIFL explicitly extended the file, but the operation
failed.
User Action:
Determine why the file could not be extended
(such
3S, disk full).
Allocate a larger output file or use a different
output disk, and type the command string again.
?IFL -- Failure to open command file
Explanation: An I/O or file system error, such as a privilege
violation,
an attempted write operation to a locked unit, or a
parity error occurred when RMSIFL attempted to open an
indirect
command file.
User Action:

Correct the problem and retry the command string.

?IFL -- Fatal RMS error - STS

= <rmscode>, STV = <rmscode>

Explanation: A fatal error occurred in the RMSIFL interface with
RMS-Il file and record handling routines.
User Action:
See the RMS-ll Macro Programmer's
descriptions of the STS and STV codes.

Guide

for

?IFL -- File access error on <file-spec>
Explanation:

The specified file could not be accessed.

User Action: Check to be sure that the file specifications that
you supplied are legal file specifications and that the input and
output files exist.
?IFL -- Illegal device <device>
Explanation:

The device does not exist.

User Action: Type the
specification.

command

C-l9

string

with

correct

device

RMS-ll COMMAND UTILITIES MESSAGES
?IFL -- Input and output fixed length record sizes unequal
Explanation:
The input and output files both have fixed-length
records,
but the sizes are different.
One of the following
conditions exists:

•

The output file's maximum record size is less than
the
input
file's maximum record size,
and the /TR switch was not
specified on the command line.

•

The output file's maximum record size is greater than the
input
file's maximum record size, and the /PD switch was not
specified on the command line.

User Action:
You must specify either the /PD or
the command string.

/TR

switch

?IFL -- Input file is not sequential, relative, or indexed
Explanation:
RMSIFL requires an
input
relative, or indexed file organization.
User Action:

file

sequential,

Retype the command string specifying a valid file.

?IFL -- Input file switch specified with output file switch
Explanation:
The switch you specified on the output side of
command line is only valid as an input file switch.
User Action:

the

Retype the command string correctly.

?IFL -- Invalid /KR value
Explanation:
You specified a key of reference
equal to the number of keys in the input file.

greater

than

User Action:
Retype the command line specifying a valid
reference number.

key

?IFL -- I/O error on command line input
Explanation:

RMSIFL cannot read:

•

The command string you typed at the terminal

•

A line within an indirect file

User Action:
Retype the command string or recreate the
file and retry the command.

indirect

?IFL -- /KR not allowed for sequential or relative file
Explanation:
The /KR switch is permitted for indexed files only.
You either specified the wrong file or used the /KR switch in the
wrong context.
User Action:
Type the command string with
specification or without the /KR switch.

C-20

the

correct

file

RMS-ll COMMAND UTILITIES MESSAGES
?IFL -- Memory exhausted
Explanation:
Not enough memory is available in the
process the files specified in the command string.
User Action: Consult your system manager
increasing the available memory for RMSIFL.

for

image

details

?IFL -- Missing file specification
Explanation:
You entered a command string with either
or output file specification missing.

input

User Action:
Retype the command
output file specifications.

input

and

?IFL -- Output file fixed

reco~d

string

with

both

size too large for bucket size

Explanation:
You specified a fixed-record size
output file that is larger than the bucket size.
User Action: Create a new output file
bucket size or a smaller record size.

with

either

indexed
a

larger

?IFL -- Output file must be empty
Explanation:

The output file you specified contains data.

User Action:

Recreate the output file.

?IFL -- Output file must be an indexed file
Explanation:
output file.

You specified a sequential or relative file

User Action:

Specify or create another indexed output file.

?IFL -- Output file switch specified with input file switch
Explanation:
The switch you specified on the input side
command line is only valid as an output file switch.
User Action:

the

Retype the command string correctly.

?IFL -- Prologue version number too high
Explanation:
RMSIFL opened an RMS-ll indexed file and checked
the version number of the file's prologue.
That number indicates
that the file was created with attributes that RMS-ll cannot
handle.
User Action:
Recreate the file using a newer version of RMSIFL
or RMSCNV or write an application program using the latest RMS-ll
software.

C-2l

RMS-ll COMMAND UTILITIES MESSAGES
?IFL -- Read error on filespec
Explanation:

RMSIFL could not read the sorted records.

User Action:
Retry the command string.
If the error occurred on
an
input
file
and
the error persists, check with your system
manager to see if there have been other errors reported for
that
disk.
If
there have not been any errors, then move the disk to
another device and retry the command string.
If RMSIFL processes
the
file
normally,
a
read error
occurred
in
the first two
attempts.
However, if the error occurs again, you must
recreate
the indicated file as follows:
1.

Use RMSDES to define and create a file, then
use
RMSIFL
RMSCNV to populate the new file from the corrupted one.

Use the last
utility.

back-up

copy

the

file

with

the

RMSRST

If the error occurred on a work file used in RMSIFL sorting,
the IDE switch to assign the work file to another device.

use

?IFL -- Read error on file prologue <file-spec>
Explanation:
RMSIFL cannot read the prologue of
the
indicated
file.
RMSIFL bypasses the file and continues processing.
User Action:
Type the command
string specifying
only
the
indicated
file.
If
the error
recurs, move the disk pack to
another device and try the command string again.
If
RMSIFL
processes
the
file normally, a read error occurred on the first
two attempts.
However,
if
RMSIFL prints
this error message
again, you must recreate the indicated file as follows:
1.

Use RMSDES to define and create a file, then use
RMSIFL
RMSCNV to populate the new file from the corrupted one.

Use the last
utility.

back-up

copy

with

the

RMSRST

Explanation:
The sort routines in RMSIFL encountered
nn is a sort error code.

error;

?IFL -- SORTS error code in octal:

the

file

<nn>

User Action:
Refer to Appendix D for
a description of
the
Correct the problem and retype the command
indicated error code.
string.
?IFL -- Syntax error
Explanation:
The format of the command string does
to the syntax rules.

not

conform

User Action:
Refer to
the appropriate RMSIFL description
Chapter 3.
Type the command string with the correct syntax.

C-22

RMS-ll COMMAND UTILITIES MESSAGES
?IFL -- /TR and/or /PD required with fixed length output records
Explanation:
The record size for the input file
is different
from the record size for
the output file and may require
truncating (/TR) and/or padding (/PD).
User Action:
/TR.

Retype the command

string

specifying

/PD

and/or

?IFL -- Undefined GCML error
Explanation:
An unknown error occurred during the processing
the command line.
User Action:
Retype the command line.
If
submit a Software Performance Report (SPR).

the

error

recurs,

indirect

If the error occurred while RMSIFL was processing
command file, try the commands interactively.
?IFL -- Unknown switch <switch>
Explanation:
recognize.

You

specified

switch

that

RMSIFL

User Action:

Retype the command string correctly.

does

not

?IFL -- Write error on filespec
Explanation:
file.

RMSIFL could not write the sorted

records

the

User Action:
Retype the command string.
If the error persists,
use the /DE switch and assign the file to a different device.

C-23

APPENDIX D
SORT ROUTINE ERROR CODES

When the sort routines used by RMSIFL detect an error, they return one
of the nonzero, octal codes listed below.
Error
Code (Octal)

Meaning

No errors

Device input error

Device output error

OPEN (IN)

failure

OPEN (OUT)

failure

Size of current record
size

Not enough work area

Key size is not positive
(the sort routines
detected a
zero or negative key size in the
calling parameter)

Record size not positive

Key address is not even (the keys must start at an
even address because the sort routines use word
moves)

Record address is not even

Scratch records will be too large (the size of the
keys plus the size of the largest record must be
less then 37776 octal)

Too few scratch files are given (a
scratch files must be specified)

Too many scratch files are given (a maximum of
scratch files may be specified)

End-of-string record was detected where
expected

Unexpected end-of-file

Record larger than expected

D-1

greater

than

maximum

minimum

none

was

INDEX

I[NO]CV switch
RMSRST utility,
I[NO]QU switch
RMSBCK utility,
6-10
RMSRST utility,
7-12
lAP switch
RMSCNV utility,
4-13, 4-15
IBD switch
RMSRST utility,
IBL switch
RMSCNV utility,
IBP switch
RMSDSP utility,
ICA switch
RMSCNV utility,
ICD switch
RMSBCK utility,
IDE switch
RMSIFL utility,
3-14
lEO switch
RMSCNV utility,
IER switch
RMSIFL utility,
IFO switch
RMSCNV utility,
IFR switch
RMSRST utility,
IFU switch
RMSDSP utility,
lID switch
RMSBCK utility,
RMSCNV utility,
RMSDEF utility,
RMSDSP utility,
RMSIFL utility,
RMSRST utility,
11M switch
RMSCNV utility,
IKN switch
RMSCNV utility,
IKR switch
RMSCNV utility,
RMSIFL utility,
ILO switch
RMSCNV utility,
RMSIFL utility,
IMJ!!. swi tch
RMSCNV utility,
IML switch
RMSCNV utility,
INCIER switch
RMSIFL utility,
INCISO switch
RMSIFL utility,
lOA switch

7-5, 7-10
6-5 to 6-7,
7-6 to 7-8,
4-5, 4-7,
7-8, 7-10
4-8
5-3 to 5-4
4-8
6-8 to 6-9
3-7, 3-10,
4-8
3-5 to 3-6
4-9, 4-15
7-7

RMSRST utility,
IPD switch
RMSCNV utility,
RMSIFL utility,
3-11
IRA switch
RMSBCK utility,
6-9
RMSRST utility,
IRC swi tch
RMSBCK utility,
RMSRST utility,
IRD switch
RMSBCK utility,
IRW switch
RMSBCK utility,
ISE switch
RMSRST utility,
ISL switch
RMSBCK utility,
RMSCNV utility,
RMSRST utility,
ISU switch
RMSBCK utility,
RMSCNV utility,
4-13, 4-15
RMSRST utility,
I'l'R switch
RMSCNV utility,
RMSIFL utility,
IWF switch
RMSCNV utility,

7-9 to 7-10
4-12
3-6 to 3-7,
6-6 to 6-7,
7-7, 7-11
6-7, 6-9
7-8, 7-11
6-8 to 6-9
6-7
7-3, 7-9
6-6, 6-10
4-12
7-6, 7-12
6-7
4-5, 4-7,
7-8
4-13
3-7, 3-11
4-14

5-2, 5-4
6-4 to 6-5
4-5, 4-9
A-5
5-3, 5-5
3-3, 3-5
7-3, 7-5
4-9
4-10, 4-16
4-10, 4-16
3-8 to 3-9
4-10
3-6
4-10
4-11
3-6
3-8 to 3-10

Alignment
RMSDEF utility, A-14
ALLOCATION
RMSDES utility
area section, 2-44
file section, 2-31
Allocation
RMSDEF utility
data, A-16
file, A-14
RMSDES utility
areas, 2-10, 2-25
RMSDSP
displaying, 5-4
Alternate index (RMSIFL),
3-11 to 3-12
Alternate key
RMSDEF utility
defining, A-ll
RMSIFL utility
allocating file space, 3-13
sorting, 3-11
Alternate key files (RMSIFL)
device allocation, 3-7
ANSI-standard tape
RMSBCK utility, 6-1, 6-8

Index-l

INDEX
RMSDSP utility, 5-3
Area information, displaying,
5-4
Area numbers (RMSDEF), A-16
Areas
RMSDEF utility
defining, A-13
RMSDES utility, 2-10, 2-25
defining, 2-1, 2-42
and BUCKET SIZE attribute,
2-32
and DATA AREA attribute,
2-40 and INDEX AREA attribute,
2-41
and LEVELl INDEX AREA
attribute, 2-41
and SIZE attribute, 2-36
by default, 2-43
explicitly, 2-43
defining by default, 2-17,
2-38
CREATE command, 2-8, 2-28
SET ALL command, 2-14
defining explicitly, 2-17
numbering, 2-8, 2-28, 2-43
ASCII stream files
RMSCNV utility, 4-3, 4-8
RMSIFL utility, 3-1
Attributes
RMSDES utility, 2-29
ALLOCATION
area section, 2-44
file section, 2-31
BLOCK SPAN, 2-37
BUCKET SIZE
area-section, 2-43, 2-45
file section, 2-32
CARRIAGE CONTROL, 2-37
CHANGES,-2-40
CLUSTER SIZE, 2-31
CONTIGUOUS
area section, 2-46
file section, 2-35
CONTROL FIELD SIZE, 2-37
DATA AREA, 2-40
DATA-FILL, 2-40
DUPLICATES, 2-40, 2-42, 2-44
EXACT POSIT1DNING, 2-47
EXTENSION
area section, 2-45
file section, 2-32
FILE PLACEMENT
system section, 2-30
FORMAT, 2-36
INDEX AREA, 2-41
INDEX-FILL, 2-41
informational, 2-29
LEVELl INDEX AREA, 2-41
MAGTAPE BLOCK SIZE, 2-34
MAX RECORD NUMBER, 2-34
NAME
file section, 2-31

key section, 2-38
NULL KEY, 2-39
NULL-VALUE, 2-39
ORGANIZATION, 2-31
OWNER, 2-34
POSITION, 2-46
PROTECTION, 2-33
REWIND MAGTAPE, 2-34
RMS-ll~ 2-29
SEGO POSITION, 2-42
SEGn-LENGTH, 2-42
SEGn-POSITION, 2-42
SIZE~ 2-36
SOURCE, 2- 3 0
SUPERSEDE, 2-35
TARGET, 2-30
TYPE, 2-38
RMSDSP, 5-1
Attributes (RMSDES)
clearing, 2-6, 2-22, 2-25
individual values, 2-26
sections, 2-26
displaying, 2-15, 2-26
individual values, 2-26
sections, 2-27
informational, 2-1, 2-17
resetting, 2-21
RMS-ll, 2-1, 2-17
setting, 2-13
from a data file, 2-25
from a description file,
2-24
individual values, 2-21
setting sections, 2-21
Back-up date, file
RMSRST utility, 7-8, 7-10
Block boundaries
RMSDEF utility, A-9
Block mode
RMSCNV utility, 4-1
BLOCK SPAN
RMSDES utility, 2-37
Bucket size
RMSDEF utility, A-15
BUCKET SIZE
RMSDES utility
area section, 2-43, 2-45
file section, 2-32
Buckets
RMSCNV utility, 4-10
Calculating file work space
(RMSIFL), 3-12
Carriage control
RMSDEF utility, A-9
CARRIAGE CONTROL
RMSDES-utility, 2-37
CHANGES
RMSDES utility, ~-40
CLEAR command
RMSDES utility, 2-~, 2-18,
2-25 to 2-26

Index-2

INDEX
defining areas by default,
2-44
in indirect command file,
2-4
PROTECTION attribute, 2-33
with CREATE, 2-8, 2-28
with SAVE, 2-27
Clearing attributes (RMSDES)
See Attributes, clearing
CLUSTER SIZE
RMSDE§ utility, 2-31
Command file
RMSDEF utility, A-5
Command string
RMSBCK utility, 6-2 to 6-3
RMSCNV utility, 4-3 to 4-4
RMSDEF utility, A-5
RMSDSP utility, 5-2 to 5-3
RMSIFL utility, 3-2 to 3-3
RMSRST utility, 7-2 to 7-3
Command string checking (RMSIFL),
3-9
Command utility
messages, C-l
Commands
RMSDES utility, 2-1, 2-4
See also individual command
entries
See also RMSDES
Compression
RMSIFL utility, 3-11
Container file
RMSBCK utility, 6-1, 6-3, 6-7
RMSDSP
detailed display, 5-4
RMSDSP utility, 5-1,
5-3 to 5-4
RMSRST utility, 7-3,
7-9 to 7-10
Contiguity
RMSCNV utility, 4-2
RMSDEF utility, A-15
RMSIFL utility, 3-1, 3-6
CONTIGUOUS
RMSDES utility
area section, 2-46
file section, 2-35
CONTROL FIELD SIZE
RMSDE§ utilTty, 2-37
CRI~ATE command
RMSDES utility, 2-7, 2-18,
2-28, 2-31
defining areas by default,
2-44
defining areas explicitly,
2-43
INDEX AREA attribute, 2-41
key numbering, 2-38
LEVELl INDEX AREA
attrTbute,-2-41
setting attributes, 2-21
with GET, 2-10, 2-25
Creating files

RMSDEF utility, A-19
See also Data file (RMSDES)
Creation date, file
RMSBCK utility, 6-8
CTRL/Z
RMSBCK utility, 6-2
RMSCNV utility, 4-4
file terminator, 4-8
RMSDES utility, 2-2, 2-9, 2-18
RMSDSP utility, 5-2
RMSIFL utility, 3-2
RMSRST utility, 7-2
Data file
RMSDES utility, 2-3, 2-17,
2-24
creating, 2-3, 2-7, 2-28
GET command, 2-10
Data integrity checking
RMSBCK utility, 6-6 to 6-7,
6-9
RMSRST utility, 7-11
data integrity checking
RMSRST utility, 7-6, 7-8
DATA AREA
RM§DES utility, 2-40
DATA FILL
RM§DES utility, 2-40
Default extension quantity
RMSDEF utility, A-15
Defaults
RMSDES utility, 2-21
Description file
RMSDES utility, 2-3, 2-13,
2-17, 2-24
EXIT command, 2-10
GET command, 2-10
SAVE command, 2-27
Design buffer
RMSDES utility, 2-1
Design buffer (RMSDES)
using, 2-16
Design buffer sections (RMSDES)
See Sections
Design session
RMSDES utility, 2-1
resuming, 2-22
Display information (RMSDSP),
5-1
Displaying allocation information
RMSDSP utility, 5-4
Displaying area information
RMSDSP utility, 5-4
Displaying attributes (RMSDES)
See Attributes
Displaying indexed file attributes
RMSDSP utility, 5-4
Displaying key information
RMSDSP utility, 5-4
Displays (RMSDSP), 5-5
DUPLICATES
RMSDES utility, 2-40, 2-42
area section, 2-44

Index-3

INDEX
Error codes (RMSIFL)
sort routine, D-l
ESC command
RMSDES utility, 2-9, 2-21
EXACT POSITIONING
RMSDES utility, 2-47
Examples
RMSBCK utility, 6-10
RMSCNV utility, 4-16
RMSDES utility, 2-47
RMSIFL utility, 3-14
RMSRST utility, 7-12
Exception codes
RMSIFL utility, 3-6
Exception records
RMSIFL utility, 3-5 to 3-6,
3-10
EXIT command
RMSDES utility, 2-3, 2-9,
2-18, 2-27
EXTENSION
RMSDES utility
area section, 2-45
file section, 2-32
External files (RMSDES)
See Data file, Description file
File attributes (RMSDES)
See Attributes
File attributes (RMSDSP)
indexed file
detailed display, 5-4
File back-up date
See Back-up date
File contiguity
St~e Contiguity
Filt~ creation (RMSDEF), A-19
File creation date
See Creation date
File organization
RMSDEF utility, A-8
FILE PLACEMENT
RMSDES utility, 2-~0
File revision date
See Revision date
File space (RMSIFL)
calculating, 3-12
File specification
RMSBCK utility, 6-9
RMSDEF utility, A-7
RMSRST utility, 7-10
See also Infile, Outfile
Fill numbers
RMSCNV utility, 4-10
RMSDEF utility, A-16
RMSIFL utility, 3-6
Fixed control area
RMSDEF utility, A-8
FORMAT
RMSDES utility, 2-36
GET command
RMSDES utility, 2-10, 2-17,

2-24
PROTECTION attribute, 2-33
with SAVE, 2-28
Global switches
RMSBCK utility, 6-5
RMSIFL utility, 3-5
RMSRST utility, 7-5
HELP
RMSBCK
RMSCNV
RMSDEF
RMSDES
RMSDSP
RMSIFL
RMSRST

utility,
utility,
utility,
utility,
utility,
utility,
utility,

6-4
4-5
A-5
2-2, 2-11
5-3
3-3
7-3

IFLA.TMP (RMSIFL) , 3-11
allocating space, 3-13
IFLAl.TMP (RMSIFL) , 3-12
allocating space, 3-14
IFLP.TMP (RMSIFL) , 3-10
allocating space, 3-13
INDEX AREA
RMSDES utility, 2-41
INDEX FILL
RMSDES utility, 2-41
Indirect command file
RMSBCK utility, 6-2
RMSCNV utility, 4-4
RMSDES utility, 2-3
comments, 2-4
RMSDSP utility, 5-2
RMSIFL utility, 3-2
RMSRST utility, 7-2
Infile
RMSBCK utility, 6-3
RMSCNV utility, 4-5
RMSDSP utility, 5-3
RMSIFL utility, 3-3
RMSRST utility, 7-3
Input file switches
RMSBCK utility, 6-8
RMSIFL utility, 3-7
RMSRST utility, 7-8
Interactive utility
RMSDES utility, 2-1
Intersystem file transfer, 1-2,
6-1
RMSCNV utility, 4-1
RMSRST
/FR swi tch, 7-7
RMSRST utility, 7-1, 7-10
file-version number
conversion, 7-5
Invoking
RMSBCK utility, 6-2
RMSCNV utility, 4-3
RMSDEF utility, A-5
RMSDES utility, 2-2
RMSDSP utility, 5-2
RMSIFL utility, 3-2
RMSRST utility, 7-2

Index-4

INDEX
Key information
displaying, 5-4
Key name
RMSCNV utility, 4-10
Key of reference
RMSCNV utility, 4-10, 4-16
RMSIFL utility, 3-8 to 3-9
Keys
RMSDES utility
numbering, 2-28, 2-38
Keys (RMSDES)
number i ng, 2-8
LEVELl INDEX AREA
RMSDES utility, 2-41
Location
RMSDEF utility, A-14
Magnetic tape
RMSBCK utility, 6-7
multivolume, 6-9
RMSCNV utility, 4-8
RMSDEF utility, A-8, A-10
RMSDES utility, 2-34
RMSRST utility, 7-8 to 7-9
MAGTAPE BLOCK SIZE
RMSDES utilTty, 2-34
mass-insertion mode
RMSCNV utility, 4-10
Maximum record number
RMSDEF utility, A-9
Maximum record size
RMSDEF utility, A-9
Messages
command utilities, C-l
RMSDEF utility, A-20
RMSDES utility, 2-52
Mounting tapes (RMSDSP), 5-3
Multiple areas
RMSDES utility, 2-7, 2-43
Multiple keys
RMSDES utility, 2-7, 2-38
NAME
RMSDES utility
file section, 2-31
key section, 2-38
Network facilities
RMSCNV, 4-1
NULL KEY
RMSDES utility, 2-39
NULL VALUE
RMSDES utility, 2-39
ORGANIZATION
RMSDES utility, 2-31
Outfile
RMSBCK utility, 6-3
RMSCNV utility, 4-4
RMSDSP utility, 5-3
RMSIFL utility, 3-3
RMSRST utility, 7-3
Output file switches

RMSBCK
RMSIFL
RMSRST
OWNER
RMSDES

utility, 6-6
utility, 3-5
utility, 7-7
utility, 2-34

Padding characters
RMSCNV utility, 4-12
RMSIFL utility, 3-6
Patch level
RMSBCK utility, 6-5
RMSCNV utility, 4-9
RMSDEF utility, A-5
RMSDSP utility, 5-5
RMSIFL utility, 3-5
RMSRST utility, 7-5
Peripheral Interchange
Program (PIP), 5-2
PIP/ENTER command (RMSBCK), 6-3
Placement
RMSBCK utility, 6-1
RMSDEF utility, A-14
RMSRST utility, 7-1
POSITION
RMSDES utility, 2-46
Primary index
RMSCNV utility, 4-1
RMSIFL utility, 3-10 to 3-11
Primary key
RMSCNV utility, 4-1, 4-16
RMSDEF utility
definition, A-10
RMSIFL utility, 3-5 to 3-6
sorting, 3-9
Processing
RMSBCK utility, 6-8
data integrity checking, 6-9
explicit/implicit file-spec,
6-9
extended diagnostic messages,
6-10
summary listing, 6-10
RMSCNV utility, 4-14
input file organization,
4-16
output file organization,
4-15
RMSDEF utility, A-1
RMSIFL utility, 3-9
building alternate indexes,
3-12
command string checking, 3-9
loading output file, 3-10
reading and sorting input,
3-9
sorting alternate key files,
3-11
summary, 3-1
terminating, 3-12
RMSRST utility, 7-9
data integrity checking,
7-11
explicit/implicit

Index-5

INDEX
file-spec, 7-10
extended diagnostic
messages, 7-11
restoration account, 7-10
summary listing, 7-12
Prompt
RMSBCK utility, 6-2
RMSCNV utility, 4-3
RMSDES utility, 2-2
RMSDSP utility, 5-2
RMSIFL utility, 3-2
RMSRST utility, 7-2
Prompting
RMSDES utility
conditional, 2-1, 2-13,
2-15, 2-17, 2-29
PROTECTION
RMSDES utility, 2-33
Protection
RMSDEF utility, A-18
RMSRST utility, 7-7
Query mode
RMSBCK utility, 6-5 to 6-7,
6-10
RMSRST utility, 7-6 to 7-8,
7-11
QUIT command
RMSDES utility, 2-2, 2-12,
2-18
Record format
RMSDEF utility, A-8
Record formats
RMSCNV utility, 4-14
Revision date, file
RMSBCK utility, 6-8
REWIND MAGTAPE
RMSDES utility, 2-34
RMSBCK, 5-1
RMSBCK (RMS-ll File Back-Up
Utility), 1-1, 3-3, 4-5, 6-1,
7-1, 7-5, 7-9 to 7-10
/[NO]QU switch, 6-5 to 6-7,
6-10
/CD switch, 6-8 to 6-9
/ID switch, 6-4 to 6-5
/RA switch, 6-6 to 6-7, 6-9
/RC switch, 6-7, 6-9
/RD switch, 6-8 to 6-9
/RW swi tch, 6-7
/SL switch, 6-6, 6-10
/SU switch, 6-7
back-up file contents, 6-1
back-up medium, 6-3
command string, 6-2 to 6-3
container file, 6-1
data integrity checking,
6-6 to 6-7, 6-9
examples, 6-10
global switches, 6-5
HELP, 6-4
indirect command file, 6-2

input file switches, 6-8
intersystem file transfer,
1-2
invoking, 6-2
magnetic tape, 6-7
multivolume, 6-9
messages, C-l
output file switches, 6-6
processing, 6-8
data integrity checking,
6-9
explicit/implicit file-spec,
6-9
extended diagnostic messages,
6-10
summary listing, 6-10
prompt, 6-2
Query mode, 6-6
query mode, 6-5 to 6-7, 6-10
summary listing, 6-10
terminating, 6-2
RMSCNV (RMS-ll File Conversion
Utility), 1-1, 3-1, 4-1
/AP switch, 4-5, 4-7, 4-13,
4-15
/BL switch, 4-8
/CA swi tch, 4-8
/EO switch, 4-8
/FO switch, 4-9, 4-15
/ID switch, 4-5, 4-9
/IM switch, 4-9
/KN switch, 4-10, 4-16
/KR switch, 4-10, 4-16
/LO switch, 4-10
/MA switch, 4-10
/ML switch, 4-11
/PD switch, 4-12
/SL switch, 4-12
/SU switch, 4-5, 4-7, 4-13,
4-15
/TR switch, 4-13
/WF switch, 4-14
ASCII stream files, 4-3, 4-8
block mode, 4-1
command string, 4-3 to 4-4
CTRL/Z
file terminator, 4-8
examples, 4-16
HELP, 4-5
indirect command file, 4-4
intersystem file transfer,
1-2, 4-1
invoking, 4-3
key name, 4-10
key of reference, 4-10
mass-insertion mode, 4-10
messages, C-l
network facilities, 4-1
processing, 4-14
input file organization,
4-16
output file organization,
4-15

Index-6

INDEX
prompt, 4-3
summary listing, 4-12
supersession, 4-13
terminating, 4-4
RMSDEF (RMS-ll File Definition
Utility), 1-1, A-l
/ID switch, A-5
alignment, A-14
allocation
data, A-16
file, A-14
alternate key, definition,
A-ll
area definition, A-13
area numbers, A-16
block boundaries, A-9
bucket size, A-15
carriage control, A-9
command file, A-5
command string, A-5
contiguity, A-15
default extension quantity,
A-15
file creation, A-19
file organization, A-8
file specification, A-7
fill numbers, A-16
fixed control area, A-8
HELP, A-5
invoking, A-5
location, A-14
magnetic tape, A-8, A-10
maximum record number, A-9
maximum record size, A-9
messages, A-20
placement control, A-14
primary key, definition,
A-10
processing, A-l
protection, A-18
record format, A-8
terminating, A-5
RMSDES (RMS-ll File Design
Utility), 1-1, 2-1, 4-2, 5-1
allocation
areas, 2-10, 2-25
areas
defining, 2-1, 2-42, B-1
and BUCKET SIZE attribute,
2-32
and DATA AREA attribute,
2-40 and INDEX AREA attribute,
2-41
and LEVELl INDEX AREA
attribute, 2-41
and SIZE attribute, 2-36
by default, 2-43
explicitly, 2-43
defining by default,
2-17, 2-38
CREATE command, 2-8
SET ALL command, 2-14

Index-7

defining explicitly, 2-17
numbering, 2-8, 2-28, 2-43
attributes, 2-29
ALLOCATION (area section),
2-44
ALLOCATION (file section),
2-31
BLOCK SPAN, 2-37
BUCKET SIZE (area section),
2-43~ 2-45
BUCKET SIZE (file section),
2-32CARRIAGE CONTROL, 2-37
CHANGES,-2-40
clearing, 2-22, 2-25
clearing individual values,
2-26
clearing sections, 2-26
CLUSTER SIZE, 2-31
CONTIGUOUS (area section),
2-46
CONTIGUOUS (file section),
2-35
CONTROL FIELD SIZE, 2-37
DATA AREA, 2-40
DATA-FILL, 2-40
displaying, 2-15, 2-26
displaying individual values,
2-26
displaying sections, 2-27
DUPLICATES, 2-40, 2-42,
2-44
EXACT POSITIONING, 2-47
EXTENSION (area section),
2-45
EXTENSION (file section),
2-32
FILE PLACEMENT, 2-30
FORMAT, 2-36
INDEX AREA, 2-41
INDEX-FILL, 2-41
informational, 2-1, 2-17,
2-29
LEVELl INDEX AREA, 2-41
MAGTAPE BLOCK SIZE, 2-34
MAX RECORD NUMBER, 2-34
NAME (file-section), 2-31
NAME (key section), 2-38
NULL KEY, 2-39
NULL-VALUE, 2-39
ORGANIZATION, 2-31
OWNER, 2-34
POSITION, 2-46
PROTECTION, 2-33
resetting, 2-21
REWIND MAGTAPE, 2-34
RMS-ll~ 2-1, 2-17, 2-29
SEGO POSITION, 2-42
SEGn-LENGTH, 2-42
SEGn-POSITION, 2-42
settTng, 2-13
setting from data file,
2-25

INDEX
setting from description
file, 2-24
setting individual values,
2-21
setting sections, 2-21
SIZE, 2-36
SOURCE, 2-30
SUPERSEDE, 2-35
TARGET, 2-30
TYPE, 2-38
CLEAR command, 2-6, 2-18,
2-25 to 2-26
defining areas by default,
2-44
in indirect command file,
2-4
PROTECTION attribute, 2-33
with CREATE, 2-8, 2-28
with SAVE, 2-27
clearing attributes, 2-6
commands, 2-4
CREATE command, 2-7, 2-18,
2-28, 2-31
defining areas by default,
2-44
defining areas explicitly,
2-43
INDEX AREA attribute, 2-41
key numbering, 2-38
LEVE~1 INDEX AREA
attrIbute, 2-41
setting attributes, 2-21
with GET, 2-10, 2-25
creating data files, 2-28
CTRLIZ command, 2-2, 2-9,
2-18
data file, 2-3, 2-17, 2-24
creating, 2-3, 2-7, 2-28
GET command, 2-10
defaults, 2-21
defining areas by default
CREATE command, 2-28
description file, 2-3,
2-17, 2-24
EXIT command, 2-10
GET command, 2-10
SAVE command, 2-27
saving the design, 2-13
design buffer, 2-1
using, 2-16
design session, 2-1
res urn i n g, 2 - 2 2
ESC command, 2-9, 2-21
examples, 2-47
EXIT command, 2-3, 2-9,
2-18, 2-27
GET command, 2-10, 2-17,
2-24
PROTECTION attribute, 2-33
with SAVE, 2-28
HELP command, 2-11
indirect command file, 2-3
comments, 2-4

invoking, 2-2
keys
numbering, 2-8, 2-28, 2-38
magnetic tape, 2-34
messages, 2-52
multiple areas, 2-7, 2-43
multiple keys, 2-7, 2-38
prompt, 2-2
conditional,
2-14 to 2-15, 2-21
prompting
conditional, 2-1, 2-13,
2-15, 2-17, 2-29
QUIT command, 2-2, 2-12,
2-18
SAVE command, 2-13, 2-18,
2-27
setting attributes, 2-21
saving the design, 2-13,
2-22, 2-27
sections, design buffer,
2-1, 2-16, 2-29
area section, 2-29, 2-42
file section, 2-29, 2-31
key section, 2-29, 2-38
key segments, 2-41
record section, 2-29, 2-36
system section,
2-29 to 2-30
SET command, 2-13, 2-17,
2-20, 2-33
allocation, 2-10
defining areas by default,
2-17, 2-43
defining areas explicitly,
2-43
INDEX AREA attribute, 2-41
LEVELl INDEX AREA
attrIbute ,-2-41
PROTECTION attribute, 2-33
with GET, 2-25
SHOW
PROTECTION attribute, 2-33
SHOW ALL command, 2-4
defining areas by default,
2-17
defining areas explicitly,
2-43
setting attributes, 2-21
SHOW command, 2-15, 2-18,
2-26
allocation, 2-10
wi th GET, 2-25
SHOW ID command, 2-16
terminating, 2-2, 2-9, 2-12
version, 2-16
RMSDSP (RMS-ll File Display
Utility), 1-1, 5-1, 6-3, 7-5,
7-10
IBP switch, 5-3 to 5-4
IFU switch, 5-2, 5-4
lID switch, 5-3, 5-5
ANSI-standard tape, 5-3

Index-8

INDEX
command string, 5-2 to 5-3
6-3, 6-8, 7-1
container file, 5-1,
/[NO]CV switch, 7-5, 7-10
/[NO]QU switch, 7-6 to 7-8,
5-3 to 5-4
detailed display, 5-4
7-12
display information, 5-1
/BD switch, 7-8, 7-10
displays, 5-5
/FR switch, 7-7
HELP, 5-3
/10 switch, 7-3, 7-5
indirect command file, 5-2
lOA switch, 7-9 to 7-10
intersystem file transfer,
/RA switch, 7-7, 7-11
1-2
/RC switch, 7-8, 7-11
invoking, 5-2
/SE switch, 7-3, 7-9
magtape allocation information,
/SL switch, 7-6, 7-12
/SU switch, 7-8
5-2
messages, C-l
command string, 7-2 to 7-3
mounting tapes, 5-3
data integrity checking,
prompt, 5-2
7-6, 7-8, 7-11
switches, 5-3 to 5-4
examples, 7-12
terminating, 5-2
global switches, 7-5
RMSIFL (RMS-ll Indexed File Load
HELP, 7-3
Utility), 1-1, 3-1, 4-1 to 4-2
input file switches, 7-8
intersystem file transfer,
/DE switch, 3-7, 3-10, 3-14
/ER switch, 3-5 to 3-6
1-2, 7-1, 7-10
/ID switch, 3-3, 3-5
/FR switch, 7-7
file-version number
/KR switch, 3-8 to 3-9
conversion, 7-5
/LO switch, 3-6
/NOER switch, 3-6
invoking, 7-2
messages, C-l
/NOSO switch, 3-8 to 3-10
output file switches, 7-7
/PD switch, 3-6 to 3-7, 3-11
/TR switch, 3-7, 3-11
processing, 7-9
calculating file work space,
data integrity checking,
3-12
7-11
command string, 3-2 to 3-3
explicit/implicit
examples, 3-14
file-spec, 7-10
global switch, 3-5
extended diagnostic
messagen, 7-11
HELP, 3-3
indirect command file, 3-2
restoration account, 7-10
input file switches, 3-7
summary listing, 7-12
invoking, 3-2
prompt, 7-2
messages, C-l
query mode, 7-6 to 7-8, 7-11
output file switches, 3-5
summary listing, 7-12
processing, 3-9
terminating, 7-2
building alternate indexes,
SAVE command
3-12
command string checking,
RMSDES utility, 2-13, 2-18,
2-27
3-9
loading output file, 3-10
setting attributes, 2-21
Saving the design
reading and sorting input,
RMSDES utility, 2-22, 2-27
3-9
See also Description file
sorting alternate key files,
Sections, design buffer
3-11
summary, 3-1
RMSDES utility, 2-1, 2-29
terminating, 3-12
area section, 2-29, 2-42
prompt, 3-2
file section, 2-29, 2-31
sort error codes, D-l
key section, 2-29, 2-38
sort work files, 3-1, 3-7,
key segments, 2-41
record section, 2-29, 2-36
3-12 to 3-13
switches, 3-3, 3-5
system section, 2-29 to 2-30
terminating, 3-2
Sections, design buffer (RMSDES),
RMSRST (RMS-ll File Back-Up
2-16
Utility)
SEGO POSITION
indirect command file, 7-2
RMSDES utility, 2-42
RMSRST (RMS-ll File Restoration
SEGn LENGTH
Utility), 1-1, 4-2, 5-4, 6-1,
RMSDES utility, 2-42

Index-9

INDEX
SEGn POSITION
RMSDES utility, 2-42
Serial, nondisk device (RMSIFL),
3-1, 3-12
SET command
RMSDES utility, 2-13, 2-17,
2-20, 2-33
allocation, 2-10
defining areas by default,
2-17, 2-43
defining areas explicitly,
2-43
INDEX AREA attribute, 2-41
LEVELl INDEX AREA
attrTbute,-2-4l
PROTECTION attribute, 2-33
with GET, 2-25
Setting attributes (RMSDES)
See Attributes
SHOW ALL command
RMSDES utility
defining areas by default,
2-17
defining areas explicitly,
2-43
SHOW command
RMSDES utility, 2-15, 2-18,
2-26
allocation, 2-10
PROTECTION attribute, 2-33
SHOW ALL, 2-4
setting attributes, 2-21
wi th GET, 2-25
SHO~l 10 command
RMSDES utility, 2-16
SIZE
RMSDES utility, 2-36
Sort routine error codes
(RMSIFL), 0-1
Sort work files (RMSIFL), 3-1,
3-10, 3-12
allocating space
primary key sort, 3-13
device allocation, 3-7
Sorting (RMSIFL)
alternate key, 3-11 to 3-13
alternate key files, 3-7
bypassing primary key sort,
3-8 to 3-9
input file organization, 3-9
primary key, 3-9
work files, 3-7, 3-13
SOURCE
RMSDES utility, 2-30
Summary listing
RMSBCK utility, 6-10
RMSCNV utility, 4-12
RMSRST utility, 7-12
SUPERSEDE
RMSDES utility, 2-35
Supersession
RMSBCK utility, 6-7
RMSCNV utility, 4-7, 4-13

RMSDEF utility, A-7
RMSRST utility, 7-8
Switches
RMSBCK utility, 6-4 to 6-5
RMSCNV utility, 4-5, 4-7
RMSDSP utility, 5-3 to 5-4
RMSIFL utility, 3-3, 3-5
RMSRST utility, 7-3, 7-5
See also individual switch
entries
See also RMSBCK, RMSCNV,
RMSDSP, RMSIFL, RMSRST
System disk
RMSBCK utility, 6-1
RMSRST utility, 7-1
TARGET
RMSDES utility, 2-30
Terminating
RMSBCK utility, 6-2
RMSCNV utility, 4-4
RMSDEF utility, A-5
RMSDES utility, 2-2, 2-9, 2-12
RMSDSP utility, 5-2
RMSIFL utility, 3-2
RMSRST utility, 7-2
Terminating processing (RMSIFL),
3-12
Truncation
RMSCNV utility, 4-13
RMSIFL utility, 3-7
TYPE
RMSDES utility, 2-38
Unit record device
RMSCNV utility, 4-5
Version
RMSDES utility,
Version number
RMSBCK utility,
RMSCNV utility,
RMSDEF utility,
RMSDSP utility,
RMSIFL utility,
RMSRST utility,

Index-10

2-16
6-5
4-9
A-5
5-5
3-5
7-5

RSX-llM/M-PLUS RMS-ll Utilities
AA-L670A-TC
READER'S COMMENTS
NOTE: This form is for document comments only. DIGITAL will use comments sub.mitted on this format the
company's discretion. If you require a written reply and are eligible to receive one under Software
Performance Report (SPR) service, submit your comments on an SPR form.

Did you find this manual understandable, usable, and well organized? Please make suggestions for improvement.

Did you find errors in this manual? If so, specify the error and the page number.

Please indicate the type of user/reader that you most nearly represent.

o Assembly language programmer
lJ Higher-level language programmer

o Occasional programmer (experienced)
User with little programming experience
[] Student programmer
[J Other (please specify)

Name ._______________________________________________ Date _________________________________
Organization
Street
City

State ___________ Zip Code ___________
or Country

-I

Do Not Tear - Fold Here and Tape

I II

No Postage
Necessary
if Mailed in the
United States

I
I

BUSINESS REPLY MAIL
FIRST CLASS PERMIT NO.33 MAYNARD MASS.
POSTAGE WILL BE PAID BY ADDRESSEE

BSSG PUBLICATIONS ZK1-3/J35
DIGITAL EQUIPMENT CORPORATION
110 SPIT BROOK ROAD
NASHUA, NEW HAMPSHIRE 03061

Do Not Tear - Fold Here

-I

I
I

=
:3

~
Q)

01)