SC19 6211 0_VM_SP_CP_Command_Reference_or_General_Users_Sep80 0 VM SP CP Command Reference Or General Users Sep80

User Manual: SC19-6211-0_VM_SP_CP_Command_Reference_or_General_Users_Sep80

Open the PDF directly: View PDF PDF.
Page Count: 220

DownloadSC19-6211-0_VM_SP_CP_Command_Reference_or_General_Users_Sep80 SC19-6211-0 VM SP CP Command Reference Or General Users Sep80
Open PDF In BrowserView PDF
File No. S37()'36

Order No. SC19-6211·0

Program Product

IBM Virtual
Machine/System Product:
CP Command Reference
for General Users
Program Number 5664-167
This publication is a reference manual for the
general class of users that are running systems
such as as, DOS, OS/VS, DOS/VS, VSE systems,
CMS, and networking systems in a virtual
machine under VM/SP.
Each CP command available to the general class
of user is listed alphabetically. Each command
description contains general usage information,
the command line format, descriptions of all
allowable operands, and default values for
operands. Also included are tables showing
the relationship of the general class of CP
commands to the entire set of VM/SP
CP commands.

PREREQUISITE PUBLICATIONS
IBM Virtual Machine/System Product:
Introduction, Order No. GC19-6200
Terminal User's

Guidt:~

Order No. GC19-6206

COREQUISITE PUBLICATIONS
IBM Virtual Machine/System Product:
System Messages and Codes, Order No. SC19·6204

--.....--- - -- _
- --------~.-

-

r--!Notice: The term VM/SP, as used in this publication,
!when-used in conjunction with VM/310 Release 6.
L-

Ei£§i !£iii2E

(september 1980)

This edition (SC19-6211)
applies to the IBM Virtual Machine/System
Product unless otherwise indicated in
new editions or Technical
Newsletters.
cpanges are continually made to the information contai~ed
herein; before using this publication in connection with the operation
of IBM systems,
consult the
1~~
~Y§i~IDL21Q
gn£ 4300 processors
finli2g£~E~Y,
~£lQ=QQQj,
for the editions that are -applicable--and
current.
It is possible that this material may contain reference to, or
information about~ IBM products (machines and programs), programming, or
services that are not annnounced in
your country.
Such references or
information must not be construed to mean that IBM intends to announce
such IBM products, programming, or services in your country.
~ublica~ions are
not stocked at the address given below; requests for
copies of IBM publications should be made to your IBM representative or
to th~ IBM branch office serving your locality.

form for readers'
ccmments is
provided at the back of this
publication; if the form has been removed, comments may be addressed to
IBM Programming Publications, Dept. G60, P.O. Box 6, Endicott, New York,
U.S.A. 13760.
IBM may use or distribute any of the information you
supply in any
way it believes appropriate without incurring any
obligation whatever.
You
may,
of course, continue
to USE the
information you supply.

©

Copyright International Business Machines Corporation 1980

refers to VM/SPI
I

Preface

This publication is a reference manual that
discusses VK/SP CP commands available to
the general user.
The user should be knowledgeable of the
concepts of VK/SP as outlined in the IB~
Virtual
~~£nin~LSyst§~
R£Qg~~!
Int£odygtiQB, Order No.
GC19-6200.
In
addition, the user should be aware of the
logon
process,
terminal-initiated
interrupts, terminal modes, and the method
of switching from CP to virtual machine
mode and vice versa. This information is
detailed in the 1BK !ir!y~! Kag~iB~L2~§te~
Product Terminal User's Guide, Order No.

GC19=6206~-------

------ -----

With the commands described in this
publication,
the
general
user
can
reconfigure his virtual machine, control
devices attached to his virtual machine,
perform
input
and
output
spooling
functions,
and
simulate
many
other
functions of a real computer console.
Other VK/SP CP commands, available only
to system operators, system programmers and
analysts, and service representatives, are
described in the publication !~~ !i£!~!
~~fhi~~L§Y§1~

f~od~£!

Order No. SC19-6202.

Q~~1Q~~§

~Yide,

Part 2 has two sections:
"Section
4. Notational
Conventions"
describes the syntax that is used in this
publication to display command formats and
command truncation and abbreviation.
"Section 5.
Format
of CP Commands"
contains reference data for all the class G
and class Any commands in alphabetical
sequence by command name.
The command line
format includes all operands along with a
description of each.
Any limitations or
restrictions applicable to the values of
variable operands are also defined.
"Appendix A.
VM/SP
Command Summary"
contains all of the VM/SP commands, with a
brief
description
of
each
command's
function.
This is intended to give the
general user a perspective of the position
that the CP class G and class Any commands
occupy
in the
overall VM/SP
command
structure.
In this
publication,
terminology is used:

The term 'cylinder' is used to describe
DASD space on Direct Access Storage
Devices
(count-key-data
devices)
supported by the VM/SP System Control
Program. The term 'block'
is used to
describe DASD space on FB-512 devices.
Specifically, FB-512 devices arE the IBM
3310 and 3370 Direct Access Devices
employing fixed block mode. The term
'DASD space' may appear in text when
there is
no need
to differentiate
between
count-key-data
devices
and
FB-512 devices.

•

"2305" refers to the IBM 2305 Fixed Head
Storage, Models 1 and 2.

•

The term, "3270", is
used in this
publication to refer to a series of
display devices, namely, the IBM 3275,
3276,
3277,
3278,
and 3279 Display
Stations.
A specific device type is
used only when a distinction is required
between device types. Information about
display terminal usage also applies to
the IBM 3138, 3148, 3158, 3033, and 3036
Display Consoles when used in display
mode, unless otherwise noted.

Part 1 has three sections:
"Section 1.
The
CP Command Syntax"
describes the VK/SP command environments
and the general structure of the CP command
languaqe.

"Sect ion 3 CP Command Usage" describes
the use of CP commands to control terminal
sessions, control I/O devices, test and
debug programs, and control virtual machine
func tions.

following

•

This publication is organized in two
parts: "Part 1. Guidance Information" and
"Part 2. Reference Information." There is
also an appendix.

"Section 2.
The CP Command Language"
provides additional information on the CP
command set.

the

Preface

iii

•

•

Any information pertaining to the IBM
3284 or 3286 printer also pertains to
t he IBM 3262, 3281,
3288 and 3289
printers unless otherwise noted.
"3330" refers to the IBM 3330 Disk
Storage Models 1, 2, 11; the IBM 3333
Disk Storage and Control Models 1 and
11; and the 3350 Direct Access Storage
operating in
3330/3333 Model
1 or
3330/3333 Model 2 compatibility mode.

•

"3340" refers to the IBK 3340 Disk
Storage, Models A2, B1,
and B2; and the
3344 Direct Access storage, Model B2.

•

"3350" refers to the IBM 3350 Direct
Access Storage, Models A2 and B2, in
native mode.

•

"3800" refers
Subsystem.

to the IBM

•

"3850" refers to
Storage System.

•

Unless otherwise noted, the term "VSE"
refers to the combination of the DOS/VSE
system
control
program
and
the
VSE/Advanced Functions program product.

the

3800 Printing
IBM

3850

Mass

In certain cases, the term DOS is
still used as a generic term.
For
example, the disk packs initialized for
use with VSE or any predecessor DOS or
DOS/VS system may be referred to as DOS
disks.
For a

glossary of VM/SP terms, see the
Prody£! Gloss~~
!Bg A!§t~~ I~, Order No. GC19-6201.
IB~ !irt~!! Ma~~iBgL~I§1~

•

"3380" refers to IBK 3380 Direct Access
storage. Information on the 3380 is for
planning
purposes
only
until
the
availability of that device.

•

"VM/310 hardware assist" refers to both
the virtual machine assist function and
VM/370 Extended control-Program Support.
Some form of the VK/370 hardware assist
is available on all VM/370 supported
S ystem/370 systems except the 155 II,
165-111, and 4331. Refer to IBM Virtual
n~~i~L~Y§1~~
R~od]&1 R!~nB!Bg---an~
~~§1g~
~~Qg~~1ion
~Yig~,
Order
No.
SC19-6201,
for
further
device
information on
the VM/310
hardware
assist and ECPS features.

PREREQUISITE PUBLICATIONS

•

Any information pertaining to the IBM
2741 terminal also applies to the IBM
3767 terminal, ~odel 1, operating as a
2741, unless otherwise specified.

•

The term
"processor" used
in this
publication means the main processor
which is the processor with I/O handling
capabilities.
The
term
"attached
processor" means a processor that has no
I/O capabilities; an attached processor
is always linked to a main processor for
utilization. VM/SP also supports real
multiprocessor (MP) configurations on
the 158MP, 168KP, and 3033MP processors.
In a MP system, the term "IPL processor"
refers
to
the processor
that
is
initialized
first
during
system
generation. The term "nonIPL processor"
refers
to
the processor
that
is
initialized after the IPL processor.
Both the IPL and nonIPL processors in a
real
KP
configuration
have
I/O
cap a b il i tie s •

iv

The concepts of VM/SP are described in the
IBM
.!irt~!
!1~hine/~yste~
Product
Ini~g~1iQ!!, Order No. GC19-6200 .•
The physical operation of the virtual
machine console is covered in the IBM
Termi1!al
!i£1~!i !1!£hineL~y§t~~
R~odu£!
y§~~~§ ~~ig~, Order No. GC19-6206.
If the IBM 3767 Communications Terminal
is to be used as a virtual console, the
publication IBM 11§1
Q~~~at2~!§
Guig~,
Order No. GA18-2000, is a prerequisite.

ASSOCIATED PUBLICATIONS
CP error messages and return codes that may
be issued to a user during a terminal
session are documented
in IBM Virtual
Machinel~Y§1~ f~Qduct Sys1n j~ssages ind
£Qg~, Order No .• SC 19-6204.
General users intending
to use eMS
should refer to the following publications
for information on the CMS command language
and its implementation:

IBM VM/310 CP Command Reference for General Users

The RSCS and IPCS components of VM/370
remain unmodified by the VM/SP program
product. If the general user intends to
use these two unmodified VM/370 components,
he
should
refer
to
the
following
publications for information on the RSCS
and IPCS command languages:

In addition,
'M/SP users
can have
enhanced networking facilities provided in
the
RSCS
Networking
program
product
(5748-XP1).
Enhanced interactive problem
control
is
provided by
the
VM/IPCS
Extension program product
(5748-S11). The
following publications contain information
about the command languages of the RSCS
Networking program product and the VK/IPCS
Extension program product:

Interactive
~I£~l~
-£gn!I2!
aJ§te~
(j~£~) ~§er~2 ~uig~, Order No. GC20-1823
References
in
text to
titles
of
prerequisite
and
corequisite
VM/SP
publications are given in abbreviated form.

Preface

v

Publications that support VM/SP as used in conjunction
with VM/370 Release 6
VM/SP Licensed
Program Specifications

f---(36)

GC20·1842

VM/SP General Information
Manual
GC20·1838

+
VM/SP Glossary and
Master Index
(20)

GC19-6207

r---

Note: The numbers given in parentheses represent the Subject Cod e.

VM/SP Introduction
(20)

GC19·6200

~
VM/SP Terminal
User's Guide

(40)

SCI9·6204

-

II

1

OSIVS, DOSNSE, VM/370
EREP Messages
(40)

GC38·1045

•
VM/SP CMS User's Guide
(39)

SC19·6210

Assembler Programmer's
Guide

r

(40)

-

(36)

SC19·6203

VM/SP CMS Command
and Macro Reference

T

VM/SP Data Areas and
Control Block Logic

Assembler Language
(21)

GC33·4010

Auxiliary
Support

IJ

VM/370 Remote Spooling
Communications Subsystem
User's Guide
(39)
SBOF3820

-.
(36)

me 2

VMISP
SC24·5219

VM/SP Quick Guide for
Users

"'''~
(36)

(36)

SX20·4400

l

(37)

LY20·0890

OSNS and VM/370
Assembler Program Logic
(21)

SY33·8041

I

(36)

II

II
VM/370 Interactive Problem
Control System (IPCS)
User's Guide

VM/SP Commands
(General User)
(36)

SX20·4401

II

VM/370 System Logic and
Problem Determination
Guide Volume 3 (RSCS)
SY20·0888

VM/SP Service Routines
Program Logic

(30)

GC20·1816

II

t

VM/SP System Product
Editor Command and
Macro Reference

+

(36)

LY20·0891

OSNS, DOSNS, VM/370

II

SC24·5220_

(36)

LY20·0893

(36)

SC19·6209

VM/SP System Product
Editor User's Guide

SC24·5221

VM/SP System Logic and
Problem Determination
Guide Volume 2 (CMS)

VM/SPSystem
Programmer's Guide

t

a

VM/SP Operator's Guide
SC19·6202

(21)

GC33·4021

t

(36)

LY20·0892

t

I

OSNS and VM/370

Operations,

VM/SP System Logic and
Problem Determination
G!Jide Volume 1 (CP)
(34)

GC19·6212

I

CMS User

(37)

SC19·6205

~
VM/SP Operating
Systems in a
Virtual Machine
(36)

SC19·6211

(34)

SC19·6201

VM/SP CP Command
Reference for
General Users

II

VM/SP OLTSEP and
Error Recording Guide

VM/SP Planning and
System Generation Guide
(40)

1

EJ

Support

a

GC19·6206

VM/SP System Messages and
Codes

System
p ... gramming

GC20·1823

(37)

OSNS, DOSNSE, VM/370
Environmental Recording,
Editing, and Printing
(EREP) Program
GC28·0772

(37)

~

II
OSNS, DOSNSE, VM/370

VM/SP Commands
(Other than General User)
SX20·4402

(36)

Environmental Recording,
Editing, and Printing
(EREP) Program Logic
SY28·0773

Legend.

II

For SNA terminal users, the prerequisite publication is: VMIVCNA Installation,

Operations, and Terminal Use, Order No. SC27-Q502.

II

All users of virtual machines must use the VMISP System Messages and Codes
publication.

II

Contains information on VM/SP EREP support.

a

VM/370 Release 6 components. However, the IPCS Extension Program
Product (5748-SA 1) and the RSCS Networking Program Product (5748-XP1)
are recommended for use with VM/SP.

II

If you want all three of the Reference Summary publications, use the SBOF
number when ordering.

Figure 1.

vi

The Virtual Machine/System Product Library

IBM VM/SP CP Command Reference for General Users

(37)

Contents

PART 1. GUIDANCE INFORKATION • •

• • •1

SECTION 1. THE CP COMMAND SYNTAX
••• 3
VM/SP Command Environments • • • • • • • • 3
VK/SP CP Command Structure. •
• •• 3
The Ccmmand Name. • • • • •
• .4
Th e Command Operands • • • •
•• 4
Comments in the CP Command Languaqe • • • 4
Character Set Usage. • • •
• .4
SECTION 2. THE CP COMMAND LANGUAGE
•• 7
Privileqe Classes for CP Commands.
• .7
The Class G Ccmmands • •
• ••••• 9
The Class Any Commands
••• 9
SECT ION 3. CP COM MAN D USAGE. •
•
controlling Input and Output Functions.
Virtual DiSKS. • • • • •
•
Permanent Virtual Disks. • •
•
Temporary Virtual Disks. • • • • • • •
Sharing Virtual Disks. • • •
•
Virtual Unit Record Devices.
•
Virtual Unit Record Spooling •
•
Spool File Characteristics •
•
Virtual Console Spooling • • • • • • •
Reordering and purging Spool Files • •
Dedicated Devices • • • • • • • • • • •
Dedicated Channels. • • • • •
•
controlling the Virtual Machine.
•
Loading an Operating System. • •
•
Si mula,tinq In terru pts. • • • •
•
Entering CP Commands. • • • • •
•
Enterinq CP Ccmmands when the Virtual
Machine Is Running • • • • • • • • • •
Enterinq CP Ccmmands from the Virtual
Console Fead Environment. • • • • • •
Entering CP Commands from CP Console
Function Mode • • • • • • • • • • • •
Reconfiguring the Virtual Machine • • •
Testinq and Debuqginq of Programs • • • •
Stopping Execution of Your Virtual
Machine • • • • • • • • • •
•
Di sp la ying Virtual Storage • • • • • •
Terminal Output. • • • • • • • • • • •
Byte Alignment on Terminal Output • • •
Printer Output. • • • • •
•
Alte~inq Virtual Storage •
•
Tracinq Virtual Machine Activity
•

11
12
13
14
14
14
15
15
16
18
18
19
20
21
21
22
23
23
24
25
25
26
26
27
27
28
29
30
31

PART 2. REFERENCE INFORMATION. • •

• 33

SECTION 4. NOTATIONAL CONVENTIONS.

• 35

SECTION 5. FORMAT OF CP COMMANDS •

• 39

*. • •

40
.CP. • •
• 41
ADS TOP •
• 43
ATTN • •
• 45
BEGIN • •
• • • • • 46
CHANGE •
• 47
CLOSE.
• • • • • 51
COUPLE •
• • • • • 55
CP • • •
• 57
DEFINE •
• 58
DETACH •
• • • • • 66
DETACH CHANNEL •
• • • • • 69
DIAL •
• •••
• 70
DISCONN.
• • • •
• • • • • 72
DISPLAY.
74
DUMP • •
• 80
ECHO • •
• 83
EXTERNAL •
• 84
INDICATE •
• 85
IPL. • • •
• • • • • 88
LINK • • •
• 92
LOADVFCB •
96
LOGOFF •
• 98
LOGON • •
.100
MESSAGE. •
• • • • • 102
NOTREADY •
• • • • • 104
ORDER. •
• • • • • 105
PURGE • •
.101
QUERY. • •
• • .109
QUERY Command for Class G Users.
• 110
QUERY Command for All Classes of Users
(Except Class Any).
• • • • .121
READY. •
.130
REQUEST.
.131
RESET ••
.132
REWIND •
.133
SCREEN •
• • • • • 134
SEND • • • • • •
• • • • • 131
SET. • •
• 138
SLEEP. •
• 151
SMSG • •
• • • • • 152
SPOOL. •
• • • • .153
STORE. •
• .163
SYSTEM.
• • • • • 166
TAG • • •
• .161
.170
TERMI NAL •
TRACE. •
.116
TRA NSFER •
• • • • • 181
VMDUMP •
• • • • .184
APPENDIX: CP COMMAND SUMMARl •

.189

INDEX. • • •

.195

Contents

vii

FIGURES
Figuce

1.

Figuce

2.

Figuce

3.

Figuce

4.

Figuce

5.

viii

The Virtual Machine/System
Product Library •••••••••••••• vi
Character Sets and Their
Contents •••••••••••••••••••••• 5
CP Privilege Class
Descriptions •••••••••••••••••• 8
Controlling the Virtual
Machine During a Terminal
Session •••••••••••••••••••••• l l
System Action to
#CP Command •••••••••••••••••• 42

Figure

6.

Figure

7.

Figure

8.

Figure

9.

Figure 10.
Figure 11.

IBM VM/SP CP Command Reference for General Users

Action Taken on CLOSE for
a Virtual Input Device ••••••• 53
Action Taken on CLOSE for
a Virtual Output Device •••••• 53
Available Form Width Codes
for 3800 Spooling •••••••••••• 64
Password Requirements on
the LINK Command •• ~ •••••••••• 94
3270 High Intensity
Features •••••••••••••••••••• 175
CP Command Summary •••••••••• 189

Part 1. Guidance Information

This part of
VM/SP system.

the publication contains general
It contains three sections.

information about

the

"s ection 1. The CP Command
Syntax" describes the CP command
environments and the general structure of the command languages.
"Section 2. The CP Command
on the CP command set.

Language" provides additional information

"Section 3.
CP Command Usage" describes
via class G CP commands.

a variety of

user requests

Part 1. Guidance Information

1

2

IBM VM/SP CP Command Beference for General Users

Section 1. CP Command Syntax

The CP component of VM/SP has its own command language.
Much like any
other language,
the CP command language has a set a
rules and
structures.
This section describes the CP command language environment,
syntax and st.ructure, giving general descri~tions of command names,
operands and their position on the command line, and character set usage
in CP.
A further discussion of CP commands is included in !~~~
Q£er~!in~ ~~stg~§ in S !ir!~al ~~£hin~.
There are two types of CP commands: system commands and user-defined
commands.
Depending
on your privilege class,
you can issue CP system
commands to do various system oriented functions.
Privilege class is
discussed in "Section 2. The CP Command Language." You, as a class G,
or general,
user can use CP commands to simulate the function of the
system operator's console.
You can issue commands to control the
operating system running in your virtual machine much like an operator
controls the entire VM/SP operating system using the keys and switches
on his system console.
User-defined CP commands are allowed, too;
however, your system programmer must create them for you.
The procedure
for creating your own CP commands
is detailed in VML~E ~Ist~~
PrQg~~m!~~ Q~ig~.

VM/SP Command Environments
There are two
basic command environments:
the control program
command environment and the virtual machine command environment.
You are in the control program
on to VM/SP and issue CP commands.

(CP)

(CP)

command environment when you log

You are in the virtual machine command environment when you load your
virtual machine with CKS or another operating system.

If you are operating under CKS,
lOU can determine which command
environment you are in by entering a
null line (that is, pressing the
enter key, or equivalent, with no data).
VM/SP responds to a null line
by displaying the current command environment, CMS or CP.

VM/SP CP Command Structure
A VM/SP command consists of a command name, usually followed
by one or
more positional operands.
The general form for the CP command line is:

r----------------------------------------------------------------------,
, command name
, ( operand ••• ]
t
..... _ - __ - - - - . J

You must use one or more blanks
line unless otherwise indicated.

to separate each entry

in the command

Section 1. The CP Command syntax

3

THE COMMAND NA!E

The ccmmand name is an alphameric symbol of not more than eight
characters. In general, the names are verbs that describe the function
you want the system to perform. For example, you may want to find out
whether or not a certain user is logged on the VM/SP system. In this
case, you would use the CP QUERY command.

THE COMM&ND OPERANDS

The command operands are keywords and positional operands of no more
than eight alphameric characters each.
The operands specify the
information on which the system operates when it performs the command
function. For the QUERY command, for example, you could use the OSER or
userid operand to find out whether the user is on the system.
Some commands require no oper.ands; others require several. You can
find each class G and class Any command with all of its operand
requirements in "Section 5: Format of CP Commands" of this publication.
You must wr i te the operands in the order j.n which they appear in the
command formats in section 5, unless otherwise specified.

COMMENTS IN THE CP COMMAND LANGUAGE

You can write comments with CP commands of the following types:
•
•
•

Commands with no operands
Commands with a fixed number of operands
Comm~nds with a single optional operand

You should not write comments with commands that have a variable
number of operands or with commands that have more than one optional
operand. If you do, the comment could be interpreted as an operand.
You can enter comments on your console by using the CP

*

command.

CHARACTER SET USAGE
VM/SP commands are entered using a combination of characters from six
different character sets. The contents of each of the character sets is
described in Figure 2.

4

IBM V!/SP CP Command Reference for General Users

r

I Character Set I

Names

Separator

Blank

Na tional

Dollar Sign
Pound Sign
At Sign

Alphabetic

Symbols

$

i
ii)

Uppercase
Lowercase

a - z

Numeric

Numeric

0

Alphameric

Na tional
Alphabetic

$, #,
A
Z
a
z
0
9

Numeric
Special
L - - -_ _ _ _ __

Figure 2.

A-

-

-

Z

9
Ii)

-

-

All other
characters

Character Sets and Their Contents

Section 1. The CP Command syntax

5

6

IBM VM/SP CP Command Reference for General Users

Section 2. The CP Command Language

The CP commands represent a set of interactive console functions that
are used (1)
by the operator to control the VM/SP system and
(2) by a
user to control a virtual machine.
In this publication, only those
commands that are used to control
a virtual machine are fully
documented. Other commands are referenced only to the extent necessary
to show relationships and provide general knowledge.

Privilege Classes for CP Commands
Each user of V"/SP is assigned one or more privilege classes as part of
the directory entry of the virtual machine.
Each user class is
indicative of a soecific function of a virtual machine and entitles the
user to a specific subset of the CP command language.
Figure 3 lists each CP privilege class along with the associated type
of user and function performed. Figure 3 also identifies the specific
publications in which each class subset of CP commands is described in
deta il.
For a complete list of CP
to

commands

group~d

by privilege class, refer

!~§R Q~~~~!g!~§ Q~ide.

Althouqh users are functionally divided into seven classes (A through
G) with a corresponding privilege class of CP commands, there is another
small group of commands available to all users.
The eighth group
consists of commands that do not belong to a privilege class because
they are used to perform certain basic functions that are required by
all virtual machines, such as logging on, logging off, and sending
messaqes. T~ese CP commands are in the Any class.
This publication is a reference manual for only the class G and class
Any subsets of the CP command language.

section 2. The CP Command Language

7

r--

IClass ,
-----1
Al
,

User and Function
--------------g~im~~Y ~§£~ Q~~1Q~: The class A user controls the
V"/SP system. Class A is assigned to the user at the VM/SP
system console during IPL. The primary system operator is
responsible for the availability of the VM/SP system and its
communication lines and resources. In addition, the class A
user controls system accounting, broadcast messages, virtual
machine performance options, and other command operands that
affect the overall performance of VM/SP. The system
operator controls operation of the real machine using the
system control panel and console device.
!Qte: The class A system operator who is automatically logged
on during CP initialization is designated as the primary
system operator.
~Y§i~! ~~2yrc~ QE~£~12~:

The class B user controls
allocation and deallocation of all the real resources of the
V"/SP system, except those controlled by the primary system
operator and spooling operator.

CI

The class C user updates certain
functions of the VM/SP system. The system programmer can
modify real storage in the real machine.

~Y§i~! R!Qg£A!~~:

2EQQ!i.ng

Q.E§g1Q~:
The class D user controls spool data
files and specific functions of the system's unit record
equipment.

Ana!YE!: The class E user displays the contents of
real storage, performs the functions required to generate
saved systems and discontiguous saved segments, and controls
the collection and recording of performance measurement data.
This class of user can display the contents of specified real
storage areas on the virtual operator's console or on a
spooled virtual printer, but cannot modify real storage.
~§te~

.lI
I
f FI
I
I
~

2~~Yif~ g~££~2~ni~ti~~:

The class F user obtains, and
examines, in detail, certain data about input and output
devices connected to the VM/SP system. The service
representative can establish intensive recording mode for one
I/O device at a time and can cause the recording of
repressable machine check errors to be initiated or resumed.

General User: The class G user controls functions associated
with-the-execution of his virtual machine. A general user
cannot display or modify real storage.
An y2

The Any classification is given to certain CP commands that
are available to any user. These are primarily for the
purpose of gaining and relinquishing access to the VM/SP
system.
Reserved for IBM use.

IDescribed in the VM/SP Operator's Guide.
2Described in this publication.
L-

Figure 3.

8

CP Privilege Class Descriptions

IBM VM/SP CP Command Reference for General Users

THE CLASS G COMKANDS
Commands in the general user class enable the user to control the
operation of a virtual machine through using its virtual operator's
console device much as a real machine is controlled through its system
control panel.
For example,
commands are included in the general user class that
enable the user to perform the following operations:
load an operating
system (IPL command); start or restart program execution in the virtual
machine (BEGIN command);
stop virtual machine execution at a specified
virtual storage address (ADSTOP command); reset and restart the virtual
machine (SYSTEK RESET and SYSTEM RESTART commands); store and display
data contained in virtual storage, registers
(general, floating-point,
and centrol), and status words such as the PSW
(STORE and DISPLAY
commands);
display storage keys, the CSW, and the CAW
(DISPLAY
command); clear virtual storage to zeros
(SYSTEM CLEAR command); and
simulate an external interruption for the CPU timer, clock comparator,
or external interruption button on
the system console
(EXTERNAL
command).

THE CLASS ANY COMMANDS
The class Any ccmmands comprise those commands that are available, with
the same format and operands,
to all user classes.
One of these
commands, LOGON,
is used to gain initial access to the VM/SP system.
The LOGON command identifies you to the system and sets up your virtual
machine. The DIAL command allows you to establish a logical connection
between your terminal and a previously logged-on multiple-access virtual
machine. If you cannot log on for some reason, such as a faulty line
connection or someone else using your user identification, the MESSAGE
command allows you to communicate with the system operator or any other
logged-on user.

Section 2. The CP Command Language

9

10

IBM

V~/SP

CP Command Reference for General Users

Section 3. CP Command Usage

This section describes the CP commands provided for the general user
that simulate the functions available on the operator's system console.
The class G user can use these commands to r.ontrol the system running in
his virtual machine like an operator controls the entire VM/SP system
with console keys and swit~hes.
Fiqure 4 lists the steps a
user must
follow in preparation for a terminal session (steps 1 and 2), and
operation of a virtual machine (step 3) •
r-

,

,
,,
I

I

I
STEP ACTION
I
'l.User must fill
l o u t request
,
provided by
I by installa. t ion l

COMMAND DESCRIPtION

FUNCTION
Establish userid, user
classes, passwords,
storage requirements,
disk space, and I/O
devices

,,

,2. Installation

t builds VM/SP
I directory entry
I for system user ,
I from information l ,
I
13.User can activate,
I terminal and
, beqin work
I session 2
,

I
I
I

None

I
1
t
,
,
,
,
I

Directory entry providesl CMS DIRECT command
CP with information
,
necessary to create a
,
virtual machine
I

,

-----------------------1

Enter CP commands to
perform the function
required

a. activate terminal

,Available class G
(Figure 11)
I

,

I commands

I

,

,

I

1 LOGON command

I

1 (Figure 11)

, b. transfer and store
I
data

1

I LINK, SPOOL, STORE,
I and TRANSFER commands
I (Figure 11)

I c. record and control
I
data
1
I
I

CHANGE, CLOSE,
DISPLAY, DUMP, ORDER,
PURGE, QUERY, and
SPOOL commands
I (Figure 11)

1-------------------------------------

,

,------------------------------------~--------

IlUnless the installation or the users change system requirements,
, steps 1 and 2 do not have to be repeated every time a user activates
I a terminal after the initial session.
12Throughout the rest of this publication, the text is interspersed
I with examples of 1M/SP commands and system responses.
, All user input is shown in lowercase, and all system responses are
I shown in uppercase.
______________________________- - J
Figure 4.

Controlling the Virtual Machine During a Terminal Session
(Part 1 of 2)

Section 3. CP Command Usage

11

,,

r--

,
I

I ST EP ACTION

FUNCTION
d. reconfigure the
virtual machine

--------------------------1
tcp, ADSTOP, ATTN,
I

e. commuriicating with
the virtual machine

f. handling errors

'-----

Figure 4.

COMMAND DESCRIPTION
I
---I
DEFINE and DETACH
I
commands (Figure 11)
f
BEGIN, EXTERNAL, IPL,
REQUEST, SET commands
(Figure 11)

1

----------11
TRACE, DISPLAY, and

DUMP commands
I
f (Figure 11)
,-------------------f g. end session
f LOGOFF command
,
1 (Figure 11)
Controllinq the Virtual
(Part 2 of 2)

1
1

------------Machine During a Terminal Session

I
f
f
I

I
'

Controlling Input and Output Functions
The directory entry for your virtual machine includes, among other
information, the I/O configuration required to run whatever operating
system you are using in that virtual machine. This usually includes a
virtual console, virtual pr~nter, a virtual card reader, a virtual card
punch, ~nd virtual disks. A typical entry would look like:
( 1)
(.3)

(5)
(6 )

USER VMUSER 123456 512K 2M G
ACCOUNT 87321 BIN14
(2)
OPTION ECMODE
CONSOLE 01F 3215
(4)
S POOL DOC 2540 R
SPOOL DOD 2540 P
SPOOL OOE 1403
MDISK 130 2314 050 050 VDISK 1 WR RWPASSWD
MDISK 151 3330 001 020 VDISK2 WR RWPASSWD
LINK CMSSYS 440 190 RR

!.h~!:~:

(1)

The userid of this virtual machine is VMUSER, and the password is
123456. The virtual machine's storage size is defined as 512K;
however, this can be redefined up to 2 megabytes if, during a
operating session, the need for additional storage arises (see the
topic on "Reconfiguring the Virtual Machine"). The user privilege
class is G.

(2)

VM/SP generates accounting data for processor time and I/O device
usage. This data is charged to a virtual machine by account number,
which in this case is 87321. BIN14 is a distribution code that is
printed or punched on spooled printer and punch output. It usually
denotes a location where the user can pick up spooled output of a
terminal session.

(3)

Option ECMODE allows the virtual machine to use the complete set of
virtual System/370 control registers and the dynamic address
translation feature of the System/310.

12

IBM VM/SP CP Command Reference for General Users

(4)

The virtual address of the virtual machine console is 01F, and your
operating system corresponds with the terminal as if it were a
3 :t 1 5/3 2 10 •

(5)

The virtual unit record devices (reader, punch, and printer) are to
be spooled and their addresses, as far as the virtual machine is
concerned, are OOC, OOD, and OOE, respectively.

(6)

In this configuration, a
50 cylinder read/write minidisk with a
virtual address of 130 is located on cylinders 50 through 99 of a
real 2314 volume labeled VSDISK1.
Similarly, a 20 cylinder
read/write minidisk with a virtual address of 151 is located on
cylinders 1 through 20 of a real 3330 volume labeled VDISK2. The
last entry provides a
link to a sharable CMS system volume so the
user can use such CMS functions as the CMS editor or the EXEC
processor.
The LINK entry makes the virtual disk at virtual
address 440 available to your virtual machine in read-only mode at
virtual address 190.

1.

The read password entry (RR) on the LINK command means that anyone
with the proper password can share the use of the minidisk in
read-on ly mode.

2.

The write access mode
(WR) on the LINK command means that you can
write to the disk as long as no one else has a link to it; if
someone else links to i t before you log on, you still have
read-only access.

3.

For detailed information on directory
"Directory Control Statements" in the
~~neratiQ~ gyid~.

entries,
!l1~f

see the

f!~n~ing

sns

section
~l§.t~!!

Some devices such as unit record devices
(readers, printers and
punches) are usually defined as being spooled; in this way, a few real
unit record devices can support a large number of ~irtual unit record
devices.
other devices such as magnetic tapes require a one-to-one virtual to
real correspondence.
This means that for its period of use, the ,device
must be dedicated to one virtual machine.
For this reason, these
devices are not permanently assigned (that is, they are not defined in
the user's directory entry). Rather, they are temporarily attached to a
user as needed.

VIRTUAL DISKS
Under VM/SP, a sinqle real direct access storage device (DASD)
can be
managed as if it were made up of a number of virtual disks (minidisks).
Virtual disks, to VM/SP, are extents on real DASD.
To the virtual
machine, they are functional equivalents of real disks. They can range
from 1 cylinder on a count-key-data device or 1 block on an FB-512
device to all of the DASD space available on a real DASD volume.
Virtual disks can be permanently or temporarily defined for your virtual
machine.

Section 3. CP Command Usage

13

PERMANENT VIRTUAL DISKS
Permanent virtual disks are defined in your VM/SP directory. They can
be your own personal disks which you mayor may not wish to have other
users access;
or, they may be common disks, owned by one user, but
generally shared in read-only mode by any user on the system. Virtual
disks, defined in your directory, are made available to you when you log
on to the system.

TEMPORARY VIRTUAL DISKS
If during a terminal session you require additional disk space, you can
define a temporary minidisk via the CP DEFINE command:
define t2319 as 133 cyl 15
In the previous example, a virtual 2319 disk comprising 15 cylinders is
allocated to your virtual machine at virtual address 133. You can then
notify your operating system of the additional storage space using the
appropriate control statements or commands.
Because the previous structure or use of this temporary disk space is
unknown, you must format it to conform to the operating system you are
usino. For CMS, use the CMS FORMAT command.
For OS, DOS, or VSAM
applications, use the IBCDASDI program.
When you have no further need for temporary disk
releasE the space to the system by issuing the command:

space, you

can

detach 133
If you do not release it
during your terminal
automatically released to the system when you log off.

session,

it

is

Your installation's system programmer can specify an option during
system generation time that allows CP to automatically format (clear to
hexadecimal zeroes)
all temporary disk space either when you release
that space or log off the system.
If your installation does not choose
this option, you should, for security purposes, always format (clear)
all temporary disk space before logging off or releasing temporary disk
storage to free storage.

SHARING VIRTUAL DISKS
You can also gain temporary access to someone else's permanent virtual
disk during your terminal session. You must know the userid of the
disk's owner, as well as its virtual address in his system.
If the
owner is controlling the access to his disk, you have to obtain the read
or write password. You can then issue the command:
link to smith 330 as 134 rr rpasswd
The virtual disk at address 330 in user SMITH's configuration is made
available to your virtual machine at address 134. You have read-only
access even if SMITH has the disk in write status.

14

IBM VM/SP CP Command Reference for General Users

disks, consult

!~L~f

£MS

~§er'2

1.

For further information on virtual
!iyide.

2.

If your installation is using the password suppression facility,
you cannot specify the password on the same command line.
For
further informaticn,
refer to discussion of the LINK command in
Section 5 of this publication.

VIRTUAL UNIT RECORD DEVICES
The VK/SP directory entries for your virtual machine usually define at
least one reader, punch, and printer. These are the virtual unit record
devices that your operating system addresses when performing unit record
input and output. Rather than dedicate a real device to each virtual
unit record device, VK/SP
uses the concept of spooling to provide a
buffered interface between the few real unit record devices and the
relatively large number of virtual unit record devices.

VIRTUAL UNIT RECORD SPOOLING
Whenever your operating system creates a punch or printer file, VM/SP
organizes the output data into a spool file.
VM/SP then places the file
in a queue by device type and stores it on auxiliary DASD for eventual
processing by the real unit record device. Similarly when card input
data is read on a real card reader, VK/SP organizes the data into a
spool file and places it in the queue for the specified virtual card
read er.
You can assign certain characteristics to spool files that enhance
their manageability by VK/SP.
Some of these characteristics such as
spooling class and distribution code are assigned in the VM/SP directory
entries. Other characteristics such as number of copies, concatenation
of files, destination, and hold status are set to default values
whenever you log on.
The CP SPOOL and CHANGE commands allow you to change some or all of
the above characteristics.
To change spool file characteristics by
devi:ce, use the SPOOL command. To change characteristics by file, use
the CHANGE command.
VK/SP identifies individual spool files by assigning each file a
spool identification number (spoolid).
This number ranges from 0001
thro~gh 9900 after
9900, VK/SP starts again from 0001. If CP has not
yet processed spoolid 0001, CP will assign the next available spoolid to
the new file. One series of spoolids covers the reader, printer, punch,
and console spool files.
VK/SP normally assigns the spoolid to a spool
file when that file is closed. An exception to this is a console spool
file where VM/SP assigns the number when the file is opened. Also, if
you close a console file without stopping console spooling, VM/SP
automatically opens ancther console spool file with a new spoolid at the
same time.

section 3. CP Command Usage

15

SPOOL FILE CHARACTERISTICS
The spcoling class of a virtual device loqically groups its output with
output from similar virtual devices belonging to other users.
For
example, you could spool all printer output that required two-part green
striped forms as class G.
The real printer could then be set up with
two-part green striped forms and told to process only class G spool
files.
If you issue the command:
spool OOe class 9
all subsequent output of the virtual unit record device at address OOE
has a spool file class G. You can use the SPOOL command to set the
spooling class of files before they are closed.
Similarly, you can spool output by form name or form number when all
your output requires a particular form such as a tax form or inventory
form.
The form name is a one-to-eight character alphameric name
assigned by your installation's system programmer at system generation
time.
Using the FORM operand on certain class G commands,
you can change,
close, purge, query, order, spool, and transfer spool files by their
form name.
For instance, you can issue:
change printer form fed tax form statetax nohold
to change all your printer files with a form name of FEDTAX to STATETAX.
These files ~re then printed on a printer set up by your spooling
operator to process state tax forms.
If you decide to change the class of a spool file that has been
closed but not selected for processing by a real device, you can issue
the command:
c~ange

printer 1234 class m

and the printer spool file with a spool identification (spoolid) number
of 1234 has its class changed to~.
If you do not remember the spoolid
of the spool file, you can issue the command:
guery printer all
and all printer spool files that have not been processed or selected for
processing have a one line description displayed at the terminal. The
information displayed includes the spoolid number and the filename and
filetype as well as other spool file characteristics.
The HOLD/NOHOLD status is a characteristic of a spool file that
determines what happens to the file after it is closed. For example:
spool printer hold
prevents the release of all subsequent printer output spool files to the
real printer. If many files are being generated, of which only few are
required to be printed, you can hold all files with the HOLD option.
You can then release only the required files via the NOHOLD option of
the CHANGE or CLOSE commands.

16

IBM VM/SP CP Command Reference for General Users

If, when you are about to close a file, you know that the file is to
be printed,
you can issue the CLOSE command with the NOHOLD option:
close printer nohold
The HOLD status of the SPOOL command is overridden for that one file and
it is ~laced on the real printer queue with a NOHOLD status.
If you do not know which files are to be printed
closed, you can use tne QUERY command:

until they are all

query printer
to determine the spoolid numbers of all the closed printer files. Then
issue the CHANGE command to alter the HOLD status of each file to be
release1.
For example, if the file with a spoolid of 0246 is to be
released, enter the command:
change printer 0246 nohold
To change your printer so that all subsequent files
released to the real printer, enter:

are automatically

spool printer nonold
If your virtual reader has the default status NOHOLD, input spool
files are deleted from the system after they have been read.
To prevent
this, enter:
spool reader hold
Reader files are nov held in the system until you issue:
spool reader nohold
and reread
enter:

the files.

If you

want to

delete the

files immediately,

purge reader all
Again, you have the option of using the CHANGE command to control the
HOLD status of specific reader files via the spoolid number.
The
CONT/NOCONT status
of a
spooling
device controls
the
concatenation of files.
Since this is a characteristic of a spooling
device, it can be changed only by the SPOOL command.
When CONT is in
effect, the spoolinq device ignores input end-of-file indicators and
output CLOSE requests.
For output devices, the effect
files into one logical spool file.

is to

concatenate multiple

output

For input devices the effect is to read files and ignore end-of-file
indicators until all files spooled to the virtual reader have been read.
At that time, the end-of-file indicator that is reflected to the virtual
machine depends on the EOF/NOEOF operand setting of the SPOOL READER
command. EOF results in a unit exception that corresponds to pressing
the end-ot-file button on a real card reader.
NOEOF results in a unit
check/intervention required status.

Section 3. CP Command Usage

17

VIRTUAL CONSOLE SPOOLING
While spooling is usually associated with unit record equipment, VM/SP
also spools both input and output data that is displayed on your virtual
console. To start console spooling, enter the command:
SFool console start
If you wish to spool your console data
terminal, you can enter:

and not have it displayed on the

spool console start noterm
Note, however, that the NOTERM operand (or its default value, TERM) is
not effective until console spooling has been started.
Also, the NOTER!
option does not prevent the printing of:
•
•

CP commands entered from CP mode.
Commands entered on a display terminal in eMS EDIT mode.

When you wish to stop console spooling, enter the command:
SFool console stop
This stops any further spooling of console data but does not close the
console spool files.
For that, you must enter the command:
close con so Ie
The converse is also true--closing
automatically stop console spooling.

the

console spool

file does

not

REORDERING AND PURGING SPOOL FILES
If you want to change the sequence of your closed spool files, issue the
ORDER command to place your files in a specific order by device type.
Files can be resequenced by spoolid or class, or both when using the
ORnE R co mmand.
For example:
order printer 2468 1351 class c
resequences your closed printer spool files as follows:
file 2468
file 1351
all class C files (in their original sequence)
other files in original sequence

18

IBM VM/SP CP Command Reference for General Users

To remove any of your closed spool files from the system use the
PURGE command.
Files can be specified individually by spoolid or by
class, or both.
For example:
purge 1234 class b
removes file 1234 and all class B files from the system.
purge punch all
removes all punch files.
purge all
removes all files from all devices.
!Qig: The CHANGE, ORDER,
and PURGE commands can be used only on closed
spool files that belong to you and have not yet been selected for
processing.

DEDICATED DEVICES
If a device's use is restricted to a single virtual machine, that device
is a
dedicated device.
Some devices, such as disks and unit record
equipm~nt;-can-function in dedicated mode at one time and in shared or
nondedicated mode at ether times. Devices such as magnetic tape drives
can only be used as dedicated devices.
The directory
statement in the
generation or a
operator's ATTACH

proqram can dedi.cate a device via a
DEDICATE control
VM/SP directory entry for a virtual machine at system
device can be dedicated dynamically via the system
command.

If the directory entry for your
such as:

virtual machine includes a statement

DEDICATE 495 295
the device at real address of 295 is made available to your virtual
machine as virtual address 495 when you log on to the system.
It
remains dedicated to your virtual machine until you either log off or
releasE the device via the DETACH command:
detach 495
The format of the DEDICATE control statement is described in detail
in "Part 2: Def ini ng Your VM/SP System" of the !.t1L~g R!~!H!i.!!g 2..!!i! ~I.§.j:~
~g.!!~fg!lcn g~ig~.
More than one user can have the same real device
specified as being dedicated to his virtual machine. However, the first
user to log on gains access to the device and others have to wait until
the current user either logs off or releases the device.
If you are using the DEDICATE statement for a ~ASD, you can specify a
particular disk volume by its volume serial number rather than by its
real device address.
This has the effect of not tying you down to a
particular real device.
In the event that a malfunction precludes the
use of the volume on one DASD, the disk pack can be transferred to
another DASD and still be accessed by its volume serial number.

Section 3. CP Command Usage

19

If a device that cannot be shared,
such as a magnetic tape, is not
required for the entire terminal session, it may be more practical to
dedicate it as required. Since the ATTACH command is a class B command
and not usually available to the general user, you can send the system
operator a message:
msg operator pls attach 281 to smith as 181
The operator issues the command:
attach 281 to smith as 181
If the device (assumed
command was completed
response:

to be a magnetic tape)
was available and the
successfully,
you receive the verification

TAPE 181 ATTACHED
When you have no further use for the device, issue the command:
detach 181
You receive the acknowledgment:
TAPE 181 DETACHED
and the device is now available to some other user.
If you do not
DETACH the deVice, it remains dedicated to your virtual machine until
you log off.

DEDICATED CHANNELS
user can have an entire channel with all its devices dedicated to his
virtual machine. CP does not translate device addresses since the
virtual addresses must be the same as the real device addresses.
Contention for use of the channel is minimized, since all of the channel
resources are dedicated to a single virtual machine. The ATTACH CHANNEL
command is a class B command and is not usually available to the general
user.
However, you can send a messaqe to the system resource operator:
!

msq operator pIs attach channel 2 to smith
If the channel is available, the operator issues:
attach channel 2 to smith
and the command has been successfully completed, you are notified by the
response:
CHANNEL 2 ATTACHED
When a dedicated channel path is DO longer
I/O operations, you can issue the command:

requi~ed

for virtual machine

detach channel 2
After the channel is detached, the following
the primary system operator:

message is sent to you and

CHANNEL 2 DETACHED userid

20

IBM

V~/SP

CP Command Reference for General Users

Controlling the Virtual Machine
VK/SP provides several commands with which you can load an operating
system into your virtual machine, simulate hardware interruptions to
your
virtual machine, enter CP commands while in a virtual machine
envircnment, and reconfiqure your virtual machine dynamically during a
terminal session.

LOADING AN OPERATING SYSTEK
At the completion of the LOGON procedure, you have a virtual machine of
a predetermined configuration at your disposal.
As with a real machine,
its use is limited without an operating system. An operating system can
te loaded via the IPL command or automatically at logon time if an IPL
control statement is ircluded in your virtual machine's directory entry.
When a virtual machine runs the same operating system with very few
exceptions, it may be expedient to use automatic loading. If the VM/SP
directory entries for your userid include an 1PL control statement with
the name or the virtual address of a specific system to be loaded, that
3ystem is automatically loaded when you log on to VM/SP unless you issue
the LOGON command as:
legon userid noipl
in which case, the automatic loading does not take Flace and you can IPL
any su p~orted system that is available ...
A more flexible apFroach is loading an operating system via the IPL
command. Again you have a choice.
You can IPL by device address or by
system name. If you 1PL by the virtual uddress of the device containing
the operating system, you can a1Eo clear virtual storaqe to binary zeros
before loading the system:
ipl 190 clear
This facility can be useful if your operating system
automatically clear storage when it is loaded.

does

not

You can stop the 1PL procedure at a point just before the initial PSi
is loaded by issuing the IPL command with the STOP operand:
ipl 190 clear stop
At this point, you can issue CP commands to display or alter data in
your nucleus. To restart the virtual machine, issue the command:
begin
You can load your operating system by name provided that the name
refers to a system that has been previously saved by your installation's
system programmer. As an example:
ipl dosvs
If you do load by name,
the options to clear
before loading the initial PSi are not available.

storage or

to stop

section 3. CP Command Usage

21

Whether you IPL by device address or by name, you can pass up to 64
bytes of data (including embedded and trailing blanks) to your operating
system via the IPL command.
The data is entered following the keyword
PARM ~
ipl dosvs parm this data will be passed
VM/SP loads the general registers, starting with register zero with
the contents of the command line beginning with the first nonblank
character after the keyword PARM and ending with the last character or
blank entered.
Embedded and trailing blanks are passed.
For the
previous example, the general registers contain the following:
GPR 0
GPR 4
GPR 8
GPR 12

THIS
E PA
xxxx
xxxx

DAT
SSED
xxxx
xxxx

A WI
xxxx
xxxx
xxxx

LL B
xxxx
xxxx
xxxx

where x x ••• denotes no change to previous contents.
If you ha d entered three blank characters following the word "passed"
in the command line, the registers would contain:
GPR 0
GPR 4
GPR 8
GPR 12

THIS
E PA
xxxx
xxxx

DAT
SSED
xxxx
xxxx

A WI

x
xxxx
xxxx

LL B
xxxx
xxxx
xxxx

For further information on the PARM operand, refer to the "Usage Notes"
discussion of the IPL command in Section 5.

S IMU LAT ING INTERRUPT S
The EXTERNAL command can be used to simulate an external interruption to
the virtual machine and return control to that virtual machine. If you
enter the command:
external
a default interrupt code of X'40' is assumed. This code corresponds to
pressing the external interrupt key on the real system control panel ..
You can also specify an interruption code within the range of X'Ol'
through X'FF':
external A8
If your virtual machine has the ECMODE option specified in the VM/SP
directory, you can also code X'1004' (clock comparator interruption) and
X'1005' (CPU timer interruption). The interruption code that you enter
or default to# is placed in position 16 through 31 of the PSi if you are
operating in basic control (BC) mode.
If your machine is in extended
control (EC) mode, the interruption code is placed in the two bytes at
location X'84'.
An external interruption is then presented to your
virtual machine and subsequent action is determined by your operating
system.
!Qte: If your virtual machine is operating in the basic control mode
(ECMODE OFF),
virtual addresses specified can be no higher than 5FF
(channels 0 through 5). If i t is operating in extended control mode
(ECMODE ON), all addresses through FFF are valid.

22

IBM VM/SP CP Command Reference for General Users

The attention or request keys on the real console can be simulated by
the CP commands:
attn
-- or
request
In either case, the effect is to interrupt the running condition of the
virtual machine and ready it for console in~ut.

ENTERING CP COMMANDS
There are several ways that you can interrupt the running of your
virtual machine in order to execute CP commands. You can stop the
virtual machine and place it in a virtual console read environment; you
can qo from a virtual console read environment to the CP environment;
and, you can stop a virtual macbine and ~lace it directly into the CP
environment.
ENTERING CP COMMANDS WHEN THE VIRTUAL MACHINE IS RUNNING
If your terminal mode is set to VM, pressing the attention key (or its
equivalent)
once stops the virtual machine and places it into the
virtual console read environment.
You can now execute CP commands by
enterinq one or more command lines as operands of the tcp command; for
exam pIe:
.cp query time
-- or -'cp query timet query users
where the
entered.

latter example

!Qlg: The pound

shows how

multiple CP

command lines

sign ct) in these examFles represents
end character currently in effect.

can be

the logical line

If you are using a 3210 display terminal where the keyboard is not
activated when the virtual machine is running, you can enter either of
the following ccmmands:
tcp attn
or -.cp request
to both simulate an attention interrupt for your virtual machine and
place it in a virtual console read environment.
On a 3210 terminal, you
can alEo enter a command such as:
tcp query time
while

the

virtual machine is running.
The centrol program
(CP)
the virtual machine, executes the CP command, and restarts
the virtual machine.

interru~ts

Section 3. CP Command Usage

23

The fCP command, entered without any command line operands, places
the v~rtual machine in the CP environment. You can then enter CP
commands directlv. Fer example, the following sequence:
tcp
query time
query users
places you in CP mode and then executes the two CP commands.
To restart the virtual machine, enter:
begin

ENTERING CP COMMANDS FROM THE VIRTUAL CONSOLE READ ENVIRONMENT
When your virtual machine is stopped and in a console read environment,
you can either enter CP commands directly or you can place the virtual
machine in the CP console function mode.
To execute CP commands directly, enter one or more CP command lines
as operands of the tcp command. For example, if you enter:
#cp query timet query users
the virtual machine executes the QUERY TIME and QUERY USERS commands and
~eturns to
the virtual console read environment. You can restart the
virtual machine by entering the command:
#cp begin
I f
you enter the tcp command without any
machine is placed in CP console function mode.
commands such as:

operands, the virtual
You can then enter CP

query time
-- or -query users
directly. After each command,
console function mode.

the virtual machine

returns to

the CP

Entering the command:
begin
returns the virtual
command was issued
envi ronment.

24

machine
in

to the environment from which the 'CP
this case r
the
virtual console read

IBM VM/SP CP Command Reference for General Users

ENTERING CP COMMANDS FROM CP CONSOLE FUNCTION MODE
When you are in CP console function mode, you can enter CP commands such
as:
query time
-- or -query users
1irectly, and you remain in CP mode until you issue the command:
begin
The BEGIN command returns you to the environment from which you entered
the #CP command that placed you in CP mode.
This would be either the
virtual machine executing or the virtual console read environment.

RECONFIGURING THE VIRTUAL MACHINE
You can alter your virtual machine configuration (stored in the VM/SP
directory) to conform to specific situations that arise.
Some examples
are: a
seldom used compiler may need additional disk work area or a
larger virtual storage.
A new application program in test status may
need additional I/O devices or require a different channel mode of
operation.
The CP DEFINE command allows you to change your configuration
temporarily for the current terminal session.
For example:
define reader OOb
temporarily adds a card reader at virtual address OOB.

The entry:

define t3330 as 291 cyl 125
adds a temporary
address 291.

virtual disk,

containing 125

cylinders, at

virtual

If your virtual machine is operating in basic control (BC) mode (that
is, your virtual machine uses a maximum of 6 channels, 0 through 5), you
can only define virtual devices with addresses up through 5FF; in
extended control (Ee) mode, you can use all addresses through FFF.
You can enter:
define storage as 768k
to temporarily change the virtual storage size of your virtual machin.e
to 768K (K=1024 bytes). When you redefine stora~e, your virtual machine
is automatically reset and you must reload your operating system.
!Q!~:

When defining virtual devices, you must be careful to specify
virtual addresses that do not result in conflict or contention in the
virtual control unit interface.

For example,
when using the SPOOL, DEDICATE and SPECIAL directory
control statements to define virtual devices, specify virtual addresses
that do not conflict or contend with the virtual control unit interface.
This conflict or contention occurs because devices can require special
Section 3. CP Command Usage

25

I/O interface protocol from control units such as shared and nonshared
subchannel operations. Putting devices that require different real
control units on the
same virtual control unit can result in a hung or
busy condition.
To avoid this problem, users must define (and separate)
device within their own control unit range.
For example, if the
directory entry specifies:
S POOL 1 02 3 2 11
SPECIAL 103 3270
the control unit 0 on channel 1 controls both a nonshared device (the
3211 printer) and a shared device (the 3270 display unit). Processing
of channel programs involving these two devices can result in a hung or
busy condi tion.

Testing and Debugging of Programs
In addition to the testing and debugging facilities that are contained
in your virtual machine's operating system,
VM/SP has several CP
commands that you can use. These commands can be used to locate,
display, trace, and alter the program instructions that are executing in
your virtual storage.
In the following discussions of the ADSTOP, DISPLAY, DUMP, STORE, and
TRACE commands, it is important that you understand the levels of
storage you can specify on the command line.
First level storage is real main storage.
Only second level storage
(storage that is real to the virtual machine) can be handled directly.
This includes the V=R partitions or regions of DOS/VS, VSE systems, and
OS/VS as well as storage in OS/PCP, MFT, and MVT.
The V=V partitions or
reaions of DOS/VS, VSE systems, and OS/VS constitute third level storage
and cannot be specified directly. The user, or the virtual operating
system, is responsible for converting any second level storage addresses
to first level storage addresses before including them in the specific
command line.

STOPPING EXECUTION OF YOUR VIRTUAL MACHINE
To stop execution of your virtual machine at a given address in virtual
storage, use the ADSTOP command and specify the hexadecimal address of a
virt ual instruction.
The command:
.cp adstop 3000
stops the virtual machine when the instruction
3000 is the next instruction to be executed.
running, you receive the message:

at hexadecimal location
When the machine stops

ADSTOP AT 3000
and your terminal is placed in CP console function mode.
At this point,
you can enter other CP debugging commands to display and alter storage
or to trace certain instructions.
When you want to resume running your
virtual machine, enter:
begin

26

IBM VM/SP CP Command Reference for General Users

Unlike the hardware address stop, ADSTOP is turned off when:
•
•
•
•

The requested address is reached.
The next ADS TOP command is issued.
An IPL or a system reset is performed.
The ADSTOP OFF command is issued.

While ADSTOP is on, the SVC portion of virtual machine assist is not
executed. When ADSTOP is turned off, SVcs are again handled by virtual
machine assist.

DISPLAYING VIRTUAL STORAGE
The contents of virtual storage, storage keys, general registers,
floating-point registers, control registers (if in EC mode), PSW, CAW,
and csw can be displayed on your terminal via the DISPLAY command. All
but the CAW and CSW can be printed on the spooled virtual printer via
the DUMP command.
Using the V~DUMP c~mmand,
you can also produce
formatted storage dumps of guest virtual storage when your installation
has the VK/IPCS Extension program product.
5.

The DISPLAY, DUMP and VMDUMP commands are fully described in Section
The examples that follow do not attempt to show all possible uses.

TERMINAL OUTPUT
With the DISPLAY command,
you can display
terminal in either of the following formats:

virtual

storage at

your

•

Four byte groups, aligned on fullword boundaries, hexadecimal format,
printed four full words per line.

•

16 byte groups, aligned on
16 byte boundaries,
hexadecimal format,
printed four fullwords plus EBCDIC translation per line.
For the first format, enter the DISPLAY command as:
display 1026-102c

you receive the response:
001024 xxxxxxxx xxxxxxxx xxxxxxxx
For the second format, enter the command as:
display t1026-102c
and the response is:
(EBCDIC trans.)

001020 xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx
You can also specify the area of
a hexadecimal byte count such as:

*................ *

storage to be displayed by entering

display 1024.12

section 3. CP Command Usage

27

The response displays 20 bytes as follows:
001024 XXXXXXXX XXXXXXXX XXXXIX!! XXXXXXXX
001034 xxxxxxxx

BYTE ALIGNMENT ON TERMINAL OUTPUT
The previous responses illustrate the byte alignment that takes place in
each of the two display formats.

If the first location to be displayed is not on the appropriate 4 or
16 byte boundary, it is rounded down to the next lover boundary that
applies.
If the last location to be displayed does not fall at the end of the
appropriate 4 or 16 byte group, it is rounded up to the end of that
group.
If you enter:
d~splay

k1024-3200

the storaqe keys that are assigned to each 2K segment of the specified
storage area are displayed.
Contiguous 2K segment with
identical
storage keys are combined; for example, the response could have been:
001000 TO 0021F'F
00 2 800 TO GO 3 80 0

KEY=FO
KEY=EO

To display all storage keys, enter:
display k

If your virtual machine is in extended control mode
interrogate any of the control registers:

(ECMODE), you can

dis pIa y X 1 4 A
and receive the response:
ECi 1 = XXXXXXXX
ECR 4 = xxxxxxxx
ECR 10 = XXXXXKXX
However, the same
command entered while your virtual
in extended control mode results in the response:
ECR 0
ECR 0
ECB 0

=
=
=

machine is not

XXXXXXXX

xxxxxxxx
XXXXXXXX

As each operand in the command line is processed,
V~/SP determines
that ECMODE is OFF and replaces any reference to a control register with
ECR 0, the only control register available in basic control (Be) mode.

28

IBM VM/SP CP Command Reference for General Users

PRINTER OUTPUT
With the DUMP command you can dump the contents of all registers, the
PSi and the storage keys,
along with any specified area of virtual
storage, to the virtual machine's spooled printer.
The printer format
for storage locations is 8 fullwords
per line plus the EECDIC
translation on the right.
To print only the registers, the PSW,
only enter:

and the storage keys, you need

dump 0
To also print an area of virtual storage,
beginning and ending hexadecimal locations:

you

can specify

the

dump 1064-10ff
You can also specify the beginning location and the
to be dumped; both values are entered in hexadecimal:

number of bytes

dump 1064. 9b
If you are printing a series of dumps, you can identify each one by
including its identification on the DUMP command line, following an
aste risk:
dump 1000-2000

*

dump no.

1

To print the dump data on the real printer you
virtual printer.
Issue the command:

must first close the

close printer
and the dump data spool file is
queu e.

placed on an appropriate system printer

In addition, if your installation has the VM/IPCS Extension program
product installed, you can use the VMDUMP command that dumps storage for
guest virtual machines.
VMDUMP provides the VM/IPCS Extension with
header information to identify the owner of the dump; it also maintains
dump information, writes the dump to a spool file, and formats the dump.
When you enter at the terminal
vmdump 150-200
or
vmdump 400:500
CP dumps the contents of virtual machine storage at the hexadecimal
addresses between 150 and 200 or between 400 and 500, respectively.
I f you enter
vmdump 150.50
CP dumps the contents of virtual storage starting at hexadecimal address
150 for a total of X'50' bytes.

section 3. CP Command Usage

29

ALTERING VIRTUAL STORAGE
You can alter the contents of your first level virtual storage, general
registers, floating-point registers, control registers
(if available),
and the PSW with the STORE command.
Virtual storage can be altered in either fullword or byte units.
When using fullword units, the address of the first
stored must have either an L or no prefix:

positions to be

store 1024 46a2
or
store 11024 46a2
results in 000046A2 being stored in locations 1024 through 1027.
store 1024 46 a2
on the other hand,
implies storing 2 fullwords and results in
storing of 00000046000000A2 in locations 1024 through 102B.

the

If the starting location is not a multiple of a fullword, it is
automatically rounded down to the next lower full word boundary. Each
fullword operand can be from one to eight hexadecimal characters in
length.
If less than 8 characters are specified, they are right
justified in the fullwcrd unit and padded to the left with zeros.
You can store in byte units by prefixing the start address with an S.
store 51026 dld6c5
stores D1D6C5 in locations 1026, 1027, and 1028. Note that the data
storage is byte aligned. If an odd number of hexadecimal characters is
specified, CP does not store the last character, you receive an error
message, and CP terminates the function.
For example, if you specify:
store s1026 d1d6c
CP stores d1 at X'1026', and d6 at X'1027'; when CP attempts to store c
at X'1028', it recognizes an incomplete hexadecimal character, and does
not store the last character.
You can store data into one or multiple consecutive registers.
General
example,

and centrol

registers are

loaded in

fullword units.

For

store 94 123456
loads general register 4 with 00123456.
store g4 12 34 56
loads general registers 4,
00000056, respectively.

30

5,

and

6

with 00000012,

IBM VM/SP CP Command Reference for General Users

00000034,

and

Floating-point registers are loaded in doubleword units.
Each
doubleword operand can be from 1 to 16 hexadecimal characters in length.
If less than 16 characters are specified, they are left justified in the
doubleword unit and padded to the right with zeros. For example:
store y2 00123456789
loads floating-point register 2
You can use
hardware store
in permanently
be in extended

~ith

the value 0012345678900000.

the STATUS operand of the STORE command to simulate the
status facility.
Selected virtual machine data is stored
assigned areas in low storage. Your virtual machine must
control mode for the command:

store status
to be accepted.
To place your virtual machine in extended control mode,
issue the command:
set ecmode on
Be aware that this command resets your virtual machine
reload (IPL) your operating system.
The data stored by
followinq table:
Virtual
Dec.

------216
224
256
352
384
q48

Address
Hex.

------D8
EO
100
160
180
lCO

the STORE
No. of
bytes
-----8
8
8
32
64
64

STATUS command

and you must

is summarized

in the

Data

------------

Processor Timer
Clock Comparator
Current PSW
Floating-Point Registers (0, 2, 4, and 6)
General Registers (0-15)
Control Registers (0-15)

!Q~:

If the operating system that is running in your virtual machine
operates in the basic control mode, these areas of low storage may be
used for other purposes. You should not use this facility under these
conditions.

TRACING VIRTUAL MACHINE ACTIVITY
The TRACE command allows you to trace certain virtual machine activities
and record the results on either your terminal or the virtual printer,
or on both.
You can trace
activities:
•
•
•
•
•
•
•
•

anyone or

more of

the

following virtual

machine

SVC interru~tions
I/O interruptions
Program interruptions
External interruptions
Privileged instructions
PSW instructions
Successful branches
Instruction execution

Section 3. CP Command Usage

31

!Qte: When MVS/System Extensions support is enabled, VM/SP trace output
may have qaps in the tracing sequences. Each qap represents a period
when VM/SP tracinq was interrupted.
VM/SP
stops
tracing
an
activity
when
a
virtual-machineextended-facility
assist
instruction
results
in
a
branch.
(Virtual-machine-extended-facility assist instructions are described in
the publication I~~ ~~!~~Ll1Q ~~l~ng~g !g~iliiI, GA22-7022.)
Tracing
resumes when these two conditions are met:
1.

When CP gains control, such as for a real I/O interruption.
--and--

2.

When the virtual machine encounters one of the specified activities
to be traced, except for successful branching.

Whenever you are recording trace output at your terminal, the virtual
machine stops execution and enters the CP console read environment after
each output line.
This is the default mode of operation when, for
example, you enter:
trace all
-- or
trace svc program branch
T~ you only want
to record the trace and not stop after each output
line, add the RUN operand as the last entry on the command line.

If, having specified multiple activities to
stop tracing one or more of them, enter:

be traced, you decide to

trace program branch off
and tracing is now confined to SVCs only.
To trace all activity
printer, enter:

with

the

output

directed to

the

virtual

trace all printer
When you stop tracing, you must also issue the CLOSE command to print
the spooled trace output on the real printer:
trace end
close printer
If your virtual machine configuration contains only one printer,
trace output is intermixed with application output.
You should define
another virtual printer with an address lower than the previously
defined printer.
Application output is still directed to the original
printer; however, trace output is always directed to the printer with
the lowest address.
For a complete description of the TRACE command
alonq with the trace output formats,
see discussion of the command in
Sect ion 5.
While trace is running,
portions of virtual machine assist are
disabled.
When the
trace is complete, they are enabled.
For more
information, see the TRACE command discussion in Section 5.

32

IBM VM/SP CP Command Reference for General Users

Part 2. Reference Information

Part 2 contains reference information.

It consists of two sections:

"Section 4. Notational Conventions" describes the syntax that is used
in this publication to dis~lay command formats.
the
The
Any
are

"Section 5.
Format of CP Commands" contains reference data for all
class G and Any commands in alphabetical sequence by command nalle.
command line format includes all operands and a description of each.
limits or restrictions applicable to the values of variable operands
also defined.

Part 2. Reference Information

33

34

IBM VK/SP CP Command Reference for General Users

Section 4. Notational Conventions

The notation used to define the command syntax for VM/SP is:
•

Truncations and Abbreviations of Commands and Operands
Where truncation of a command name is permitted, the shortest
acceptable version of
the command is represented by uppercase
letters.
(Remember, however, that VK/SP commands can be entered with
any combination of uppercase and lowercase letters.)
The following examples show the format specifications as used:
Display

INDica te

DISConn

The format for Display means that 0, 01, DIS, DISP, DISPL, DISPLA,
and DISPLAY can be used.
The format for INDicate means that IND,
INDI, INDIC, INDICA, INDICAT, and INDICATE can be typed.
The format
for DISConn means that DISC, DISCO, DISCON, and DISCONN can be used.
Each of the examples given are shown with the valid specifications
for the command name.
Operands are specified in the same manner.
Where truncation is
permitted,
the shortest acceptable version
of the operand is
represented by uppercase letters in the command format box.
If no
minimum truncation is noted, the entire word
(represented by all
capital letters) must be entered.
Abbreviations are shorter forms of command names and operands.
Abbreviations for command names are shown below the full name in the
format box.
Abbreviations for operands are shown in the description
of the individual operands that follows the format box. For example,
the operand READER has both a minimum truncation and an abbreviation.
In the format box, it is shown as:
Reader
indicating that the minimum truncation is R.
In the discussion of
the READER operand that follows the format block, i t is shown as:
READER
RDR
indicating that the abbreviation is RDR.
Thus, the acceptable
specifications for the READER operand are: R, RE,
REA, REAt, READE,
READER, and RDll.
•

The following symbols are used to define the command format
should never be typed when the actual command is entered.
underscore
braces
brackets
ellipsis

and

{ }
( ]

Section 4. Notational Conventions

35

•

Uppercase letters and words, and the following symbols,
entered as specified in the format box.
asterisk
comma
hyphen
equal sign
parentheses
period
colon

should be

*,
=
( )

•

Lowercase letters, words, and symbols that appear in the command
format box represent variables for which specific information should
be substituted. For example, "hexloc" indicates that a hexadecimal
storage location address is to be entered.

•

Choices are represented in the command format boxes by stacking.
A
B
C

•

An underscore indicates an assumed default. If an underscored choice
is desired, it need not be specified when the command is entered.
~X2:!.Ele

The representation
A
§
C

indicates that either A, B, or C may be selected.
However, if B is
selected, it need not be specified. Or, if none is entered, B is
assumed.
•

The use of braces denotes choices, one of which !Y§i be selected.
:§.!gJ!!,Ele

The representation

{~ }
indicates that you ~st specify either A, or B, or C.
choices is enclosed by neither brackets or braces,
treated as if enclosed by braces.

•

The use of brackets denotes choices, one of which

~aI

If a list of
it is to be
be selected.

:§.!g.!,E Ie

The representation
r

,

i A i
, B I
I C I
L

.J

indicates that you may enter A, B, or C, or you may omit the field.

36

IBM VM/SP CP Command Reference for General Users

•

In instances where there are nested braces or brackets on the text
lines. the following rule applies; nested operand selection is
dependent upon the selection of the operand of a higher level of
nest inq.
~.!~1!!.Ele:

Nestinq levels are represented as follows
[Level 1

(Level 2

(Level 3 ]])

Wher e tbe hiqhest level of nesting is the 0 perand that is enclosed in
only one pair of
brackets and the lowest level of nesting is the
operand that is enclosed by the maximum number of brackets.
As
noted. our rule states:
the higher level of nesting must be selected
in order to select the next level (lower level) operand.

•

An ellipsis indicates that the preceding item or group
be repeated more than once in succession.

of items may

~.!!.!.Ele

The representation
{spoolid1 spoolid2 ••• }

indicates that .ore than one spoolid may be coded within the braces.

Section 4. Notational Conventions

37

38

IBM VM/SP CP Command Ref€rence for General Users

Section 5. Format of CP Commands

The command formats are described in alphabetical order except for
special characters such as the asterisk
(*) and the pound sign ('),
which appear first.
The command formats are presented in the following order:
•

Command Name: Identifies the name of the command. The
included at the top of the page for easy reference.

•

Privilege Class: States the privilege class
G.

•

Description of Function: Describes the use.

•

Syntax: Lists the syntax
operands that you can use.

•

Operand Description: Describes the function of each
values that you can include in the operand.

•

Usaqe Notes:
contains notes about special uses of the
operands, or combinations of commands or operands.

•

Respcnses: Describes the CP responses sent to the terminal, caused
by execution of the command. These responses are command responses
and are not to be construed as VK/SP system messages.
The command
res~onses are not prefixed and, therefore,
they are not containe~ in
!!L§R ~lst~~ Me§§~~§
sng ~Qde§.
Only CP
command responses
applicable to the class G and class Any user are contained in this
publication.

of

the

command

name is also

of the command as Any or

with all

the

possible

operand and any
command, its

!Qte: The execution of certain commands may produce system messages.
Refer to !~L§f ~I2i~~ ~g§§~g§ ~ng £Qg~§ for information on system
message formats and user action.

section 5. Format of CP Commands

39

*

Use the
display
virtual
for the

asterisk (*) to annotate the terminal console sheet or terminal
screen data with a comment. This commentary also appears in the
console spool file (if the console spooling function is invoked
virtual machine). The format of the
(comment) command is:

*

r

anycomment

*

None.

40

IBM VM/SP CP Command Reference for General Users

#CP

#CP

Use the #CP command to execute a CP command while in a virtual machine
command environment without first signaling attention to get to the CP
command environment.
The format of the #CP command is:
r----I #CP ,

(commandline1 (#commandline2 i ... ]]

L--

cornman dline

specifies the name and operands for the CP command or
commands you want to issue.
You must precede the first
commandline with at least one blank.

1.

The pound sign (t)
shown in the preceding format represents the
logical line end symbol and is the default supplied by VM/SP.
However, your installation may wish to redefine the logical linend
symbol. If you have redefined the logical line end symbol, #CP is
an invalid command; you must substitute your line end symbol for
the pound sign when using this command.

2.

For the command to operate, the following conditions must be met:
•

The virtual
default) •

machine must

be operating with

SET LINEDIT

ON (a

•

The first three characters of the edited line must be #CP
(uppercase or lowercase)
with the "#" representing the logical
line end symbol currently defined.

•

At least one blank must separate the #CP from any command line.
Do not use attention interruption in any part of the line or to
enter t he Ii ne.

•

If in a virtual machine command environment, the virtual machine
must have issued a READ for at least four bytes of data. If the
BEAD is for less than three bytes, you must use the attention
key to enter the CP environment.

3.

You can enter multiple command lines as operands of the #CP
provided that
(a) the virtual machine's console READ is
least the number of bytes required to enter the entire line
all command lines to be executed must be separated by the
logical line end symbol.

command
for at
and (b)
current

4.

If you enter #CP with no operands, the virtual machine enters the
CP environment.
CP cancels the virtual machine's console BEAD by
returning a unit exception status for the virtual console. The
virtual operating system then reissues the console READ to allow
you to key in the appropriate response to a previous message from
that machine's operatinq system.

Section 5. Format of CP Commands

41

#CP

5.

If you issue the TERMINAL APL ON command on a keyboard equipped
with APL characters, and then issue a tcp command during your APL
session, CP does not translate the iCP command. When APL is ON, CP
uses a different set of translation tables and does not recognize
the pound sign (#) as a logical line end symbol.

r

Command

f

system Action

tcp

Your virtual machine enters
CP environment.

tcp query files

QUERY command executed.

iCP query filesiquery users

Two separate QUERY commands
executed.

data enteredttCP msg op is tape
available

"Data entered" is ignored. You
send a message to the
operator.

'# CP data entered

You enter CP environment and
CP interprets "data entered"
as an invalid operand.

data enteredttCP

"Data entered" is ignored. You
enter CP environment.

#CP query filestdata entered

QUERY command is not executed;
console input (data entered)
passes to the virtual machine.

Figure 5.

----------'

System Action to #CP Command

If you enter #CP without a commandline, you receive this message:
CP
If you enter
tcp with commandlines, you
receive
appropriate to the individual commands you entered.

42

IBM VK/SP CP Command Reference for General Users

the

responses

ADSTOP

ADSTOP

Use the ADSTO~ command to halt the execution of a virtual machine at a
virtual instruction address. Execution halts when the instruction at
the address specified in the command is the next instruction to be
executed. Only one ADSTOP ccmmand can be in effect at a given time. If
a second ADSTOP command is issued, the previous ADSTOP setting is
canceled. The format of the ADSTOP command is:
r

ADSTOP

hexloc }
{ OFF

L __________________________________________________________________- - - - J

hexloc

is the hexadecimal representation of the
address where ~xecution is to be halted.

OFF

cancels any previous ADSTOP setting.

1.

2.

virtual instruction

When execution halts, the CP command mode is entered and a message
is displayed.
At this point, you may invoke other CP debugging
ccmmands.
To resume operation of the virtual machine, issue the
BEGIN command.
Once an ADSTOP location is set, it is removed
(turned off) by the following:
•

Reaching the
command

virtual storage location

specified in

•

Performing a virtual IPL or SYSTEM RESET

•

Issuing the ADSTOP OFF command

•

Specifying a different location with a new ADSTOP hexloc command

Since the ADSTOP function modifies storage by placing
X'B3' at th~ specified location, you should not:

the ADSTOP

a CP

SVC

•

Designate an address within a shared segment.
If a shared
segment is modified by an ADSTOP command, a warning message is
issued to the user and the virtual machine is unshared from
(given a ~rivate copy of) the named system. Other users of the
segment continue to operate with an unchanged copy of that
segment.

•

Use the TRACE command with the INSTRUCT, BRANCH, or ALL operands
when a traced instruction is located at the ADSTOP address.

Section 5. Format of CP Commands

43

ADSTOP

3.

Address stop (ADSTOP hexloc) is specified as a virtual machine real
address.
For OS/VS or DOS/YS, the specified address must be in
fixed storage.
Movement of the page containing the ADSTOP can
cause erroneous processing because the resulting SVC X'B3' is
pr'~sen ted to the virtual machine for handling.

4.

If the SYC handling portion of the virtual machine assist feature
is enabled on your virtual machine, CP turns it off when an ADSTOP
is set.
When the address stop is removed~ CP returns the assist
feature SVC handling to its previous status.

5.

Issue the SET RUN OFF command before the ADSTOP command.

ADSTOP AT xxxxxx
The instruction whose address is xxxxxx is the next instruction
scheduled for execution.
The virtual machine is in a stopped
state. Any CP command (including an ADSTOP command to set the next
address stop) can be issued. Enter the CP command BEGIN to resume
execution at the instruction location xxxxxx, or at any other
location desired.

44

IBM VM/SP CP Command Reference for General Users

ATTN

ATTN

Use the ATTN command to make an attention interruption
virtual console. The format of the ATTN command is:

pending at your

ATTN

1.

The REQUEST command perfo~ms the same function
ccmmands can be used interchangeably.

as ATTN;

the two

2.

The BEGIN command is not required after you issue ATTN.

3.

CP iqnores the ATTN and REQUEST commands if an I/O operation is in
progress at the ccnsole or if other interrupts are pending for your
virtual machine. This condition may result if you issue the ATTN
or REQUEST command by means of DIAGNOSE X'S'.

None.

Section 5. Format of CP Commands

45

BEGIN

BEGIN

Use the BEGIN command to continue or resume execution in the virtual
machine at either a specified storage location or the location pointed
to by the virtual machine's current program status word (PSW).
The
format of the BEGIN command is:
r-

t

Begin

(hexloc ]

_ _ _ _ _ _ _ _ _ ---1

L-

hexloc

is the hexadecimal
begin.

storage location

where

execution is

to

1.

When BEGIN is issued without hexloc, execution begins at the
storage address pointed to by the current virtual machine PSi.
Unless the PSi has been altered since the CP command mode was
entered, the location stored in the PSi is the location where the
virtual machine stopped.

2.

When BEGIN is issued with a storage location specified, execution
begins at the specified storaqe location. Toe specified address
replaces the instruction address in the PSi, then the PSW is
loaded.

None.

46

The virtual machine begins execution.

IBM VM/SP CP Command Reference for General Users

CHANGE

CHANGE

Use the CHANGE command to alter one or more of the external attributes
of a closed spool file or files. The format of the CHANGE command is:
r

CHanqe

Reader
Class cl
~l CLass c2
Pri nter spoolid
r
,
,HOld
,
PUnch
[ FORM form 1
ALL
,NOHold I
L

1

r

,

, NAm e { . f n [ f t ] } I
I
dsname
I
L

..J

..J

Dlst dist
COpy (* ]nnn
FLash name nnn
'MOdify name
CHars name
FCB name
FORM form2

I
,lane of these operands mu§! be chosen; however, more than one may be
,specified. They may be combined in any order on the command line,
, except for NAME which, if specified, must be the last entry in the
t
I command line.
This is contrary to the notation normally used in thisl
, publication.
t

L---__________________________________________________________

,

'READER
RDR

changes reader spool files.

PRINTER
PRT

cbanges printer spool files.

PUNCH
PCH

changes punch spool files.

CLAS S cl

designates an
existing class.
The
class, c 1,
one-character alphameric field from A through Z or
through 9.
Refer to the VMLSP ~Bg~~to~~§ Guig~
detailed description of spool classes.

spoolid

is the spoolid number of the file that is to be changed.

is a
from 0
for a

FORK'form1 is a one to eight character alphameric form name.
Use the
form name to select those files you want to change.
All form
names are defined by your installation at system generation
time.
ALL

changes all your spool files.

CLASS c2

changes the spool class of the file to c2.

HOLD
//

prevents the file from being printed, punched, or read until
it is released.
The file is released when the CHANGE command
is issued with the NOHOLD operand specified.

"

NOHOLD

releases the specified file from user HOLD status.

Section 5. Format of CP Commands

47

CHANGE
DIST dist
changes the
distribution code specified in
the VM/SP
directory to the distcode specified on the command line, for
the specified file only. The distribution code appears on
the output separators of the printer and punch output; it has
no effect on reader files.
COPY(*]nnn specifies the number of copies cf the file you want spooled
to the virtual output device.
The option is valid for
printer and punch files only. The value of nnn
(number of
copies) must be a number from 1 through 255. Leading zeroes
are optional. The optional asterisk
(*) can be specified on
files to be spooled to the 3800 printer. The asterisk (*)
forces the 3800 printer to perform the file duplication
internally one
page at a
time.
This
option avoids
retransmission of the print file to the virtual output device
every time a copy is desired.
FLAS H na me n nn
siqnifies that a forms overlay contained in the 3800 printer
be superimposed onto certain pages of the output. The name,
one to four characters, identifies the forms overlay to be
used in the projection. The number nnn can be anything from
o to 255.
The number specifies the first nnn copies of
output are to be superimposed. For example, if you specify
COpy 4 FLASH name 2, the first 2 copies of your file are
flashed, while the last two copies remain unflashed.
The
default, 0, indicates no superimFosinq is desired.
MODIFY name
assigns a copy modification module to be used when printing a
file on the 3800. This function makes it possible to alter
text by either preventing printing of certain information or
adding labels to output.
The name must be one to four
characters. If the name is omitted, the file prints normally
without modification.
CHARS name
specifies the character arrangement table used when printing
a file.
The name mUEt be from one to four characterS.
FCB name
controls the vertical spacing of output
must be from one to four characters.

on a page.

The name

FORM form2
changes the spool form name of the file to form2.
NAME

fn (ft]
assigns identification to the spool file in the eMS format
filename and filetype.
The field,
fn, is a one- to
eight-character alphameric filename assigned to the file for
identification.
Th.e field, ft, is a one- to eight-character
alphameric filetype assigned to the file for identification.
If ft is not specified, the filetype is set to blanks.

NAME

dsname
assigns identification to the spool file in a non-eMS format.
The field, dsname, is a. 1- to 24-character field suitable for
specifyinq OS or DOS files (for example, SYS1.SYSLIB.MYMAC).

48

IBM VM/SP CP Command Reference for General Users

CHANGE

t~e

1.

Issue
file.

QUERY command to determine

the current attributes of the

2.

If you want to change an output file,
the file must have
closed but not yet selected for printing or punching.

3.

You can change an input (READER) file at any time before it is
opened; that is, before CP issues the first read for the file.

4.

Use the QUERY command
fi lese

5.

Your system proqrammer can define
certain spool classes to
automatically print certain classification titles (for, example,
TOP PBIORITY or CONFIDENTIAL).
The title prints on the separator
paqe, and,
optionally, at the bottom of each printed page. Ask
your system programmer if he has defined certain classes for this
function, or request that classes be defined.
For example, you may
wish class P to print TOP PRIORITY on the separator page, and class
X to print CONFIDENTIAL on the separator page and also on the
bottom of each page of output.

6.

In order to print on the 3800, the name you specify in the FLASH
oFtion must match the FLASH name the VM/SP operator specifies in
the START command, unless the FLASH number nnn is zero.
If you
specify a zero for the PLASH number or you omit the FLASH option, a
file still prints on the 3800 as long as the spool file class
matches the print class designated by the installation for the
3800.
If you fail to meet these requirements, CP submits the spool
file to anothec printer and the special 3800 print options are
iqnored.

7.

When a spool file containing special 3800 options is spooled to a
printer other than the 3800, the options are ignored and printing
occurs normally.

8.

You can nullify any previous or existing settings of the CHARS,
PCB options by specifying NULL in the name field of
MODIFY, or
tb ese opera nds.

9.

An FCB name of 6, 8, or 12 avoids an FCB forms
mismatch.
These
special FCB specifications print the eDtire spool file at 6, 8, or
12 lines per inch regardless of the paper size.
VM/SP calculates
the proper FCB form to load.

10.

When the operator activates the
3800 printer, the operator
specifies the character arrangement table and the FCB value that
prints the saparator page for every output file.
If you omit the
CHARS option on a file spooled to the 3800,
the printing defaults
to the character arrangement table previously defined by the
operator.
This is also the case for the FeB option.

11.

VM/SP issues a message to you whenever a file spooled to the 3800
printer contains invalid or undefined option names.
If the
operator has not automatically purged the file, you can correct the
situation using
the CHANGE command or spool the file to another
printer.

to verify the new attributes of

been

the file or

Section 5. Format of CP Commands

49

CHANGE

{n~~ n} FILES CHANGED

This is the response when you
indication of the number of
individual alterations to a
appear if you have issued the

50

issue the CHANGE command. This is an
files changed.
It does not reflect
given file.
This message does not
CP SET IMSG OFF command line.

IBM VK/SP CP Command Reference for General Users

CLOSE

CLOSE

Use the CLOSE command to terminate the spooling activity on any virtual
spooled unit record or console device.
The format of the CLOSE command
is:
r----r

Close

,

,

,Reader r
Ivaddr I HOld I
INOHoldl

I
I
I

.J

.J

,
L

r

,CONsole
,Printer
I PUnch
,vaddr
I
L

L

, ,

r

,

I PUrge
FORM form

I

,

,

I r
r
(DIst distcode] , NAme {fn eft
I IHOld
dsname
I ,NOHold,
L

L

,,, ,
,, ,

,
L

.J

,

l} II
.J

I
I

.J

.J
--.J

READER
RDR

closes all reader spool files.

CONSOLE

closes your virtual machine's console spool file.
Once a
virtual console spool file is closed, it becomes a printer
spool file and can be manipulated in th~ same way as any
printer spool file (for example, it can be purged or changed).

PRINTER
PRT

closes all printer spool files.

PUNCH
PCH

closes all punch spool files.

vaddr

is the virtual address (cuu) of the device to be closed. The
address may represent a reader, console, printer, or punch.

HOLD

makes the output spool file being closed unavailable for
further processing, until it is specifically requested or
changed. Howev~r, input reader files are still available for
processing
(see Figure
6).
This option, specified in the
CLOSE command, overrides any previously specified HOLD or
NOHOLD option for the files being closed.

NOHOLD

makes the output spool file being closed available for further
processing, but the input reader file is no longer available
for processing (see Figure 6). Specify NOHOLD if a HOLD
established by the SPOOL command is still in effect and the
current active file is not to be held.
You can release one of your own output files in HOLD status by
using the CHANGE command.
If an output file is spooled for
another user
(SPOOL FOR userid), only the receiving virtual
machine user can change the file status. If an output file is
spooled to another user as an input file (SPOOL TO userid),
the HOLD option places the input file in HOLD status. The
Section 5. Format of CP Commands

51

CLOSE

file then cannot be read by the virtual machine until it is
changed to NOHOLD by the receiving virtual machine user.
If an input file
is closed with the HOLD option, the file is
saved and not purged from the system. The saved file is
available for virtual machine and user processing and is not
placed in a user hold status.
Input spool files that are
closed are normally purged from the virtual machine.
closes and immediately purges from the virtual machine
output spool files.
No output file is produced.

PURGE

the

FORM form
specifies the form name for a file.
The form operand is a
one-to-eight
alphan umeric
form name
d·efined
by
your
installation during system generation.
If FORM is not
specified for the CLOSE command, the file created has the form
associated with the last SPOOL command applied to it.
DIST distcode
uses

the one- to eight-character alphameric identification
on the output separators of printer and punch
instead of
the identification
specified in
the VM/SP
directory.
The distribution code is changed for this file
only and does not affect other files or change the VM/SP
directory.
If the file is transferred to another user, this
option has no effect.
(distcod~

NAME fn (ft 1
assigns identification to the spool file in the CMS format
filename and filetype.
The filename, fn, is a one- to
eight-character alphameric name assigned to the file for
a
oneto
identification.
The
filetype,
ft,
is
eight-character alphameric type assigned to the file for
identification. If ft is not specified, the filetype is set
to blanks.
NAME dsname
assigns ~entification to the spool file in a non-CMS format.
The dsname field is a 1- to 24-character field suitable for
specifying OS or DOS files (for example, SYS1.SYSLIB.MYMAC).
Only 18 characters of the 24-character dsname are displayed by
QUERY, even though a name of up to 24 characters is valid.

1.

If the file is an input reader file, the file being processed is
purged 'unless SPOOL READER HOLD was previously specified (see the
SPOOL command).
The effect of HOLD or NOHOLD for a particular file
established by the SPOOL command can be overridden by specifying
NOHOLD or HOLD, respectively, in the CLOSE command.

2.

If an input spool file is read but the read is not completed (that
is, the virtual machine does not get a last-card indication), you
must issue a CLOSE READER command in order to be able to read that
file again
(or to read any other file).
Unless you specify HOLD
when you close a reader file, the file is purged.

52

IBM VM/SP CP Command Reference for General Users

CLOSE

3.

If the file is an output file on a printer, punch, or console, the
file is either queued for output on a real unit record device, or,
if the virtual output device is transferred (by use of the "SPOOL
vaddr TO userid" command), the file is queued for input to the
receiving user.

4.

You can
specify a filename
and filetype and
an
distribution code to aid in later identification of the
its contents.

5.

Figure 6 shows what happens to an input file in your virtual reader
when the CLOSE command is issued with the HOLD or NOHOLD operand in
effect. The CLOSE command can result in an input file being purged
or saved.

---------------------------------------------------,

,-

SPOOL Command Options Set for a Virtual Input Device ,
I

I
I

t (C LOS E
I Command
, Setting)
1---I Normal EOF
I
(default
I
CLOSE)
1--1 CLOSE

NOHOLD

File saved

File Furged

File saved

I CLOSE HOLD

File saved

File sa ved

I CLOSE HOHOLD
1-----

File Furged

File purged

I

1---------

INote: The term
lin aOLD status.

L-____

Figure 6.

,

HOLD

File purged

6.

optional
file and

I
I

I
I
I
I

----------11
----I
I
----I
,

---------1

means that the flle is neither purged nor is itt
A subsequent READ could read this file.
I

~saved"

---I

Action Taken on CLOSE for a Virtual Input Device.

Fiqure 7 shows what happens to a file in your virtual output device
when the CLOSE command is issued with the HOLD, NOHOLD r CONT, and
NOCONT operands in effect.

,----SPOOL Command Options Set for a Virtual Output Device

1
I
I (CLOSE
I Command
I Setting)

NOHOLD
NOCONT

1----I CLOSE
I
I
I CL OSE HOLD
1----I CLOSE NOHOLD
,

I

HOLD
NOCONT

IFile released I File held
Ifor processingl
I File held

NOHOLD
CONT

HOLD
CONT
----------INo action 1 INo action'
,
I

------------------------I File held
'No action 1 ,No action 1

-------1

IFile released IFile released INo action 1 INo action 1
Ifor processinglfor processingl
I

I
I

-------------------------1

t 1 No action is taken until you issue a SPOOL {PRTIPUN} NOCONT command. I
I Then you can issue a _CLOSE command to release the file for,
I -processing.
L
- ___________________________________________________________- - - - - 'I

Figure 7.

Action Taken on CLOSE for a Virtual Output Device

Section 5. Format of CP Commands

53

CLOSE

t:~;t

lCON~

54

FILE spoolid

{~gR}

userid COpy nnn

{:~~~LD}

This response is received if: multiple copies of the file are being
processed, the file is being transferred to another user, or the
file is placed in a USER HOLD status.
However,
if the SET MSG
option is OFF, this message is not issued even though the preceding
conditions are met.

IBM VM/SP CP Command Reference for General Users

COUPLE

COUPLE

Use the
COUPLE command to
connect your
virtual
(nondedicated)
cbannel-to-channel
adapter
(CTCA)
to
another
user's
virtual
channel-to-channel adapter
(or to another one of your own virtual
channel-to-channel adapters). The format of the COUPLE command is:
r

,

COUPLE

vaddr 1

(To]

userid

vaddr 2

'---

vaddrl

is the virtual
adapter.

address

(cuu)

of

your

channel-to-channel

[TO) userid
is the user identification of the virtual machine to which
vaddrl is to be connected.
If vaddrl is to be connected to
your own virtual machine, userid may be specified as an
asterisk (*). The user must be logged on and have a virtual
channe l-to-channel adap~er defined.
If the keyword '1'0 is
omitted, the userid cannot be "T" or "TO".
vaddr2

is the virtual address (cuu)
to be connected to vaddrl.

of the channel-to-channel adapter

eTCA vaddrl COUPLE TO userid vaddr2
This is the response you receive when you issue the COUPLE command.
vaddr 1

is the address of your channel-to-channel adapter.

userid

is the identification of the receiving virtual machine.

vaddr2

is the address of the channel-to-channel adapter of the
receiving user (or a different channel-to-channel adapter
in your own virtual machine).

CTCA vaddr2 COUPLE BY userid vaddrl
This is the response that the user
when you issue the COUPLE ccmmand.

specified by

userid receives

vaddr2

is the address of the channel-to-channel adapter
recei vi ng use r.

userid

is the identification
ccmmand.

of the user who

of the

issued the COUPLE

section 5. Format of CP Commands

55

COUPLE

vaddr 1

is the address of the issuing
adapter.

user's channel-to-channel

CTCA vaddr1 DROP FROM userid vaddr2
This is the response that the user who issued the COUPLE command
receives if the virtual eTCA vaddr1 was already coupled when the
COUPLE command was issued. The previous connection is terminated.
This response is always followed by the response:
CTCA vaddr1 COUPLE TO userid vaddr2

56

IBM VM/SP CP Command Reference for General Users

DEFINE

DEFINE

Use the DEFINE command to alter
your virtual machine configuration or
channel operating mode. The format of the DEFINE command is:

.I

DEFine

I

t

Reader
Printer
PUnch
CONsole
CTCa
TIMer
1403
1443
2501
2540P
2540R
3203
3211
3262
3289E
3505
3525

(As]

vaddr

r

,

3800 (As] vaddr (Size ww 11] 14W£'9:.!!!I
f 2Wcgm I
L

CHANnels (As]
LIne

SEL}
{ BMI

..J

r
,
l~l~1

r
,
Il!QQ~1£!'

,BTS f

IDAtck

l

.J..

f
.J

,

r
[AS] vaddr IIBMljJ I

I TELE[ 211

.J

l

,
,,
,..
r

GRAF

vaddrl

cuu

(As]

3033
I 3036
3138
3148
I 3158
3270

,

,
I

I
I
I
I

..

vaddr2

TFB-512
T3310
(As] vad.dr (BLK] (nnnnnn]
T3370
T2305
T2314
T2319
T3330
T3340
T3350
T3380

[As] vaddr [CIL] (nnn]

STORage [As]
,___

58

nnnnnK}
{ nnM _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ - - . J

IBM VM/SP CP Command Reference for General Users

DEFINE

READER [AS1 vaddr
RDR
adds a spooling 2540 card reader with the address specified by
vaddr to the virtual machine configuration.
PRINTER (AS] vaddr
PRT
adds a spooling 1403 printer with the address
vaddr to the virtual machine configuration.

specified by

PUNCH [AS] vaddr
PCH
adds a spooling 2540 card punch with the address specified by
vaddr to the virtual machine configuration.
CONSOLE [AS] vaddr
adds a virtual system console to
address spec~fied by vaddr.
CTCA

r AS]

the virtual machine

at the

vaddr
adds a virtual channel-to-channel adapter with the address
specified by vaddr to the virtual machine configuration. The
control unit address must end in zero, and must not already be
in use. Once the control unit is defined, other virtual
devices may not be defined for the same eTCA.

TIMER [AS1 vaddr
adds a pseudo timing device with the address specified
vaddr to the virtual machine configuration.

by

1403 [AS] vaddr
adds a spooling 1403 printer with the address
vaddr to the virtual machine configuration.

specified by

1443 (AS] vaddr
adds a spooling 1443 printer with the address
vaddr to the virtual machine configuration.

specified by

2501 (AS] vaddr
adds a spooling 2501 card reader with the address specified by
vaddr to the virtual machine configuration.
2540P [AS] vaddr
adds a spooling 2540 card punch with the address specified by
vaddr to the virtual machine configuration.
2540R (AS] vaddr
adds a spooling 2540 card reade~ with the address specified by
vaddr to the virtual machine configuration.
3203 [AS] vaddr
adds a spooling 3203 printer with the address specified by
vaddr to the virtual machine configuration.
The virtual 3203
printer supports the LOADVFCB command, but not the Index
feature.
3211 (AS] vaddr
adds a spooling 3211 printer with the address specified by
vaddr to the virtual machine configuration.
The virtual 3211
printer supports LOADVFCB and the Index feature (right-index
only) •

Section 5. Format of CP Commands

59

DEFINE

3262 [AS] vaddr
Adds a
spooling 3262 printer
to the
virtual machine
configuration; vaddr specifies the address to the virtual
machine configuration. The virtual 3262 printer supports the
LOADVFCB command but not the INDEX feature.
If the INDEX
feature is specified, CP processing ignores it.
3289E [AS1 vaddr
adds a spooling 3289E printer; vaddr specifies the address to
the virtual machine configuration.
The virtual 3289E printer
supports the LOADVFCB command but the INDEX feature is not
supported.
If the INDEX feature is specified, CP processing
rejects it.
3505 (AS] vaddr
adds a spooling 3505 card reader with the address specified by
vaddr to the virtual machine configuration.
3525 (AS] vaddr
adds a spooling 3525 card punch with the address specified by
vaddr to the virtual machine configuration.
r

,

3800 [AS] vaddr (SIze ww 11] 12WCGMI

r

IBTSI

IDAtck

I

I~!CG~I

1£1~1

IBQDai£~1

L

,

r

,

.JL.JL

.J

adds a
spooling 3800 printer
to the
virtual machine
configuration; vaddr specifies the address to the virtual
machine configuration. The SIZE keyword specifies the size of
the forms that CP loads into the virtual 3800.
The ww
specifies the width of the form as a hexadecimal code (see
Usage Note 6. for the available form width codes.)
The 11
specifies the length of the paper in half inches expressed in
decimal notation.
For example, if you want 8 1/2" by 11"
paper loaded into your virtual 3800, specify:
define 3800 as OOe size 04 22
If no width and length are specified,
11 inches.

the default is 14 7/8 x

The user can also specify the number of writable Character
Generation Modules (WCGMs) that CP assumes for the virtual
3800.
A 3800 has a standard two WCGMs with the option of
adding two more.
Each WCGM stores a raster pattern for 64
characters.
If the user specifies 2WCGM, he has enough
storage for CP to load 128 characters in the 3800; if he
chooses the default, 4WCGM, he can load up to 255 characters.
The user also has the option of specifying which stacker the
3800 uses -- either the Continuous Forms Stacker (CFS) which
is the default, or the Burster-Trimmer-Stacker (BTS).
In addition, the virtual 3800 user can choose whether he wants
data checks for the 3800 reflected to his virtual machine. If
he specifies the DATCK keyword, CP reflects all data checks
for the 3800 to the user's virtual machine if the Block Data
Check CCN has not been issued. If the user specifies NODATCK,
CP only reflect.s those data checks that are the result of
invalid translate tables or no FCB code match being found.
NODATCK is the default.

60

IBM VM/SP CP Command Reference for General Users

DEFINE
!ot~:

The user should only specify the DATCK keyword when it
is absolutely necessary since it severely increases the
overhead associated with the simulation of Write and Skip CCWs
to the virtual 3800.
In general, the reflection of data
checks due to overprinting and invalid EBCDIC codes is
unnecessar y.

CHAN NELS [AS] {SEL}
BMX
redefines the channel mode of operation for the virtual
machine to either selector or block multiplexer.
Use of the
SEL
(selector channel) or BMI
(block multiplexer channel)
operand sets the mode of operation for all channels except
virtual channel O.
Channel 0
always operates in byte
multiplexer mode.
The real or virtual channel-to-channel
adapter always operates in selector mode.
Block multiplexer mode may enhance the virtual machine's
operating system by allowinq the
overlap of start I/O
operations. This is done by reflecting a channel condition
code of 0 back to the virtual machine rather than a channel
busy signal.
Note: The virtual machine is immediately reset
of operands is executed.
r

LINE (AS] vaddr

when this set

,

11BM1 I
ITELE21
L

.J

adds a virtual 2701/2702/2703 communication line with the
address
specified
by
vaddr to
the
virtual
machine
configuration.
IBM1
indicates that an IBM-type terminal (2741,
1050, or
equivalent) is on the 2701/2702/2703 line.
TELE2 indicates
that a teletypewriter is on the 2701/2702/2703 line.

,

r

,
,,

GRAF cuu I 3033
I 3036 1
3138 I
3148
I 3158
I 3270 I

,,
L

.J

defines a temporary 3033, 3036, 3270, 3138, 3148, or 3158 (the
console used on the IBM System/370 Model 138, 148, or 158) for
the virtual machine.
The cuu is the hexadecimal virtual
address for the device.
After you define the 3033, 3036,
3270, 3138, 3148, or 3158, you must issue the CP DIAL command
from the device in order to use it.
The device must be
supported by the virtual machine's operating system.

section 5. Format of CP Commands

61

DEFINE

vaddrl [AS] vaddr2
redefines the device represented by vaddrl as vaddr2.
The
virtual address,
vaddr1, must represent a defined device in
the virtual machine configuration.
If vaddr1 is a dedicated 2305, both vaddr1 and vaddr2 must be
specified as base--addresses (xxO or xx8).
Also, when you
redefine a dedicated 2305, all eight exposure addresses are
redefined.
For example, if lBO is the base address of a
dedicated 2305, the command
define 1bO as ldO
redefines addresses
respectively.

1BO

through 1B7

as

lDO

through

1D7,

A VM/SP virtual machine that has a Mass storage System's MSC
port and 3330 virtual volume (3330~ addresses dedicated to it
must ensure that the 3330V addresses used by the virtual
machine are the same addresses as those specified in the mass
table create control statements and in the input to the as/vs
system generation process because VM/SP does not perform
device mapping for MSC messages or orders.
If desired,
an installation may choose to use the same mass
table create input for the multiple real processor environment
as well as the single processor environment running VM/SP with
multiple virtual
processors (virtual machines). Mass table
create permits definition of the same set of device addresses
for more than one CPUID.
One set of addresses can be
redefined later under VM/SP so that VM/SP can run two or more
MSS virtual machines on a single real machine.

define 3330V
Mass table
create control statements may
addresses 120 through
l2F for CPUID A associated with one
virtual machine
user. The same set of addresses may be
defined for CPUID B.
VM/SP, on the other hand may have
defined addresses 120 through 12F and 220 through 22F as
separate devices in DMKRIO.
All virtual machines must address the 3330V devices via 120
through 12F since these are the addresses predefined in the
mass table create proqram and by the as/vs system generation
process.
By means of the DEDICATE statement in OSER1's
directory,
the installation may choose to DEDICATE real
addresses 120 through 12F as virtual addresses 120 through
12F.
In a similar manner,
the i.nstallation may choose to
DEDICATE real addresses 220 through 22F to USER2 as virtual
addresses 120 through 12F.
The same could be accomplished by
attaching the string of addresses and then redefining them by
means of the DEFINE command.

62

IBM VM/SP CP Command Reference for General Users

DEFINE

TFB-512
T3310
T3370
T2305
T2314
T2319
T3330
T3340
T3350
T3380

[AS] vaddr [BLK] [nnnnnn]

[AS] vaddr {CIL] [nnn]

adds a temporary virtual disk of the specified type to the
virtual machine configuration.
The
vaddr specifies the
address of the disk, and must not be on a virtual control unit
already defined as a CTCA.
CYL nnn specifies the number of cylinders that the disk
contains for count-key-data devices.
Specify T3350 if a 3350
is used in native mode; specify T3330 if a 3350 is used in
3330 compatibility mode. Specify T3340 if a 3344 is used.
BLK nnnnnn specifies the number of blocks for FB-512 devices.
Specify TFB-512 if you do not care what specific fixed-block
device ho Ids the temporary disk (allowing VM/SP to select
either 3310 or 3310).
When you define temporary disk space on a 2305 device, only
the vaddr specified is defined (not all eight addresses
associated with the device).
!g!~:

Temporary disk space is assigned from a pool of DASD
resources; therefore, you should always format your temporary
disk space before you use it. If your installation's system
programmer specifies the SYSCLR=Yes option on the SYSRES
macro,
and you release temporary disk space or logoff the
system, CP clears all data areas and directory areas in that
temporary space.
If your installation chooses
not to
implement the SYSCLR option, you should clear any temporary
disk space yourself before you release it to free storage or
logoff the system.
This eliminates the possibility of an
unauthorized person accessing your data either accidentally or
deliberately.

STOR AGE [AS]

{ nnnn nK}
nnM

redefines the size of the virtual storage for the virtual
machina as nnnnnK
(where K represents 1024 bytes) or nnM
(where "represents 1,048,576 bytes).
The value specified
becomes the new virtual storage size.
Sizes must be in 4K
increments and are limited by the maximum value in the VM/SP
directory entry.
The minimum size you can specify is 8K. All
entries not specified in a 4K increment are rounded up to the
next 4K
boundary.
Changing
the virtual
storage size
(increasing or decreasing)
causes a virtual system reset and
clears all virtual storage to binary zeros.

1.

When you alter the configuration or channel operating mode of your
virtual machine via the DEFINE command, the changes are temporary
and are in effect for the current terminal session only.

Section 5. Format of CP Commands

63

DEFINE

2.

If either storage or channel operating mode is altered, the virtual
machine is immediately reset and the IPL procedure must be
performed again.

3.

If storage is redefined, any pages
LOCK command become unlocked.

4.

If your virtual machine is operating in the basic control mode
(ECMODE OFF), virtual addresses specified in vaddr, vaddrl, and
vaddr2 can be no higher than 5FF
(channols 0 through 5). If it is
operating in extended control mode
(ECMODE ON), all addresses
through FFF are valid.

5.

Use caution in defining the hexadecimal addresses of virtual
devices
(cuu) in DEFINE statements in order to avoid a usage
conflict caused by control unit I/O interface protocol.
The
following is an example of a virtual machine's DEFINE statements
that can cause operational conflict:

that have been locked

via the

define 3211 as 102
define graf 103 3270
The virtual addresses of both the 3211 pr~n~er and the 3270
terminal indicate the use of the same channel (1) and control unit
(0). By definition, the devices are virtual and therefore share
one virtual control unit in CP. A real 3211 printer operates on a
nonshared subchannel,
and the real 3270 console is designed for
shared subchannel operations.
Both of these real devices are
mapped to the same virtual
control unit.
Thus, subsequent
processing of a channel program involving these devices can result
in a
hung or
busy condition
(caused by
a conflict
in
real-to-virtual I/O processing).
Therefore, when defininq devices,
make sure the devices are defined
(and separated) within their own
control unit ranqe and not shared with other devices.
6.

Figure 8
below shows the form width codes
(in hexadecimal
notation) that are available for the 3800 as a virtual printer. A
virtual 3800 accepts form width code sizes for common use sizes
(inches)
or ISO
(millimeters).
Note that the default value is
X, OP' •

r

X'01'
X' 02'
X'03'
X' 04'
X' 05'
X' 0 6'
X'07'
X'08'
X' 09'
X'OA'
X'OB'
X'OC'
X'OD'
X' OE'
X'OF'

6-1/2 in.
Reserved
Reserved
8-1/2 in.
Reserved
9-1/2 in.
9-7/8 in.
10-5/8 in.
11 in.
12 in.
Reserved
Reserved
13-5/8 in.
14-3/10 in.
14-7/8 in.

(165 mm ISO)
(180 mm ISO)

------------

(215 mm ISO)
(235
(250
(270
(280
(305
(322

mm
mm
mm
mm
mm
mm

ISO)
ISO)
ISO)
ISO)
ISO)
ISO)

(340 mm ISO)
(363 mm ISO)
(378 mm ISO)

L-

Figure 8.

64

Available Form Width Codes for 3800 Spooling

IBM VM/SP CP Command Reference for General Users

DEFINE

Responses are generated to confirm that the desired configuration change
has taken place. These responses do not appear on your terminal if you
have issued the CP SET IKSG OFF command line.
type vaddr DEFINED
where the possible values for type are:
!1§~ni.!!.g

IIl!§
DASD
TAPE
LINE

Direct access storage device/3330V(virtual volumes)
Kagne tic ta pe
Communication line
Card reader
Line printer
Card punch
Graphics device
Console
Channel-to-channel adapter
Mass storage Control

RDR
PRT

PUN
GRAF
CONS

eTC A
MSC

CHANNELS = {SEL}

BMX

is the

channel mode of operation for the virtual macbine. This
response applies to all channels except channel 0
(always a byte
multiplexer cha nnel)
and any channel that has a virtual or real
cbannel-to-channel adapter (always a selector channel) •
STORAGE

= {nnnnnK}

nnK
verifies the new storage size of your virtual machine.
storage you may specify is 8K.

The minimum

Section 5. Format of CP Commands

65

DETACH

DETACH

Use the DETACH command to remove a virtual device
machine. The format of the DETACH command is:
r--

I
I

DETach

I vaddr (Vaddr ••• ]]}
{ ( vaddr-vaddr
]

from the

virtual

__________________- - - J

'----

vaddr (vaddr ••• ]
vaddr-vaddr
the term vaddr is the virtual address (cuu) of the device to
be detached from your virtual machine.
To detach multiple
devices on one command line, a blank must be inserted between
the addresses specified.
To detach a range of devices, a
hyphen (-) must be inserted between the addresses specified.
Multiple addresses and a range
of addresses cannot be
intermixed on the same command line.

1.

You can detach a previously attached device even if the device is
currently in use.
You can also detach devices that were attached
because
of V~/SP
directory entries
or
during CP
system
in i tializa t ion.

2.

When you detach a virtual device, it becomes inacc~ssible to your
virtual machine.
If the device was previously attached to your
virtual machine by an ATTACH command, it is released and becomes
available for attachment to your virtual machine, another user, or
the CP system. Tape devices are automatically rewound and unloaded
when detached.

3.

If you detach a device th.a t was previously attached to your virtual
machine by the operator, a message is sent to the operator
informinq him that the device is free.

4.

If the device being detached is a dedicated 2305, the
address you specify must be a base address (xxO or xx8).

5.

If a detach operation is taking place for a 2305 device and a range
is being used, processing for all 2305 exposures is performed when
the base address is encountered,.
It is possible that the range
operand may not include all the 2305 exposures. This is not an
error situation; all exposures are detached. When multiple real
device addresses are specified on the command line, only the base
address for the 2305 should be used. Any device address other than
the base exposure is considered an error condition.

66

IBM VM/SP CP Command Reference for General Users

virtual

DETACH

6.

Ccmmand processing does not terminate if an error (other than a
syntax error) is encountered when processing a range of addresses
or multiple addresses. Instead, an error message is issued for
each device
(address) that cannot be detached.
In addition, an
informational
message
identifies those
devices
that
were
successfully detached.
Informational messages may appear several
times in one command execution when a ra~ge of addresses or
multiple addresses are being processed.
Multiple informational
messages appear only when range is being ~rocessed.

7.

It is possible for a class
another user or other users.

B user

to DETACH

real devices

from

The DETACH command belongs to both the B and the G privilege class of
user; the response or responses issued are dependent upon who issues the
DETACH command.
Depending uFon the situaticn, responses are issued to:
•
•
•

the qeneral user whose virtual machine has the device to be detached
the system operator informing him that the device is successfully
detached
another B privilege class operator (not the system operator) that may
have initiated the detach operation.

This publication documents only those responses that the general user
would receive in the course of a virtual machine terminal session. For
those responses that are received by the system operator as a result of
a general users detach operation, refer to the DETACH command in the
Y~L~g QE&~~1Q£§ 2yid~ •

.Note: the 'type' variable in the following responses is omitted when a
range of addresses or multiple addresses are being reflected in the
resp onse.
type vaddr } DETACHED
vad dr •••
{ vaddr-vaddr
The user receives one or more of
completion of a
successful detach
initiated.

these responses
operation that

upon the
was self

typ e vaddr } DETACHED BY operator
vaddr •••
{ vaddr-vaddr
The user receives one or more of these responses upon the
completion of the detach operation if the system operator or
another user with the B privilege class had initiated the detach
opera tion.

Section 5. Format of CP Commands

67

DETACH

CTC! vaddr DROP FROM userid vaddr
This is the response if the device detached was a virtual CTCA
connected (via the COUPLE command) to another CTCA on the virtual
machine specified by the userid.
This response is always followed
by the response:
eTC! vaddr DETACHED
In the above responses, 'type' is one of the following:
~l:e~

DASD
TAPE
LINE
RD~

PET
PUN

GRAF
CONS
CTCA
DEV
MSC

68

!1~~ni.!!g

Direct access storage device/3330V(virtual) volumes
Maqnetic tape
Communication line
Card reader
Line printer
Card punch
Graphics device
Console
Channel-to-channel adapter
Any other device
Mass storage Control unit

IBM VM/SP CP Command Reference for General Users

DETACH CHANNEL

DETACH CHANNEL

Use the DETACH CHANNEL command to detach a dedicated channel from your
virtual machine when that channel path is no lonqer required for virtual
machine I/O operations. The format of the DETACH CHANNEL command is:

r--------------I DETach I CHANnel

L-_______________________________________________________
_
c

CHANNEL c
is the real address of the channel that is to be detached.

If DETACH CHANNEL is invoked prior to the normal completion of
activities on the dedicated channel, those activities are aborted.

CHANNEL c DETACHED u~erid
is sent to the user who
system ope ra tor.

issued the

command and

to the

I/O

primary

section 5. Format of CP Commands

69

DIAL

DIAL

Use the DIAL command to logically connect a switched line, leased line,
or locally attached terminal to a previously logged-on multiple-access
virtual machine. The format of the DIAL command is:

r--------------------------------------------------------,DIAL
, u s e r i d [vaddr]

-----,

L----______________________________________________________________ - - - - JI

user id

is the identification
logged on.

vaddr

is the address of the virtual
connection is to be made.

of a virtual machine

that is currently

communication line to which the

1.

A DIAL command is accepted only at loqon, and only as a substitute
for a LOGON command.
The type of terminal used must be supported
by both VM/SP and the multiple-access virtual machine.
See the
YJUSP Te~.!!!.i..Qal Qser'.§ ~.Yide for details on running and gaining
access to multiple-access machines.

2.

The DIAL command is not supported for the 3066 system console, for
the 3210/3215 system console, or for terminals that are using NCP
lines in a 3704/3705 control unit, but is supported for 3138, 3148,
and 3158 display consoles.

3.

Once the connection is made,
your terminal operates entirely under
the control of that virtual machine. The DIAL command matches your
terminal to an eguivalent type defined in the multiple-access
virtual machine.
If no matching
terminal type exists, the
connection cannot be made and an error message is issued.

4.

The DIAL command, though not suppcrted for remote 3270 terminals,
is supported for locally attached 3270 display devices. If the
DIAL command is issued from a local 3270 terminal, the virtual
system user must issue the CP command RESET to drop the dialed
ccnnection.

5.

The DIAL command is not supported for SNA terminals logically
connected to the host VM/SP system using the VTAM Communications
Network Application (VM/VCNA) program product.

DIALED TO userid vaddr
is the message sent to the
connection has been made.

70

user

indicating

IBM VK/SP CP Command Reference for General Users

that a

logical

DIAL

GRAF raddr}
LINE raddr DIALED TO userid DIALED = nnn
{ DEV
resid
is the response to the primary system operator. It indicates a
successful connection to the virtual machine (usc rid)
and the
total number of VM/SP lines (nnn) currently connected to other
v~rtual
machines.
DEV
resid
indicates
the
resource
identification of a 3704/3705 line.
No1~: The terminal remains connected to and under the control of
the virtual machine until that virtual machine terminates the
communica tion.

DBOP FROM userid vaddr
is the message sent to the user when the line is disabled.
GRAF raddr}
LINE raddr
DROP FROM userid DIALED = nnn
{ DEV resid
is the messa ge sent to the primary system operator when the line
is disabled.

section 5. Format of CP Commands

71

DISCONN

DISCONN

Use the DISCONN command to disconnect your terminal from the VM/SP
system while the virtual machine continues operation.
If you h~ve a
secondary userid {secuser} specified in your directory entry,
you can
now use the console of that logged on secondary user as your virtual
console after you disconnect.
The format of the DISCONN command is:
r

,

DISConn

[HOld]

L-

HOLD

specifies that the communication line is not to be disabled.
This option allows you to disconnect your terminal,
and, at
the same time, to avoid the process of telephone dialing into
the system to access your virtual machine again. If specified,
control returns to CP and the "VM/370 online" message is
displayed.

1.

The terminal remains disconnected until it is reconnected via a
LOGON command.
The virtual machine is logged off 15 minutes after
an attempt is made to read from the terminal or if the virtual
machine goes into a disabled WAIT state.
The user should be aware
that certain operating systems frequently issue "reads" to the
console, which can cause the logoff time-out situation.

2.

If your terminal connection is broken because of terminal, line, or
teleprocessing control unit errors, CP places the virtual machine
in disconnect mode for up to 15 minutes and your virtual machine
does not continue to
run unless SET RUN ON has been previously
specified.
If you log on within 15 minutes, your virtual machine
can continue operating.
Since many operands of the SET and
TERMINAL commands default to OFF when you log on again, you have to
reissue the SET and TERMINAL commands.
If you do not log on within
the 15-minute interval, the virtual machine is logged off.

3.

Unless the CP command, SPOOL CONSOLE START, is issued to spool the
virtual console output, all "writes" or output messages to the
virtual console are ignored.
When the terminal is reconnected via
the normal lo~on procedure, the terminal is placed in CP console
function mode.
To resume execution of the virtual machine, enter
the BEGIN command.

4.

If you have a secondary userid specified in your directory entry,
but that SECUSER is not logged on or is running disconnected, you
receive a message stating that the secondary user is unavailable.

72

IBM VM/SP CP Conmand Reference for General Users

DISCONN

When the DISCONN
issued.

command is

issued,

the disconnect

time message

is

DISCONNECT AT hh:mm:ss zone weekday mm/dd/yy
is the response to the user who issued the command.
GRAF raddr}
LINE raddr DISCONNECT userid USERS = nnn
{ DEV resid
is the response to the primary system operator informing him
that the user represented by userid has been disconnected from
the VM/SP system.
The response, nnn, is th~ total number of
users remaining in the system. DEV resid indicates the resource
identification of a 3704/3705 line.

section 5. Format of CP Commands

73

DISPLAY

DISPLAY

Use the DISPLAY command to display
components at your terminal:

•

•
•
•
•
•
•

•

Virtual storage locations
"Usaqe Notes")
Storage keys
General registers
F loa ting-point registers
Control registers
Program status word (PS W)
Channel address word (CAW)
Channel status word (CS W)

HQi~:

Use

the

NETWORK

the

following

(second-level virtual

DISPLAY command

to

virtual

machine

storage only;

display

the

content

see

of

3704/3105 storage.

The format of the DISPLAY command is:

r--------,------------------------------------------------I

Display I
,
I
I

r

,

r

r

'-'

I hexloc11 '{-}'heXIOc2

I t
I
I
I
I
I f

I Khexloc11 I : 1l!!H~
,
ILhexloc11 I
L
.J
IThexlocll I
r
,
,L
.J
I {.}Ibytecountl
f

I ~!i!l

f

.J .J

I L L

f

I
I
I
I
I
I
I
I

,
I
I
I

r

Greg 1 I
Yreg 1 I
Xreg1 ,

,,
I
L

r

,

,

-}lre g 2 f

{ : I]N12 f
L

r

.J

,

{.} I regcount I
I~ND
f
L

.J

I
f
f
I
f
I
.J

Psw
CAW
CSW

hex loc 1
Lhex loc 1
Thexloc 1
Khex loc 1
is the first, or only, hexadecimal storage location that is to
be displayed at the terminal.
If L or no letter prefix is
specified, the storage contents are displayed in hexadecimal.
If T is specified, the storage contents are displayed in
hexad eci ma 1, with EBCDIC transla tion. If K is speci fied, the
storage keys are displayed in hexadecimal.
If hexloc1 is not on a fullword boundary, it
to the next lower fullword.
74

IBM VM/SP CP Command Reference for General Users

is rounded down

DISPLAY

If L, T,
or K is entered either without any operands, or
followed immediately by a blank, the contents of all storage
locations or all the storage keys are displayed. The address,
hexloc1, may be one to six hexadecimal digits; leading zeros
are optional.
-}heXIOC2
{ : Eli!!

is the last of the range of hexadecimal storage locations
whose contents are to be displayed at the terminal.
Either a
- or a : must ~e specified to display the contents of more
than one location by storage address. If - or : is the first
character of the operand, then hexloc1 defaults to zero. If
hexloc2 is not specified, the
contents of all storage
locations from hexloc1 to the end of virtual storage are
displayed.
If specified, hexloc2 must be equal to or greater
than hexloc 1 and wi thin the virt ual storage size.
(See "Usage
Notes" below
for a
discussion on
discontiguous saved
segments.)
The address, hexloc2,
may be from one to six
hexadecimal digits; leadinq zeros are option.al.

{.} b ytecount
,g!Q
is a
hexadecimal integer designating the number of bytes of
storage (starting with the byte at hexloc1) to be displayed at
the terminal. The period (.) must be specified to display the
contents of mere than one storage location by bytecount. The
sum of hexloc1 and bytecount must be an address that does not
exceed the virtual machine size.
(See "Usage Notes" below for
a discussion on discontiguous saved segments.)
If this
address is net on a fullword boundary, it is rounded up to the
next higher fullword.
The value, bytecount, must have a value
of at least one and may be from one to six hexadecimal digits;
leading zeros are optional.
Greg 1
is a decimal number from 0 to 15 or a hexadecimal integer from
to F representing the first, or only, general register whose
contents are to be displayed at the terminal.
If G is
specified without a register number, the contents of all the
general registers are displayed at the terminal.

o

Ireg1
is an integer (0, 2, 4, or 6) representing the first, or only,
floating-point register whose contents are to be displayed at
the terminal.
If 1 is specified without a
register number,
the contents of all of the floating-point registers are
displayed at the terminal.
Xreg 1
is a decimal number from 0 to 15 or a hexadecimal number from
to F representing the first, or only, control register whose
contents are to be displayed at the terminal.
If X is
specified without a register number,
the contents of all of
the control registers are displayed at the terminal. If Xreg1
is specified for a virtual machine without extended mode
operations available, only control register 0 is displayed.

o

Section 5. Format of CP Commands

75

DiSPLAY

-}re g 2
{ : :§l!12

isa number representing the last register whose contents are
to be displayed at the terminal. The dash (-) or colon (:)
following reg1 is used to specify a range of register values
to be displayed~ If reg2 is not specified, the contents of
all registers from regl throu9h the last register of this type
are displayed. The operand, reg2, must be equal to or greater
than reg1.
If Greg1 or Xre91 is specified, reg2 may be a
decimal number from 0 to 15 or a hexadecimal number from 0 to
F. If Yreg1 is specified, reg2 may be 0,
2, 4, or 6. The
contents of registers reg1 through reg2 are displayed at the
terminal.

{.} regcount

l!l!12

is a decimal number from 1 to 16 or a hexadecimal number from
1 to F specifying the number of registers (starting with reg1)
whose contents are to be displayed at the terminal.
If the
display type G or X is specified, reqcount can be a decimal
number from 1 to 16 or a hexadecimal number from 1 to P. If
display type Y is specified, regcount must be 1, 2, 3, or 4.
The sum of reg1 and regcount must be a number that does not
exceed the maximum register number for the type of registers
being displayed.

PSW

displays the current virtual machine
word) as two hexadecimal words.

PSi (program

status

CAW
displays the contents of the CAW (channel address word
hexadecimal location 48) as one hexadecimal word.

at

displays the contents of the CSW
(channel status word
hexadecimal location 40) as two hexadecimal words.

at

csw

1.

First level s~orage is real main storage.
Only second-level
storage (storage that is real to the virtual machine) can be
displayed.
Operating systems running in a virtual machine such as
DOS/VS and OS/VS have virtual
storage of their own.
This
third-level virtual storage cannot be displayed directly. The user
or the virtual operating system is responsible for converting any
third-level storage locations to second-level storage locations
before issuing the command.

2.

If a command line with an invalid operand is entered, the DISPLAY
command terminates when it encounters the invalid operand; however,
any previous valid operands are processed before termination
occurs. Multiple storage locations, registers, and control words
can be displayed using a single command line.

76

IBM VM/SP CP Command Reference for General Users

DISPLAY

3.

When multiple operands are entered on a line for location or
register displays, the default display type is the same as the
previous explicit display type.
The explicit specification of a
display type defines the default for subsequent operands for the
current display function.
Blanks are used to separate operands or
sets of' operands if more than one operand is entered on the same
command line. If a dash or a colon is omitted between the hexloc1
and hexloc2 operands, and the two operands are separated by one or
more blanks, CP only displays the storage contents at those two
specific addresses. Blanks must not be used to the right or left
of the range or length delimiters (: or - or .), unless the user
wants the default value of the missing operand defined by the
blank. For example:
display 10 20 T40 80 G12 5 L60-100
displays the following, respectively:
hexadecimal location 10
hexadecima 1 loca tion 20
hexadecimal location 40 with EBCDIC translation
hexadecimal location 80 with EBCDIC translation
general register 12
general register 5
hexadecimal locations 60 through 100

4.

To terminate the DISPLAY function while data is being displayed at
the terminal,
press the attention key (or its eguivalent). When
the display terminates, another command may be entered.

5.

The DISPLAY command does not distinguish between shared and
nonshared storage; it displays any of the virtual machine's
addressable storage whether shared or not.

6.

Use the DISPLAY command to display the contents of various storage
locations,
registers, and control words at the terminal.
By
examining this type of information during the program's execution,
you may be able to determine the cause of program errors.
Usually,
an address stop is set to stop the program execution at a specified
point. The system enters the CP environment and you may then issue
the DISPLAY command.

7.

When you must examine large portions of storage, use the DUMP
command rather than the DISPLAY command.
Because the terminal
operates at a much slower speed than the printer, only limited
amounts of storage should be printed (via the DISPLAY command) at
the terminal.

8.

When running with a
discontiguous saved segment (DCSS),
you can
storage locations outside the range of your virtual machine
size if they are within the DCSS.
If there exist locations between
the upper limit of your virtual machine and the address at which
the DCSS was saved, an attempt to display those locations
(or
associated keys) results in a "nonaddressable storage" message.
dis~lay

One or more of the following
operands specified.

responses is displayed, depending upon the

section 5. Format of CP Commands

77

DISPLAY

xxxxxx word1 word2 word3 word4 (key] *EBCDIC TRANSLATION*
This is the response you
receive when you display storage
locations; xxxxxx is the hexadecimal storage location of word1.
Word1
is displayed
(word-aligned)
for
a single
location
specification. Up to four words are displayed on a line, followed,
optionally, by an EBCDIC translation of those four words. Periods
represent nonprintable characters.
Multiple lines are used
(if
required) for a range of locations.
If translation to EBCDIC is
requested (Thexloc), alignment is made to the next lower 16-byte
boundary; otherwise, alignment is made to the next lower fullvord
boundary.
If the location is at a 2K page boundary, the key for
that page is alsc displayed.

xxxxxx TO xxxxxx

KEY = k k

This is the response you receive when you display storage keys;
xxxxxx is a storage location and kk is the associated storage key.

GPR n = genreg1 genreg2 genreg3 genreg4
This is the response you
receive when you display general
reqisters;
n is the register whose contents are genreg1.
The
contents of the following consecutive registers are genreg2,
genreg3, and so on. The contents of the registers are displayed in
hexadecimal. Up to four registers per line are displayed for a
range of registers. Multiple lines are displayed if required, with
a maximum of four lines needed to display all 16 general registers.

FPR n

=

xxxxxxxxxxxxxxxx

.xxxxxxxxxxxxxxxxx

E xx

This is the response you receive when you display floating-point
registers;
n is the even-number floating-point register whose
contents are displayed on this line. The contents of the requested
floating-point registers are displayed
in both the internal
hexadecimal format and the E format. One register is displayed per
line.
Multiple lines are displayed for a range of registers.

78

IBM VK/SP CP Command Reference for General Users

DISPLAY

ECR n = ctlreg1 ctlreg2ctlreq3 ctlreg4
This is the response you
receive when you display control
registers;
n is the register whose contents are ctlreg1.
The
contents of the following consecutive registers are ctlreg2,
ctlreg3, and so on.
The contents of the requested control
registers are displayed in hexadecimal.
Up to four registers per
line are displayed. Multiple lines are displayed if required.

PSi = xxxxxxxx

xxxxxxxx

The contents of the PSi are displayed in hexadecimal.

CAW = xxxxxxxx
The contents of the CAW (hexadecimal
h exadec ima 1.

CSW = xxxxxxxx

location 48) are displayed in

xxxxxxxx

The contents' of the CSW (hexadecimal
hexadecimal.

location 40) are displayed in

section 5. Format of CP Commands

79

DUMP

DUMP

Use the DUMP command to print the contents of various components of the
virtual machine on the virtual spooled printer. The following items are
printed:
•

Virtual program status word (PSW)

•

General registers

•

~loating-point

•

Con t rol registers
(if you ha ve the
VM/SP directory entry)

•

Storage keys

•

Virtual storage locations
"Usage Notes")

1iQi~:

Use

storage.

registers
EC MODE option specified

(second-level virtual

in your

storage only;

see

the NETWORK DUMP command to dump the contents of 370Q/3705
This command is described in the V~l~~ QE~ra1Q~~2 2Yig~.

The format of the DUMP command is:

r----------------------------------------------------------------------,I

I DU MP I r
,
r
,
,
I I Lhexlocl I {-} I he xloc2 I
' I The x loc 1 , : I EHQ
I
I
I ' hex locl I
L
J
I
J
r
,
I
I L
' I
{.} I bytecount I
I
I
I ~!Q
I

( *dum pi d ]

I
I
I
I
I
I

- - J,
"L____________________________________________________________________
L.J

Lhex loc 1
Thex loc 1
hex loc 1
is the first or only hexadecimal storage location to be
dumped. If you enter L or T withcut operands, the contents of
all virtual storage locations are dumped. If L or no letter
prefix is specified, the storage contents are displayed in
hexadecimal.
If T is specified, the storage contents are
displayed in hexadecimal, with EBCDIC translation.
The address, hexloc1, may be one to six hexadecimal digits;
leading zeros are optional.
If hexlocl is not on a boundary divisible by 32, it is rounded
down to the next lower such boundary.
-} hexloc2
{ : ~1iQ

80

TB~

is the last hexadecimal storage location whose contents are to
be dumped to the printer. If - or : is the first character of
the operand, then hexlocl defaults to zero. The operand,
hexloc2, must be equal to or greater than hexlocl and within

V~/SP

CP Command Reference for General Users

DUMP

the virtual storage size. To dump to the end of storage, you
can specify END instead of bexloc2 or you can leave the field
blank, since the default is END.
If you specify :END or -END,
the contents of storage from hexloc1 to END are dumped.
The
contents of storage locations hexloc1 through hexloc2 are
printed with EBCDIC translation at the printer. The operand,
hexloc2, may be from one to six hexadecimal digits; leading
zeros are optional.
{.}bytecount
~!Q

is a
hexadecimal integer designating the number of bytes of
storage ~tarting with the byte at hexloc1) to be dumped to
the printer.
The period
(.) must be specified to dump the
contents of more than one storage location by bytecount. The
sum of hexloc1 and bytecount must be an address that does not
exceed the virtual machine size. If this address is not on a
fullword boundary,
it is rounded up to the next highest
fullword.
The value, bytecount, must be one or greater and
can be no longer than six hexadecimal digits. Leading zeros
are optional.
*dumpid
can be entered for descriptive purposes.
If specified, it
becomp.s the first line printed preceding the dump data.
Up to
100 characters, with or without blanks, may be specified after
the asterisK prefix.
No error messages are issued if more
than 100 characters are used including asterisks and embedded
blanks.

1.

First level storage is real main storage.
Only second-level
storage
(storage that is real to the virtual machine) can be
dumped. Operating systems running in a
virtual machine such as
DOS/VS, VSE operating systems, and OS/VS have virtual storage of
their cwn.
This third-level virtual storage cannot be dumped
directly.
The user or the virtual operating system is responsible
fer converting any third-level storage locations to second-level
storage locations before issuing the command.

2.

The CP DUMP command executes in an area of storage separate from
your virtual machine storage and does not destro~ any portion of
your storage.

3.

If the DUMP command is used in CMS mode, use the #CP DUMP command
or depress the PAl key before entering the command.
This procedure
maintains the virtual machine's registers for the dump.
Otherwise,
the registers are those of the CMS command processor.

4.

The DUMP command prints the virtual PSi and the virtual registers
(general~ floating-point,
and control). If only this information
is desired, at least one virtual address must be specified, such as
DUKP 0

5.

The output format for the virtual storage locations is eight words
per line with the EBCDIC translation on the right. Each full word
consists of eiqht hexadecimal characters.
All the rest of the
information (PSW, general and floating-point registers, and storage
keys) is printed in hexadecimal.
If you have the ECMODE option in
your VK/SP directory entry, the control registers are also printed.
Section 5. Format of CP Commands

81

DUMP

To print the dump on the real printer, a
issued for the spooled virtual printer.
6.

Normally, you should define beginning
the following manner:

CLOSE command

must be

and ending dump locations in

dump Lhexloc1-hexloc2
dump Lb~xloc1.bytecount
dump Lhexloc1-hexloc2 hexloc1.bytecount

*

dumpid

If, however,

a blank follows the type character
(L or T)
or the
character and the hexloc, the default dump starting and ending
locations are assumed to be the beginning and/or end of virtual
storage. Blanks aLe used to separate operands or sets of operands
if more than one operand is entered on the same command line. If a
dash or a colon is omitted between the hex1oc1 and hex10c2
operands, and the two operands are separated by one or more blanks,
CP only dumps tbe storage contents at those two specific addresses.
Blanks must not be used to the right or left of range or length
ilalimiters
(:
or or.), unless it is inten1ed to take the
default value of t~e missing operand defined by the blank. Thus.
all of the following produce full storage dumps:
dump
dump
dump
dump
dump
dump
dump
dump

1

t

-

.1t1:

rlump
dump
(lump
dump
dump
dump
dump
dump

t:

1.
t.
00:

o.

l-end
t-end

dump
dump
dump
dump
dump
dump
dump

O-end
l:end
t:end
O:end
l.end
t. end
O.end

The following produces three full dumps:
dump 1 • t
dump - • .
7.

When running with a discontiquous saved segment (DCSS), you can
dump storage locations outside the range of your virtual machine
size if they are within the DeSS. If there exist locations between
the upper limit cf your virtual machine and the address at which
the Dess was saved, an attempt to dump those locations (or
associated keys) results in d "nonaddressable storage" message
appearing in the printer output.

the dump progresses, the fol1owinq
terminal, indicatinq that the dump is
boundary:

A~

message is displayed at
continuing from the next

DUMPING LOC hexloc
where hexloc is the segment (64K) boundary address for
continuation, such as 020000, 030000, or 040000.

the
64k

the dump

If you press the attention key, or its equivalent, on the terminal
while the meSS:ige is being displayed, the dump function is
terminated.
COMMANt COMPLETE
is the response indicating normal completion of the dump function.
82

IBM VM/SP CP Command Reference for General Users

ECHO

ECHO

Use the ECHO command to place the terminal in the echo environment.
When in the echo environment, any input line entered is transmitted
unchanged back to the terminal a specified number of times.
The format of the ECHO command is:

r----------------------------------------------------------------------,

I
I
r ,
I
I ECho I
Innl
I
I
I
11 1
1
IL _ _ _ _ _ .______________________________________________________
J
- - JI

,L

nn

.1

is the number of times that the line is to be sent.
The
default is 1. An invalid entry
(that is, one that is greater
than 99 or contains nonnumeric characters) is treated as 1.

1.

When the sp·ecified number of lin.es has been displayed, another read
tc the terminal is issued to accept another data line.

2.

To terminate the display before completion (for example, when you
want to change the data line), Fress the attention key.

3.

No line editing is done; the output line is the
same as the input
line and mav contain any of the logical line editing symbols.

ECHO ENTERED;
TO TERMINATE lEST, TYPE END
is displayed after the ECHO command is invoked to indicate that the
echo envircnment has been entered.
8NTER LINE
is displayed to prompt for an input line to be entered.
END returns the terminal to the CP command environment.

A reply of

Section 5. Format of CP Commands

83

EXTERNAL

EXTERNAL

Use tbe EXTERNAL command to simulate an exter~al
virtual machine and return control to that machine.
The format of the EXTERNAL command

interrupt to

the

....

• c:.
1.

r----------------------------------------------------------------------,
,
I r
,
I
I

EXTernal

,

I Icodel
, , !i.Q I
,L.I

L

code
!iQ

is the interrupt code, a hexadecimal number to be associated
with the external interrupt. All codes within the range X'Ol'
through X'FF' are valid. If your virtual machine has th9
EeMODE option specified in the VM/SP directory, you can also
code X'1004' (clock comparator interrupt)
or X'100S'
(CPU
timer interrupt).
The default is the external interrupt
button on the system console, X'40'.

This simulates pressing the interrupt key on the real
or other functions which cause an external interrupt.
to the virtual machine immediately.

None. since control is given to
from virtual machine processing~

84

system console,
Control is given

the virtual machine, any

IBM VM/SP CP Command Reference for General Users

response is

INDICATE

INDICATE

Use the INDICATE command to display, at your terminal, the use of and
contention for major system resources. The format of the INDICATE
command is:

r-----

----,
I r
,
I
I
I INDicate I ,LOAD
I
t
I ,USER I
I
I
~
- - JI
IL____________________________________________________________________

,L

provides an indication of the operating load of VM/SP by
displaying values on: the number of users in queue 1 and
queue 2, the usage of real storage, and the ratio of active
users to users being serviced.
USER

displays the amounts of system resources used by your virtual
machine in the current terminal session.

1.

Use INDICATE LOAD to display system load conditions.

2.

Use INDICATE USER to display the total amount of certain resources
used by your virtual machine during the current terminal session.
Use the INDICATE USER command before and after the execution of a
program to indicate the execution characteristics of that program
in terms of the resources used.

r

,

ICPU-nnn'fAPU-nnn'4]
I
IPROC xx-nnl PROC yy-nn~1
L

Q1-nn

Q2-nn

STORAGE-nnn%

EXPAN-nnn

~

PAGING-nnn/SEC

STEAL-nnn~

LOAD-nnn'

CPU-nnn'
(in AP and UP modes) nnn is a value rounded to the
nearest whole number; it indicates the percentage of time
that the main processor is executing.
APU-nnn%
(in AP mode) nnn is a value rounded to the nearest whole
number; it indicates the percentage of time that the
attached processor is executing. In uniprocessor mode of
operation, VM/SP indicates this response field as zero.
Section 5. Format of CP Commands

85

INDICATE

PROC xx-nnl
(in KP mode only) nn is a value rounded to the nearest
whole number;
it indicates the percentage of time that
the system is running on the IPL processor; xx represents
the processor ID.of the IPL processor. If the system was
generated for KP operation, but it is currently executing
in UP mode, PROC xx is the only value displayed (PROC yy
is omitted from the response).
PROC yy-nn%
(in MP mode only) nn is a value rounded to the nearest
whole number;
it indicates the percentage of time that
the system is running on the non-IPL processor;
yy
represents the processor ID of the non-IPL processor. If
the system was generated for MP operation,
but it is
currently executing in UP mode, this value is not
displayed.
Q 1-nn

Q2-nn
indicates the contention for CP. nn is a value rounded
to the nearest whole number; it represents the numbers of
users in queue 1 and queue 2.
The values are maintained
by the scheduler.

STORAGE-nnn~

is a measurement of the use of real storage.
nnn is a
value rounded to the nearest whole number and represents
the ratio of the sum of the estimated working sets of the
users in queue 1 and queue 2 (the runlist) to the number
of pageable pages
in the system, expressed
as a
percentage.
Because the criterion for allowing a user on
the eligible list to enter a queue is that at least 75
percent of his working set size must fit in the available
page frames,
the value of STORAGE can be more than 100
percant.
EXPAN-nnn
indicates the
average elapsed time ratio
for the
contention of processor and storage resources.
As EXPAN
increases above the ratio of 1,
there is a relative
increase in the contention for these resources.
For an
explanation of the algorithm used, see the VML~f ~I§tem
g~£g£~~~~§ 2~ig~·

PAGING-nnn/SEC
indicates the average number
performed per second.

of page

reads and

writes

S TEAl. - n n n %

indicates the percentage of page
real storage page to be stolen
virtual machine.

reads that required a
from another in-queue

LOAD-nnn%
is an artificial value. It attempts to measure the
elapsed time as a percentage of the system time devoted
to paging that results from real storage contention.
This calculation includes the estimated processor time
involved in paging, the amount of time spent in page
~aits,
and the percentage of pages stolen (STEAL).

86

IBM VM/SP CP Command Reference for General Users

INDICATE

PAGES: RES-nnnn is-nnnn READS=nnnnnn WRITES=nnnnnn MH-nnnn FH-nnnn
VTIME=mmm:ss TTIME=mmm:ss SIO=nnnnnn RDR-nnnnnn PRT-nnnnnn PCH-nnnnnn

RES-nnnn

is the current number of your virtual storage pages
resident in main storage. This number is taken at an
instant of time during the execution of the INDICATE
command.

is-nnnn

is the most recent system
set size.

READS=nnnnnn

is the total number of page reads that have occurred
for you since you logged on or since the last ACNT
command was issued for your virtual machine.

estimate of

your working

WRITES=nnnnnn is the total number of pages written for
you since
you have logged on or since the last ACNT command was
issued for your virtual machine.
MH-nnnn

is the current number of virtual pages allocated for
you in the preferred moveable head paging area of the
system owned paging disk(s). This number is taken at
an instant in time during the execution of the
INDICATE command.

FH-nnnn

is the current number of virtual pages allocated for
you in the preferred fixed head paging area of the
system owned paging disk(s).
This number is taken at
an instant in time during the execution of the
INDICATE command.

VTIME=mmm:ss

is your total virtual machine time since you logged
on or since the last ACNT command was issued for your
virtual machine.

TTIME=mmm:ss

is your total virtual
machine time plus total
processor time (virtual plus overhead) that you have
used S1nce you logged on or since the last ACNT
command was issued for your virtual machine.

SIO=nnnnnn

is the total number of nonspooled 1/0 requests that
you have issued since you logged on or since the last
ACNT command was issued for your virtual machine.

RDR-nnnnnn

is the total number of virtual cards read since you
logged on or since the last ACNT command was issued
for your virtual machine.

PRT-nnnnnn

is the total number of virtual lines printed since
you logged on or since the last ACNT command was
issued for your virtual machine.

PCH-nnnnnn

is the total number of virtual cards punched since
you logged on or since the last ACNT command was
issued for your virtual machine.

section 5. Format of CP Commands

87

IPL

IPL

Use the IPL command to simulate an initial program load
virt ual machine. The forma t of the IPL command is:

function for a

r--------------------------------------------------------,
I pI
,
r, r
,
,
,
I
I
,
L ____ _

I
,
I
I
t

r

vadd r

vaddr Icy lno I I CLear I
Innnnnni I NO£LegIt (STOP] (ATTN]
L.J

L

systemna me

,

_ ______________________--..J

r

,

,cylno ,
Innnnnn,

I CLEAR

I (STOP]

L

L

J

.J

[PARM {p1 p2 ••• }]

..J

'!QCL]!~t

simulates the IPL function when loading by device address.
vaddr

is the virtual address (cuu)
nucleus to be loaded.

cylno

is the cylinder containing the IPL data. If this operand is
specified, CP loads the IPL data from the specified virtual
cylinder instead of from virtual cylinder zero.
Virtual
cylinder zero is the default when cylno is not specified.
This operand is valid only for virtual direct storage devices.

nnnn nn

is the Dlock address containing the IPL data. Virtual block
zero is the default when nnnnnn is not specified.
This
operand is valid only for FB-512 devices.

CLEAR

sets the virtual storage space to binary zeros before the
operating system is loaded.
This operand is invalid if you
specify a systemname in the IPL ccmmand line.

of the device

that contains the

allows the contents of your virtual storage space to remain
unchanged prior to program load. This operand is invalid if
you specify a systemname in the IPL command line.
NOCLEAR is
the default if you IPL by device (vaddr).
STOP

halts the virtual machine during the IPL procedure just before
the initial PSW is loaded. It provides the virtual simulation
of the IPL procedure for a real machine in instruction step
mode.
The STOP operand is invalid if systemname is specified
in the IPL command.
When the virtual machine stops, you can
issue CP commands. For example, if you are loading OS or OS/VS
into your virtual machine, you can use CP commands to store
data into low storage, to load an alternate nucleus, or to
alter the apparent size of virtual storage. To restart the
virtual machine, issue the BEGIN command.

ATTN

generates an attention interrupt to the virtual machine during
the IPL procedure.
When the user specifies this parameter for
an OS/VS1 IPL, the FASTNIP feature of OS/VS1 is automatically
activated.
Note that the ATTN operand is invalid if the user
specifies the 'systemname' operand on the IPL ccmmand.

88

IBM VM/SP CP Command Reference for General Users

IPL

systemn~me

simulates the IPL function when loading a named system that
was previously saved via the SAVESYS command. It is loaded
into virtual storage and given control. For information about
saved systems, see the VML~f ~Y§1~ fIQg~~m~I~2 Guig~.
Note:
You cannot load a shared system or one that uses
aIscontiguous saved segments into a virtual machine running in
the V=R area.
An attempt to do so results in an error
message.
You can load a system into the V=R area that was stored by the
VMSAVE function.
When loading a VMSAVE system, the date and
time that the system was stored is displayed.
In addition,
the page ranges that were saved are displayed • .' The page-range
display can be suppressed by using the the' SET IMSG OFF
command.
PARM {p1 p2 ••• }
passes up to 6q bytes of data (excluding the first
blank
character after the keyword, PARM, but including all other
embedded blanks)
to your virtual machine's general registers
(4 bytes per register), starting with the high order byte of
general register O.
Since the registers are not cleared
before use, the PARM value should be some multiple of 4 bytes
to avoid having extraneous characters present in the low order
positions of the register.
For example, you could key in
PARM CMS)j
where ~ represents a blank to ensure that the low order
positions of register 0 contain a hexadecimal 40.
Whenever
PARM is specified, the remaining characters in the command
line are treated as parameters to be passed to your virtual
machine; therefore, PARM must be the last operand entered on
the command line.

1.

IPL simulates the LOAD button and the device address switches on
the real
system
console.
The specified virtual address is
aCCEssed and the required input/output operations are performed to
retrieve the IPL data.

2.

Optionally, the IPL procedure can be stopped just before loading
the virtual PSW except when loading a named system.
Also,
parameters can be
passed to the virtual
machine's general
registers.
When the simulated load function is complete, CP
initiates execution of the virtual machine by loading the IPL PSW
which was stored during the simulation process.

3.

Care must be used when passing parameters to a named system
(systemname) •
Named
systems expect
certain registers to be
initialized when they are given control. Indiscriminate use of the
PARM operand could overlay a previously initialized register
causing unpredictable results.

Section 5. Format of CP Commands

89

IPL

4.

The IPL simulator program occupies one page (4096 bytes) of storage
in your virtual m.achine.
Therefore, if the system being loaded
utilizes data remaining in storage by the previous system, card
should be taken as to where that data is located.
The starting
address of the overload virtual storage is:
!iI!Y~! ~!QI~g~ Si~~

256K and above

Less than 256K

=

1/2 the storage size

For example:
Storage size=200K then the IPL Simulator is loaded at lOOK.
5.

To load a VKSAVE system, a number of conditions must be met:
•

The user must be specified in module DMKSNT as either the owner
(USERID=) or the receiver (RCVRID=).

•

The area must contain a valid saved system.

•

The system must have been saved
expressed in the IPL command.

•

The area cannot be
enabled for VMSAVE.

the target area

under the

same system

for other

name

users currently

When these conditions are not met, an appropriate message is issued, and
the IPL is terminated.
6.

Any logical lines following the IPL command are ignored since the
execution of the IPL command transfers control from the CP
environment to the virtual machine environment.

1.

Some CMS routines and programs are stored on disks and loaded into
storage as needed. Since this storage area is not contiguous with
your virtual storage, the saved segments that are loaded in this
area are called discontiguous segments (DCSS). However, the only
discontiguous saved segment a CMS user can replace is the CMSSEG
segment. The user can indicate an alternate segment to be loaded
by issuing an IPL command with this format:
IPt

{CUU

systemname

} PARM

SEG=seqmentname

SEG=segme nt name
indicates the name of the saved segment to be loaded whenever
the CMS Editor, EXEC processor, or as simulation routines are
needed.
Eight characters must be entered for segmentname;
either assign an 8-character seqment name when you code the
NA~~SYS
macro for your installation, or be sure that the
operator enters trailing blanks if segment name is less than
eight characters long.
The CMS batch facility loads whatever segment is specified
on the first IPL command issued for the batch virtual machine~
Thus,
if the first IPL command for a CMS batch facility
machine is:
IPL CMS PAR" SEG=CMSSEG02
all subsequent IPL commands issued by the
specify the same segment name (CMSSEG02).
90

IBM V"/SP CP Command Reference for General Users

CMS batch facility

IPL

8.

The BATCH option in the PARK operand indicates that the CMS initial
program load is being performed in
a batch instead of an
interactive virtual machine. This option causes the CMS nucleus to
issue the CMSBATCH command to load the batch processor.
Specifying
the BATCH option eliminates the need for operator intervention
between jobs. Consult VKL~f £MS £2!!§nd §~g H~£~Q Re~~~~n£~ for
information on the CMSBATCH facility.

9.

CMS users can use the PARM operand to pass the AOTOCR (automatic
carriage return) cption to the CMS initialization routine.
AUTOCR
simulates the pressing of the RNTER key as input to the vi~tual
machine. This results in automatic execution of the user's PROFILE
EXEC, if it ex~sts on virtual minidisk 191.

MQ!§:

For a disconnected CMS
service virtual machine, this
mechanism can prove to be very useful. The name of a CMS restart
routine may be specified in the CMS nucleus. In the event of an
ABEND, the specified restart routine receives control ~nstead of
the service virtual machine entering a disabled wait state.. If
this routine issues an IPL CMS PARM AOTOCR command, the PROFILE
EXEC executes initial setup procedures that allow the service
virtual machine to reestablish itself~

10.

If the user issues an 'IPL vaddr ATTN' command to a virtual machine
other than
OS/VSl
with
the FASTNIP
feature, results
are
unpredictable.
The results depend on how the object operating
system handles ATTN interrupts during 1PL.

After a successful IPt, any responses you receive are those
operating system that was loaded and initialized.

from the

Section 5. Format of CP Commands

91

LINK

LINK

Use the LINK command to make a device that is associated with another
virtual machine available to your virtual machine configuration, based
upon information in that user's VM/SP directory entry. The format of
the LINK command is:
r--

(TO] userid vaddr1 [As] vaddr2 [mode] [[PASS=]

,LINK

1---

passwo~dl]

-----------1

11If your installation uses the password suppression facility, the
I pa ssword for a DAS D uni t cannot be entered on the LI NK command
,line. See the full descri~tion of the password operand for the
I steps needed to link to DASD with the password suppression facility
I in effect.
_______________________- - - - J

r TO 1

userid
is the name of
the user whose VM/SP directory is to be
searched for device vaddr1. An asterisk (*) is used to specify
that the device is in your own VM/SP directory. If the keyword
TO is omitted, the userid may not be "TO" or "T".

vaddr1
is the virtual device address
that userii.

(cuu) in the VM/SP directory for

( AS] vaddr2
is the virtual address (cuu)
that is to be assigned to the
device for your virtual machine. If the keyword AS is omitted,
vaddr may not be "AS" or "A". If your virtual machine has the
ECMODE option, any address up to X'FFF' is valid; otherwise,
any address up to X'SFF' is valid.
mode
is the access mode; the primary access requested (read-only,
write, or multiple), and the alternate access
(read-only or
write) desired if the primary access is not available. Valid
modes are:
1:!Qg~ !t~!!ni.!!g

92

R

Read-only (R/O) access. The link is not done if any other
user has the disk in write status. R is the default mode
if the link is to another userid.

RR

Read-only (RIO) access.
The link is established
another user bas the disk in write status.

W

Write access. The link is not done if any other user has
the disk in read or write status.

WR

Write and read access. If another user has the disk in
read or write status, an alternate access of read-only is
acceptable.

M

Multiple access.
This means that a write-link is to be
given to the disk unless another user already has write
access to it, in which case no link is to be done.

IBM VM/SP CP Command Reference for General Users

even if

LINK

!!Qde

!!~S!!!.!!g

MB

Write-link. If another user already has write
the disk, a read-link is to be done.

access to

Note: Unpredictable results can Occur when one user has a
R/O-(R or RR) link to a device that is being updated by a
user who has the device in write/read status.
~w

Write-link. This link is established in all cases.

£~uti~]:

More than one user writing to the same virtual device
can result in permanent loss of data.
If the mode is omitted, the default is R if the userid is
another user.
If you are linking to one of your own disks,
the default is the "user access mode" as specified in the
VM/SP directory for your disks.

PASS= password.
is a ond- to eight-character string that must match the access
mode password for device vaddrl in the VM/SP directory for the
user (userid) specified. The password should be specified only
when th~ LINK is executed by a virtual machine (for example,
from CMS),
since printing of the password is not suppressed
when included with the LINK command.
The access mode password
cannot be the same as any of the access modes
(R, RR, W, WR,
M, MR, or MW) if the default mode is to be used.

1.

The access mode password should
user password.

not be confused

with a

2.

If your installation is using the password suppression
facility, an INVALID FORMAT message is issued when a user
attempts to enter the password for a DASD
unit
on the
LINK command line.
The user must wait for the ENTER
PASSWORD response before typing in the password. This
facility improves system security because the password is
automatically masked.

1.

If you link to one of your own disks, no password is required.
Also, if the link is to a device whose password is ALL, meaning
that the device can be used by all users, the password is not
required. However, if the link is to any other userid, a password
for the desired device must be provided. If a LINK command is
issued from a CMS batch job, a password must be provided, even if
the device password is ALL.

2.

When linking to a 2305 device, you gain access only to the virtual
address specified and not to all eight addresses associated with
the dev ice.

3.

The access allowed by the LINK command to the vaddr1 device
belonging to userid is summarized below.
You read the columns down
to determine the type of link that results.
The first row
indicates the primary (and, optionally, the alternate) access mode
requested.
The second row indicates whether read,
write, or
multiple passwords exist in the VM/SP directory for the disk being
linked. The third row indicates whether the disk is already being
Section 5. Format of CP Commands

93

LINK

used, and if so, the mode of its access.
The last row indicates
the type of link established. For example, the third column is
interpreted as follows: if you request a read access link (R) to a
disk that has a read password defined and that already is accessed
in read mode, you can establish a read link.
4.

Virtual reserve/release processing cannot be requested by appending
a V to the mode operand of the LINK command line.
Virtual
reserve/release processing can only be requested by means of the
MDISK statement of the directory program.

r----------------------------------------------------------------------,
Primary access requested:
R R R R R WW W WW W M M M M M M
Alternate access (if any):

R

R

R

R W ,

----------------------------------------------------------------------1
Read password in directory:
N Y Y YY
,
Wri te password in directory:
Mult. password in directory:

N Y Y YY Y
N Y Y Y Y Y

,
1

----------------------------------------------------------------------1
Any existing links:
N R WW
N R R WW
N R W WW I

======================================================================f
Access established:
N R R N R N W N R N R N WWN R W ,

----------------------------------------------------------------------1
N=no or Donei R=read; W=write; M=multiple; Y=yes
I
L-----------------------------------------------------------------_____
~
Figure 9. Password Requirements on the LINK command.
!h~~~:

ENTER READ PASSWORD:
IKIIIIIIIIII

Type the read password
desired disk.

over the mask to obtain read

access to the

ENTER WRITE PASSWORD:
MIIIKJlDlIIH

Type the write password over the mask to obtain write access to the
desired disk.
ENTE R MULT PASS WORD:
HIIJIIIIUUI.II

Type the multiple password over the mask to obtain write access to
a disk for which other users may already have access.
No!~: If
the LOGON/AUTOLOG/LINK journaling facility is activated,
unsuccessful link attempts, due to invalid passwords, are recorded.
When a predefined system threshhold value for attempts is exceeded,
an installation userid receives a message. There is another system
threshhold value that disables the LINK command when a user
continues to enter trial passwords to obtain a link to a minidisk.
The default is ten incorrect passwords before the command is
disallowed for the remainder of the terminal session.

DASD vaddr2 LINKED R/O
This response indicates that a read-only link to the given disk is
established for a LINK request with a mode of R or RR, and that no
other users are linked to the same disk in read/write mode.

94

IBM VM/SP CP Command Reference for General Users

LINK

DASD vaddr2 LINKED R/i
This response indicates that a read/write link to the given disk is
established for a LINK request with a mode of W, WR, M, MR, or MW,
and that no other users are linked to the same disk.
r

,

DASD vaddr2 LINKED R/O; E/i BY {nnn ~SERS}I; R/O BY {nnn USERS} I
user l.d

I

1

userid
J

l

This response indicates that a read-only link to the given disk is
established for a LINK request with a mode of RR, but warns that
the disk is in read/write use by some users and possibly in read
use by some users. If only one user has access, the number of users
(nnn USERS) is replaced by userid.

DASD vaddr2 LINKED R/i; R/O BY {nnD ?SERS}
user~d

This response indicates that a read/write link to t~e given disk is
established for
a LINK request with a mode of H, MR, or MW, and
informs you that the disk is also in read-only use by userid or by
nnn users. (NO other users have a read/write link to the disk.)
r

,

DASD vaddr2 LINKED R/i; R/i BY {nnn ?SERS} I; R/O BY {nnn ?SERS} 1
user l . d ,
user~d
1
L

.J

This response indicates that a read/write link to the given disk is
established for
a LINK request with a mode of MW, but warns you
that the disk is also in read/write use by some users and possibly
in read use by some users. If only one user has access, the number
of users (nnn USERS) is replaced by userid.

section 5. Format of CP Commands

95

LOADVFCB

LOADVFCB

Use the LOADVFCB command to specify the forms control buffer image for a
virtual spooled 3203, 3211, 3262, or 3289E printer. The format of the
LOADVFCB command is:

r----------------------------------------------------------------------,
LOADVFCB I vaddr
Fcb name (Index {nn]]
1

I

L

vaddr

is the virtual device address (cuu)
3203, 3211, 3262, or 3289E printer.

FCB

is a required reserved keyword meaning Forms Control Buffer.

name

is a system-defined name for the 3203, 3211, 3262, or 3289E
FCB image which is to be the controlling virtual FeB image.

of the

virtual spooled

INDEX (nn)
for the 3211 only, is the number of the print position that is
the first
print position.
The value, nn, must be a number
from 1 through 31; a leading zero need not be specified. If
the keyword INDEX is specified without a value, the index
defaults to the value specified in the FCB macro.
See the
!~LSP ~l§tg~
PrQg~~m~~f~§ Qyjgg for
a discussion of the FCB
macro and forms control images.
The 3203, 3262, and 3289E do not support the index feature and
CP rejects any attempt to issue the INDEX operand.

1.

The LOADVFCB

command can be used with installations that do not
have a 3203, 3211, 3262, or 3289E printer.
The virtual machine's
VM/SP directory entry must indicate a 3203, 3211, 3262, or 3289E,
even though the program and operating system have a 1403 printer
defined.
Then the LOADVFCB command can be used to specify a
virtual FCB image foi 1403 printers so that programs that use
printer overflow sensing may be spooled to disk.

2.

VM/SP provides one FCB image (FCB1) with the following format:
r

,

L

---,-------'

ILine spacing = 6 lines/inch
I
1----------------------------------1
I Length of page = 66 lines
1
1-----------------------------------1
IPage line
1 11
31 5, 71 91111131151191 21t 231641
I
I
I
1
1
1
I
1
I
1
1
I
1
1
1
---------,
,Channel skip
11
21 3,
4,
5f 6, 7, 81 101 111 121 91
,
I
I
,
,
,
1
I
I
1
I
t
1
Your system programmer may provide you with additional FCB images.
96

IBM VM/SP CP Command Reference for General Users

LOADVFCB
3.

The user must load a
virtual 3203, 3211, 3262, or 3289E printer
with an FCB that is compatible with an FCB used in its read
counterpart. Failure to do so may produce unpredictable results.

4.

CP stores the virtual FCB image in all spool files created on the
virtual spooled
printer.
If a real 3203, 3211,
3262, or 3289E
printer prints the spool file, the virtual FCB image is sent to the
real printer. The spool file is then printed under the control of
the FCB, with the channel skip commands skipping to the proper line
on the page.
If the spool file is printed on a real 1403 printer, the virtual
FCB image
is ignored and channel skipping is controlled by the
carria ge ta pee

5.

If the virtual machine operating sy~tem issues a LOAD FeB channel
command word to the virtual spooled printer, the LOAD FeB ecw image
replaces the virtual FCB image provided on the LOADVFCB command
line.
Note that the CMS PRINT command issues a LOAD FCE CC~ and
thereby replaces the virtual FCB image.

6.

The following table shows the default virtual FCB
spooled 320.3, 3211, 3262, or 3289E printer:

image for

,

r

,

, Line spacing = 6 lines/inch

I

'Length of page = 66 lines
I,Page line
11
31
21
1
t

I
I

,,

IChannel skip
1

a

--------------.. . ------1

,

11

I

,

2,

41
1

51
1

,

61

71
I

81
1

9,

t

10 I 11 I EOI
1
I
I

--I

, ,

41
51
61 71
81
91 10 t 111 121
-J
I
I
1
I
I
I
I ______________________________
I

31

L

None.

section 5. Format of CP Commands

97

LOGOFF

LOGOFF

Use the LOGOFF command to terminate a
disconnect your virtual machine from the
the LOGOFF command is:
r

t
,

LOGoff
LOGout

[ HOld]

-----------------------------------,,
t

'-------

HOLD

virtual machine session and
VM/SP system. The format of

----------------------------~

retains the connection for a switched communication line to
enable you to log on without re1ialing the VM/SP system.

1.

This command causes all active spool files to be closed, temporary
disks to be relinquished, dedicated devices to be detached, and an
accounting record to be created for the user.

2.

You should always log off of your terminal in addition to turning
power off on the terminal. Terminal power off is not synonymous
with logoff.
If you turn power off at the terminal instead
logoff occurs by one of the following methods:

98

of logging

off,

•

IIE~!rit~f 19~mi]~! g~g

R~Q1g 1~lQ ~12E!~! Ig!!i]al
-- Logoff
takes place after a 15-minute interval has elapsed. This occurs
if no attempt is made to turn terminal power on and re-establish
communications with the still logged-on virtual machine during
this 15-minute period.

•

Lo~~l
l~lQ
~i§B!~I l~~!i]~!
Logoff only takes place 15
minutes after V~/SP discovers that the terminal has been turned
off (that is, V~/SP attempts to send a message to the terminal,
but gets back an error code indicating that the terminal is
turned off).
Because many hours may pass before VM/SP discovers
that the terminal
is turned off,
you run
the risk of
compromising the security of the virtual machine and data files.
Anyone turning the 3270 power back on has access to the virtual
machine without logging on.
This is because the machine is
still logged on, although inactive.

IBM VM/SP CP Command Reference for General Users

LOGOFF

CONNECT= hh:mm:ss VIRTCPU= mmm:ss.hs TOTCPU= mmm:ss.hs

CONNECT= hh:mm:ss
is the actual clock time spent in the current terminal session
in hours:minutes:seconds.
VIBTCPU= mmm:ss.hs
the virtual CPU time used in the current
minutes:seconds.hundredths of seconds.

terminal session in

TOTCPU= mmm:ss.hs
the total CPU time (including virtual and overhead)
used in
the current terminal session in minutes:seconds.hundredths of
second s.
These times are either the elapsed time for the entire terminal
session or the elapsed time since the ACNT command was entered for
this user.
LOGOFF AT hh:mm:ss zone weekday mm/dd/yy
is the response for a logoff.
GRA F raddr}
LINE raddr LOGOFF AS userid USERS = nnn
{ DEV
rid
is the normal response to the primary system operator.
specifies the resource identification of a 3704/3705 line.

DEV rid

GRAF raddr}

LINE raddr LOGOFF AS use rid USERS = nnn FORCED
rid
is the response to the primary system operator if the logoff is
forced by a line timeout or a terminal power-off.
DEV rid
specifies the resource identification of a 3704/3705 line.

{ DEV

USER DSC LOGOFF AS userid
USERS = nnn
is the response to the primary system operator when logoff occurs
for a user who had previously disconnected using the DISCONN
ccmma nd.

section 5. Format of CP Commands

99

LOGON

LOGON

Use the LOGON command to identify yourself to the VM/SP system
access that system. The format of the LOGON command is:

and

t~

,,

----.,

r

Logon
Login

I
I

userid

(password]

(Noipl]

L

I

user id

is the identifier assigned to you in the VM/SP system.

password

is your password.
Specify this field if
is, 'masking characters) is desired.

no protection (that

If your installation is using the password suppression
facility, an INVALID FORMAT message is issued when a user
attempts to enter the system LOGON password on the command
line.
The user must wait for the ENTER PASSWORD response
before typing in the password.
This facility improves system
security because the password is automatically masked.

!£~:

NOIPL

specifies that the IPL device or name in
should not be used for an automatic IPL.

the VM/SP directory

1.

Upon
successful
logon,
VM/SP creates
a
virtual
machine
configuration from information in that user's directory entry. The
LOGON command name may not be entered using any line-editing
symbols, but the operands may use these symbols. See the l!LSP
!sImin~l
Q§~~§
§yig~
for a detailed description
of logon
procedures.

2.

If you use LOGON because a teleprocessing line or terminal error
disconnected you from your virtual machine, you have 15 minutes to
log on again. If you do not log on within 15 minutes, your virtual
machine automatically logs off.
In this case, you may have to
reconstruct
f~les
and
restart
jobs
interrupted
by
the
teleprocessing line or terminal error.

3.

If you previously issued the DISCONN command to run your virtual
machine without a console and then issue the LOGON command to
reconnect your console, certain SET and TERMINAL command operands
are forc~d off even if they were on prior to issuing the DISCONN
command. For example, after a reconnect, CP resets the line delete
character specified in the directory to the system default value.
Issue the QUERY SET and QUERY TERMINAL command lines to check which
functions are currently active.

4.

During the virtual machine logon process on a VM/SP system
qenerated for attached processing operation but operating in
uniprocessor mode, a message is sent to the user with attached
processor AFFINITY set (via the user directory's OPTION statement)

100

IBM VM/SP CP Command Reference for General Users

LOGON

that the AFFINITY setting of his virtual machine is
the system's uniprocessor mode of operation.

nullified by

5.

If the
LOGON/AUTOLOG/LINK journaling facility
is activated,
accounting records are produced for unsuccessful logon attempts
with incorrect passwords. If system defined values are exceeded
attempting to logon with trial passwords, a message is issued to an
installation userid and any further LOGON attempts by the user are
r e iected.

6.

CP automatically masks your password on typewriter terminals to
insure installation security. For installations migrating from a
VM/370 operating system
to VK/SP, and for compatibility purposes,
CP still accepts the MASK operand on the LOGON command as valid.
However, CP automatically masks out your password should you forget
to issue a LOGON command without the MASK operand.

ENTER PASSWORD:
indicates that the
in the password.

use rid has been accepted.

You

should nov type

LOGMSG- hh:mm:ss mm/dd/yy
indicates the time and date at which the system log message vas
generated or most recently revised. All linp,s of the log message
for which the first character is an asterisk are displayed at this
point. If you wish to see all of the system log messages, you must
issue the CP command QUERY LOGMSG.
FILES: {~~n} RDR, {:gn} PRT, {:~n} PUN
Th1S message is omitted if all counts are zero; otherwise, it
indicates the number of spool files that exist for you at logon
time.
LOGON AT hh:mm:ss zone weekday mm/dd/yy
-- or -RECONNECTED AT hh:mm:ss zone weekday mm/dd/yy
indicates the time, day of the week, and date at which the LOGON or
RECONNECT is complete.

{ ~~~;m~addr

LINE raddr
DEV resid

l
l

LOGON AS userid

USERS = nnn

-- or --

~~~:m~addr

USERS = nnn
{ LINE raddr RECONNECT userid
DEV resid
is the respons@. to the primary system operator.
DEV resid
specifies the resource identification of a 3704/3705 line.
An
luname response specifies the logical unit name of a user who logs
on to VM/SP through a SNA network.

section 5. Format of CP Commands

101

MESSAGE

MESSAGE

Use the MESSAGE command to transmit message text to a specified userid
or to the primary system operator.
The format of the MESSAGE command
is:

r-----------------------------------------Message
MSG

{Us.erid} msgtext

*

OPerator . ______________ _
L-_______________________

user id

is the identification
message.

*

specifies that you are sending a message to yourself.

OPERATOR

sends the messa~e to the primary system operator regardless of
his userid.

msqtext

is the text of the message that is to be transmitted. The
lenqth of the message is limited to the number of characters
remaining on the input line after entering the command and the
appropriate operand.

of

the user

who

is

to receive

the

1.

If the user designated to receive the message is not logged on or
has suppressed the receiving of messages (SET MSG OFF), the message
is not transmitted and the sender receives a diagnostic message to
this effect.
A message which is not received by a user is not
saved and must be sent at a later time when the user is receiving
messages.

2.

The message is displayed at the terminal when the terminal is ready
to receive output. If a typewriter terminal (or a display terminal
having AUTOREAD set ON)
is entering data,
the message is not
displayed until an end-of-line (carriage return or ENTER) siqnal is
received.

3.

If the message is received by the primary system operator console
and SET MSG ON is in effect, the alarm at the central computer
console sounds.

4.

If the user receiving the message is logged on with a 3277 virtual
console that has the alarm feature, the alarm sounds.

5.

MSG
is useful in identifying the current userid of an abandoned
terminal, or it can be used in a program intended to be executed
under several userids.

102

*

IBM VM/SP CP Command Reference for General Users

MESSAGE

hh:mm:ss
MSG FRC~ OPERATOR:
msgtext
is the message received by the user from the system operator.
hh:mm:ss
"S~ PROM {LOGO~XXX}: msgtext
user1d
LOGNxxxx
is the format of the message sent to another user or to the
system operator,
where userid is that of the sender.
If the
user sending
the message is not logged on to VM/SP,
LOGON or
LOGN and the line number are displayed instead of userid.
hh:mm:ss
is the time in hours:minutes:seconds when the
to the user.

message was sent

section 5. Format of CP Commands

103

NOTREADY

NOTREADY

Use the NOTREADY command to cause a virtual device to appear as if it
had changed from ready to not ready status. The format of the NOTREADY
command is:
r

I

NOTBeady

vaddr

L--

vaddr

is the virtual device address (cuu)
from ready status.

spooled

of the unit to be removed

1.

This command is for use with
virtual consoles only.

unit

record devices

2.

Any I/O operation to the specified device, in progress at the time
the command is issued, is completed. On the next start I/O (SIO)
instruction, the not ready condition is in effect.

None.

104

IBM VM/SP CP Command Reference for General Users

and

ORDER

ORDER

Use the ORDER command to place your closed spool files in
order ty device type. The format of the ORDER command is:
r

,
I
,

ORDer

,

'{Reader }
I .printer
,PUnch

a specific

}t

----------------------------------'----~

{CLaSS c1 CLass c2...
FORM form1 FORK form2 •••
spoolid1 spoolid2 •••

-----

IIA combination of CLASS, FORM, and spoolid specifications may be
I en tered.

READER
RDR

specifies that
order.

PRINTER
PRT

specifies that the
order.

PUNCH
PCH

specifies that
order.

the reader
printe~

the punch

spool files
spool
spool

are to

files are
files are

be placed

to be
to

in

placed in

be placed

in

CLASS cl CLASS c2 •••
are the class(es)
to be rearranged and the sequence in which
they are to be processed~ CLASS is a required reserved word
and cl, c2,...
are one-character alphameric fields
,with
values from A to Z and from 0 to 9) that represent spooling
classes.
FOR" form1 FORK form2 •••
are the forms you want rearranged and the sequence in which
you want
CP to
process them.
The form1
and form2
spec if ications are one-to-eight character form names defined
during system generation.
spoolidlspoolid2 •••
are the spoolids of the files to be rearranged
sequence in which they are to be processed.

and

the

1.

You may order only your own

2.

Use the QUERY command to determine Epool file attributes
form, class, and spoolid for files you want to rearrange.

such as

3.

You
can use
a combination
of class,
form,
specifications to rearrange files. For example:

spoolid

files~

and

order printer class A 1963 class C form CATALOG4
specifies that CP queues printer files in the following order: all
class A files, the file with spoolid 1963, all class C files, all
tiles with form name CATALOG4, followed by any otber printer spool
files not specified in the ORDER command line.
Section 5. Format of CP Commands

105

ORDER

4.

When duplicate spoolids are present, the ORDER command resequences
only the first duplicate spool file found.

s.

The order of your spool files may change without warning between
terminal sessions if the system was restarted with a checkpoint
restart.

{:~nn} FILES OReERED

indicates the number of files that were placed in order.
displayed if you issued the CP SET IMSG OFF command.

106

IB! VK/SP CP Command Reference for General Users

It is not

PURGE

PURGE

Use the PURGE command to remove your own closed spool files from the
system before they are printed or punched by the spooling devices, or
before they are read by a user.
The forma~ of the PURGE command is:
r

I
I
I
I
I
I

PURge

I
I
I
I
I
.J
L
I
---I
1
I 1 A com bina tion of CLASS, FORM and spoolid specifications may be
I
, en tered.
______________ ---.JI
Reader
Printer
PUnch
ALL

r

..

ICLass c1 CLass c2...
IFORK form1 FORK form2 •••
Ispoolid1 spoolid2...
IALL

,
,
I
,

1

L--

READER
RDR

purges reader files.

PRINTER
PRT

purges printer spool files.

PUNCH
PCH

purges punch spool files.

ALL

purges all reader,
printer, and punch spool files.
When ALL
is specified instead of a device type, all other operands are
ignored.

CLASS c1 CLASS c2 •••
are the class(es) of files to be purged. CLASS is a required
reserved word and c1, c2, ••• are one-character alphameric
fields (with values from A to z and 0 to 9)
that represent
spoolinq classes.
FOR" form1 FORK form2 •••
specifies that CP should purge all files with the specified
form names defined during system generation. The form1 and
form2 options are one-to-eiqht character form numbers.
spoolid1 spoolid2 •••
are the spoolids of specific files to be purged.

111

purges all
punch) •

files of the

specified type (reader,

printer, or

Section 5. Format of CP Commands

107

PURGE

1.

You can purge any closed spool file you own, regardless
status, as long as CP has not selected it for processing.

of its

2.

You can purge files using a combination of CLASS, FORM, andspoolid
specifications.
For example:
purge printer class A 1932 class D 619 form INVOICE
specifies that CP should purge all class A and class D printer
files, printer files with spoolids of 1932 and 619, and all printer
files with ferm name INVOICE.

3.

You cannot purge any file you spool to the reader of another user
it is unless you first reclaim it using the TRANSFER command.

{:~nn} FILES PURGED
indicates the number of files purged.
This response
displayed if you issued the CP SET IMSG OFF command.

108

IBK VK/SP CP Command Reference for General Users

is

not

QUERY

QUERY
g~ivil~S! Cl~:

G and all classes except class Any

Use the class G QUERY command to determine
machine configuration by requesting:

your

system status

and

•

The time you have used during a terminal session.

•

The number of closed input and output spool files associated with
your virtual machine. For information on how to alter spool file
attributes, see the CHANGE command.

•

The current settings of the color and/or extended highlight values in
effect for your virtual machine console.

•

The current settings of the SET command functions.

•

The current settings of the TERMINAL command functions.

•

The status of all the devices on your virtual machine.

•

The channel operating
mode
block-multiplexer or selector.

•

A listing of all users who are linked to a given virtual address,
together with their device addresses and access modes.

•

Display of the secondary user (secuser)
CONSOLE directory statement.

•

Identification and attributes associated with your
punch, and reader spool files.

•

The identification cf your virtual processor.

•

The mode of
processor operation of your
VM/SP installation:
uniprocessor
mode
(UP),
attached processor
mode
(AP),
or
multiprocessor mode (MP).

of

Jour

virtual

that is

machine,

whether

specified in

the

virtual printer,

There are other operands you can use with the QUERY command if you
have the privilege class required to use them. These are described in
the !!L~R QR~A~~~ Guid~. Also, if you are a eMS user, you can use
the CMS QUERY ccmmand to query the status of your CMS virtual machine.
Note: Use the NETWORK QUERY co.mand to query 3704/3705 resources and
remote 3270 devices attached to a 2701 or 2703 or to a 3704/3705 in EP
or shared PEP mode.
Por ease of use, the QUERY command and operands described in this
section have been separated into the operands available for general
users (class G) and those available to all users ~xcept class Any.

Section 5. Pormat of CP Commands

109

QUERY

QUERY COMMAND FOR CLASS G USERS
The format of the Class G QUERY command is:

r-----------------------------------------.----,
,
.

Query

,
Time
,Set
,
TERMinal

-

,,
,,
,
t

I
I

r

Files [CLass c) [FORM form)

,1

INOHold f
,HOld
,
,USERholdl
ISYShold ,
L

r

t CHANnels
,GRAF
I.CONsole
I DAsd
[Virt ual] ,TApes
,LINES
I UR
I STORage
,ALL
, vaddr[-vaddr
L

J

,

,
I
I

,
,
I

,
,
I
)I
J

Links vaddr
CPUid
SECuser
r

Reader
Pr inter
PUnch

,

,NOHold ,
[CLass c] [FORM form] ,HOld
I
I USERhold,
spoolid
,SYShoid I
L

[ ALL] {TBL]1

J

PF[nn]
SCREen
PROCess
V~SAVE

S370E
SPMODE
IThe options may be specified in any order.
L--

TIME

displays the current time, time zone, weekday, date, connect
and processor time for the current terminal session.

SET

displays the status of the SET command functions.

TERMINAL

displays the current
console en vironmen t.

CPUID

displays the 16-digit processor identification that is in use
by the virtual machine. Values within the CPUID can be set by
the directory OPTION statement or modified by the SET CPUID.

110

options in

effect

IBM VM/SP CP Command Reference for General Users

for

your

virtual

QUERY

FILES

displays the number of spooled input and output files for your
virtual machine. Files currently being processed are not
included in the totals.
The CLASS p FORM p and HOLD p NOHOLD,
SYSHOLD, or USER HOLD operands restrict counting to certain
spool file s.

VIRTUAL

displays the status of all virtual devices.
CHANNELS displays
virtual machine.

the

channel mode

of

GRAF displays the status of all your
that are locally attached.

operation

for

the

virtual display devices

CONSOLE displays the status of your virtual consoles.
DASD displays the status
storage dev ices.

of all

your virtual

direct access
magnetic tape

TAPES displays
devices.

the status of

all your virtual

LINES displays
lines.

the status of

all your

virtual communication

UR displays the status of all your unit record devices.
STORAGE displays the size of your virtual storage.
ALL displays the status of all your virtual devices.
vaddr displays
vaddr.

the status

of the

vaddr-vaddr displays the status of
range of addresses specified.

virtual device
the

at address

devices within

the

LINKS vaddr
displays the userid, device address, and access mode at the
terminal for all users linked to the specified virtual address
(vaddr). A range of virtual addresses is not supported by the
LINKS operand.
SECUSER

displays the userid of the secondary user that is specified in
the CONSOLE directory statement.

READER
RDR
PRINTER

displays the following informatioD p pertaining to your closed
virtual reader p virtual printer p and virtual punch spool files:

PRT

•
•
•
•
•

PUNCH
PCH

•
•

Userid (of user who created the file)
Spool file identification (spoolid)
Class and originating device type
Number of logical records in the file
Number of copies specified for the file (has no effect for
reader files)
File hold status
Form name

One line of information is displayed for
spool file specified by spoolid) •

each spool

Section 5. Format of CP Commands

file.

111

QUERY

ALL

displays additional information for spool files.
The ALL
operand must follow the READER, PRINTER, or PUNCH operand. In
addition to the information normally displayed for the reader,
printer, or punch files, the following is also displayed:
•
•
•

Date and time the file was created
Filename and file type of file (if any); if 'your file was
assigned a dsname and you later issue QUERY, only the first
18 characters of the 24-character field are displayed.
Distribution code of the file

!ot~:

The

form name is B2!

displayed when the ALL

option is

used.
One line of information is displayed
the type specified.
TBL

for each spool

file of

displays additional information about spool files pertaining
to the 3800 printer. This option must follow the READER,
PRINTER, or PUNCH operand.
In addition to the information
normally displayed, the following is also displayed:
•
•
•
•
•
•

Character arrangement table
Vertical format (FCB)
Copy modification module
Forms overlay frame
Number of copies to be printed with forms overlay frame in
place
The placement of 3800 LOAD channel command words
(CCWs)
within a 3800 spool file

No!~:

The

form name is B2!

displayed when the TBL

option is

used.
One line of
specified.

information

is displayed

for

each print

file

spoolid

selects
the
specified
(READER/PRINTER/PUNCH option)

CLASS c

selects spool files of class IC' for counting (FILES option)
or display (READERjPRINTER/PUNCH option)

spool

file

for

display

FORM form
selects spool files with a particular form name for counting
(FILES option) or display (READER/PRINTER/PUNCH option)
NOROLD

selects spool files that are not held (either by system hold
or user hold)
for counting
(FILES option)
or display
(READER/PRINTER/PUNCH option)

HOLD

selects spool files that are held
(either by system
user
hold)
for
counting
(FILES
option)
or
(READER/PRINTER/PUNCH option)

USERHOLD

selects spool files that are in user hold for counting (FILES
option) or display (READER/PRINTER/PUNCH option)

SYSHOLD

selects speol files that are in system hold for counting
(FILES option) or display (READER/PRINTER/PUNCH option)

112

IBM

V~/SP

CP Command Reference for General Users

hold or
display

QUERY

PF[ n n]

displays the program function key number specified for a 3270
Information Display device, along with its associated command
lines.
If you do not specify nn, CP displays all 24 program
function keys and their associated data lines. The value, nn,
is a number from
1 (or 01) to 24. See the CP SET command for
an explanation of how to define and use prog ram function keys.

PROCESS

displays for the user which processors are currently online to
V"/SP.

SCREEN

displays the color and extended highlight values currently in
effect for your virtual console.
These values are set either
by the SCREEN statement in your directory entry or when you
issue class G SCREEN command(s).

S370E

indicates
in~ctive

that MVS/System Extensions support
(not available) on the system.

is active

or

SPMODE

displays whether single processor mode is ON or OFF for VM/SP.

VMSA VE

displays information about all of the target VMSAVE areas
specified in module DMKSNT that this user is either the owner
or receiver of.

This section describes the messages that CP issues in
specific QUERY operands.

response to your

TIME IS hh:mm:ss zone weekday mm/dd/yy
The current real clock time in hours:minutes:seconds, the time zone
(for example, EST),
the day of the week and the calendar date
(month/day/year) are displayed.
CONNECT= bh:mm:ss VIRTCPU= mmm:ss.hs TOTCPU= mmm:ss.hs
The time spent in the current terminal session is displayed.

CONNECT= hh:mm:ss

is the actual clock time spent in the current
terminal session in hours:minutes:seconds.

VIRTCPU= mmm: ss. hs is the virtual CPU time used in the current
terminal session in minutes:seconds.hundredths
of seconds.
TOTCPU= mmm:ss.hs

is the total CPU time
(virtual and overhead)
used in
the current
terminal session
in
minutes:seconds.hundredths of seconds.

Section 5. Format of CP Commands

113

QUERY

KSG

{~:p}. {~:p}. t~~:}.
WNG

EKSG

LINEDIT {g;F}, TIMER

{~;F

ACNT

{~:p}. {~:p}
RUN

}, ISAM {g;p}, EeMODE

REAL

ASSIST
IMSG

{ ~~T

OFF

ACTIVE

{g;F} ,SMSG

{i6;vc} {~~~MR}} ,

{g;F} ,APFINITY

PAGEX

{~;F}

{ON }

~FF, AUTOPOLL

{:~NE},NOTRAN {g~F},VMSAVE

{ON }
OFF
{g:F},370E

{~;F}

VR
NNNNNK }
N/Q xxlyy
{
STBYPASS OFF
, STMULTI {OFF
}
Q in the ST~ULTI response is the actual number of shadow tables
being used.
with the exception of Q, all of the response values
are the result of and explained with the SET command.
The settings of all functions controlled by the SET command and the
VM/SP directory ISAM and ECMODE options are displayed.
Refer to
the discussion of the SET command for explanation of these
functions.

LINEND

{~FF},

LINEDEL

LINESIZE nnn, ATTN

{~FF},

{g;F},

CHARDEL

APL

CON~ODE {3270}.
3215

HILIGHT

{g;F},

{~FF}'

ESCAPE

ON }
OFF
{
TABCHAR CHAR

{~FF},

TEXT {g;F}, MODE

{~:}

IMMED

BREAK!N {GUESTCTL}. BRKKEY

!
I
PF1
PA1

:

PF24

SCRNSAVE

{g;F}

The settings of all functions that are controlled by the TERMINAL
command are displayed. Refer to the discussion of the TERMINAL
command for explanations of the functions.
If LINEDIT is turned
off, the logical editing symbols displayed are those that were in
effect before line editing was turned off.
Note: If the user has no physical console, only the first line is
issued.
Also, the responses after the HILIGHT message do not
appear when there is no virtual console defined.

114

IBM VM/SP CP Command Reference for General Users

QUERY

CPUID= aabbbbbbccccdddd

aabbbbbbccccdddd
is the 15-digit processor identification associated
virtual machine ..

with the

aa

is the version code;
these two digits are forced to X'FF' to
identify that the virtual machine is running under VM/SP.

bbbbbb

is the processor identification number; this field contains
six hexadecimal digits. This is the only part of the CPUID
that can be modified by means of the SET CPUID command or set
by the V~/SP directory's OPTION control statement.

cccc

is the model number of the processor you are running on; this
field is padded to the left with zeroes when you are not
running on a 303X or 4300 processor. This field defaults to
the model number of the real machine. In MP mode, this value
is the moiel nu~ber stored in the PSA (prefix storage area) of
the IPL processor.
If the IPL processor is not online at the
time of the QUERY,
CP displays the model number o-f the
processor that is online at the time the QUERY command is
issued.

dddd

is the machine check extended logout;
this field is forced to
X'OOOO' since CP does not reflect machine checks back to the
virtu al machine.

If the CPUID is not supplied by the directory OPTION statement or
the SET CPUID command, then the CPUID associated with virtual machine(s)
is a s follows:

!Ql~:

aabbbbbbccccdddd
A A
A
A
FF(virtual mach)-------J,
"
real CPUID---------------J
"
real S/310 Model No .. -----------J
I
all zeros--------------------------J

FILES: {~~n} RDR, {~~n} PRT, {~~n} PUN
CP displays the total number of
specify the CLASS, FORM and/or
options with ~UERY FILES, CP
options you specify rather than

spool files in your system.
If you
NOHold, HOld, USERhold, or SYShold
displays only the totals for the
for all files on your system.

Section 5 .. Format of CP Commands

115

QUERY

CHAN NELS=

SEL}
{ BMI

The operating mode of the virtual machine channels is displayed.
This response applies to all of the virtual machine channels except
channel 0, which is always a byte multiplexer channel, and any
channels with virtual or real channel-to-channel adapters, which
are always selector channels.

GRAF vaddr {ON DEV raddr}
NOT READY
The status of all locally attached virtual display devices defined
to your virtual machine is displayed.

vaddr

is the virtual address to which the device is attached.

raddr

is the real address of the device.

NOT READY shows the status of a virtual 'display device that has not
been attached via the DIAL command.

CONS vaddr ON

~:~;}me raddr } { NOTERM
TERM}
{{ LINE

{STOP }
START

CONT} { HOLD}
{READY}
vaddr CL c { NOCONT
NOHOLD COpy nnn NOTREADY FORM form
DIST distcode FLASHC ccc
vaddr FLASH ovly CHAR ctab MDFY cmod PCB pcpi
For virtual machine consoles and SNA terminals, a four-line
response is displayed. The first line shows the console status and
options and the Dext three lines show the virtual console spooling
status •

116

.!.!!§n:
vaddr

is the virtual address of the virtual machine console.

raddr

is the real address of the ter minal
virtua 1 console.

c

is the spooling class of the console.

nnn

is the number of copies spooled.

IBM VM/SP CP Command Reference for General Users

associa ted with the

QUERY

userid

is the user identification.

distcode

is the distribution code.

ovly

is the name of the
the output pages.

forms overlay frame

ctab

is the name of the
generate output.

character arrangement table

cmod

is the name of the copy modification module used to alter
output text.

pcpi

is the name of the FCB
formatting of a page.

ccc

is the flash count for the file.

luname

is the logical unit name for the SNA terminal simulating
a virtual console. The response to the QUERY VIRTUAL
CONSOLE command displays the luname rather than the real
address (raddr)
and the GRAF/LINE option. Luname is a
one-to-eight character identifier assigned to a SNA
terminal user and use by CP instead of raddr.
It is
valid for SNA terminals connected to the host VM/SP
system by the VTAM Communications Network Application
(VKjVCNA) program product.

module

The other fields indicate the setting
the SPOOL command.

used

superimposed on

in the

used to

vertical

of the respective options in

The default settings for a virtual console are:
CONS vaddr
vaddr
vaddr
vaddr

ON DEV raddr TERM STOP
CL T NOCONT NOHOLD COPY 001 READY
FOR userid DIST distcode FLASHC 000
FLASH CHAR MDFY FCB

The default
console are:
CONS vaddr
vaddr
vaddr
vaddr

settings for

a

SNA

terminal simulating

a

virtual

luname TERM STOP
CL T ROCONT NOHOLD COpy 001 READY
FOR userid DIST distcode FLASHC 000
FLASH CHAR MDFY FCB

Section 5. Format of CP Commands

117

QUERY

B/i} {nnnnnn BLK}
DASD vaddr type volser { R/O
nnn
CIL
The status
displayed.

of each
whe!:~ :

virtual minidisk

defined for

vaddr

is the virtual address
attached.

to

which

type

is an IBM direct access device.

your system

the DASD

unit

is
is

!g.:t~:

1.

A display
device.

2.

For a dedicated DASD
DASD vaddr

of 3340 represents either a

ON

unit ,

3340 or 3344

the response is:

DASD raddr

vaddr

is the virtual address
device is attached.

to which

raddr

is the real address of the FB-512 device.

volser

is the volume serial number of the system
this virtual disk resides.

R/W

indicates the read/write status of the disk.

the FB-512

disk on which

R/O

nnn

is the number of cylinders
count-key-data devices.

nnnnnn

is the number of blocks on
devices.

TAPE vaddr

ON

on

the virtual

the virtual disk

disk

for FB-512

DEV raddr

The status of each tape defined for your system is displayed.

118

vaddr

is the virtual address to which the tape is attached.

raddr

is the real address of the tape.

IBM VM/SP CP Command Reference for General Users

for

QUERY

LINE vaddr ON DEV raddr
The status of all communication lines
machine is displayed.

defined

in your

virtual

vaddr

is the virtual address to which the line is attached.

raddr

is the real address of the line.

ENABLED}
LINE vaddr { DISABLED
The status of virtual communication
is displayed.

lines at virtual address vaddr

CONT} { HOLD} { EOF} {
READY}
RDR vaddr CL c { NOCONT
NOHOLD
NOEOF
NOTRElDY
The status of all the virtual
machine is displayed.

readers attached

to your

virtual

vaddr

is the virtual device address of the virtual reader.

c

is the spool file class which the device services. A
class of
indicates the device serves all classes of
spool files for input.

*

The other fields indicate the setting
the SPOOL command.

of the respective options in

The default settings fOI a reader are:
RDR vaddr CL
PUN

*

NOCONT NOHOLD READY EOF

READY}
CONT} {
HOLD}
vaddr CL c { NOCONT
NOHOLD CPY nnn { NOTREADY FORM form
DIST distcode

CONT} { HOLD}
{
READY'}
PRT vaddr CL c { NOCONT
NOHOLD CPY (*] nnn NOTREADY FORM form
vaddr

userid DIST distcode FLASHC ccc

vaddr FLASH ovly

CHAR ctab

KDFY cmod

FCB pcpi

2WCGK} {BTS} {DATCK }
vaddr SIZE ww 11 { 4WCGK
CFS
NODATCK
The status of all the virtual printers and punches attached to your
virtual machine is displayed.
section 5. Format of CP Commands

119

QUERY
l!.Ql~:

The last line of the response is displayed only for a virtual
3800 printer.

vaddr

is the virtual
punch.

device address of the

virtual printer or

c

is the output class assigned to spool files produced from
the device.

[* 1nnn

is the number of copies from 1 to 255, of each output
file to be
produced.
When the optional asterisk
(*)
appears, the 3800 performs the duplication internally,
provided the spool file contains sufficient information
to be spooled to the
3800 printer.
If there is
insufficient information, the asterisk is ignored and
printing occurs normally on the printer apsiqned in the
spool file class.
Note: Further information can be obtained in
i~~;s" discussion of the SPOOL command.

TO userid indicates that the
becomes
userid.

a reader

the "Usage

output from the device, when closed,
input spool file for the indicated

FOR userid
indicates the userid identification
(spool file
assigned to spool files produced from the device.

owner)

distcode

is the distribution code assigned
produced from the device.

ccc

is the number of copies that
overlay frame is in place.

ovly

is the name of the
the output pages.

forms overlay frame

ctab

is the name of the
qenerate output.

character arrangement table

cmod

is the name of the copy modification module used to alter
output text.

pcp!

is the name of the FCB
forma t ting of a page.

ww

indicates the form width code
virtual 3800 printer.

11

indicates in deci.al notation the length of the paper in
half-inches loaded into a 3800 printer.

to

each spool

file

are printed while the forms

module

used
(in

superimposed on

in the

used to

vertical

hexadecimal)

for

a

Note: The distcode in this case indicates the FOR userid; however,
the-distcode produced on the output files when the file is closed
is the distcode assigned to the FOR userid as specified in the
VM/SP directory.
1be other fields indicate the setting
the SPOOL command.

120

of the respective options in

IBM VM/SP CP Command Reference for General Users

QUERY

The default settings are:
PUN vaddr CL A NOCONT NOHOLD COpy 001 READY FORM form
vaddr
FOR userid DIST distcode
PRT vaddr CL A ROCONT NOBOLD COpy 001 READY FORM form
vaddr FOR userid DIST distcode FLASHC 000
vaddr FLASH
CHAR
MDFY
FCB
vaddr SIZE OF 11
4WCGM CFS NODATCK

userid and distcode are assigned for the virtual machine.
form is the installation defined default value.

STORAGE = nnnnnK
The size of
displayed.

the virtual

machine in

multiples of

1024 bytes

is

Has the same effect as if all the following commands were issued:
QUERY
QUERY
QUERY
QUERY
QUERY
QUER Y
QUERY
QUERY

VIRTUAL
VIRTUAL
VIRTUAL
VIRTUAL
VIRTUAL
VIRTU AL
VIRTUAL
VIRTUAL

STORAGE
LINES
TAPE
UR
DASD
GRAF
CONSOLE
CHANNELS

The response is in the same form as QUERY VIRTUAL DASD, TAPES, LINES, or
UR, depending on virtual device type.
When a range of addresses is
specified a response is used for each device within that range.
If vaddr corresponds to a 3330V
(Mass Storage System's virtual
volume) address, the following response is issued:

3330

DASD vaddr ON DASD vaddr
If vaddr on the command line is a Mass
address, the following response is issued:

Storage

Control 3851

port

MSC vaddr ON DEV vaddr

Section 5. Format of CP Commands

121

QUERY

user id vaddr

R/O},
{ R/i

A list of users
who are currently linked to the
address vaddr is displayed.

userid

is the identification
link.

vaddr

is the virtual address bl
to the device.

RIO

is the type
device.

R/W

of access

of the

user

device at virtual

who originated

which the user (userid)
the

user

(userid) has

the

refers
to

the

The response you receive is:
CPOUT
INREDISP
STAT AREA

color
color
color

color

is the color
console.

exthiligh t
exthiligh t
exthiligh t

value

VMOUT
INA REA

currently in

exthilight is the extended highlight value
virtual console.

color
color

effect

exthilight
exthilight

for your

virtual

currently in effect for your

Note: If you do not have a
SCREEN directory statement in your directory
entry and you have not issued the SCREEN command during the current
terminal session, the response to the QUERY SCREEN command is DEFAULT
for the color value and NONE for the exthilight value.

The response is one of the following:
SECONDARY USER IS UNDEFINED
is the response if no secondary user appears in the user's
directory entry.
If the primary user disconnects, all output
issued during that period is lost.
SECONDARY USER XXXXXXXX IS LOGGED ON
is the response if the secondary user is logged on.
If the
primary user disconnects, the secondary user receives all
output issued until the primary user reconnects.

122

IBM VM/SP CP Command Reference for General Users

QUERY

SECONDARY USER XXXXXXXX IS
is the response
the primary user
the primary user

NOT LOGGED ON
if the secondary user is not logged on. If
disconnects, all output issued is lost until
reconnects or the secondary user logs on.

SECONDARY USER XXXXXXXX IS DISCONNECTED
is the response if the secondary user is disconnected. If the
primary user disconnects, all output issued is lost until
either the primary user reconnects or the secondary user
reconnects.

r--------Basi~

Information----------,

V

V

ORIGINID FILE CLASS RECORDS
userid
file a typ norecs

CPY HOLD
nnn stat

r
I r---Addi tional Information
IV
NAME TYPE DIST
IDATE TIME
Imm/dd hh:mm:ss name type code
r
I FORMI I
I forml I r------Table Information
L
.J
IV
MDFY FLSHC
IFLASH CHARS FCB
ctab
plpi cmod ccc
lovly
I
I

,

,
.1

VI
I
I
I
.1
VI
LOADI

tr

BEG I
ANY I'
.J

L

userid

is the user who originally created the file.

spoolid

is a unique, system-as~igned number which
identify the file.

c

is the spool file class.

typ

is the originating device type (PRT, PUN, CON, DMP, or RDR).

norecs

is the number of logical records contained in the file.

[* ]n nn

is the number of copies assigned to the file (it has no effect
for virtual reader files).
Appearance of the asterisk
indicates that spool file duplication is handled by the 3800
printer. The device copies a spool file internally one page
at a time (collated output produced).

stat

is the file hold status: NONE (no hold), USER (user hold), SYS
(system hold), or USYS (system and user hold).

form

is the form name of the spool file.

mm/dd

is the date the file was created in month/day.

hh:mm:ss

opened
for creation
in
is
the time
the
file vas
such as spooled
hours:minutes:seconds.
For some files,
console files,
this time may be a span of hours before the
time at which the file is closed.

fn

is the filename assigned to the file (if any). If the file
has a 24-character data set name (dsname), only 18 characters
are displayed. These characters extend from the "name" field
through the "type" field.

is used by VM/SP to

Section 5. Format of CP Commands

123

QUERY

ft

is the filetype assigned to the file

distcode

is the distribution code assigned to the file.

ovly

is the name of
output.

ctab

is the name of
generate output.

pcpi

is the name of the FCB
of a page.

cmod

is the na me of
output text.

ccc

is the number 0'£ copies that
overlay frame is in place.

NO

indicates that no 3800 LOAD channel command
positioned within the 3800 spool file.

BEG

indicates that 3800 LOAD channel command words (CCWs)
positioned at the beginning of the 3800 spool file.

are

ANY

indicates that 3800 LOAD channel command words (CCis)
interspersed throughout the 3800 spool file.

are

the forms overlay
the character

(if any).

frame superimposed
arrangement

table

on the
used

to

module used in the vertical formatting

the copy

modification module
are printed

used to

alter

while the

forms

words (CCWs) are

When you issue QUERY READER, QUERY PRINTER, or QUERY PUNCH commands,
CP responds by listing (in the form described)
all the closed spool
files associated with your virtual reader, printer, or punch.
The information listing DATE, TIME, NAME, TYPE, and DIST
(date of
file creation,
time of file creation, filename, filetype and file
distribution code) is displayed only when you specify the ALL operand.
However, if you specify the TBL operand, the information listing FLASH,
CHARS, FCB, MDFY, FLSHC,
and LOAD (3800 overlay form, 3800 character
arrangement table, 3800 vertical formatting, 3800 copy modifications,
the number of copies to be printed by 3800 with overlay form, and the
placement of 3800 LOAD CCW's within a 3800 spool file) is displayed.
Once a printer file starts printing,
response to a QUERY PRlNTER command.

it does

not

appear in

the

If a reader file
appears to be lost, due to the virtual machine
abnormally terminating without closing the reader, you can issue the
command CLOSE READER HOLD to try to recover the reader file.
To terminate the displaying of the response to a QUERY READER, QUERY
PRINTER, or QUERY PUNCH command, press the Attention key
(or its
eguivalent).
!Qte: For further information on altering spool
to the CHANGE command in this section.

124

file attributes, refer

IBM VPI/SP CP Command Reference for General Users

QUERY

r

,

,tab...
I
IMHED} ,copy...
,
PFnn { DELAY Ipfdatal ••• 1
L

The program function defined for a program
displayed.
If there is no function defined
function k~y, the following message is issued:

function
for the

key is
program

PFnn UNDEFINED

1.

! logical line end character imbedded in pfdatal appears as a
carriage return in the response to a QUERY PFnn command.

2.

In the case of PFnn COpy or PFnn TAB, the existence of
unnecessary or lack of trailing blanks may negate the function
and force the PF key to be recognized as pfdata.

USEB
RECEIVER SYSNAHE PRTY IPLD ENBLD IN USE
USERF
USER!
AREA 6 0015 NO
NO
NO
0001-0002 0006

DATE/TI~E

NIA

VaLID
TND198

USER

is the userid of the user who can store into the area or IFL
the area (the owner of the area).

RECEIVER

is the userid of the user who can IPL the area.

SYSNAHE

is the name of the
command.

PRTY

is the priority number of 'this area.

IPLD=YES

indicates that either the owner or the receiver is currently
loaded from the area.

ENBLD=YES

indicates that
area.

IN USE=YES

indicates that a VMS!VE area that overlaps this one is in
use by some user (the area has been loaded, V!SAVE has
enabled, or a system is already saved in the area) •

DATE/TIHE=NONE indicates
area.
DATE/TIME=N/A

area specified on

the owner has issued

that ro

system is

a SET VMSAVE

a SET VMSAVE

or IPL

for this

currently stored

in this

indicates one of the following:

•

The DASD volume is not mounted or is not CP owned.

•

An overlapping area
valid system.

is enabled for VMSAVE

or contains a

section 5. Format of CP Commands

125

QUERY

is the volume serial number of the target volume.

VaLID

The second and subsequent lines indicate the page range associated with
this area.
A page range is indicated by the first and last page numbers
of the range separated by a hyphen. A single page is simply indicated
by the page number.
For a saved system, these pages are the ones that
were stored, and the ones that are loaded by the IPL command;
for a
virtual machine with VMSAVE enabled, this is the list of pages that are
saved when and if the virtual machine is terminated by VM/SP or when
VM/SP itself terminates. See the discussion on the VMSAVE option in the
!!L~R
~I21~~ f~gg~!~~~
~ig~
for more information regarding the
specification and use of the VMSAVE option.

r

,

S370E {ON }'PROC xx, {ON} PROC yyl
OFF I
OFF
I
L

.J

This command tells you whether or not the system/370 Extended
(hardware) special feature has been installed and, if installed,
whether or not the feature has been enabled by the VM/SP system
operator.
When installed and enabled, an MVS virtual machine may
use the feature after the MVS operator of that virtual machine has
issued the SET 370E command.
With attached processors, the VM/SP system operator may enable
the feature for either or both processors. When enabled for only
one processor, you must SET AFFINITY ON for that processor before
VM/SP accepts the SET 370E command.

PROCESSOR mm ONLINE[, PROCESSOR nn ONLINE, SYSTEM IN

{~:}

MODE]

mm

is the processor ID number of the main processor if VM/SP is
runninq in UP or AP modes; in SP mode, it is the processor ID
number of the IPt processor.

nn

is the processor ID number of the attached processor if VM/SP
is running in AP mode; in MP mode, it is the processor ID
number of the non-IPL processor.

If VM/SP is running in uniprocessor mode, the bracketed
response is omitted.
If V~/SP is running in AP or
bracketed portion of the response is displayed.

126

IBM VS/SP CP Command Reference for General Users

portion of the
SP modes, the

QUERY

SPMODE

{ON}
OFF

In a VM/SP system, this response indicate~ whether or not VM/SP is
operating in single processor mode. If it is, VM/SP uses only the
main processor in the configuration; the V=R virtual machine has
exclusive use of the other processor.

!.Q!!: When

V~/SP is AP or MP
generated and SPMODE is off, the user
can reset the affinity setting of the virtual machine after the
attached processor or non-IPL processor has been varied online -Vl1/SP has resumed AP or MP mode.

au ERY Command for all Classes of Users (Except
Class Any)
This form of the QUERY command is for all classes of users except those
in the Any category.
Use this form of the QUERY command to:
•
•
•

Display the log messages.
List all the users that are logged OD.
Display the number of users that are logged on or dialed to VM/SP.

The format for this QUERY command is:
r

!

,

Query

~~::~::

[userid]

t

, - - -_______________________________________________________________
{userid
)
L
----J

LOGMSG displays the log messages of the day.
NAMES
displays a list of all the users logged on and the real
address of the line to which each is connected. If a user is
disconnected, the abbreviation DSC is printed instead of the
line address.
USERS
displays the number of logged on users and the number of users
logically connected to other virtual machines.
USERS userid
user id
displays the user identification and the terminal device
address of the specified user if he is logged on. If the user
is not logged on, a message to this effect is issued. Use the
QUERY USERS userid format if the userid is the same as an
operand of the QUERY command (for example, TAPES).
Note: It is possible for the number of users logged on as indicated by
the "NAMES" operand to differ from the number of users indicated by the
"USERS" operand if the QUERY command is executed while users are in the
process of logging on or logging off the system.

section 5. Format of CP Commands

127

QUERY

*

logmsg text line

*

logmsg text line n
All lines
(both those with an
message file are displayed.

user id
userid

asterisk and

withou~

in

the log

{~;~dr
}'
resid

- {DSC
rad~r }'
res~d

VSM

- (userid},

userid - (luname},
Lnnn

- vaddr
A list of all logged-on users is displayed;
if the user is
currently connected, the real address (raddr),
or the resource
identification of a 3704/3705 line (resid) to which he is connected
is displayed;
if he is not connected to the system,
DSC is
displayed.
The userid - luname response displays the userids and
logical unit names
(lunames)
of all users accessing the VM/SP
system in a SNA network through the VTAM Service Machine (VSM).
The VSM userid displays the userids of all users connected
through that particular VSM to the host VM/SP system.
If your
installation has the VM/Pass-through program product, Lnnn displays
the logical device name of the user accessing the host VM/SP system
through the Pass-through virtual machine;
vaddr is logical address
of that user.

128

IBM VK/SP CP Command Reference for General Users

QUERY

nnn USERS, mmm DIALED, xxx NET
The number of users logged on and dialed to VM/SP is displayed.

nnn

is the total nunber of logged-on users.

mmm

is tne total number
machines.

xxx

is tne total nunber of users logged
network.

of users

attached via

DIAL to

virtual

on through a VSM in a SNA

MQi~:

DIALED means the line is not available to CP because it is
logically attached to a multiple-access virtual machine and is a
part of that user's virtual machine operation.

userid - {rad~r }
res~d

luname
The real address (raddr)
or the
3704/3705 line (residt to which the
displayed.
The luname is displayed
if that user is logged on through
Service Machine.

resource identification of a
specified user is connected is
instead of the raddr or resid
a SNA network using the VTAM

Section 5. Format of CP Commands

129

READY

READY

Use the READY command to
specified virtual device.

set a device-end interruption pending
The format of the READY command is:

for a

r

I

READY

vaddr

'--

vaddr

is a virtual device address (cuu).

1.

The status of the virtual machine is unchanged.

2.

Other than having a device-end
device is unchanged.

interruption pending,

None.

130

IBM va/sp CP Command Reference for General Users

the virtual

REQUEST

REQUEST

Use the REQUEST command to make an attention interrupt
virtual console. The format of the REQUEST command is:
r

,

pending at your

REQuest

L

1.

The REQUEST command performs the same functions as ATTN and the two
commands can be used interchangeably.

2.

CP iqnores the REQUEST command if any I/O operation is in progress
at the console or if other interrupts are pending. This condition
may result if the user issues the REQUEST command by means of
DIAGNOSE X I 8'.

None.

Section 5. Format of CP Commands

131

RESET

RESET

Use the RESET command to clear all pending interrupts from the specified
virtual device.
The format of the RESET command is:
r

I

RESET

L ___
" _ _ _ _ __

vaddr

1.

vaddr

is a virtual device address (cuu) of the device to be reset.

In addition to
clearing all pending interrupts,
all error
conditions occurring as a result of unit checks and virtual sense
bytes are reset.

2.

When the DIAL command is issued from
virtual system user must use the CP
dialed connection~

DEVICE RESET
is the response
the command.

132

a local 3270 terminal, the
command RESET to drop the

you receive upon the the

successful completion of

IBft V8/SP CP Command Reference for General Users

REWIND

REWIND

Use the REWIND command to rewind
(but not unload) a real tape unit
attached to your virtual machine at a specific virtual device address.
The format of the REWIND command is:
,.---,L---___________
REWind
_ vaddr

vaddr

is the virtual device address
rewound.

(cuu) of

the tape unit

The REWIND command accomplishes the manual operation of
making the tape ready at the tape unit.

to be

rewinding and

REWIND COMPLETE
is the response
you receive upon the the successful initiation of
the command. Receiving this message does not imply that the tape
is physically rewound yet.
REWIND NOT PERFOR~ED
is the response you receive if the real tape unit is not ready.

Section 5. Format of CP Commands

133

SCREEN

SCREEN

Use the SCREEN command to alter or change any color and/or extended
highlight definitions for your virtual machine console.
You may issue
the command from any IBM
supported terminal or from a PROFILE EXEC
because the SCREEN command is not device dependent.
You can assign color and extended highlighting values to six distinct
display screen areas: the input area, the system status area, and the
output area that encompasses three other areas: CP output, virtual
machine output, and an input redisplay area. The physical attributes of
3270 Information Display station screens vary according to model. Por a
general discussion of screen layout and the way CP handles color and
extended h~9hlight definitions, refer to "Section 2. Display Terminals"
in !!1L2g !~£.!!ingl Us~!~ ~.Yi de.
The format of the SCREEN command is:

---------,

r-----

,,,
,,
,,
,
I

SCREen

I: { area
I

f 'I { color J
~!Fa'y!!

{

exthili9ht}", } t
lONe
I

L

J

J

lEach time you enter the command, you must specify at least one
screen 'area' operand with at least one 'color' and/or 'exthilight'
value. You may specify more than one 'area' operand on the same
command line.
L---_________________________
. ___________________________ - - - - - -

!!..her~:

area

134

specifies the area of the screen.

Area can be:

ALL

the entire screen.
If you specify this operand, you
cannot specify any other area on the same command.

INArea

the input area.

STAtarea

the system status area.

OUTarea

the output area.
The OUTAREA operand encompasses
the next three areas. If you specify OUTAREA, you
cannot specify CPOUT, VMOUT, or INREDISP on the same
command line as OUTAREA.

CPOut

is the output from the VM/SP control program. You
may not specify CPOUT on the same command as
OUTAREA.

VMOut

is the output from CMS or the virtual operating
system running in your virtual machine. You may not
specify VMOUT on the same command line as CUTAREA.

INRedisp

is your input redisplay.
You may not specify
INREDISP on the same command line as OUTAREA.

IBM VM/SP CP Command Reference for General Users

SCREEN
color

specifies the color attribute you want
of your screen. Color can b~:

to assign to an 'area'

BLUe -- blue
RED -- red
GREen -- green
YELlow -- yellow
TURquois-- turquoise
PINk -- pink
WHIte -- white
~!lSull -- monochrome is the default.
exthilight specifies the extended highlight value you want to assign to
an area of your screen. The exthiligbt value can be:
BLInk -- blinking
REVvideo -- reverse video
UNDerlin -- underlining
!2~~ -- no extended highlighting

1.

If you issue the SCREEN command from a terminal that does not
support color and/or extended highlighting, CP still sets the
values you specify for your virtual machine console. Then, if you
disconnect from that terminal and logon at a terminal that does
support color and/or extended highlighting,
the values you set are
inplemented for your virtual machine after the reconnection. The
color and extended highlighting values remain in effect for the
duration of the current terminal sessicn unless you alter them with
other SCREEN commands.

2.

You cannot specify a particular 'area'
the same SCREEN command line.

3.

If you enter the SCREEN command and you fail to enter any operands
(or enter invalid operands), command processing terminates, you
receive an error message, and the color and extended highlighting
values in effect for your terminal remain unchanged by the invalid
command.

operand more than

once on

section 5. Format of CP Commands

135

SCREEN

If you enter:

SCREEN aUTAREA RED NONE INAREA GREEN BLINK STATAREA PINK UNDERLIN
CP

s~ts

the following values for your terminal:

!lt~!

cpout
}
vmout
outarea
inredisp
inarea
statarea

red
red
red
green
pink

none
none
none
blinking
underlining

None.

136

IBM VM/SP CP Command Reference for General Users

SEND

SEND

Use the SEND command to pass commands and message replies from the
secondary user's console to disconnected virtual machines for execution.
The format of the SEND command i£:
,---

I SEND

, {CP]

use rid

[ text ]

L-

CP

indicates that CP executes the text in behalf of the receiving
virtual machine.
If the first three bytes of text are 'ICP'
or if the receiving
virtual machine is already in CP READ
state, the user need not specify the CP operand when sending a
CP command.
If the SEND command does not include text, CP
puts the receiving virtual machine into console function mode.
This operand is equivalent to the tcp command.

userid

represents the disconnected virtual
machine that has
specified secondary user (secuser) in its directory entry.

text

can be any command allowed in the virtual machine command
environment or a reply to a message issued by the disconnected
virtual machine. CP passes the text to the disconnected
virtual machine for processing.
If the user wants to send
multiple lines in the text, he must use the logical line end
(I) immediately preceded by the logical escape character (");
in addition, the user must have line editing enabled in his
virtu al machine.

a

Usag§ B.Qte§:
1.

The issuer of the SEND command must be authorized by the secondary
user
(seeuser) by means of the secuser operand of the CONSOLE
statement in the directory entry of the receiving virtual machine.

2.

The receiver
disconnected.

of

the

SEND

command

input

must

be

running

None.

section 5. Format of CP Commands

137

SET

SET

Use the
system.

SET command to control various functions within
The format of the SET command is:

your virtual

r-----

f / SET

ACNT
AUTOPoll
MSG
SMsg
WNG
IKSG
RUN
LINEDit
ECmode
ISAM
NOTRans
PAGEX
EMSG

ON
OFF

fa I
fa }
OFF
CODE
TEXT

TIMER

OFF
REAL

AF,Fini ty

, ,,
r

IQ! I
.IOFFI

..

L

CPUid

bbbbbb
r

ASsist

,

,

r

r

,

L

.J

ION I I~!~ I tTMR 1
t
t ,NOSVCt I!!QII1Rt
L

.J

L

.J

OFF
r

PFnn 11M Med
IM1i!~ed
L

,
I (pfdata1#pfdata2# ••• pfdatan]
I
.J

PFnn (TAB n1 n2 •••

]

PFnn (COpy (resid] ]
PFnn [COpy (cuu ] ]
PFnn (COpy (luname ] ]
L-

-----'

(Part 1 of 2)

138

IBM VM/SP CP Command Reference for General Users

SET

VIISAVE {ON

}

OFF
name

STBypass

, ,

r

r

tnnnnnK
InnM

I NOVEBIFYI I
t
I t

L

L

..

VB
OFF
ST~ulti

l

rr

,

.II

"!

n II USEG xxi CSEG YYYI'
,I
ON
I

t "

LL

OFF

..

....

370E {ON }
OFF
L

(Part 2 of 2)

ACNT

{~:F}
controls whether accounting information is displayed at the
terminal or not
(ON and OFF, respectively)
when the operator
issues the
CP lCNT command.
When you log on VM/SP,
AeNT is
set on.

AUTOPOLL

{~;F}

controls whether or not cp tests each BTAM autopoll CCW to see
if it has been dynamically modified.
ON indicates that (1) CP
bypasses testing, and
(2)
the VS1
operating system is to
notify CP, via the DIAGNOSE instruction code X'0028', after an
autopoll CCW has been modified.
ON substantially reduces the
overhead required by CP to service BTAM autopoll channel
programs. OFF causes CP to check each autopoll CCW after each
execution of the channel program and is the default status
when the user logs on.
If you SET AUTOPOLL ON and the virtual operating system
does not have the appropriate Diagnose interface, CP does not
detect changes to BTA~ channel programs and unpredictable
results can occur. OS/VS 1 Release 6.0, however,
does have
this interface.

!2!~:

KSG {ON}
OFF
controls whether messages sent by the MSG command from other
users are to be received at the terminal. If ON is specified,
the messages are displayed.
If OFF is specified, no messages
are received.
In addition to controlling messages generated
by the MESSAGE command, spooling messages generated by users
sending punch, printer or reader files to another virtual
machine are also suppressed if OFF is specified.
When you log
on V"/5P, MSG is set on.

Section 5. Format of CP Commands

139

SET
saSG

{~:F}

controls whether a virtual machine is receiving special
messages or not. If OPF is specified, the virtual machine
cannot receive special messages.

WNG {ON }
OFP
controls whether warning messages
are displayed at the
terminal. If ON is specified, all warning messages sent via
the CP WARNING command from the system operator are received
at the terminal.
If OFP is specified, no warning messages are
received. When you log on VK/SP, WNG is set on.
IaSG

{~:p}
controls whether certain informational responses issued by the
CP CHANGE,
DEFINE, DETACH, IPL, ~DER, PURGE, and TRANSFER
commands are
displayed at
the terminal
or not.
The
descriptions of these CP commands tell which responses are
affected. If ON is specified the informational responses are
displayed. If OFF is specified, they are not. The SET IMSG ON
or OFF command line has no effect on the handling of error
m~ssages set by the SET EMSG
command. When you log on VM/SP,
I!SG is set on.

RUN {ON }
OFF
controls whether the virtual machine stops when the attention
key is pressed. ON allows you to activate the attention key
(causing a read of a CP command) without stopping your virtual
machine. When the CP command is entered, it is immediately
executed and the virtual machine resumes execution.
OFF
places the virtual machine in the normal CP environment, so
that when the attention key is pressed, the virtual machine
stops. When you log on VM/SP, RUN is set off.
LINEDIT

{~;F}

controls the line editing functions.
ON specifies that the
line editing functions and the symbols of the VM/SP system are
to be used to edit virtual processor console input requests.
This establishes line editing features in systems that do not
normally provide them. OFF specifies that no character or line
editing is to be used for the virtual machine operating
system.
When you log on VM/SP, LINEDIT is set on.
The
LINEDIT operand is unaffected by the setting of the APL/TEXT
operand of the TERMINAL command.

ECMODE

{~=F}

controls whether the virtual machine operating system may use
System/370 extended control mode and control registers 1
through 15. Control register 0 may be used with ECMODE either
ON or OFF. When you log on VM/SP, ECMODE is set according to
the user's directory option; ON if ECMODE was specified and
OFF if not.

!Q!~:

Execution of the SET ECMODE
causes a virtual system reset.

140

{ONIOFF} command

IBM VK/SP CP Command Reference for General Users

always

SET

{~;F}

ISAM

controls whether
I/O requests to
Sequential Access
is set according
was specified and

ROTRANS
{

additional checking is performed on virtual
DASD in order to support the OS Indexed
Method
(ISAM). When you log on VM/SP, ISAM
to the user's directory options; O~ if ISAM
OFF if not.

ON }

OPF
controls ccw translation for CPa ROTRANS can be specified
only by a
virtual machine that occupies the virtual=real
space. It causes all virtual I/O from the issuing virtual
machine to bypass the CP CCW translation except under the
following conditions:
•
•
•
•
•
•

510 tracing active
First ecw not in the V=R region
1/0 operation is a sense command
1/0 device is a dial-up terminal
1/0 is for a non-dedicated device
Pending device status

Any of the above conditions forces

eel

translation.

To be in effect in the virtual=real environment, SET NOTRANS
ON must be issued after the virtual=real machine is loaded via
the IPL command.
(IPL sets the NOTRANS option to an OFF
condition.)
PAGEX

{~;F}

controls the
pseudo page fault
portion of
the VM/VS
handshaking feature. PAGEX ON or OFF should only be issued for
a virtual machine that has the VM/VS handshaking feature
active. It can only be specified for a virtual machine that
has the extended control mode
(ECMODE) option. PAGEX ON sets
on the pseudo page fault portion of handshaking;
PAGEX OFF
sets it off. When you log on to VM/SP, PAGEX is set OFF.
Also, each time you IPL your virtual machine, PAGEX is set
off.
If you want to use the pseudo page fault handling
portion of handshaking, you must issue SET PAGEX ON after you
load your operating system.

EMSG

fg~~El
(TEXT)
controls error message handling. ON specifies that both the
error code and text are displayed at the terminal.
TEXT
specifies that only text is displayed. CODE specifies that
only the error code is to be displayed. OFF specifies that no
error message is to be displayed. When you log on VM/SP, EMSG
is set to TEXT.
If the console is being spooled, the OFF setting is ignored
for the spooled output and the full error message appears in
the spooled output.
The other three settings result in
spooled output that matches the console printout.

Section 5. Format of CP Commands

141

SET
Iote: CMS recognizes EKSG settings
for all error
(E),
information (I),
and warning (W) messages, but ignores the
EKSG setting and displays the complete message (error code and
text) for all response (R), severe error (S), and terminal (T)
messaqes.
Also, data written by means of type in, such as a
list of names following a message, are not controlled by the
EKSG operand.
TIKER

{ ~;F }

REAL
controls the virtual timer.
ON specifies that the virtual
timer is to be updated only when the virtual processor is
running. OFF specifies that the virtual timer is not to be
updated.
REAL specifies that the virtual timer is to be
updated during virtual CPU run time and also during virtual
wait time.
If the REALTIKER option is specified in your VK/SP
directory entry, TIKER is set to REAL when you log on;
otherwise it is set to ON when you log on.
r

,

AFFINITY IOFFI
ION I
L

~

controls whether or not CP dispatches a virtual machine and
execute its programs on either the main processor, the
attached processor of an attached processor system or the
nonIPL processor of a multiprocessor system.
Normal mode is
AFFINITY OFF, allowing virtual machine execution on either
processor.
AFFINITY ON
causes
the
directory to
be
interrogated for an affinity setting; if there is none in the
directory,
the user receives an informational message.
In
uniprocessor mode, affinity is meaningless because all virtual
machines execute on the main processor.
When affinity is in effect for a virtual machine, only the
specified processor runs the
virtual machine.
This is
particularly useful for virtual machines that require features
or performance enhancements that are only available on one
processor in an attached processor or multiprocessor system.
CP instructions (such as privileged operation instructions)
executed on behalf of a virtual machine are not restricted to
a processor by an affinity setting.
CPUID

bbbbbb
CPUID is the keyword that provides a means of setting or
changing the CPU identification for a virtual machine. The
variable value bbbbbb represents a string of six hexadecimal
digits that permit unique identification of the CPU.
This
command allows the user to provide a unique CPU identification
to be stored in response to the 'STIOP' instruction.
It is
necessary to associate a unique CPUIO with each virtual
machine
that
is
attached
to
an
MSC
port
since
solicited/unsolicited messages are directed to the host system
by means of the CPUID.
There is no checking by VM/SP to
ensure that all virtual machine using the SET CPUID command
have specified unique CPU serials.
The hexadecimal field
'bbbbbb' is the CPU identification number (CPU serial).
!ot~:

The CPU identification number (serial) is only a portion
of the complete CPUID.
The CPUID identification stored in
resporise to a STIOP instruction is a string of 16 hexadecimal
digits as follows:
aabbbtbbccccdddd

142

IBM VK/SP CP Command Reference for General Users

SET

version code; these two digits are forced to X'PP'
to identify', that the virtual machine is running
under VM/SP.

bbbhbb -

CPU identification number; this field contains six
hexa~~cimal digits.
This is the only part of the
CPUID that can be set by the DIRECTORY OPTION
control statement and modified by means of the SET
CPUID command.

cccc

model number;
this field contains a
digit followed by the three digits
number
(0-9). This field defaults
number of the real machine.

dddd

machine check extended logout; this field is forced
to X'OOOO' since CP does rrot reflect machine checks
back to the virtual machine.

, ,

r
'§I~

,

ION I

L

L

.J

r

ASSIST

aa

,

.J

r

high order 0
of the model
to the model

,

I ITMR I
I NOSVC I , NO ll!!J
L

.J

OFF
All functions of SET ASSIST operands pertain to VM/SP hardware
assist. VM/SP hardware assist consists of processor hardware
that assists the processor in the execution of certain
instructions, series of instructions, privileged operat,lons,
and interrupt processing that are normally handled by the
control program portion of VM/SP.
In attached processor or
multiprocessor systems, VM/SP hardware assist is available for
installation on either or both processors.
All, some, or none of the function performed by VM/SP hardware
assist may be available on the processor, attached processor,
or nonIPL processor that the virtual machine is logged on.
(For the extent of VM/SP
hardware assist available on
supported VM/SP processors, refer to the !~L§f Q~~~!tot's
Guid~.)
The extent of VM/SP hardware assist available to your
virtual machine can be determined by invoking QUERY SET and by
the res~onses to attempts to invoke the various operands of
SET ASSIST.
The hardwace assist functions can only be
activated for an individual virtual machine provided the VM/SP
system operator
permits the associated
hardware assist
function to be active for the entire system (or in attached
processor
or
multiprocessor
systems,
the
appropriate
processor) •
Overall system control of hardware assist is
controlled by SET SASSIST and SET CPASSIST commands; see the
!~L~ Q~~s12!~ Quig~ for details on these commands.
If VM/SP hardware assist is active for the entire' system, then
hardware assist is active and used during virtual machine
operations immediately after logon. Hardware assist as it
pertains to a virtual machine can then be turned off and on
again by SET ASSIST OPP and SET ASSIST ON respectively.

Section 5. Format of CP Commands

143

SET
The SVC handling portion of the hardware assist is invoked
when you log on unless your VM/SP directory entry has the
SVCOFF option. Issue the QUERY SET command line to see if the
hardware assist is activated and whether the hardware assist
or V~/SP is handling SVC interruptions. All SVC 76 requests
are passed to CP for handling, regardless of the SVC and NOSVC
operands.
If you issue the SET ASSIST command line, and
specify SiC or Nosve while the hardware assist is turned off,
the appropriate bits are set. tater, if hardware assist is
turned on again, the operand you specified while it was off
becomes effective.
ON sets the hardware assist on for the
virtual machine;
OFF turns it off.
SVC specifies that the
hardware assist handles all SiC interruptiQns except SVC 76
for the virtual machine; Nosve means VM/SP handles all the SVC
interr upti on s.
If the user requests VM/SP hardware assist and it is available
and active, the request is honored; if VM/SP hardware assist
is not active but is available and the user attempts to enable
hardware assist,
the virtual machine remembers the enabling
attempt and an appropriate message is sent to the user. When
the system operator enables hardware assist, it is immediately
utilized by the virtual machine. In the event that hardware
assist is
not
available or active on
the system, an
appropriate error message is issued.
In an attached processor
or multiprocessor system, hardware assist is available to any
virtual machine provided it is installed on one of the
processors; then, to use hardware assist, the virtual machines
affinity must be set to match the processor that contains
hardware assist.
The TMR and NOTMR operands control the method of updating the
virtual interval timer (virtual address X' 50').
If' TMR is
specified, the virtual interval timer assist hardware updates
the virtual interval timer in the same way that the real
interval timer is updated, that is, 300 times per second. If
NOTMR is specified, the virtual interval timer is updated only
when CP is given control. This can be as seldom as once per
time slice interval.
See the !~~~ ~~§!~!
f~Qg~~~~2
~y!~~
for
information on how to use VM/SP hardware assist.
r

additional

,

1!21tAYE~

I [pfdata1tpfdata2# ••• pfdatan]
t

L

..

PFnn ,IKMED

defines a
program function for a program function key on a
3270 Information Display station and indicates when that
function is to be executed. If PFnn is specified with no
operands, that program function key is considered "undefined."
See the VML~f ~~~~iR~! y§~~~§ ~uide for a description of how
to use the 3270 program function keys.
In PFnn, nn is a number from 1 (or 01) to 24 that corresponds
to a key on a 3270 display station. The program function is a
programming capability you create by defining a series of
VM/SP commands or data you want executed. This series of
commands is executed when you press the appropriate program
function key.
IMMED specifies
that the program function
is executed
immediately after you press the program function key.

144

IBM VM/SP CP Command Reference for General Users

SET

DELAYED specifies that exec~tion of the program function is
delayed for a display terminal. When the program function is
entered, it is displayed in the input area and not executed
until you pr~ss the Ent~r key. DELAYED is the default value
for display terminals.
pfdatal#pfdata2 •••• pfdatan
defines the VM/SP command or data lines that constitute the
program function.
If more than one command line is to be
·entered, the pound sign (#) must separate the lines. If you
use the pound sign
(#) to
separate commands that you ~ant
executed with the designated PF key, you must precede the
command line with ICP, turn line editing off, or precede each
pound sign with the logical escape character ("). For further
explanation, see the "Usage Notes" section that follows. If
no command lines are entered following the· PFnn designation,
then the program function is marked undefined.
Program
functions cannot be embedded within one another.
PFnn [TAB n1 n2 ••• ]
specifies a program function kay number to be associated with
tab settings on a terminal. The number of the PF key, nn, can
be a value from 1 (or 01) to 24. If the TAB keyword and tab
settings are not entered, that program function key is
considered "undefined." For examples of how this feature is
used,
see the !~~f ~~~ ~2~~~2 ~Y1~~.
TAB is a keyword
identifying the tab function .• The tab settings (n1 n2 ••• ) may
be entered in any sequence.
!Q!~:

When defining the TAB function, the existence of blanks
preceding the keyword TAB or the lack of trailing tab settings
forces the PF key to be treated as pfdata.

PFnn [COpy (res id ] ]
specifies that the program function key numbered nn performs a
COpy function for a remote 3270 Information Display terminal.
The number,
nn, must be a value from 1 (or 01) to 24. The
COpy function produces a printed output of the entire screen
display at
the time the PF key is actuated. The output is
~rinted on an
IBM printer connected to the same control unit
as your display terminal.
The PF key COPY function is not
available for dedicated 3284, 3286, 3287, 3288, and 3289
printers.
The
resource identification,
resid, may
be
specified if more than one printer is connected to the same
control
unit
as
your display
terminal.
It
is
a
three-character hexadecimal resource identification number
assigned to a specific printer.
If resid is entered, the
printed copy is directed to a specific printer; if not, the
copy is printed on the printer with the lowest resid number.
The resid numbe~s of the printers available to your display
terminal can be obtained from your system operator. If only
one printer is available, as with the 3275 Display Station,
resid need not be specified.

section 5. Format of CP comman~s
!

145

SET

PFnn [COpy [cuu]]
specifies that the designated program function key. Plnn.
performs a COpy function for a local 3270 Information Display
terminal.
The number of the PP key.
nn. must be a value from
1
(or 01)
to 24.
When the PP key is pressed, the COPY
function produces a printed output of the entire local screen
display except for the status field, which is replaced with
blanks. The cuu
represents the real hardware address of the
display printer, and may specify a printer that is on a
different control unit than the one to which your 3210 is
attached.
If you do not specify cuu,
the printer with the
lowest cuu that is available on the same control unit as your
3270 is selected.
PFDn [COpy (luname]]
specifies that the program function key numbered nn performs a
COpy functicn for a SRA terminal. The number, nn,
must be a
value between 1
(or 01) to 24. The COPY function produces a
printed output of the entire screen display at the time the PP
key is pressed.
The output is printed on an IBM printer
connected to the same control unit as your display terminal.
CP does not know the real address (raddr) of the logical unit
(LU device), so you must specify a one to eight character
luname (logical unit name).
Not~§:

1.

For both remote and local COpy functions:

You receive a NOT ACCEPTED message, displayed in the screen status
field of your 3270, if any of the following situations occur:
•

The printer is already busy, or all printers are busy.

•

The printer is turned off.

•

The printer is operational but has not been varied online by the
system operator.

•

The
printer
is out
of
paper
intervention-required condition.

•

or

is

in

any

other

The designated printer does not support the copy functions.
See
ang ~§!~ 2~~!g!i2n 2Yig~ for a list of 3270
Information Display printers that support the COPY function.

!~2~ ~lgBning

•

The SET PFnn COPY command format is invalid.
You may include your own identification on the printed output by
~t~ring the data into the user
input area of the screen before
you press the PF key. The identification appears on the last two
lines of the printed copy.

2.

To insure the definition of a PF key for the COPY function. you can
either start with one leading blank before the keyword COpy or
follow the keyword with at least five blanks.

3.

The existence of more than one data field (cuu or resid) following
the keyword COpy identifies the string as pfdata rather than a
hardcopy request.

146

IB! VK/SP CP Command Reference for General Users

SET

VMSAVE

}
{ ~;F
name
controls the status of the VMS AVE option.
ON enables the
option for the user with exactly one DASD area. OFF disables
the option for the user~ The name operand allows a user with
one or more DASD areas to designate which DASD area is to be
enabled. When the name operand is used, the name must be
ident~cal to
the name used in the SYSNAME parameter of the
NAMESYS macro in the DMKSNT module.
The DEFINE STORAGE
command t~rns VMSAVE off. See the !~L~f ~~~te~ f~Q~~mer'2
gYi~~ for more information.
Note, when specifying the VKSAVE
option, the
virtual machine
size cannot
exceed eight
megabytes.
r

STBypass

,

InnnnnK [NOVERIFY] I
InnM
I
L

.J

VR
OFF
allows V=R users to eliminate and reestablish shadow tables.
Allows V=V users to reduce shadow-table processing.
nnnnnK defines in thousands of bytes the highest contiguous
storage a1dress starting from zero where the virtual and real
addresses are equal for a virtual machine running in a V=V
area.
The value is rounded down to the nearest full page
boundary.
nnM defines in
millions of bytes the highest contiguous
storage a1dress starting from zero where the virtual and real
addresses are equal for a virtual machine running in a V=V
area.
NOVERIFY prevents the. scanning of a virtual machine's page and
segment tables.
VR eliminates shadow
the VM/SP V=R area.

tables for a virtual

machine running in

OFF terminates the shadow table bypass function.
STMulti

l

in IIUSEG xxi CSEG
IONII
I

L

LL

YYYII!
II

.J

....

OFF
allows users running in the system V=V area to have VM/SP
maintain multiple shadow tables when a virtual operating
system, such as MVS, SVS and VM/SP itself, uses multiple
segment tables.
n defines the
maximum of 6.

number

ON establishes the
shadow tables.

of shadow

system default

tables
of

between
3 for

1 and

the number

the
of

USEG xx defines the size of the contiguous preallocated pool
of shadow page tables.
xx is the number of shadow page tables
in each pool (one pool per set of shadow tables)
and ranges
from 0 through 99.
The USEG operand is only valid when
STMULTI n or ON was previously specified.

Section 5. Format of CP Commands

147

SET
CSEG yyy defines the number of full segments at the high end
of the address space that are shared by all address spaces.
The value of yyy ranges between 0 and 128 and represents the
number of shadow page tables to be allocated for CSEG.
OFF sets the number of shadow tables to 1.
370E

{~;F}
provided the System/370 Extended (hardware) special feature
has been installed and the VM/SP system operator has enabled
it, this operand allows you to execute the OS/VS2 MVS/System
Extensions Program Product (program number 5740-XE1)
or any
other operating systems capable of using the 370E feature.
To determine whether the product has been installed
enabled, iS$ue the QUERY S370E command.
To determine
status of the feature for your virtual machine, issue
QUERY SET command.

and
the
the

With attached processors, the VM/SP system operator may
enable the feature for either or both processors.
When
enabled for both processors, the SET 370E command operates as
previously explained.
When only one processor is enabled, you
must SET AFFINITY ON for that processor before VM/SP accepts
t heS ET 37 OE command.

1.

System default values for SET operands or the values set by
previously invoked SET command operands can be determined by the
use of the QUERY command.

2.

SET'TIMER REAL must be specified if an interrupt-driven system such
as customer Information Control System (CICS) is to be run in a
virtual machine.

3.

Both SET PFnn TAB and SET PFnn COpy are executed immediately upon
pressing the appropriate program function key. If you insert the
keywords DELAYED or IMKED after the PFnn operand, the command is
accepted, but the keywords are ignored. The program function still
executes immediately.

4.

In the case of systems with attached processors or multiprocessors,
the VM/SP hardware assists may be installed on none, one, or both
processors.
Similarly, hardware assist, if equipped on both
processors of an attached processor or multiprocessor system, can
be activated for none, either, cr both systems by the system
operator.
Thus, with the AFFINITY setting of a virtual machine,
the user can receive no response indicating tha t
VM/SP hardware
assist is installed and active on his processor. In attached
processor or multiprocessor setups where the user has no processor
preference (AFFINITY=NONE) upon entering SET ASSIST he too receives
no response if either processor has VK/SP hardware assist active.
Any error message is indicative that VM/SP hardware assist is not
available or active for user.
If the user receives a message
indicating that VK/SP hardware assist is not available on a
particular processor it is also implying that it is available on
the other processor.
Therefore, the user,
to take advantage of
VM/SP hardware,
need only change his affinity setting, then
initiate the SET ASSIST command.

148

IBM VM/SP CP Command Reference for General Users

SET

5.

If you plan to issue an ADSTOP command, you must first issue a SET
RUN OFF command.
This command allows the virtual machine to halt
execution at the address specified on the ADSTOP command line.

6.

If you use the SET PFnn command to set up a series of concatenated
commands. you should be careful of line-editing characters. The
following examples demonstrate two methods for entering a series of
commands:

Enter the following command while in CMS mode:
set linedit on
and press the enter key.
Now enter one of the following commands while in CMS mode:
#cp set pf02 immed q rdr#q prt'q pun
-- or
cp set pf02 immed 9 rdr"#q prt"iq pun
or
set pf02 immed q rdr"#g prt"tg pun
and press the enter key.
CP assigns the three QUERY commands as functions of the
Pressing the PF02 key executes the three QUERY commands.

PF02 key.

Section 5. Format of CP Commands

149

SET

Enter the following command while in eMS mode:
set linedit off
and press the enter key.
Then enter:
set pf02 immed q rdr#q prt#q pun
or
cp set pf02 immed q rdrtq prttq pun
and press the enter key.
CP assigns the three QUERY commands as functions of the PF02 key.
T hen enter:
set linedit on
and press the enter key.
Pressing the PF02 key executes the three QUERY commands.

None.

150

IBM VM/SP CP Command Reference for General Users

SLEEP

SLEEP

Use
but
the
the

the SLEEP command to place the virtual machine in a dormant state
allow messages to be displayed. You can specify a sleep interval in
command line and the virtual machine is awakened automatically when
specified interval has elapsed. The format of the SLEEP command is:

r---------------------------~--------------------------------------~

r

,

r

"

,SEC"

Inn Ill!!! I ,
I
,HRs"

SLeep

L

.1.1

------------------------------------------------~~

r

r

"

I

,SEC, I

L

L

,nn Ul!!! I'
I
IHRsit
.1.1

indicates the number of seconds r minutes, or hours r measured
by the time-of-day clock, that the virtual machine is to
remain dormant. The value no can be any decimal number from
00 through 99. If you specify no time unit, the value of nn
is taken to be in minutes.

1.

During the dormant period, the virtual machine
connection time is still being counted.

does not

run but

2.

The terminal can be awakened at any time by signaling attention.

3.

If no interval is specified, the virtual machine
until awakened by signaling attention.

4.

If you issue the SLEEP command from a CP read or from a VM read
using the CP "escape" function
(tcp SLEEP),
the end of the time
interval or signaling attention returns you to the CP environment.

5.

If you issue the SLEEP command while in virtual machine mode (for
example, CMS execution of the command line CP SLEEP), the end of
the time interval or signaling attention returns your terminal to
virtual machine mode without entering the CP env~ronment.

6.

The SLEEP command, with the time interval, is a convenient way to
delay or schedule the execution of certain jobs that could be run
more efficiently at a later time; for example, second shift.

remains dormant

None.

Section 5. Format of CP Commands

151

SMSG

SMSG

Use the SMSG ccmmand to send a special message to a virtual machine
programmed to accept and process the messaqe. The format of the SMSG
command is:
r---------~-------------------------------------------------------__,
,L ___________
S Msg
,
userid msgtext
,
~ ______________________________________________________ ~

user id

is the receiving virtual machine's loqon ID;
if you specify
user id as" *", it indicates the message is to be sent to
yourself.

msqtext

is the text of the .message that is to be transmitted.
Because
the input buffers on various console devices differ, the
length of the message is limited by the number of characters
remaining on the input line after entering the command and the
userid. For example: A 3270 display device contains a 139
character input buffer. If you enter:
,s msg pd58gh 1 c)

,special message)

"'"

"'"

14 characters used

125 characters left
,special message)

"'"
5 characters used

134 characters left

No1~:
Although
the 3270
display station
contains 139
characters in its input area, CP only reads the first 134
characters. When the SMSG command is issued by DIAGNOSE X'8',
CP reads only the first 132 characters.

virtual
to be
special
area as
by the

1.

Special messages do not appear on the specially programmed
machine's screen
because the messages
are designed
instructions that are passed as data parameters.
The
messages are stored in the prespecified VMCF data receiving
they are received, and the instructions are processed
programmed virtual machine.

2.

Virtual machines can only receive and process special messages
under these two conditions:
(1) the virtual machine has issued the
SET SMSG ON
command, and (2) the user wishing to receive special
messages has issued
an AUTHORIZE with the
Virtual Machine
Ccmmunication Facility (VMCF) of VM/SP.
!Q.t~:

Refer
to !]1L~ ~.lst~!
f.£oqr~.!!!!~£~2
information on the AUTHORIZE function of VMCF.

None.

152

IBM VM/SP CP Command Reference for General Users

~Yi~~

for

more

SPOOL

SPOOL

Use the SPOOL command to modify the spooling control options in effect
for a qiven virtual spooling device or for a· group of devices. The
SPOOL command can also start or stop the spooling of virtual console
input and output. You can direct a file to a remote location by using
the SPOOL command in conjunction with the TAG command. This latter
function is discussed below in the section "Transmitting Files to Remote
Locations." The default values for the SPOOL command appear under the
"Usage Notes" following the SPOOL operand descriptions.
The format of
the SPOOL command is:

r-SP::-{Reade:-}
-{r=-{C}I
vaddr
I
* I
L

.J

ICONt

~I

-----..

til,

1

IBOF

INOCont I I NOHold I I NOEof,
L

.J

L

L

.J

.J

I

rr.,

Printer}
PUnch
CONsole
vaddr

t

.,r.,r.,

"I2 ,{uSerid} I ,HOld
I,Fori
*
IL
.J S YSTEK
I OFF
L

if
IICONt ,
'iNOHold"NOContl(CLass c](Copy[*]nnn] I

'L

.J L

~

.J

I

1

.J

r.,r

,r

,r

.,

ICLOSEI ,FLash name nnn, ,FORK {fOrm}"Dist {distcode},
IPURGEI ,KOdify name
II
OFF II
OFF
,
L
.J ,Chars name
IL
.J L
.J
,FCB name
,
L

.J

r

.,

r

.,

ISTArt,2
,STop I

ITErm 12
,NOTerml

L

L

.J

...

---~---------------------,
I1At least one of the options within braces must be selected; however,
1
I more than one may be specified, and they may be entered in any order
,
,
, on the command line.
12These options apply only to a virtual spooled console.
,
-----------~

L-

READER
RDR

modifies the options for all reader spool devices.

PRINTER
PRT

mddifies the options for all ~rinter spool devices.

PUNCH
PCH

modifies the options for all punch spool devices.

CONSOLE

modifies the options for the virtual console spool file and/or
initiates or stops the spooling of virtual console input and
output, including CP input/output.

Section 5. Format of CP Commands

153

SPOOL

vaddr

is the virtual device address (cuu) of the virtual unit record
device or console whose options are to be modified.

{*C}

CLAS S

spec ifies the
spool
class
one-character alphameric field
Z, or 0 through 9.

of the
device.
c
is
a
whose values can be A through

Unless your virtual reader class is asterisk (*),
you must
ensure that any files to be read by your virtual reader are of
the same spool class as your virtual reader. The
is the
universal class;
if your virtual reader is class *, it can
read any file, regardless of class.

*

CONT

ignores
intermediate
end-of-file indications
or
CLOSE
requests.
For virtual readers, reading is continuous, with
all end-of-file indicators ignored until all files spooled to
the virtual machine,are read in. If th~s option is not in
effect, a unit exception is reflected to the virtual machine
at the end of each spooled file. CONT specified for the punch
or printer causes all CLOSE requests to be ignored until reset
by NOCONT.
If CONT is specified, NOCONT cannot be specified.
NOCONT is the default if you do not specify CONT.
CONT
specifies that
reading is
to continue,
without
intervening end-of-file indications until all files in the
system that belong to the user are read. If CONT is not in
effect or is reset by specification of NOCONT, an end-of-file
indication is reflected to the virtual machine at the end of
each SPOOL file in the system. The nature of the end-of-file
indication to be reflected is set by the EOF and NOEOF
options.
If the EOF option is in effect, end-of-file is
signaled by a unit exception:
this corresponds to pressing
the end-of-file button on a real card reader. If NOEOF is in
effect for a virtual reader, end-of-file is signaled by the
reflection of a unit check/intervention required status.

NOCONT

resets the continuous spooling option. If NOCONT is specified,
CONT cannot be specified.
NOCONT is the default is CONT is
not specified.

HOLD

places all files created by the specified device in a user
hold status.
For READER files, this option specifies that
input files for the specified reader are not deleted from the
system after they are read.
The status of all files must be
changed by the CHANGE command. The status of output devices is
changed by the SPOOL command.
If HOLD is specified, NOHOLD
cannot be specified.
If the aOLD option is specified for a virtual printer or punch
that is transferred to a user for input
(TO userid), that
virtual device places a user hold status on the reader file.
The user receiving the file cannot read its status until it is
changed by issuing the CHANGE command with the NOHOLD operand.
The spool file class of the virtual output device must match
the class of the receiver's virtual reader (or the virtual
reader must have a class of *)
in order for the spool file to
be processed. If these conditions are not satisfied, the
reader appears empty to the virtual machine attempting to read
a file, even though reader files do exist.
If a virtual reader is operating with CONT and HOLD, then
virtual reader files are saved and placed in a user HOLD
status. The file cannot be read until it is changed (using
the CHANGE command) to a NOHOLD status.

154

IBM VM/SP CP Command Reference for General Users

SPOOL

NOHOLD

resets the
HOLD operand. Future files are not held.
NOHOLD
resets the HOLD operand in effect for ~he specified reader.
This operand can be overridden for an active file beinq closed
by the CLOSE command using the HOLD or NOHOLD operand. If
NOHOLD is specified, HOLD may not be specified.

EOF

sets a virtual end-of-file condition on the specified reader,
thereby ensuring that a unit exception dondition is reflected
on the read that follows the reading of the last card in a
file.
If EOF is specified, NOEOF may not be specified.

NOEOF

specifies that the reading continues to physical end-of-file.
The virtual reader stops when no cards are left in the reader
and when a unit check/intervention required status is pending.
If NOEOF is specified, EOF may not be specified.

(1:2 ]

Us;rid}
{

SYSTEM
transfers the output of the virtual device to the virtual card
reader of the specified userid. If TO is omitted, the userid
may not be "TO" or "T". TO
may be coded if the output is to
be transferred to your own virtual card reader. If TO userid
is specified, neither OFF nor FOR may be specified on the same
command line.

*

If you specify COpy with TO userid, the number of copies you
specify has no effect on the receiver of the spool file; he
receives only one copy. However, if OFF or FOR is specified on
a subsequent command, the receiver of your spool file receives
the number of copies you specify via COPY. For example, if the
following command is entered:
spool pun to usera copy 3 class b
the COpy operand has no
However, if the command:

effect on

the file goinq

to USERA.

spool pun off
-- or -spool pun for usera
is entered, the COpy 3 specified
affects subsequent punch files.
TO SYSTEM is equivalent
transferred spool option.

in the

to specifying

OFF

first

statement

and resets

the

FOR {Us:rid}
(SYSTEM)
indicates the userid under which printed or punched output is
produced. The userid becomes the owner of the output spool
file and the distcode on the file is the distcode for the user
that is specified in the VM/SP directory.
The file is not
transferred to the user's reader input. The default setting is
for your own virtual machine identification. FOR *, or FOR
SYSTEM can be coded to specify your own identification and-is
equivalent to the OFF option~
OFF

resets the transferred spool option.

Section 5. Format of CP Commands

155

SPOOL

COPY[*lnnn
is the number of copies that are to be printed or punched when
the file is spooled to the real unit record device.
This
operand is valid only for output files; the number of copies,
nnn must be between 1 and 255
(leading zeros need not be
specified) •
When the optional asterisk
(*) is specified,
output files spooled to the 3800 printer
(see "Usage Notes")
are duplicated inside the device one page at a time.
If a
file
is not spooled to the 3800 printer, the function
performed by specifying the asterisk
(*)
is ignored and
duplication occurs normally.
CLOSE

closes the specified device regardless of the CONT setting for
the device. If CLOSE is specified, PURGE may not be specified.
CLOSE does not affect the setting of any other operand and is
provided as a convenience to close a virtual output device.
As an example, this sequence of ccmmands:
SPOOL PRT CONT
(print file)
(pri nt file)
(print file)
SPOOL PRT NOCONT
CLOSE PRT
SPOOL PRT CaNT
(print file)
(print file)

can be replaced with
desired result:

the following

sequence to

achieve the

SPOOL PRT CaNT
(pr i n t f i 1 e )
(prin t file)
(pr in t f i 1 e )
SPOOL PRT CLO SE
(print file)
(pri nt file)

PURGE

closes and
purges the spool file from the specified virtual
output device regardless of the CaNT setting for the device.
If PURGE is specified, CLOSE cannot be specified. PURGE does
not affect the setting of any other operand and is equivalent
to issuing the CLOSE command for a device (or type of device)
with the PURGE operand.

FLAS H name nnn
signifies that a
forms overlay contained in the 3800 printer
is to be superimposed onto certain pages of the output. The
name, one to four characters, identifies the forms overlay to
be used in the projection.
The number, nnn, can be anything
from 0 to 255. The number specifies that the first nnn copies
of output are to be superimposed. For example, if you specify
COpy 4 and FLASH name 2, the first two copies of your file are
flashed,
while the last two copies remain unflashed.
The
default, 0, indicates no superimposing is desired.

156

IBM VK/SP CP Command Reference for General Users

SPOOL

tiODI FY name
assigns a copy modification module to be used when printing a
file on the 3800.
This function makes it possible to alter
text by either preventing printing of certain information or
adding labels to output..
The name must be one to four
characters. If the name is emitted, the file prints normally
without modification.
CHARS name
specifies the name of the character arrangement table
when printing a
file. The name must be from one to
characters.
page.

used
four

FCB name

controls the vertical spacing of output on a
must be from one to four characters.

The name

START

places all console input and output in a spool file.
Until a
CLOSE is issued for the console, characteristics of the
console spool file may be changed by use of th. SPOOL CONSOLE
command.
After the console is closed, the file becomes a
printer spool file whose characteristics can be changed by
issuing the CHANGE PRINTER command.

STOP

terminates the spooling of console input and output.
The
command SPOOL CONSOLE STOP does not close the console spool
file.

TERM

displays the virtual console input and oQtput at the terminal
in addition to placing it in a spool file.
The TERM operand
has no effect until the START operand is specified.

NOTERM

suppresses the display of console input and output of a system
running in a virtual machine.
The display of console input
and output is not suppressed if:
•

it is the result of CP commands entered from CP mode.

•

it is a message or warning.

•

it is the result of a CP
#CP com mand.

•

it is the result of Commands entered
mode.

•

the output line immediately precedes a virtual machine read
to the console.
(This output line prints twice in the
spooled console file.)

The NOTERM
specif ied.

command entered by means

operand has no effect

of the

on a 3270 in CMS EDIT

until the START

operand is

FORM form
specifies the form name for spool files created on this
virtual device.
'form' is a one to eight characters name
defined during system generation. This form can be overridden
by the FORM option of the CLOSE command.
FORM OFF
resets the form for the virtual device to the system default
as specified by the installation.
When a virtual device is
defined (at logon or with the DEFINE com~and), its form is set
to this default.

Section 5. Format of CP Commands

157

SPOOL

DIST distcode
specifies the distribution code for spool files created on
this virtual device.
'distcode' is one to eight characters.
This distcode can be overridden by the DIST option of the
CLOSE command.
DIST OFF
resets the distribution code for the virtual device to the
default specified in the directory for this virtual machine.
When a virtual device is defined
(at logon or with the DEFINE
command), its distcode is set to this default.

Unless otherwise set, the following options are default values for spool
file s:
r

I

Spool File

,

,
t
,

Reader

Punch
,
,Printer
t
,Console

t----

-------------------

Default options

,

~--~~~~-~-------~

NOHOLD NOCONT CLASS

*'

EOF

NOHOLD NOCONT CLASS A' OFF COPY 001
NOHOLD NOCONT CLASS At OFF COPY 001 FLASHC 000
NOHOLD NOCONT CLASS T' OFF COpy 001 TERM

,
,
,
I
,
I
,

----------------~-----t

t 1These are default classes only if a specific class option is not
I part of the VK/SP directory entry.
L-


SEEK
read/write position on count-key-data device
REAL EXTENT real block location on a fixed-block device
VIRT EXTENT virtual block location on a fixed-block device
LOCATE
read/write block position within extent

TRAC E STARTED
This response is issued when tracing is initiated.
TRACE ENDED
This response is issued when tracing is suspended.

1/0 vvvvvv TCH xxxxxxxx type vadd CC n

1/0 vvvvvv mnem xxxxxxxx type vadd CC n type radd CSW xxxx

1/0 vvvvvv mnem xxxxxxxx type vadd CC n type radd CSW xxxx CAW vvvvvvvv.

Section 5. Format of CP Commands

179

TRACE

CCil vvvvvv xxxxxxxx xxxxxxxx rrrrrr YIYIYYYY YYYYYYYY
CCil IDAL vvvvvvvv vvvvvvvv IDAL OOrrrrrr OOrrrrrr
CCil SEEK xxxxxxxx xxxxxx
SEEK YYYIYYYI YYYY
CCil REAL EXTENT YYYYYYYY YYYYYYYY YYYYYYIY YYYYYYYY
CCil VIRT EXTENT xxxxxxxx xxxxxxxx xxxxxxxx xxxxxxxx
CCil
LOCATE
xxxxxxxx xxxxxxxx
The IDAL or SEEK lines, as well as the REAL EXTENT, VIRT EXTENT, or
LOCATE lines, are included only if applicable. The virtual IDAL is not
print~d if the real CCil operation code does not match the real ceil.
I!~!gY£XIO! TR!~I!Q:
~£ivi!~ged

!.!!§!I1!£!i.Q.n:

· ..
·· ......
· ....
···......
··· ....

SSM
SSM
STOSM
STOSK
STNSM
STNSM
LPSW
LPSW
mnem

vvvvvv
vvvvvv
vvvvvv
vvvvvv
vvvvvv
vvvvvv
vvvvvv
vvvvvv
vvvvvv

xxxxxxxx
xxxxxxxx
xxxxxxxx
xxxxxxxx
xxxxxxxx
xxxxxxxx
xxxxxxxx
xxxxxxxx
xxxxxxxx

ss
ss
ns
ns
ns
ns

(normal SSM)
(switch to/from translate mode)
(normal STOS M)
tttttt
(sw itch to translate mode)
(normal STNSM)
tttttt
(swi tch from translate mode)
tttttttt tttttttt
(WAIT bit on)
==) tttttttt tt tttttt
(WAIT bit not on)
(all others)
tttttt

vvvvvv EX xxxxxxxx zz vvvvvv mnem xxxx xxxxxxxx
For an executed instruction, where Z2 (see preceding explanation of
symbols) is nonzero, the mnemonic for the executed instruction is given
as if the zz byte had been put into the instruction with an OR
operation.

vvvvvv mnem xxxxxxxx xxxx
~~CC~22lUL ~RA!£~:

vvvvvv mnem xxxxxxxx

***

==)

tttttt

vvvvvv int code ==) tttttt

ILQ I!IERRUPTIQ! (First line given only if "CSW" was specified) :
CSW V vadd xxxxxxxx xxxxxxxx R radd YIYYYYIY YYYYYYYY
*** vvvvvv I/O vadd ==) tttttt CSW xxxx
BRA!£~

IRA£~:

(ALL option selected)

Entry for 'branch from' instruction
vvvvvv mnem xxxxxxxx

tttttt

Entry for 'branch to' instruction

==> vvvvvv mnem xxxxxxxxxxxx
180

IBM VM/SP CP Command Reference for General Users

TRANSFER

TRANSFER

Use the TRANSFER command to transf~r your closed spool files to a
specified user or queue, or to reclaim closed spool files that you
crea ted.
The format of the class G TRANSFER command is:

,,
,,
,,
r

r

TRANsfer

,Pri nterl
I PUnch I
,!!~g.!l: ,
L

I

,

.J

spoolid
CLass c
FORM form
ALL

1

!

--------'"

,

L

.J

IPrinteri
,PUnch I
IIt~~gfi: I
From {ALL . }
userl.d

L

PRINTER/PRT
PUNCH/PCH
READ ER/RDR
specifies the queues to which and from CP transfers files.
spoo lid

is the spool file you want to transfer to the queue of the
userid you specify or retrieve from the queue of the userid
specified.

CLAS S c

is the class of spool files you want to transfer. The c is a
one-character alphameric field with values from A to z and
from 0 to 9.

FORM form
specifies that you want to transfer all files that have the
form name you specify.
'form' is a one to eight character
form name defined at system generation.
ALL

specifies that you want to
reader/printer/punch queue.

transfer

all spool

files in

a

[TO] {us:rid}
If you
is the user to whom you want to transfer the files.
omit the optional keyword TO, the userid may not be T.O or T.
, *' denote s your own userid.
FROM

userid}
{ ALL
is the use rid from whom you
specified reader/printer or
to reclaim spool files you
to the reader/printer/punch

want to reclaim spool files of the
punch queue.
You can specify ALL
originally created an~ transferred
queues of other user~.

Section 5. Format of CP Commands

181

TRANSFER

The TRANSFER command does not transfer any active spool files.
The command only transfers spool files to valid queues. For example,
files created as real card reader input decks, CP system dumps, user
dumps (VMOUMP command), network dumps, or VM/SP Monitor spool files can
exist only on the reader queue. Files created on a virtual punch, or by
accountinq to disk support, can exist on either the reader queue or the
punch queue. Files created on a virtual printer can exist on either the
reader queue or the print queue. The following chart summarizes the
valid queues to which you can transfer spool files.

r-------------------------------,
1
1
Queue
1
1 Spool

1-

1 Files

1 ROR 1 PRT 1 PCH 1

1

*'

,

,

1 - - - - - -1- - - - - - - - - - ,
,Real
1
o 1 Reader 1
1
1
1
r 1-----1--1---1
1
i 1 Printer 1 * 1 * '
1

1
1--1---1--1
1 Console 1 * 1 * 1 * 1
n 1------1--1---1---1
1 Pu nc h
1 * 1
1 * 1
1-1---1--1---1
,Dump/
, * 1
1
1
1 Monitor 1
1
1
1
g

i

L--

"*"

.J

= files may reside on queue

CP flags, as an error, any attempt to transfer spool files from a
queue to punch queue, as well as any attempt to transfer spool
from a punch queue to a print queue. You may, however, transfer
on the reader queue to printer or punch queues, if they are print
and punch files respectively.

TRANSFER 0123 TO USERA
transfers the spool file with spoolid 0123 from
to the reader queue of USERA.

print
files
files
files

your reader queue

TRANSFER PRT 0123 TO USERA
transfers the spool file with spoolid 0123 from your print queue to
the reader queue of USER!.
TRANSFER PRT ALE TO * RDR
transfers ,all spool files on your print queue to your reader queue.
Note that you didn't need to specify the default, ROR.
TRANSFER ROB CLASS B TO * PCB
transfers all the class B punch files on your reader queue to your
own punch queue.
CP does not transfer any class B files on your
reader queue that are not punch files.
TRANSFER. RDR ALL FROM ALL PRT
reclaims all print files that you created and sent to the print
queues of other users.
CP places these reclaimed files on your
reader queue.
'
182

IBM VM/SP CP Command Reference for General Users

TRANSFER

RDR} FILE spoolid TRANSFERRED TO userid {RDR}
PRT
PRT
{ PUN
PUN
is the response when you is~ue a TRANSFER command with the TO
option. CP also sends this response to the previous owner of a
file reclaimed with the FROK option.

RDR/PRT/PUN
(first occurrence)
previously resided.

is

the

queue

on

which

the

file

RDR/PRT/PUN
(second occurrence)
is the queue on which the file now
resides. CP does not display the second occurrence of
RDR/PRT/PUN unless the old and new queues are different.
spoolid

is the spool identification
does not change.

number of

the file.

userid

is the user identification of the new file owner.

This

RDR} FILE spoolid TRANSFERRED FROM {Userid} {RDR}
PRT
{ PRT
PUN
PUN
is the response
to the user issuing the TRANSFER command with the
FROK option. This response is also sent to the new owner of a file
transferred with the TO option.

*

RDR/PRT/PUN
(first occurrence)
resides.

is the

queue on

which the

file now

RDR/PRT/PUN
(second occurrence) is the queue on which the file
previously resided.
CP does not display the second
occurrence of RDR/PRT/PUN unless the old and new queues
differ.
num~er

spoolid

is the spool identification
does not change~

userid

is the identification of the previous file owner.

*

is displayed when the

"~O

*"

of

the file.

This

option is used.

{~~nn} FILES TRANSFERRED

is also a response you receive when you issue the TRANSFER command.
It is not displayed if you issued the CP SET IMSG OFF command line.
CP does not display any of these responses if you issued the CP SET IMSG
OFF command.

Section 5. Format of CP Commands

183

VMDUMP

VMDUMP

The VMDUMP command, when used with the VM/lnteractive Problem Control
System Extension (VM/IPCS Extension) program product, dumps storage for
quest virtual machines (that is, the virtual storage that VM/SP creates
for the virtual machine user).
See Usage Note 1.
The VM/IPCS Extension
debugs errors, as well as stores and maintains error information about
the virtual machine.
The VM/IPCS Extension displays this information at
the user's terminal.
VMDUMP provides the VM/IPCS Extension with header
information to identify the owner of the dump; it also maintains dump
information, writes the dump to a spool file, and formats the dump. In
addition to saving the storage contents of the virtual machine, the
VMDUMP command also dumps:
•
•
•
•
•
•
•

Virtual program status word (PSW)
Gene ral reg isters
Floatinq point reqisters
Control registers
storage protection keys
Virtual machine type identification
Timer va lues

VMDUMP also
user s.

provides you

with the

ability to

send dumps

to other

The VMDUMP command, when issued without the VM/IPCS Extension
installed, only writes an unformatted dump to a spool file. It does not
format the dump without the VM/IPCS Extension.
However, you may write
routines that perform this function.
For more information on the
VM/IPCS Extension,
refer to !~L~g In1~~~£tiv~ g£QR!~! £Qn!~Q! ~~§tem
~~1!H!§i.Qn
(!!iL!g£~
]xt~!!§ion)
gIQ~g!!!
PrQ~'y£!:
!l§~1:.!§
!iYig~
and
~~fe~~]£~, Order No. SC3Q-2019.
Except for the *dumpid operand, you can specify the operands of the
VMDUMP command in any order.
However, you must specify the *dumpid
operand as the last operand on the command line.

184

IBM VM/SP CP Command Reference for General Users

VMDUMP
The format of the VMDUMP command is:

r---------------------------------~-----

r

VMDUMP

,

r

:{~}

I hexloc11
Q

I
I

,,

{.}

L

I

..

L

r

,

L

.J

r

, ,

,,

I hexloc21
I ~!I!
L

I
I

.J

I
, I
I bytecount' ,
f
II
Ill!
r

L

....

I!Q *
I
ITO useridf
I SYSTEM
f
[FORMAT vmtype]
(DSS]
[*dumpid]

hex I oc 1
~

is the first or only hexadecimal virtual storage address
dumped.
If you omit the hexloc1 operand, the default
is zero, the beginning of virtual machine storage~ You
may also specify the hexloc2 or bytecount operands with
the hexloc1 operand when you know the dump size you want.
If you specify hexloc2 with hexloc1, CP takes a dump of
the storage contents within the range of addresses
between hexloc1 and hexloc2.
For example,
when you
enter:
vmdump 1000-2000
or
vmdump 1000:2000
CP dumps the contents of virtual machine storage at the
hexadecimal addresses between 1000 and 2000. If you
specify the bytecount operand with hexloc1, hexloc1
specifies the beginning address of the dump and the
hexadecimal number of bytes dumped. If you enter:
vmdump 1000.8A
CP dumps
the contents of virtual
machine storage
beginning at hexadecimal address 1000 for a total of 8A
bytes.
You can specify a maximum of three different
areas of virtual storage that you want dumped each time
you issue the VMDUMP command. See Usage Notes 2, 3~ and

5.

Section 5. Format of CP Commands

185

VMDUMP

~}

{
hexloc2
.END

is the last hexadecimal virtual storage address dumped.
If you do not specify the hexloc2 operand, the default
is END, and CP dumps the contents of virtual machine
storage starting from hexloc1 to the end of virtual
storage. You must precede the hexloc2 operand with one
of the allowable delimiters (either a dash or a colon) to
dump the contents of more than one location by storage
address. For example, if you enter:
vmdump :2000
or
vmdump -2000
CP takes a dump of the contents of virtual storage from
hexadecimal location zero (the default for hexloc1) to
hexadecimal address 2000. See Usage Notes 1 and 4 for an
expanded explanation of the use of delimiters.
You may
specify up to a maximum of three different virtual
machine storage areas you wish to dump each time you
issue the VMDUMP command. You must specify a value for
hexloc2 which is greater than hexloc1 value. The hexloc2
value must not exceed the limit of virtual storage.

{. } bytecoun t.
]I!Q

is the hexadecimal number of bytes dumped, starting with
the first byte of virtual storaqe at hexloc1. If you
do not specify bytecount, the default is END, and CP
takes a dump of the contents of virtual machine storage
from the first byte at hexloc1 to the end of virtual
storage. You must specify a period (.)
delimiter if you
want to dump the contents of more than one storage
location by bytecount.
When you enter:
vmdump 1000.20
CP takes a
dump of the virtual storage contents from
hexadecimal location 1000 for a length of X'20' bytes.
See Usage Note 3 for an expanded explanation of delimiter
use.

TO userid
1:Q *

transfers the dump to the virtual card reader of the
userid specified. If you enter an asterisk after TO, CP
transfers the dump to your virtual card reader.

SYSTEM

transfers the dump to the virtual card
userid specified on the SYSDUMP operand
system generation macro instruction.
specify TO preceding t~e keyword SYSTEM.

FORMAT vmtype

provides VM/IPCS Extension with the virtual machine type
(vmtype) which VM/IPCS Extension uses to format the dump.
The vmtype keyword is a one-to-eight byte name of the
operating system running in a virtual machine
(for
example, CMS)~ CP also uses the specified vmtype as the
virtual card reader filetype.CP does not validity check
the vmtype.
Any vmtype longer than eight bytes generates
an error message and halts further VMDUMP processing.
The dump header record includes you specify vmtype and
the VM/IPCS Extension uses the vmtype information to
format the dump.
If you enter FORMAT, you must also
specify a vmtype.
If you do not specify FORMAT, the
default vmtype is FILE.
See Usage Note 4.

DSS

specifies that CP take a dump of all discontiguous saved
seqments in use by your virtual macbine.

186

IBM VM/SP CP Command Reference for General Users

reader of the
of the SYSOPR
You must not

VMDUMP
*dumpid

is a line of user input up to 100 characters long
including imbedded blanks and asterisks which you can
enter for your own benefit (that is; for descriptive
purposes, such as the time and da te of the dump, or what
was being processed at the time of the dump) ~
If you
specify this operand, it becomes the DMPDMPID field in
~he dump
file information record (DMPINREC)
data area.
If specified, you must enter *dumpid as the last operan~
on the VKDUKP command line.

1.

First level storage is real main storage. CP, however, dumps only
second level storage
(that is, storage that VM/SP creates for the
quest virtual machine.)
Operating systems running in a guest
virtual machine such as OS/VS, DOS/VS VSE/AF ReI 1, and VSE/AF ReI
2, have virtual (third level) storage of their own. CP cannot dump
this third level storage directly. The user or the virtual
operating system is responsible for converting any third level
storage addresses to second level storage addresses before issuing
the VMDUMP command.

2.

The dump profile produced contains a whole number of 4K pages. CP
rounds down the hexloc1 operand to a 4K boundary if its value is
not a
multiple of 4K.
CP rounds up the hexloc2 operand to a 4K
boundary minus one.

'3.

Due to 4K boundary rounding for the hexloc1 operand, additional
dumps of up to 4095 more bytes than you specified can occur.

4.

If you enter the FORMAT operand followed by another valid keyword
of the VMDUMP command (for example, SYSTEM), CP uses the keyword
following FORMAT as the vmtype and CP ignores the normal meaning of
the keyword following FORMAT.

5.

If you omit a dash or a colon between the hexloc1 and hexloc2
operands, and you separate the operands with one or more blanks, CP
dumps only the storage contents at those two specific hexadecimal
addresses.
You must insert blanks to separate operands or sets of
operands if you specify more than one operand on the command line.
You must not insert blanks to the left or right of the range or
length delimiters ~, :, or .) unles~ you intend to use the default
value of the missing operand that the blank represents.

COMMAND COMPLETE
is the response
function.

indicating

normal

completion

of

the

VMDUMP

Section 5. Format of CP Commands

187

188

IBK VK/SP CP Command Reference for General Users

Appendix: CP Command Summary

This appendix contains brief descriptions of all the commands acceptable
to the CP component of the VM/SP system.
Figure 11 contains an alphabetical list of the
privilege classes which may execute the command, and
about the use of each ccmmand.

CP commands, the
a brief statement

r---------------------------------------------------------------,
, Privilege I
,Command

,

Class

,

Usage

*

any

Annotate the console sheet.

#CP

any

Execute a CP command while remaining in the
virtual machine environment.

ACNT

A

Create accounting records for logged on users,
and reset accounting data. ACNT also closes
the spool file that is accumulating accounting
records.

ADSTO~

G

Halt execution at a specific virtual machine
instruction address.

ATTACH

B
B
B

Attach a real device to a virtual machine.
Attach a DASD device for CP control.
Dedicate all devices on a particular channel
to a virtual machine.

ATTN

G

Make an attention interruption pending for the
virtual machine console.

AUTOLOG

A,B

Automatically log on a virtual machine and
have it operate in disconnect mode.

BACKSPAC

D

Restart or reposition the output of a unit
record spooling device.

BEGIN

G

Continue or resume execution of the virtual
machine at either a specific storage location
or at the address in the current PSi.

CHANGE

D,G

Alter one or more attributes of a closed spool
file.

CLOSE

G

Terminate spooling operations on a virtual card
reader, punch, printer, or console.

COUPLE

G

Connect channel-to-channel adapters.

CP

any

Execute a CP command while remaining in the CMS
virtual machine environment.

DCP
C,E
Display real storage at terminal.
L___________________________________________________________
~ _________~
Figure 11.

CP Command Summary (Part 1 of 5)

Appendix: CP Command Summary

189

,r--------------------------------, Command
DEFINE

, Privilege,
I Class
,
B
G

DETACH

B
B
B

G
G

-----------------------------,
Usage

-----'----

Redefine the usage of SYSVIRT and VIRTUAL 3330V
devices.
Reconfigure your virtual machine.
Disconnect a real device from a virtual machine.
Detach a DASD device from CP.
Detach a channel from a specific user.
Detach a virtual device from a virtual machine.
Detach a channel from your virtual machine.

DIAL

any

Connect a terminal or display device to the
virtual machine's virtual communication line.

DISABLE

A,B

Disable 2701/2702/2703, 370X in EP
and 3270 local communication lines.

DISCONN

any

Disconnect your terminal from your virtual
machine.

DISPLAY

G

Display virtual storage on your terminal.

DMCP

C,E

Dump the specified real storage location on your
virtual printer.

DRAIN

D

Halt operations of specified spool devices upon
completion of current operation.

DUMP

G

Print the following on the virtual printer:
virtual PSW, general registers, floating-point
registers, storage keys, and contents of
specified virtual storage locations.

ECHO

G

Test terminal hardware by redisplaying data
entered at the terminal.

ENABLE

A,B

Enable communication lines.

EXTERNAL

G

Simulate an external interruption for a virtual
machine and return control to that machine.

FLUSH

D

Cancel the current file being printed or punched
on a specific real unit record device.

FORCE

A

FREE

D

HALT

A

Terminate the active channel program on
specified real device.

HOLD

D

Defer real spooled output of a particular user.

INDICATE

A,E,G

Indicate resource utilization and contention.

IPL

G

Simulate IPt for a virtual machine.

LINK

G

Provide access to a specific DASD by a
virtual machine.

L--_______________- - - - - - - - - - - - -____________________________ _

~igure

190

11.

IB~

CP Command Summary (Part 2 of 5)

VM/SP CP Command Reference for General Users

mode,

,,

r-

,
-------- ----Command

,

Usage

--------_.----------.----

LOADBUF

D

Load real UCS/UCSB or FCB printer buffers.

LOADVFCB

G

Load virtual forms control buffer for a virtual
3203, 3262, 3289E, or 3211 printer.

LOCATE

C,E

Find CP control blocks.

LOCK

A

Bring virtual pages into real storage and lock
them; thus, excluding them from future paging.

LOGOFF

any

Disable access to CP.

LOGON

any

Provide access to CP.

MESSAGE

A,B,any

Transmit messages to other users.

MIGRATE

A

Allows the operator to migrate pages either for
the entire system or just on~ user.

MONITOR

A,E

Trace events of the real machine and record
system performance data.

MSGNOH

B

Send a specified message, without the standard
message header, from one virtual machine to
another.

A,B,F

Load, dump, trace, and control the operation of
the 370X control program. Control the
operation of 3270 remote devices.

NOTRFADY

G

Simulate "not ready" for a device to a virtual
machine.

ORDER

D,G

Rearrange closed spool files in a specific
order.

PURGE

D,G

Remove closed spool file from system.

QUERY

A,B,C,D, Request information about machine configuration
E,F,G
, and system status.

QV f1

A

READY

G

REPEAT

D

Repeat (a specified number of times) printing or
punching of a specific real spool output file.

REQUEST

G

Make an attention interruption pending for the
virtual machine console.

RESET

G

, NE TWORK

L-_ _ _ _ _ _ _ _ _ _ _ _

Figure 11.

,,

----,

---~

,Pri vileqe,
Class

Request the transition from VM/SP to the V=R
virtual machine running in native mode.
Simulate devic~
dev ice.

en~

interruption for a virtual

,Clear and reset all pending interruptions for a
, specified virtual device and reset all error
, conditions.
_ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _- - J

CP Command Summary

(Part 3 of 5)

Appendix: CP Command Summary

191

r

I

,, RE WIND

, Command

I Pr i vile q e I
, Class I
G

Rewind (to load point) a tape and ready a tape
unit.

G

Allows the user to change or alter the color and
extended highlighting values for his virtual
console.

SEND

G

Pass commands and message replies to
disconnected virtual machine for processing.

SAVESYS

E

Save virtual machine storage contents#
registers, and PSi.

A, B, E,

Operator--establish system parameters.
User--control various functions within the
virtual machine.
Terminate all VK/SP functions and checkpoint CP
system for warm start.

,
,,
I

, SCREEN

t

Usage

SET

F,G
SHUTDOWN

A

SLEEP

any

Place virtual machine in dcrmant state.

SMSG

G

Send Special Messages to specified virtual
machine.

SPACE

D

Force single spacing on printer.

SPr10DE

A

Establish or reset
envi ronment.

SPOOL

G

Alter spooling control options; direct a file to
another virtual machine or to a remote
location via the RSCS virtual machine~

SPTAPE

D

Dump output spool files on tape
spool files from tape.

START

D

Start spooling device after draining or changing
output classes.

STCP

C

STORE

G

SYSTEM

G

TAG

G

192

single processor mode

or load output

,

IChange the contents of real storage.

IAlter specified virtual storage locations and
I registers.
I
ISimulate RESET, CLEAR STORAGE, and RESTART
I buttons on a real system console.
I

,Specify variable information to be associated
I with a spool file or output unit record
I device.
IInterrogate the current TAG text setting of a
I given spool file or output unit record device.~

L-______________________________
Figure 11.

the

-___________________

CP Command Summary (Part 4 of 5)

IBM VM/SP CP Command Reference for General Users

,, Command

r

, Privilege t
t Class ,

Usage

------- ----- --------.-----------TERMINAL

G

Define or redefine the input and attention
handling characteristics of your virtual
console.

TRACE

G

Trac~

TR ANSFER

D,G

Transfer input files to or reclaim input files
from a specified user's virtual card reader.

UNLOCK

A

Un16ck previously locked page frames.

VARY

B

Mark a device unavailable or available.

VMDUMP

G

Dump virtual machine when issued with the
VM/IPCS Extension.

WARNING

A,B

Transmit a high priority message to a specified
user or to all users.

'----

Figure 11.

specified virtual machine activ~ty at your
terminal, spooled printer, or both.

CP Command Summa ry (Part 5 of 5)

--~----.-----------.~,---

Appendix: CP Command Summary

193

194

IBM VM/SP CP Command Reference for General Users

Index

*
*

command
described 40
summary 189
op~!'and

of MESSAGE command 102
of SPOOL command 153
*dumpid operand, VMDUMP command

185

#CP
command
commandline operand 41
l=tescribed 41
summary 189
#cp c0mm~nd, example of usage

42

'colo~' operand, of SCRREN comman~
134
'exthilight' operand, of SCREEN command
134

attached processor, INDICATE command use
for monitor of system load 85
attached processor application, use of SET
ASSI ST
138
a tten tion
handling, terminal control of 170
in terrupt
entering from your virtual console
45
for a virtual machine 131
ATTN
command
described 45
summary 189
ATTN operand
of IPL command 88
of TERMINAL command 170
attributes
modifying, for 3800 printer 153
spool file, changing 47
virtual device, modifying 153
AUTOCR option, of PARM operand, for IPL
command 91
AUTOPOLL operand, of SET command 138

A

abbreviation, use of 35
accounting, information, displaying
ACNT, command, summary 189
ACNT operand, of SET command 138

B

138

ADSTO~

command.
described 43
hexloc operand 43
OFF operanii 43
summary 189
AFFINITY operand, of SET command 138
affinity setting, relation to the logon
process qQ
ALL operand
of CqANGE command 47
of pnRGE command 107
of QUERY command 112
of TRACE command 176
of TRANSFER command 181
alt erinq
at tri bu tf>S of
virtual printer file 47
virtual punch file 47
virtual reader file 47
loqical editing symbols 170
virtual machine environment 58
annotating your console sheet 40
Any user, described 8
APt, control of translation tables 170
APL operand, of TERMINAL command 170
ASSIST operand, of SET command 138
ATTACH, command, summary 189

BACKSPAC, command, summary 189
BATCH option, of PARM operand, for IPL
command 91
BEGIN
command
de scribed 46
hexloc operand 46
summary 189
BEGIN command, used with the DISCONN
command 72
blanks, as delimiters 3
block address, used to load a system, at
IPL 88
BOTH operand, of TRACE command 176
braces, use of 36
brackets, use of 36
BRANCH operand, of TRACE command 176
branches, tracing 176
BREAKIN operand, of TERMINAL command 170
BRKKEY operand, of TERMINAL command 170
byte aliqnment, DISPLAY command 28
bytecount operand, VMDUMP command 185

C

CAW
CAW
CCW
CCW

(Channel Address Word), displaying
operand, of DISPLAY command 74
operand, of TRACE command 176
translation, controlling 138

Index

74

195

CHANGE
command
ALL operand 47
CHARS operand 47
CLASS operand 47
COPy* operand 47
COpy operand ~7
described ~7
DIST operand ~7
FCB operand ~7
FLASH operand ~7
FORM operan~ ~7
HOLD operand ~7
MODIFY operand ~7
NAME operand ~7
NOHOLD operand ~7
PRINTER operand ~7
PUNCH operand 47
READER operand 47
summary
189
changing
extended control r~gisters in your
.virtual machine 163
filename of a spool file 47
floating-point registers in your virtual
machine 163
general registers in your virtual
machine 163
Program status Word ~SW) in your
virtual machine 163
spool class of a file ~7
spool file attributes ~7
spoolid of a file ~7
virtual storage locations 163
channel c operand, of DETACH CHANNEL
command 6°
CHANNELS operand
or DEFINE command 58
of QUERY command 112
channel-to-channql adapters, virtual,
connect ing 55
character
set
~
translation tables, API, controlling
.' 170

CHARDEL operand, of TERMINAL command
170
CHARS operand
of CHANGE command 47
of SPOOL command 153
class
privilege, for CP commands 7
spool, changing for a file 47
virtual device spool, modifying 153
class Any, described 9
class G, describe1 9
CLASS operand
of CP.ANGE command 47
of ORDER command 105
of PURGE command 107
of QUERY command 112
of SPOOL command 153
of 'rRAN'SFE"R command 181
CLE AR operand
of InL comman~ 88
of SYSTEM command 165
clearing
interrupts from a virtual machine
132
storage to zeros 88,165
196

IB~

CLOSE
command
CONSOLE operand 51
described 51
DIS.T operand 51
dsname operand 51
fnft operand 51
FORM operand 51
HOLD operand 51
NAME operand 51
NOHOLD operand 51
PRINTER operand 51
PUNCH operand 51
PURGE operand 51
READER operand 51
summary 189
vaddr operand 51
HOLD restrictions 51
NOHOLD restrictions 51
re strictions 51
CLOSE operand, of SPOOL command 153
closi ng
files 51
TR ACE output 32
virtual devices
153
code operand, of EXTERNAL command 8~
comma nd
name 4
operands 4
command environment
CP 3
defined 3
commandline operand
of #CP command 41
of CP command 57
comma nds
ADSTOP command~ halting execution of
virtual machine 26
ATTACH command, with dedicated devices
20
ATTN command, simulates real console
function
23
CHANGE command, altering spool file
attributes 16
CLOSE command, using with spool files
16
CP, summarized 189
DEFINE comman d
reconfiguring virtual machine 25
temporary disks 14
DETACH CHANNEL command, with dedicated
channels 21
DETACH com.mand
removing dedicated devices 20
temporary disks 14
DISPLAY command, displaying virtual
storage 28
DUMP command, printing virtual storage
29
EXTERNAL command, simulating
interruptions 22
LINK command, sharing virtual disks 14
MESSAGE command, obtaining operator
a ssi stance 21
notational conventions 35
ORDER command, reordering spool files
19
PURGE command, deleting spool files 19

VM/SP CP Command Reference for General Users

QUERY command, determining device or
file attributes
16
RBQijEST command, simulates real console
function
23
S~OOL command, altering device
attributes
16
STORE command, altering virtual storage
30
summary of use 189
TRACE command, follow virtual machine
activities 32
used to control a terminal session,
summary o~
189
comments, how to write 4
CONMODE operand, of TERMINAL command
110
connect ing
r~mo~e terminals to virtual machines
70
virtual channel-to-channel adapters 55
console
input/output, terminating 153
sheet, annotation of 40
s?ool file, modifying 153
s?oolinq, controlling 153
CONSOLE operand
of CLOSE command 51
of DEFINE command 58
of QUERY command 112
of SPOOL command 153
CONT operand, of SPOOL command
153
continuous reading of an entire file
153
control, functions, setting for your
virtual machine 138
Control Program, console function mode 24
controlling
a terminal session, summary of commands
use~
18 Q
3270 display
172
controlling virtual machine, during
terminals session
11
COPy* operand
of CHANGE command 41
of SPOOL command 153
COpy operand
of CHANGE command 41
of SPOOL command 153
COUPI.E
command
described 55
summary
189
userid operand 55
vaddrl operand 55
vaddr2 operand 55
CP
command
commandline operand 51
described 51
summary
189
CP command environment 3
CP commands
entering 23
from CP console function mode 24
from virtual console read mode 24
while running 22
entering from the virtual machine
environment 57
privilege classes, described 8
privilege classes for 7
text format of 39

CP operand, of SEND command 131
CPUID operand, of QUERY command
112
creating disk space with DEFINE command,
precautions 58
CSW (Channel Status Word), displaying 14
CSW operand
of DISPLAY command 14
of TRACE command 176
CTCA operand, of DEFINE command 58

D

DASD operand, of QUERY command
112
DCP, command, summary 190
debugging, programs 26
dedicated channel, detaching 69
dedicated 2305 restriction 58
DEFIN E
command
CHANNELS operand 58
CONSOLE operand 58
CTCA operand 58
described 58
GR AFoperand
58
LINE operand
58
PRINTER operand 58
PUNCH operand 58
READER operand 58
STORAGE operand 58
summary 190
TFB-512 operand 58
TIMER operand 58
T2305 operand 58
T2314 operand 58
T2319 operand 58
T3310 operand 58
T3330 operand 58
T3340 operand 58
T3350 operand 58
T3370 operand 58
T3380 operand 58
1403 operand
58
1443 operand
58
2501 operand 58
2540P operand 58
2540R operand 58
3203 operand
58
32110perand
58
3262 operand 58
3289E operand 58
3505 operand
58
3525 operand
58
3800 operand
58
DEFIN E command
temporary disks
14
use with MSS devices 58
virtual addresses
58
defining
fixed-block mode devices, for the
virtual machine 61
virtual devices
58
delimiters, in.command lines 4
DETACH
command
described 66
summary 190
vaddr operand 66
Index

191

DET ACH CHANNEL
command
channel c operand 69
described 69
DETACH command, temporary disks 14
detaching
dedicated channels 69
virtual devices 66
DEV operand, of TAG command 161
device-end interrupt pending for a virtual
device, specifying 130
devices
virtual
linking to 92
simulating not ready status for
104
DIAL
command
described 10
summary
190
userid operand 10
vaddr operand 10
DIAL command, device restriction 10
directory entry, controlling, virtual
machine attributes 12
DISABLE, command, summary 190
DIS CONN
command
described 12
HOLD operand 72
summary 190
disconnecting
virtual console 72
viL~ual machine
98
DISPLAY
command
CAW operand 74
CSW operand 14
described 74
PSW operand 14
summary 190
DISPLAY command, byte alignment 28
displaying
accounting information 138
Channel Address Word ~AW)
14
Channel Status Word (CSW)
14
extended control registers 14
floating-point registers 74
general registers 14
Program status Word ~SW)
14
storage keys 74
virtual storage 21
virtual storage location~ 14
DIST operand
of CHANGE command 41
of CLOSE command 51
distribution code, for an output file 41
- DMCP, command, summary 190
DRAIN,- command, summary 190
dsname operand, of CLOSE command 51
DSS operand, VKDUMP command 185
DUMP
command
described 80
summary 190

198

E

ECHO
command
described 84
nn operand 84
summary 190
ECMODE operand, of SET command 138
editing symbols
controlling 170
logical, controlling use of 138
EKSG operand, of SET command 138
ENABLE, command, summary 190
END operand, of TRACE command 116
entering
a CP command from the virtual machine
environment 51
CP comman ds 3
EOP operand, of SPOOL command 153
error message handling, controlling 138
ESCAPE operand, of TERMINAL command 170
execution
halting at an instruction address 43
of a virtual machine, resuming 46
extended control mode, setting 138
extended control registers
changing your virtual machine 163
di splaying 14
printing 80
EXTERNAL
command
code operand 84
described 84
summary 190
external interrupt, simulated 84
EXTERNAL operand, of TRACE command 116

F

FB-512 device information, obtained with
QUERY command 118
PB-512 devices, tracing CCW information
178
FCB operand
of CHANGE command 47
of LOADVPCB command 96
of SPOOL command 153
FILE operand, of TAG command 161
files
changing the spool class of 41
changing the spoolid for 47
closing 51
distribution code for 47
holding before output processing 41
holding from further processing 51,153
holding via CLOSE 153
P u rg i n g 5 1 , 1 53
purging via SPOOL 153
reclaiming 181
reordering closed spool files
105
spool, changing filename for 41
terminating processing of 51
transferring to another user 153
transmitting to a virtual reader 181

IBM VK/SP CP Command Reference for General Users

FILES operand, of QUERY command 112
first-level storage, requesting via DISPLAY
command 78
FLASH operand
of CHANGE command 47
of SPOOL command 153
floating-point registers
changing your virtual machine 163
displaying 74
printing 80
FLUSH, command, summary 190
fnft operand, of CLOSE command 51
FOR operand, of SPOOL command 153
FORCE, command, summary 190
FORM operand
of CHANGE command 47
of CLOSE command 51
of ORDER command 105
of PURGE command 107
of SPOOL command 153
of TRANSFER command 181
FORMAT vmtype operand, VMDUMP command 185
forms controls for a virtual printer,
specifying 96
FBEE, command, summary 190
FROM operand, of TRANSFER command 181

G

general registers
changing in your virtual machine
displaying 74
printing 80
general user, described 8
GRAF operand
of DEFINE command 58
of QUERY command 112

163

H

HALT, command, summary 190
halting, execution at an instruction
address 43
handshaking, control of VM/VS
138
hexloc operand
of ADSTOP command 43
of BEGIN command 46
hexlocl operand, VMDUMP command 183
hexloc2 operand, VMDUMP command 185
hiding your password 99
highlighting, 3270 terminal display 172
HILIGHT operand, of TERMINAL command
170
HOLD, command, summary 190
HOL D operand
of CHANGE command 47
of CLOSE command 51
of DISCONN command 72
of LOGOFF command 98
of SPOOL command _153
holding
a file before output processing 47
files by user hold status 153
files from further processing 51,153

I

IMSG operand, of SET command 138
INDEX operand, for LOADVFCB command 96
INDIC ATE
command
attached processor load indication
-85
descr.ibed 85
LOAD operand 85
multiprocessor load indication 85
summary 190
USER operand 85
initial program load (IPL)
automatic, suppression of 99
of a virtual machine operating system
88
stopping 88
input/output operations, tracing 176
INSTRUCT operand, of TRACE command 176
internal print file duplication, by 3800
printer 47
interrupt codes
X' 1004', clock comparator 23
X'1005', CPU timer 23
interruptions, simulating 22
interrupts
clearing from a virtual machine 132
device-end, specifying virtual 130
external, simulating 84
for a virtual machine 131
range of external codes 84
tracing 176
I/O devices, virtual, defining for your
virtual machine 58
I/O operand, of TRACE command 176
IPL
command
ATTN operand 88
CLEAR operand 88
described 88
nnnnnn operand 88
NOCLEAR operand 88
PARM operand 88
STOP operand 88
summary 190
vaddr operand 88
IPL command, for named systems 91
ISAM operand, of SET command 138

K

keys
program function, controlling
storage
displaying 74
printing 80

138

L

line editing iymbols, controlling 138
line length, controlling at your terminal
170
LINE operand, of DEFINE command 58
LINEDEL operand, of TERMINAL command 170
LINEDIT operand, of SET command 138
LINEND operand, of TERMINAL command 170
Index

199

LINES operand, of QUERY command 112
LINESIZE operand, of TERMINAL command 170
LINK
command
de.scribed 92
password operand 92
summary 190
userid operand 92
vaddr operand 92
LINK command
batch job restrictions 92
passwords 92
2305 restrictions 92
linkinq, a device to your virtual machine
q2

LINKS operand, of QUERY command 112
load key, simulation of via IPL command 88
LOAD operand, of INDICATE commmand 85
LOADBUF, command, summary 191
loading, an operating system 21
loading a system, with a block address, at
1PL Aq
LOADVFCB
command
described 96
FCB operand 96
INDEX operand 96
su mmary 191
va~dr operand
96
LOCATB, command, summary 191
LOCK, command, summary 191
logging off of your virtual machine 98
logqing on your virtual machine 99
logical editing symbols
altering 170
controlling 170
controlling use of 138
logically connected terminal 70
LOGMSG operand, of QUERY command 127
LOGOFF
command
described 98
HOLD operand 98
su mmary 191
logon, affinity setting effect 99
LOGON
command
described 99
N01PL operand 99
password operand 99
summary 191
userid operand 99
logon procedure, hiding your password
during qq

message handling, error, handling 138
messages
controlling transmission of 138
sending to other users 102
MODE operand, of TERMINAL command 170
MODIFY operand
of.CHANGE command ~7
of SPOOL command 153
modifying
spooling control options 153
storage, using ADSTOP command 43
virtual device attributes 153
MONITOR, command, summary 191
MSG operand, of SET command 138
MSGNOH, command, summary 191
msgte xt operand
for MESSAGE command 102
of SMSG command 152
MSS, virtual volumes, defined with DEFINE
command 58
multiprocessor, INDICATE command to display
system load 85

N

NAME operand
of CHANGE command 47
of CLOSE command 51
named systems, IPL command for 88
NAMES operand, of QUERY command 127
nesting, described 36
NETWORK, command, summary 191
nn operand, of ECHO command 8~
nnnnnn operand, of IPL command 88
NOCLEAR operand, of IPL command 88
NOCONT operand, of SPOOL command 153
NOEOF operand, of SPOOL command 153
NOHOL D operand
of CHANGE command 47
of CLOSE command 51
of SPOOL command 153
NOIPL operand, of LOGON command 99
NORUN operand, of TRACE command 176
notational conventions 35
NOTERM operand, of SPOOL command 153
NOTRANS operand, of SET command '38
NOTRE ADY
command
described· 104
summary 191
.addr operand 10~

o
M

masking, password during logon 99
Mass storage Systems
(§~~ MSS)
MESSAGE
command
* operand 102
described 102
msgtext operand 102
OPERATOR operand 102
summary 191
userid operand 102
200

OFF operand
of.ADSTOP command 43
of SPOOL command 153
of TRACE command 176
operands, command ~
operating system
for a virtual machine, passing
parameters to 91
initial program load for 88
operating systems
loading 21
passing parameters at IPL 22

IBM VM/SP CP Command Reference for General Users

operator, sending messages to 102
OPERATOR operand, of MESSAGE command
ORDER
command
CLASS operand 105
described 105
FORM operand 105
PRINTER operand 105
PUNCH operand 105
READER operand 105
spoolid operand 105
summary 191
OS Indexed Sequential Access Method
138

102

(ISA~

P

PAGEX operand, of SET command 138
parameters, passing to a virtual machine
operating system 88
PARM operand, of IPL command 88
passing parameters to your virtual machine
operating system 91
password
hiding during logon procedure 99
invalid format for commandline,
precaution 99
with the LINK command 92
password operand
of LINK command 92
of LOGON command 99
PFnn operand
of QUERY command 112
of SET command 138
power off vs logoff, with 3270 terminal 98
print file requirements, for 3800 printer

program function keys, controlling 138
PROGRAM operand, of TRACE command 116
Program Status Word (PSW)
changing your virtual machine 163
displaying 14
printing 80
PSW operand, of DISPLAY command 14
PUNCH
operand
of CHANGE command 41
of PURGE command 101
of QUERY command 112
punch files, virtual, altering the
attributes of 41
PUNCH operand
of CLOSE command 51
of DEFINE command 58
of SPOOL command 153
PUNCH operator, of ORDER command 105
PURGE
command
ALL operand 101
CLASS operand 101
described 101
FORM operand 101
PRINTER operand 101
PUNCH operand 101
READER operand 101
spoolid operand 107
summary 191
PURGE operand
of CLOSE command 51
of SPOOL command 153
purging
closed files 51
spooled files
153
purging closed spool files 101

49

printer , virtual, specifying forms
controls for 96
printer files, virtual, altering the
attributes of 47
PRINTER operand
of CHANGE command 47
of CLOSE command 51
of DEFINE command 58
of ORDER command 105
of PURGE command 107
of QUERY command 112
of SPOOL command 153
of TRACE command 176
printing
contents of virtual machine components
AO

Program Status Word (PSW)
80
virtual storage keys 80
virtual storage locations 80
printing first-level storage, with DUMP
command Rl
PRIV operand, of TRACE command 176
privilege classes
for CP commands
defined 1
summarized 8
privileged instructions, tracing 116
processor, determining, attached or main
109
PROCESSOR operand, of QUERY command 112

Q

QUERY
command
ALL operand 112
CHANNELS operand 112
CLASS operand 112
CONSOLE operand 112
CPUID operand 112
DASD operand 112
de scri bed 109
FILES operand 112
GR AF operand 112
LINES operand 112
LINKS operand 112
LOGMSG operand 121
NAMES operand 121
PFnn operand 112
PRINTER operand 112
PROCESSOR operand 112
PUNCH operand 112
READER operand 112
SCREEN operand 109.112
SECUSER operand 109,112
SET operand 109
spoolid operand 112
STORAGE operand 112
summary 191
TAPES operand 112
Index

201

TBL operand 112
TERMINAL operand 109
TIME operand 109
UR operand 112
USERS operand 127
vaddr operand 112
VIRTUAL operand 112
VMSAVE operand 112
QUERY operand, of TAG command

167

R

reader files, virtual, altering the
attributes of 47
READER operand
of CHANGE command 47
of CLOSE command 51
of DEFINE command 58
of ORDER command 105
of PURGE command 107
of QUERY command 112
of SPOOL command 153
reading, an entire file continuously 153
read/write acce$S, with LINK command 92
READY
command
described 130
summary 191
vaddr operand 130
real computer
reset button, simulating 165
restart button, simulating 165
reclaiming files, in order to purge 107
reclaiming transmitted files 181
reconfiguring, your virtual machine 25
registers
exten<1ed control
displaying 74
printing 80
floating-point
displaying 74
printing 80
general
displaying 74
printing 80
remote spooling, TAG command 167
remote spooling networks
receiving files 160
transmitting files 160
remote terminal, connecting to a virtual
machine 70
removing a virtual device from your virtual.
machine 66
REPEAT, command, summary 191
REQUEST
command
described 131
performs same function as ATTN
command 45
summary 191
reserved IBM class, described 8
RESET
command
described 132
summary 191
vaddr operand 132

202

reset button, simulating 165
RESET operand, of SYSTEM command 165
.response
for ADSTOP command 44
for DETACH CHANNEL command 69
for ORDER command 106
for PURGE command 108
fo~ QUERY CPUID command
114
for QUERY FILES command 115
for QUERY LINKS command 121
for QUERY LOGMSG command 127
for QUERY NAMES command 128
for QUERY PFnn command 124
for QUERY PROCESSOR command 126
for QUERY READER, PRINTER, and PUNCH
command 123
for QUERY SCREEN command 122
for QUERY SECUSER command 122
for QUERY SET command 113
for QUERY SPMODE command 126
for QUERY S370E command 125
for QUERY TERMINAL command 114
for QUERY TIME command 113
for QUERY USERS command 128
for QUERY VIRTUAL CHANNELS command 115
for QUERY VIRTUAL CONSOLE command 116
for QUERY VIRTUAL DASD command 118
for QUERY VIRTUAL GRAF command 116
for QUERY VIRTUAL LINES command 119
for QUERY VIRTUAL STORAGE command 121
for QUERY VIRTUAL TAPES command 119
for QUERY VIRTUAL UR command 119
for QUERY VIRTUAL vaddr command 121
for QUERY VMSAVE 125
for RESET command 132
for SCREEN command 133
for SEND command 137
for STORE command 164
responses
for #cP command 42
for CHANGE command 50
for CLOSE command 54
for COUPLE command 55
for CP command 57
for DEFINE command 65
for DETACH command 68
for DIAL command 70
for DISCONN command 72
for DISPLAY command 79
for DUMP command 82
for ECHO command 84
for INDICATE LOAD and USER 85
for LINK command 93
for LOGOFF command 98
for LOGON command 100
for MESSAGE command 103
fo r REWIND comman d 133
for SPOOL command 160
for SYSTEM command 165
for TAG command 169
for TRACE command 177
for TRANSFER command 182
forVMDUMP command 183
responses to CP commands, types of 39
responses vs system messages 39
restart button, simulating 165
RESTART operand, of SYSTEM command 165

IBM VM/SP CP Command Reference for General Users

resume
execution of your virtual machine
use of your virtual machine after
disconnecting it 72
REWIND
command
described 133
summary 192
vaddr operand 133
rewinding a real tape 133
RUN operand
of SET command 138
of TRlCE command 176

46

S

saved systems, IPL command for 88
SlVESYS, command, summary 192
saving, virtual machine data 163
SCREEN
command
'color' operand 134
'exthilight' operand 134
described 134
SCREEN operand, of QUERY command 109,112
SCRNSlVE operand, of TERMINlL command
110
SECUSER operand, of QUERY command 109,112
SEND
command
CP operand 137
described 137
text operand 131
userid operand 137
sending messages
to other users 102
to the operator 102
service representative, described 8
SET
command
lCNT operand 138
lFFINITY operand 138
ASSIST operand 138
lUTOPOLL operand 138
described 138
ECMODE operand 138
EMSG operand 138
IMSG operand 138
ISlM operand 138
LINEDIT operand 138
MSG operand 138
NOTRANS operand 138
PlGEX operand 138
PFnn operand 138
RUN operand 138
SMSG operand 138
summary 192
TIMER operand 138
VMSlVE operand 138
WNG operand 138
SET operand, of QUERY command 109
shared segment, modification of 43,111
shared segments, modification of 164
sharing virtual disks 14

SHUTDOWN, command, summary 192
simulating
not ready status for a virtual device
104
the reset button on a real computer 165
the restart button on a real computer
165
simulating interruptions 22
SIO operand, of TRACE command 176
SLEEP
command
described
151
summary 192
SMSG
command
described
152
msgtext operand 152
summary 192
userid operand 152
SMSG operand, of SET command 138
SPlCE, command, summary 192
specifying, device-end interrupt for a
virtual device
130
SPOOL
command
• operand 153
CHlRS operand 153
CLlSS operand 153
CLOSE operand 153
CONSOLE operand 153
CaNT operand
153
COpy. operand 153
COpy operand
153
described 153
EOF operand 153
FCB operan d 153
FLASH operand 153
FOR operand 153
FORM operand
153
HOLD operand
153
MODIFY operand 153
NOCONT operand 153
NOEOF operand 153
NOHOLD operand 153
NOTERM operand 153
OFF operand 153
PRINTER operand 153
PUNCH operand 153
PURGE operand 153
READER operand 153
START operand 153
STOP operand
153
summary 192
SYSTEM operand 153
TERM operand
153
TO operand
153
userid ope.rand 153
vaddr operand 153
spool class
for a file, changing 41
modifying
153
SPOOL command, use with TAG command 159
spool command options, set for a virtual
device 51

Index

203

spool file
altering TAG information 167
changing filename for 47
changing the attributes of 47
charact er ist ics
changing 16
querying 16
setting 15
reordering 105
spoolid 158
TAG command 167
transmitting locally 158
transmitting to remote location 159, 167
spoolid number
158
spoolid operand
of ORDER command 105
of PURGE command 107
of QUERY command 112
of TRANSFER command 181
spooling
considerations during abend 153
considerations during shutdown 153
control, options, modifying 153
operator, described 8
terminals session 15
virtual console 17
spooling output to a 3800 printer 158
SPTAPE, command, summary 177
START, command, summary 192
START operand, of SPOOL command 153
status
virtual machine, determining 109
words, tracing 176
STATUS operand
of STORE command 163
STORE command, simulating hardware store
31
STCP, command, summary 192
STOP operand
of IPt command 88
of SPOOL command 153
stopping, initial program load (IPL)
procedure 88
storage
clearing to zeros 88
keys, printing 80
locations, virtual, displaying 74
modification of 43
virtual, altering 30
storage keys, displaying 74
storage locations
virtual machine
altering 163
displaying 74
printing 80
STORAGE operand
of DEFINE command 58
, of QUERY command 112
ST~RE
/
command
described 163
------,-$TATUS operand 163
~mary192

STORE comma:nd, STATUS operand, simulate
hardware store 31

204

storing
CPU status for virtual machine 163
virtual machine data 163
summary, of CP commands 189
suppressing, automatic IPL of a virtual
machine operating system 99
SVC operand, of TRACE command 176
SYSTEM
command
CLEAR operand 165
described 165
RESET operand 165
RESTART operand 165
summary 192
system analyst, described 8
system messages vs CP command responses
SYSTEM operand
of SPOOL command 153
VMDUMP command 185
system operator, primary, described 8
system programmer, described 8
system resource operator, described 8
system resources, indication of 85

T

TABCHAR operand, of TERMINAL command 170
TAG
command
described
167
DEV command 167
FILE operand
167
QUERY operand 167
summary 192
TAG command
altering TAG information 167
transmitting files to remote location
167
use with SPOOL command 159
tapes, rewinding
133
TAPES operand, of QUERY command 112
TBL operand~ of QUERY command 112
temporary, virtual disks 14
temporary disk space, formatting and
clearing 58
TERM operand, of SPOOL command 153
TERMINAL
command
APL operan d 170
ATTN operand
170
BREAKIN operand 170
CHARDEL operand 170
CONMODE operand 170
described 170
ESCAPE operand 170
HILIGHT operand 170
LINEDEL operand 170
LINEND operand 170
LINESIZE operand 170
MODE operand
170
SCRNSAVE operand 170
summary 193
TABCHAR operand 170
TEXT operand
170

IBM VM/SP CP Command Reference for General Users

39

TERMINAL command, BRKKEY operand 170
TERMINAL operand
of QUERY command 109
of TRACE command 176
terminals
console, disconnecting from your virtual
machine 72
control of attention handling 170
input/output processing, controlling
110
line length, controlling 170
remote, connecting to a virtual machine
"'0

session
altering virtual storage 30
changing spool file characteristics
16
commands used to control, summary of
189
controlling I/O functions 12
controlling virtual machine 21
debugging programs 26
dedicated channels 21
dedicated devices 18
determining the length of time of
10Q
displaying virtual storage 27
entering CP ccmmands 23
logging en 21
purging spool files 18
querying spool file char·acteristics
16
reordering spool files 19
setting spool file characteristics
15
simulating interruptions 22
spooling 15
.
store virtual machine status 31
testing programs 26
tracing virtual machine activity 31
virtual console spooling 18
virtual disks 13
virtual disks, permanent 14
virtual disks, temporary 14
virtual unit record devices 15
testing using the ECHO command 84
terminating
console input/output 153
processing of files 51
testing
programs 26
terminal 84
TEXT, control of translation tables 170
text format, of CP commands 39
text operand, of SEND command 137
TEXT operand, of TERMINAL command 170
TFB-512 devices, defining fixed-block mode
61
TFB-512 operand, of DEFINE command 58
time, determining length for a terminal
session 10Q
TIME operand, of QUERY command 109
timer, virtual, controlling 138
TIMER operand
of DEFINE command 58
of SET command 138
TO * operand, VMDUMP command 185

TO operand
of SPOOL command 153
of TRANSFER command 1&1
TO userid operand, VMDUMp'command 185
TRACE
command
ALL operand 176
BOTH operand
176
BRANCH operand 176
CCW operand 176
CSW operand 176
described 176
END operand 176
EXTERNAL operand 176
INSTRUCT operand 176
I/O operand 176
NORUN operand 176
OFF operand 176
PRINTER operand 176
PRIV operand
176
PROGRAM operand 176
RUN operand 176
SIO operan d 176
summary 193
SVC operan d 176
TERMINAL operand 176
TRACE output, closing 32
tracing
fixed-block mode device information
virtual machine activity 31,176
TRANSFER
command
ALL operand 181
CLASS operand 181
described 181
FORM operand
181
FROM operand
181
spoolid operand 181
summary 193
TO operand
181
userid operand 181
transferring
files
to a virtual reader 181
to another user 153
translating, CCWs, controlling 138
transmitting
spool files
locally 158
to remote locations 159
T2305 operand, of DEFINE command 58
T2314 operand, of DEFINE command 58
T2319 operand, of DEFINE command 58
T3310 operand, of DEFINE command 58
T3330 operand, of DEFINE command 58
T3340 operand, of DEFINE command 58
T3350 operand, of DEFINE command 58
T3370 operand, of DEFINE command 58
T3380 operand, of DEFINE command 58

178

U

underscore, use of 36
UNLOCK, command, summary 193
uppercase (letters and words) and special
symbols, use of 35
UR operand, of QUERY command 112
Index

205

TJSER operand
of INPICATE command 85
of QUERY command 127
userid operand
of COUPLE command 55
of DIAL command 70
of LINK command 92
of LOGON command 99
of MESSAGE command 102
of SEND command 137
of SMSG command 152
of SPOOL command 153
of TRACE command 181
using virtual forms control buffer
with the 3262 printer 96
with the 3289E printer 96

V

vaddr operand
of CLOSE command 51
of DETACH command 66
of DIAL command 70
of IPL command 88
of LINK command 92
of LOADVFCB command 96
of NOTRFADY command 104
of QUERY command 112
of READY command 130
of RESET command 132
of REWIND command 133
of SPOOL command 153
vaddrl opera~d, of COUPLE command 55
vaddr2 operand, of COUPLE command 55
VARY, command, summary 193
virtual console
disconnecting fro~ your virtual machine
12
read environment 24
spooling 17,153
virtual devices
closing 153
defining 58
detaching from your virtual machine 66
det~rmining number of for your virtual
machine 109
determining the status of 109
I/O, defining for your virtual machine
5A
removing from your virtual machine 66
simulating not ready status for
104
spec~fying a device-end interrupt for
/
130
virtual disks, permanent 14
virtual machine
activity, tracing 176
configuration, altering 58
determining status of 109
device, linking to 92
di~ctory entry
12
disconnecting 98
execution, resuming 46
logging off of 98
logging on 99
operating system, passing parameters to
~A

placing in
20~

~-dormant

state

151

reconfiguring 25
sending and processing special messages
152
setting control functions for 138
storing information from 163
tracing activity 31
virtual machine environment, entering a CP
command from 57
VIRTUAL operand, of QUERY command 112
virtual printer , specifying forms controls
for 96
virtual storage, altering 30
virtual storage locations
changing 163
printing 80
virtual timer, controlling 138
virtual unit record devices 15
virtual volumes (3330V), defining 58
VMDUM P command
*dumpid operand 185
bytecount operand 185
DSS operand 185
FOR8AT vmtype operand 185
hexlocl operand 183
hexloc2 operand 185
SYSTEM operand 185
TO * operand 185
TO userid operand 185
VMSAV! operand
of QUERY command 112
of SET command 138
VM/VS handshaking, control of 138

W

WARNING, command, summary 193
WNG operand, of SET command 138
writing, comments in VM/370 4

Z

zeros
clearing storage to 165
clearing storage to via IPL 88
clearing storage to via SYSTEM command
165

1

1403 operand, of DEFINE command
1443 operand, of DEFINE command

58
58

2

2501 operand, of DEFINE command 58
2540P operand, of DEFINE command 58
2540R operand, of DEFINE command 58

3

3203 device
as DEFINE operand 58
LOADVFCB restrictions

IBM V8/SP CP Command Reference for General Users

96

3203 operand, of DEFINE command 58
3203 printer, virtual, specifying forms
controls for 96
3211 operand, of DEFINE command 58
3211 printer, virtual, specifying forms
controls for 96
3262 operand, of DEFINE command 58
3262 printer, loading a virtual forms
control buffer 96
3270 device message length 102,152
3270 terminal, power off vs logoff,
precautions 98
3270 terminal display, highlighting
features available 172

3289E operand, of DEFINE command 58
3289E printer, loading a virtual forms
control buffer 96
3505 operand, of DEFINE command 58
3525 operand, of DEFINE command 58
3800 operand, of DEFINE command 58
3800 printer
modifying device attributes 153
modifying spool file attributes 49
print file duplication 47
spooling output to one 158
using CHANGE command 49
using SPOOL command 153
3850 Mass storage Systems
~~ MSS)

Index

207

20A

IB~

VM/SP CP Command Reference for General Users

IBM Virtual Machine/System Product
CP Command Reference for General Users

READER'S
COMMENT
FORM

SC19-6211-0

This manual is part of a library that serves as a reference source for systems analysts,
programmers, and operators of IBM systems. This form may be used to communicate
your views about this publication. They will be sent to the author's department for
whatever review and action, if any, is deemed appropriate. Comments may be written
in your own language; use of English is not required.
IBM may use or distribute any of the information you supply in any way it believes
appropriate without incurring any obligation whatever. You may, of course, continue
to use the information you supply.

Note: Copies of IBM publications are not stocked at the location to which this form is
addressed. Please direct any requests for copies of publications, or for assistance in using
your IBM system, to your IBM representative or to the IBM branch office serving your
locality.

•

Does the publication meet your needs?

•

Did you find the material:
Easy to read and understand?
Organized for convenient use?
Complete?
Well illustrated?
Written for your technical level?

•

What is your occupation?

•

How do you use this publication:
As an introduction to the subject?
F or advanced knowledge of the subject?
To learn about operating procedures?

Yes

No

o

o

o
o
o
o
o

o
o
o

o

o

o

o
o

As an instructor in class?
As a student in class?
As a reference manual?

o
o

o

Your comments:

If you would like a reply, please supply your name and address on the reverse side of this
form.

Thank you for your cooperation. No postage stamp necessary if mailed in the U.S.A.
(Elsewhere, an IBM office or representative will be happy to forward your comments.)

.

'"

44

:)~"I ~6211-0

Reader's Comment Form

"V

Fold and Tape

Please Do Not Staple

Fold and Tape

I

.................................................................................................................................................................. ·································1

&.
~

(")

"V

111111

NO POSTAGE
NECESSARY
..JF MAILED
IN THE
UNITED STATES

BUSINESS REPLY MAIL
FIRST CLASS

PERMIT NO. 40

....

ARMONK, N.Y.

o...

POSTAGE WILL BE PAID BY ADDRESSEE:

I nternational Business Machines Corporation
Department G60
P. O. Box 6
Endicott, New York 13760

:p

:r
So.

...................................................................................................................................................................................................1

Fold

Fold

If you would like a reply, please print:

I

:r
~
~

Your Name ____________________________________________________________
Company Name ..,..-_________________________ Department _________
Street Address ____________________________
City _______________________________

-- -- _

-- -------~-- ---.....
_-..r'_._
-------

State ___________________ Zip Code __________
IBM Branch Office serving you __________________________

~

®

International Business Machines Corporation
Data Processing Division
1133 Westchester Avenue, White Plains, N. Y. 10604
IBM World Trade Americas/Far East Corporation
Town of Mount Pleasant, Route 9, North Tarrytown, N. V., U. S. A. 10591
IBM World Trade Europe/Middle East/Africa Corporation
360 Hamilton Avenue, White Plains. N. V., U. S.A. 10601

-(I)

(")

to

a,

N

6



Source Exif Data:
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.3
Linearized                      : No
XMP Toolkit                     : Adobe XMP Core 4.2.1-c043 52.372728, 2009/01/18-15:56:37
Create Date                     : 2012:06:06 14:35:14-08:00
Modify Date                     : 2012:06:06 21:25:51-07:00
Metadata Date                   : 2012:06:06 21:25:51-07:00
Producer                        : Adobe Acrobat 9.51 Paper Capture Plug-in
Format                          : application/pdf
Document ID                     : uuid:0c4949b1-0ae9-4072-ade6-d8ec51788b49
Instance ID                     : uuid:8d3aab66-fea9-4ff2-84d7-7a9cf8c36a40
Page Layout                     : SinglePage
Page Mode                       : UseNone
Page Count                      : 220
EXIF Metadata provided by EXIF.tools

Navigation menu