HISTORICAL MANUALS
UNIVERSITY OF KENTUCKY
COMPUTING CENTER
CMS Reference
VM/SP Release 3
UU U KK K CCCC CCCC
UU U KK K CC CC
UU U KKK CC CC
UU U KK K CC CC
UUU KK K CCCC CCCC
Fifth Edition, Revision 0 (March 1984)
Users of this manual are encouraged to report
any errors or ambiguities, and to make
suggestions for improvements. The author can
be contacted at the address below.
Technical changes made to the contents of this
manual are indicated by a vertical bar to the
left of the change.
University of Kentucky
Computing Center
72 McVey Hall
Lexington, KY 40506-0045
Phone: 606/257-2900
Processed March 6, 1984-Waterloo SCRIPT - Version 82.2 (09/26/83)
Prepared by Dave Elbon
PREFACE
This manual is designed to be used as a reference. It contains
detailed command syntax and usage notes for many of the commands
(including XEDIT and its subcommands) available under the IBM Virtual
Machine System Product (VM/SP) Conversational Monitor System (CMS)
through the facilities of the University of Kentucky Computing Center.
Introductory information for new users can be found in several of the
manuals listed in the Bibliography.
| Not all commands available under VM/SP are documented in this manual.
| The intention is to cover the most commonly used commands (or at least
| their most commonly needed functions) and commands not documented
| elsewhere. Most commands not included here are covered in detail in
| either the VM/SP CMS Command and Macro Reference or the VM/SP HPO CP
| Command Reference for General Users.
| This manual reflects changes and additions made to VM/SP at the UKCC
| that aren't described in the IBM documentation. When there is a
| discrepancy between this manual and IBM documentation this manual is
| usually correct. Documentation for all commands is available online
| through the HELP command, and since the online information can be
| updated faster than printed manuals, HELP is usually the most accurate
| source.
| Refer to the Bibliography at the end of this manual for a list of
| other manuals that may be of interest. (Note: Some publications refer
| to software and hardware not available under CMS at the UKCC.)
Preface i
Summary of Changes
Fifth Edition, February 1984
· This edition replaces the UKCC CJS Reference and the UKCC CMS
Programming Supplement.
· Numerous changes have been made to reflect the new features
available with Release 3 of VM/SP.
· The default settings of PF10, PF11, and PF12 under XEDIT have
changed.
· XEDIT no longer supports EDGAR simulation mode, and the EDGAR and
ECOMMAND commands are no longer available.
· Minor changes and additions have been made to the XEDIT default
characteristics for some filetypes. Refer to Appendix A.
· The naming convention for XEDIT AUTOSAVE files has changed.
· Documentation has been added for several new commands, including
HI, PASSWORD, SAS, SSORT (SyncSort), and YCALC.
· The EXECIO command can be used in EXEC programs to perform a
number of functions. Since EXECIO is a nucleus resident
function, it is much more efficient than the equivalent function
performed by CMSDIO or one of the STKxxx commands. The LISTFILE
and QUERY commands now have stacking options and are both now
nucleus resident also. These should be used when possible
instead of the STKxxx commands.
· Because of the unwieldy size this manual has become, descriptions
of the following seldom used or obsolete commands have been
removed: BIGFILES, CMSPUN, NEWFILES, OPTANAL, RETCODE, SETUFLG,
STKCP, STKFILE and STKUFLG. The commands (and online help for
them) are still available.
· Minor editorial changes have been made throughout the manual.
Summary of Changes ii
CMS Reference
CONTENTS
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . i
Summary of Changes . . . . . . . . . . . . . . . . . . . . . . . . ii
Section 1. Command Summaries . . . . . . . . . . . . . . . . . . . 1
1.A Functional Summary . . . . . . . . . . . . . . . . . . . . . 1
1.B CMS Commands for EXEC Writers . . . . . . . . . . . . . . . 8
Section 2. Command Descriptions . . . . . . . . . . . . . . . . . 9
Section 3. Command Return Codes . . . . . . . . . . . . . . . . 345
Section 4. Communicating With Asynchronous ASCII Terminals . . . 346
4.A Asynchronous Protocols . . . . . . . . . . . . . . . . . . 346
4.B ASCII Typewriter Mode . . . . . . . . . . . . . . . . . . 347
4.C ASCII Display Mode Using S3270 . . . . . . . . . . . . . . 348
4.D Exchanging Files With Personal Computers . . . . . . . . . 350
Appendix A. XEDIT Default Filetype Attributes . . . . . . . . . 352
Appendix B. Character Translation for ASCII Communication . . . 354
Appendix C. Glossary . . . . . . . . . . . . . . . . . . . . . . 359
Bibliography . . . . . . . . . . . . . . . . . . . . . . . . . . 363
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366
Contents iii
CMS Reference
Section 1: Command Summaries
1.A Functional Summary
The tables on the following pages list the most frequently needed
functions available under CMS and some of the commands that can
perform them. More information about these commands can be found in
Section 2 of this manual.
+--------------------------------------------------------------------+
| Creating CMS Disk Files |
|--------------------------------------------------------------------|
| XEDIT Create a CMS disk file from data entered at your |
| terminal or copied from other CMS disk files. |
| FCOPY Create a CMS disk file by copying data from an |
| existing CMS disk file. |
| ACCEPT Create a CMS disk file by copying data from a reader |
| spool file. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Examining CMS Disk Files |
|--------------------------------------------------------------------|
| XEDIT Examine (and modify, if necessary) a CMS disk file. |
| | LEDIT Examine and modify a very large CMS disk file. |
| BROWSE Examine a CMS disk file (for 3270-type display |
| terminals only). Unlike XEDIT, BROWSE can be used |
| to examine files of any size. |
| TYPE Type the contents of a CMS disk file at your terminal.|
| MATCH Compare two CMS disk files and determine the changes |
| necessary to make the first file match the second. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Modifying CMS Disk Files |
|--------------------------------------------------------------------|
| XEDIT Examine and modify a CMS disk file. |
| | LEDIT Examine and modify a very large CMS disk file. |
| +--------------------------------------------------------------------+
Section 1: Command Summaries 1
CMS Reference
| +--------------------------------------------------------------------+
| Printing CMS Disk Files |
|--------------------------------------------------------------------|
| PRINT Generate a spool file for printing from the contents |
| of a CMS disk file. You must use the SETPRT command |
| to select a destination and other printing options |
| before issuing the PRINT command. |
| SCRIPT Format a document using text and control information |
| in a CMS disk file. SCRIPT can produce a spool file |
| for printing, type directly at your terminal, or |
| create a CMS disk file containing the formatted text. |
| Use SETPRT before generating a spool file for |
| printing. |
| TPRINT Type the contents of a CMS disk file on your terminal |
| using carriage control characters in the file. |
| LABELS Format labels using text in a CMS disk file. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Producing a List of CMS Disk Files |
|--------------------------------------------------------------------|
| FLIST Produce a menu describing selected CMS disk files. |
| Commands using the files may be issued from the FLIST |
| menu. This command can be used only on 3270-type |
| display terminals. |
| LISTFILE Produce a list of selected CMS disk files and the |
| or LISTX attributes of each. Output may be directed to your |
| terminal, a spool file, or a CMS disk file. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Erasing CMS Disk Files |
|--------------------------------------------------------------------|
| BURN Erase a selected CMS disk file (or files). |
| ERASE Erase a selected CMS disk file (or files). |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Word Processing |
|--------------------------------------------------------------------|
| SCRIPT Format a document using text and control information |
| in a CMS disk file. (see "Printing CMS Disk Files") |
| XEDIT Create, examine, and modify a CMS disk file. |
| SPELLFIX Check the spelling of words in a CMS disk file, and |
| suggest alternatives for misspelled words. |
+--------------------------------------------------------------------+
Section 1: Command Summaries 2
CMS Reference
+--------------------------------------------------------------------+
| Other CMS Disk File Manipulations |
|--------------------------------------------------------------------|
| | SSORT Sort the contents of a CMS disk file based on the data|
| in selected columns. |
| CODETRAN Translate the contents of a CMS disk file to and from |
| EBCDIC, ASCII, or user specified codes. |
| COPYFILE Copy one or more CMS disk files and optionally perform|
| specified manipulations. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Sharing CMS Disk Files with Other Users |
|--------------------------------------------------------------------|
| Two or more users may simultaneously have access to a CMS disk |
| and read the files it contains. Only one user should ever have |
| write-access to a CMS disk. If two or more users have write- |
| access to a CMS disk, the disk file directory may be corrupted |
| and the files permanently lost. |
| |
| AUTOLINK Authorize other users to LINK to your CMS disk. |
| LINK and Gain access to another user's CMS disk. The other |
| ACCESS user must have used AUTOLINK to authorize the LINK. |
| After a successful LINK, you must use the ACCESS |
| command before you can actually use the files. |
| DROP Release a minidisk and drop the link. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Creating Plots |
|--------------------------------------------------------------------|
| PLOT Send a CMS disk file containing Zeta Graphic Machine |
| Language (GML) instructions to be plotted on the Zeta |
| plotter in the UKCC Computer Room. GML data files |
| are generated by the standard plotting subroutines |
| | in ZETALIB. |
| OUTPUT Send a reader spool file containing Zeta GML in- |
| structions to be plotted in the UKCC Computer Room. |
| PLOTAJ Produce a plot on an Anderson Jacobson 832 or 833 |
| terminal. The input is a CMS disk file containing |
| GML instructions. This will produce a plot with |
| relatively low resolution. |
| PLOTHP Produce a plot on a Hewlett Packard 2647a graphics |
| terminal. The input is a CMS disk file containing |
| GML instructions. |
| PLOTTEK Produce a plot on a Tektronix (or compatible) |
| graphics terminal. The input is a CMS disk file |
| containing GML instructions. |
| | SAS The Statistical Analysis System can produce several |
| | kinds of plots on supported terminals. |
+--------------------------------------------------------------------+
Section 1: Command Summaries 3
CMS Reference
+--------------------------------------------------------------------+
| Communicating With Other CMS Users |
|--------------------------------------------------------------------|
| SENDFILE Send a CMS disk file to one or more users. |
| or SFILE |
| NOTE Create (using XEDIT) a note and send it to one or |
| more users. |
| OUTPUT Send a reader spool file to another user. |
| TELL Send a brief (one line) message to one or more |
| logged on users. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Examining Reader Spool Files |
|--------------------------------------------------------------------|
| PEEK Examine a reader spool file with XEDIT. |
| RBROWSE Examine a reader spool file (for 3270-type display |
| terminals only). |
| RXEDIT Examine a reader spool file with XEDIT. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Printing Reader Spool Files |
|--------------------------------------------------------------------|
| OUTPUT Send a reader spool file to be printed. |
| GATHER Gather several reader spool files into a single file. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Producing a List of Reader Spool Files |
|--------------------------------------------------------------------|
| RDRLIST Produce a menu describing selected reader spool files.|
| or RLIST This command is similar to FLIST and FILELIST and is |
| most useful on a 3270-type display terminal. |
| RDRCOST Produce a list of selected reader spool files and the |
| attributes and estimated cost of each. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Erasing Reader Spool Files |
|--------------------------------------------------------------------|
| BURN Erase (purge) a reader spool file. |
| PURGE Erase (purge) a reader spool file or files. |
+--------------------------------------------------------------------+
Section 1: Command Summaries 4
CMS Reference
+--------------------------------------------------------------------+
| | Programming Languages |
| |--------------------------------------------------------------------|
| A number of programming languages are available under CMS. The |
| names of the commands generally begin with four or five letters |
| to indicate the language and end with one or two letters to |
| indicate the function of the command. "C" means compile, "CG" |
| means compile and execute (go), and "G" means execute (go). |
| |
| Some of the available language processors are no longer |
| supported. This means that the organization that originally |
| supplied it will no longer investigate or correct problems, and |
| that the UKCC probably will not be able to supply consulting |
| assistance. These languages can still be used successfully, |
| but if you encounter a problem you are on your own. Use them |
| at your own risk! |
| |
| Assembler |
| ASMXC IBM Assembler XF |
| ASMXCG |
| ASMXG |
| |
| BASIC |
| BASIC IBM CALL/OS BASIC interpreter (BASIC is no longer |
| supported by IBM. WBASIC is recommended.) |
| WBASIC Waterloo BASIC interpreter |
| |
| COBOL |
| COBDC IBM VS COBOL (with Interactive Debug) |
| COBDCG |
| COBDG |
| COBVC IBM VS COBOL |
| COBVCG |
| COBVG |
| |
| FORTRAN |
| FORTGC IBM FORTRAN G (FORTRAN G is no longer supported by |
| FORTGCG IBM. VS FORTRAN is recommended.) |
| FORTGG |
| FORTVC IBM VS FORTRAN (VS FORTRAN conforms to the standard |
| FORTVCG known as FORTRAN 77.) |
| FORTVG |
| FORTXC IBM FORTRAN H Extended |
| FORTXCG |
| FORTXG |
| WATFIV Waterloo FORTRAN interpreter |
| |
| LISP |
| LISP Partial implementation of the Utah LISP interpreter. |
| (not supported) |
|--------------------------------------------------------------------|
| (Continued on the next page...) |
+--------------------------------------------------------------------+
Section 1: Command Summaries 5
CMS Reference
+--------------------------------------------------------------------+
| | Programming Languages (Continued) |
| |--------------------------------------------------------------------|
| Pascal |
| PAS4C P4 Pascal (not supported) |
| PAS4CG |
| PAS4G |
| PW Waterloo Pascal interpreter |
| P8000 AAEC Pascal 8000 (not supported) |
| |
| PL/I |
| PLC Cornell PL/CT interpreter |
| PLIXC IBM PL/I Optimizer |
| PLIXCG |
| PLIXG |
| PLIC IBM PL/I Checkout |
| PLICR |
| |
| SPITBOL |
| SPITBOL IIT SPITBOL (not supported) |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| | Disk and Processor Storage |
| |--------------------------------------------------------------------|
| STORAGE Redefine the amount of processor storage available |
| to programs running on your userid. Some programming |
| languages and packages may require more storage than |
| the initial (512K) storage size. |
| TDISK Define a temporary CMS minidisk. TDISK space is |
| discarded when you DROP it, when you log off, when |
| the system is shut down, or if there is a system |
| failure. TDISK is often needed to supply work space |
| for programming language compilers. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| CMS Batch |
|--------------------------------------------------------------------|
| BATCH Send a CMS disk file or files containing control |
| statements and CMS commands to the CMS batch system |
| for processing. The BATCH command can help you |
| create a CMS batch job interactively. Output from |
| your batch job can be routed back to your userid in a |
| reader spool file, or printed. |
+--------------------------------------------------------------------+
Section 1: Command Summaries 6
CMS Reference
+--------------------------------------------------------------------+
| OS Batch |
|--------------------------------------------------------------------|
| SUBMIT Send a CMS disk file or files containing JCL and data |
| to the OS batch system. Output from your batch job |
| can be routed back to your userid in a reader spool |
| file, or printed. |
| STATUS Display the status of your OS batch jobs. |
| CANCEL Cancel an OS batch job. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Communicating with Personal Computers |
|--------------------------------------------------------------------|
| The section on Asynchronous Communication contains more |
| information about personal computers. |
| |
| TERMINAL Set terminal communication options. |
| | KERMIT Communicate with a personal computer or other system |
| | running KERMIT. KERMIT supports two-way file |
| | exchange. KERMIT is available (without charge) for |
| | several systems, including the IBM PC. |
| HOSTCM Communicate with a personal computer acting as your |
| CMS terminal. HOSTCM supports two-way file exchange. |
| The personal computer must be using the Waterloo |
| Computing Systems microSoftware. |
| FSEND Send a file to a personal computer acting as your CMS |
| terminal. |
+--------------------------------------------------------------------+
+--------------------------------------------------------------------+
| Other Functions |
|--------------------------------------------------------------------|
| HELP Display documentation at your terminal. |
| MANUAL Display (at a 3270-type display) or print a manual. |
| CALC Desk calculator. |
| | NEWS Display online news. |
| | KYREG Display the online version of the Kentucky Register, |
| | the UKCC's monthly newsletter. |
| | RATES Display the current charging rates. |
| | GRIPE Send a complaint to the UKCC User Services Group. |
| | YCALC Spreadsheet calculator. |
+--------------------------------------------------------------------+
Section 1: Command Summaries 7
CMS Reference
1.B CMS Commands for EXEC Writers
Some commands are intended primarily for use from an EXEC (some can be
used only from an EXEC). The following table is a summary of these
| commands. Refer to the description of the EXEC command in this manual
| for more information about REXX, EXEC 2, and EXEC.
+--------------------------------------------------------------------+
| Command | Function |
|----------|---------------------------------------------------------|
| CHECKBUF | Determine the number of lines in a stack buffer |
| CLEAR | Clear the screen of a display terminal |
| CMDCALL | Execute a command with a CMS extended p-list |
| CMSCMSG | Write a message on the command line of a 3270 display |
| CMSPMSG | Write a prompt message on the terminal |
| CMSREAD | Read and stack a line from the terminal |
| CMSTIO | Determine if a device exists |
| CONWAIT | Wait for terminal I/O to complete |
| DESBUF | Clear all console and stack buffers |
| DROPBUF | Destroy one or more CMS program stack buffers |
| ENVIRON | Determine the current environment |
| EXec | Execute another EXEC |
| EXECIO | Perform various functions from an EXEC |
| | EXECOS | Reset the OS simulation environment |
| | GETFMODE | Get an available filemode (ACCESS) letter |
| | GETVADDR | Get an available virtual device address |
| GLOBALV | Set and examine global variables |
| IDentify | Stack your userid, the date, and other information |
| | IMMCMD | Establish and cancel immediate commands |
| | LISTFILE | Use the STACK option to get information about files |
| MAKEBUF | Create a CMS program stack buffer |
| MENUEXEC | Display an XMENU panel |
| NAMEFind | Retrieve information from a NAMES file |
| | QUERY | Use the STACK option to get CMS and CP information |
| RANDOM | Generate a random number |
| RDR | Determine the format of a reader spool file |
| SELECT | Select records from a CMS disk file |
| SENTRIES | Determine the number of lines in the CMS program stack |
| SPELLCHK | Check the spelling of words from file or stack |
| STATE | Verify the existence of a CMS disk file |
| STATEW | Verify a file on a read/write CMS disk |
| STKDATE | Stack day, date, and time |
| STKDISK | Stack information about an accessed disk |
| STKID | Stack system and userid information |
| STKRDR | Stack reader spool file numbers |
| STKTERM | Stack terminal information |
| STKTIME | Stack timing information |
| STKXRDR | Stack detailed reader spool file information |
| VERIFY | Issue a message and read a yes/no response |
| WAITRDR | Wait for a reader spool file to arrive |
+--------------------------------------------------------------------+
Section 1: Command Summaries 8
CMS Reference
Section 2: Command Descriptions
This section contains detailed descriptions of many of the commands
available under CMS. The conventions used in the descriptions are
similar to those used in the IBM VM/SP publications. Command and
option names use uppercase and lowercase to indicate minimum
abbreviations; parts shown in uppercase must be entered as shown.
Brackets are used to mark optional parameters or a list of choices,
and default values are underlined.
This section includes CMS commands, CP commands, and XEDIT subcommands
(grouped under XEDIT). EXEC's and CP commands are marked as such to
aid EXEC writers, since this distinction can be important.
| The information in this section is available at your terminal from the
| HELP command. To get help for most commands just enter
| help [command]
| where [command] is the name of the command. For XEDIT subcommands,
| and for cases when there are several commands with the same name, you
| must specify a qualifier with the command name:
| help xedit [subcommand]
| or
| help cp [command]
For commands not described in this section refer to the IBM
documentation or online HELP for more information.
Section 2: Command Descriptions 9
CMS Reference
? (CMS Recall Function)
Use the ? function to display the previous command entered from your
terminal or through the CMS program stack.
+--------------------------------------------------------------------+
| | |
| ? | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. Anything following the question mark on the command line is
ignored.
2. Commands entered while in CP mode, the ? and = functions, and the
CMS immediate commands (HT, HX, etc.) cannot be recalled with
this function. Users of 3101 and 3270-type display terminals may
use the CP RETRIEVE PF key function to display and reissue
previously entered lines, including those not available from the
? function.
3. On a 3270-type display terminal the command is displayed in the
command input area at the bottom of the screen. The command line
may then be modified and may be reissued by pressing ENTER.
4. The ? function may be entered only from the keyboard (including
Program Function keys) or through the CMS program stack. It may
not be directly executed from an EXEC. The CMS editors support ?
subcommands with similar functions.
Section 2: Command Descriptions 10
CMS Reference
& (CMS Retain Function)
Use the & function to execute a command and leave the command line in
the input area of your 3270-type display terminal.
+--------------------------------------------------------------------+
| | |
| & | [command line] |
| | |
+--------------------------------------------------------------------+
where
command line
is the command line to be executed. The entire line
(including the ampersand) remains in the input area. It may
be modified and may be reissued by pressing ENTER.
Usage Notes
1. The command line may not use the retain (&) function. In other
words, no more than one ampersand is allowed on a command line.
2. The ampersand is ignored on all terminals other than 3270-type
displays.
3. Some commands (such as CMSCMSG and the ? function) alter the
command input line and overwrite the retained command.
4. The & function may be entered only from the keyboard (including
Program Function keys) or through the CMS program stack. It may
not be directly executed from an EXEC. Some CMS editors support
an & subcommand with a similar function.
Section 2: Command Descriptions 11
CMS Reference
= (CMS Reuse Function)
Use the = function to reissue the previous command entered from your
terminal or through the CMS program stack. You may follow the equal
sign with an additional CMS command (including an equal sign) on the
same line. This additional command will be issued before the previous
command is repeated.
+--------------------------------------------------------------------+
| | |
| = | [command line] |
| | |
+--------------------------------------------------------------------+
where
command line
is an optional additional command or function. This is
issued before the previous command is repeated. The = and ?
functions may be used.
Usage Notes
1. Commands entered while in CP mode, the ? and = functions, and the
CMS immediate commands (HT, HX, etc.) cannot be reissued with
this function. Users of 3101 and 3270-type terminals may use the
CP RETRIEVE PF key function to display and reissue previously
entered lines, including those not available from the = function.
2. Entering multiple equal signs on one line will cause the previous
command to be repeated once for each equal sign entered.
3. The = function may be entered only from the keyboard (including
Program Function keys) or through the CMS program stack. It may
not be directly executed from an EXEC. The CMS editors support =
subcommands with similar functions.
Section 2: Command Descriptions 12
CMS Reference
ACCEPT (EXEC)
Use the ACCEPT command to copy a reader spool file into a CMS disk
file. The reader file is purged. ACCEPT can process any input format
(NETDATA, print, etc.) and can be used to receive files sent with the
NOTE and SENDFILE commands.
+--------------------------------------------------------------------+
| | + + |
| ACCEPT | |spoolid [* [fm]]| [( options... [)]] |
| | |name [type [fm]]| |
| | |* * A1 | |
| | + + |
+--------------------------------------------------------------------+
where
spoolid is the spool file number of the reader spool file to be
processed. The default is "*", the first file in your
reader.
name [type]
select an input file by spool file name and type rather than
number. (Not all spool files have names and types.) The
default type is "*," the first file that matches the
specified name.
fm is the filemode used for the created CMS disk file. The
default is "A1." The filemode is ignored if the input file
is in DISK DUMP format.
options Depending on the data format, ACCEPT uses INPUT, RECEIVE,
DISK, or READCARD to process the file, and ACCEPT options
are passed to the command used. Refer to the descriptions
of these commands for more information.
Usage Notes
1. The parameters used to select an input spool file are handled by
the INPUT command. ACCEPT can use any of the parameters of the
INPUT command.
2. When processing files in NETDATA format (used by NOTE and
SENDFILE), ACCEPT returns an acknowledgment if one was requested
by the originating user.
Messages and Return Codes
DMSACP024E File "[fn ft fm]" already exists. RC=28
DMSACP655E Reader file [n] does not exist, or is in hold. RC=28
Section 2: Command Descriptions 13
CMS Reference
ACCEPT (EXEC)
DMSACP687E File [n] is a dump file and cannot be processed. RC=1
| DMSACP999E Reader not ready or not operational. RC=100
| DMSACP999E Weird result from RDR command. RC=100
Messages may also be produced by DISK, INPUT, READCARD, and RECEIVE.
Section 2: Command Descriptions 14
CMS Reference
ACCESS
Use the ACCESS command to identify a minidisk to CMS and establish a
filemode letter for the files on the disk. This is a partial
description of the ACCESS command; other options are available.
+--------------------------------------------------------------------+
| | + + |
| ACcess | |disk mode[/ext [fn [ft [fm]]]]| [( options... [)]] |
| | |191 A * * * | |
| | | | |
| | + + |
| | |
| | Options: |
| | |
| | [NOIMSG] [NOPROF] |
| | |
+--------------------------------------------------------------------+
where
disk is the virtual device address of the minidisk to be
accessed. The default value is 191.
mode is the one-character filemode letter assigned to all files
on the disk being accessed. If "disk" is not specified, a
default mode of "A" is supplied. You should generally not
access disks as modes W, X, Y, or S, since these modes are
reserved for system use.
/ext indicates that the disk is to be a read-accessed extension
to the disk accessed as mode "ext". The slash must not be
preceded or followed by a blank.
fn [ft [fm]]
defines a subset of the files on the specified disk that
will be made accessible. An asterisk coded in any of these
fields indicates that all filenames, filetypes, or filemode
numbers (except mode number 0) are to be included. You may
also specify general forms using an asterisk suffix. You
must specify both a letter and a number for the filemode.
This feature may not be used when accessing OS disks.
Options
NOIMSG suppresses most informational messages.
NOPROF suppresses execution of the PROFILE EXEC file. This option
is valid only if the ACCESS command is the first command
entered after you IPL CMS. On subsequent ACCESS commands
the NOPROF option is ignored.
Section 2: Command Descriptions 15
CMS Reference
ACCESS
Usage Notes
1. When you log on (or when you IPL CMS), a number of disks are
accessed automatically by CMS. All CMS users have a write-
accessed A-disk (191) for storing files. Some users also have a
D-disk (192). The shared system S-disk (190) and Y-disk (19E)
are accessed also. These disks contain system files necessary
for the operation of CMS and should not be accessed in any other
way. You should not issue the ACCESS command using modes S, W,
X, or Y.
2. The Public disk is accessed with the PUBLIC command. It is
accessed as the Z-disk by default.
3. You can force your A-disk to read-only status by accessing it as
an extension of itself or another disk; for example:
access 191 a/a
4. Files on a read-accessed disk with a filemode number of 0 ("B0,"
for example) normally are not accessible. The documentation of
the RENAME command discusses filemode numbers in more detail.
5. The RELEASE and DROP commands make an accessed disk inaccessible.
DROP also drops your link to a disk, requiring you to LINK to the
disk to make it accessible again.
| 6. If a user with write-access to a minidisk updates a file and
| other users with read-access then try to read that same file, the
| other users will get the older version of the file, garbled
| records, or CMS file system errors (most often "DMSxxx104S ERROR
| 3 READING FILE"). The users with read-access should issue the
| ACCESS command again to use the updated file directory. Using
| filemode number 6 for shared files can eliminate this problem in
| some applications.
7. The OSDISK command will access the OS volumes containing user
data sets. These disks are accessed starting with mode H, and
| you should not access other disks using modes H through V if you
| use OS data sets from CMS. You should not access the OS disks by
issuing ACCESS yourself; always use the OSDISK command to be
certain that all of the current user volumes are available to
you.
Section 2: Command Descriptions 16
CMS Reference
AJ833 (EXEC)
Use the AJ833 command to prepare an Anderson Jacobson model 833
terminal with the High Speed Option for printing SCRIPT and other text
output.
+--------------------------------------------------------------------+
| | |
| AJ833 | [On|OFF] |
| | |
+--------------------------------------------------------------------+
where
On prepares both the terminal and VM/SP to use some of the
special features of an Anderson Jacobson 833 terminal.
OFF stops use of the special features.
Usage Note
AJ833 changes the CMS output translate table to properly produce
boxes. IDLE characters are translated to NULL to increase printing
speed. ETX/ACK protocol, which allows the terminal to receive data at
1200 baud, is enabled. This requires the High Speed Option of the AJ
833 terminal.
Messages and Return Codes
AJ833 may produce messages from the CMS SET command and the CP
TERMINAL command. Attempting to issue this command from other than an
asynchronous ASCII terminal will result in an error message and a non-
zero return code.
Section 2: Command Descriptions 17
CMS Reference
ASMXC (EXEC)
Use the ASMXC command to assemble a program with the IBM VM Assembler
(Assembler XF).
+--------------------------------------------------------------------+
| | |
| ASMXC | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the
assembler source program. The filetype of the file must be
"ASSEMBLE," and it must contain fixed-length, 80-byte
records. This filename will be used for the TEXT and
LISTING files, if they are created.
options are assembler options. The assembler has options to control
its output, listings produced, and other functions.
Usage Notes
1. ASMXC uses the default macro libraries for CMS: CMSUKCC, DMSSP,
CMSLIB, XMENU, OSMACRO, and TSOMAC. You cannot use ASMXC if you
need other macro libraries.
2. Refer to the description of the ASSEMBLE command for more
information.
Section 2: Command Descriptions 18
CMS Reference
ASMXCG (EXEC)
Use the ASMXCG command to assemble (using the IBM VM Assembler) and
execute a program.
+--------------------------------------------------------------------+
| | |
| ASMXCG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the
assembler source program. The filetype of the file must be
"ASSEMBLE," and it must contain fixed-length, 80-byte
records. This filename will be used for the TEXT and
LISTING files, if they are created.
options are assembler options.
Usage Notes
1. ASMXC uses the default macro libraries for CMS: CMSUKCC, DMSSP,
CMSLIB, XMENU, OSMACRO, and TSOMAC. You cannot use ASMXC if you
need other macro libraries.
2. The default subroutine libraries are used: ZETALIB and CMSLIB.
If you need to use additional libraries or load additional object
files you must use the ASMXG command to execute your program.
3. The assembled program is loaded and executed. Refer to the
descriptions of the ASSEMBLE and LOAD commands for more
information.
Section 2: Command Descriptions 19
CMS Reference
ASMXG (EXEC)
Use the ASMXG command to execute a previously assembled program.
+--------------------------------------------------------------------+
| | |
| ASMXG | filename [filename...] [( [libraries] [> parms] ] |
| | |
+--------------------------------------------------------------------+
where
filename are the filenames of the CMS disks file containing the
object program. The filetypes of the files must be "TEXT."
libraries are the names of subroutine libraries (TXTLIB's). Any
libraries specified here are searched before the default
libraries: ZETALIB and CMSLIB.
parms are command line parameters for the executed program.
Usage Note
Refer to the descriptions of the ASMXC and ASSEMBLE commands for more
information.
Section 2: Command Descriptions 20
CMS Reference
ASSEMBLE
Use the ASSEMBLE command to assemble a program with the IBM VM
Assembler (Assembler XF). The ASMXCG, ASMXC, and ASMXG commands also
are available for use with assembler programs.
+--------------------------------------------------------------------+
| | |
| Assemble | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the
assembler source program. The filetype of the file must be
"ASSEMBLE," and it must contain fixed-length, 80-byte
records. This filename will be used for the TEXT and
LISTING files, if they are created.
options are assembler options. ASSEMBLE has options to control its
output, listings produced, and other functions.
Usage Note
1. Detailed descriptions of the assembler options are available in
the VM/SP CMS Command and Macro Reference and from the HELP
command. A description of the assembler language can be found in
the OS/VS-DOS/VSE-VM/370 Assembler Language manual. The language
is an extended version of that used by OS Assembler F.
2. When writing programs to run under CMS, the following macro
libraries should be specified on a GLOBAL MACLIB command (in this
order):
CMSUKCC DMSSP CMSLIB
Depending on your application, you may also need the XMENU,
OSMACRO, and TSOMAC libraries. Use OSMACRO for programs that use
OS simulation or are to be run under the OS batch system. You
can create your own macro libraries with the MACLIB command.
Section 2: Command Descriptions 21
CMS Reference
AUTOLINK (EXEC)
Use the AUTOLINK command to authorize other users to access your CMS
disk files. Once authorized by you, another user can use the LINK and
ACCESS commands to gain access to your CMS disk files. AUTOLINK can
also be used to revoke authorizations, examine existing authorization
rules, and assign another user to act as your proxy.
+--------------------------------------------------------------------+
| | |
| AUTOLINK | function [( option [)]] |
| | |
| | Functions: |
| | |
| | ASSIGN proxy |
| | AUTH disk level rule1 [| rule2 [| rules] ... ] |
| | DELete disk rulenumber |
| | Display disk [rulenumber|ALL] |
| | DROP proxy |
| | EXClude disk level rule1 [| rule2 [| rules] ... ] |
| | FOR userid function |
| | LOCK disk |
| | Query [disk [ALL]|SYSTEM] |
| | SENDLog disk |
| | SET LOG disk level logmode |
| | UNLOCK disk |
| | |
| | Options: |
| | |
| | [MSG | NOMSG | SMSG] |
| | |
+--------------------------------------------------------------------+
where
ASSIGN proxy
designates a user who may act as your proxy. The designated
user (or users) may use the AUTOLINK FOR function to issue
AUTOLINK commands for you. Use the AUTOLINK DROP function
to drop a proxy designation.
AUTH disk level rule1 [| rule2] ...
authorizes one or more users to LINK to your minidisk with
virtual address "disk." The "level" parameter specifies the
level of access allowed: R (read), W (write if no other
links), M (write if no write links), or X (write even if
other write links). Warning! You should not specify level
X. If two or more users simultaneously have write-access to
a CMS minidisk (even if they do not modify any files) the
disk file directory for that minidisk may be destroyed and
the files permanently lost.
Section 2: Command Descriptions 22
CMS Reference
AUTOLINK (EXEC)
The simplest kind of rule is "USER userid," which grants
access to a single user. More complex rules are discussed
in the Usage Notes.
DELete disk rulenumber
deletes the specified authorization rule for the specified
minidisk. The AUTOLINK DISPLAY function can be used to
display existing rules.
Display disk [rulenumber|ALL]
displays the complete history of a specific authorization
rule or a brief list of all rules for a particular minidisk.
DROP proxy
revokes a proxy granted with the AUTOLINK ASSIGN function.
EXClude disk level rule1 [| rule2] ...
defines exclusion rules for a minidisk. Use AUTOLINK
EXCLUDE to exclude users from a group defined with the
AUTOLINK AUTH function. The syntax of this function is the
same as that of the AUTOLINK AUTH function. Refer to the
Usage Notes for more information.
FOR userid function
is used to issue an AUTOLINK function for another user.
Before you can use this function, the other user must have
used AUTOLINK ASSIGN to make your userid a proxy. A proxy
may not issue the ASSIGN, DROP, or FOR functions for another
user.
LOCK disk
temporarily prevents any links to the specified minidisk
from any users except the owner or the proxy who issued the
AUTOLINK LOCK. Use the AUTOLINK UNLOCK function to allow
access by authorized users. Locking a minidisk will not
affect any existing links.
Query [disk [ALL] | SYSTEM]
displays information about the specified minidisk, or about
the AUTOLINK system.
SENDLog disk
causes the access log for the specified minidisk to be sent
to you in a spool file. The system clears the log after
sending a copy. Use the AUTOLINK SET LOG function to enable
access logging.
SET LOG disk level logmode
enables access logging for the specified minidisk. The
"level" may be specified as R (read), W (write), or M
(mult). The "logmode" may be specified as NONE, AUTH, FAIL,
Section 2: Command Descriptions 23
CMS Reference
AUTOLINK (EXEC)
or ALL. Use the AUTOLINK SENDLOG function to retrieve the
access log.
UNLOCK disk
unlocks a minidisk after AUTOLINK LOCK has been used.
Options
MSG causes AUTOLINK responses to be sent to you with a heading
and time-stamp.
NOMSG suppresses AUTOLINK responses.
SMSG causes AUTOLINK responses to be sent using the SMSG
interface. The last line will contain "===> END OF RESPONSE
<===." This option is provided for special purposes and
should not be specified by CMS users.
Usage Notes
1. Once authorized by you, another user can access your CMS disk
files with the LINK and ACCESS commands. You can restrict
another user to read-access, or permit write-access. You should
not allow X-level access (which permits MW links) because CMS
does not support write-access to a minidisk from more than one
user. If two or more users simultaneously have write-access to a
minidisk, the disk file directory may be destroyed and the files
permanently lost. For more information about sharing CMS disk
files refer to the descriptions of the LINK and ACCESS commands.
2. The rule definitions used by the AUTOLINK AUTH and EXCLUDE
functions allow you to authorize or exclude a single userid, or a
group of userids, and restrict access by date, time, and number
of LINKs. The following forms can be used:
Form Defines
--------------- -------------------------------------
USER userid A single userid
USER pattern* Any userid that begins with "pattern"
FROM time Time limits using day, date, and time
TO time Time limits using day, date, and time
COUNT n Number of times the rule may be used
Time limits may be specified using a day of the week, a time
(hh:mm[:ss]), or a date [mm/dd[/yy]), or any combination
specified in any order.
3. Unless NOMSG or SMSG is specified, AUTOLINK uses CP messages to
return responses to you. If you have SET MSG OFF these responses
will be suppressed.
Section 2: Command Descriptions 24
CMS Reference
| BALANCE
Use the BALANCE command to obtain the allocation and balance for your
userid.
+--------------------------------------------------------------------+
| | + + |
| BALANCE | [target] [( [Type] |Stack| [QUIET] [)]] |
| | |Lifo | |
| | |Fifo | |
| | + + |
+--------------------------------------------------------------------+
where
target is the userid or project number to be checked. The default
is your userid. If you specify a userid or project number
for which you are not authorized the balance will not be
returned and the system will record the attempt.
Options
Fifo puts the data in the stack (first-in, first-out).
Lifo is a synonym for STACK.
QUIET suppresses all error messages. If an error occurs the
return code indicates the nature of the error. This option
is intended for use in an EXEC.
Stack puts the data in the stack (last-in, first-out).
Type displays the data on the terminal. This is the default.
Usage Notes
1. The allocation and balance returned are for the userid or project
number specified. If the target does not have an allocation the
information will be from the userid or project containing the
allocation used by the target. The balance is not available for
some userids and project numbers.
2. The stacking options (STACK, LIFO, and FIFO) put a single line
containing the following data on the program stack:
1. An asterisk (*)
2. If no target was specified, the four-digit department number
If a target was specified, four asterisks (****)
3. If no target was specified, the five-digit project number
If a target was specified, five asterisks (****)
Section 2: Command Descriptions 25
CMS Reference
| BALANCE
4. Balance (dollars)
5. Balance (cents)
6. Allocation (dollars)
7. Allocation (cents)
8. Userid or project containing allocation used by the target
9. Allocation
10. Balance
11. Logon-time allocation
12. Logon-time balance
13. Disk space allocation
14. Disk space balance
3. The balance is updated for OS batch jobs and printed output when
they occur, CMS sessions are charged at the end of each day
(after midnight), and plotting and other charges are added at the
end of each month.
4. In a CMS Batch job the default target is the project number to
which the job will be charged. CMS Batch jobs cannot obtain the
balance for other userids or project numbers.
Messages and Return Codes
In case of an error, the return code will be the message number.
OUIBAL001E "[string]" is an extraneous parameter.
OUIBAL001E "[string]" is not a valid parameter.
OUIBAL002E "[string]" is not an option.
OUIBAL011E You are not authorized for this service.
OUIBAL011E This attempt has been recorded.
OUIBAL012E Sorry, but this transaction cannot be completed at this
time.
OUIBAL012E Try again later.
OUIBAL013E No record found for [target].
OUIBAL014E You are not authorized to access data for [target].
OUIBAL014E This attempt has been recorded.
OUIBAL020E The balance is not available for [target].
OUIBAL100E Error code [code] from an IUCV function.
OUIBAL101E An IUCV handler already exists for service name.
Communication cannot be established.
OUIBAL102E An IUCV DECLARE BUFFER has already been issued. CMS IUCV
support cannot be initialized.
OUIBAL103E Service is shutting down and cannot accept requests; try
again later.
OUIBAL104E IUCV message limit exceeded.
OUIBAL105E IUCV priority messages are not allowed.
OUIBAL106E Service is not available; try again later.
OUIBAL107E Service is not running; try again later.
OUIBAL108E Maximum number of IUCV connections exceeded for your
userid.
OUIBAL109E No service connections are available; try again later.
Section 2: Command Descriptions 26
CMS Reference
| BALANCE
OUIBAL110E Not enough storage available.
Section 2: Command Descriptions 27
CMS Reference
BASIC
Use the BASIC command to run a program with CALL/OS BASIC. CALL/OS
BASIC is not supported; Waterloo BASIC (WBASIC) generally should be
used for new programs.
+--------------------------------------------------------------------+
| | |
| BASIC | filename [( [LONG] [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the file containing the BASIC program.
The filetype must be "BASIC," and it must contain fixed-
length records.
LONG causes long precision floating-point to be used. Short
floating-point is used by default.
Statements
CHAIN DIM GOSUB LET PAUSE REM STOP
CLOSE END GOTO MAT PRINT RESET USE
DATA FOR IF NEXT PUT RESTORE
DEF GET INPUT OPEN READ RETURN
Arithmetic Functions
ABS abs. value CSC cosecant INT int. part SEC secant
ACS arccosine DEG rad-to-deg LGT log 10 SGN sign
ASN arcsine EXP natural exp LOG log e SIN sine
ATN arctangent HCS hyper. cos. LTW log 2 SQR square root
COS cosine HSN hyper. sin. RAD deg-to-deg TAN tangent
COT cotangent HTN hyper. tan. RND random
Usage Note
1. Line numbers are required only if needed as the target of a GOTO.
2. BASIC supplies the following built-in constants: &E (2.718282),
&PI (3.141593), and &SQR2 (1.414214).
3. No additional information is available.
Section 2: Command Descriptions 28
CMS Reference
BATCH
The BATCH command is your interface with the CMS Batch system. It can
submit jobs (and assist in their preparation), change job parameters
after submission, cancel jobs, hold and release jobs, and query the
CMS Batch system for information.
+--------------------------------------------------------------------+
| | |
| BATch | [function [( options... [)]] |
| | |
| | Functions: |
| | |
| | macroname [parms] |
| | |
| | Submit [fileid [fileid2...]] |
| | |
| | + + |
| | |jobid | |
| | CAncel |ACTIVE| |
| | |ALL | |
| | |QUEUE | |
| | + + |
| | |
| | + + |
| | |All | |
| | |Current | |
| | Query |Job jobid | |
| | |User userid | *| |
| | |System | |
| | + + |
| | |
| | CHange [jobid] |
| | |
| | + + |
| | Hold |jobid| |
| | Release |ALL | |
| | + + |
| | |
| | Options: |
| | |
| | + + + + + + |
| | |Clear | |Long | |Msgcount n | |
| | |NOClear| |Short| | 100| |
| | + + + + + + |
+--------------------------------------------------------------------+
Section 2: Command Descriptions 29
CMS Reference
BATCH
Functions
CAncel cancels the specified jobs, before or during execution.
CHange permits you to change the parameters (/SET, etc.) of a job
which has already been submitted but has not yet begun
execution. Changes are made interactively; the BATCH
command will prompt you for required information.
Hold places the specified jobs on hold. CMS Batch will not
schedule held jobs for execution.
macroname executes the specified batch macro. The filetype must be
"BATCH." CMS Batch macros may contain EXEC 2 statements,
BATCH command functions, batch jobs, and CMS commands. Each
line in the file is treated as a command until a line
containing /JOB is encountered, indicating the start of a
batch job. Additional commands may follow the /* at the end
of the job.
Query displays information about your CMS Batch jobs. QUERY
CURRENT, the default, displays all of your jobs currently in
the system.
Release releases the specified jobs so they can be scheduled for
execution. This will not release a job held by the
operator.
Submit initiates job preparation and submission. If no fileid is
included, BATCH assumes that you want assistance preparing a
job; otherwise, the files specified are submitted as one
batch job. If a fileids is specified BATCH will not prompt
for additional information.
The first file specified must contain all of the job control
statements for the job. Any additional files are included
as data files for use by the job. If only one fileid is
specified (which is the usual case), you need only supply a
filename, and the default filetype ("BATCH") and filemode
("*") are used. When submitting a single file you can omit
the keyword "SUBMIT."
Parameters
ACTIVE specifies that all of your active jobs will be affected by
the function.
ALL specifies that all of your jobs in the batch system will be
affected by the function.
Section 2: Command Descriptions 30
CMS Reference
BATCH
Current specifies that all of your jobs in the batch system are to
be checked.
fileid is the filename, filetype, and filemode of a CMS disk file.
The filetype and filemode are optional when only one fileid
is specified.
jobid is a job identifier. All jobs submitted to the CMS Batch
system are assigned an identifying number. (When you use
this number you need not enter any leading zeros.) You also
have the option of providing your own identifier when you
submit a job, or adding an identifier with the CHANGE
function.
Job indicates that you want a history of activity for a
specified job. This history does not include any job
parameters. Use the change function if you want to see job
characteristics.
parms are parameters that are passed to the specified macro.
QUEUE specifies that all of your jobs waiting in the queue will be
affected by the function.
System indicates that you want general information about the batch
system's activities. This includes queue lengths and
scheduling criteria.
User indicates that you want to query current status for all jobs
owned by a specified user.
userid specifies a particular userid. You may use an asterisk to
indicate your own userid.
Options
Clear causes the BATCH command to clear the terminal screen at
appropriate times. This is the default.
Long causes BATCH to use long prompts when operating in
interactive mode. This is the default.
Msgcount n
is the maximum number of messages that will be returned by a
QUERY function (not including header lines). The default is
100. MSGCOUNT 0 will suppress all QUERY responses.
Noclear inhibits the screen clearing normally done by the BATCH
command.
Section 2: Command Descriptions 31
CMS Reference
BATCH
Short causes BATCH to use short prompts when operating in
interactive mode.
Job Status Codes
The following job status codes are used by the BATCH QUERY function:
ABN Abnormal termination RST Restart in progress
ACT Active RUN Waiting in queue (hi prio)
CMP Completed normally S/U Held by user and operator
CRS System crash and RESTART=NO SKD Selected for execution
DSP Dispatched, but not started SQU Waiting in queue (chained)
JCE JCL error SYS Held by operator
NUL Null job (no commands) TPW Waiting for tape drive
MCN Cancelled by batch monitor UAB Abended by BATKILL command
NOT Not a job UCN Cancelled by user
OCN Cancelled by operator UNK Unknown
QUE Waiting in queue USR Held by user
Job Control Statement Summary
/* marks the end of the job or an in-stream (/FILE) file.
// comment
is a comment. This is allowed only in batch macros.
CHAIN jobid1 [jobid2 ... jobid8]
is used to specify a list of jobs that must successfully complete
before this job can execute.
/ERROR PRINT=destination
causes a diagnostic listing of the job control statements in the
job to be produced.
/FILE filename filetype
marks the beginning of an in-stream data file. The file will be
given the specified name. The data must be terminated with a /*
statement.
/HOLD
causes the job to be placed in USER hold. The BATCH RELEASE
command is used to release the job for execution.
/IDENT jobname
assigns a user job name. This is only required for use with job
chaining (/CHAIN).
/INCLUDE filename filetype
Section 2: Command Descriptions 32
CMS Reference
BATCH
causes the specified file to be copied to the batch server's
temporary working disk. Since your batch job has read-access to
your A-disk and D-disk, files on these disks can usually be
accessed directly. /INCLUDE is only necessary when the file
might change while the job is executing, or if the file is
modified by the job.
/JOB [userid username]
is required at the beginning of each CMS Batch job. The userid
and name are optional.
/QUERY PRINT=destination
specifies that you want a system status and history listing.
/SET CARDS=[5000|limit]
DUMP=[NO|YES]
LINES=[2000|limit]
NOTIFY=[YES|NO]
PRINT=destination[=HOLD]
PUNCH=destination[=HOLD]
RATE=[DAY|NIGHT|WEEKEND|HOLIDAY]
RESTART=[YES|NO]
| SIZE=[1|2|3]
TIME=[10|seconds]
sets job parameters. CARDS, LINES, and TIME are limits for the
job.
Usage Notes
1. A CMS batch job is executed by a special CMS userid called a
"batch server." It is logged on to execute a single job and logs
off when the job is completed. The batch server has read-access
to the files on your A-disk (and D-disk, if you have one) and
| write-access to a 500 kilobyte temporary disk. One, two, or
| three megabytes of virtual storage are provided.
2. Because of limitations in CMS disk file management, you should
not change the files on your disks that are being used by an
executing CMS Batch job. (You will receive a message from the
batch system when your job begins execution.) Since the batch
server has only read-access to your files there is no danger of
damage to the files involved, but changing a file that is being
used as input by a batch job will almost certainly cause the
| batch job to fail or produce incorrect results. (Using filemode
| number 6 can eliminate this problem in some applications.) You
| may alter or erase any of your files that are not in use by a
batch job.
3. The BATCH command operates either interactively or non-
interactively. Interactive mode is used when you do not supply a
Section 2: Command Descriptions 33
CMS Reference
BATCH
function or all required parameters on the command line. This
mode can be used to create all job control statements. When the
BATCH command is in interactive mode you can respond to any
prompt with a ? if you need more information.
4. CMS batch jobs require only two control statements: /JOB at the
beginning and /* at the end. For example:
/JOB
SCRIPT MYFILE ( PRT
/*
would process a file named "MYFILE SCRIPT" on your A-disk and
send the formatted output back to your userid in a spool file.
5. Batch macros are similar to XEDIT macros. Anything that is
allowed in an EXEC 2 file is allowed in a macro, and the BATCH
command functions (SUBMIT, QUERY, CANCEL, etc.) can all be used
as subcommands within a macro. Each causes a return code to be
set. The SUBMIT function sets the variables &SYSJOBID and
&USRJOBID. A QUERY function for a specific job sets the &JOBSTAT
variable with a job status code.
6. More information about the CMS Batch system is available in the
UKCC CMS Batch User's Guide and from the HELP command. Try HELP
BATCH MENU for more information about job control statements.
Section 2: Command Descriptions 34
CMS Reference
BATKILL
Use the BATKILL command in a CMS Batch job to terminate the job.
+--------------------------------------------------------------------+
| | |
| BATKILL | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. BATKILL is intended for use in an EXEC that is executed in a
batch job. The EXEC could check for errors or unusual conditions
and issue the BATKILL command if further processing would be
wasted. Jobs terminated with BATKILL are not considered to have
completed normally by the CMS Batch job chaining facility.
2. If used outside of a CMS Batch job, BATKILL sets a return code of
zero and has no further effect.
Section 2: Command Descriptions 35
CMS Reference
BROWSE
Use the BROWSE command to examine a CMS disk file from a 3270-type
terminal. BROWSE cannot be used to modify a file (although it can be
used to erase a file); but unlike XEDIT, it can be used to examine any
file, regardless of size.
+--------------------------------------------------------------------+
| | + + ++ |
| BRowse | filename |filetype |filemode|| [( [options...] [)]] |
| | | * | * || |
| | + + ++ |
| | |
| | Options: |
| | |
| | | [Bottom] [Noclear] [Member membername] |
| | |
| | [Help fn] [Profile [([fn [ft [fm [)]]]]]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the file to be examined.
filetype is the filetype of the file to be examined. If no filetype
is specified, the first file with the correct filename will
be used.
filemode is the filemode of the file to be examined. The default
value is "*".
Options
| Bottom causes BROWSE to initially display the last (bottom) part of
| the file. Without this option the top of the file is
| displayed initially.
Help fn specifies the name of an EXEC to be called by the HELP
subcommand. The default name is "HBROWSE".
Member membername
displays the specified member of a CMS library immediately
at entry to BROWSE.
Noclear specifies that the screen is not to be cleared by BROWSE.
Profile (fn ft fm)
specifies a file to be used as the BROWSE profile. The
default is "BROWSE $PROFILE *".
Section 2: Command Descriptions 36
CMS Reference
BROWSE
Keyboard Functions
PA1 will transfer control to CP and clear the screen. A CP READ
status will be displayed. Enter BEGIN to return to BROWSE.
PA2 will transfer control to CMS subset and clear the screen. A
VM READ or RUNNING status will be displayed. Enter RETURN
to return to BROWSE.
PFnn will execute the subcommand defined for the Program Function
key that is pressed. The PF key definitions are contained
in the BROWSE profile (see below). Use the DSPF subcommand
to display their current settings.
BROWSE Subcommands
BROWSE is a read-only editor and supports subcommands for searching,
examining, and erasing a file. The following subcommands can be
entered on the command line at the top of the display area:
n makes record "n" the top line in the current level.
= repeats the last command for this level.
?[?] displays the last command entered for this level. The
command will be executed only if you press the ENTER key.
If two question marks are entered, the second most recent
command entered for this level is displayed.
& can be used as a prefix for BROWSE subcommands to leave the
subcommand on the command line after execution; this allows
repeated execution of a command by just pressing ENTER.
Backward n
scrolls the screen window backwards (toward the top of the
file) "n" screens. The default is one screen.
BOttom displays the last screen of a file or CMS library member.
| BURN erases the current file and ends the current level.
Case x controls translation of character strings used with the
locate (/) subcommand. Specify "U" (for uppercase) to
ignore case during comparisons, or "M" (for mixed case) if
case is significant. The default is "U".
| CP ... executes a specified CP command.
DIct displays the names of the members in a CMS library.
| DISCARD erases the current file and ends the current level.
Section 2: Command Descriptions 37
CMS Reference
BROWSE
Down n moves the screen window down (toward the end of the file)
"n" lines. The default is one line.
DSpf displays the current settings of the PF keys.
Enter [fn|* [ft|* [fm|*]]]
creates a new BROWSE level within the current file or a
split-screen display of a file not currently displayed. The
screen will be split the first time a new level is created.
Forward n scrolls the screen window forward (toward the end of the
file) "n" screens. The default is one screen.
| LAst is a synonym for BOTTOM.
Left n scrolls the screen window "n" columns to the left. The
default is the width of the screen.
Member [membername]
displays a member within a CMS library. If "membername" is
unspecified, the last selected member is redisplayed. If a
member is found, member-select mode is entered and the
member name is displayed after the filename in the level
header. Scroll and locate subcommands will be applied to
the selected member only. Use the DICT or QUIT subcommands
or the PF key function END to leave member-select mode. If
member-select mode was entered through the MEMBER
subcommand, the PF key function END and the QUIT subcommand
will display the dictionary. If entered through the MEMBER
option, the level is terminated.
Next n is a synonym for DOWN.
QQuit is a synonym for QUIT.
Quit ends the current level (or displays the dictionary if
member-select mode was entered with a MEMBER subcommand).
Right n scrolls the screen window "n" columns to the right. The
default is the width of the screen.
Set [Hex On|OFf|Char] [Numbers On|OFf]
controls the display of line numbers and the screen data
format. HEX ON displays data in hexadecimal. HEX CHAR
displays data in both hexadecimal and character forms. The
initial settings are HEX OFF and NUMBERS OFF. If no
parameters are specified, the current settings are
displayed.
Top displays the first screen of a file or CMS library member.
Section 2: Command Descriptions 38
CMS Reference
BROWSE
Up n moves the screen window up (toward the top of the file) "n"
lines. The default is one line.
View n displays the specified column of the input records in column
one of the screen. If no parameter is specified, the
current column setting is displayed.
/string[/n [m]]
(Locate) searches for "string" in the current level and, if
found, makes the located line the top line for the level.
If CASE U (the default) is in effect, the case of the
letters in the string and in the data is ignored. Column
boundaries for the search may be specified with the "n" and
"m" arguments. Note that the closing delimiter is only
required if boundaries are given.
The BROWSE Profile
A search is made at initialization for the BROWSE profile. The
profile is a CMS file named "BROWSE $PROFILE *" (or a specified
substitute) that is used to set PF key functions and specify special
options. The profile may contain either variable or fixed-length
records up to 132 bytes long. After processing the profile, any lines
in the CMS stack are processed as if they were also profile records.
The profile may contain the following types of records:
*OPTION options
The only option is "EXITCLR." This causes BROWSE to clear
the screen before terminating, which is useful if BROWSE is
invoked from another environment that uses full-screen support.
*PFKEYS nn function
Define Program Function key "nn" as "function." The
following functions can be used here (those marked with an
asterisk can be used only from PF keys):
Name Description
BOT Display the last page of a file or member.
*BRN Erase the file and end the level.
*CAN Cancel all levels.
*CCL Make the line indicated by the cursor the top line.
*DSPC Display cursor position (record number and column).
*END End level containing the cursor.
*RPTF Repeat the last locate function.
*SCB Scroll backward (toward top of file).
*SCF Scroll forward (toward end of file).
*SCL Scroll left the screen width.
*SCR Scroll right the screen width.
*SPL Move the split to the line indicated by the cursor.
TOP Display first page of a file or member.
Section 2: Command Descriptions 39
CMS Reference
BROWSE
Usage Note
Characters that cannot be displayed on a 3270-type display screen are
represented by dots. Use SET HEX CHAR or SET HEX ON to determine the
actual character in such a case.
Messages and Return Codes
BROWSE does not issue error messages, but can generate the following
return codes:
1 Console not a 3270-type terminal.
2 Insufficient free storage available.
28 File not found.
1xxx Error xxx reading input file (see CMSDIO command
for meaning of "xxx").
Section 2: Command Descriptions 40
CMS Reference
BURN (EXEC)
Use the BURN command to erase a CMS disk file or purge a reader spool
file.
+--------------------------------------------------------------------+
| | + + |
| BURN | |filename filetype [filemode]| |
| | |spoolid | |
| | + + |
+--------------------------------------------------------------------+
where
filename is the filename of a file to be erased.
filetype is the filetype of the file.
filemode is the filemode of the file. The default filemode is "A."
spoolid is the spool file number of a reader file to be purged.
Usage Notes
1. BURN can be issued from virtually any environment under CMS.
BURN is accepted by XEDIT, FLIST, PEEK, FILELIST, RLIST, BROWSE,
and RBROWSE. If the file identifier is not specified when
issuing BURN as a subcommand from one of these environments, the
current file is erased or purged, and the editors will also QUIT.
2. When purging a reader spool file in NETDATA format (used by the
NOTE and SENDFILE commands), BURN will issue an acknowledgment if
one was requested by the originating user.
3. BURN supports all of the options of the ERASE command. Refer to
the VM/SP CMS Command and Macro Reference or online Help for
details on other features of the ERASE command.
Messages and Return Codes
DMSBRN001E No file specified. RC=24
DMSBRN920E Reader file [n] could not be found. RC=28
Messages may also be produced by the ERASE, PURGE, and RECEIVE
commands.
Section 2: Command Descriptions 41
CMS Reference
CALC
The CALC command provides desk calculator functions by placing you in
calculator mode, allowing assignment statements and CALC subcommands
to be processed. Use the QUIT subcommand to leave calculator mode.
+--------------------------------------------------------------------+
| | |
| CALC | |
| | |
+--------------------------------------------------------------------+
CALC Subcommands
var = expression
is the CALC assignment statement. CALC variables are
identified by single letters. The syntax of the expression
is like that used by the FORTRAN and BASIC programming
languages, accepting arithmetic operators (+, *, etc.) and
functions (LOG, SIN, SQRT, etc.).
Clear var ...
sets one or more variables to zero. All 26 variables (A
through Z) are initially set to zero.
Display causes the result of each assignment statement to be
displayed. This is the initial setting.
Integer var ...
makes one or more variables integers and sets them to zero.
Variables I through N are initially integers.
Nodisplay suppresses the display of the result of assignments.
Perform filename
reads and executes commands from a CMS disk file. The
filetype of the file must be "CALC" and all subcommands in
the file must be in uppercase. The PERFORM subcommand
cannot be executed from a file.
Quit ends CALC.
Real var ...
makes one or more variables real (floating point) and sets
them to zero. Variables A through H and O through Z are
initially real.
Type var ...
displays the current value of one or more variables.
Section 2: Command Descriptions 42
CMS Reference
CALC
Usage Notes
1. CALC uses a question mark to prompt for commands.
2. The following example illustrates how CALC could be used to make
a few simple calculations. Commands from the user are in
lowercase; responses from CALC and CMS are in uppercase.
calc
?
r=10.75*40
R=430.0
?
f=r*.067
F=28.810
?
s=r*52
S=22360.0
?
quit
R; $0.01 15:22:44
Messages and Return Codes
CALC produces warning messages when it detects errors, but doesn't
terminate until the QUIT subcommand is issued. CALC always sets a
return code of zero.
Section 2: Command Descriptions 43
CMS Reference
CANCEL
Use the CANCEL command to cancel OS batch jobs and HASP printed output
submitted from your userid.
+--------------------------------------------------------------------+
| | |
| CANCEL | jobnumber |
| | |
+--------------------------------------------------------------------+
where
jobnumber is the job number of the OS batch job or HASP print job to
be canceled. The job number is the last three digits of the
runid, but must be entered without leading zeroes.
Usage Note
If the specified job or output is found and was submitted from your
userid, the job will be canceled and a message will be sent confirming
that the CANCEL command was accepted. Only the current job activity
is canceled when you issue CANCEL. For example, if your job was
executing or waiting for execution, some printed output will still be
produced. A second CANCEL will delete the printed output in such a
case.
Messages and Return Codes
DMSCAN070E "[name]" is not a parameter. RC=24
DMSCAN923E A job number was not specified. RC=24
DMSCAN930E [batch] is not available. RC=101
| DMSCAN943E Error "[code]" from VMCF [function]. RC=100
Responses may also be sent by HASP and the OS batch system.
Section 2: Command Descriptions 44
CMS Reference
CASE
Use the CASE command to force all CMS terminal output to uppercase or
lowercase. This is valuable if your terminal cannot display lowercase
characters or displays special symbols in place of lowercase
characters.
+--------------------------------------------------------------------+
| | + + |
| CASE | |Mixedcase| |
| | |Uppercase| |
| | |Lowercase| |
| | + + |
+--------------------------------------------------------------------+
where
Mixedcase allows CMS terminal output to be produced in mixed case.
This is the initial condition and the default parameter.
Uppercase forces all CMS terminal output to be produced in uppercase.
All lowercase alphabetic characters are translated to
uppercase.
Lowercase forces all CMS terminal output to be produced in lowercase.
All uppercase alphabetic characters are translated to
lowercase.
Usage Notes
1. The CASE setting affects all CMS terminal output, including
output from SCRIPT and XEDIT. Terminal output from CP commands
and the text of messages from other users are not affected,
however.
2. The CASE command has no effect on terminal input.
3. The CASE command and the CMS SET OUTPUT command alter the same
output translation table. Issuing one can change or override the
other.
Messages and Return Codes
DMSCAS070E "[name]" is not a parameter. RC=24
DMSCAS109S Insufficient storage available to create the output
table. RC=41
Section 2: Command Descriptions 45
CMS Reference
| CC (CMS Immediate Command)
Use the CC (Current command Cost) to display the cost and resources
used by the currently executing CMS command or program.
+--------------------------------------------------------------------+
| | |
| CC | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. CC displays the cost, CPU time, and I/O count used since the
currently executing command or program started. The output is
displayed with the CP MESSAGE command, so it is suppressed by the
CP SET MSG OFF command.
2. CMS immediate commands are accepted only from the terminal. They
cannot be issued from an EXEC.
3. The SET IMMEDIATE command can be used to disable CMS immediate
commands. QUERY IMMEDIATE to determine the current setting. The
initial setting is SET IMMEDIATE ON.
Section 2: Command Descriptions 46
CMS Reference
CHECKBUF
Use the CHECKBUF command to determine the number of lines in the
current CMS program stack buffer. The return code is set to the
number of lines. Use the SENTRIES command to determine the total
number of lines in all the program stack buffers.
+--------------------------------------------------------------------+
| | |
| CHECKBUF | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. Program stack buffers can be created with the MAKEBUF command and
destroyed with the DROPBUF command. Lines entered from your
terminal are not placed in the program stack.
2. If there are no program stack buffers the return code is zero.
| 3. When CHECKBUF is executed in an EXEC with an &ERROR or SIGNAL ON
| ERROR trap in effect the error action is performed if the current
program stack buffer contains one or more lines.
Messages and Return Codes
CHECKBUF produces no messages. The return code is set to the number
of lines in the current CMS program stack buffer.
Section 2: Command Descriptions 47
CMS Reference
CJSPREP
Use the CJSPREP command to convert a file in SUBMIT command INCLUDE V
format to its original format.
+--------------------------------------------------------------------+
| | |
| CJSPREP | ifileid ofileid [(options... [)]] |
| | |
| | Options: |
| | |
| | [REPlace] [Counts] |
| | |
+--------------------------------------------------------------------+
where
ifileid is the fileid of the input file.
ofileid is the fileid of the output file.
Options
REPlace allows an existing file to be replaced.
Counts specifies that a count of the input and output records is to
be displayed at the completion of the command.
Usage Notes
The input file must contain fixed-length, eighty-byte records in the
format produced by the SUBMIT command INCLUDE-V function. The output
file will always contain variable-length records.
Messages and Return Codes
DMSPRP001E No filename specified. RC=24
DMSPRP002E File not found. RC=28
DMSPRP003E "[string]" is not an option. RC=24
DMSPRP007E File "[fn ft fm]" does not contain fixed, 80-byte records.
RC=32
DMSPRP023E No filetype specified. RC=24
DMSPRP024E File "[fn ft fm]" already exists; specify "REPLACE". RC=28
DMSPRP056E Record [n] in file "[fn ft fm]" is not valid. RC=32
DMSPRP062E Invalid "*" in fileid. RC=20
DMSPRP070E "[string]" is not a parameter. RC=24
DMSPRP104S Error "[code]" reading file "[fn ft fm]" from disk. RC=100
DMSPRP105S Error "[code]" writing file "[fn ft fm]" from disk. RC=100
DMSPRP932I [count] records read, [count] records written.
Section 2: Command Descriptions 48
CMS Reference
CLEAR
Use the CLEAR command to clear the screen of a display terminal.
+--------------------------------------------------------------------+
| | |
| CLEAR | |
| | |
+--------------------------------------------------------------------+
Usage Notes
The CLEAR command is functional on all 3270-type terminals, 3066
terminals, and ASCII terminals that will clear their screens when a
Form Feed control character is received. Some printing ASCII
terminals will eject a page when a Form Feed is received.
Messages and Return Codes
CLEAR produces no messages or non-zero return codes.
Section 2: Command Descriptions 49
CMS Reference
CMSCMSG
Use the CMSCMSG command to write a message in the command area of a
3270-type display terminal. CMSCMSG performs no function on any other
type of terminal.
+--------------------------------------------------------------------+
| | |
| CMSCMSG | [text...] |
| | |
+--------------------------------------------------------------------+
where
| text is one or more words of data to be written. When called
| from EXEC (not REXX or EXEC 2), the text will be tokenized
| and the eight-character tokens concatenated. The text will
be truncated to a length of 130 characters. If no text is
specified, a blank line is written.
Usage Notes
The text is written into the command (input) area at the bottom of the
display screen. This text may then be entered as a command. The user
may modify the text before pressing ENTER.
Messages and Return Codes
CMSCMSG produces no error messages or non-zero return codes.
Section 2: Command Descriptions 50
CMS Reference
CMSDIO
| Use the CMSDIO command to perform CMS disk file operations from an
| EXEC. The EXECIO command provides most of the functions of CMSDIO.
+--------------------------------------------------------------------+
| | + + + + + + ++++ |
| CMSDIO | |Read | fn ft |fm |line |format |size|||| [([data...]]|
| | |Write | |A1 |0 |V | |||| |
| | |Point | + + + + ++++ |
| | |RPoint| |
| | |WPoint| |
| | |Close | |
| | |TRunc | |
| | + + |
+--------------------------------------------------------------------+
where
Read reads a line from the file and puts it in the stack.
Write writes a line into the file.
Point sets the read and write pointers to the specified line.
RPoint sets the read pointer to the specified line.
WPoint sets the write pointer to the specified line.
Close closes the file.
TRunc truncates the file at the specified line. All lines from
the line specified to the end of the file are deleted.
Truncating at line 1 erases the file. The TRUNC function
cannot be used if the file is on an 800-byte block format
minidisk.
fn is the filename of the file to be accessed.
ft is the filetype of the file to be accessed.
fm is the filemode of the file to be accessed. If unspecified,
"A1" is assumed.
line is a line number in the file. The lines are numbered from 1
to n for a file with n lines. An item number of 0 causes
the next sequential line to be read or written. Reading
begins with line 1 unless a POINT or RPOINT has selected
another line. For a new file, an item number of zero causes
line 1 to be written. For existing files, the line is
written after the last existing line or after the last line
Section 2: Command Descriptions 51
CMS Reference
CMSDIO
selected with a POINT or WPOINT function. Subsequent writes
using line 0 cause lines to be read or written sequentially
until a CLOSE, POINT, or WPOINT is issued. The default line
number is 0.
format is the record format of the file. It may be either "F" for
fixed-length or "V" for variable-length. "V" is assumed for
new files. The actual format is always used for existing
files.
size is the length of the line. If unspecified, the default
value is the actual data length for variable-length records.
The default for fixed-length records is the actual record
| length of the file for existing files, or 255 for new files.
| The maximum value is 255.
data represents data to be written to the file (used only with
the WRITE function). A blank line is written if the
parenthesis is present with no data. If the parenthesis is
not present the data is read from the stack. Data items on
| the command line are tokenized if CMSDIO is called from EXEC
| (but not REXX or EXEC 2).
Usage Notes
1. Rewriting a variable-length record with a longer line causes any
following lines in the file to be discarded.
2. Data may be lost if a file is not closed after new lines have
been written.
| 3. Lines read by CMSDIO are truncated to 255 bytes. Lines lines
| written are limited by the command line (130 bytes) or stack
| width (about 500 bytes).
4. If an I/O error is encountered a special return code will be
produced without a message. The return codes and their meanings
are:
1001 File not found
1002 Invalid buffer address
1003 Permanent I/O error
1004 First character of filemode is invalid
1005 Number of lines to be read is less than or equal to
zero, or is greater than 32,768 for an 800-byte block
format disk, or filemode number is invalid (WRITE)
1006 File not open (CLOSE), or line number too large
1007 Invalid record format (READ), or attempt to skip
unwritten V-format item (WRITE)
1008 Incorrect length or buffer size not specified
1009 Read from a file open for output or write to a file open
Section 2: Command Descriptions 52
CMS Reference
CMSDIO
for input on an 800-byte block formatted disk
1010 Maximum number of files reached
1011 Number of lines greater than one for a V-format file
(READ), or record format not F or V (WRITE)
1012 End of file, or line number greater than number of
lines in file
1013 V-format line has an invalid displacement in active
file table (READ), or disk full (WRITE)
1014 Invalid character in filename, or number of bytes to be
written not integrally divisible by the number of
lines to be written
1015 Invalid character in filetype, or length of F-format
item not the same as the previous item (WRITE)
1016 Record format specified does not match that of the file
1019 Maximum number of data blocks reached
1020 Invalid character in fileid
1021 Invalid character in filetype
1022 Virtual storage capacity exceeded
1024 Invalid filemode
1025 Insufficient free storage available for file
management control areas
1026 Requested item number is negative or exceeds file
system capacity
1036 Disk not accessed, or access is read-only (WRITE)
1040 Error closing file
1044 File system pointers invalid
1050 Not an EDF disk
Messages and Return Codes
DMSDIO001E No filename specified. RC=24
DMSDIO023E No filetype specified. RC=24
DMSDIO047E No function specified. RC=24
DMSDIO048E Invalid mode "[mode]". RC=24
DMSDIO070E "[string]" is not a parameter. RC=24
Refer to the Usage Notes for a description of the special I/O error
return codes.
Section 2: Command Descriptions 53
CMS Reference
CMSPMSG
Use the CMSPMSG command to write a prompt message on the terminal. On
terminals other than 3270-type displays the cursor or carriage will
remain on the space following the message text.
+--------------------------------------------------------------------+
| | |
| CMSPMSG | [text...] |
| | |
+--------------------------------------------------------------------+
where
| text is the text of the message. The text is truncated to a
| length of 130 characters. When called from an EXEC (but not
| REXX or EXEC 2) the text is tokenized.
Messages and Return Codes
CMSPMSG produces no error messages or non-zero return codes.
Section 2: Command Descriptions 54
CMS Reference
CMSREAD
Use the CMSREAD command to read a line from the terminal or stack and
place the data in the stack. The input may be masked.
+--------------------------------------------------------------------+
| | |
| CMSREAD | [Mask] |
| | |
+--------------------------------------------------------------------+
where
Mask specifies that the input is to be masked. On 3270-type
terminals the entire input line is set to non-display mode.
On other types of terminals the first eight characters of
the line will be concealed by overstriking with a mask
string.
Usage Notes
1. The input is limited to 130 characters from the terminal or 255
characters from the program stack. Lines read from the terminal
are not translated to uppercase (when using EXEC 2, &CASE M will
be needed to prevent translation to uppercase), but any CMS SET
INPUT translations will be performed. Lines read from the
terminal are also subject to logical editing under the control of
the CP TERMINAL and SET LINEDIT commands.
2. Lines entered when the MASK parameter is used will not be
recorded on your console log and cannot be recalled or displayed
with either the CP PF key function RETRIEVE or the CMS ?
function.
3. You should not use a CMSREAD MASK command immediately following a
CMSPMSG command unless you are using a 3270-type terminal. On
other kinds of terminals, the mask will overstrike part of the
message.
Messages and Return Codes
DMSCRD070E "[string]" is not a parameter. RC=24
Section 2: Command Descriptions 55
CMS Reference
CMSTIO
Use the CMSTIO command to determine if a virtual device exists.
+--------------------------------------------------------------------+
| | |
| CMSTIO | [address] |
| | |
+--------------------------------------------------------------------+
where
address is the virtual device address of the device to be tested.
If omitted, the terminal will be tested. The virtual
address is specified as a hexadecimal value.
Messages and Return Codes
CMSTIO produces no messages. It uses the following return codes:
0 Device exists
1 Invalid parameter
3 Device doesn't exist
Section 2: Command Descriptions 56
CMS Reference
COBDC (EXEC)
Use the COBDC command to compile a program with the IBM VS COBOL
compiler using the TEST option. The program then can be executed
using COBOL Interactive Debug.
+--------------------------------------------------------------------+
| | |
| COBDC | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the COBOL
source program. The filetype of the file must be "COBOL,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are COBOL compiler options.
Usage Notes
1. The filename of the COBOL file should be the same as the name on
the PROGRAM-ID line in the program.
2. COBDC is an EXEC that uses the COBOL command to compile a COBOL
program. The object program produced can be executed with the
COBDG or COBVG command. Refer to the descriptions of the COBOL
and TESTCOB commands for more information.
Section 2: Command Descriptions 57
CMS Reference
COBDCG (EXEC)
Use the COBDCG command to compile a program using the IBM VS COBOL
compiler and then execute the program with COBOL Interactive Debug.
+--------------------------------------------------------------------+
| | |
| COBDCG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the COBOL
source program. The filetype of the file must be "COBOL,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are COBOL options. The TEST option is supplied.
Usage Notes
1. The filename of the COBOL file must be the same as the name on
the PROGRAM-ID line in the program.
2. You must define any DD names that you use before issuing the
COBDCG command. For example:
FILEDEF SYSPRINT TERMINAL ( PERM
FILEDEF SYSOUT TERMINAL ( PERM
FILEDEF DATAFILE DISK DATA FILE A (PERM
COBDCG program
3. COBDCG is an EXEC that uses the COBOL command to compile a COBOL
program. The object program produced is then executed using
COBOL Interactive Debug. Refer to the descriptions of the COBOL
and TESTCOB commands for more information.
Section 2: Command Descriptions 58
CMS Reference
COBDG (EXEC)
Use the COBDG command to execute a program using COBOL Interactive
DEBUG. The program must have been compiled with the IBM VS COBOL
compiler with the TEST option.
+--------------------------------------------------------------------+
| | |
| COBDG | filename |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the COBOL
object program produced by the VS COBOL compiler. The
filetype of the file must be "TEXT."
Usage Notes
1. The filename of the TEXT file must be the same as the name on the
PROGRAM-ID line in the source program.
2. You must define any DD names that you use before issuing the
COBDG command. For example:
FILEDEF SYSPRINT TERMINAL ( PERM
FILEDEF SYSOUT TERMINAL ( PERM
FILEDEF DATAFILE DISK DATA FILE A (PERM
COBDG program
3. Refer to the descriptions of the COBOL and TESTCOB commands for
more information.
Section 2: Command Descriptions 59
CMS Reference
COBOL
Use the COBOL command to compile a program with the IBM VS COBOL
compiler. The COBVCG, COBVC, COBVG, COBDCG, COBDC, and COBDG commands
are available for use with VS COBOL programs.
+--------------------------------------------------------------------+
| | |
| CObol | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the COBOL
source program. The filetype of the file must be "COBOL,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
Options
ACEn is the same as SPACEn.
ADV specifies that records for files with WRITE...ADVANCING need
not reserve the first byte for the control character. This
is the default.
APOst specifies that apostrophes are used to delimit literals.
The default is QUOTE.
BATch specifies that the source file contains multiple programs or
subprograms. The default is NOBATCH.
BUF n is the amount of storage used for buffers during
compilation. The default is (SIZE-96K)/4+4K if SIZE is
specified, 4K otherwise.
CDEck causes COPY statements to be expanded in the reformatted
deck produced with the FDECK option. The default is
NOCDECK.
CLIst produces a condensed listing of the generated object code.
The default is NOCLIST.
CNT n is the same as LINECNT.
COUnt causes code to be generated to produce verb execution
summaries at the end of program execution. This output is
directed to SYSCOUNT. The default is NOCOUNT.
Section 2: Command Descriptions 60
CMS Reference
COBOL
CSYNtax suppresses object code generation if E-level or higher
messages are produced during compilation. The default is
NOCSYNTAX, which allows compilation to complete with errors.
DECk sends the object program to the spooled punch. The default
is NODECK.
DIsk writes the program listing to a disk file named "filename
LISTING." This is the default.
DMAp lists the glossary, global tables, literal pools, and
register assignments. NODMAP is the default.
DUMp causes an abnormal termination when a disaster situation
occurs. NODUMP is the default.
DYNam causes subprograms to be dynamically loaded when called,
rather than statically loaded when the main program is
loaded. NODYNAM is the default.
ENDjob causes clean-up to be done when a GOBACK is executed in a
main program, or when a STOP RUN is executed in any program.
NOENDJOB is the default.
FDEck sends a reformatted listing to SYSPUNCH. FDECK is used with
the LSTONLY or LSTCOMP options. NOFDECK is the default.
FLAGE suppresses compiler warning messages. FLAGW is the default.
FLAGW allows all compiler warning and error messages to be listed.
This is the default.
FLOw n causes a formatted trace of "n" procedures to be listed if
an abnormal termination occurs. NOFLOW is the default.
LAG is the same as FLAGE.
LAGW is the same as FLAGW.
LANGLVL n specifies the COBOL dialect used by the compiler. LANGLVL 2
(the default) is ANS X3.23-1974; LANGLVL 1 is the older ANS
X3.23-1968 standard. Both dialects include IBM extensions.
LCOLn controls the reformatted Procedure Division listing. LCOL1
causes single-column output; LCOL2 causes double-column
output. LCOL2 is the default.
LIB allows COPY and BASIS statements to be used. NOLIB is the
default.
Section 2: Command Descriptions 61
CMS Reference
COBOL
LINECNT n is the number of lines on each page of compiler listing
output (ranging from 1 to 99). The default is LINECNT 60.
LOAd writes the object program to a disk file named "filename
TEXT." This is the default.
LSTComp causes the lister to be used and the source program to be
compiled. NOLST is the default.
LSTOnly causes the lister to be used, but the program is not
compiled. NOLST is the default.
LVLx specifies how deviations from ANS COBOL are to be flagged.
FIPS levels A, B, C, or D may be specified. NOLVL is the
default.
L120 specifies that the reformatted listing will have 120
characters per line.
L132 specifies that the reformatted listing will have 132
characters per line. This is the default.
NAMe causes NAME records to be included in the generated TEXT
file. NONAME is the default.
NOADV See the ADV option.
NOLOAd See the LOAD option.
NOPRInt suppresses listing output. See the DISK and PRINT options.
NOSEQ See the SEQ option.
NOSOUrce See the SOURCE option.
NOTERm See the TERM option.
NOVERB See the VERB option.
NOZWB See the ZWB option.
NUM causes line numbers on the input records to be used. NONUM
is the default.
OLn is the same as LCOLn.
OPTimize causes optimized code to be generated. OPTIMIZE is implied
by the SYMDMP option. NOOPT is the default.
OSDeck specifies that the object program will be executed under OS,
or is a subprogram for OS or CMS.
Section 2: Command Descriptions 62
CMS Reference
COBOL
PMAp lists the global tables, literal pools, register
assignments, and assembler language expansion of the source
program. NOPMAP is the default.
PRInt sends the compiler listing to the spooled printer. DISK is
the default.
QUOte specifies that double quotes will be used to delimit
literals. This is the default.
RESident causes the COBOL Library Management feature to dynamically
load at execution time. NORES is the default.
SEQ causes the compiler to check the sequence of the source
statements. This is the default.
SIZE n indicates the amount of storage available to the compiler
(from 128K to 9999999). The default is 128K. See also the
BUF option.
SOUrce produces a source listing. This is the default.
SPACEn specifies single, double, or triple spacing in the source
listing. The default is SPACE1 (single spacing).
STAte causes the statement number and verb executing at the time
of an abnormal failure to be listed. NOSTATE is the
default.
SUPmap suppresses object listing and generation if an E-level or D-
level message is produced. NOSUPMAP is the default.
SXRef produces a sorted cross-reference listing. NOSXREF is the
default.
SYMdmp causes a formatted dump of the data area to be produced if
the program terminates abnormally. SYMDMP implies the
OPTIMIZE option. NOSYMDMP is the default.
SYNtax causes the syntax of the source program to be checked, but
not compiled. NOSYNTAX, the default, specifies syntax
checking and compilation.
SYSx causes SYSOUx to be used for debugging and DISPLAY output.
The default is SYST, which causes SYSOUT to be used. An
appropriate FILEDEF must be issued before execution for
names other than SYSOUT.
TERm displays compiler statistics and messages at the terminal.
This is the default.
Section 2: Command Descriptions 63
CMS Reference
COBOL
TEST is used with COBOL Interactive Debug (TESTCOB). NOTEST is
the default.
TRUnc causes computational (binary) items to use the PICTURE
clause specification when moved. NOTRUNC is the default.
VBRef produces a cross-reference of verbs. NOVBREF is the
default.
VBSum produces a summary of the verbs used in the program.
NOVBSUM is the default.
VERB includes the names of procedures and verbs in the object
program listing. This option is significant only if CLIST
or PMAP is specified.
XREf produces an unsorted cross-reference. The default is
NOXREF.
ZWB causes the compiler to generate code to strip the sign from
a signed external decimal field when it is compared to an
alphanumeric field. This is the default.
Usage Notes
1. More information about VS COBOL can be found in the IBM VM/370
CMS User's Guide for COBOL. The VS COBOL compiler and language
are documented in IBM VS COBOL for OS/VS and the IBM OS/VS COBOL
Compiler and Library Programmer's Guide. COBOL Interactive Debug
is described in IBM OS COBOL Interactive Debug Terminal User's
Guide and Reference.
2. If you use COPY statements in your COBOL program, you must define
the libraries to be searched before you issue the COBOL command.
Members to be copied may be in CMS MACLIB's or OS partitioned
data sets (or both). To use a CMS MACLIB, use the following
commands:
GLOBAL MACLIB libname
FILEDEF SYSLIB DISK libname MACLIB *
To use an OS PDS, issue the following commands:
OSDISK
FILEDEF SYSLIB DISK SYSLIB MACLIB * DSN data.set.name
GLOBAL MACLIB SYSLIB
COBOL filename
Refer to the description of the GLOBAL and MACLIB commands for
more information.
Section 2: Command Descriptions 64
CMS Reference
COBOL
3. Before loading your COBOL program, you must define any subroutine
libraries required (including the VS COBOL libraries). For
example:
GLOBAL TXTLIB PTF8LIB COBOLVS
LOAD filename ( START
If your program performs any input or output operations you must
use FILEDEF commands to define the files or devices to be used
before execution.
Section 2: Command Descriptions 65
CMS Reference
COBVC (EXEC)
Use the COBVC command to compile a program with the IBM VS COBOL
compiler.
+--------------------------------------------------------------------+
| | |
| COBVC | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the COBOL
source program. The filetype of the file must be "COBOL,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are COBOL compiler options.
Usage Note
COBVC is an EXEC that uses the COBOL command to compile a COBOL
program. The object program produced can be executed with the COBVG
command. Refer to the description of the COBOL command for more
information.
Section 2: Command Descriptions 66
CMS Reference
COBVCG (EXEC)
Use the COBVCG command to compile and execute a program using the IBM
VS COBOL compiler.
+--------------------------------------------------------------------+
| | |
| COBVCG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the COBOL
source program. The filetype of the file must be "COBOL,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are COBOL compiler options.
Usage Notes
1. The default VS COBOL subroutine libraries are used: PTF8LIB and
COBLIBVS. If you need to use additional libraries or load
additional object files you must use the COBVG command to execute
your program.
2. COBVCG is an EXEC that uses the COBOL command to compile a COBOL
program. The object program produced is then executed. Refer to
the description of the COBOL command for more information.
Section 2: Command Descriptions 67
CMS Reference
COBVG (EXEC)
Use the COBVG command to execute a program previously compiled with
the IBM VS COBOL compiler.
+--------------------------------------------------------------------+
| | |
| COBVG | filename [filename...] [( [libraries] [> parms] ] |
| | |
+--------------------------------------------------------------------+
where
filename are the filenames of the CMS disks file containing the VS
COBOL (or VS COBOL compatible) object programs. The
filetypes of the files must be "TEXT."
libraries are the names of subroutine libraries (TXTLIB's). Any
libraries specified here are searched before the default
libraries: PTF8LIB and COBLIBVS.
parms are command line parameters for the executed program.
Usage Note
Refer to the descriptions of the COBVC and COBOL commands for more
information.
Section 2: Command Descriptions 68
CMS Reference
CODETRAN
Use the CODETRAN command to perform character code and case
conversions on CMS disk files.
+--------------------------------------------------------------------+
| | |
| CODETRAN | ifileid [ofileid] [( options ... [)]] |
| | |
| | Options: |
| | |
| | + + + + |
| | |ATOE | |NEWFile| |
| | |ETOA | |REPlace| |
| | |LOwcase| + + |
| | |UPcase | |
| | |USer fn| |
| | + + |
+--------------------------------------------------------------------+
where
ifileid is the file identifier (filename, filetype, and filemode) of
the input file. The filemode may be specified as "*," or
may be omitted if the output file identifier is not
specified. The default is "*."
ofileid is the file identifier (filename, filetype, and filemode) of
the output file. An equal sign (=) may be coded for any of
the output file identifier fields. If unspecified, the
default is "= = =," which causes the input file to be
replaced.
Options
ATOE converts from ASCII to EBCDIC.
ETOA converts from EBCDIC to ASCII.
LOwcase converts EBCDIC uppercase to EBCDIC lowercase.
NEWFile specifies that the output file must not exist prior to the
execution of the command. This is the default unless the
output file is the same as the input file.
REPlace causes the output file to be replaced if it already exists.
This is the default if the output file is the same as the
input file.
UPcase converts EBCDIC lowercase to EBCDIC uppercase.
Section 2: Command Descriptions 69
CMS Reference
CODETRAN
USer fn causes translation to use a table in the specified CMS disk
file. The filetype of the file must be "CODETRAN" and the
file must contain at least 16 records of 32 characters. A
translation table consists of 256 hexadecimal values (00
through FF).
Usage Notes
1. A few characters do not translate properly when going back and
forth between ASCII and EBCDIC. Refer to the Appendix on
character sets for more information.
2. The following files are available as guides for making your own
translation tables:
ATOE CODETRAN Y2 (ASCII to EBCDIC)
ETOA CODETRAN Y2 (EBCDIC to ASCII)
LOWCASE CODETRAN Y2 (EBCDIC lowercase to EBCDIC uppercase)
UPCASE CODETRAN Y2 (EBCDIC uppercase to EBCDIC lowercase)
NONE CODETRAN Y2 (Each character to itself, no change)
3. With an appropriate pair of translation tables, CODETRAN could be
used as part of a simple substitution-type cipher system.
Messages and Return Codes
DMSCOD002E Input file "file" not found. RC=28
DMSCOD003E "string" is not an option. RC=24
DMSCOD007E Insufficient storage to initialize i/o buffer. RC=28
DMSCOD024E File "file" already exists, specify "replace". RC=28
DMSCOD042E No fileid(s) specified. RC=24
DMSCOD044E Record length incorrect in "file". RC=32
DMSCOD048E Invalid mode "mode". RC=24
DMSCOD054E Incomplete fileid. RC=24
DMSCOD062E Invalid "*" in fileid. RC=20
DMSCOD062E Invalid character in fileid "file". RC=20
DMSCOD069E Disk mode "mode" not accessed. RC=36
DMSCOD070E "string" is not a parameter. RC=24
DMSCOD104S Error n reading file "file". RC=100
DMSCOD105S Error n writing file "file". RC=100
DMSCOD106E Output disk not accessed r/w. RC=100
DMSCOD930E Invalid character in user translate record. RC=4
DMSCOD931E Multiple translate options specified. RC=4
DMSCOD932E No translate option specified. RC=12
Section 2: Command Descriptions 70
CMS Reference
COPYFILE
Use the COPYFILE command to make a copy of a CMS disk file. Use the
FCOPY command to copy one or more files if the only options required
are TYPE or OLDDATE. FCOPY is as much as ten times faster (and
cheaper) than COPYFILE. This is a summary of the most frequently
needed options and functions of the COPYFILE command, not a complete
description.
+--------------------------------------------------------------------+
| | |
| COPYFILE | ifileid [ofileid] [( [options...] [)]] |
| | |
| | Options: |
| | + + + + + + |
| | [Type] [OLDDate] |APPend | |PACK | |RECfm V| |
| | |REPlace| |UNPACK| | F| |
| | [TRUnc] + + + + + + |
| | |
+--------------------------------------------------------------------+
where
ifileid is the filename, filetype, and filemode of the input file.
Any part of the fileid may be specified as "*" to indicate a
group of files matching the other parts of the fileid.
ofileid is the filename, filetype, and filemode of the output file.
If any part of "ifileid" contains an "*", the corresponding
part of "ofileid" must be specified as "=". The default
output fileid is "= = =".
Options
APPend adds the input file to the end of an existing output file.
A new file is created it does'n exist.
OLDDate uses the date of the input file for the output file. The
date may be examined with the FLIST, LISTX or LISTFILE
"DATE" option, and is used with the sorting options of
FLIST, LISTX, LISTFILE, and FILELIST.
PACK writes the output file in packed format. Refer to the PACK
command description for more information.
RECfm x specifies the record format of the output file. RECFM may
be specified as "V" (variable-length records) or "F" (fixed-
length records). The default is the format of the input
file.
Section 2: Command Descriptions 71
CMS Reference
COPYFILE
REPlace replaces an existing file with the output file. This is the
default if the output fileid is "= = =" (the default value).
TRUnc is used when converting files to variable-length format. It
removes trailing blanks from output lines.
Type displays the fileid of each file copied.
UNPACK writes the output file in normal, unpacked format. The
input file must be in packed format. Refer to the UNPACK
command description for more information.
Usage Notes
1. COPYFILE can be used to convert a file in fixed-length record
format to variable-length format. This often results in a
considerable savings of disk space. To perform this procedure,
use the following command:
copyfile filename filetype filemode ( RECFM V TRUNC OLDDATE
Warning: Do not perform this procedure on a file in packed
format. Packed files must be in fixed-length format.
2. COPYFILE has many other options and capabilities, including a
SPECS option that can be used to manipulate the data in specified
columns as the file is copied. Refer to the VM/SP CMS Command
and Macro Reference or the online HELP command for details.
Section 2: Command Descriptions 72
CMS Reference
COST
Use the COST command to obtain the cost of a terminal session.
+--------------------------------------------------------------------+
| | + + |
| COST | [( [Type] |Stack| [Nohdr] [)]] |
| | |Lifo | |
| | |Fifo | |
| | + + |
+--------------------------------------------------------------------+
Options
Type displays the cost on the terminal. This is the default.
Stack puts the cost in the stack (last-in, first-out).
Lifo is the same as STACK.
Fifo puts the cost in the stack (first-in, first-out).
Nohdr suppresses the typed header line.
Usage Notes
| 1. COST displays the total charge for the terminal session during
| the current rate period. Also displayed are the CPU time and the
| I/O operation count. The header line contains the elapsed time
| of this terminal session during the current rate period.
2. The stacking options of COST (STACK, LIFO, and FIFO) put a single
line containing the following data on the program stack:
1. An asterisk (*)
2. Cost (dollars)
3. Cost (cents)
4. Four-digit department number
5. Five-digit project number
6. Milliseconds of CPU time used
7. Count of I/O operations (only non-spooled disk
operations are counted
| 8. Elapsed time (hours:minutes:seconds)
| 9. Cost (dollars and cents)
Messages and Return Codes
| DMSCST003E "[string]" is not an option. RC=24
Section 2: Command Descriptions 73
CMS Reference
| DEFAULTS (EXEC)
Use the DEFAULTS command to customize the default options for the
commands listed below.
+--------------------------------------------------------------------+
| | + + |
| DEFAULTS | |Set command options...| |
| | |List [command] | |
| | + + |
+--------------------------------------------------------------------+
where
Set sets default options for the specified command.
List lists the current default options for the specified command
or for all commands supported by DEFAULTS (if no command is
specified).
Supported Commands and Options
Command Options
Filelist Profile [fn|PROFFLST] Filelist
NOFilelist
Note Profile [fn|PROFNOTE] Short LOG NOAck
LONg NOLog Ack
NOTebook [fn|ALL|*]
NONOTebook
Peek Profile [fn|PROFPEEK] FRom recno FOr numrec
RDrlist Profile [fn|PROFRLST]
Receive Log Olddate NOTebook [fn|ALL|*]
NOLog NEwdate
Sendfile New NOType NOFilelist Log NOAck
Old Type Filelist NOLog Ack
TDISK SIZE [nK|nM|200K]
Tell MSGCMD [MSG|SMSG]
Usage Note
Refer to the VM/SP CMS Command and Macro Reference or online HELP for
more information.
Section 2: Command Descriptions 74
CMS Reference
DROP (EXEC)
Use the DROP command to drop a link to a minidisk. (DROP combines the
RELEASE and DETACH commands.) After dropping a link it is necessary
to use the LINK and ACCESS commands to make the files on the dropped
minidisk accessible again.
+--------------------------------------------------------------------+
| | |
| DROP | disk [disk...] |
| | |
+--------------------------------------------------------------------+
where
disk is a filemode letter or a virtual device address. More than
one can be specified. Filemode letters are assigned with
the ACCESS command, and virtual device addresses are
assigned with the LINK command. You cannot drop "190,"
"19E," "S," or "Y."
Usage Notes
1. It is possible to drop your own A-disk, D-disk, and links to the
OS rental volumes. This doesn't destroy any files, but it makes
them temporarily inaccessible. The following commands would re-
establish your A-disk:
link * 191 191
access 191 a
You can also log off and log on again to re-establish your normal
links.
| 2. You must DROP a disk that you have write-access to if you want to
| allow another user to write on that disk. Refer to the
| descriptions of the AUTOLINK, LINK, and ACCESS commands for more
| information.
| 3. If you DROP a temporary disk (TDISK), DROP attempts to estimate
| the charge for the disk space.
Messages and Return Codes
DMSDRP070E No devices specified.
DMSDRP070E "disk" cannot be dropped.
DMSDRP070E "disk" is not a valid mode or address.
DMSDRP113S Device "disk" does not exist.
Messages may also be produced by the RELEASE and DETACH commands.
Section 2: Command Descriptions 75
CMS Reference
DROPBUF
Use the DROPBUF command to destroy the most recently created CMS
program stack buffer or buffers.
+--------------------------------------------------------------------+
| | |
| DROPBUF | [n] |
| | |
+--------------------------------------------------------------------+
where
n is the number of the first buffer to be dropped. All
buffers created after the specified buffer will also be
dropped (these will have higher numbers). If "n" is not
specified, the most recently created buffer is dropped.
Usage Note
The CHECKBUF, MAKEBUF, and SENTRIES commands are also useful when
manipulating the stack. All of these commands are intended to be used
from EXEC's.
Messages and Return Codes
DROPBUF produces no messages, but can produce the following return
codes:
1 The buffer number was not valid.
2 The specified buffer does not exist.
Section 2: Command Descriptions 76
CMS Reference
ENVIRON
The ENVIRON command provides information about the CMS environment by
setting a return code.
+--------------------------------------------------------------------+
| | + + |
| | |BATch | |
| ENVIRON | |DISConnect| |
| | |DISPlay | |
| | |SUBset | |
| | |system | |
| | + + |
+--------------------------------------------------------------------+
where
| BATch checks for the CMS Batch environment.
DISConne checks for disconnected terminal status. This is the
default.
DISPlay checks for a display (3270-type) terminal.
SUBset checks for CMS SUBSET mode.
| system checks the IPL system name or device address. This usually
will be "CMS."
Messages and Return Codes
ENVIRON will check for the specified condition and set the return code
to zero if true, one if false. For example, issuing ENVIRON DISPLAY
while you are using a 3270-type terminal will return a zero. Issuing
ENVIRON DISC from a 3270-type terminal will return a one.
ENVIRON produces no messages.
Section 2: Command Descriptions 77
CMS Reference
ERASE
Use the ERASE command to delete a CMS disk file. This is a
description of the most frequently used function of the ERASE command;
other functions are available.
+--------------------------------------------------------------------+
| | + + |
| ERASE | filename filetype |filemode| [( [TYPE] [)]] |
| | |A | |
| | + + |
+--------------------------------------------------------------------+
where
filename is the filename of a CMS disk file to be erased.
filetype is the filetype of the file.
filemode is the filemode of the file. The default is "A."
Options
TYPE types the fileid of each erased file.
Usage Notes
1. The BURN command also provides this function.
2. ERASE has other options and capabilities. Refer to the VM/SP CMS
Command and Macro Reference or online HELP for details.
Section 2: Command Descriptions 78
CMS Reference
EXEC
Use the EXEC command to execute commands and control statements
| contained in the specified CMS disk file. The filetype of the file
| must be "EXEC." If the first line of the program contains a comment
| beginning with "/*" it is processed by REXX; if it contains an
| "&TRACE" control statement it is processed by EXEC 2; otherwise EXEC
| is used. REXX is recommended for new applications.
| For more detailed information about REXX (the Restructured Extended
| Executor), consult the VM/SP System Product Interpreter Reference and
| the VM/SP System Product Interpreter User's Guide.
| For more detailed information about EXEC 2, consult the VM/SP EXEC 2
| Reference.
| For more information about EXEC, consult the VM/SP CMS Command and
| Macro Reference.
| Online information is available for all three EXEC languages; enter:
| help rexx -or- help exec2 -or- help exec
+--------------------------------------------------------------------+
| | |
| [EXec] | filename [arguments...] |
| | |
+--------------------------------------------------------------------+
where
filename is the name of the EXEC.
arguments are arguments passed to the EXEC.
Usage Notes
1. Any command issued from the terminal ordinarily is assumed to be
the name of an EXEC. This is controlled by the CMS command SET
IMPEX (implied EXEC); SET IMPEX OFF to disable the automatic EXEC
search. If no EXEC exists a search is made for a module or CMS
nucleus command. If neither is found, the command is passed to
CP for execution. This is controlled with the CMS command SET
IMPCP (implied CP); SET IMPCP OFF to disable this process.
When issuing commands from within XEDIT, XEDIT will first assume
that the command is an XEDIT subcommand. If this is not the case
a check for an XEDIT macro is made (this is under the control of
the XEDIT subcommand SET MACRO). If no macro is found, the
command is passed through the normal CMS command search (under
the control of the XEDIT subcommand SET IMPCMSCP).
Section 2: Command Descriptions 79
CMS Reference
EXEC
Both CMS and XEDIT have facilities for user-defined command
synonyms and abbreviations. For more information, refer to the
description of the CMS command SYNONYM in the VM/SP CMS Command
and Macro Reference, and to the description of the XEDIT
subcommand SET SYNONYM in this manual.
| 2. REXX supports the full CMS command search (refer to the REXX
| ADDRESS function for more information). This is not true of
| EXEC 2 and EXEC, however. To execute another EXEC program from
| one of these languages use the "EXEC" command. For example, to
| execute an EXEC named "SAMPLE" from one named "TEST," the TEST
EXEC would contain the line "EXEC SAMPLE." Similarly, to execute
a CP command from within an EXEC, it must be preceded by the
command "CP" ("CP LINK...," for example).
3. Two special EXEC programs are used by CMS at IPL (which occurs
automatically when you log on). A system profile EXEC is
executed, and it calls a user-supplied EXEC named "PROFILE EXEC."
You can use this EXEC to tailor the CMS environment to your own
requirements. The following example illustrates some of the
things that you might use in a PROFILE:
| /* A Sample Profile EXEC */
| "set emsg on"
| "setcon to *"
See the UKCC CMS User's Guide for more information about the
PROFILE EXEC.
| 4. REXX and EXEC 2 also process XEDIT macros. An XEDIT macro is
| similar to an EXEC and may contain XEDIT subcommands in addition
to the other functions allowed in an EXEC. All XEDIT macros have
a filetype of "XEDIT" and may only be used from within XEDIT.
Refer to the XEDIT command Usage Notes for more information.
| 5. Use the HI (Halt Interpretation) command to stop all currently
| executing REXX and EXEC 2 programs and macros. HI halts
| execution without destroying the environment as HX does.
6. Contrary to the IBM-supplied documentation, the predefined EXEC 2
variables &DATE and &TIME return the local date and time in
Lexington, Kentucky, rather than the true date and time "on the
primary meridian, Greenwich Mean Time (GMT)." This would be the
Mean Solar Time at Greenwich, which is roughly equivalent to
| standard Universal Coordinated Time (UTC). The REXX DATE and
| TIME functions also return the local date and time in Lexington.
Lexington local time is either Eastern Standard Time (EST) or
Eastern Daylight Time (EDT). EST is five hours earlier than GMT,
and EDT is six hours earlier than GMT. The time is usually
correct to within a few minutes.
Section 2: Command Descriptions 80
CMS Reference
EXPLAIN (EXEC)
Use the EXPLAIN command to display an explanation of the most recently
issued error message.
+--------------------------------------------------------------------+
| | |
| EXPLAIN | |
| | |
+--------------------------------------------------------------------+
Usage Note
EXPLAIN can properly handle all CMS error messages (DMS prefix), and
all CP error messages (DMK prefix) resulting from CP commands entered
from CMS. It will not work for CP informational and warning messages,
or CP messages resulting from commands issued from CP mode, or with a
#CP.
Messages and Return Codes
Messages may be generated by the CMS HELP command.
Section 2: Command Descriptions 81
CMS Reference
FCOPY
Use the FCOPY command to copy CMS disk files. FCOPY is considerably
more efficient than COPYFILE, but does not allow packing, unpacking,
or other file manipulations during the copy.
+--------------------------------------------------------------------+
| | |
| FCOPY | ifileid ofileid [ (options... [)]] |
| | |
| | Options: |
| | |
| | + + + + + + |
| | |Type | |NEWDate| |UPdirt | |
| | |NOType| |OLDDate| |NOUPdirt| |
| | + + + + + + |
+--------------------------------------------------------------------+
where
ifileid is the fileid of the input file. Patterns may be specified
using asterisks in the fileid (as with the LISTFILE
command).
ofileid is the fileid of the output file or files. Equal signs must
be used for the filename, filetype, or filemode if the
corresponding part of the input fileid contains an asterisk.
Options
Type displays the fileids of the copied files. This is the
default if any part of the input fileid contains an
asterisk.
NOType suppresses the fileid list.
NEWDate uses the current date as the creation date of the output
file or files. This is the default.
OLDDate uses the creation date of the input file or files as the
creation date of the output file or files.
UPdirt uses normal file directory updating during the copy. This
is the default.
NOUPdirt causes file directory updating to be bypassed until all
files have been copied. This is much faster than the
default mode if many files are to be copied. The NOUPDIRT
option is overridden when an existing file is replaced.
Section 2: Command Descriptions 82
CMS Reference
FCOPY
Usage Notes
1. Unlike the COPYFILE command, FCOPY will always replace an
existing output file. FCOPY does not have a NOREPLACE or NEWFILE
option. Use care to avoid unintentionally destroying existing
files.
2. You should always use FCOPY instead of COPYFILE when you do not
need the functions that only COPYFILE provides. FCOPY is as much
as ten times faster (and cheaper) than COPYFILE.
Messages and return codes
DMSCPY002E Files not found. RC=28
DMSCPY003E "name" is not an option. RC=24
DMSCPY030E File "fileid" was active. it has been closed.
DMSCPY032E Invalid filename or filetype. RC=24
DMSCPY037E Disk "mode" is read-only. RC=32
DMSCPY048E Invalid mode "mode". RC=24
DMSCPY054E Incomplete fileid specified. RC=24
DMSCPY062E Invalid "char" in fileid. RC=20
DMSCPY069E Disk "mode" is not accessed. RC=32
DMSCPY070E "name" is not a valid parameter. RC=24
DMSCPY104S Error n reading file "fileid" from disk. RC=100
DMSCPY105S Error n writing file "fileid" to disk. RC=100
DMSCPY703I File "fileid" copied.
DMSCPY985E Insufficient storage for fcopy. RC=25
DMSCPY993E [record|block] count for file "fileid" is too large
For disk mode. RC=100
Section 2: Command Descriptions 83
CMS Reference
FLIST
Use the FLIST command to view a list of selected CMS disk files on a
3270-type terminal. FLIST creates a menu display that may be used to
issue any CP or CMS command or EXEC (BURN or XEDIT, for example) by
entering the command in the input area immediately to the right of a
fileid on the screen. You can also issue FLIST subcommands to sort
the displayed data or to enter a new FLIST level that displays
another set of files.
+--------------------------------------------------------------------+
| | |
| | + + + +++ |
| Flist | |fn |ft |fm||| [( [options...] [)]] |
| | |* |* |A ||| |
| | + + + +++ |
| | |
| | Options: |
| | |
| | [Help fn] [Menu] [Profile ([fn [ft [fm]]])] |
| | |
| | [Noclear] [Stack] [One [(recno)]] |
| | |
| | [PROTect] [SOrt fn] [Use [([fn [ft [fm [)]]]]]] |
| | |
+--------------------------------------------------------------------+
where
fn is the filename or general form of the filename of the files
for which information is to be collected. The default is
"*".
ft is the filetype or general form of the filetype of the files
for which information is to be collected. The default is
"*".
fm is the filemode or general form of the filemode of the files
for which information is to be collected. The default value
is "A".
General Forms for File Identifiers
Portions of file identifiers (name, type, and mode) may use asterisks
(*) and plus signs (+) either alone or combined with other characters
for matching purposes. Each asterisk will match any number of any
character. Each plus sign will match a single occurrence of any
character.
Section 2: Command Descriptions 84
CMS Reference
FLIST
Options
Help fn specifies the name of an EXEC to be called by the /HELP
subcommand. The default name is "HFLIST".
Profile (fn ft fm)
specifies an alternate file to be used as the FLIST profile.
The default is "FLIST $PROFILE *".
Noclear specifies that FLIST is not to clear the screen.
Stack stacks one line for each input area used:
*FLIST nnnnn filename filetype filemode input
| | | | | |
| | | | | user input
| | | | the displayed filemode
| | | the displayed filetype
| | the displayed filename
| the file (entry) number in the list
to make it a comment, in case CMS reads it
One (recno)
causes the first selected input line to be stacked. If
"recno" is specified, display starts at recno. The ONE
option implies the STACK option.
SOrt fn specifies an alternate EXEC to be called when a subcommand
(/Sx) is issued and the "USE" option was specified. The
default name is "FLISTS".
PROTect allows input fields to be used only once, after which they
are protected to prevent entry of another command.
Use (fn ft fm)
specifies display of the named file (which must be in CMS
EXEC format) rather than FLIST's file listing. If no fileid
is specified, "CMS EXEC *" is used. The data from file
columns 8-27 is placed in screen columns 1-19. The
remainder of the data columns are placed in the appropriate
columns of the display following the user input areas. This
means that the LISTX DATE or LABEL options should be used
when the input file is created.
Menu is used with the USE option to prevent formatting of the
screen to the right of the input areas. When MENU is
specified, the text from input file columns 8-27 is placed
in screen columns 1-19, and text from file columns 29-64 is
moved intact to the right of the input areas.
Section 2: Command Descriptions 85
CMS Reference
FLIST
Keyboard Functions
PA1 will transfer control to CP mode. Enter BEGIN to return to
FLIST.
PA2 will transfer control to CMS subset. Enter RETURN to return
to FLIST.
PFnn will execute the command defined for the Program Function
key pressed. The PF key definitions are contained in the
FLIST profile.
FLIST Subcommands
The following subcommands are available after you enter the FLIST
environment (abbreviations are shown in uppercase):
/Bottom displays the last page of the current FLIST level.
/Cancel cancels all active FLIST levels without processing any other
commands that are entered after the /CANCEL command.
/Dspf displays the PF key definitions.
/Enter fn ft fm (options)
enters another FLIST level. This is the same as the /LEVEL
subcommand.
/Help displays information on the use of the FLIST facility.
/Level fn ft fm (options)
enters another FLIST level. The /LEVEL subcommand operands
are the same as those used for the FLIST command. If no
parameters are specified, the next logical level will
replace the level from which the command was entered. If a
new level is required, at least a filename should be
specified. When creating the second level, the screen will
be split into two equal parts. Use the SPL PF key function
to move the split. The profile is only processed on
initialization of the first level.
/Omit command
is used to issue a CP or CMS command without appending the
fileid to the command. /, /N, /T, and /M may be used within
the command to insert all or part of the fileid.
/Quit ends the current FLIST level after processing commands
entered for the level.
Section 2: Command Descriptions 86
CMS Reference
FLIST
| /Refresh builds a new file display, removing lines for deleted files
| and adding lines for new files.
/Sx sorts the entries in the current level. The sort code "x"
specifies how the sorting is to be done. After sorting, the
level is redisplayed from the top. If any files have been
erased, the empty lines are removed during the sort. The
following sorts are supported:
Code Sort
| B Block Count and Fileid (same as S)
D Date, Time, and Fileid (descending date and time)
L Record Length (descending order) and Fileid
M Filemode, Filename, and Filetype
N Filename, Filetype, and Filemode
| S File Size (descending order) and Fileid
T Filetype, Filename, and Filemode
/Top displays the first (top) page for the current level.
/n positions the indicated line on the top line of the current
level. If "n" is not specified, the line on which the
command is entered becomes the top line.
= repeats the last command for the current level. Except for
/ENTER, /LEVEL, and /OMIT, FLIST subcommands cannot be
repeated.
? displays the last command for the current level (what would
execute if = were entered). Press ENTER or a PF key to re-
execute the displayed command. This command can be used
from a PF key to provide a convenient command recall
function.
The FLIST Profile
At initialization, a search is made for the FLIST profile. The
profile is a CMS file named "FLIST $PROFILE *" (or a specified
substitute) that is used to set PF key functions and override the
default top and bottom titles. The file may contain either fixed or
variable-length records up to 132 bytes long. After processing the
profile, any lines in the CMS stack will be processed as profile
records.
The profile may contain any of the following records:
*HEADER header-text
The first 50 characters following *HEADER will replace the
level title line. The text will be centered.
*PFKEYS nn [(btd)] function
Section 2: Command Descriptions 87
CMS Reference
FLIST
PF key "nn" will be defined as "function". The optional
bottom title data, "btd", is used on the default bottom
title to explain the PF key. The text must appear between
parentheses, and must be three characters long. If "btd" is
not specified, the first three characters of the function
are used. Some special FLIST functions may be used as PF
key definitions (these functions are allowed only on PF
keys):
Function Description
%% Clear the definition for this PF key.
>I Widen command input area to end of line.
BRW Invoke BROWSE.
CAN Cancel all levels.
END Terminate the level containing the cursor.
SCB Scroll backward (toward the top of the file).
SCF Scroll forward (toward the end of the file).
SPL Split the screen at the cursor position.
A record containing no keyword may be placed at the end of
the profile. The contents of this record will replace the
default bottom title line of the display.
Usage Notes
1. FLIST creates a display of fileids and related information (much
like the LISTX command output) on the screen. Each line contains
an input field that may be used for commands or FLIST
subcommands. If a command is placed in an input field, the
corresponding fileid is passed to it. For example, placing
"BURN" in the input field of the line for "A FILE A1" would cause
the command "BURN A FILE A1" to be executed. Any CP or CMS
command or EXEC may be used. The special indicator / can be used
in the input area:
/ Insert the complete fileid.
/n Insert the filename.
/t Insert the filetype.
/m Insert the filemode.
/o Omit the fileid (must be first item on line).
Any combination of "n", "t" and "m" is valid to a maximum of
seven characters. If not explicitly specified, FLIST will append
the entire fileid to the input text. The /o indicator can be
placed at the beginning of the line to suppress this.
After executing a command, the CMS stack is processed. Input
starting with a / will replace the original command and be
processed as if entered by the user. Input not starting with a /
will be passed to CMS without any change to the contents of the
Section 2: Command Descriptions 88
CMS Reference
FLIST
line. If the stack is empty, the next input field is processed.
When all input fields are processed, the screen is redisplayed
and the input fields are marked to indicate the result of the
commands:
* indicates that the command completed normally
(return code zero).
¬nn Indicates that the command returned a non-zero
return code (nn).
? Indicates that no command with that name exists.
+ Indicates that no FLIST subcommand with that
name exists.
2. Never re-access a disk which is displayed on one of the levels.
Do not erase files displayed on any level with an EXEC or with an
"ERASE * filetype filemode" command. Do not erase a file which
is displayed on more than one level. These situations cannot
always be detected by FLIST and the results are unpredictable.
3. The input areas on each display line may be made wider with the
>I PF key function. The supplied FLIST $PROFILE sets PF9 to this
function.
Messages and Return Codes
FLIST produces no messages, but can produce the following return
codes:
1 Console not a 3270-type terminal.
2 Insufficient storage available.
24 Invalid filemode specified.
28 File not found.
36 Disk not accessed.
1xxx Disk I/O error. See the CMSDIO command return codes for a
detailed list.
Section 2: Command Descriptions 89
CMS Reference
FORTG
Use the FORTG command to compile a program with the IBM FORTRAN G
compiler. FORTRAN G is not supported; VS FORTRAN generally should be
used for new programs. The FORTGCG, FORTGC, and FORTGG commands are
available for use with FORTRAN G programs.
+--------------------------------------------------------------------+
| | |
| FORTG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
Options
BCD permits the use of BCD characters rather than EBCDIC in the
source program. This option exists to support non-EBCDIC
keypunches. Further details can be found in the
Programmer's Guide. EBCDIC is the default option.
DECK causes the object program to be written to the disk file
"filename TEXT." This is the default.
EBCDIC specifies that the source program contains EBCDIC
characters. This is the default.
ID specifies that internal statement numbers (ISN's) are to be
generated for statements that call subroutines or contain
external function references. This information is used in
the traceback produced if an error occurs in the called
subprogram. This is the default.
LINECNT n is the number of lines on each page of compiler listing
output (ranging from 1 to 99). The default is LINECNT 56.
LIST produces a listing of the object program. The default is
NOLIST.
MAP produces a table of names. NOMAP is the default.
NAME name assigns a name to the object program. The default name of a
main program is MAIN, the name of a subprogram is always the
name used on the SUBROUTINE or FUNCTION statement.
Section 2: Command Descriptions 90
CMS Reference
FORTG
NODECK suppresses generation of an object program.
NOID See the ID option.
NOPrint suppresses the compiler listing.
NOTerm See the TERM option.
Print sends the compiler listing to the spooled printer. The
default is to write the listing into a disk file named
"filename LISTING."
SOURCE produces a source listing. This is the default.
Term displays compiler diagnostic messages at the terminal. This
is the default.
Usage Notes
1. The FORTRAN language supported by the FORTRAN G compiler is
described in the IBM System/360 and System/370 FORTRAN IV
Language manual, and more information about the compiler can be
found in the IBM System/360 OS FORTRAN IV (G and H) Programmer's
Guide.
2. Before loading your FORTRAN program, you must define any
subroutine libraries required (including the FORTRAN G library).
If your program performs any input or output operations, you may
also need to define the files to be used. All unit numbers are
defined to be disk files named "FILE FTnnF001" by default (and
input files must contain 80-byte, fixed-length records). To
associate a FORTRAN unit number with a device, use a DD name in
the form FTnnF001 (nn is the unit number), or just the number on
a FILEDEF command. For example:
GLOBAL TXTLIB FORTGLIB
FILEDEF 5 TERMINAL
FILEDEF 6 PRINTER
LOAD filename ( START
defines unit 5 as the terminal (for keyboard input) and unit 6 as
the spooled printer.
Section 2: Command Descriptions 91
CMS Reference
FORTGC (EXEC)
Use the FORTGC command to compile a program with the IBM FORTRAN G
compiler. FORTRAN G is not supported; VS FORTRAN generally should be
used for new programs.
+--------------------------------------------------------------------+
| | |
| FORTGC | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are FORTG compiler options.
Usage Note
FORTGC is an EXEC that uses the FORTG command to compile a FORTRAN
program. The object program produced can be executed with the FORTGG
command. Refer to the description of the FORTG command for more
information.
Section 2: Command Descriptions 92
CMS Reference
FORTGCG (EXEC)
Use the FORTGCG command to compile and execute a program using the IBM
FORTRAN G compiler. FORTRAN G is not supported; VS FORTRAN generally
should be used for new programs.
+--------------------------------------------------------------------+
| | |
| FORTGCG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are FORTG compiler options.
Usage Notes
1. The default FORTRAN G subroutine libraries are used: ZETALIB,
FORTGLIB, and CMSLIB. If you need to use additional libraries or
load additional object files you must use the FORTGG command to
execute your program.
2. FORTGCG is an EXEC that uses the FORTG command to compile a
FORTRAN program. The object program produced is then executed.
Refer to the description of the FORTG command for more
information.
Section 2: Command Descriptions 93
CMS Reference
FORTGG (EXEC)
Use the FORTGG command to execute a program previously compiled with
the IBM FORTRAN G compiler. FORTRAN G is not supported; VS FORTRAN
generally should be used for new programs.
+--------------------------------------------------------------------+
| | |
| FORTGG | filename [filename...] [( [libraries] [> parms] ] |
| | |
+--------------------------------------------------------------------+
where
filename are the filenames of the CMS disks file containing the
FORTRAN G (or FORTRAN G compatible) object programs. The
filetypes of the files must be "TEXT."
libraries are the names of subroutine libraries (TXTLIB's). Any
libraries specified here are searched before the default
libraries: ZETALIB, FORTGLIB, and CMSLIB.
parms are command line parameters for the executed program.
Usage Note
Refer to the descriptions of the FORTGC and FORTG commands for more
information.
Section 2: Command Descriptions 94
CMS Reference
FORTHX
Use the FORTHX command to compile a program with the IBM FORTRAN H
Extended compiler. The FORTXCG, FORTXC, and FORTXG commands are
available for use with FORTRAN H Extended programs.
+--------------------------------------------------------------------+
| | |
| FORTHX | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
Options
AD is the same as AUTODBL.
ALC controls the alignment of data items in storage and is used
with the AUTODBL option. Refer to the discussion of the
Automatic Precision Increase (API) facility in the
Programmer's Guide for more information. NOALC is the
default.
ANSF causes the compiler to recognize only ANS built-in and
library functions. NOANSF is the default.
AUTODBL(value|NONE)
controls the Automatic Precision Increase (API) facility.
Refer to the Programmer's Guide for more information. The
default is AUTODBL(NONE).
BCD permits the use of BCD characters rather than EBCDIC in the
source program. This option exists to support non-EBCDIC
keypunches. Further details may be found in the
Programmer's Guide. EBCDIC is the default option.
DECK sends the object program to the spooled punch. NODECK is
the default.
DIsk writes the compiler listing into a CMS disk file named
"filename LISTING." This is the default.
Section 2: Command Descriptions 95
CMS Reference
FORTHX
DUMP produces a dump if the compiler terminates abnormally.
NODUMP is the default.
EBCDIC specifies that the source program contains EBCDIC
characters. This is the default.
FLAG(I|E|S)
indicates the lowest level of diagnostic messages produced.
You can specify I (informational), E (error), or S (severe).
FLAG(I) is the default.
FMT is the same as FORMAT.
FORMAT produces a structured listing if OPTIMIZE(2) is in effect.
The default is NOFORMAT.
GOSTMT specifies that internal sequence numbers (ISN's) are to be
generated for statements that call subroutines or contain
external function references. This information is used in
the traceback produced if an error occurs in the called
subprogram. NOGOSTMT is the default.
LC is a synonym for LINECOUNT.
LINECOUN (n|60)
is the number of lines on each page of compiler listing
output (ranging from 1 to 99). The default is LINECOUN(60).
LIST produces a listing of the object program. The default is
NOLIST.
MAP produces a table of names. NOMAP is the default.
NAME(name)
assigns a name to the object program. The default name of a
main program is MAIN. The name of a subprogram is always
the name used on the SUBROUTINE or FUNCTION statement.
Names are limited to six characters.
NOOBJect See the OBJECT option.
NOPrint suppresses the compiler listing. The default is DISK.
NOSource See the SOURCE option.
NOTERMin See the TERMINAL option.
OBJect produces an object program. This is the default.
Section 2: Command Descriptions 96
CMS Reference
FORTHX
OPTimize(0|1|2)
is the optimization level. The default is OPTIMIZE(0),
which is the same as NOOPTIMIZE.
Print sends the compiler listing to the spooled printer. DISK is
the default.
SIZE(n) controls the use of storage by the compiler, and may range
from 160K to 9999K. The default is SIZE(MAX). FORTHX
requires at least an 800K virtual machine to operate.
SOURCE produces a source listing. This is the default.
Terminal displays compiler statistics and diagnostic messages at the
terminal. This is the default.
XL allows the extended language features (STRUCTURE statement
and logical operations). These features are documented in
the compiler logic manual. NOXL is the default.
XREF produces a cross-reference listing. NOXREF is the default.
Usage Notes
1. The FORTRAN language supported by the FORTRAN H Extended compiler
is described in the IBM System/360 and System/370 FORTRAN IV
Language manual, and more information about the compiler can be
found in the IBM OS FORTRAN IV (H Extended) Programmer's Guide.
The extended language (XL) features are documented in the IBM
FORTRAN IV (H Extended) Compiler for OS and VM/370 (CMS) Program
Logic manual.
2. The FORTHX compiler will not operate in a virtual machine smaller
than 800K, but compiled programs can run in smaller machines.
Use the STORAGE command to change your virtual machine size.
3. Before loading your FORTRAN program, you must define any
subroutine libraries required (including the FORTRAN libraries).
If your program performs any input or output operations using
units other that 5 and 6 you must also define the files or
devices to be used before execution. To associate a FORTRAN unit
number with a device, use a DD name in the form FTnnF001 (nn is
the unit number), or just the number on a FILEDEF command.
(Units 5 and 6 are assigned to the terminal by default.) For
example:
GLOBAL TXTLIB FORTLIB FORTEEH
FILEDEF 10 DISK DATA FILE A
LOAD filename ( START
Section 2: Command Descriptions 97
CMS Reference
FORTVC (EXEC)
Use the FORTVC command to compile a program with the IBM VS FORTRAN
compiler.
+--------------------------------------------------------------------+
| | |
| FORTVC | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are FORTVS compiler options.
Usage Note
FORTVC is an EXEC that uses the FORTVS command to compile a FORTRAN
program. The object program produced can be executed with the FORTVG
command. Refer to the description of the FORTVS command for more
information.
Section 2: Command Descriptions 98
CMS Reference
FORTVCG (EXEC)
Use the FORTVCG command to compile and execute a program using the IBM
VS FORTRAN compiler.
+--------------------------------------------------------------------+
| | |
| FORTVCG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are FORTVS compiler options.
Usage Notes
1. The default VS FORTRAN subroutine libraries are used: VALTLIB,
VFORTLIB, and CMSLIB. If you need to use additional libraries or
load additional object files you must use the FORTVG command to
execute your program.
2. FORTVCG is an EXEC that uses the FORTVS command to compile a
FORTRAN program. The object program produced is then executed.
Refer to the description of the FORTVS command for more
information.
Section 2: Command Descriptions 99
CMS Reference
FORTVG (EXEC)
Use the FORTVG command to execute a program previously compiled with
the IBM VS FORTRAN compiler.
+--------------------------------------------------------------------+
| | |
| FORTVG | filename [filename...] [( [libraries] [> parms] ] |
| | |
+--------------------------------------------------------------------+
where
filename are the filenames of the CMS disks file containing the VS
FORTRAN (or VS FORTRAN compatible) object programs. The
filetypes of the files must be "TEXT."
libraries are the names of subroutine libraries (TXTLIB's). Any
libraries specified here are searched before the default
libraries: VALTLIB, VFORTLIB, and CMSLIB.
parms are command line parameters for the executed program.
Usage Note
Refer to the descriptions of the FORTVC and FORTVS commands for more
information.
Section 2: Command Descriptions 100
CMS Reference
FORTVS
Use the FORTVS command to compile a program with the IBM VS FORTRAN
compiler. The FORTVCG, FORTVC, and FORTVG commands are available for
VS FORTRAN programs.
+--------------------------------------------------------------------+
| | |
| FORTVS | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
Options
CHARLEN(n|500)
is the maximum length for CHARACTER variables. The default
is 500.
CI(list) are the id numbers of the INCLUDEs to be processed.
CL is a synonym for CHARLEN.
DC(list) are the COMMON blocks to be allocated at execution time.
library functions.
Deck sends the object program to be sent to the spooled punch.
NODeck is the default.
DIsk writes the compiler listing into a CMS disk file named
"filename LISTING." This is the default. DISK cannot be
specified on a PROCESS statement.
FIPS(F|S) controls standard language flagging. You can specify F
(full) or S (subset). NOFIPS is the default. FIPS is
ignored when LANGLVL(66) is specified.
FIXED specifies fixed-format source. This is the default. See
also FREE.
FLAG(I|W|E|S)
indicates the lowest level of diagnostic messages produced.
You can specify I (informational), W (warning), E (error),
or S (severe). FLAG(I) is the default.
Section 2: Command Descriptions 101
CMS Reference
FORTVS
FREE specifies free-format source. FIXED is the default.
GOSTMT specifies that internal sequence numbers (ISN's) are to be
generated for statements that call subroutines or contain
external function references. This information is used in
the traceback produced if an error occurs in the called
subprogram. NOGOSTMT is the default.
GS is a synonym for GOSTMT.
LANGLVL(66|77)
specifies the FORTRAN dialect used by the compiler. 77 (the
default) is ANS X3.9-1978, ISO 1539-1980 (known as FORTRAN
77); 66 is the older ANS X3.9-1966, ISO R1539-1972 standard.
Both dialects include IBM extensions.
LC is a synonym for LINECOUNT.
LINECOUNT(n|60)
is the number of lines on each page of compiler listing
output (ranging from 1 to 32765). The default is
LINECOUNT(60).
List produces a listing of the object program. The default is
NOLIST.
MAP produces a table of names. NOMAP is the default.
NAME(name)
for old FORTRAN programs only, assigns a name to the object
program. The default name of a main program is MAIN. The
name of a subprogram is always the name used on the
SUBROUTINE or FUNCTION statement.
NOOBJect See the OBJECT option.
NOPrint suppresses the compiler listing. The default is DISK.
NOSDump suppresses generation of symbolic dump information.
NOSource See the SOURCE option.
NOSRCFLG See the SRCFLG option.
NOTERMinal
See the TERMINAL option.
NOTRMFLG See the TRMFLG option.
OBJect produces an object program. This is the default.
Section 2: Command Descriptions 102
CMS Reference
FORTVS
OPTimize(0|1|2|3)
specifies the optimization level. The default is
OPTIMIZE(0), which is the same as NOOPTIMIZE.
Print sends the compiler listing to the spooled printer. DISK is
the default. PRINT cannot be specified on a PROCESS
statement.
SF is a synonym for SRCFLG.
Source produces a source listing. This is the default.
SRCFLG includes error messages in the source listing. This is the
default.
SYM produces SYM information for the object program. NOSYM is
the default.
TERMinal displays compiler diagnostic messages at the terminal. This
is the default.
TEST is used with FORTRAN Interactive Debug. NOTEST is the
default.
TRMFLG displays statements in error and the associated messages at
the terminal. This is the default.
Xref produces a cross-reference listing. NOXREF is the default.
Usage Notes
1. The FORTRAN language supported by the VS FORTRAN compiler is
described in the VS FORTRAN Application Programming: Language
Reference. Other VS FORTRAN manuals are listed in the
Bibliography.
2. Before loading your FORTRAN program, you must define any
subroutine libraries required (including the FORTRAN libraries).
If your program performs any input or output operations using
units other that 5 and 6 you must also define the files or
devices to be used before execution. To associate a FORTRAN unit
number with a device, use a DD name in the form FTnnF001 (nn is
the unit number), or just the number on a FILEDEF command.
(Units 5 and 6 are assigned to the terminal by default.) For
example:
GLOBAL TXTLIB VALTLIB VFORTLIB CMSLIB
FILEDEF 10 DISK DATA FILE A
LOAD filename ( START
Section 2: Command Descriptions 103
CMS Reference
FORTXC (EXEC)
Use the FORTXC command to compile a program with the IBM FORTRAN H
Extended compiler.
+--------------------------------------------------------------------+
| | |
| FORTXC | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are FORTHX compiler options.
Usage Notes
1. FORTXC is an EXEC that uses the FORTHX command to compile a
FORTRAN program. The object program produced can be executed
with the FORTXG command. Refer to the description of the FORTHX
command for more information.
2. FORTXC will not operate in a virtual machine smaller than 800K,
but compiled programs can run in smaller machines. You can use
the STORAGE command to redefine your storage size if necessary.
Section 2: Command Descriptions 104
CMS Reference
FORTXCG (EXEC)
Use the FORTXCG command to compile and execute a program using the IBM
FORTRAN H Extended compiler.
+--------------------------------------------------------------------+
| | |
| FORTXCG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the FORTRAN
source program. The filetype of the file must be "FORTRAN,"
and it must contain fixed-length, 80-byte records. This
filename will be used for the TEXT and LISTING files, if
they are created.
options are FORTHX compiler options.
Usage Notes
1. The default FORTRAN HX subroutine libraries are used: FORTEEH,
FORTLIB, and CMSLIB. If you need to use additional libraries or
load additional object files you must use the FORTXG command to
execute your program.
2. FORTXCG will not operate in a virtual machine smaller than 800K.
You can use the STORAGE command to redefine your storage size if
necessary.
3. FORTXCG is an EXEC that uses the FORTHX command to compile a
FORTRAN program. The object program produced is then executed.
Refer to the description of the FORTHX command for more
information.
Section 2: Command Descriptions 105
CMS Reference
FORTXG (EXEC)
Use the FORTXG command to execute a program previously compiled with
the IBM FORTRAN H Extended compiler.
+--------------------------------------------------------------------+
| | |
| FORTXG | filename [filename...] [( [libraries] [> parms] ] |
| | |
+--------------------------------------------------------------------+
where
filename are the filenames of the CMS disks file containing the
FORTRAN HX (or FORTRAN HX compatible) object programs. The
filetypes of the files must be "TEXT."
libraries are the names of subroutine libraries (TXTLIB's). Any
libraries specified here are searched before the default
libraries: FORTEEH, FORTLIB, and CMSLIB.
parms are command line parameters for the executed program.
Usage Note
Refer to the descriptions of the FORTXC and FORTHX commands for more
information.
Section 2: Command Descriptions 106
CMS Reference
FSEND
Use the FSEND command to send all or part of a CMS disk file to a
personal computer or other system that is acting as your CMS terminal.
+--------------------------------------------------------------------+
| | + + + + ++ |
| FSEND | fn ft |fm| |start |end|| [( [options...] [)]] |
| | |* | |1 |* || |
| | + + + + ++ |
| | Options: |
| | |
| | [Cr] [Lf] [Nl] [Eofstring string] |
| | |
| | [Prompt x] [Repeat x] |
| | |
+--------------------------------------------------------------------+
where
fn is the filename of the file to be sent.
ft is the filetype of the file to be sent.
fm is the filemode of the file to be sent. The default is "*,"
which searches all accessed disks.
start is the line number of the first line to be sent. If "start"
is greater than the number of lines in the file an immediate
end-of-file occurs. The default value is "1."
end is the line number of the last line to be sent. The default
value is "*," the last line in the file.
Options
Cr adds a carriage return character to the end of each line
sent to the terminal.
Eofstring string
specifies a string to be sent after the last line in the
file. This string is sent as a separate line, and is sent
even if no lines are sent from the file. The string can
contain up to eight characters.
Lf adds a line feed character to the end of each line sent to
the terminal.
Nl causes a carriage return and a line feed character to be
added to the end of each line sent to the terminal.
Section 2: Command Descriptions 107
CMS Reference
FSEND
Prompt x specifies the character used by the personal computer to
signal that the next line should be sent from the file.
FSEND pauses and waits for this character before sending
each line. The default character is a carriage return. The
PROMPT may be specified as a single character, two hex
digits, or one of the special names CR, DC1, DC2, DC3, DC4,
ESC, LF, NAK, NUL, or STX. An empty line (carriage return
with no other data) is always recognized as a PROMPT. Note
that all lines sent from an ASCII terminal must be ended
with a carriage return.
Repeat x specifies the character used by the personal computer to
signal that the most recent line should be sent again. This
character is used in place of the PROMPT to indicate that a
line must be repeated. The default character is a negative
acknowledgement (NAK). REPEAT may be specified as a single
character, two hex digits, or one of the special names CR,
DC1, DC2, DC3, DC4, ESC, LF, NAK, NUL, or STX. Note that
all lines sent from an ASCII terminal must be ended with a
carriage return.
Usage Notes
1. Consult the section on ASCII Communication elsewhere in this
manual for more information.
2. If the specified file is not found, it is treated as an immediate
end-of-file. No error message is produced.
3. All lines sent from an ASCII terminal must be ended with a
carriage return character.
| 4. The KERMIT command also performs this function, and in addition
| provides error checking and other features.
Messages and Return Codes
DMSFSE001E No input data file was specified. RC=24
DMSFSE003E "string" is not an option. RC=24
DMSFSE029E No argument specified for the "option" option. RC=24
DMSFSE054E Incomplete fileid beginning with "string". RC=24
DMSFSE066E "PROMPT" and "REPEAT" are set to the same character. RC=24
DMSFSE070E "string" is not a valid parameter. RC=24
DMSFSE104S Error n occurred while reading the file "file". RC=100
Section 2: Command Descriptions 108
CMS Reference
GATHER (EXEC)
Use the GATHER command to create a printer spool file from one or more
files in your reader, retaining the original carriage control
information.
+--------------------------------------------------------------------+
| | |
| GATHER | [spoolid...] |
| | |
+--------------------------------------------------------------------+
where
spoolid is one or more spool file numbers. The specified reader
files will be combined into a single print file. If no
spoolid's are specified, all of your PRT (print) and CON
(console) reader files (except those in hold) will be
gathered.
Usage Notes
1. The file created by the GATHER command is sent to the current
printer destination set with the SETPRT command. The name of the
print file will be the name of the first reader file in the
group.
2. GATHER processes only PRT (print) and CON (console) files. It
can't handle PUN, DMP, or RDR files.
3. GATHER is an EXEC and uses the REPRINT command to process the
reader files.
Messages and Return Codes
DMSGAT920E No files in reader. RC=28
DMSGAT920E File [nnnn] does not exist or is in hold. RC=28
DMSKXR070E "string" is not a valid parameter. RC=24
Section 2: Command Descriptions 109
CMS Reference
GETFMODE
| Use the GETFMODE command to put the next available filemode letter
| into a REXX or EXEC 2 variable. The format of the command is:
+--------------------------------------------------------------------+
| | |
| GETFMODE | variable |
| | |
+--------------------------------------------------------------------+
where
| variable is the name of a REXX or EXEC 2 variable. (For EXEC 2, do
not include the initial ampersand in the variable name. If
the name begins with an ampersand, the value of the variable
is used as the variable name.)
Usage Notes
GETFMODE puts the first available filemode letter into the specified
variable. Searching begins with mode A and continues through Z. If
all filemode letters are in use the variable is not set and a non-zero
return code is set.
Messages and Return Codes
If an error occurs, the return code is set to the message number:
| UKCGFM100E GETFMODE can only operate when called from REXX or EXEC 2.
UKCGFM102E Error accessing variable "name".
UKCGFM103E No variable name was specified.
UKCGFM105E Unable to set result variable.
UKCGFM106E No filemodes are available.
Section 2: Command Descriptions 110
CMS Reference
GETVADDR
| Use the GETVADDR command to put the next available virtual device
| address into a REXX or EXEC 2 variable.
+--------------------------------------------------------------------+
| | |
| GETVADDR | variable |
| | |
+--------------------------------------------------------------------+
where
| variable is the name of a REXX or EXEC 2 variable. (For EXEC 2, do
not include the initial ampersand in the variable name. If
the name begins with an ampersand, the value of the variable
is used as the variable name.)
Usage Notes
GETVADDR puts the first available virtual device address into the
| specified variable. Searching begins with address 195 and continues
| through FFF. If all addresses in the range are in use the variable is
not set and a non-zero return code is set.
Messages and Return Codes
If an error occurs, the return code is set to the message number:
| UKCGVA100E GETVADDR can only operate when called from REXX or EXEC 2.
UKCGVA102E Error accessing variable "name".
UKCGVA103E No variable name was specified.
UKCGVA105E Unable to set result variable.
UKCGVA106E No device addresses are available.
Section 2: Command Descriptions 111
CMS Reference
| GRIPE (EXEC)
Use the GRIPE command to prepare a note for transmission to the UKCC
User Services Group.
+--------------------------------------------------------------------+
| | |
| GRIPE | |
| | |
+--------------------------------------------------------------------+
Usage Note
GRIPE uses the NOTE command to create and transmit your message.
Section 2: Command Descriptions 112
CMS Reference
HELP
The HELP command displays detailed documentation for commands,
explanations of CMS and CP messages, and other information.
+--------------------------------------------------------------------+
| | |
| Help | [topic] |
| | |
+--------------------------------------------------------------------+
where
topic is the name of the topic you are interested in. This can be
a command name, a message identifier, or a general topic.
If you don't specify a topic, HELP displays a menu of
topics.
Usage Notes
| 1. By default, the HELP command uses the Yale HELP (YHELP) system.
| If you want to use the standard IBM HELP command, then enter
| "YHELP OFF" to disable YHELP. The HELP information supplied with
| CMS cannot be displayed with the IBM HELP command, but you can
| use it to display your own HELP files.
| 2. HELP information is available for all commands and error
| messages. To display information about a message, enter only the
| first three letters of the prefix (usually DMS or DMK), the
| three-digit number, and the final letter (E, W, S, etc.). Use
| the EXPLAIN command for information about the most recent error
| message.
| If you want information about a command that exists in several
| environments (like QUERY, which can be CMS, CP, or XEDIT), you
| may need to specify the environment name on the HELP command
| ("HELP CP QUERY," for example). XEDIT subcommands require that
| XEDIT be specified ("HELP XEDIT SET PREFIX") unless the HELP
| command is entered from XEDIT.
| 3. The RH (Resume HELP) command can be used to return to where you
| left off in the HELP system during a terminal session.
| 4. HELP information is preformatted and kept in files with a
| filetype beginning "HELP." If you want to create your own HELP
| information files, consult the information available online from
| the HELP command.
Section 2: Command Descriptions 113
CMS Reference
| HI (CMS Immediate Command)
Use the HI (Halt Interpretation) command to stop all currently
executing REXX and EXEC 2 programs and macros. HI halts execution
without destroying the environment as HX (Halt Execution) does.
+--------------------------------------------------------------------+
| | |
| HI | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. HI is useful for stopping an XEDIT macro without terminating
XEDIT.
2. In a REXX program you can use a SIGNAL ON HALT statement to trap
the HI interruption.
3. CMS immediate commands are only accepted from the terminal. They
may not be issued from an EXEC. In some cases it may be
necessary to cause an attention at the terminal before issuing an
immediate command.
4. The SET IMMEDIATE command can be used to disable the CMS
immediate commands. QUERY IMMEDIATE to determine the current
setting. The initial setting is SET IMMEDIATE ON.
Messages and Return Codes
One of these messages is usually produced as a result of HI:
DMSEXE085E ERROR IN [fileid], LINE [n] - PROGRAM INTERRUPTED.
DMSREX452E Error 4 running [fileid], line [n]: Program interrupted
Section 2: Command Descriptions 114
CMS Reference
HOSTCM (EXEC)
Use the HOSTCM command to communicate with a personal computer system
that is acting as your CMS terminal. The personal computer must be
running the Waterloo Computing Systems microSoftware. HOSTCM and the
microSoftware support two-way file transmission and allow CMS disk
files to be accessed by programs running on the personal computer
system.
+--------------------------------------------------------------------+
| | |
| HOSTCM | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. The Waterloo Computing Systems microSoftware is currently
available for the IBM Personal Computer, the Commodore SuperPET,
and the Northern Digital microWAT. An editor and a number of
language processors (APL, BASIC, COBOL, FORTRAN, and Pascal) are
available for these systems. HOSTCM allows programs running on
these systems to read and write CMS disk files, and to pass
commands to CMS.
2. Terminate HOSTCM by entering "QUIT" at your terminal.
3. More information is available in the section on asynchronous
ASCII communications. Detailed specifications for HOSTCM are
available online from the MANUAL command.
| 4. The KERMIT command also performs most of the functions of HOSTCM.
Section 2: Command Descriptions 115
CMS Reference
HT (CMS Immediate Command)
Use the HT (Halt Typing) command to suppress terminal output from a
CMS command.
+--------------------------------------------------------------------+
| | |
| HT | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. Execution of the command continues and you can use the RT (Resume
Typing) command to resume normal terminal output. The HT command
is only in effect for the duration of the current command. The
ready message is displayed when the command completes.
2. CMS immediate commands are only accepted from the terminal. They
can not be issued from an EXEC. In some cases it may be
necessary to cause an attention at the terminal before issuing an
immediate command.
3. The SET CMSTYPE HT command can be used from within an EXEC to
halt terminal output. Terminal output will be suppressed until
the end of the EXEC, or until enabled with an RT or SET CMSTYPE
RT command.
4. Severe error messages (severity code S or T) are not suppressed
by HT.
5. The SET IMMEDIATE command can be used to disable the CMS
immediate commands. QUERY IMMEDIATE to determine the current
setting. The initial setting is SET IMMEDIATE ON.
Section 2: Command Descriptions 116
CMS Reference
HX (CMS Immediate Command)
Use the HX (Halt Execution) command to stop the execution of a CMS
command.
+--------------------------------------------------------------------+
| | |
| HX | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. Execution of the command terminates immediately. Output to the
terminal will continue until the output buffers have been
emptied. HX will also close all open files and clear existing
FILEDEF definitions (including those made with the PERM option).
Entering HX from CMS Subset terminates the command from which
Subset was entered (XEDIT, for example) and returns to normal CMS
mode.
| The HI (Halt Interpretation) command stops all currently
| executing REXX and EXEC 2 programs and macros without destroying
| the environment. For example, HI will stop an XEDIT macro
| without terminating XEDIT.
2. CMS immediate commands are only accepted from the terminal. They
may not be issued from an EXEC. In some cases it may be
necessary to cause an attention at the terminal before issuing an
immediate command.
3. The SET IMMEDIATE command can be used to disable the CMS
immediate commands. QUERY IMMEDIATE to determine the current
setting. The initial setting is SET IMMEDIATE ON.
Messages and Return Codes
Some commands and programs may produce a message when halted with HX.
Section 2: Command Descriptions 117
CMS Reference
INPUT
Use the INPUT command to copy a reader spool file to a CMS disk file.
The ACCEPT command is a more general way of performing this function.
+--------------------------------------------------------------------+
| | + + |
| INPUT | |spoolid [* [fm [fn [ft]]]]| [( options... [)]] |
| | |name [type [fm [fn [ft]]]]| |
| | | * * A1 = = | |
| | + + |
| | |
| | Options: |
| | |
| | + + + + + + + + |
| | |Disk | |All | |Nohold| |NOCc | |
| | |APpend | |Data | |Hold | |CCPrint| |
| | |Replace| |Jcl | + + |CCPrt | |
| | |DStack | |Log | |Cc | |
| | |Xedit | |NOJcl| + + |
| | |SELect | |NOLog| |
| | + + + + |
| | |
| | + + + + |
| | |Truncate n| |RECfm V| [NOMsg] [Stack] |
| | |SPLit n | | F| |
| | + + + + |
+--------------------------------------------------------------------+
where
spoolid is the spool file number of the reader spool file to be
processed. The default is "*", the first file in your
reader.
name [type]
are used to specify an input file by spool file name and
type rather than number. Spool files do not necessarily
have names and types. The default type is "*," the first
file that matches the specified name.
fm is the filemode used for the output file. If omitted, the
default is "A1."
fn is the filename used for the output file (if any). If
omitted, the default is "=," which will use the spool file
name.
ft is the filetype used for the output file (if any). If
omitted, the default is "=," which will use the spool file
type.
Section 2: Command Descriptions 118
CMS Reference
INPUT
Options
All copies the entire input file without OS batch output
editing. This is the default.
APpend appends the output data to an existing CMS disk file. If
the file does not exist, it is created.
Cc retains the carriage control information from the input
file. The carriage control information placed into the
output will be American National Standard (ANS) carriage
| control characters added at the beginning of each line
| (refer to the PRINT command for a description of these
characters). Lines containing only carriage control
information may be generated. Carriage control will be
generated for input files that do not contain it already. A
file created with this option can be printed with the CC
option of the CMS commands PRINT and TPRINT.
CCPrint retains the carriage control information from the input file
if the input file is a print (PRT) file. Other files are
read as is, and no carriage control is generated.
CCPrt is a synonym for CCPRINT.
Data can be specified when the input file is printed output from
an OS batch job. DATA excludes the JCL, system messages,
accounting box, and HASP log to be excluded from the output.
DATA is the same as NOJCL and NOLOG.
DIsk writes the output into a CMS disk file. This is the
default.
DStack stacks the input spool file. The first line in the stack
will be a line in the format produced by the STACK option,
followed by the lines of data. The stack has a limited
capacity, and execution stops if the entire file cannot be
stacked. Part of the file may be stacked, and the header
line may be missing. DSTACK implies ALL and STACK.
Hold retains the file in the reader when processing is complete.
Jcl includes JCL, system messages, and the accounting box in the
output. This option is for use with output from an OS batch
job.
Log includes the HASP system log in the output. This option is
for use with output from an OS batch job.
NOCc ignores carriage control in the input file. This is the
default.
Section 2: Command Descriptions 119
CMS Reference
INPUT
Nohold purges the file from the reader when processing successfully
completes. This option is ignored if an error occurs during
processing. This is the default.
NOJcl excludes JCL, system messages, and the accounting box from
the output. This option is for use with output from an OS
batch job.
NOLog excludes the HASP system log from the output. This option
is for use with output from an OS batch job.
NOMsg suppresses the message that is normally issued to describe
the selected input reader spool file.
RECfm x specifies the record format of the CMS disk file created.
The default is RECFM V, which produces a file with variable-
length records. You can specify RECFM F to create a file
with fixed-length records. The RECFM option is ignored when
the output is appended to an existing file.
Replace writes the output into a CMS disk file, replacing an
existing file.
SELect suppresses data output. This is used to determine if the
specified reader file exists and may be used with the STACK
option in an EXEC to identify the next file to be processed.
The selected file becomes the first file in the reader.
SPlit n breaks output lines into one or more additional lines at the
specified column. The minimum column is two when NOCC is in
effect, three when CC is in effect.
Stack stacks a line in the following format:
* fn ft fm NOCC spool-number spool-type origin
CC
If message 922I (empty output file) is issued, an empty line
is stacked. If errors are found in the command parameters
or options, or if the input file is not found, or if no
output disk is available, the line is not stacked.
Truncate n
truncates the output lines to the specified length. The
minimum length is one when NOCC is in effect, two when CC is
in effect.
Xedit passes output lines to XEDIT. No disk storage is used.
This option may only be specified from XEDIT. The XEDIT
option implies ALL, CCPRINT, and NOMSG. Refer to the XEDIT
macro RINPUT for more information.
Section 2: Command Descriptions 120
CMS Reference
INPUT
Usage Notes
1. If you specify the HOLD option to retain a reader spool file, be
certain to purge the file when it is no longer needed. Reader
files are purged with the "BURN nnnn" command ("nnnn" is the
spool file number). You are charged for each spool file based on
its size and age. VM/SP automatically purges spool files when
they are one week old.
2. If the spool file is output from an OS batch job, its spool file
name will be the job name, and the spool file type will be the
runid.
3. Unless otherwise specified, the disk file created by the INPUT
command is given a filename and filetype to match the spool file
name and type of the input file. If the spool name and type are
not valid as a CMS fileid, the filename will be the kind of file
processed ("PRT," "PUN," or "CON"), and the filetype will be
"FILE." Some errors cause the name "INPUT CMSUT1" to be used for
the output file.
4. If the input file is a print or console spool file, the CMS disk
file can contain lines up to 151 bytes long. Punch spool files
can contain lines up to 80 bytes long.
5. Unless NOMSG is specified INPUT displays a message in the
following format when a file is selected for processing:
FILE nnnn type x mm/dd/yy hh:mm:ss nnn RECORDS; name1 name2
nnnn is the spool file number,
type x is the spool type and class, such as "PRT A",
mm/dd/yy is the creation date,
hh:mm:ss is the creation time,
nnn RECORDS is the number of input lines,
name1 is the spool file name, and
name2 is the spool file type.
If the input file is printed output from an OS batch job, the
accounting line from the end of the job will also be displayed.
6. Held spool files cannot be processed by INPUT. Attempting to
INPUT a held spool file will result in message 920E (reader file
not found) being issued.
7. If message 922I (no output lines) is received, try the command
again without editing options (JCL, LOG, NOJCL, and NOLOG).
8. A successfully selected file is ordered to the front of the
reader files if it is retained (HOLD or SELECT specified).
Section 2: Command Descriptions 121
CMS Reference
INPUT
Messages and Return Codes
DMSINP003E Invalid option "option". RC=24
DMSINP024E File "fn ft fm" already exists -- erase or specify
"REPLACE". RC=28
DMSINP029E Invalid parameter "xxx" in the RECFM option. RC=24
DMSINP066E Only one output destination may be specified. RC=24
DMSINP069E Disk "mode" not accessed. RC=36
DMSINP070E Invalid parameter "parameter". RC=24
DMSINP105S Error "nn" writing file "fn ft fm" to [disk|xedit].
RC=100
DMSINP702I Reader file name not a valid disk fileid. following
Id assumed:
DMSINP702I Input cmsut1 fm
DMSINP920E Reader file "id1 id2" not found. RC=28
DMSINP922I No output lines. Reader file retained.
DMSINP935E Bad reader spool block. RC=100
DMSINP942E XEDIT option can only be specified under XEDIT. RC=88
DMSINP946E I/O error (description) from device at address xxx.
RC=100
DMSINP949E Files of type [type] cannot be processed by input. RC=25
DMSINP985E Insufficient storage to stack more data. RC=25
Section 2: Command Descriptions 122
CMS Reference
IPL (CP)
Use the IPL command to simulate an Initial Program Load function.
This command is ordinarily issued automatically when you log on, and
need not be used again except in unusual circumstances. This is a
summary of the most frequently needed and function of the IPL command,
not a complete description.
+--------------------------------------------------------------------+
| | |
| Ipl | system [PARM [parameters...]] |
| | |
+--------------------------------------------------------------------+
where
system is the name of the system to be loaded. You will normally
specify "CMS."
PARM parameters
specifies up to 64 bytes of parameters to be passed to the
loaded system. All of the characters on the command line
after the keyword "PARM" (excluding the first blank) are
treated as data. The only parm that you might want to use
with CMS is "AUTOCR," which suppresses the initial CMS
prompt.
Usage Notes
1. IPL simulates the LOAD button or function found on the console of
real Central Processing Units.
2. If the IPL is successful the loaded system will respond. The
first response from CMS is a line that describes the current
version and prompts you to press ENTER or RETURN.
Section 2: Command Descriptions 123
CMS Reference
| KERMIT
Use the KERMIT (KL10 Error-free Reciprocal Micro Interface Transfer)
command to communicate with a personal computer or other system that
is acting as your CMS terminal. The other system must be running its
version of KERMIT. KERMIT supports two-way file transmission.
+--------------------------------------------------------------------+
| | |
| KERMIT | |
| | |
+--------------------------------------------------------------------+
KERMIT Subcommands
CMS ... issues the specified CMS command.
CP ... issues the specified CP command.
EXIT ends KERMIT and returns control to CMS.
HELP displays a list of KERMIT commands.
QUIT is a synonym for EXIT.
RECEIVE receives a file or group of files from the remote system.
If an incoming fileid is not legal an attempt is made to
transform it to a similar legal name. If the file already
exists, KERMIT appends the new file to the existing file if
their record formats are the same.
SEND fileid
sends a file or group of files to the remote system. The
names of the files are passed to the other system so that it
can store them with the same names. Wildcard characters (*)
are allowed in the fileid.
SET sets various parameters, such as maximum packet length,
logical record length, record format, etc.
SHOW displays the current setting of the SET command parameters.
STATUS displays information about the previous file transfer.
Usage Note
More information is available in the section on asynchronous ASCII
communications. Detailed specifications for KERMIT are available
online from the MANUAL command.
Section 2: Command Descriptions 124
CMS Reference
| KYREG (EXEC)
Use the KYREG command to examine this month's Kentucky Register, the
Computing Center's monthly newsletter. The online edition is the
complete Register, with the exception of the statistics and
illustrations.
+--------------------------------------------------------------------+
| | + + |
| KYREG | |Browse| |
| | |Xedit | |
| | |Type | |
| | + + |
+--------------------------------------------------------------------+
where
Browse| displays the Register with the BROWSE command (for
3270-type display terminals only). BROWSE is the default
for 3270 displays.
Type types the Register on your terminal.
Xedit displays the Register with XEDIT. This is the default if
you are not using a 3270 display.
Messages and Return Codes
DMSREG002E Sorry, the newsletter is not available at this time. RC=28
DMSREG070E Missing or invalid parameter. RC=24
Messages and return codes can also be produced by the CMS commands
BROWSE, TYPE, and XEDIT.
Section 2: Command Descriptions 125
CMS Reference
LABELS (EXEC)
Use the LABELS command to print labels at your terminal, or produce a
spool file for printing.
+--------------------------------------------------------------------+
| | + + |
| LABELS | filename [( |Print| [Copies n] [Route dest] [)]] |
| | |Prt | [Forms x] |
| | + + |
| | |
| | filename [( Terminal [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the name of a SCRIPT file containing the information for
the labels. The filetype of this file must be "SCRIPT."
Options
Copies n is a SETPRT option that specifies the number of copies to be
printed. Multiple copy requests are ignored for output
routed HOT (labels cannot be printed on the HOT printer).
The maximum value is 255, the default value is 1. This
option is ignored in TERMINAL mode (repeat the LABELS
command for additional copies).
Forms x is a SETPRT option that specifies the forms to be used for
printing. For output routed CENTRAL the default forms are
LT (3 1/2 by 15/16 inch labels with the mixed case print
train). FORMS 5106 may be specified for labels with
uppercase-only printing. Output not routed CENTRAL should
not use FORMS LT or 5106. All output routed HOT is forced
to standard forms, and remote sites should be consulted in
advance before requesting any special forms. An additional
charge to pay for the labels is added to the printing cost
for output using LT or 5106 forms.
Print sends the output to be printed. The default routing is
CENTRAL, which will cause the labels to be printed in the
UKCC Computer Room. If you are using the PRINT mode you may
also specify options for the SETPRT command. PRINT is the
default.
Prt is a synonym for PRINT.
Terminal types the labels on the terminal.
Section 2: Command Descriptions 126
CMS Reference
LABELS (EXEC)
Route dest
is a SETPRT option that specifies the destination of the
printed output when using PRINT mode. Output may be routed
to the HOT printer at the UKCC, to a HASP remote site
(RMTnn), to an RSCS site (Pnnnn), or CENTRAL (the default).
Only standard forms are available on the HOT printer.
Usage Notes
1. The LABELS command is not compatible with the Waterloo SYSLABEL
macro package. Refer to the Waterloo SCRIPT User's Guide for a
description of SYSLABEL.
2. The labels used at the UKCC, designated form LT or 5106, are
3 1/2 by 15/16 inches. This allows five lines of 34 characters
on each label, with a single line space between the labels (this
assumes printing 6 lines/inch and 10 characters/inch). When
printing labels at a terminal you should use labels of the same
vertical size.
3. A copy for proofreading purposes may be printed by specifying the
"FORMS STD." and "SPACE S" options. This will cause the label
data to be printed on standard forms. If you specify ROUTE HOT,
standard forms will always be used. When SPACE S is used the
label data will be printed without intervening blank lines.
SPACE W will cause the data for each label to print on a separate
page.
4. LABELS will use the SCRIPT command to process the file containing
the label information. This file should contain the data for the
labels (up to five lines each) separated by a blank line. A
blank line will cause the text on the following line to print at
the top of a new label. Use the SCRIPT control word .SP to
include blank lines within the text on a label. You can cause
all blank input lines to print as blank output lines by placing
the following line at the beginning of your file:
.dm nl /.sp/
If you use this method, you must place a .PA control word before
the data for each label, or provide exactly five lines of data
followed by a single blank line for each label. Your file may
contain SCRIPT control words, but the page length and heading and
footing definitions should not be altered. Control words named
.NM and .PH are defined and are currently treated as comments.
These control words may be used at a later date as part of a
mailing and telephone list system.
5. When in PRINT mode, LABELS will use the SETPRT command to set the
FORMS, ROUTING, and other options. The destination userid (TO
Section 2: Command Descriptions 127
CMS Reference
LABELS (EXEC)
option) is not changed. A print file containing labels may be
sent to your reader; such a file may be printed with the OUTPUT
command using the LABELS option.
Messages and Return Codes
DMSLAB001E You must specify a filename. RC=24
DMSLAB002E File "fn SCRIPT" could not be found. RC=28
DMSLAB070E Extraneous parameters follow the filename. RC=24
Messages and return codes may also be produced by the SCRIPT and
SETPRT commands.
Section 2: Command Descriptions 128
CMS Reference
| LEDIT
Use the LEDIT command to edit files which are too large for
conventional editors like XEDIT. It is also much faster than XEDIT
when you need to only make a few changes to a large file. LEDIT has
some limitations, so check the Usage Notes before you use it. Changes
made with LEDIT are written to the file as soon as you press the ENTER
key. LEDIT can be used only on 3270 display terminals.
+--------------------------------------------------------------------+
| | |
| LEDIT | filename [filetype [filemode]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the file to be edited.
filetype is the filetype of the file to be edited. "*" is the
default.
filemode is the filemode of the file to be edited. "*" is the
default.
LEDIT Subcommands
n moves down n lines toward the end of the file.
+n moves down n lines toward the end of the file.
-n moves up n lines toward the top of the file.
:n makes line n the current line.
/string locates the next occurrence of the specified string.
= re-executes the last subcommand.
ADD [TOP] [n]
adds "n" lines after the current (highlighted) line or at
the top of the file. The ADD subcommand is relatively
expensive. If you are adding several lines to a large file,
you should use the MARK subcommand.
BAckward scrolls back one screen toward the top of the file.
Bottom makes the last line in the file the current line.
Section 2: Command Descriptions 129
CMS Reference
| LEDIT
CASE [U|M]
controls the way mixed-case letters are handled. CASE M
(the default) allows mixed-case letters. String searches
must match the case in this mode. When you are in CASE U,
all data entered will be translated to upper case before any
changes are made to the file and before any subcommands are
interpreted.
Change/string1/string2/
changes "string1" to "string2" on the current line. The
strings must be the same length.
CMS ... executes the specified CMS command. The command must be
valid in CMS subset. If no command is specified, CMS subset
mode is entered.
CURline n sets the current line position on the screen. The default
is a line near the middle of the display.
DELete [n|*]
deletes one or more lines, beginning at the current line.
The DELETE subcommand is relatively expensive. If you are
deleting several lines from a large file, you should use the
MARK subcommand.
Down [n] moves down n lines toward the end of the file.
FOrward scrolls forward one screen toward the end of the file.
Help displays this information with the CMS HELP command.
HEX displays the current line in hexadecimal and EBCDIC. Non-
displayable characters appear as dots.
INFo types a brief description of the file, including the number
of data blocks, and the date and time it was last updated.
LAST displays the last full screen of data in the file. The
current line will be adjusted based on the CURLINE setting
and the number of lines on the screen.
LEFT n moves the display n characters to the left. This is only
useful when the file has lines longer than will fit on one
display line.
LRECL n increases the logical record (line) length of a file with
variable-length records.
MARK [n|ADD|DEL|CAN]
is used when several lines are to be added or deleted.
Enter MARK when a line to be marked is the current line, or
Section 2: Command Descriptions 130
CMS Reference
| LEDIT
press PF11 when the cursor is on a line to be marked.
Entering MARK DEL will delete all marked lines. MARK ADD
will add a line after each marked line. MARK CAN will un-
mark all marked lines. You can use QUERY MARK to determine
which lines are currently marked.
Menu is the same as HELP.
Next [n] is a synonym for DOWN.
Query [CASE|CURline|LRECL|MARK|Verify|Zone]
displays current settings.
QUIT ends LEDIT. Unlike most editors, this does not cause
changes to be discarded since all changes are written to
disk as they are made.
Right n moves the display n columns to the right. This is only
useful when the file has lines longer than will fit on one
display line.
SERial [*|n [*]]
causes serial numbers to be written if the file contains
fixed-length, eighty-byte records. The increment may be
specified as n (the default is 10). If "*" is not
specified, the first three characters of the filename are
placed in columns 73 through 75, and the default increment
is 1000. The first line of the file is numbered n.
Top makes the first line in the file the current line.
TYpe [n] types n lines from the file.
Up [n] moves up n lines toward the top of the file.
Verify n makes column n the first column displayed on the screen.
This can only be used if the file contains lines longer than
the display lines.
XC string1 string2
will change string1 to string2 on the current line. Both
strings must be the same length and are specified in
hexadecimal.
XL string locates the specified string (specified in hexadecimal).
Zone n m are the starting and ending columns for the locate
functions.
Section 2: Command Descriptions 131
CMS Reference
| LEDIT
Program Function (PF) Keys
PF1 Displays this information.
PF2 Adds a line to the file following the cursor.
PF3 Ends LEDIT.
PF4 Tabs forward 10 spaces.
PF5 Tabs backward 10 spaces.
PF6 Discards changes typed on the screen since ENTER was pressed.
PF7 Scroll up towards the top of the file.
PF8 Scroll down towards the bottom of the file.
PF9 Reuse last subcommand.
PF10 Make the line under the cursor the current line.
PF11 Mark the line under the cursor.
PF12 Move the cursor to the beginning of the current line.
Usage Notes
1. Non-displayable characters are represented on the screen by dots.
Any non-displayable characters on a line will be changed to dots
if the line is changed.
2. You cannot change the length of a line in the file, even if the
file contains variable-length records. LEDIT does not remove
trailing blanks from lines.
3. The verify columns refer to the columns of the file which are
being displayed on the screen. For example, VERIFY 1 displays
columns 1 through 79. The VERIFY, RIGHT, and LEFT subcommands
affect the verify columns.
4. Most PF keys cause changes typed on the screen to be discarded.
That is, if you make changes to the screen and then press any PF
key (except PF4, PF5, and PF12) the changes are lost. Changes
are actually saved when you press ENTER.
Messages and Return Codes
DMSLED001E No filename specified. RC=1
DMSLED004E File not found. RC=28
DMSLED012E Disk filemode is read-only. RC=12
DMSLED013E Disk filemode is full. RC=13
DMSLED030E Work file $LEDIT$ $LEDIT$ exists. Erase before using
LEDIT. RC=32
DMSLDT104S Error n reading from disk. RC=100
DMSLDT105S Error n writing to disk. RC=100
DMSLED109S Not enough storage. RC=104
Section 2: Command Descriptions 132
CMS Reference
LINK (CP)
Use the LINK command to gain access to a minidisk belonging to another
user (if the other user has authorized the link with AUTOLINK). The
CMS command ACCESS must be used after LINK to identify the new
minidisk to CMS.
+--------------------------------------------------------------------+
| | |
| LINK | [To] userid disk1 [As] disk2 [level] |
| | |
+--------------------------------------------------------------------+
where
[To] userid
is the userid whose minidisk "disk1" is to be linked. You
may use an asterisk to refer to your own userid.
disk1 is the virtual device address of the minidisk. This is the
address that user "userid" uses to refer to the minidisk.
Virtual device addresses are expressed as three-digit
hexadecimal values.
[As] disk2
is the virtual device address you will use to refer to the
minidisk. This address must not already be defined in your
userid. The virtual device address that you assign may be
any unused value up to 5FF (hexadecimal).
level is the kind of link requested. Links may be read-only or
read/write. You may request a primary and secondary level;
the secondary will be used if the primary link fails. In
order for any link to succeed, the userid that owns the
minidisk must have authorized you to link at the level you
are requesting. The following levels may be requested:
Level Meaning
R Read-only. Fails if another user has a write-link
to the minidisk. This is the default when linking
to a minidisk that belongs to another userid.
RR Read-only. Disregards existing links.
W Write. Fails if another user has any link to the
minidisk.
WR Write or read. Read-link is made if another user has
a link to the minidisk.
M Write. Fails if another user has a write-link.
MR Write or read. Read-link is made if another user has
a write-link.
MW Write. Disregards existing links. If two or more
users have write-links to the same minidisk, the disk
file directory may be corrupted and the files lost.
Section 2: Command Descriptions 133
CMS Reference
LINK (CP)
Usage Notes
1. Links made with the LINK command last only until you log off, or
are logged off by the system. You can drop a link with the DROP
command.
2. An example may clarify the way links can be used. Suppose the
files on user XYZ101's A-disk (191) were to be shared with XYZ102
and USR101. User XYZ101 would first use AUTOLINK to authorize
the links:
autolink auth 191 r user xyz102 | user usr101
This need only be done once. Users XYZ102 and USR101 would issue
the following commands to make the files on XYZ101's A-disk
available to them:
link xyz101 191 193 rr
access 193 b/a
XYZ101's 191 (A-disk) would then be available as 193 (B-disk) to
XYZ102 and USR101. These commands could be placed in a PROFILE
EXEC.
3. CMS supports only simultaneous read-access sharing of minidisks.
If two or more users simultaneously have write-access to the same
minidisk the disk file directory will almost certainly be
corrupted and the files on the minidisk permanently lost.
| 4. If a user with write-access to a minidisk updates a file and
| other users with read-access then try to read that same file, the
| other users will get the older version of the file, garbled
| records, or CMS file system errors (most often DMSxxx104S: "ERROR
| 3 READING FILE"). The users with read-access should issue the
| ACCESS command again to read the updated file directory. Using
| filemode number 6 for shared files can eliminate this problem in
| some applications.
5. All CJS users have a minidisk at virtual address 191 (the default
A-disk), and some users also have a minidisk at 192 (the default
D-disk). All users share (read-access) several CMS system
minidisks, including some or all of 190, 19C, 19D, and 19E. OS
volumes occupy virtual device addresses in the 120's. Other
virtual devices generally occupy addresses below 100. Unused
addresses in the 19x range should be used first when making links
to other users minidisks.
6. You can use the CP command QUERY LINKS to determine which users
have links to one of your minidisks. For example:
q links 191
Section 2: Command Descriptions 134
CMS Reference
LINK (CP)
7. Refer to the descriptions of the ACCESS and AUTOLINK commands for
more information about sharing CMS disk files.
Messages and Return Codes
| If a numbered message is issued, the return code is set to the message
number; otherwise, the return code is zero.
DASD disk2 LINKED R/O
DASD disk2 LINKED R/W
DASD disk2 LINKED R/O; R/W BY [n USERS[; R/O BY n USERS]]
DASD disk2 LINKED R/W; R/O BY [n USERS]
DASD disk2 LINKED R/W; R/W BY [n USERS[; R/O BY n USERS]]
DMKLNC999E userid disk1 NOT LINKED; NOT AUTHORIZED
DMKLNC999E userid disk1 NOT LINKED; LOCKED BY owner SINCE time
DMKLNC999E userid disk1 NOT LINKED; AUTOLINK UNAVAILABLE
DMKLNC999E userid disk1 NOT LINKED; AUTOLINK QUIESCED
DMKLNC999E userid disk1 NOT LINKED; AUTOLINK BUSY -- TRY AGAIN
DMKLNC999E userid disk1 NOT LINKED; AUTOLINK SHUTDOWN/REIPL IN
PROGRESS -- TRY LATER
DMKLNK020E USERID MISSING OR INVALID
DMKLNK022E disk MISSING OR INVALID
DMKLNK052E ERROR IN CP DIRECTORY
DMKLNK053E userid NOT IN CP DIRECTORY
DMKLNK101W DASD disk2 FORCED R/O; R/O BY nnn USERS
| DMKLNK103W DASD disk2 FORCED R/O; R/W BY nnn USERS
| DMKLNK106E userid disk1 NOT LINKED[; R/W BY nnn USERS]
| [; R/O BY nnn USERS]
DMKLNK116E USERID userid NOT LINKED; CP DIRECTORY IN USE
Section 2: Command Descriptions 135
CMS Reference
| LISP
An experimental partial implementation of the Utah LISP interpreter is
available under CMS. It is not supported.
+--------------------------------------------------------------------+
| | |
| LISP | [filename] |
| | |
+--------------------------------------------------------------------+
where
filename is the name of an input file. The filetype of this file
must be "LISP," and it must contain fixed-length, 80-byte
records. If no filename is given, input and output will use
the terminal.
Usage Notes
1. Some internal LISP functions are available:
PRBUFFER(T) causes input records to be printed.
VERBOS(NIL) suppresses garbage collection messages.
2. LISP uses OS simulation input and output. The following DD names
are defined by default:
LISPIN Input (disk or terminal)
LISPOUT Printed Output (disk or terminal)
3. Some additional information about the OS version of the Utah LISP
interpreter is available in the UKCC Consulting Room in McVey
Hall.
Section 2: Command Descriptions 136
CMS Reference
LISTDS
Use the LISTDS command to display information about data sets residing
on accessed OS disks.
+--------------------------------------------------------------------+
| | + + |
| LISTDS | |dsname| fm [(options...[)]] |
| | |? | |
| | + + |
| | |
| | Options: |
| | |
| | + + + + |
| | |FOrmat| |PRINT| [LIKE root] |
| | |PDS | |STACK| |
| | |EXtent| + + |
| | |FREE | |
| | + + |
+--------------------------------------------------------------------+
where
dsname is an OS data set name. The qualifiers may be separated by
either dots or spaces, and the final qualifier may end with
an asterisk to indicate a matching pattern.
? indicates that the data set name should be read from the
terminal. A prompt will be issued. The data set name must
use dots to separate qualifiers.
fm is the filemode of the disk to be searched for the specified
file. Use an asterisk to search all accessed OS disks.
Options:
EXtent displays the allocated extents for the specified data sets.
FOrmat displays information describing the specified data sets.
FREE displays the free space extents on the specified OS volume.
You may not specify a dsname when you use the FREE option.
LIKE root is used with the PDS option to restrict the display to
members with names beginning "root".
PDS displays the names of the members in the specified
partitioned data sets. The FORMAT option may also be
specified with the PDS option.
Section 2: Command Descriptions 137
CMS Reference
LISTDS
PRINT causes the output of the LISTDS command to be directed to a
spooled print file instead of the terminal.
STACK causes the output of the LISTDS command to be directed to
the CMS program stack instead of the terminal.
Usage Note
Use the OSDISKS command to access the OS volumes containing user data
sets. The first OS volume will be accessed as the H-disk.
Messages and Return Codes
DMSLDS002E Data set not found. RC=28
DMSLDS003E Invalid option "option". RC=24
DMSLDS048E Invalid mode "mode". RC=24
DMSLDS069E Disk "mode" not accessed. RC=36
DMSLDS117E Invalid extent found for "dsname" on "fm" disk. RC=24
DMSLDS221E Invalid data set name. RC=24
DMSLDS222E I/O error reading "dsname" from [fm|OS|DOS] disk. RC=28
DMSLDS223E No filemode specified. RC=24
DMSLDS226E No data set name allowed with FREE option. RC=24
DMSLDS227W Invalid extent found for "dsname" on [fm|OS|DOS] disk. RC=4
DMSLDS231E I/O error reading vtoc from [fm|OS|DOS] disk. RC=28
Section 2: Command Descriptions 138
CMS Reference
LISTX
| Use the LISTX command to obtain specified information about CMS files
| residing on accessed disks. LISTX supports most of the features of
| the LISTFILE command and some additional features.
+--------------------------------------------------------------------+
| | + + + +++ |
| LISTX | |fn |ft |fm||| [(options... [)]] |
| | |* |* |A ||| |
| | + + + +++ |
| | |
| | Options: |
| | |
| | + + + + + + + + |
| | |FName | |Sort Type | |COntrol CMs | |TRace ALl| |
| | |FType | | Name | | OFf | | ERr| |
| | |FMode | | Dtype | | ALl | | OFf| |
| | |FOrmat| | DName | | ERror | | ON | |
| | |ALloc | | Rtype | | NOMsg | + + |
| | |Date | | RName | | PAck | |
| | |Label | | Brtype| | NOPack| |
| | + + | BRName| | TIme | |
| | + + | NOTime| |
| | + + |
| | |
| | + + + + |
| | |TERMINAL| [DEScend] |Before mm/dd/yy| |
| | |PRint | |AFter | |
| | |Exec | [TODay] |FRom | |
| | |APpend | |THRough | |
| | |DIsk | [SYStem] + + |
| | |STAck | |
| | + + |
| | |
| | + + |
| | |Header | [PREfix nn] [SUFfix nn] |
| | |NOHeader| |
| | + + |
+--------------------------------------------------------------------+
where
fn is the filename or general form of the filename of the files
for which information is to be collected.
ft is the filetype or general form of the filetype of the files
for which information is to be collected.
fm is the filemode or general form of the filemode of the files
for which information is to be collected.
Section 2: Command Descriptions 139
CMS Reference
LISTX
General Forms for File Identifiers
* All values of the specified parameter.
[string]* All values of the specified parameter that begin with the
characters [string].
*[string] All values of the specified parameter that end with the
characters [string].
[string1]*[string2]
All values of the specified parameter that begin with the
characters [string1] and end with the characters [string2].
Question marks in [string1] and [string2] will stand for
non-blank characters only.
A question mark (?) may be imbedded in a fileid parameter to indicate
a character which need not match. If more than one asterisk is
specified in a parameter, then asterisks preceding the final asterisk
will be interpreted as question marks. The last asterisk will be
interpreted as a question mark if it is not the last non-blank
character in the parameter.
A blank as the second character of a filemode specification will
always be interpreted as a question mark. Asterisks in filemode
specifications are always interpreted as question marks.
Fileid specifications may be preceded by a logical not indicator (¬)
which will cause all files matching the specified portions of the
identifier to be excluded from information collection. The indicator
must appear as a separate item on the command line.
Output Format Options
Header includes column headings in the listing. HEADER is the
default when ALLOC, DATE, or LABEL is specified.
NOHeader does not include headings.
COntrol type
causes an "&CONTROL" record to be put at the beginning of
the file created with the EXEC or DISK options. The allowed
values for "type" are:
ALl ERror NOPack OFf TIme
CMs NOMsg NOTime PAck
Only one value may be specified for "type".
Section 2: Command Descriptions 140
CMS Reference
LISTX
TRace type
causes an "&TRACE" record to be put at the beginning of the
file created with the EXEC or DISK options. This will cause
the generated EXEC to be processed by EXEC 2. The values
for "type" are:
ALl ERr OFf ON
Only one value may be specified for "type".
PREfix n controls the number of "&nn" EXEC variables that are placed
before the data on each line of the file created by the
APPEND, DISK, and EXEC options. The default is two.
SUFfix n similar to the PREFIX option, but the variables are placed
after the data.
Output Disposition Options
APpend appends output to a file named "CMS EXEC A1". If the file
does not exist, one will be created.
DIsk creates an output file like the one generated by the EXEC
option, except that PREFIX is given a default value of zero.
Exec creates a file named "CMS EXEC A1" containing one record for
each of the files that satisfy the given file identifier.
The data in each record will be preceded by the number of
EXEC argument tokens specified by PREFIX and followed by the
number specified by SUFFIX. The default value for PREFIX is
two and the default value for SUFFIX is zero.
PRint causes output to be directed to the spooled virtual printer.
STAck causes output to be directed to the CMS program stack.
TERMinal causes output to be directed to the terminal.
The APPEND, DISK, and EXEC options are mutually exclusive. Any other
combinations may be specified.
Information Request Options
Only one information request option may be specified. Each option
includes the information given by the options that precede it on the
list. The options and the information they display are:
FName Filename
FType Filetype
FMode Filemode
Section 2: Command Descriptions 141
CMS Reference
LISTX
FOrmat Record Format and Record Length
ALloc Number of Records and Disk Blocks
Date Date and Time Last Changed
Label Label of the Disk Containing the File
Sorting and Selection Options
Sort type causes the output to be sorted in the specified manner. The
SORT types are:
BRName Block Count, Record Count, Filename, Filetype
Brtype Block Count, Record Count, Filetype, Filename
DName Creation Date, Filename, Filetype
Dtype Creation Date, Filetype, Filename
Name Filename, Filetype
RName Record Count, Filename, Filetype
Rtype Record Count, Filetype, Filename
TIme Creation Date, Time, Filetype, Filename
Type Filetype, Filename
Only one sort type may be specified.
AFter mm/dd/yy
list only those files created after the specified date.
Before mm/dd/yy
list only those files created before the specified date.
FRom mm/dd/yy
list only those files created on or after the specified
date.
THRough mm/dd/yy
list only those files created up to and including the
specified date.
Only one or two date-related selection options may be specified on a
single command. Each part of the date must have two digits.
TODay lists only those files created on the current date. TODAY
may not be specified with any of the other time related
selection options.
SYStem causes the S, X, Y, and Z disks to be searched when a
filemode of "*" is specified.
Usage Notes
Section 2: Command Descriptions 142
CMS Reference
LISTX
1. The creation date is the date (and time) that the file was
created or last modified.
| 2. On EDF disks there are two pseudo-files that are listed by LISTX.
These pseudo-files have filenames that are not valid for CMS
files (eight asterisks), and filetypes of DIRECTOR and ALLOCMAP.
The DIRECTOR represents the space taken by the CMS file directory
on the disk. The ALLOCMAP represents the space taken by the disk
allocation map and will be found only on disks that are write-
accessed. These pseudo-files cannot be examined, altered, or
erased. The date and time on the ALLOCMAP is the time the disk
was last modified (a file was written or erased), and its LRECL
is the physical block size of the disk. The number of records in
the DIRECTOR is the number of files on the disk, including the
ALLOCMAP and DIRECTOR.
| 3. Message 002E (file not found) will not be issued if LISTX is
| invoked from REXX or EXEC 2. The message is issued from EXEC if
| &CONTROL MSG is in effect.
| 4. The output file created by the EXEC and DISK options is limited
| to 80 characters per line.
Messages and Return Codes
DMSLSX002E File not found. RC=28
DMSLSX003E Invalid option -- option. RC=24
DMSLSX022E Invalid '¬' specification. RC=24
DMSLSX029E Invalid control - control. RC=24
DMSLSX029E Invalid sort - sort. RC=24
DMSLSX029E Invalid date - date. RC=24
DMSLSX029E Invalid prefix - prefix. RC=24
DMSLSX029E Invalid suffix - suffix. RC=24
DMSLSX029E Conflicting options - option1 + option2. RC=24
DMSLSX029E PREFIX+DISPLAY+SUFFIX is more than 80 characters. RC=24
DMSLSX062E Invalid fileid - fn ft fm. RC=24
DMSLSX069E A-disk not accessed. RC=36
DMSLSX105E Error n writing cms exec. RC=100+n
Section 2: Command Descriptions 143
CMS Reference
LOGOFF (EXEC)
Use the LOGOFF command to end a terminal session and disconnect from
the VM/SP system.
+--------------------------------------------------------------------+
| | |
| LOGoff | [Yes|No] [Hold] |
| LOGout | |
| | |
+--------------------------------------------------------------------+
where
Hold retains the connection for a switched communication line.
This enables you to log on again without redialing the
system. This parameter has no effect on locally attached
terminals (such as 3270-type displays), or remote terminals
using non-switched communication lines.
No causes your console log to be purged. This parameter has no
effect if you are not spooling your console.
Yes causes your console log to be retained. This parameter has
no effect if you are not spooling your console.
Usage Notes
1. Console spooling is controlled with the SETCON command. If you
are spooling your console and you do not specify YES or NO with
the LOGOFF command, a prompt will be issued to determine the
disposition of the console log.
2. LOGOFF displays a list of your reader spool files (including an
estimate of the charge for each) and asks which, if any, should
be purged.
| 3. LOGOFF displays the cost of your terminal session during the
| current rate period and your current balance (if available).
4. Respond "ESCAPE" to any prompt from the LOGOFF command to cancel
the log off.
Messages and Return Codes
DMSLOG070E "string" is not a valid parameter. RC=24
Messages may also be produced by the BALANCE, COST, CP LOGOFF, PURGE,
and RDRCOST commands.
Section 2: Command Descriptions 144
CMS Reference
LOGON (CP)
Use the LOGON command to identify yourself to the VM/SP system and
begin a terminal session.
+--------------------------------------------------------------------+
| | + + |
| Logon | userid [password] [Mask] [Noipl] |Apl | |
| Login | |APLT| |
| | + + |
+--------------------------------------------------------------------+
where
userid is the identifier assigned to you by the Computing Center.
password is the password you requested to be associated with your
userid. If the password is not specified, a special prompt
with a security mask will be issued to read the password.
It is recommended that the password not be placed on the
command line because it would be visible on your terminal.
Mask specifies that a security mask is desired for entering the
password. This option need not be specified; it is the
default when the password does not appear on the command
line.
Noipl specifies that the automatic IPL command should not be
issued by the system after logon.
Apl indicates that you are logging on with a terminal using the
APL character set and that the TERMINAL APL ON mode should
be in effect immediately. APL should be specified when
using a correspondence or EBCD code terminal (such as an IBM
2741) or a bit-paired ASCII APL code.
APLT indicates that you are logging on with a terminal using the
APL character set and that the TERMINAL APL ON mode should
be in effect immediately. APLT should be specified when
using a typewriter-paired ASCII APL terminal, such as a
DECwriter.
Usage Notes
1. APL is not available under CMS at the UKCC. The APL and APLT
options are provided to support terminals that have only an APL
character set.
2. The LOGON command name may not contain line-editing symbols, but
its operands may use these symbols if needed.
Section 2: Command Descriptions 145
CMS Reference
LOGON (CP)
3. Logging on after a disconnect (because of a hardware malfunction
or the DISCONNECT command) is a called reconnecting. When you
reconnect the system will reset some CP SET and CP TERMINAL
options based on the kind of terminal you are using. You can use
the CP QUERY SET and CP QUERY TERMINAL commands to determine the
current values. The initial values of some CMS SET options will
depend on the type of terminal you are using when CMS is IPL'ed
(this is done automatically when you log on, but not when you
reconnect).
The settings that cause the most trouble are CP TERMINAL
LINESIZE, and CMS SET AUTOREAD and SET BLIP. When using an ASCII
terminal, you will probably want SET AUTOREAD ON and may want SET
BLIP ON. On a 3270-type terminal SET AUTOREAD OFF and SET BLIP
OFF will be more useful.
After reconnecting you may want to re-execute your PROFILE EXEC
if you have one that sets any of these characteristics. To do
this, issue the command "PROFILE" (after entering "BEGIN"), or
"IPL CMS" to reinitialize CMS and execute your profile. If you
intend to continue a terminal session using another kind of
terminal (moving from a 3270-type terminal to an ASCII
typewriter, for example), it may be easier to logoff rather than
disconnect.
4. When you log on or reconnect, the system will display the number
of spool files that you own (if you own any). Reader spool files
may contain notes or files sent to you from other users, or
output from batch jobs.
5. The UKCC CMS User's Guide contains more information about logging
on.
Responses
ENTER PASSWORD:
LOGMSG - hh:mm:ss zone day mm/dd/yy
* online news banner
FILES: n RDR, n PRT, n PUN
LOGON AT hh:mm:ss zone day mm/dd/yy
-or-
RECONNECTED AT hh:mm:ss zone day mm/dd/yy
Section 2: Command Descriptions 146
CMS Reference
MAKEBUF
Use the MAKEBUF command to create a new CMS program stack buffer.
+--------------------------------------------------------------------+
| | |
| MAKEBUF | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. The return code from the MAKEBUF command is the number of the
buffer just created (this may later be used with a DROPBUF
| command). When MAKEBUF is executed in an EXEC with an &ERROR or
| SIGNAL ON ERROR in effect, the non-zero return code causes the
error action to be taken.
2. Each buffer contains a new program stack. Commands that read
| from the stack (like the REXX PULL and EXEC &READ function) will
| read lines from the MAKEBUF buffers, beginning with the buffer
most recently created. When the MAKEBUF buffers are exhausted,
input lines will come from the console input buffer. When this
is exhausted a line will be read directly from the terminal.
MAKEBUF creates a stack of stacks.
3. MAKEBUF is used in an EXEC to insure that stacked lines from a
command are read immediately:
| /* MAKEBUF Example */
| "makebuf"
| "stkdate"
| pull . . day .
| say "Today is" day
| .
| .
| .
| "dropbuf"
4. Buffers created with MAKEBUF may be deleted with the DESBUF and
DROPBUF commands.
Messages and Return Codes
MAKEBUF produces no messages. See Usage Note 1 for the return codes.
Section 2: Command Descriptions 147
CMS Reference
MANUAL (EXEC)
Use the MANUAL command to examine or print documentation. Some UKCC
manuals and documents are available online and can be examined (from a
3270-type terminal) or printed. A menu of available documents is
available.
+--------------------------------------------------------------------+
| | + + |
| MANUAL | |Menu | |
| | |Browse name | |
| | | | |
| | | + + + + + +| |
| | |Print name |Copies n| |Route dest | |Forms xxxx|| |
| | | | 1| | Central| | NT || |
| | | + + + + + +| |
| | | | |
| | |Tprint name [STop] | |
| | + + |
+--------------------------------------------------------------------+
where
Browse displays the specified manual with the BROWSE command. This
can only be used on 3270-type terminals.
Menu displays a menu of available manuals. This is the default.
Print prints the selected manual. Use the COPIES, ROUTE, and
FORMS options if desired. These options are SETPRT command
options; other SETPRT command options can be specified.
Tprint prints the selected manual on your terminal. You may
specify STOP or other TPRINT command options. Refer to the
description of the TPRINT command for more information.
Options
Copies n is the number of copies requested. Multiple copy requests
are ignored for output routed HOT. The maximum value is
255, the default value is 1.
Forms xxxx
specifies the forms to be used for printing. The default
form is "NT", narrow unlined paper with the TN print train
(uppercase and lowercase letters). Other valid forms for
CENTRAL routing are 5162 and T. Forms requests are ignored
with HOT routing, and may be restricted at remote sites. A
remote site should be consulted in advance before requesting
special forms. Specify "FORMS STD." for printing on
standard forms.
Section 2: Command Descriptions 148
CMS Reference
MANUAL (EXEC)
Route dest
specifies the destination of the printed output. Any of the
following may be specified: "RMTnn" for a HASP remote site,
"HOT" for the hands-on printer at the UKCC, "CENTRAL" for
the UKCC Computer Room, "Pnnnn" for an RSCS remote site, or
"TERMINAL" for the user's terminal (reader spool file). The
default is "CENTRAL." Note that output routed HOT or
TERMINAL will be limited to about 1600 lines.
STop specifies that output at your terminal will stop before each
page is printed to allow for manual forms positioning.
Usage Notes
1. See the description of the SETPRT command for more information
about printing options and special forms.
2. The MANUAL PRINT function will leave the printer spooled back to
your reader (SETPRT TO *).
3. You will be charged for printing a manual, just as for any other
printed output. The cost will be determined by the number of
lines in the manual, the number of copies printed, and the
| routing. For example, printing one copy of the UKCC CMS
| Reference at the Computing Center costs about $8.50 (internal day
rate) for the CPU time, I/O operations, and output lines.
Messages and Return Codes
DMSMAN001E No manual name specified. RC=24
DMSMAN002E There is no manual named "name". RC=28
DMSMAN070E Missing or invalid parameter. RC=24
Messages and return codes may also be produced by the CMS commands
BROWSE, HELP, PRINT, and TPRINT.
Section 2: Command Descriptions 149
CMS Reference
MATCH
Use the MATCH command to compare two CMS disk files and describe the
changes needed to make the first file match the second file. The
output from the MATCH command may be a typed or printed list of
changes, or a CMS disk file in CMS UPDATE format. The MATCH command
replaces the less useful COMPARE command.
+--------------------------------------------------------------------+
| | |
| MATCH | fileid1 fileid2 [updateid] [( [options...] [)]] |
| | |
| | Options: |
| | |
| | BUFsize n + + + + |
| | COLumns n m |DATAstrea| |HEADer | |
| | ISEQuence n m |MSGstream| |NOHEADer| |
| | LINecount n |UPDstream| + + |
| | NSEQuence n m + + |
| | PREcision n |
| | |
| | + + + + + + |
| | |INCZero | |INSZero | |SEQuence| |
| | |NOINCZer| |NOINSZer| |NOSEQuen| |
| | + + + + + + |
| | |
| | + + + + + + |
| | |TRAILer | |TYPE | |UPDCtl | |
| | |NOTRAILe| |TERMinal| |NOUPDCtl| |
| | + + |PRInter | + + |
| | |PRT | |
| | + + |
+--------------------------------------------------------------------+
where
fileid1 is the file identifier of the base (original) file. The
filemode may be specified as "*".
fileid2 is the file identifier of the second (modified) file. Any
part of the fileid may be specified as "=", and the filemode
may be specified as "*".
updateid is the file identifier of the optional output file. Any
part of this fileid may be specified as "=", and the
filemode may be specified as "*". This file will be in CMS
UPDATE format. Specifying this parameter implies the
options UPDSTREAM, NOINCZERO, NOINSZERO, and UPDCTL.
Section 2: Command Descriptions 150
CMS Reference
MATCH
Options
BUFsize specifies the size of the input and output buffers, in
records, to be used for fixed-length record files (usually,
variable-length record files are read and written a single
record at a time). A value of "*" (the default) may be used
to specify that the buffer is to hold as many records as
will fit in 4096 bytes (one page) or one record, whichever
value is greater.
COLumns specifies the columns of the input file records which
contain data to be compared. The starting and ending column
values must both be specified. See the Usage Notes for more
information. The default value is "COL 1 *".
DATAstre specifies that output is to consist of a series of control
messages together with the deleted and inserted data lines.
This option is the default when the update file identifier
is omitted from the command line.
HEADer specifies that a header message describing the files being
compared is to be typed at the terminal before the
comparison operation begins. This option is the default at
all times.
INCZero specifies that sequence increments of zero on CMS UPDATE
control statements are allowed. This option and NOINCZERO
are meaningful only when the UPDSTREAM option is in effect.
INSZero specifies that records may be inserted at the beginning of a
file (after sequence number or "record number" zero). This
option is the default when either the DATASTREAM or
MSGSTREAM options are in effect.
ISEQuenc specifies the columns of the input file records which
contain sequence numbers. The starting column number and
length must both be specified. See the Usage Notes for more
information. The default value is "ISEQ * 8"
LINecoun specifies the number of lines on each page of printed
output. A value of zero may be specified to suppress both
pagination and the printing of a title line on the first
page (to print the title line and treat output as a single
page only, use a very large value, like 99999). The default
value is 55.
MSGstrea specifies that output is to consist of a series of control
messages only. The deleted and inserted data lines are not
written.
NOHEADer specifies that no header message is to be typed.
Section 2: Command Descriptions 151
CMS Reference
MATCH
NOINCZer specifies that sequence increments of zero on CMS UPDATE
control statements are not allowed. When this option is in
effect, insertion or replacement blocks will be expanded
into larger replacement blocks (gathering non-updated
records from the input file) until a sequence range is found
which will generate a nonzero sequence increment. This
option is the default when a CMS UPDATE stream is being
created.
NOINSZer specifies that records may not be inserted at the beginning
of a file. Instead, the first record of the file will be
replaced with a block consisting of the inserted records
followed by the first record. This option is the default
when the UPDSTREAM option is in effect, since the CMS UPDATE
command cannot insert records at the beginning of a file.
NOSEQuen specifies that input records do not contain sequence numbers
and output records are not to contain sequence numbers.
This option is the default when the base input file contains
anything other than fixed-length, eighty-character records.
See the Usage Notes for more information.
NOTRAILe specifies that no trailer messages are to be typed.
NOUPDCtl specifies that CMS UPDATE control statements in the input
files are not processed specially. These records take part
in the comparison operation just as do all other records in
the files. This option is the default when either the
DATASTREAM or MSGSTREAM option is in effect.
NSEQuenc specifies how new sequence numbers are to be generated, if
needed. Both a starting sequence number and an increment
value must be specified. This option applies both to the
process of generating sequence numbers when none are present
in the input file and to the adding of new records at the
end of the file (when a low sequence number is available,
but no high sequence number limit is available). The
default is "NSEQ 1000 1000".
PREcisio specifies the precision to be used in the hash comparison
algorithm. The value must be from 10 to 25. The default
value is 15.
PRInter specifies that output is to be written to the printer. If
an update fileid is specified this option is ignored. You
should issue a SETPRT command before using this option.
PRT is the same as the PRINTER option.
SEQuence specifies that input records contain sequence numbers and,
when possible, output records are to contain sequence
Section 2: Command Descriptions 152
CMS Reference
MATCH
numbers. This option is the default when the base input
file consists of fixed-length, eighty-character records.
See the Usage Notes for more information.
TERMinal specifies that output is to be typed at the console. This
is the default if the update fileid is omitted. If an
update fileid is specified this option is ignored.
TRAILer specifies that one or more trailer messages describing the
results of the file comparison are to be typed at the
terminal after the comparison operation completes. This
option is the default at all times.
TYPE is the same as the TERMINAL option.
UPDCtl specifies that CMS UPDATE control statements (any record
beginning "./") found in the input files are not to take
part in the comparison operation. Update statements found
in the base file will be ignored. Update statements found
in the second file will be written intact. This option is
the default when the UPDSTREAM option is in effect.
UPDstrea specifies that output is to consist of control statements
suitable for use by the CMS UPDATE facility. Inserted data
lines are written after insert or replace statements.
Deleted data lines are not written. This option is the
default when an update file identifier is supplied on the
command line.
Usage Notes
1. The two input files used by this program may have any record
format and length. The output file will contain variable-length
records if either of the two input files contain variable-length
records. If both of the two input files contain fixed-length
records, then the output file will also contain fixed-length
records. In either case, the maximum output record length will
be the maximum of the two input record lengths.
2. Note that the two input files must be similarly sequenced, in the
sense that the COLUMNS and ISEQUENCE options must apply to both
files. Sequence numbers (if any) on the second file's records
are ignored; however, the sequencing may affect the data
positions (if "COL n *" or "COL * n" were in effect).
3. The COLUMNS and ISEQUENCE options control the positions and
lengths of both the data columns and the sequence numbers in a
record. The NOSEQUENCE option may be used to specify that input
records do not contain sequence numbers (if necessary, sequence
numbers will be generated based on the value of the NSEQUENCE
option).
Section 2: Command Descriptions 153
CMS Reference
MATCH
Sequence number columns are specified as "S1 SL", where S1 is the
starting sequence number column and SL is the length of the
sequence number field. Data columns are specified as "C1 C2",
where C1 is the starting data column and C2 is the ending data
column.
If the starting sequence column, S1, is specified as an asterisk,
then sequence numbers are assumed to lie at the end of the
record; S1 is calculated to be [record length]-SL+1.
If the sequence number length, SL, is specified as an asterisk,
then sequence numbers are assumed to be of variable length; the
value of SL is calculated by scanning up from S1 to the start of
the sequence number (first non-blank) and then scanning up to the
end of the sequence number (first blank).
If the starting data column number, C1, is specified as an
asterisk, then the record data is assumed to follow the sequence
number field (or lie at the start of the record if no sequence
numbers are present); the value of C1 is calculated to be S1+SL
(or 1).
If the ending data column number, C2, is specified as an
asterisk, then the record data is assumed to extend up to, but
not including, the start of the sequence number field (or up to
the end of the record if no sequence numbers are present); the
value of C2 is calculated to be S1-1 (or the record length).
If the value of S1+SL-1 is greater then the current record
length, then SL is set to the [record length]-S1+1.
If the value of C2 is greater then the current record length,
then C2 is set to the record length.
Note that S1=* implies that sequence numbers follow the data on a
record and that C1=* implies that data follows the sequence
numbers on a record. Hence, several combinations are not allowed
and will result in an error message. These are:
If S1=*, then SL and C1 cannot be * (C2=* allowed).
If SL=*, then S1 and C2 cannot be * (C1=* allowed).
If C1=*, then S1 and C2 cannot be * (SL=* allowed).
If C2=*, then SL and C1 cannot be * (S1=* allowed).
In general, it is advisable to use the option combinations listed
below, where "s" is the length of the sequence number field and
"r" is the length of the record:
COL 1 * ISEQ * s (sequencing at record end)
COL * r ISEQ 1 s (fixed sequencing at record start)
COL * r ISEQ 1 * (variable sequencing at record start)
Section 2: Command Descriptions 154
CMS Reference
MATCH
Messages and Return Codes
DMSMAT002E File "fileid" does not exist. RC=28
DMSMAT003E "name" is not a valid option. RC=24
DMSMAT006E No read/write disks accessed. RC=32
DMSMAT019E Identical input files: "fileid". RC=24
DMSMAT029E "name" is not a valid operand. RC=24
DMSMAT029E Missing or invalid operand for the name option. RC=24
DMSMAT032E Invalid filename or filetype. RC=24
DMSMAT037E Disk "mode" is read-only. RC=32
DMSMAT048E Invalid mode "mode". RC=24
DMSMAT054E Incomplete fileid specified. RC=24
DMSMAT062E Invalid "char" in fileid. RC=20
DMSMAT069E Disk "mode" is not accessed. RC=32
DMSMAT070E [extraneous|missing] parameters. RC=24
DMSMAT104S Error n reading file "fileid" from disk. RC=100
DMSMAT105S Error n writing file "fileid" to disk. RC=100
DMSMAT179I Comparing "fileid" with "fileid".
DMSMAT211E Invalid or incomparable column numbers. RC=24
DMSMAT938E Error n from cms name function. RC=100
DMSMAT970E File "fileid" could not be opened (code n). RC=100
DMSMAT985E Insufficient storage for match. RC=25
DMSMAT991I Files match.
DMSMAT991I n records deleted starting at record number n...
DMSMAT991I n records inserted after record number n...
DMSMAT991I n records replaced starting at record number n...
DMSMAT991I n replacement records...
DMSMAT991I n smallest sequence number generated was n.
DMSMAT991I n update records created.
DMSMAT991I No sequence number increments were generated.
Section 2: Command Descriptions 155
CMS Reference
MATLAB (EXEC)
MATLAB provides a "laboratory" for matrix computations. Use the EXIT
subcommand to leave MATLAB.
+--------------------------------------------------------------------+
| | |
| MATLAB | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. MATLAB may not function in a virtual machine smaller than 600K.
You can use the STORAGE command to redefine your storage size if
necessary.
2. For more information enter HELP while in MATLAB or see the MATLAB
User's Guide (available from the MANUAL command).
Section 2: Command Descriptions 156
CMS Reference
MENUEXEC
| MENUEXEC is used to provide REXX, EXEC 2, EXEC and program support for
display panels created with the XMENU command. MENUEXEC can display
panels on a 3270-type display terminal and accept input data from the
user at the terminal.
+--------------------------------------------------------------------+
| | |
| MENUEXEC | menuname [(options... [)]] |
| | |
| | Options: |
| | |
| | [LIB library] [ALARM] [CURSOR fieldname] |
| | [UPCASE] [EMSG] [NOWAIT] |
| | [NONULLS] [STACK LIFO|FIFO] |
| | [TEST] [CLEAR] [NOXVARS|XVARS] |
| | [MAP] [PA1] [SKIP] |
| | [MDT] [CURPOINT] [FILE filename] |
| | [WAIT limit] [SMSG] [RDR] |
| | [DEV address] |
| | |
+--------------------------------------------------------------------+
where
menuname specifies the name of the MENU file to be displayed.
Usage Note
| Refer to the XMENU and DMSCVT User's Guide or online HELP for details.
Messages and Return Codes
Unless EMSG is specified, MENUEXEC produces no messages. Errors are
indicated by a non-zero return code which is the same as the
corresponding message number. The text of the MENUEXEC messages can
be found in a file named "MENUEXEC MESSAGES Y2."
Section 2: Command Descriptions 157
CMS Reference
NEWS
Use the NEWS command to display the online news.
+--------------------------------------------------------------------+
| | + + |
| | |CHECK | |
| NEWS | |Headlines| |
| | |Summary | |
| | |Type | |
| | |Xedit | |
| | + + |
+--------------------------------------------------------------------+
where
CHECK checks for news, but does not display it. If news is
available, the return code is zero; if there is no news, the
return code is 1, and a message is issued. This option is
intended for use in an EXEC.
Headlines displays the news headlines.
Summary displays a summary of the news. This currently has the same
effect has the HEADLINES option.
Type types the news at your terminal.
Xedit inserts the news text into an XEDIT file. This is the
default if NEWS is entered under XEDIT. The XEDIT option is
valid only under XEDIT.
Usage Notes
1. By default, the NEWS command displays the news with XEDIT in a
file named "Online News."
2. NEWS is implemented as an EXEC and a module.
Messages and Return Codes
DMSNEW070E "parm" is not a valid parameter. RC=24
DMSNEW105S Error nn writing file to xedit. RC=100
DMSNEW942E The "XEDIT" option is only valid under XEDIT. RC=88
DMSNEW973E Sorry, no news today. RC=1
Section 2: Command Descriptions 158
CMS Reference
NOTE (EXEC)
Use the NOTE command to prepare a note with XEDIT for transmission to
one or more users. This is a description of the simplest form of the
NOTE command; other features and options are available.
+--------------------------------------------------------------------+
| | |
| NOTE | name [names...] [CC: name [names...]] |
| | |
+--------------------------------------------------------------------+
where
name is the name of a user to receive the note. A "name" may be
a userid or a nickname (from a NAMES file). You may specify
more than one name, and a nickname may refer to more than
one userid.
CC: name is the name of a user to receive a complimentary copy. The
rules for these names are the same as those for the
principle recipients.
Usage Notes
1. The note created by the NOTE command is sent as a reader spool
file to the designated users. The file will be in the NETDATA
format. The recipients may examine the note with the PEEK
command, or copy the note to a permanent CMS disk file with the
ACCEPT command.
2. The NOTE command supports a number of options, including ACK and
NOACK options similar to those of the SENDFILE command. The
default options of the NOTE command can be changed with the
DEFAULTS command. Refer to the VM/SP CMS Command and Macro
Reference or to the online HELP command for more information.
3. The nicknames used by the NOTE command are kept in a CMS disk
file named "userid NAMES", where "userid" is your userid. This
file can be maintained with the NAMES command, or edited directly
with XEDIT. The NAMES file is also used by the TELL, SENDFILE,
and NAMEFIND commands. Refer to the VM/SP CMS Command and Macro
Reference or to the online HELP command for more details about
these commands.
Section 2: Command Descriptions 159
CMS Reference
OSDISKS (EXEC)
Use the OSDISK command to access the OS rental disks that contain user
data sets.
+--------------------------------------------------------------------+
| | + + |
| | OSDISKs | | ON | ACCess | LINK | |
| | | | OFF | RELease | DETach | |
| | + + |
+--------------------------------------------------------------------+
where
| ON links and accesses the OS rental volumes. This is the
| default. ACCESS and LINK are synonyms for ON.
| OFF releases the OS rental volumes. RELEASE and DETACH are
| synonyms for OFF.
Usage Note
OSDISKS accesses the OS rental volumes beginning with mode H. Use the
QUERY DISK command to display the names of the currently accessed
disks, both OS and CMS.
Messages and Return Codes
DMSOSD070E The correct format is OSDISKS ON or OSDISKS OFF. RC=24
Messages may also be produced by the CMS command ACCESS.
Section 2: Command Descriptions 160
CMS Reference
OSXEDIT (EXEC)
Use the OSXEDIT command to examine an OS disk data set with the System
Product editor (XEDIT). The OS data set cannot be modified, but it
can be saved as a CMS disk file, with or without modifications.
+--------------------------------------------------------------------+
| | |
| OSXEDIT | dsname [(member [)]] |
| | |
+--------------------------------------------------------------------+
where
dsname is the name of the OS data set. Each part (qualifier) of
the data set name is limited to eight characters, with a
blank or a period between each.
member is an optional member name. The member name is only used
when editing a member of a partitioned data set (PDS).
Usage Notes
1. OSXEDIT uses a fileid of "OS DATASET A1" for the file. You can
save the file on disk under another name by issuing the SAVE or
FILE subcommand with a fileid ("FILE SAMPLE DATA," for example).
2. The OSDISKS command is issued by OSXEDIT to access the OS rental
disks if it has not already been issued.
3. Attempting to edit a member of a PDS that does not exist will
cause the following messages to be issued:
DMSSOP036E OPEN ERROR CODE '08' ON 'SYSIN '.
DMSXDS591E OPEN ERROR ON SYSIN.
Messages and Return Codes
DMSOSX001E No data set name specified. RC=24
DMSOSX002E OS data set not found. RC=28
DMSOSX070E Incorrectly specified data set or member name. RC=24
Messages may also be generated by the FILEDEF, STATE, and XEDIT
commands.
Section 2: Command Descriptions 161
CMS Reference
OUTPUT
Use the OUTPUT command to print or plot a reader spool file (such as
output returned from a batch job), or to send a reader spool file to
another VM/SP user.
+--------------------------------------------------------------------+
| | + + |
| OUTPUT | |spoolid [*]| [( options... [)]] |
| | |name [type]| |
| | | * * | |
| | + + |
| | |
| | Options: |
| | |
| | + + + + [Copies n] |
| | |PLot | |DOCument| |
| | |Route destination| |LABels | [Pagesize n] |
| | |To userid | + + |
| | |User userid | [Forms xxxx] |
| | + + |
| | [Space x] |
| | |
+--------------------------------------------------------------------+
where
spoolid is the spool file number of the reader spool file to be
processed. The default is "*," the first file in your
reader.
name [type]
are used to specify a file by spool file name and type
rather than number. Spool files do not necessarily have
names and types. The default type is "*," the first file
that matches the specified name.
Options
Copies n is the number of copies to be printed. The default is one
copy. This option only applies to output routed to a HASP
printer (except the HOT printer).
DOCument will cause PAGESIZE 0 and FORMS NT to be used (the normal
settings for printing SCRIPT output). This option only
applies to output routed to a HASP printer.
Forms xxxx
is the printer forms designation. The default is standard
(STD.) forms. Refer to the Usage Notes for more
Section 2: Command Descriptions 162
CMS Reference
OUTPUT
information. Specifying the special forms implies the SPACE
W option. This option only applies to output routed to a
HASP printer.
K is a synonym for PAGESIZE.
LABels will cause PAGESIZE 0 and FORMS LT to be used. This option
is used for printing labels and only applies to output
routed to a HASP printer.
Linect is a synonym for PAGESIZE.
N is a synonym for COPIES.
Pagesize n
is the number of lines per page. The default is 61 and the
maximum is 255. If zero is specified, automatic page
skipping is not provided. This option applies only to
output routed to a HASP printer.
PLot sends the reader file to be plotted on the Zeta plotter in
the UKCC Computer Room. This option should only be
specified for spool files containing plot output in Zeta
Graphics Machine Language (GML) format as produced by the
standard plotting routines.
Route destination
specifies the destination of the output. Any of the
following may be used:
Central HASP Printer in the UKCC Computer Room
Hot HASP Hands-on (HOT) Printer at the UKCC
Local Synonym for CENTRAL (This option isn't recommended
and is included only for compatibility with old
applications.)
Pnnnn RSCS Remote Printer "nnnn"
RMTnn HASP Remote Site "nn"
Terminal Your Userid (Reader Spool File)
userid Any VM/SP Userid (Reader Spool File)
Space n determines the carriage control used. SPACE S causes single
spacing of output, SPACE W allows normal carriage control.
The default is SPACE S unless special forms are used. This
option applies only to output routed to a HASP printer.
To userid will cause the reader file to be sent to the specified
userid rather than to be printed or plotted. This can be
used to send a file to another user, who could then use
ACCEPT, PEEK, OUTPUT, etc.
User is a synonym for TO.
Section 2: Command Descriptions 163
CMS Reference
OUTPUT
Usage Notes
1. A message will be sent to you when the file is received for
printing or plotting. This message will contain the identifier
assigned by the system that will be processing the output (HASP,
RSCS, or the plotting system). If your output was routed to the
HASP HOT printer in McVey Hall you will receive another message
when it begins printing. If you have SET MSG OFF, these messages
will be suppressed.
2. Output routed HOT is limited to 1600 lines, and the multiple
copies option will be ignored for output routed to either HOT or
TERMINAL.
3. There are restrictions on the use of special FORMS. The FORMS
option is ignored for output routed HOT or TERMINAL. Since each
remote site controls its own special forms, a site should be
consulted in advance before requesting any special forms. Output
routed CENTRAL can use any of the following special forms:
LT Labels (3 1/2" by 15/16"), TN (mixed case) Print Train
NT Narrow Unlined Paper, TN (mixed case) Print Train
STD. Regular Paper, PN (uppercase) Print Train
T Regular Paper, TN (mixed case) Print Train
5106 Labels (3 1/2" by 15/16"), PN (uppercase) Print Train
5162 Narrow Unlined Paper, PN (uppercase) Print Train
There is an additional charge for printing on labels (forms LT
and 5106) routed CENTRAL.
4. Note that "PAGESIZE 0", which suppresses automatic page skipping,
should be specified when printing SCRIPT output, since SCRIPT
will control page skipping itself. The DOCUMENT and LABELS
options set "PAGESIZE 0".
5. A held reader file cannot be processed by OUTPUT. Any attempt to
do so will result in message 920E being issued.
Messages and Return Codes
DMSOUT003E Invalid option "option". RC=24
DMSOUT029E Invalid parameter "parm" in the option "option" field.
RC=24
DMSOUT070E Invalid parameter "parameter". RC=24
DMSOUT920E Reader file "identifier" not found. RC=28
DMSOUT921E Error "nn" from reader. RC=100
DMSOUT935E Bad reader spool block. RC=100
Messages may be produced by the CP commands TAG and TRANSFER. HASP,
RSCS, and the plotting system will send messages to acknowledge
receipt of a file.
Section 2: Command Descriptions 164
CMS Reference
PACK (EXEC)
Use the PACK command to convert a CMS disk file to packed format.
+--------------------------------------------------------------------+
| | + + + + + +++++ |
| PACK | ifn |ift |ifm |ofn |oft |ofm||||| |
| | |* |A |= |= |= ||||| |
| | + + + + + +++++ |
+--------------------------------------------------------------------+
where
ifn is the filename of the CMS disk file to be packed.
ift is the filetype of the input file.
ifm is the filemode of the input file. The default is "A."
ofn is the filename of the packed output file. The default is
"=," the input filename.
oft is the filetype of the output file. The default is "=," the
input filetype.
ofm is the filemode of the output file. The default is "=," the
input filemode.
Usage Notes
1. Packed files are kept on disk in a special compressed format that
usually requires much less disk space than normal format. Once a
file has been packed, it can no longer be processed by most CMS
commands (such as PRINT, SCRIPT, SUBMIT, etc.). Only COPYFILE,
DISK, UNPACK, and XEDIT should be used with packed files. Only
XEDIT should be used to modify or examine a file in packed
format. Modifying a packed file improperly will make it
impossible to unpack the file or recover the data.
2. Use the UNPACK command to convert a packed file to normal format.
Messages and Return Codes
Messages may be generated by the CMS COPYFILE command.
Section 2: Command Descriptions 165
CMS Reference
PASCAL
Use the PASCAL command to compile a program with the P4 Pascal
compiler. P4 Pascal is not supported. The PAS4CG, PAS4C, and PAS4G
commands are available for use with P4 Pascal programs.
+--------------------------------------------------------------------+
| | |
| PASCAL | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the Pascal
source program. The filetype of the file must be "PASCAL."
This filename will be used for the TEXT, LISTING, EXEC, and
P4ASSEM files, if they are created.
Options
If conflicting options are specified the last option given is used.
ATtribute specifies that an attribute table is to be generated. This
option sets the value of the compiler directive A to A+.
This is the default.
COErce specifies that less rigorous type checking is to be
performed. This option provides compatibility with the
level of type checking performed by the CDC 6000 compilers.
This option sets the value of the compiler directive C to
C+. NOCOERCE is the default.
CONcat allows the compilation of a program which is held in several
files. The named file ("filename PASCAL") contains a list
of these files, with one fileid (filename and filetype) per
line. The source appears as a continuous stream to the
compiler.
DEbug causes the compiler to generate code to check array bounds,
assignments to sub-range types, line number tracing, etc.
This option sets the initial value of the compiler directive
D to D+. This is the default.
DIsk will send the output listing to a disk file named "filename
LISTING A1." This is the default.
EXec causes the generation of an EXEC named "filename EXEC A1"
which can be used to execute the object program. NOEXEC is
the default.
Section 2: Command Descriptions 166
CMS Reference
PASCAL
EXtern will force the compiler to use the first eight characters of
a procedure or function name as the external name to be used
by the CMS loader, instead of the unique internal name that
would ordinarily be used. In order to be used successfully,
all names must be unique (only the first seven characters
being considered). EXTERN is most useful for generating
program libraries. This option sets the value of the
compiler directive E to E+. The default is NOEXTERN.
INstore causes the intermediate P-code to be held in storage between
the compile and assembly stages. INSTORE implies the OBJECT
option.
KEepasm will cause the P-code generated by the compiler to be kept
on disk in a file named "filename P4ASSEM A1." KEEPASM
implies the ONDISK option.
LInecoun n
sets the number of lines on each page of compiler listing
(must be greater than 9). The default is LINECOUNT 55.
NOATtribu See the ATTRIBUTE option.
NODEbug See the DEBUG option.
NOOBject See the OBJECT option.
NOPRint will suppress the output listing. The default is DISK.
NOSEGmen See the SEGMENT option.
NOSEQuen suppresses margin marking and causes the compiler to check
the entire input record (up to the limit of 130 bytes).
SEQUENCE is the default.
NOTerm See the TERM option.
NOXRef See the XREF option.
OBject causes the object program to be put into a disk file named
"filename TEXT A1". This is the default.
ONdisk will cause the compiler intermediate code to be written on
disk. This option reduces the storage requirements of the
compiler by 384K, but increases compilation time. ONDISK
implies the OBJECT option.
PRint will send the output listing to the virtual printer. The
default is DISK.
Section 2: Command Descriptions 167
CMS Reference
PASCAL
REsword causes reserved words to be bold-printed and converted to
lowercase. This option sets the initial value of the R
compiler directive to R+. NORESWORD is the default.
SEGment causes the PASCAL command to attempt to use the PASCAL
shared segment. This is the default, but no shared segment
is available at this time.
SEQuence causes the compiler to examine only the first 72 characters
of each input record, allowing sequence numbers to appear
afterward, and causes the margins of the input record
examined to be marked on the program listing with a vertical
bar. This option sets the I and U compiler directives to I+
and U+. This is the default.
TErm causes diagnostic messages to be displayed on the terminal.
This is the default.
WArn causes warnings to be issued for non-standard features used
and sets the initial value of the compiler directive W to
W+. NOWARN is the default.
XRef causes generation of a program cross-reference listing and
sets the initial value of the X compiler directive to X+.
This is the default.
Usage Notes
1. The P4 Pascal compiler accepts the language described in the
Pascal User Manual and Report, with several extensions and
restrictions. The UKCC CMS P4 Pascal User's Guide (available
from the MANUAL command) describes the compiler in detail.
2. The P4 Pascal compiler will not operate in a virtual machine
smaller than 600K, but compiled programs can execute in smaller
machines. You can use the STORAGE command to redefine your
storage size if necessary.
Section 2: Command Descriptions 168
CMS Reference
| PASSWORD
Use the PASSWORD command to change your logon password.
+--------------------------------------------------------------------+
| | |
| PASSWORD | [target] [( [NOPRompt] [QUIET] [)]] |
| | |
+--------------------------------------------------------------------+
where
target is the userid or project number to be affected. The default
is your userid. If you specify a userid or project number
for which you are not authorized the password will not be
changed and the system will record the attempt.
Options
NOPRompt suppresses the prompt messages. The prompts are suppressed
also if data is available in the program stack or console
input buffer.
QUIET suppresses all error messages. If an error occurs the
return code indicates the nature of the error. This option
is intended for use in an EXEC.
Usage Notes
1. PASSWORD prompts you to enter your current password, and then
asks for the new password twice (the two must match). The
passwords are masked during input, so the new password is read
twice to reduce the chances of a typing error.
You cannot display your current password or change your password
if you do not know it, so be careful when entering the new
password. If you forget your password contact the person
authorized to maintain your userid or project number (instructor,
etc.) or the Computing Center office. No one can determine your
current password, but a new password can be set for you. The
Computing Center office is open from 8:00 am to 4:30 pm (EST),
Monday through Friday; it is closed on university holidays.
2. A password can be from two through eight characters long.
Letters, numbers, and special characters can be used; lowercase
letters are converted to uppercase. Control characters cannot be
used. Extra care will be needed to use one of the CP line
editing characters. (The defaults are #, @, and ". Refer to the
description of the TERMINAL command for more information.) A
Section 2: Command Descriptions 169
CMS Reference
| PASSWORD
password cannot be entirely blank, contain imbedded blanks, or
begin with "NOLOG."
3. The system automatically makes a permanent record of all
unauthorized attempts to alter the password of a userid or
project number. The record includes the date and time, and the
userid making the attempt.
Messages and Return Codes
In case of an error, the return code will be the message number.
OUIPAS001E "[string]" is an extraneous parameter.
OUIPAS001E "[string]" is not a valid parameter.
OUIPAS002E "[string]" is not an option.
OUIPAS011E You are not authorized for this service.
OUIPAS011E This attempt has been recorded.
OUIPAS012E Sorry, but this transaction cannot be completed at this time.
OUIPAS012E Try again later.
OUIPAS013E No record found for [target].
OUIPAS014E You are not authorized to access data for [target].
OUIPAS014E This attempt has been recorded.
OUIPAS016E That is not the correct password.
OUIPAS017E Password cannot be blank.
OUIPAS018E Password contains invalid characters.
OUIPAS019E Passwords can be from two through eight characters long.
OUIPAS021E New passwords don't match; try again.
OUIPAS100E Error code [code] from an IUCV function.
OUIPAS101E An IUCV handler already exists for service name.
Communication cannot be established.
OUIPAS102E An IUCV DECLARE BUFFER has already been issued. CMS IUCV
support cannot be initialized.
OUIPAS103E Service is shutting down and cannot accept requests; try
again later.
OUIPAS104E IUCV message limit exceeded.
OUIPAS105E IUCV priority messages are not allowed.
OUIPAS106E Service is not available; try again later.
OUIPAS107E Service is not running; try again later.
OUIPAS108E Maximum number of IUCV connections exceeded for your
userid.
OUIPAS109E No service connections are available; try again later.
OUIPAS110E Not enough storage available.
Section 2: Command Descriptions 170
CMS Reference
PASXREF
Use the PASXREF command to create a cross-reference of a P8000 Pascal
program. PASXREF is not supported.
+--------------------------------------------------------------------+
| | |
| PASXREF | filename |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the source program file. The filetype of
this file must be "PASCAL."
Usage Notes
1. The cross-reference is written into a disk file called "filename
CROSSREF."
2. PASXREF may work with programs written for compilers other that
AAEC P8000. Some compilers can produce a cross-reference during
compilation.
Section 2: Command Descriptions 171
CMS Reference
PAS4C (EXEC)
Use the PAS4C command to compile a program with the P4 Pascal
compiler. P4 Pascal is not supported.
+--------------------------------------------------------------------+
| | |
| PAS4C | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the Pascal
source program. The filetype of the file must be "PASCAL."
This filename will be used for the TEXT, LISTING, and
P4ASSEM files, if they are created.
options are PASCAL compiler options.
Usage Notes
1. PAS4C is an EXEC that uses the PASCAL command to compile a Pascal
program. The object program produced can be executed with the
PAS4G command. Refer to the description of the PASCAL command
for more information.
2. The PAS4C command will not operate in a virtual machine smaller
than 600K, but compiled programs can execute in smaller machines.
You can use the STORAGE command to redefine your storage size if
necessary.
Section 2: Command Descriptions 172
CMS Reference
PAS4CG (EXEC)
Use the PAS4CG command to compile and execute a program using the P4
Pascal compiler. P4 Pascal is not supported.
+--------------------------------------------------------------------+
| | |
| PAS4CG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the Pascal
source program. The filetype of the file must be "PASCAL."
This filename will be used for the TEXT, LISTING, and
P4ASSEM files, if they are created.
options are PASCAL compiler options.
Usage Notes
1. The default P4 Pascal subroutine libraries are used: ZETALIB,
PASLIB, and CMSLIB. If you need to use additional libraries or
load additional object files you must use the PAS4G command to
execute your program.
2. The PAS4CG command will not operate in a virtual machine smaller
than 600K. You can use the STORAGE command to redefine your
storage size if necessary.
3. PAS4CG is an EXEC that uses the PASCAL command to compile a
Pascal program. The object program produced is then executed.
Refer to the description of the PASCAL command for more
information.
Section 2: Command Descriptions 173
CMS Reference
PAS4G (EXEC)
Use the PAS4G command to execute a program previously compiled with
the P4 Pascal compiler. P4 Pascal is not supported.
+--------------------------------------------------------------------+
| | |
| PAS4G | filename [filename...] [( [libraries] [> parms] ] |
| | |
+--------------------------------------------------------------------+
where
filename are the filenames of the CMS disks file containing the P4
Pascal (or P4 Pascal compatible) object programs. The
filetypes of the files must be "TEXT."
libraries are the names of subroutine libraries (TXTLIB's). Any
libraries specified here are searched before the default
libraries: ZETALIB, PASLIB, and CMSLIB.
parms are command line parameters for the executed program.
Usage Note
Refer to the descriptions of the PAS4C and PASCAL commands for more
information.
Section 2: Command Descriptions 174
CMS Reference
PEEK
Use the PEEK command to examine a reader spool file with the System
Product editor (XEDIT). The spool file cannot be modified, but it can
be saved as a CMS disk file, with or without modifications. PEEK can
be used with reader files in any format, and can be used to examine
files sent with the NOTE and SENDFILE commands. PEEK by default
displays only the first 200 lines of the file (except for files in
NETDATA or DISK DUMP format which must be displayed in their
entirety). This is not a complete description of the functions and
options available.
+--------------------------------------------------------------------+
| | |
| PEEK | [spoolid] [( [options...] [)]] |
| | |
| | Options: |
| | |
| | [FRom line] [FOr lines] |
| | |
+--------------------------------------------------------------------+
where
spoolid is the spool file number of the file to be examined. The
default is the first file in your reader.
Options
FRom line is the first record to be displayed. The default is one.
FOr lines is the number of records to be read from the file.
Specifying an asterisk causes the entire file to be read.
The default is to read up to 200 records.
Usage Notes
1. PEEK will use a fileid of "spoolid PEEK A0" for the file. You
can save the file on disk under another name by issuing the SAVE
or FILE subcommand with a fileid (e.g., "FILE SAMPLE DATA").
2. You can use the subcommands BURN and DISCARD to purge the reader
file and end PEEK. Both subcommands will send an acknowledgment
to the originating user if one was requested.
3. Files in DISK DUMP or NETDATA format are reformatted so that they
are readable. However, the entire file must be displayed and it
must have a logical record length of less than 256 in order to be
reformatted.
Section 2: Command Descriptions 175
CMS Reference
PLC
Use the PLC command to run a program written in PL/I using the Cornell
PL/CT system.
+--------------------------------------------------------------------+
| | |
| PLC | in-list [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
in-list is a list of input sources. This may include fileids and
asterisks (which indicate terminal input). "PLC" is assumed
for omitted filetypes, and "*" is assumed for missing
filemodes. "*DATA" and "*PROCESS" may be inserted in the
list to indicate the type of information to follow. The
default is input from the terminal.
Options
In addition to the following options, options valid on the *PL/C
statement may also be specified on the command line.
DISK causes all output to be written into a disk file named "PLC
LISTING". TERM is the default.
NOSAVE inhibits saving of source listing lines.
PAUSE to have your program enter debug mode just prior to program
execution. It is equivalent to pressing "ATTN" just as
program execution begins (which is hard to do). This will
give you the opportunity to set PAUSEs in the program prior
to execution.
SAVE n to have PL/CT save a copy of the source listing for display
during execution. Only the first n lines will be saved; if
omitted, n defaults to 100. This feature uses extra
storage.
TERM causes all output to be sent to the terminal. This is the
default.
Usage Note
Refer to PL/CT - User's Guide to the CMS Version (available from the
MANUAL command) for more information.
Section 2: Command Descriptions 176
CMS Reference
| PLIC
Use the PLIC command to compile and execute a program with the OS PL/I
Checkout Compiler.
+--------------------------------------------------------------------+
| | |
| PLIC | filename [ft [fm]] [( [options] [/ parameters] [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the primary input file.
ft is the filetype of the input file. The default is "PLI" or
"PLIOPT."
fm is the filemode. The default is "*."
options are PL/I Checkout options.
parameters
is a character string that is passed to the main procedure
of the PL/I program when it is executed. It is truncated to
100 characters and broken into 8-character tokens.
PL/I Checkout Subcommands
ABOVE Set breakpoints, insert debugging code
AT Set breakpoints, insert debugging code
CHANGE Change text in source or logic unit
CMS Enter CMS subset to execute CMS commands
CORRECT Make syntax corrections
COUNT Count statement executions
DELETE Remove text from source
EDIT Enter edit mode
END End edit mode
ERASE Remove source statements
FIND Find text in source or logical unit
GO Continue processing
GROUP Create logical unit
HELP Help information
INCREMENT Specify increment between statements
insert/replace Insert or replace source code
LIST Type source code, mods, logical units
LISTCOUNT Type the count information
MONITOR Copy file output to the terminal
NOCOUNT End counting
NOMONITOR End monitoring
NOVERIFY End verifying
Section 2: Command Descriptions 177
CMS Reference
| PLIC
OFF Remove breakpoints
OPTIONS Change or examine compiler options
QUALIFY Change scope of immediate input
REFERENCE Obtain attributes, cross reference
RENUMBER Renumber the source
RESUME Continue processing
RETRANSLATE Retranslate and execute
SAVE Save current version as a CMS file
STEP Specify number of statements to execute
VERIFY Have effects of CHANGE, CORRECT, DELETE,
and FIND typed at the terminal
Usage Notes
1. For more information about the PL/I Checkout Compiler, see the OS
PL/I Checkout Compiler CMS User's Guide. A summary is available
online from the MANUAL command.
2. Use the PLICR command to execute a program previously compiled
with either the Checkout or Optimizing compiler.
Section 2: Command Descriptions 178
CMS Reference
| PLICR
Use the PLICR command to execute a program previously compiled with
the PL/I Checkout or Optimizing compiler. PLICR uses the Checkout
debugging facilities.
+--------------------------------------------------------------------+
| | |
| PLICR | filename [filename...] [( [options] [/ parameters] [)]]|
| | |
+--------------------------------------------------------------------+
where
filename is one or more filenames of TEXT files produced by the PL/I
Checkout or Optimizing compiler.
options are PL/I Checkout options.
parameters
is a character string that is passed to the main procedure
of the PL/I program when it is executed. It is truncated to
100 characters and broken into 8-character tokens.
Usage Notes
1. PLICR provides the same subcommands as the PLIC command.
2. For more information about the PL/I Checkout Compiler, see the OS
PL/I Checkout Compiler CMS User's Guide. A summary is available
online from the MANUAL command.
Section 2: Command Descriptions 179
CMS Reference
PLIOPT
Use the PLIOPT command to compile a program with the IBM PL/I
Optimizing Compiler. The PLIXCG, PLIXC, and PLIXG commands are
available for use with PL/I programs.
+--------------------------------------------------------------------+
| | |
| PLIOPT | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the PL/I
source program. The filetype of the file must be "PLI" or
"PLIOPT." This filename will be used for the TEXT and
LISTING files, if they are created.
Options
A [(FULL|SHORT)]
controls the production of an attribute listing. NA is the
default.
AG causes the production of an aggregate length table. NAG is
the default.
CHARSET ([48|60] [EBCDIC|BCD])
specifies the character set used in the source program.
Refer to the PL/I User's Guide for more information. The
default is CHARSET(60 EBCDIC).
Compile causes the compiler to continue unless an unrecoverable
error is encountered. NC(S) is the default.
CONTROL ('password')
allows deleted options to be specified. Refer to the PL/I
User's Guide for more information.
COUNT causes code to be generated that will count the times each
statement is executed. COUNT implies GONUMBER or GOSTMT.
NOCOUNT is the default.
CS is the same as CHARSET.
CT is the same as COUNT.
Deck causes the object program to be sent to the virtual punch.
NODECK is the default.
Section 2: Command Descriptions 180
CMS Reference
PLIOPT
DIsk causes the compiler listing to be written into a file named
"filename LISTING". This is the default.
DUmp causes a dump to be produced if the compiler terminates
abnormally. NODUMP is the default.
ESD causes an external symbol dictionary to be produced. NOESD
is the default.
Flag [(I|W|E|S)]
indicates the level of diagnostic messages to be produced.
FLAG (W), the default, allows warning, error, and severe
error messages to be produced. FLAG (E) allows only error
and severe error messages. FLAG (S) allows only severe
error messages. FLAG (I) allows informational messages to
be produced along with all other classes.
FLOW [(n m)]
controls the tracing of flow of control during execution.
The two arguments specify the number of transfers of control
that will be listed for statements and for procedures.
NOFLOW is the default.
GONUMBER causes source program statement numbers to be included in
execution-time messages. GONUMBER implies the NUMBER
option. NGN is the default.
GOSTMT is similar to GONUMBER, but implies the STMT option. NGS is
the default.
IMP generates extra code to correctly handle imprecise
interruptions on IBM 360/91, 360/195, and 370/195
processors. NIMP is the default.
INClude allows %INCLUDE statements to appear in the source program
without the overhead of the full preprocessor. The MACRO
option overrides INCLUDE. NINC is the default.
INSOURCE causes a source listing (including preprocessor statements)
to be generated. This only applies when MACRO is specified.
This is the default.
INT allows ATTENTION on-units to function. NINT is the default.
LC (n) indicates the number of lines on each page of compiler
listing output (ranging from 1 to 32767). The default is LC
(55).
LIST [(m n)]
causes the generated object code to be listed. A range of
statement numbers may be specified with "m" and "n." NOLIST
is the default.
Section 2: Command Descriptions 181
CMS Reference
PLIOPT
LMESSAGE causes long-form messages to be produced. SMESSAGE is the
default.
Macro causes the preprocessor to be used. NOMACRO is the default.
MAP causes a storage map to be generated. NOMAP is the default.
MARGINI ('c')
causes the margins to be marked in the listing with the
specified character. NMI is the default.
MARgins (l r [c])
are the left and right margins on source records. The third
parameter is the column that contains ANS carriage control
characters. The default for source files with fixed-length
records is MARGINS (2 72 1); for files with variable-length
records the default is MARGINS (10 100 0).
MDeck causes the output of the preprocessor to be sent to the
virtual punch. NOMDECK is the default.
NA See the A (attributes) option.
NAG See the AG (aggregate) option.
NAME ('name')
causes the object program to be assigned the specified name.
Names are limited to six characters. There is no default
value.
NC [(W|E|S)]
causes compilation to stop if a warning, error, or severe
error is detected. NC (S) is the default. Also see the
COMPILE option.
NEST causes nesting levels to be indicated on the listing.
NONEST is the default.
NONUMBER See the NUMBER option.
NOOBJECT See the OBJECT option.
NOPRInt suppresses the compiler listing. DISK is the default.
NOPT See the OPTIMIZE option.
NSEQ See the SEQUENCE option.
NSYN [(W|E|S)]
causes syntax checking to stop if a warning, error, or
severe error is detected. NSYN (S) is the default.
Section 2: Command Descriptions 182
CMS Reference
PLIOPT
NTERM suppresses output to the terminal during compilation.
NUMber causes sequence numbers on the source records to be used as
statement numbers. This is the default. Also see the
SEQUENCE option.
OBJect [(filename)]
causes the object program to be written to a disk file named
"filename TEXT". The default filename is the filename of
the source file. OBJECT is the default.
OFfset causes a table of offsets to be produced. NOOFFSET is the
default.
OPTimize (TIME|0|2)
specifies the optimization level (0 or 2). TIME is the same
as 2. The default is OPTIMIZE (0), which is the same as
NOOPTIMIZE.
OPtions causes a complete list of options to be included in the
compiler listing. NOP is the default.
OSDeck specifies that the object program will be executed under OS
rather than CMS.
PRInt causes the compiler listing to be sent to the virtual
printer. DISK is the default.
SEQuence (m n)
specifies that sequence numbers are included on source
program records. The default for source files with fixed-
length records is SEQUENCE (73 80); for files with variable-
length records the default is SEQUENCE (1 8).
SIZE (n|nK|MAX)
controls the use of storage by the compiler. The default,
SIZE (MAX), should be used.
SMESSAGE causes short-form messages to be produced. This is the
default.
Source causes the source program to be included in the compiler
listing. NOSOURCE is the default.
STMT causes the actual statement numbers rather than input
sequence numbers to be used to number statements. NOSTMT is
the default. STMT is implied by NONUMBER and GOSTMT.
STORAGE causes storage requirements to be included in the compiler
listing. NSTG is the default.
Section 2: Command Descriptions 183
CMS Reference
PLIOPT
SYNtax causes the compiler to continue syntax checking unless an
unrecoverable error is encountered. NSYN (S) is the
default.
TERMinal [(options)]
is used to direct output from selected options to the
terminal. The default is to display diagnostic messages.
TYpe causes the compiler listing to be directed to the terminal.
DISK is the default.
Xref [(FULL|SHORT)]
causes a cross-reference to be generated. XREF(SHORT)
causes unreferenced identifiers to be omitted. NOXREF is
the default.
Usage Note
1. Detailed information about using the PL/I Optimizer can be found
in the OS PL/I Optimizing Compiler: CMS User's Guide. The PL/I
language is described in the OS and DOS PL/I Language Reference
Manual.
2. If you use %INCLUDE statements in your PL/I program, you must
define the libraries to be searched before you issue the PLIOPT
command. Members to be copied may be in CMS MACLIB's or OS
partitioned data sets (or both). To use a CMS MACLIB, use the
following command:
GLOBAL MACLIB libname
You must specify either INCLUDE or MACRO on the PLIOPT command.
If you use the form "%INCLUDE libname member" rather than
"%INCLUDE member," you must also issue a FILEDEF:
FILEDEF libname DISK libname MACLIB *
GLOBAL MACLIB libname
Refer to the description of the GLOBAL and MACLIB commands for
more information.
3. Before loading your PL/I program, you must define any subroutine
libraries required (including the PL/I Optimizer library). For
example:
GLOBAL TXTLIB PLILIB
LOAD filename ( START
The PL/I standard files SYSIN, SYSPRINT, and PLIDUMP are defined
by the PL/I run-time system. SYSIN and SYSPRINT are assigned to
Section 2: Command Descriptions 184
CMS Reference
PLIOPT
the terminal, and PLIDUMP is assigned to the printer. If your
program performs any input or output operations with other files
you must use FILEDEF commands to define the files or devices to
be used before execution.
4. You can create modules from PL/I programs using the following
commands:
GLOBAL TXTLIB PLILIB
LOAD filename
GENMOD name ( FROM PLISTART
The FROM PLISTART option must be specified on the GENMOD command.
Since some library routines are loaded dynamically, the PLILIB
TXTLIB must be available when the module is executed.
5. Parameters can be passed from the command line to the PL/I run-
time environment and to the PL/I program with the START command:
GLOBAL TXTLIB PLILIB
LOAD filename
START * execution-time options / program parameters
All blanks are removed from the parameters before they are passed
to the program. The execution-time options are described in the
PL/I User's Guide.
Section 2: Command Descriptions 185
CMS Reference
PLIXC (EXEC)
Use the PLIXC command to compile a program with the IBM PL/I
Optimizing compiler.
+--------------------------------------------------------------------+
| | |
| PLIXC | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the PL/I
source program. The filetype of the file must be "PLI" or
"PLIOPT." This filename will be used for the TEXT and
LISTING files, if they are created.
options are PLIOPT compiler options.
Usage Note
PLIXC is an EXEC that uses the PLIOPT command to compile a PL/I
program. The object program produced can be executed with the PLIXG
command. Refer to the description of the PLIOPT command for more
information.
Section 2: Command Descriptions 186
CMS Reference
PLIXCG (EXEC)
Use the PLIXCG command to compile and execute a program using the IBM
PL/I Optimizing compiler.
+--------------------------------------------------------------------+
| | |
| PLIXCG | filename [( options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the CMS disk file containing the PL/I
source program. The filetype of the file must be "PLI" or
"PLIOPT." This filename will be used for the TEXT and
LISTING files, if they are created.
options are PLIOPT compiler options.
Usage Notes
1. The default PL/I Optimizer subroutine libraries are used: PLILIB
and CMSLIB. If you need to use additional libraries or load
additional object files you must use the PLIXG command to execute
your program.
2. PLIXCG is an EXEC that uses the PLIOPT command to compile a PL/I
program. The object program produced is then executed. Refer to
the description of the PLIOPT command for more information.
Section 2: Command Descriptions 187
CMS Reference
PLIXG (EXEC)
Use the PLIXG command to execute a program previously compiled with
the IBM PL/I Optimizing compiler.
+--------------------------------------------------------------------+
| | |
| PLIXG | filename [filename...] [( [libraries] [> parms] ] |
| | |
+--------------------------------------------------------------------+
where
filename are the filenames of the CMS disks file containing the PL/I
Optimizer (or PL/I Optimizer compatible) object programs.
The filetypes of the files must be "TEXT."
libraries are the names of subroutine libraries (TXTLIB's). Any
libraries specified here are searched before the default
libraries: PLILIB and CMSLIB.
parms are command line parameters for the PL/I execution
environment and the executed program. Use a "/" to mark the
start of the parameters for the program.
Usage Note
Refer to the descriptions of the PLIXC and PLIOPT commands for more
information.
Section 2: Command Descriptions 188
CMS Reference
PLOT
Use the PLOT command to send a CMS disk file containing Zeta Graphic
Machine Language (GML) instructions to be plotted on the Zeta plotter
in the UKCC Computer Room. The GML data file may be produced with the
standard plotting subroutines.
+--------------------------------------------------------------------+
| | + + + +++ |
| PLOT | |fn |ft |fm||| [(options... [)]] |
| | |LAST |PLOT |* ||| |
| | + + + +++ |
| | |
| | Options: |
| | |
| | + + |
| | |Zeta | |
| | |Type | |
| | |Terminal | |
| | |TO userid| |
| | + + |
+--------------------------------------------------------------------+
where
fn specifies the filename of a file to be plotted. "LAST" is
the default.
ft specifies the filetype of the file. "PLOT" is the default.
fm specifies the filemode of the file. "*" is the default.
Options
Terminal is a synonym for TYPE.
TO userid sends the data to a user rather than plotting.
Type displays the data at the terminal rather than plotting.
Zeta sends the data to be plotted on the Zeta plotter at the UK
Computing Center. This is the default. Plotter output may
be picked up at the UKCC Data Center. (The runid is required
to claim output.)
PLOT Control Statements
Control statements must be in uppercase and begin in column one.
..* is a comment. PLOT discards this line.
Section 2: Command Descriptions 189
CMS Reference
PLOT
..END marks the end of the data in a file. PLOT will not read
past this point in the file.
..EOF is the same as END.
..INClude fn [ft [fm]]
includes another file in the output. The default filetype
and filemode are taken from the including file. The
specified file is inserted into the output at the point
where the INCLUDE statement is found. The CMS disk files
are not altered. This is used to combine several plots in
separate CMS disk files into a single plotted output.
..READ reads a single line from your terminal when the statement is
encountered. The data read from the terminal is discarded.
..TYPE text
displays the text at your terminal.
Usage Notes
1. Data from the input files is truncated to 80 characters. The
Zeta plotter uses only the first 64 characters of each line.
2. More information about plotting at the University of Kentucky
Computing Center can be found in the UKCC Plotting Manual (Third
Edition), available at the University Bookstore in the Student
Center on the Lexington campus.
Messages and Return Codes
DMSPLT002E Input file "fileid" not found. RC=28
DMSPLT003E "name" is not a valid option. RC=24
DMSPLT029E Missing parameter for the name option. RC=24
DMSPLT070E "name" is not a parameter. RC=24
DMSPLT104S Error n reading file "fileid". RC=100
DMSPLT911E Include statement in error: RC=99
DMSPLT946E I/O error (code n) writing to punch. RC=100
DMSPLT984E Attempt to include an included file from "fileid". RC=24
Messages will also be sent by the plotting system to acknowledge
receipt of your file.
Section 2: Command Descriptions 190
CMS Reference
PLOTAJ
Use the PLOTAJ command to draw a plot on an Anderson Jacobson 832 or
833 terminal with the Ultraplot option. The input file must contain
Zeta Graphic Machine Language (GML) instructions, as produced by the
standard plotting subroutines.
+--------------------------------------------------------------------+
| | + + + +++ |
| PLOTAJ | |fn |ft |fm||| [( options... [)]] |
| | |LAST |PLOT |* ||| |
| | + + + +++ |
| | |
| | Options: |
| | |
| | | [Xstart x] [Ystart y] [Height h] |
| | |
+--------------------------------------------------------------------+
where
fn specifies the filename of the file to be plotted. If not
specified, "LAST" will be assumed.
ft specifies the filetype of the file to be plotted. If not
specified, "PLOT" will be assumed.
fm specifies the filemode of the file to be plotted. If
omitted, the default value is "*".
Options
The XSTART, YSTART, and HEIGHT options may be specified, but are
ignored. These options are supported by the PLOTHP and PLOTTEK
commands. No clipping is done by PLOTAJ.
Usage Notes
1. If you are using an Anderson Jacobson 833 terminal you should
issue the AJ833 command before using PLOTAJ.
2. The data file may contain either fixed-length or variable-length
records. Only the first 64 characters of each record will be
used.
3. The plotted output may be interrupted with the HT and HX
commands, but doing so will leave the terminal in plot mode.
Type ESC (escape) N to return to normal mode.
Section 2: Command Descriptions 191
CMS Reference
PLOTAJ
4. More information about plotting at the University of Kentucky
Computing Center may be found in the UKCC Plotting Manual (Third
Edition), available at the University Bookstore in the Student
Center on the Lexington campus.
Messages and Return Codes
DMSPLT002E File "fileid" does not exist. RC=28
DMSPLT003E "name" is not a valid option. RC=24
DMSPLT029E Invalid value "value" in the name option. RC=24
DMSPLT069E Disk "mode" not accessed. RC=36
DMSPLT070E "name" is an extraneous parameter. RC=24
DMSPLT938E Error n from FILEDEF. RC=n
DMSPLY988I PLOTAJ starting...
DMSPLY989I PLOTAJ finished: Min X=n Max X=n Min Y=n Max Y=n
Section 2: Command Descriptions 192
CMS Reference
PLOTHP
Use the PLOTHP command to draw a plot on a Hewlett Packard 2647a
graphics terminal. The input file must contain Zeta Graphic Machine
Language (GML) instructions, as produced by the standard plotting
subroutines.
+--------------------------------------------------------------------+
| | + + + +++ |
| PLOTHP | |fn |ft |fm||| [( options... [)]] |
| | |LAST |PLOT |* ||| |
| | + + + +++ |
| | |
| | Options: |
| | |
| | | [Xstart x] [Ystart y] [Height h] |
| | |
+--------------------------------------------------------------------+
where
fn specifies the filename of the file to be plotted. If not
specified, "LAST" will be assumed.
ft specifies the filetype of the file to be plotted. If not
specified, "PLOT" will be assumed.
fm specifies the filemode of the file to be plotted. If
omitted, the default value is "*".
Options
| Height h gives the length that will be scaled to fit the height of
the screen. Vectors above YSTART+HEIGHT or to the right of
XSTART+2*HEIGHT will be clipped. If not specified, +12.0 is
assumed.
| Xstart x specifies the minimum X value to be plotted. Vectors to the
left of this value will be clipped. If not specified, 0.0
is used.
| Ystart y specifies the minimum Y value to be plotted. Vectors below
this value will be clipped. If not specified, 0.0 is used.
Usage Notes
1. The data file may contain either fixed or variable-length
records. Only the first 64 characters of each record will be
used.
Section 2: Command Descriptions 193
CMS Reference
PLOTHP
2. XSTART, YSTART, and HEIGHT should be specified in inches.
Together they define the clipping window. The default values
will draw a section of the plot 12 inches high by 24 inches wide
on the screen. If the plot is longer than this, use the XSTART
option to view the next section (e.g., XSTART 24).
3. More information about plotting at the University of Kentucky
Computing Center may be found in the UKCC Plotting Manual (Third
Edition), available at the University Bookstore in the Student
Center on the Lexington campus.
Messages and Return Codes
DMSPLT002E File "fileid" does not exist. RC=28
DMSPLT003E "name" is not a valid option. RC=24
DMSPLT029E Invalid value "value" in the name option. RC=24
DMSPLT069E Disk "mode" not accessed. RC=36
DMSPLT070E "name" is an extraneous parameter. RC=24
DMSPLT938E Error n from FILEDEF. RC=n
DMSPLY988I PLOTHP starting...
DMSPLY989I PLOTHP finished: Min X=n Max X=n Min Y=n Max Y=n
Section 2: Command Descriptions 194
CMS Reference
PLOTTEK
Use the PLOTTEK command to draw a plot on a Tektronix graphics
terminal. The input file must contain Zeta Graphic Machine Language
(GML) instructions, as produced by the standard plotting subroutines.
+--------------------------------------------------------------------+
| | + + + +++ |
| PLOTTEK | |fn |ft |fm||| [( options... [)]] |
| | |LAST |PLOT |* ||| |
| | + + + +++ |
| | |
| | Options: |
| | |
| | | [Xstart x] [Ystart y] [Height h] |
| | |
+--------------------------------------------------------------------+
where
fn specifies the filename of the file to be plotted. If not
specified, "LAST" will be assumed.
ft specifies the filetype of the file to be plotted. If not
specified, "PLOT" will be assumed.
fm specifies the filemode of the file to be plotted. If
omitted, the default value is "*".
Options
| Height h gives the length that will be scaled to fit the height of
the screen. Vectors above YSTART+HEIGHT or to the right of
XSTART+1.31*HEIGHT will be clipped. If not specified, +12.0
will be used.
| Xstart x specifies the minimum X value to be plotted. Vectors to the
left of this value will be clipped. If not specified, 0.0
is used.
| Ystart y specifies the minimum Y value to be plotted. Vectors below
this value will be clipped. If not specified, 0.0 is used.
Usage Notes
1. The data file may contain either fixed or variable-length
records. Only the first 64 characters of each record will be
used.
Section 2: Command Descriptions 195
CMS Reference
PLOTTEK
2. XSTART, YSTART, and HEIGHT should be specified in inches.
Together they define the clipping window. The default values
will draw a section of the plot 12 inches high by 15.72 inches
wide on the screen. If the plot is longer than this, use the
XSTART option to view the next section (e.g., XSTART 15.73).
3. At the end of the plot, PLOTTEK will sound the alarm, then
"sleep" until RETURN is pressed. It will then print the
termination message and exit.
4. More information about plotting at the University of Kentucky
Computing Center may be found in the UKCC Plotting Manual (Third
Edition), available at the University Bookstore in the Student
Center on the Lexington campus.
Messages and Return Codes
DMSPLT002E File "fileid" does not exist. RC=28
DMSPLT003E "name" is not a valid option. RC=24
DMSPLT029E Invalid value "value" in the name option. RC=24
DMSPLT069E Disk "mode" not accessed. RC=36
DMSPLT070E "name" is an extraneous parameter. RC=24
DMSPLT938E Error n from FILEDEF. RC=n
DMSPLY988I PLOTTEK starting...
DMSPLY989I PLOTTEK finished: Min X=n Max X=n Min Y=n Max Y=n
Section 2: Command Descriptions 196
CMS Reference
PRHELP (EXEC)
Use the PRHELP command to generate a printer spool file from a CMS
HELP file.
+--------------------------------------------------------------------+
| | |
| PRHELP | topic |
| | |
+--------------------------------------------------------------------+
where
topic is the HELP file to be printed. It is specified exactly the
same as for the HELP command.
Usage Note
The SETPRT command should be issued before you use PRHELP, to set the
destination and attributes of the printed output. For example:
SETPRT FORMS NT
PRHELP topic
will cause the HELP file to be printed in the UKCC Computer Room using
narrow, unlined paper. A group of files could be printed together by
issuing the commands:
SETPRT GROUP
PRHELP first
PRHELP second
.
.
.
SETPRT ENDGROUP FORMS NT
SETPRT
Messages and Return Codes
| Messages may be produced by the CMS commands STATE, EXECIO, and PRINT.
Section 2: Command Descriptions 197
CMS Reference
PRINT
Use the PRINT command to generate a printer spool file from a CMS disk
file. This is only a summary of the most frequently needed options
and functions of the PRINT command, not a complete description.
+--------------------------------------------------------------------+
| | + + |
| PRINT | filename filetype |filemode| [( [options...] [)]] |
| | |A | |
| | + + |
| | Options: |
| | |
| | + + |
| | |NOCC| |
| | |CC | |
| | + + |
+--------------------------------------------------------------------+
where
filename is the filename of the file to be printed.
filetype is the filetype of the file to be printed.
filemode is the filemode of the file to be printed. The default is
"A."
Options
CC causes the first character of each record from the file to
| be interpreted as a carriage control character (see the
| Usage Notes). CC is the default if the filetype is
"LISTING."
NOCC will not use carriage control information from the file.
The PRINT command will control spacing and will print page
headings for each file printed. NOCC is the default unless
the filetype is "LISTING."
Usage Notes
1. The CMS SETPRT command should be issued before the PRINT command
to set routing and other options. For example, to print a file
on the UKCC hands-on (HOT) printer, enter the commands:
SETPRT ROUTE HOT
PRINT a file
2. A group of files can be printed together with the commands:
Section 2: Command Descriptions 198
CMS Reference
PRINT
SETPRT GROUP
PRINT first file
PRINT second file
...
SETPRT ENDGROUP CLOSE SPACE W ROUTE HOT
SETPRT
The "SPACE W" option causes each file to begin on a new listing
| page. Groups of files may also be printed with the aid of the
| LISTFILE or LISTX "EXEC" option. These commands would print all
files modified since the beginning of 1981:
SETPRT GROUP
LISTX ( FROM 01/01/81 EXEC
CMS PRINT
SETPRT ENDGROUP SPACE W ROUTE HOT
SETPRT
Note that any SETPRT options specified with the GROUP option are
overridden when SETPRT is later issued with the ENDGROUP option.
3. Both American National Standard (ANS) and IBM machine carriage
control characters are allowed. Invalid carriage control
characters have unpredictable results. The following are valid
ANS control characters under CMS:
Graphic Hex Value Meaning
[blank] 40 Space 1 line before printing.
0 F0 Space 2 lines before printing.
- 60 Space 3 lines before printing.
+ 4E Space no lines before printing (overprint).
1 F1 Skip to channel 1 before printing (new page).
4. PRINT has additional options and functions. Refer to the VM/SP
CMS Command and Macro Reference or online HELP for details.
Section 2: Command Descriptions 199
CMS Reference
PUBLIC (EXEC)
| Use the PUBLIC command to link and access the Public disk. After you
have issued the PUBLIC command, you may issue "HELP PUBLIC MENU" for a
list of things available on the disk. Nothing on the Public disk is
supported.
+--------------------------------------------------------------------+
| | |
| PUBLIC | [mode] |
| | |
+--------------------------------------------------------------------+
where
mode is the mode used to access the Public disk. The default
mode is "Z." The mode may be specified as with the ACCESS
command.
Usage Notes
1. The Public disk contains EXEC's, XEDIT macros, and other
contributions from users. Items on the Public disk are not
subjected to extensive testing by the UKCC, and the UKCC will not
provide any support for them. You should evaluate an item before
using it. Each item on the Public disk is required to have a
Help file which will identify the contributor. The contributor
should be contacted if you have suggestions or complaints about
an item. Contact the User Services Group at the UKCC for
information on contributing to the Public disk.
2. If it is present, the PUBLIC MEMO is typed at the terminal by the
PUBLIC command. The PUBLIC MEMO is used to alert you to
important information about the Public disk.
3. If you regularly use files on the Public disk you may want to
have it accessed automatically when you log on. This can be done
by placing "EXEC PUBLIC" in your PROFILE EXEC.
Messages and Return Codes
Messages may be issued by the ACCESS command.
Section 2: Command Descriptions 200
CMS Reference
PW
Use the PW command to run a program with Waterloo Pascal.
+--------------------------------------------------------------------+
| | |
| PW | [-D] filename |
| | |
+--------------------------------------------------------------------+
where
-D indicates that the interactive debugger is to be used. When
this is specified the interactive debugger will take control
immediately before your program begins execution. The
subcommands supported by this facility are listed in the
Usage Notes.
filename is the filename of the input file. The filetype of this
file must be "PASCAL."
Usage Notes
1. Refer to the Waterloo Pascal User's Guide and Language
Description (available from the MANUAL command) for more
information.
2. The interactive debugger supports the following subcommands (only
the first letter of each subcommand need be entered):
Breakpoint List
Breakpoint Reset [id]
Breakpoint Set [line-range | routine | *]
Display [variable | *]
Go
Help
Quit
Single Reset
Single Set
Trace List
Trace Reset [id]
Trace Set [line-range | routine | *]
Section 2: Command Descriptions 201
CMS Reference
P8000
Use the P8000 command to compile a program using the AAEC P8000 Pascal
compiler. P8000 is not supported.
+--------------------------------------------------------------------+
| | |
| P8000 | filename [(options... [)]] |
| | |
+--------------------------------------------------------------------+
where
filename is the filename of the input file. The filetype of this
file must be "PASCAL."
Usage Notes
1. Execution requires the following libraries:
P8000 FORTLIB FORTEEH TSOLIB CMSLIB
2. No additional information is available at this time.
Section 2: Command Descriptions 202
CMS Reference
QUERY (CMS and CP)
Use the QUERY command to gather information about your userid and the
setting of various options. There are distinct CMS and CP QUERY
commands, but the CMS QUERY command will pass unrecognized parameters
to the CP QUERY command if IMPCP is ON. In most cases QUERY can be
considered to be a CMS command. This description includes the most
often needed parameters of both commands.
+--------------------------------------------------------------------+
| | |
| Query | function [( option [)]] |
| | |
| | CP Functions: CMS Functions: |
| | |
| | Files ABBREV |
| | Links address DISK [*|mode|R+W|MAX] |
| | LOGmsg FILEDEF |
| | | Names IMMEDIATe |
| | PF[nn] IMPCP |
| | | RATE IMPEX |
| | Rdr [ALL] INPUT |
| | Reader [ALL] OUTPUT |
| | Set SEARCH |
| | TERMinal SYNONYM [SYSTEM|USER|ALL] |
| | Time |
| | USERID |
| | Users [userid] |
| | |
| | Options: |
| | |
| | + + |
| | |STACK [FIFO|LIFO]| |
| | |FIFO | |
| | |LIFO | |
| | + + |
+--------------------------------------------------------------------+
where
(Each function is marked "CMS" or "CP" to indicate the command used.)
ABBREV (CMS) checks whether abbreviations are accepted for CMS
command names. The initial setting is "ON". This is
controlled with the SET ABBREV command.
DISK [*|mode|R/W|MAX]
(CMS) displays information about accessed minidisks. The
default (*) is to display all accessed minidisks. You may
specify a single access mode letter, "R/W" (for all writable
minidisks), or "MAX" (for the writable minidisk with the
Section 2: Command Descriptions 203
CMS Reference
QUERY (CMS and CP)
most available space). The ACCESS command is used to
control the accessibility of minidisks.
FILEDEF (CMS) displays information about file definitions made with
the FILEDEF command.
Files (CP) displays the number of spool files owned by your
userid.
IMMEDIATE (CMS) checks whether the CMS immediate commands (HT, HX,
etc.) will be recognized. The initial setting is "ON".
This is controlled with the SET IMMEDIATE command.
IMPCP (CMS) checks whether commands not recognized by CMS are
implied to be CP commands. The initial setting is "ON".
When IMPCP is off, CP commands must be prefixed with "CP",
or be issued from the CP environment. CP commands in an
EXEC file must be prefixed by "CP" regardless of the IMPCP
setting (except for QUERY with a stacking option specified).
IMPCP is controlled with the SET IMPCP command.
IMPEX (CMS) checks whether all commands are implied to be EXEC
names. The initial setting is "ON". When IMPEX is off,
EXEC names must be prefixed with "EXEC". Regardless of the
IMPEX setting, all EXEC names must be prefixed with "EXEC"
when called from another EXEC. IMPCP is controlled with the
SET IMPCP command.
INPUT (CMS) displays any input translations in effect. The
initial setting is to have no input translations. This is
controlled with the SET INPUT command.
Links address
(CP) displays the userids that currently have links to your
minidisk with virtual device address "address". Other users
use the LINK command to link to your minidisks. You use the
AUTOLINK command to authorize and control these links.
LOGmsg (CP) displays the current system log messages. These
messages are set by the system support staff to announce
system changes and specially scheduled down-time. A very
brief summary of the current log messages is displayed at
your terminal each time you log on or reconnect to the
system. The log message will be empty if there are no
announcements. The NEWS command displays this information
in a more useful form.
| Names (CP) displays a list of all logged-on users along with the
| addresses (real or logical) of their terminals.
| Disconnected users are indicated by DSC.
Section 2: Command Descriptions 204
CMS Reference
QUERY (CMS and CP)
OUTPUT (CMS) displays any existing output translations. The
initial setting is no output translations. This is
controlled with the CASE and SET OUTPUT commands.
PF[nn] (CP) displays the current setting of the Program Function
keys, or a single specified PF key. All undefined PF keys
will function as if set to the RETRIEVE command. Only
3270-type and 3101 terminals have PF keys that are supported
by VM/SP. PF keys are set with the SET PFnn command.
| RATE (CP) displays the current rate period: DAY, NIGHT, WEEKEND,
| or HOLIDAY. Additional text (like the name of a holiday)
| may follow the rate indicator. The RATES command displays
| the rate period and the rate actually charged.
Reader [ALL]
Rdr [ALL] (CP) displays a list of reader spool files. The ALL
parameter causes more extensive information to be displayed
for each file.
SEARCH (CMS) displays the accessed minidisks in the search order.
This information is a subset of that displayed by the QUERY
DISK command.
Set (CP) displays the current values of the CP SET command.
SYNONYM [SYSTEM|USER|ALL]
(CMS) displays the defined CMS command synonyms. Synonyms
may be defined with the SYNONYM command.
TERMinal (CP) displays the current setting of the CP TERMINAL
command.
Time (CP) displays the current date and time (Lexington, Kentucky
local time).
USERID (CP) displays your userid and the node name of the computer
system (if a node name has been assigned).
Users [userid]
(CP) displays either the number of users logged on to the
system, or the current status of a particular userid.
Options:
Options are accepted by the CMS QUERY command, but not by the CP QUERY
command. However, if the parameters are passed to CP by the CMS QUERY
command the options will be honored.
FIFO is a synonym for STACK FIFO.
Section 2: Command Descriptions 205
CMS Reference
QUERY (CMS and CP)
LIFO is a synonym for STACK LIFO.
STACK [FIFO|LIFO]
stacks the responses from the QUERY command (rather than
typing them). Error messages are never stacked and are
typed even if STACK is specified. The default stacking
order is FIFO.
Usage Notes
1. Only one function may be specified.
2. The QUERY command must be prefixed by "CP" to use the CP QUERY
functions from an EXEC, unless a STACK option is specified and
SET IMPCP is ON.
3. Both the CP and CMS QUERY commands have additional functions.
For more information refer to the VM/SP CP Command Reference for
General Users, the VM/SP CMS Command and Macro Reference, or
online HELP.
Messages and Return Codes
Messages may be produced by either the CP or the CMS QUERY command.
If the command is processed by CP, the return code is set to either
zero or the message number of the error message issued.
Section 2: Command Descriptions 206
CMS Reference
RATES
Use the RATES command to obtain the current rate period and rates.
+--------------------------------------------------------------------+
| | |
| RATEs | [( [Type] [Stack] [)]] |
| | |
+--------------------------------------------------------------------+
Options
Type specifies that the rate data is to be typed on the terminal.
This is the default.
Stack specifies that the rate data is to be placed on the console
stack in a last in, first out order.
Usage Note
When the STACK option is specified a single line containing five items
is stacked:
+ +
* |Internal [day|night|holiday|weekend]| cpurate iorate
|External base |
+ +
The CPU rate is specified as dollars (and cents) per virtual CPU hour;
the I/O rate is dollars (and cents) per 1000 I/O operations.
Messages and Return Codes
DMSRAT003E "string" is not a valid option. RC=24
Section 2: Command Descriptions 207
CMS Reference
RBROWSE
Use the RBROWSE command to examine a reader spool file from a
3270-type display terminal. RBROWSE is a read-only editor based on
the BROWSE command and supports a similar set of subcommands.
+--------------------------------------------------------------------+
| | |
| RBrowse | [spoolid] [( [options...] [)]] |
| | |
| | Options: |
| | |
| | [Help fn] [Profile [([fn [ft [fm [)]]]]]] |
| | |
| | [Noclear] |
| | |
+--------------------------------------------------------------------+
where
spoolid is the spool file number of the reader spool file to be
examined. If this parameter is not specified the first file
in the reader will be used.
Options
Help fn specifies the name of an EXEC to be called by the /HELP
subcommand. The default name is "HRBROWSE."
Profile (fn ft fm)
specifies a file to be used as the RBROWSE profile. The
default is "RBROWSE $PROFILE *."
Noclear suppresses clearing the screen on entry to RBROWSE.
Usage Notes
RBROWSE supports an RBROWSE $PROFILE, subcommands, and keyboard
functions like the BROWSE command. RBROWSE does not have DICT, ENTER,
and MEMBER subcommands. It allows PURGE as a synonym for BURN.
Messages and Return Codes
RBROWSE does not issue error messages, but uses these return codes:
1 Console not a 3270-type terminal.
2 Insufficient free storage available.
28 File not found.
1xxx Error xxx reading input file.
Section 2: Command Descriptions 208
CMS Reference
RDRCOST (EXEC)
Use the RDRCOST command to display information and estimated charges
for one or more reader spool files.
+--------------------------------------------------------------------+
| | + + |
| RDRCOST | |ALL | |
| | |spoolid| |
| | |* | |
| | + + |
+--------------------------------------------------------------------+
where
ALL indicates that information about all reader files is to be
displayed. This is the default.
spoolid is the spool file number of the reader file to be displayed.
* indicates that information on the first reader file is to be
displayed.
Usage Notes
1. The block count and charges given by the RDRCOST command are
estimates determined by the number of lines in the file and an
estimated average line length based on the type of the file
(print, punch, etc.). Obtaining more accurate figures entails so
much system overhead that it is impractical.
2. RDRCOST will not find a held reader file unless ALL is specified.
3. If a specific spool file number is given, the specified file
becomes the first file in your reader.
4. RDRCOST uses the STKXRDR command with the COST parameter to
obtain information about spool files.
Messages and Return Codes
DMSKXR070E "parm" is not a valid parameter. RC=24
DMSRDR655E There are no files in your reader. RC=28
Section 2: Command Descriptions 209
CMS Reference
RENAME
Use the RENAME command to change the fileid of a CMS disk file. This
is only a summary of the most frequently needed function of the RENAME
command, not a complete description.
+--------------------------------------------------------------------+
| | |
| RENAME | fileid1 fileid2 |
| | |
+--------------------------------------------------------------------+
where
fileid1 is the filename, filetype, and filemode of the file to be
renamed. Any part of the fileid may be specified as "*" to
indicate a group of files matching the other parts of the
fileid.
fileid2 is the new filename, filetype, and filemode. Equal signs
may be used to indicate portions of the fileid that are to
remain unchanged.
Usage Notes
1. The RENAME command cannot be used to change the filemode letter
of a file, although it can be used to change the filemode number.
The filemode letter is under the control of the ACCESS command.
The filemode number of a CMS disk file indicates certain
attributes. Use the filemode number with care! The following
values can be used:
| 0 General use, but filemode number 0 makes a file generally
inaccessible to users with a read-only link to the disk.
1 General use. This is the default.
2 General use.
3 Scratch file. CMS erases a file with filemode number 3
after it has been read once.
4 OS simulation file. Don't use filemode number 4 unless you
have an understanding of OS simulation.
5 General use.
| 6 Update-in-place.
2. RENAME has other options and functions. Refer to the VM/SP CMS
Command and Macro Reference or the online HELP command for
details.
Section 2: Command Descriptions 210
CMS Reference
REPRINT
Use the REPRINT command to create a printer spool file from the first
file in your reader, retaining the carriage control information.
+--------------------------------------------------------------------+
| | |
| REPRINT | [name [type]] [( [HOLD] [PRINTABLE] [)]] |
| | |
+--------------------------------------------------------------------+
where
name [type]
specify a new spool file name and type for the printer spool
file. The defaults are the spool file name and type of the
original reader file.
Options
HOLD retains the original reader spool file. The default is to
purge the original file unless an error occurs.
PRINTABLe restricts the data in the output file to an all-uppercase
64-character set. All unprintable characters and lowercase
letters are translated to blanks.
Usage Notes
1. REPRINT takes one reader spool file (the first PRT or CON file)
and creates a printer spool file. The new file is sent to the
current printer destination (set with the SETPRT command). The
OUTPUT command is much more efficient if you want simply to
transfer a file. REPRINT has the ability to retain the original
file, which OUTPUT cannot do. REPRINT can also be used to gather
several reader files into a single file for printing (see the
GATHER command).
2. REPRINT can process only PRT (print) and CON (console) files. It
can't handle PUN files or files that have been held with the
CHANGE RDR command.
Messages and Return Codes
THE TAG FOR PRINTER FILE nnnn WAS: text
mm LINES WITH UNPRINTABLE CHARACTERS WERE FOUND.
NO INPUT PRINT FILE FOUND. RC=4
Section 2: Command Descriptions 211
CMS Reference
RETRIEVE (CP)
Use the RETRIEVE command to retrieve input lines on a 3101 or
3270-type terminal. The RETRIEVE command can be used only from a
Program Function (PF) key.
+--------------------------------------------------------------------+
| | |
| RETrieve | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. RETRIEVE can be used only on 3101 or 3270-type terminals equipped
with Program Function (PF) keys. To use RETRIEVE, issue the CP
SET command in the following form:
CP SET PFn RETRIEVE
where "n" is a PF key number. Do not specify the DELAY or
IMMEDIATE parameters of the SET PF command.
When a PF key set to RETRIEVE is pressed, the previous input line
will be placed in the input area of the screen. The most
recently entered input lines are recorded for possible recall; if
the PF key is pressed again, the preceding line will be
retrieved. After all of the retained lines are retrieved,
pressing the PF key again will recall the first saved line. Null
(empty) input lines, duplicated lines, and lines entered with
display off (such as passwords) are not saved. Programs which
manage the screen and PF keys themselves (such as BROWSE, FLIST,
XEDIT, and XMENU) override the RETRIEVE feature; it will not
function while they are in control.
2. The CMS recall function (?) may be used on any terminal to
display the last command entered at the terminal or through the
CMS program stack. Lines entered in CP mode or using #CP cannot
be recalled with the CMS function.
| 3. On local 3270-type terminals TEST REQ (Test Request) and all
| unassigned PF keys function as RETRIEVE. You cannot change the
| function of the TEST REQ key.
4. The keyword "RECALL" is also supported for this function to
provide compatibility with previous releases of VM/SP.
Section 2: Command Descriptions 212
CMS Reference
RH
Use the RH (Resume Help) command to return to the Yale HELP (YHELP)
system at the point you last left it during this terminal session.
+--------------------------------------------------------------------+
| | |
| RH | |
| | |
+--------------------------------------------------------------------+
Messages and Return Codes
NO ACTIVE HELP ENVIRONMENT
Section 2: Command Descriptions 213
CMS Reference
| RT (CMS Immediate Command)
Use the RT (Resume Typing) command to resume terminal output during a
CMS command after HT has been issued.
+--------------------------------------------------------------------+
| | |
| RT | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. CMS immediate commands are accepted only from the terminal. They
may not be issued from an EXEC. The SET CMSTYPE RT command can
be used to resume terminal output within an EXEC.
2. The SET IMMEDIATE command can be used to disable the CMS
immediate commands. QUERY IMMEDIATE to determine the current
setting. The initial setting is SET IMMEDIATE ON.
Messages and Return Codes
None.
Section 2: Command Descriptions 214
CMS Reference
RUNID
Use the RUNID command to obtain information about OS batch jobs and
HASP printed output routed to CENTRAL that were submitted from your
userid.
+--------------------------------------------------------------------+
| | |
| RUNID | [ALL] |
| | |
+--------------------------------------------------------------------+
where
ALL causes all information retained by the system for jobs you
have submitted to be displayed. The RUNID FILE is updated
with those jobs which have not previously been displayed.
Usage Notes
1. RUNID displays the runid, the job name, and other information for
each job. The information is also placed in a file on your A-
disk called "RUNID FILE". If the RUNID command detects errors
while writing the information into the RUNID FILE, an error
message will be issued and the information will be displayed on
your terminal. The ALL parameter can be used to redisplay the
job information.
2. You are responsible for maintaining your RUNID FILE. The file
can be modified as desired, although it should be left in
variable-length format. You may want to occasionally erase the
file to conserve disk space.
3. RUNID can be used to obtain information about a job after it has
been read by the OS batch system. This information will be
retained for at least twenty-four hours or through a weekend.
Once a job has been displayed by RUNID, this information will not
be displayed again unless the ALL parameter is specified.
Messages and Return Codes
DMSRID037E DISK 'A' IS READ/ONLY. RC=28
DMSRID069E DISK 'A' NOT ACCESSED. RC=28
DMSRID070E INVALID PARAMETER 'parameter'. RC=24
DMSRID105S ERROR 'n' WRITING FILE 'fn fm ft' ON DISK. RC=100
DMSRID107S DISK 'A' IS FULL. RC=100
DMSRID934S FATAL RUNID ERROR.
DMSRID939I NO RUNIDS FOUND.
DMSRID940I RUNID FACILITY TEMPORARILY OVERLOADED -- TRY AGAIN LATER.
DMSRID941I RUNID FACILITY TEMPORARILY OUT OF SERVICE.
Section 2: Command Descriptions 215
CMS Reference
RXEDIT (EXEC)
Use the RXEDIT command to examine a reader spool file with the System
Product editor (XEDIT). The spool file cannot be modified, but it can
be erased or saved as a CMS disk file, with or without modifications.
+--------------------------------------------------------------------+
| | + + |
| RXedit | |spoolid [*]| [file] [( options [)]] |
| | |name [type]| |
| | | * * | |
| | + + |
+--------------------------------------------------------------------+
where
spoolid is the spool file number of the reader spool file to be
processed. The default is "*", the first file in your
reader.
name [type]
specify an input file by spool file name and type rather
than number. Spool files do not necessarily have names and
types. The default type is "*," the first file that matches
the specified name.
options are INPUT command options. Except for the file destination
options (APPEND, DISK, REPLACE, SELECT, STACK, and XEDIT),
any INPUT option may be specified. The NOHOLD option is
ignored.
Usage Notes
1. RXEDIT assigns a filename using the spool file type and the spool
file number. This special name is used by the BURN subcommand.
The filetype is "LISTING" and the filemode is "A1."
2. The BURN subcommand purges the reader file if you have not
altered the XEDIT filename and filetype. If the file still
exists when you have completed your editing session, you will be
asked if you want to keep the file.
3. You can write the file to disk under another name by issuing the
FILE or SAVE subcommand with a fileid (e.g., "FILE SOME OUTPUT").
4. RXEDIT will use your XEDIT profile.
5. RXEDIT uses an XEDIT macro named RINPUT that uses the CMS command
INPUT to read the spool file. The RINPUT macro can be used alone
from within XEDIT to read another spool file.
Section 2: Command Descriptions 216
CMS Reference
| SAS (EXEC)
Use the SAS command to execute the CMS Statistical Analysis System.
This is not a complete description of SAS; refer to the manuals listed
in the Usage Notes for details.
+--------------------------------------------------------------------+
| | |
| SAS | [filename [filename...]] [( options... [)]] |
| | |
| | Options: |
| | |
| | + + + + + + |
| | |LDisk | |PDisk | |NOTLog| |
| | |LPrint| |PPrint| |TLog | |
| | |LType | |PType | + + |
| | + + + + |
| | |
| | + + |
| | |TMSG NOTEs | NAme filename |
| | | ERRORs| |
| | | OFF | SASLIB filename |
| | + + |
+--------------------------------------------------------------------+
where
filename is the name of a CMS disk file containing SAS program
statements. More than one filename can be specified. The
filetypes must be "SAS," and the files must contain fixed-
length 80-byte records. If no filenames are specified, SAS
executes in interactive mode.
Options
LDisk writes the SAS log to a CMS disk file with filetype
"SASLOG." The filename of the SASLOG file is determined by
the name of the first SAS source file (in interactive mode
the filename "SAS" is used), or by the NAME option.
LPrint sends the SAS log to a printer spool file.
LType types the SAS log at the terminal.
NAme filename
is the filename assigned to printed procedure output
(LISTING file), SAS log (SASLOG file), and TLOG output (SAS
file). "SAS" is the default filename.
Section 2: Command Descriptions 217
CMS Reference
| SAS (EXEC)
NOTLog suppresses recording of SAS statements in a CMS disk file.
This is the default.
PDisk writes the printed procedure output to a CMS disk file with
filetype "LISTING." The filename of the LISTING file is
determined by the name of the first SAS source file (in
interactive mode the filename "SAS" is used), or by the NAME
option.
PPrint sends the printed procedure output to a printer spool file.
PType types the printed procedure output at the terminal.
SASLIB filename
issues a FILEDEF with DD name "SASLIB" for the specified
TXTLIB. This TXTLIB is added to the TXTLIB's searched by
SAS.
TLog records SAS statements entered at the terminal in a CMS disk
file with a filetype of "SAS." The filename of the LISTING
file is determined by the NAME option. TLOG is only valid
in interactive mode.
TMSG level
controls which messages are typed at the terminal when not
in interactive mode. The default message level is ERRORS,
which displays only error messages. You can specify NOTES,
for notes and error messages, or OFF, to suppress all
messages.
Usage Notes
1. SAS has its own online help. Enter "help;" in interactive mode.
Also refer to SAS User's Guide: Basics, SAS Companion for the
VM/CMS Operating System, and SAS/FSP User's Guide.
2. End interactive SAS by entering "/*."
3. The SAS command links to and accesses the disk containing the SAS
modules and related files, then drops the link before completing.
If SAS ABEND's (or if you stop it with an HX) the link is not
dropped.
Messages and Return Codes
DMSSAS985E SAS requires at least 1M of storage. Use the STORAGE
command to increase your storage size. RC=25
Messages can be produced by SAS, and by the LINK and ACCESS commands.
Section 2: Command Descriptions 218
CMS Reference
SCAN
Use the SCAN command to check OS Job Control Language (JCL) syntax
without submitting a batch job.
+--------------------------------------------------------------------+
| | + + ++ |
| SCAN | fn | ft | fm || [(options... [)]] |
| | | JOB | * || |
| | | JCL + +| |
| | + + |
| | |
| | Options: |
| | |
| | + + + + + + |
| | | NOPRint | | TErm | | SOurce | |
| | | TYpe | | NOTErm | | NOSOurce | |
| | | DIsk | + + + + |
| | | PRint | |
| | + + |
| | |
| | + + + + + + + + |
| | | MVT | | UKcc | | PROClib | | NOSYsin | |
| | | MFT | | NOUKcc | | NOPROCli | | SYsin | |
| | + + + + + + + + |
+--------------------------------------------------------------------+
where
fn specifies the filename of the file to be scanned and the
filename of the listing output file, if any.
ft specifies the filetype of the file to be scanned. If
omitted, "JOB" and "JCL" will be used, in that order.
fm specifies the filemode of the file to be scanned. If not
specified, "*" will be assumed and all accessed disks
searched.
Options
DIsk writes the LISTING file on your A-disk.
NOPRint suppresses generation of the listing file.
NOTErm suppresses the TERM output.
MFT uses OS/360-MFT JCL syntax.
MVT uses OS/360-MVT JCL syntax.
Section 2: Command Descriptions 219
CMS Reference
SCAN
NOPROCli suppresses procedure library processing.
NOSOurce suppresses the JCL listing.
NOSYsin suppresses data listing.
NOUKcc will not process HASP or INCLUDE records.
PRint writes the LISTING file to a printer spool file.
PROClib causes a procedure library to be searched for referenced
procedures.
SOurce produces a JCL listing.
SYsin causes input stream data (DD * and DD DATA) to be listed.
TErm writes the diagnostic messages on the terminal.
TYpe writes the LISTING file to the terminal.
UKcc will cause HASP /* and SUBMIT command ..INCLUDE records to
be processed. Syntax is not checked for HASP control
records.
Usage Notes
1. If the DISK or SYSIN options are specified a write-accessed A-
disk is necessary for the "fn LISTING A1" and "SCAN SYSUT1 A3"
files.
2. Unless the NOPROC option is specified a procedure library will be
used. The default libraries are SYS4.PROCLIB and SYS2.PROCLIB.
Since these are assumed by default to reside on OS disks, OS
formatted disks containing these files must be accessed.
Currently both default proclib's are on volume UKC004. This disk
must be accessed before the SCAN command is issued (the OSDISKS
command should be used for this purpose).
3. It is possible to override the default proclib's used by SCAN.
The DD name used by SCAN for the proclib is IEFPDSI, so by
defining IEFPDSI with one or more FILEDEF commands and issuing a
GLOBAL command it is possible to specify any desired combination
of user and system libraries. The libraries may be on OS or CMS
disks, or both. The following example demonstrates this
capability:
OSDISK
FILEDEF IEFPDSI DISK MYLIB MACLIB * DSN MYLIB PROCLIB ( CONCAT
FILEDEF IEFPDSI DISK SYS4 MACLIB * DSN SYS4 PROCLIB ( CONCAT
GLOBAL MACLIB MYLIB SYS4
Section 2: Command Descriptions 220
CMS Reference
SCAN
SCAN MYJOB
This would cause MYLIB.PROCLIB and SYS4.PROCLIB to be used as
proclib's. Note that the CONCAT option must be used if more than
one proclib is to be used.
4. SCAN will clear all non-permanent FILEDEF's at completion.
5. There are several minor differences between the results obtained
from SCAN and those from the OS batch system:
(a) The CLASS parameter on the JOB card will not be
accepted as valid if it contains X or Z.
(b) The DLM parameter on the DD card must be enclosed
in single quotes if it contains special characters.
(c) The UKCC project number on the job card is not
checked for validity.
6. A null JCL statement will be generated at the end of a listing.
7. The //PROCLIB DD for user proclib's is not supported. A
//PROCLIB DD referring to a cataloged dataset will cause a
warning message to be issued; other forms will cause SCAN to
ABEND. To refer to other than the default system proclib's, use
the procedure above to define IEFPDSI.
8. SCAN checks only the syntax of JCL statements. There are many
other JCL-related errors that will not be caught. For example:
(a) Specifying a nonexistent program in the PGM
parameter of the EXEC card.
(b) Specifying a nonexistent dataset or volume.
(c) Specifying a nonexistent or inconsistent
unit in the UNIT parameter of the DD card.
9. The MSGLEVEL parameter on the JOB card can be used to control the
output produced by SCAN.
10. The message IEF110I will be issued if SCAN has insufficient
working storage to process your JCL. You can try breaking your
| JCL into smaller segments or redefining your storage size with
| the STORAGE command to circumvent this problem.
11. Help information is available for OS JCL. Enter "HELP JCL" for
details.
Section 2: Command Descriptions 221
CMS Reference
SCAN
Messages and Return Codes
DMSJCL001E NO FILENAME SPECIFIED RC=24
DMSJCL002E INPUT FILE "fn ft fm" NOT FOUND RC=28
DMSJCL002E PROCLIB FILES NOT FOUND RC=28
DMSJCL003E INVALID OPTION "option" RC=24
DMSJCL004W WARNING MESSAGES ISSUED RC=4
DMSJCL006E NO READ/WRITE "A" DISK ACCESSED FOR "fn LISTING A1" RC=36
DMSJCL008W ERROR MESSAGES ISSUED RC=8
DMSJCL012W SEVERE ERROR MESSAGES ISSUED RC=12
DMSJCL016W TERMINAL ERROR MESSAGES ISSUED RC=16
DMSJCL032E INVALID FILETYPE "ft" RC=24
DMSJCL044E RECORD LENGTH EXCEEDS ALLOWABLE MAXIMUM RC=32
DMSJCL048E INVALID MODE "fm" RC=24
DMSJCL062E INVALID "*" IN FILEID RC=20
DMSJCL062E INVALID CHAR IN FILEID "fn ft fm" RC=20
DMSJCL069E DISK "fm" NOT ACCESSED RC=36
DMSJCL104S ERROR "nn" READING FILE "fn ft fm" FROM DISK ABEND 001
DMSJCL105S ERROR "nn" WRITING FILE "fn ft fm" TO DISK ABEND 001
DMSJCL901T UNEXPECTED ERROR AT "address" ABEND 999
DMSJCL901T UNEXPECTED ERROR: PLIST "function", RC "nn" RC=256
IEE345I COMMAND AUTHORITY INVALID NON-FATAL
IEF110I Q MGR I/O ERR - JOBQUE FULL ABEND 1B0
IEF440I I/O ERROR IN THE JOB QUEUE 0042 ABEND 0B0
Section 2: Command Descriptions 222
CMS Reference
SCRIPT
Use the SCRIPT command to format documents and other text. SCRIPT
accepts text and control words as input and produces output suitable
for printing on a line printer or terminal. This is not a complete
description of the options available with the SCRIPT command.
+--------------------------------------------------------------------+
| | + + + + |
| SCript | filename [( |FFTOp n| |PLength nn| [)]] |
| | | ? | 4| |