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| | 66| |
| | + + + + |
+--------------------------------------------------------------------+
where
filename is the filename of the input file containing text and SCRIPT
control words. The filetype of the file must be "SCRIPT".
? causes a complete list of SCRIPT options to be displayed at
the terminal.
Options
FFTOp n is useful when the output will be printed on a line printer.
FFTOP indicates to SCRIPT which line on the page the printer
will be positioned to when SCRIPT issues a page eject. This
| may range from line 1 to 175. The default is 4; HASP
| printers at the UKCC are positioned to the fourth line of
the page by a page eject.
PLength nn
specifies the length of the output page in lines. This is
used to allow for different types of printers or terminals
and various paper sizes. This should be used to specify the
actual physical page size. The value of the .PL control
word is set by this option. The value may range from 10
lines to 32,767. The default is 66 (the normal value for 11
inch paper at 6 lines per inch).
Usage Notes
1. To print on every line on the page (including the top three
lines), output to be printed at the UKCC Computer Room (CENTRAL)
should be processed with "FFTOP 4" and "PLENGTH 66", and output
to be printed on the UKCC hands-on (HOT) printer should be
processed with "FFTOP 4" and "PLENGTH 68".
Section 2: Command Descriptions 223
CMS Reference
SCRIPT
2. When printing SCRIPT output, specify "PAGESIZE 0" and "SPACE W"
on the SETPRT or OUTPUT command. For more information on these
options, and for information on special forms, consult the OUTPUT
command description.
3. Before producing printed output from SCRIPT at a terminal (such
as an AJ833) you may want to suppress messages that could
interrupt your output. This could be done in a short EXEC:
| /* Suppress messages and SCRIPT */
| address command
| "CP SET ACNT OFF"
| "CP SET IMSG OFF"
| "CP SET MSG OFF"
| arg parms
| "SCRIPT" parms
| xc = rc
| "CP SET MSG ON"
| "CP SET IMSG ON"
| "CP SET ACNT ON"
| exit xc
This sample EXEC is available online in "PSCRIPT EXEC Y2."
4. The hyphenation exception dictionary is always included and does
not reduce the working storage available to SCRIPT. It is not
necessary to imbed SYSHYPH (".im syshyph" will be ignored), but
it is necessary to specify ".hy on" to enable hyphenation.
5. For more information about the SCRIPT command, refer to the
Waterloo SCRIPT Reference Manual, or issue the command "SCRIPT ?"
for a list of options at your terminal. Options are available to
direct SCRIPT output to a disk file, printer, or terminal, and to
control other aspects of SCRIPT processing.
Section 2: Command Descriptions 224
CMS Reference
SELECT
Use the SELECT command to search one or more CMS disk files for lines
containing a specified character string. The selected lines may be
| typed, stacked, or written to another CMS disk file. Some of these
| functions are available from the EXECIO command.
+--------------------------------------------------------------------+
| | |
| SELECT | fileid1 [fileidn...] [( [options...] [)]] |
| | |
| | Options: |
| | |
| | STARTRec n STARTCol n DATAColumn n ALl |
| | SRecord n SColumn n DColumn n ANchor |
| | ENDRecord n ENDColumn n DATAEnd n ORDer |
| | ERecord n EColumn n DEnd n BInary |
| | |
| | | Counts FINd n Key string + + |
| | | Cnts DISPlay n IGnore Case |char | |
| | | STKCounts NODISPlay NOIGnore Case SKip |BLanks| |
| | | STKCnts |NUlls | |
| | | |ZEros | |
| | | + + Prefix + + |
| | |Append fileid| |
| | |DISk fileid | NOMessage |
| | |FIFo | NOMsg |
| | |LIfo | NOPrompt |
| | |Terminal | |
| | |Type | Header |
| | |NOTerminal | Hdr |
| | |NOType | |
| | |STACk | |
| | + + |
+--------------------------------------------------------------------+
where
fileid1 is the fileid of the first file to be searched. The default
filemode is "*."
fileidn is one or more additional input files. Any part of these
fileids may be specified as "=" to use the corresponding
part of the pervious fileid.
Options
ALl selects all lines in the specified file or files.
Section 2: Command Descriptions 225
CMS Reference
SELECT
ANchor checks only one substring in each line. The substring
checked begins at STARTCOL (default 1) and is the length of
the selector (KEY) string. The line is rejected if this
doesn't match.
Append fileid
specifies the CMS disk file to which selected lines will be
appended. If the file does not exist it will be created.
The APPEND and DISK options may not be specified together.
BInary is used for searching files sorted in ascending order.
Specifying BINARY implies ORDER, ANCHOR, and FIND 1. If the
file contains more than one line containing the key, the
| first occurrence will be returned. You should use the
| STARTCOL and ENDCOL options to define the field to be
checked in each line. BINARY searching can significantly
reduce the time and resources used by SELECT.
Cnts causes a count of the selected lines to be displayed.
Counts is a synonym for CNTS.
DATAColu n
is the first column of the data to be used for output from
selected lines. The default is 1.
DATAEnd n is the last column of the data to be used for output from
selected lines. The default is "*", the end of the line.
DColumn is a synonym for DATACOLUMN.
DISk fileid
specifies the CMS disk file to which selected lines will be
written. If the file already exists it will be replaced.
The APPEND and DISK options may not be specified together.
DISPlay n specifies the number of selected lines to be output. The
default is "*," all of the selected lines.
DEnd n is a synonym for DATAEND.
EColumn n specifies the last column of the input lines to be searched.
The default is "*", the entire line.
ERecord n specifies the last line of each input file to be searched.
The default is "*", the entire file.
ENDColum n
is a synonym for ECOLUMN.
ENDRecor n
is a synonym for ERECORD.
Section 2: Command Descriptions 226
CMS Reference
SELECT
FIFo indicates that selected lines are to be stacked first-in,
first-out. FIFO overrides the default TYPE option.
FINd n specifies the number of lines to be selected from each input
file. Searching ends when the limit is reached. The
default is "*," no limit.
Hdr will cause each input file to be identified at the terminal.
Header is a synonym for HDR.
IGnore Case
causes the difference between uppercase and lowercase
letters to be ignored during the search. This is the
default.
Key string
specifies the target string for searching. The string is
limited to eight non-blank characters and is translated to
uppercase before use. If the KEY option is not used, the
target string will be read from the CMS program stack or
console (unless the ALL option was specified). Strings read
this way may contain up to 130 characters (255 characters
| for input from the stack), may include blanks, and are not
| translated to uppercase.
LIfo causes selected lines to be stacked last-in, first-out.
This option overrides the default TYPE option.
NODISPlay is the same as specifying "DISPLAY 0." This will suppress
the output of selected lines.
NOIGnore Case
will cause the difference between uppercase and lowercase
letters to be significant during the search.
NOMessag suppresses the warning message if no lines are selected.
NOMsg is a synonym for NOMESSAGE.
NOPrompt suppresses the prompt for the target string. The prompt is
only issued if the KEY and ALL options were not specified
and the stack is empty.
NOTermin suppresses the default TYPE output of selected lines.
NOType is a synonym for NOTERMINAL.
ORDer causes searching in a file to stop when a string in a line
is "greater than" the selector (KEY) string. This is used
in combination with the ANCHOR option for faster searches of
Section 2: Command Descriptions 227
CMS Reference
SELECT
files that are kept in ascending order by some field (such
as a list of names in alphabetic order). See also the
BINARY option.
Prefix causes each output line to be prefixed by its line number in
the file in which it was found. The PREFIX number will be
eight digits followed by one space.
SColumn n specifies the first column to be searched in each input
line. The default is one.
| SKip char causes lines beginning with the specified character to be
| skipped. Specify a single character, BLANKS, NULLS, or
| ZEROS.
SRecord n specifies the first line to be searched in each input file.
The default is one.
STACk specifies that selected lines are to be stacked. This
option overrides the default TYPE output. STACK is a
synonym for FIFO.
STARTCol n
is a synonym for SCOLUMN.
STARTRec n
is a synonym for SRECORD.
STKCnts causes a line containing the number of selected lines to be
stacked. If the selected lines are being stacked, this line
will precede any data lines.
STKCounts is a synonym for STKCNTS.
Terminal causes selected lines to be typed on the terminal. This is
the default unless another output option is selected.
Type is a synonym for TERMINAL.
Usage Note
SELECT searchs every specified line in each input file between the
specified columns for the target (KEY) string. Every possible
substring in the lines searched is examined. If the target string is
known to begin in a specific column, use the ANCHOR and column options
to limit the search to the single substring beginning in that column.
This can result in considerable savings of resources required for the
search. If the file is sorted in ascending order by the specified
field, the ORDER option can be used to stop searching after passing
the target string or the position where it would be in the file. The
BINARY option provides the best performance for sorted files.
Section 2: Command Descriptions 228
CMS Reference
SELECT
Messages and Return Codes
DMSSEL001E No input data file name was specified. RC=24
DMSSEL002E The input file "fileid" could not be found. RC=28
DMSSEL002E No input file was found. RC=28
DMSSEL003E "name" is not an option. RC=24
DMSSEL019E Input and output files are the same. RC=24
DMSSEL029E "name" is not a valid argument for the name option. RC=24
DMSSEL054E Incomplete fileid beginning with "string". RC=24
DMSSEL066E "APPEND" and "DISK" are conflicting options. RC=24
DMSSEL104S Error n occurred while reading the file "fileid". RC=100
DMSSEL105S Error n occurred while writing the file "fileid". RC=100
DMSSEL973E No entry containing the key was found. RC=1
Section 2: Command Descriptions 229
CMS Reference
SENDFILE (EXEC)
Use the SENDFILE command to send CMS disk files to other users. The
receiving users can use the PEEK and ACCEPT commands to examine and
save the files. This is a description of the simplest form of the
SENDFILE command; other functions and options are available.
+--------------------------------------------------------------------+
| | |
| SENDFile | fn ft [fm] [TO] name [name...] [( options... [)]] |
| SFile | |
| | Options: |
| | |
| | + + + + + + |
| | |NOAck| |NOFilelist| |Log | |
| | |Ack | |Filelist | |NOLog| |
| | + + + + + + |
+--------------------------------------------------------------------+
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 filemode may be
omitted if the first name would not be misinterpreted as a
filemode, or if the TO parameter is specified. The default
filemode is "*" (search all accessed minidisks).
TO marks the beginning of the names. This parameter is not
required if the first name is not "TO".
name is the name of a user to receive the file. 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.
Options
Ack requests that an acknowledgment be returned to you when a
recipient receives your file (with the ACCEPT, PEEK, BURN,
or RECEIVE command). No acknowledgment is sent if the
recipient purges the file with the PURGE RDR command, or if
the system purges the file.
Filelist indicates that the file specified in the parameters contains
a list of file identifiers. This file must be in the format
of the CMS EXEC file produced by the LISTX and LISTFILE
commands with their EXEC options specified. The file
Section 2: Command Descriptions 230
CMS Reference
SENDFILE (EXEC)
containing the list of file identifiers is transmitted in
addition to the files named.
Log specifies that the recipients and time of this transmission
are to be logged in a file called "userid NETLOG" (where
"userid" is your userid). This file is also updated when
acknowledgments are received. LOG is the default.
NOAck requests that no acknowledgment be returned to you. This is
the default.
NOFilelist
indicates that only the single file specified is to be sent.
This is the default.
NOLog suppresses transmission logging.
Usage Notes
1. The files sent by the SENDFILE command are sent as reader spool
files in NETDATA format. The recipients may examine the files
with the PEEK command, or copy them to permanent CMS disk files
with the ACCEPT command.
2. The default options of the SENDFILE 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 SENDFILE 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, NOTE, and
NAMEFIND commands. Refer to the VM/SP CMS Command and Macro
Reference or to the online HELP command for more information.
Section 2: Command Descriptions 231
CMS Reference
SENTRIES
Use the SENTRIES command to determine the number of lines in the CMS
program stack. The number of lines in the program stack (this does
not include lines entered from the terminal) is returned as a return
code.
+--------------------------------------------------------------------+
| | |
| SENTRIES | |
| | |
+--------------------------------------------------------------------+
Usage Notes
1. Use the CHECKBUF command to determine the number of lines in the
most recently created program stack buffer.
| 2. When SENTRIES is executed in an EXEC with an &ERROR or SIGNAL ON
| ERROR in effect, the non-zero return code will cause the error
action to be taken if there are lines in the stack.
Messages and Return Codes
SENTRIES produces no messages.
Section 2: Command Descriptions 232
CMS Reference
SET (CMS and CP)
Use the SET command to control CMS and CP options. There are distinct
CMS and CP commands named "SET", but the CMS command will pass
unrecognized parameters to the CP command if IMPCP is ON. In most
cases SET can be considered to be a CMS command. This description
includes the most often needed parameters of both commands.
+--------------------------------------------------------------------+
| | |
| SET | function |
| | |
| | CP Functions: CMS Functions: |
| | |
| | EMSG [ON|TEXT|OFF] ABBREV [ON|OFF] |
| | IMSG [ON|OFF] AUTOREAD [ON|OFF] |
| | LINEDit [ON|OFF] BLIP [ON|OFF|string] |
| | MSG [ON|OFF] CMSTYPE [HT|RT] |
| | | PFnn [IMMed|DELayed] [data] EXECTRACE [ON|OFF] |
| | PFnn RETrieve IMMEDIATE [ON|OFF] |
| | IMPCP [ON|OFF] |
| | IMPEX [ON|OFF] |
| | INPUT char1 char2 |
| | OUTPUT char1 char2 |
| | RDYMSG [$MSG|SMSG|LMSG] |
| | |
+--------------------------------------------------------------------+
where
(Each function is marked "CMS" or "CP" to indicate the command used.)
ABBREV [ON|OFF]
(CMS) controls whether abbreviations are accepted for CMS
command names. The initial setting is "ON". Use the
SYNONYM command to define your own command synonyms and
abbreviations.
AUTOREAD [ON|OFF]
(CMS) controls whether a console read will be issued after
each command. The initial setting for 3270-type terminals
is OFF; for others it is ON. The setting is not
automatically changed if you disconnect from one kind of
terminal and reconnect with another kind. The default
setting is generally the more convenient.
BLIP [ON|OFF|string]
(CMS) controls the display of a "blip" after each two
seconds of virtual CPU time. The initial setting for
3270-type terminals is OFF; for others it is ON. The
default BLIP is a two character string that is not visible
Section 2: Command Descriptions 233
CMS Reference
SET (CMS and CP)
on most terminals. You will probably want to SET BLIP OFF
(this could be placed in your PROFILE EXEC).
CMSTYPE [HT|RT]
(CMS) is used to control CMS terminal output from an EXEC.
SET CMSTYPE HT will halt typing at the terminal until a SET
CMSTYPE RT (resume typing) or the end of the EXEC. Severe
error messages (code S and T) cannot be suppressed. This
command provides functions similar to the CMS immediate
commands HT and RT.
EMSG [ON|CODE|OFF]
(CP) controls the display of error messages at your
terminal. The initial setting is TEXT, which causes only
the text of error messages to be displayed. Setting EMSG to
ON will cause the message code and text to be displayed.
You may want to place a CP SET EMSG ON command in your
PROFILE EXEC. You can use the OFF setting to suppress error
messages during an EXEC. Some messages (severity codes R,
S, and T) will always be displayed as if EMSG were ON. The
description of the CMSEMSG command contains more information
about message severity codes.
| EXECTRACe [ON|OFF]
| (CMS) controls interactive tracing for EXEC's written in
| REXX or EXEC 2.
IMMEDIATE [ON|OFF]
(CMS) controls the CMS immediate commands (HT, HX, etc.).
The initial setting is ON, which allows the immediate
commands to operate. Setting IMMEDIATE to OFF will cause
the immediate commands to be ignored.
IMPCP [ON|OFF]
(CMS) controls 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).
IMPEX [ON|OFF]
(CMS) controls 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.
IMSG [ON|OFF]
(CP) controls the display of some informational messages
from CP, including the message that is issued when you
Section 2: Command Descriptions 234
CMS Reference
SET (CMS and CP)
receive a spool file. The initial setting is ON. The
commands affected include ORDER, PURGE, and TRANSFER. You
can use CP SET IMSG OFF in an EXEC to suppress unwanted
informational messages.
INPUT char1 char2
(CMS) causes all occurrences of "char1" in input from the
terminal to be translated to "char2". You may use either a
character or a hexadecimal value for "char1"; "char2" must
always be specified in hexadecimal. CP may perform
additional translations before presenting input characters
to CMS (translating from ASCII to EBCDIC, for example).
LINEDIT [ON|OFF]
(CP) controls the use of CP line editing characters. The
initial setting is ON. The actual line editing characters
are defined with the CP command TERMINAL. Refer to the
description of the TERMINAL command for more information.
MSG [ON|OFF]
(CP) controls the display of messages from other users. The
initial setting is ON. Other users can use the TELL and
MESSAGE commands to send messages to you. You may want to
suppress messages from other users when you are producing
output (such as from SCRIPT) at a printing terminal.
Setting MSG to OFF will also suppress messages from the OS
batch system, HASP, RSCS, AUTOLINK, and some other system
services. This will not affect warnings from the system
operator.
OUTPUT char1 char2
(CMS) causes all occurrences of "char1" in output to the
terminal to be translated to "char2". You must use
| hexadecimal to specify "char1"; "char2" must be a single
| character. The CMS command CASE can also be used to define
output translations. CP may perform additional translations
before actually writing to your terminal (translating from
EBCDIC to ASCII, for example).
PFnn [IMMed|DELayed] [data]
PFnn RETrieve
(CP) defines a Program Function (PF) key setting for a 3101
or 3270-type terminal. In the first form of the command the
specified "data" will be entered when the specified PF key
is pressed. The "data" can be entered immediately (IMM), or
after pressing the ENTER key (DELAY). The default mode is
DELAY. Refer to the description of the RETRIEVE command for
more information about that function.
RDYMSG [$MSG|SMSG|LMSG]
Section 2: Command Descriptions 235
CMS Reference
SET (CMS and CP)
(CMS) controls the format of the CMS ready message displayed
at the completion of each CMS command. The initial setting
is $MSG, which displays the time and the cost of executing
the command. The LMSG setting displays the virtual and
total CPU times instead of the cost. The SMSG setting
displays only "R;". With any setting, a non-zero return
code from a command will also be displayed.
Usage Notes
1. Only one function may be specified.
2. The SET command must be prefixed by "CP" to use the CP SET
functions from an EXEC.
| 3. Use the QUERY command to determine the current value of most SET
functions. The CP QUERY SET command will display all of the CP
SET values.
4. Both the CMS and CP SET commands have additional functions. For
more information refer to either the online HELP command or to
the VM/SP CP Command Reference for General Users and the VM/SP
CMS Command and Macro Reference.
Messages and Return Codes
Messages may be produced by either the CP or the CMS SET 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 236
CMS Reference
SETCON
Use the SETCON command to control recording of the console log and to
prepare it for printing.
+--------------------------------------------------------------------+
| | + + + + + + + + |
| SETCON | |STart| |CLose| |CONTinuous | |User userid| |
| | |STOp | |PUrge| |NOCONTinuous| |To userid | |
| | |OFf | + + + + |Route dest | |
| | + + + + |
| | |
| | [Pagesize n] [Space x] [Forms nnnn] [Copies n] |
| | |
| | [DOCument] [Name name [type]] |
| | |
+--------------------------------------------------------------------+
where
CLose closes the console log. Recording continues if started.
The closed console log becomes a spool file that is sent to
the user specified by the USER option. The default is to
send the file to HASP to be printed at the UKCC.
CONTinuo causes CLOSE requests to be ignored until NOCONTINUOUS is
specified.
Copies n is the number of copies to be printed. The default is one
copy. This option applies only to output routed to a HASP
printer (except the HOT printer).
DOCument has the effect of specifying PAGESIZE 0 and FORMS NT. This
option applies only to output routed to a HASP printer.
Forms nnnn
specifies the printer forms to be used. The default is
standard (STD.) forms. This option applies only to output
routed to a HASP printer. Refer to the description of the
OUTPUT command FORMS option for more information.
K n is a synonym for PAGESIZE.
Linect n is a synonym for PAGESIZE.
N n is a synonym for COPIES.
Name name [type]
is used with the CLOSE option to set the spool file name and
type. This identifier is used by HASP when assigning job
names and by the ACCEPT and INPUT commands when assigning
Section 2: Command Descriptions 237
CMS Reference
SETCON
CMS disk fileids. The second part of the name is optional
if NAME is the last option specified.
NOCONTin resets the continuous spooling option. NOCONT is the
initial setting.
OFf stops console spooling and purges any already spooled lines.
OFF is equivalent to specifying STOP and PURGE.
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.
PUrge purges the console log. Recording continues if started.
Specify OFF to stop recording and purge any recorded data.
Route dest
specifies the destination of the printed output. The
default routing is to CENTRAL. Any of the following may be
specified:
Central HASP Printer in the UKCC Computer Room
Hot HASP Hands-on (HOT) Printer at the UKCC
Local Synonym for CENTRAL (This option is not
recommended and is provided only for
compatibility with older applications.)
Pnnnn RSCS Remote Printer "nnnn"
RMTnn HASP Remote Site "nn"
| Terminal Is the same as specifying "TO *"
userid Any VM/SP Userid (Reader Spool File)
Space x 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.
STart causes console recording to begin. Recording continues
until STOP is specified.
STOp stops console recording, but does not close or purge any
already recorded console log. Use OFF top STOP and PURGE.
To userid will cause the console log to be sent to the specified user
as a reader spool file rather than to be printed. Specify
"*" to send the file to your own reader. Specify "SAME" to
leave the destination userid unchanged. SAME should not be
specified the first time SETCON is issued during a terminal
session.
User is a synonym for TO.
Section 2: Command Descriptions 238
CMS Reference
SETCON
Usage Notes
1. Issuing the SETCON command will cause the system to record input
from and output to the terminal for later examination or
printing. This is useful for display terminals to provide a
record of the session, and is very useful when trying to diagnose
errors that may have occurred during the session. BROWSE, FLIST,
XEDIT, and other commands that operate in a full-screen mode on a
3270-type terminal are exceptions to this rule; little or no
recording is done for these programs. Data entered when display
is suppressed (such as passwords) are not recorded.
A useful technique is to issue the command "SETCON TO *" at the
beginning of a terminal session (possibly in the PROFILE EXEC).
Then logging off or issuing a "SETCON CLOSE TO *" command will
cause the console log to be sent to your own reader. The reader
spool file can then be examined with the PEEK, RBROWSE, or RXEDIT
command, printed or sent to another user with the OUTPUT command,
or copied into a CMS disk file with the ACCEPT command.
2. You will receive a message when the console is closed and the
file is accepted by HASP or RSCS for printing. This message will
contain the identifier assigned to the printed output. If the
output was routed to the UKCC hands-on (HOT) printer in McVey
Hall, another message is sent when it begins printing.
If you log off, the console will automatically be closed by the
system. (The CMS LOGOFF command will ask if the spooled console
log should be kept. If not needed it can be purged.) The RUNID
command can later be used to recover the runid assigned if the
console was routed CENTRAL.
3. Refer to the OUTPUT command description for restrictions
regarding the FORMS, ROUTE, and COPIES options.
Messages and Return Codes
DMSSCN003E "name" is not a valid option. RC=24
DMSSCN029E Invalid parameter "parm" in the option field. RC=24
Messages may also be produced by the CLOSE, SPOOL, and TAG commands.
Section 2: Command Descriptions 239
CMS Reference
SETPRT
Use the SETPRT command to prepare your printer for hardcopy output.
+--------------------------------------------------------------------+
| | + + + + + + + + |
| SETPRT | |CLose| |GRoup | |CONTinuous | |User userid| |
| | |PUrge| |ENdgroup| |NOCONTinuous| |To userid | |
| | + + + + + + |Route dest | |
| | + + |
| | |
| | [Pagesize n] [Space x] [Forms nnnn] [Copies n] |
| | |
| | + + + + |
| | [Name name [type]] |DOCument| |Device addr| |
| | |LABels | | 00E | |
| | + + + + |
+--------------------------------------------------------------------+
where
CLose causes the printer to be closed. This is used in
conjunction with the NOCONT or GROUP options.
CONTinuo causes CLOSE requests to be ignored until NOCONT or ENDGROUP
has been specified. This includes automatic closes
performed by commands such as PRINT and SCRIPT.
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).
Device 00E
specifies the virtual address of the printer device. This
option is present for special purposes and should not
normally be used.
DOCument has the effect of specifying PAGESIZE 0 and FORMS NT. This
option applies only to output routed to a HASP printer.
ENdgroup is used to indicate the end of a printing group. This is
equivalent to specifying NOCONT and CLOSE. Any options
specified with ENDGROUP will override those specified on the
SETPRT GROUP command.
Forms nnnn
specifies the printer forms to be used. The default is
standard (STD.) forms. This option applies only to output
routed to a HASP printer. Refer to the description of the
OUTPUT command FORMS option for more information.
Section 2: Command Descriptions 240
CMS Reference
SETPRT
GRoup is used for setting the printer to print a group of files
together. This is equivalent to specifying CONTINUOUS.
CLOSE requests, including automatic closes performed by the
PRINT and SCRIPT commands, are ignored until NOCONT or
ENDGROUP is specified. Any other options specified with
GROUP will be overridden by the options specified on the
SETPRT ENDGROUP command.
K n 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. Refer to the description of the
OUTPUT command for more information.
Linect n is a synonym for PAGESIZE.
N n is a synonym for COPIES.
Name name [type]
is used with the CLOSE and ENDGROUP options to set the spool
file name and type. This identifier is used by HASP when
assigning job names and by the ACCEPT and INPUT commands
when assigning disk fileids. The second part of the name is
optional if NAME is the last option specified.
NOCONTin resets the continuous spooling option. NOCONT is the
initial setting.
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.
PUrge causes any printed lines generated but not yet closed to be
deleted. PURGE forces the CLOSE and NOCONT options.
Route dest
specifies the destination of the printed output. The
default routing is to CENTRAL. Any of the following may be
specified:
Central HASP Printer in the UKCC Computer Room
Hot HASP Hands-on (HOT) Printer at the UKCC
Local Synonym for CENTRAL (This option is not
recommended and is provided only for
compatibility with older applications.)
Pnnnn RSCS Remote Printer "nnnn"
RMTnn HASP Remote Site "nn"
| Terminal Is the same as specifying "TO *"
userid Any VM/SP Userid (Reader Spool File)
Section 2: Command Descriptions 241
CMS Reference
SETPRT
Space x 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 only applies to output routed to a HASP printer.
To userid will cause print files to be sent to the specified user
rather than to be printed. Specify "*" to send the file to
your own reader. Specify "SAME" to leave the destination
userid unchanged. SAME should not be specified the first
time SETPRT is issued during a terminal session.
User is a synonym for TO.
Usage Notes
1. Issuing the SETPRT command will set your printer so that all
printed output you generate (such as from the PRINT and SCRIPT
commands) will be sent to the specified printer or user.
A useful technique is to issue the command "SETPRT TO *" at the
beginning of a terminal session (possibly in the PROFILE EXEC).
This will cause printed files to be sent to your own reader. The
reader spool file can then be examined, copied into a CMS disk
file with the ACCEPT or INPUT commands, or sent to another user
with the OUTPUT command.
2. You will receive a message when the console is closed and the
file is accepted by HASP or RSCS for printing. This message will
contain the identifier assigned to the printed output. If the
output was routed to the UKCC hands-on (HOT) printer in McVey
Hall, another message is sent when it begins printing.
3. You should always specify DOCUMENT or PAGESIZE 0 when using
SCRIPT, since SCRIPT will control page skipping itself.
4. Refer to the description of the OUTPUT command for restrictions
on the FORMS, ROUTE, and COPIES options.
5. Refer to the description of the PRINT command for some examples
of the use of the SETPRT command.
Messages and Return Codes
DMSSPT003E "name" is not a valid option. RC=24
DMSSPT029E "name" is not valid in the option field. RC=24
Messages may also be produced by the CP commands CLOSE, TAG, and
TRANSFER.
Section 2: Command Descriptions 242
CMS Reference
SETPUN
Use the SETPUN command to prepare your punch for hardcopy printed
output. Output processed in this manner will be printed, not punched.
An OS batch job must be used to produce punched output on cards.
+--------------------------------------------------------------------+
| | + + + + + + + + |
| SETPUN | |CLose| |GRoup | |CONTinuous | |User userid| |
| | |PUrge| |ENdgroup| |NOCONTinuous| |To userid | |
| | + + + + + + |Route dest | |
| | + + |
| | |
| | [Pagesize n] [Space x] [Forms nnnn] [Copies n] |
| | |
| | + + + + |
| | [Name name [type]] |DOCument| |Device addr| |
| | |LABels | | 00D | |
| | + + + + |
+--------------------------------------------------------------------+
where
CLose causes the punch to be closed. This is used in conjunction
with the NOCONT or GROUP options.
CONTinuo causes CLOSE requests to be ignored until NOCONT or ENDGROUP
has been specified. This includes automatic closes
performed by commands such as DISK DUMP, PUNCH, and SUBMIT.
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).
Device 00D
specifies the virtual address of the punch device. This
option is present for special purposes and should not
normally be used.
DOCument has the effect of specifying PAGESIZE 0 and FORMS NT. This
option applies only to output routed to a HASP printer.
ENdgroup is used to indicate the end of a punch group. This is
equivalent to specifying NOCONT and CLOSE. Any options
specified with ENDGROUP will override those specified on the
SETPUN GROUP command.
Forms nnnn
specifies the printer forms to be used. The default is
standard (STD.) forms. This option applies only to output
routed to a HASP printer. Refer to the description of the
OUTPUT command FORMS option for more information.
Section 2: Command Descriptions 243
CMS Reference
SETPUN
GRoup is used for setting the punch to print a group of files
together. This is equivalent to specifying CONTINUOUS.
CLOSE requests, including automatic closes performed by the
SUBMIT and other commands, are ignored until NOCONT or
ENDGROUP is specified. Any other options specified with
GROUP will be overridden by the options specified on the
SETPUN ENDGROUP command.
K n 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. Refer to the description of the
OUTPUT command for more information.
Linect n is a synonym for PAGESIZE.
N n is a synonym for COPIES.
Name name [type]
is used with the CLOSE and ENDGROUP options to set the spool
file name and type. This identifier is used by HASP when
assigning job names and by the ACCEPT and INPUT commands
when assigning CMS disk fileids. The second part of the
name is optional if NAME is the last option specified.
NOCONTin resets the continuous spooling option. NOCONT is the
initial setting.
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.
PUrge causes any punched lines generated but not yet closed to be
deleted. PURGE forces the CLOSE and NOCONT options.
Route dest
specifies the destination of the printed output. The
default routing is to CENTRAL. Any of the following may be
specified:
Central HASP Printer in the UKCC Computer Room
Hot HASP Hands-on (HOT) Printer at the UKCC
Local Synonym for CENTRAL (This option is not
recommended and is provided only for
compatibility with older applications.)
Pnnnn RSCS Remote Printer "nnnn"
RMTnn HASP Remote Site "nn"
| Terminal Is the same as specifying "TO *"
userid Any VM/SP Userid (Reader Spool File)
Section 2: Command Descriptions 244
CMS Reference
SETPUN
Space x 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 punch files to be sent to the specified user
rather than to be printed. Specify "*" to send the file to
your own reader. Specify "SAME" to leave the destination
userid unchanged. SAME should not be specified the first
time SETPUN is issued during a terminal session.
User is a synonym for TO.
Usage Notes
1. Issuing the SETPUN command will set your punch so that all
punched output you generate (such as from the DISK DUMP or PUNCH
commands) will be sent to the specified printer or user.
A useful technique is to issue the command "SETPUN TO *" at the
beginning of a terminal session (possibly in the PROFILE EXEC).
This will cause punched files to be sent to your own reader. The
reader spool file can then be examined, copied into a CMS disk
file with the ACCEPT command, or sent to another user with the
OUTPUT command.
2. You will receive a message when the console is closed and the
file is accepted by HASP or RSCS for printing. This message will
contain the identifier assigned to the printed output. If the
output was routed to the UKCC hands-on (HOT) printer in McVey
Hall, another message is sent when it begins printing.
3. Refer to the description of the OUTPUT command for restrictions
on the FORMS, ROUTE, and COPIES options.
4. Refer to the description of the PRINT command for some examples
of the use of the SETPUN command.
Messages and Return Codes
DMSSPN003E "name" is not a valid option. RC=24
DMSSPN029E "name" is not valid in the option field. RC=24
Messages may also be produced by the CP commands CLOSE, TAG, and
TRANSFER.
Section 2: Command Descriptions 245
CMS Reference
SORTF
Use the SORTF command to create a file sorted in a specified order.
| SORTF is from 3 to 90 times faster than the CMS command SORT. SSORT
| (SyncSort) is usually faster than either SORT or SORTF.
+--------------------------------------------------------------------+
| | |
| SORTF | ifileid1 ofileid |
| | |
+--------------------------------------------------------------------+
where
ifileid is the fileid of the input file. The records may be fixed-
length or variable-length.
ofileid is the fileid of the output file. Parts of the fileid may
be specified with "=" and the output file may be the same as
the input file.
Usage Notes
1. After entering the command you will be prompted to enter the sort
field descriptions. The sort fields are entered in the form:
s e [type] [seq] [s e [type] [seq]] ...
where "s" is the starting sort column, "e" is the ending sort
column, "type" is an optional description of the data type, and
"seq" is an optional sort sequence indicator. The sort types
supported are:
CH Character (default) PD Packed Decimal
FI Fixed Binary ZD Zoned Decimal
FL Floating-Point
The sort sequence may be specified as:
A Ascending (default)
D Descending
E Alphabetic (ignores uppercase/lowercase distinction,
blanks, and special characters)
Multiple sort fields may be entered (on one line), limited to a
total width of 256 characters. All sort fields must be in the
first 256 characters of the input records. If the "type" and
"seq" specifications are both used they must be entered in the
order shown. Floating-point data must be normalized to obtain a
correct sort.
Section 2: Command Descriptions 246
CMS Reference
SORTF
2. SORTF can use reader spool files for input and punch spool files
for output, but this feature is not supported. Use RDR1 for the
input fileid to indicate that input is from a reader file, and
PUN1 for the output fileid to indicate that output is a punch
file. Spool file input and output may not function correctly in
all cases. Sorting from a CMS disk file with variable-length
records to the punch will sometimes cause a large number of
extraneous blank records to be produced in the output file.
If the input file is not a CMS disk file and SORTF cannot
determine the length of the input records, you will be prompted
to enter the input record length and the number of input records.
If you know the number of records enter the exact value;
otherwise enter a value that is larger than the actual count.
The sort will fail if you underestimate the number of records.
Messages
MWCSRT2E FILE 'fileid' NOT FOUND
MWCSRT5E INVALID PARAMETER 'name'
MWCSRT9E COLUMN 'nn' EXCEEDS RECORD LENGTH
MWCSRT37E DISK 'mode' IS READ/ONLY
MWCSRT53E INVALID SORT FIELD PAIR DEFINED
MWCSRT55E INVALID SORT TYPE 'type'
MWCSRT56E INVALID SEQUENCE SPECIFICATION 'spec'
MWCSRT58E END-OF-FILE OR END-OF-TAPE
MWCSRT62E INVALID '*' IN FILEID 'fileid'
MWCSRT63E NO LIST ENTERED
MWCSRT70E INVALID PARAMETER 'name'
MWCSRT71E INVALID PARAMETER LIST
MWCSRT104S ERROR 'nn' READING FILE 'fileid'
MWCSRT105S ERROR 'nn' WRITING FILE 'fileid'
MWCSRT109S VIRTUAL STORAGE CAPACITY EXCEEDED
MWCSRT110S ERROR READING device
MWCSRT111S ERROR WRITING device
MWCSRT113S device NOT ATTACHED
MWCSRT205W READER EMPTY OR NOT READY
MWCSRT215E SORT TOO LARGE - INCREASE MACHINE SIZE BY nnnK
MWCSRT390E INPUT BLOCKSIZE nnn NOT INTEGRAL MULTIPLE OF LRECL
MWCSRT391E INVALID RETURN CODE nn FROM exit FLAGS xxxx
MWCSRT393E INVALID NUMERIC FIELD 'field'
MWCSRT604R ENTER SORT FIELDS:
MWCSRT650R ENTER INPUT LRECL:
MWCSRT651E SENSE DATA xxxx
MWCSRT652I INPUT TAPE UNLOADED; CR WHEN OUTPUT TAPE IS READY
MWCSRT653R ENTER ESTIMATED NUMBER OF RECORDS:
MWCSRT654I OUTPUT BLOCKSIZE nnn
MWCSRT658E NUMBER OF INPUT RECORDS EXCEEDS ESTIMATE
Section 2: Command Descriptions 247
CMS Reference
SPELL (EXEC)
Use the SPELL command to check the spelling of one or more words
| entered as parameters on the command line. A list of alternative
| spellings is displayed.
+--------------------------------------------------------------------+
| | |
| SPELL | word [word...] |
| | |
+--------------------------------------------------------------------+
where
word is one or more words to be checked.
Usage Notes
1. SPELL cannot detect an incorrectly used word, and some
misspellings can result in a correctly spelled, but spurious,
word. There is currently no checking for capitalization. SPELL
| has a limited vocabulary (currently about 90,000 words) and will
| flag as incorrect any word not known to it.
2. Lexicon files named JARGON and USER will automatically be used if
they are present. A default JARGON LEXICON file containing
computer-related and locally used words and abbreviations is
supplied. You may supply your own version of these lexicons (a
JARGON LEXICON file containing words related to your own field or
specialty, for example), or you can create a dummy file to
prevent the default file from being used. You also can supply an
additional USER LEXICON file.
3. Please report any errors or omissions that you discover in our
lexicons. Contact the Systems Programming group at the UKCC.
4. SPELL uses the SPELLCHK command to check the specified words.
Messages and Return Codes
| DMSSPE070E You didn't supply a word to be checked. RC=24
Messages may also be produced by the SPELLCHK command.
Section 2: Command Descriptions 248
CMS Reference
SPELLCHK
Use the SPELLCHK command to search a CMS disk file or stack and
terminal input for words that are misspelled, or to generate
alternative spellings for a given word. The incorrect words can be
typed, stacked, or written to another CMS file. SPELLCHK is the basis
for the SPELL and SPELLFIX commands.
+--------------------------------------------------------------------+
| | + + |
| SPELLCHK | |fn [ft [fm]]| [( [options...] [)]] |
| | |? | |
| | + + |
| | |
| | Options: |
| | |
| | + + + + + + + + + + |
| | |CHEck| |SLAng | |IGnore | |NOSingle| |NOSTutter| |
| | |Guess| |NOSLAng| |REspect| |SINgle | |STUtter | |
| | + + + + |FIRst | + + + + |
| | + + |
| | + + |
| | [ABBreviate] [NUmber] [All] |APpend | |
| | |Disk | |
| | | [User (fn [fn...])] [ONLYUser] |FIFo | |
| | |LIfo | |
| | | [FRom n] [TO n] [FOR n] |Stack | |
| | |Terminal | |
| | + + + + + + |Type | |
| | | |Counts | |PRompt | |NOCC| [Xedit] |NOTerminal| |
| | |Cnts | |NOPrompt| |CC | |NOType | |
| | |NOCOunt| + + + + + + |
| | + + |
+--------------------------------------------------------------------+
where
? signals interactive mode. Words are read from the stack (or
the terminal if the stack is empty). One or more words may
be entered on each line. An empty line indicates the end of
the input. The FROM, TO, FOR, and CC options are ignored in
interactive mode. This is the default.
fn is the filename of the file to be examined.
ft is the filetype of the file to be examined. If none is
specified the default is "SCRIPT."
fm is the filemode of the file to be examined. The default
filemode is "*."
Section 2: Command Descriptions 249
CMS Reference
SPELLCHK
Options
ABBreviate
makes periods valid characters in a word (periods are
otherwise considered to be word separators). A word ending
with a period will be checked first with the period, and
then, if necessary, checked without the period.
All specifies that if a word is entirely in uppercase the case
must match as well as the letters. This option may be used
with IGNORE and FIRST.
APpend appends output to a CMS disk file named "fn XCEPTION A1."
The output filename is the same as the input filename (in
interactive mode the filename is "INTERACT"). If the file
does not already exist it is created. The APPEND and DISK
options may not be specified together. This option requires
a write-accessed A-disk.
CC indicates that the input file contains carriage control
characters and that word scanning is to start with the
second character in each line. The CC option is assumed if
the filetype is LISTING, DOCUMENT, MANUAL, or LABELS.
CHEck causes the words read by SPELLCHK to be checked for correct
spelling. This is default mode. Output produced in this
mode is incorrectly spelled words found in the input data.
Cnts is a synonym for COUNTS.
Counts displays statistics at the terminal.
Disk writes output into a CMS disk file named "fn XCEPTION A1."
The output filename is the same as the input filename (in
interactive mode the filename is "INTERACT"). An existing
file with that fileid is replaced. The DISK and APPEND
options may not be specified together. This option requires
a write-accessed A-disk.
FIFo stacks output (first-in, first-out).
FIRst causes the case of the first letter of each word to be
ignored. The case of the other letters is respected.
| FOR n is the number of lines of the input file to be examined.
| The default is "*," the entire file.
FRom n is the first line to be checked in the file. The default is
"1."
Section 2: Command Descriptions 250
CMS Reference
SPELLCHK
Guess reads a single input word and generates alternative
spellings. The correctly spelled alternatives are sent to
the specified output destination. Output consists of
multiple words per line separated by blanks. GUESS is only
valid in interactive mode and will only process one input
word. GUESS implies the IGNORE, NOCOUNT, and NOSTUTTER
options. The ALL, ABBREVIATE, FIRST, and NUMBER options are
ignored in this mode. Alternative spellings are generated
by substituting, deleting, inserting, and transposing
letters in the input word.
IGnore causes the difference between uppercase and lowercase
letters to be ignored when checking words. This is the
default.
LIfo stacks output (last-in, first-out).
NOCC causes word scanning to begin with the first character in
each line. The NOCC option is assumed if the filetype is
not LISTING, DOCUMENT, MANUAL, or LABELS.
NOCOunt suppresses the display of statistics.
NOPrompt suppresses the prompt for input in interactive mode.
NOSingle See the SINGLE option. NOSINGLE is the default.
NOSLAng treats slang and non-standard words as incorrect.
NOSTutter See the STUTTER option. NOSTUTTER is the default.
NOTermin is a synonym for NOTYPE.
NOType suppresses the default TYPE output.
NUmber makes the digits valid characters in a word. Numbers are
usually treated as word separators.
| ONLYUser ignores SPELLCHK's internal lexicons. Only the lexicons
| specified by the USER option are used.
PRompt prompts for words in interactive mode. This is the default
in interactive mode.
REspect respects the difference between uppercase and lowercase
letters when checking words.
SINgle assumes that all single-letter words correct.
SLAng allows all words in the internal lexicon to be recognized.
This is the default option.
Section 2: Command Descriptions 251
CMS Reference
SPELLCHK
Stack stacks output (first-in, first-out).
STUtter checks for repeated consecutive occurrences of a word A
stutter is not indicated if there is a non-blank character
between the repeated words, but line boundaries are ignored.
Terminal is a synonym for TYPE.
TO n specifies the last line of the input file to be examined.
The default is "*," the entire file.
Type types output at the terminal. This is the default.
User (fn [fn...])
specifies the filenames of user lexicon files. The filetype
of each must be "LEXICON." The files must contain variable-
length records with one word per line. Words may be in
uppercase, lowercase, or mixed.
| Xedit reads input lines directly from XEDIT storage. An input
| fileid should not be specified when using this option.
| SPELLCHK terminates after the first incorrect word when this
| option is used. This option is only valid when SPELLCHK is
| called from XEDIT and is intended for use in XEDIT macros.
Usage Notes
1. SPELLCHK is not a substitute for careful proofreading. An
incorrectly used word cannot be detected, and some misspellings
can result in a correctly spelled, but spurious, word. SPELLCHK
| has a limited vocabulary (currently about 90,000 words) and flags
| as incorrect any word not known to it.
2. SPELLCHK can check words containing as many as 100 characters.
Longer words are considered misspelled.
3. Hyphenated words are broken after the hyphen and each part is
checked separately. The first part will be checked first with
the hyphen, and then, if necessary, without the hyphen.
4. If a word ending with 'S or 's is not found in the lexicons the
suffix is removed and another search is made.
5. SPELLCHK output can be displayed at the terminal, put on the
program stack, written to a CMS disk file, or any combination of
these options. The information consists of the following: line
number, column number, type of error, and the word. The type of
error is "X" for incorrect, "S" for stutter, and "L" for a long
word (more than 100 characters). The line and column numbers are
not included in interactive mode.
Section 2: Command Descriptions 252
CMS Reference
SPELLCHK
6. Please report any errors or omissions that you discover in our
lexicons. Contact the Systems Programming group at the UKCC.
Messages and Return Codes
Return code 1 (with no message) is set by the GUESS option if no
alternatives are generated.
Record n incorrect in "fileid".
Correct -- "word".
Incorrect -- "word".
Stutter -- "word".
Too long -- "word".
Rec=n Col=n X|S|L "word"
DMSSPE002E Input file "fileid" not found. RC=28
DMSSPE003E "name" is not an option. RC=24
DMSSPE004E User option specified incorrectly. RC=24
DMSSPE005E User lexicon "fileid" not found. RC=28
DMSSPE006E Records in user lexicon "fileid" are not variable-
length. RC=24
DMSSPE007E Insufficient storage to initialize user lexicon. RC=28
DMSSPE029E "name" is not a valid argument for the "name" option.
RC=24
DMSSPE044E Record length of "fileid" exceeds the allowable maximum
of "nn". RC=24
DMSSPE062E Invalid "*" in fileid. RC=20
DMSSPE070E "name" is not a parameter. RC=24
DMSSPE104S Error n reading file "fileid". RC=100
DMSSPE105S Error n writing file "fileid". RC=100
DMSSPE106E Output disk not accessed r/w. RC=100
DMSSPE933I Total words n; correct n; incorrect n.
DMSSPE933I Words found: common n; other n; user n.
DMSSPE979R Enter word(s) or null line to exit:
Section 2: Command Descriptions 253
CMS Reference
SPELLFIX (EXEC)
Use the SPELLFIX command to search a CMS disk file for words that are
incorrectly spelled and then edit the file (using XEDIT) with the
possible misspellings indicated for correction. SPELLFIX can be used
only on 3270-type display terminals with Program Function (PF) keys.
+--------------------------------------------------------------------+
| | + + ++ |
| SPELLFIX | fn |ft |fm|| [( options... [)]] |
| | |SCRIPT |* || |
| | + + ++ |
+--------------------------------------------------------------------+
where
fn is the filename of the CMS disk file to be examined.
ft is the filetype of the CMS disk file to be examined. The
default is "SCRIPT."
fm is the filemode of the CMS disk file to be examined. The
default is "*," which will search all accessed disks.
options are options for the SPELLCHK command. A number of options
are supplied by the SPELLFIX EXEC (refer to the Usage
Notes).
Usage Notes
1. If no errors are detected, the file is not edited. If XEDIT is
used, SPELLFIX will use your XEDIT PROFILE.
2. SPELLFIX is also an XEDIT subcommand. While using XEDIT you may
issue SPELLFIX (with no operands) to check the spelling in the
file that you are editing.
3. SPELLFIX will temporarily change the Program Function (PF) key
definitions used by XEDIT, and will display the definitions at
the bottom of the screen. The PF keys are used to indicate how a
possibly misspelled word should be handled, to display
alternative spellings, and insert corrections.
4. You must use PF3 (or PF15) to stop SPELLFIX. You will still be
in the XEDIT environment. After pressing PF3 (or PF15) to stop
SPELLFIX, you may enter KEEP to retain the exception file ("fn
XCEPTION A1") produced by the SPELLCHK command. Be certain to
use the FILE subcommand to retain any corrections made to the
file.
Section 2: Command Descriptions 254
CMS Reference
SPELLFIX (EXEC)
5. SPELLFIX is not a substitute for careful proofreading. An
incorrectly used word cannot be detected, and some misspellings
can result in a correctly spelled, but spurious, word. There is
no checking for capitalization. SPELLFIX has a limited
| vocabulary (currently about 90,000 words) and will consider any
| word not known to it to be incorrect.
6. Lexicon files named ABBR, SCRIPT, JARGON, and USER will
automatically be used if they are present (default ABBR, SCRIPT,
and JARGON lexicons are supplied). The supplied SCRIPT LEXICON
file contains SCRIPT control words and some common SCRIPT
variable names. The ABBR LEXICON file contains some common
abbreviations. The JARGON LEXICON file contains computer-related
and locally used words and abbreviations. You may supply your
own versions of these lexicons (a JARGON LEXICON file containing
words related to your own field or specialty, for example), or
you may want to create dummy files to prevent the default files
from being used. You may also supply an additional USER LEXICON
file.
7. Please report any errors or omissions that you discover in our
lexicons. Contact the Systems Programming group at the UKCC.
8. SPELLFIX uses the SPELLCHK and XEDIT commands to check and edit
the specified file. The SPELLCHK command is issued using several
options, including the ABBREV, SINGLE, and STUTTER options. This
allows abbreviations to appear in the lexicon files, causes all
single letter words to be considered correct, and flags repeated
words. Additional SPELLCHK options may be specified.
Messages and Return Codes
DMSFIX001E No filename specified. RC=24
DMSFIX529E Spellfix can only be used on a 3270-type display. RC=24
Messages may also be produced by the SPELLCHK and XEDIT commands.
Section 2: Command Descriptions 255
CMS Reference
SPITBOL
Use the SPITBOL command to compile and execute a program using the
Illinois Institute of Technology SPITBOL compiler. SPITBOL is not
supported.
+--------------------------------------------------------------------+
| | |
| SPITBOL | filename [filename...] [( [options...] [)]] |
| | |
| | Options: |
| | |
| | + + + + + + + + |
| | |NOPRint| |NOPUnch| |TErm | |NOTYpe| |
| | |PRint | |PUnch | |NOTErm| |TYpe | |
| | + + + + + + + + |
| | |
| | + + |
| | |NOXtype| [DECK] [compiler options] |
| | |Xtype | |
| | + + |
+--------------------------------------------------------------------+
where
filename is one or more input filenames. The filetype of these files
must be "SPITBOL," and they must contain fixed-length,
| 80-byte records. These files must be on the A-disk or an
| extension of the A-disk.
Options
DECK produces an object file. There is no information available
on how to use an object file produced in this way, so this
option is not recommended.
NOPRint writes the program listing and execution output into a CMS
disk file named "filename LISTING." This is the default.
NOPUnch discards punched output from the program. This is the
default.
NOTErm suppresses display of compiler error messages at the
terminal.
NOTYpe suppresses display of the program listing at the terminal.
This is the default.
NOXtype suppresses display of execution time output at the terminal.
Section 2: Command Descriptions 256
CMS Reference
SPITBOL
PRint sends the program listing and execution output to the
spooled printer.
PUnch writes punched output from the program into a CMS disk file
named "filename PUNCH."
TErm displays compiler error messages at the terminal. This is
the default.
TYpe displays the program listing at the terminal.
Xtype displays execution time output at the terminal.
In addition, the following compiler options may also be specified:
C nnn is the maximum number of lines to be written to the PUNCH
file. The default is zero.
D nn is the maximum number of dumps to be produced.
H nnK is the maximum amount of storage to be used by the compiler.
The default is 1000K.
L nnK is the minimum amount of storage which must be available for
the compiler. The default is 16K.
N nnn is the number of lines per page of LISTING. The default is
63.
P nnn is the maximum number of pages to be printed in the LISTING.
The default is 999.
R nnK is the amount of storage to be reserved for CMS. The
default is 8K.
T nnn is the maximum amount of CPU time to be used by the
compiler. The default is 999.
Usage Notes
1. The SPITBOL language is similar to the SNOBOL4 language described
in The SNOBOL4 Programming Language. Some additional information
is available in the UKCC Consulting Room in McVey Hall.
2. SPITBOL uses OS simulation input and output. The following DD
names are defined by default:
SYSIN Input
SYSPRINT Printed Output
SYSPUNCH Punched Output
Section 2: Command Descriptions 257
CMS Reference
SPITBOL
If you wish to use other files with a SPITBOL program, you must
issue FILEDEF commands for these files before the program is
executed. A file with one of the DD names given above can be
overridden with a FILEDEF before the program is executed. The
record format and block size of the file must be specified in the
| FILEDEF command. You may need to specify a larger value for the
| R compiler option if you define additional files.
Section 2: Command Descriptions 258
CMS Reference
| SSORT
Use the SSORT command to create a file sorted in a specified order.
SSORT uses SyncSort and is considerably more efficient than SORTF or
SORT. This is a summary of the most frequently needed options and
functions of SyncSort.
+--------------------------------------------------------------------+
| | + + + + + + |
| SSORT | |ifile [ifile...]| |ofile| |PROmpt | [( options... |
| | |RDR | |PRT | |NOPrompt| |
| | + + |PUN | |cfile | |
| | + + + + |
| | |
| | Options: |
| | |
| | + + + + |
| | |OUTput CANcel | | WORK Tnnnn primary secondary| |
| | | REPlace| | address | |
| | | APPend | + + |
| | + + |
+--------------------------------------------------------------------+
where
ifile is the fileid of the input file. You can specify more than
one input fileid. You can specify "RDR" to indicate input
from a reader spool file. The default fileid is "SORTIN1
FILE A1."
ofile is the fileid of the output file. The default is "= = =,"
which causes the input file to be replaced. You can specify
"PRT" for output to a printer spool file, or "PUN" for
output to a punch spool file. The default fileid is
"SORTOUT FILE A1."
cfile is the fileid of the file containing SyncSort control
statements (the SYSIN file). The default is "PROMPT," which
will read the control statements from the terminal.
Specifying "NOPROMPT" will read the control statements from
the terminal, but without prompting. The last statement
must be "END" in this case. The default fileid is "SYSIN
FILE A1."
Options
OUTput controls output to a CMS disk file. OUTPUT CANCEL causes
SSORT to stop if the output file already exists. OUTPUT
REPLACE causes an existing file to be replaced. OUTPUT
APPEND causes the output to be appended to an existing file,
Section 2: Command Descriptions 259
CMS Reference
| SSORT
if one exists. REPLACE is the default when the input and
output fileid's are the same.
WORK controls the device used for work space (SORTWK) by the
sort. "Tnnnn" is the device type, and can be T3330, T3350,
or T3380. "Primary" and "secondary" are the number of
cylinders. "Address" is the virtual device address to be
used. The SORTWK device is formatted by SyncSort and must
be reformatted with the CMS FORMAT command to be used for
CMS disk files.
Usage Notes
1. SyncSort supports a number of control statements. The most
frequently needed is the SORT statement:
SORT FIELDS=(p,l,c,o,...)
FIELDS=(p,l,o,...),FORMAT=c
where "p" is the starting position of the sort field, "l" is the
length, "c" is the collating method, and "o" is the order ("A"
for ascending, "D" for descending). If all of the fields are in
the same format, the FORMAT= parm can be used. When sorting a
file with variable-length records, the first data position is 5
(to allow for a record descriptor word). Some frequently used
collating methods are:
AC Characters (ASCII)
BI Binary (unsigned)
CH Characters (EBCDIC)
FI Fixed-point
FL Floating-point (Normalized)
PD Packed decimal
As many as 64 fields can be specified. Use the "END" statement
to mark the end of the control statements.
2. SyncSort provides many other functions and can be called from
COBOL, PL/I, and assembler programs. Refer to the SyncSort CMS
Programmer's Guide for more information. (Note that tapes are
not available to CMS users at the UKCC.)
Section 2: Command Descriptions 260
CMS Reference
STATUS
Use the STATUS command to determine the status of an OS batch job or
HASP printed output that was submitted from your userid.
+--------------------------------------------------------------------+
| | |
| STATUS | [job|ALL] |
| | |
+--------------------------------------------------------------------+
where
job is the job name, number, or HASP runid of the OS batch job
or HASP print job to be checked.
ALL checks all jobs submitted from this userid. This is the
default.
Usage Notes
1. If the job is found and was submitted from your userid a message
containing the following is returned:
JOBNAME RUNID QUE POS STEP/PROC NAME CPUTIME LINES
jobname runid que pos step procstep seconds lines
jobname job name
runid HASP runid
que PRTn, PUN, XEQn, or blank (between queues)
pos position of the job in queue, or BUSY
step current job step name (if executing)
procstep current procedure step name (if executing)
seconds seconds of CPU time used by an executing job
lines estimated print lines, number of lines
generated, or number of lines left to print
If the specified job is not in the system or was not submitted
from your userid, HASP returns a message that the job was not
found. You may receive this indication if you issue the STATUS
command immediately after submitting a job, especially when the
system is heavily loaded.
2. The responses from HASP are suppressed if you have SET MSG OFF.
3. Allow at least thirty minutes after completion before coming to
the UKCC Data Center to pick up printed output; allow an hour for
plotted output.
Section 2: Command Descriptions 261
CMS Reference
STATUS
Messages and Return Codes
DMSSTA070E Invalid parameter "parm". RC=24
DMSSTA930E [batch] is not available. RC=101
DMSSTA931E No job specified. RC=24
| DMSSTA943E Error "[code]" from VMCF [function]. RC=100
Messages are also sent by HASP.
Section 2: Command Descriptions 262
CMS Reference
STK (EXEC)
Use the STK command to execute a command and display the contents of
the CMS program stack.
+--------------------------------------------------------------------+
| | |
| STK | [command [operands...]] |
| | |
+--------------------------------------------------------------------+
where
command can be any CMS or CP command or EXEC name. The specified
command will be executed by STK.
operands are operands to be passed to the executed command. STK does
no checking of the operands.
Usage Notes
1. STK executes the specified command, and displays the contents of
the CMS program stack. If no command is specified, the stack is
left unchanged. The return code from the executed command will
also be displayed.
2. STK is useful in examining the operation of the STKxxx commands
(STKDATE, STKID, STKRDR, etc.). For example, the following would
demonstrate the operation of the STKDATE command:
stk stkdate
| STKDATE completed with RC=0 and stacked 1 lines.
| Contents of stack (word count begins each line):
| 12 : THU 02/09/84 12:13:06 Thursday THU 02/09/84 09:54:39
| Thursday 000008307 February 09 1984
| R; $0.01 12:13:06
Messages and Return Codes
DMSSTK915E "name" is not a command. RC=24
Section 2: Command Descriptions 263
CMS Reference
STKDATE
| Use the STKDATE command to put the current day, date, and time onto
| the CMS program stack. Most of this information is available from the
| QUERY TIME command and the DATE functions of REXX and EXEC 2.
+--------------------------------------------------------------------+
| | |
| STKDATE | [LIFO|FIFO] |
| | |
+--------------------------------------------------------------------+
where
LIFO stacks last-in, first-out. This is the default.
FIFO stacks first-in, first-out.
Usage Notes
| 1. STKDATE stacks a line containing the following:
1. Abbreviated Day (MON,TUE,WED,THU,FRI,SAT,SUN)
2. Date (mm/dd/yy)
3. Time (hh:mm:ss, using a 24-hour clock)
4. Day (Monday, Tuesday, etc.)
5. IPL Abbreviated Day (MON,TUE,WED,THU,FRI,SAT,SUN)
6. IPL Date (mm/dd/yy)
7. IPL Time (hh:mm:ss, using a 24-hour clock)
8. IPL Day (Monday, Tuesday, etc.)
9. Seconds since IPL
| 10. Month
| 11. Day
| 12. Year
The IPL time information is set at CMS IPL. IPL occurs
automatically when you log on and is usually not done again
during a terminal session.
2. Lexington local time is either Eastern Standard Time (EST) or
Eastern Daylight Time (EDT). The time is usually correct to
within a few minutes.
Messages and Return Codes
DMSKDT070E "string" is not a valid parameter. RC=24
Return code 25 will be set (with no error message) if there is no room
on the program stack.
Section 2: Command Descriptions 264
CMS Reference
STKDISK
Use the STKDISK command to put information describing accessed
| minidisks onto the CMS program stack. Some of this information is
| available from the QUERY DISK command.
+--------------------------------------------------------------------+
| | + + |
| STKDISK | |FIrst | |
| | |MOst | |
| | |mode | |
| | |address| |
| | |ALl | |
| | + + |
+--------------------------------------------------------------------+
where
address stacks information about the minidisk at address "address"
(if it is accessed).
ALl stacks information about all accessed minidisks.
FIrst stacks information about the first accessed minidisk
(usually the A-disk). This is the default.
mode stacks information about the minidisk accessed as "mode."
MOst stacks information about the write-accesses CMS minidisk
with the most space available.
Usage Notes
STKDISK checks the specified disk or disks and sets a return code of 0
(if the disk is accessed) or 36 (if the disk is not accessed). No
message is issued with return code 36. One or more lines containing
the following are stacked when the return code is zero:
1. Asterisk ("*")
2. Disk label
3. Device address
4. Primary access mode
5. Access mode with extension
6. R/W or R/O
7. Disk size (cylinders)
8. Device type
9. Format (CMS, OS, or DOS)
| 10. (CMS Disks Only) Disk block size
| 11. (CMS Disks Only) Number of files
12. (CMS Disks Only) Total blocks
13. (CMS Disks Only) Free blocks
Section 2: Command Descriptions 265
CMS Reference
STKDISK
14. (CMS Disks Only) Used blocks
15. (CMS Disks Only) Used percentage
16. (CMS Disks Only) Date formatted
17. (CMS Disks Only) Time formatted
Stacking is LIFO unless ALL, which uses FIFO, is specified.
Messages and Return Codes
DMSKDK070E "name" is not a parameter. RC=24
Section 2: Command Descriptions 266
CMS Reference
STKID
| Use the STKID command to put system identification information onto
| the CMS program stack. Most of this information is available from the
| QUERY CPLEVEL or IDENTIFY commands.
+--------------------------------------------------------------------+
| | |
| STKID | [LIFO|FIFO] |
| | |
+--------------------------------------------------------------------+
where
LIFO stacks last-in, first-out. This is the default.
FIFO stacks first-in, first-out.
Usage Note
STKID places a line containing from 11 to 13 words on the stack:
1. System Control Program Name
2. SCP Version
3. SCP Level
| 4. SCP Service Level
5. Real CPU Model
6. Real CPU Version
7. Real CPU Address
8. Virtual CPU Serial Number
9. Userid
10. IPL Name or Address
11. Subsystem Name
12. Userid (2nd level VM, not normally present)
13. Userid (3rd level VM, not normally present)
Messages and Return Codes
DMSKDT070E "string" is not a valid parameter. RC=24
Return code 25 will be given (with no error message) if there is no
room in the CMS program stack.
Section 2: Command Descriptions 267
CMS Reference
STKRDR
Use the STKRDR command to put the spool file numbers of your reader
spool files onto the CMS program stack.
+--------------------------------------------------------------------+
| | |
| STKRDR | [LIFO|FIFO] |
| | |
+--------------------------------------------------------------------+
where
LIFO stacks last-in, first-out. This is the default.
FIFO stacks first-in, first-out.
Usage Notes
1. STKRDR stacks a line containing up to 30 reader spool file
numbers. If you have no reader spool files, an empty line is
stacked.
2. The following EXEC demonstrates how STKRDR could be used:
| /* Look for reader files */
| "makebuf"
| "stkrdr"
| pull files
| say "There are" words(files) "reader files."
| say "Spool file numbers:" files
| "dropbuf"
3. STKRDR returns punch files before print and console files. Spool
file numbers of held reader files are not returned.
Messages and Return Codes
DMSKDT070E "string" is not a valid parameter. RC=24
Return code 25 will be given (with no error message) if there is no
room on the program stack.
Section 2: Command Descriptions 268
CMS Reference
STKTERM
Use the STKTERM command to put information about your terminal onto
the CMS program stack.
+--------------------------------------------------------------------+
| | |
| STKTERM | [LIFO|FIFO] |
| | |
+--------------------------------------------------------------------+
where
LIFO stacks last-in, first-out. This is the default.
FIFO stacks first-in, first-out.
Usage Notes
1. STKTERM stacks a line containing the following items:
1. Virtual Device Address
2. Virtual Device Type
3. Real Device Type
4. Real Model
5. CP LINESIZE
6. "DISPLAY" or "TYPEWRITER"
7. Number of lines on a display screen
8. Number of columns on a display screen
The LINESIZE is controlled by the CP TERMINAL LINESIZE command.
The sixth item distinguishes between 3270-type terminals
(DISPLAY) and asynchronous ASCII terminals (TYPEWRITER). Even if
it has a display screen, an asynchronous ASCII terminal is
treated as a typewriter unless you are using the 3270 Simulator
(S3270). A terminal using S3270 is treated by VM/SP as a 3278
model 2, and STKTERM indicates "DISPLAY" in this case. The real
model, line count, and column count are only meaningful if the
terminal is a 3270 display or an ASCII display using S3270.
2. The virtual device address is set to "FFF" if there is no virtual
console. This is not a normal condition.
3. The real device type is set to one of the following:
Type Description
TTY Any asynchronous ASCII (TeleVideo, DECwriter, etc.)
2741 IBM 2741
3066 IBM 3066
3215 IBM 3215
3277 IBM 3277, Memorex 1377, Telex 277, etc.
Section 2: Command Descriptions 269
CMS Reference
STKTERM
3278 IBM 3278, IBM 3276, ASCII S3270
3279 IBM 3279
NONE No real terminal (disconnected)
???? Unknown type (not normal)
Messages and Return Codes
DMSKDT070E "name" is not a valid parameter. RC=24
Return code 25 will be given (with no error message) if there is no
room on the program stack.
Section 2: Command Descriptions 270
CMS Reference
STKTIME
| Use the STKTIME command to put timing information onto the CMS program
| stack. Some of this information is available from the QUERY TIME
| command and the TIME functions available in REXX and EXEC 2.
+--------------------------------------------------------------------+
| | |
| STKTIME | [LIFO|FIFO] |
| | |
+--------------------------------------------------------------------+
where
LIFO stacks last-in, first-out. This is the default.
FIFO stacks first-in, first-out.
Usage Notes
1. STKTIME stacks a line containing the following items:
1. Date (mm/dd/yy)
2. Time (hh:mm:ss, using a 24-hour clock)
3. Milliseconds of virtual CPU time used
4. Milliseconds of real CPU time used
2. The real CPU time is the sum of the virtual CPU time and the
system overhead caused by your userid. You are billed for
| virtual CPU time only. The CPU times are for this terminal
| session during the current rate period.
3. The maximum value for CPU time that can be returned is 99999999
ms (99,999 seconds or 1,666 hours). It is unlikely that you
could exceed that limit in one terminal session.
4. The date and time returned are local time in Lexington, Kentucky,
either Eastern Standard Time (EST) or Eastern Daylight Time
(EDT). The time is usually correct to within a few minutes.
Messages and Return Codes
DMSKDT070E "string" is not a valid parameter. RC=24
Return code 25 will be given (with no error message) if there is no
room on the program stack.
Section 2: Command Descriptions 271
CMS Reference
STKXRDR
Use the STKXRDR command to put information describing selected reader
| spool files onto the CMS program stack. Most of this information is
| available from the QUERY RDR command.
+--------------------------------------------------------------------+
| | + + ++ |
| STKXRDR | |* |LIFO|| |
| | |spoolid |FIFO|| |
| | |All + +| |
| | | | |
| | | [COST]| |
| | + + |
+--------------------------------------------------------------------+
where
* stacks information describing the first reader file. This
is the default.
spoolid is the spool file number of a selected reader file.
All stacks information about all reader files.
LIFO stacks last-in, first-out. This is the default unless ALL
is specified.
FIFO stacks first-in, first-out. This is the default when ALL is
specified.
COST adds an estimated spool block count and cost to the data
stacked for each file. Charges for spool files are based on
their size and age.
Usage Notes
1. If the specified file is not found, or if there are no reader
files, an empty line is stacked. If the file is found, a line
containing from 8 to 15 words is stacked. Word 0 (the file
number) is not present if a "spoolid" was specified. Words 9
through 11 are not always present. If COST is specified, words 9
through 11 are set to "NONE" if they would otherwise be blank.
The output format is:
0. Spool File Number (only if * or ALL specified)
1. Origin Userid
2. Spool Class (one character)
3. Spool Type (PRT, PUN, CON, etc.)
4. Number of Records
5. Copy Count
Section 2: Command Descriptions 272
CMS Reference
STKXRDR
6. Hold (will always be "NONE")
7. Creation Date (mm/dd/yy)
8. Creation Time (hh:mm:ss)
9. Distribution Code (may be blank or "NONE")
10. Spool File Name (may be blank or "NONE")
11. Spool File Type (may be blank or "NONE")
12. Estimated Spool Block Count (only if COST specified)
13. Estimated Current Charge (only if COST specified)
14. Estimated Cost Per Day (only if COST specified)
2. The specified reader spool file is ordered (placed at the head of
the reader spool queue) if a "spoolid" was specified.
3. STKXRDR will not find a held reader file unless ALL is specified.
Specifying the "spoolid" of a held reader file will cause an
empty line to be stacked.
4. The estimated spool block count is based on the type of file
(print, punch, etc.) and an estimated average line length.
Obtaining an accurate count entails too much system overhead to
be practical.
5. This EXEC demonstrates how STKXRDR can be used:
| /* Display reader file info */
| arg file .
| if file="" then file = "*"
| "makebuf"
| "stkxrdr" file "cost"
| if rc=0 then do
| "checkbuf"
| n = rc
| do n
| pull info
| say info
| end
| end
| "dropbuf"
Messages and Return Codes
DMSKDT070E "string" is not a valid parameter. RC=24
Return code 25 will be given (with no error message) if there is no
room on the program stack.
Section 2: Command Descriptions 273
CMS Reference
STORAGE (EXEC)
Use the STORAGE command to redefine your virtual machine size and re-
IPL CMS.
+--------------------------------------------------------------------+
| | |
| STORAGE | [size] |
| | |
+--------------------------------------------------------------------+
where
size is the new storage size. The value is assumed to be in
kilobytes unless a suffix of "M" is used to indicate
megabytes. The default is 512K. Values may range from 8K
through 2M, although CMS cannot be used in a virtual machine
smaller than 256K.
Usage Notes
1. CMS will not be reloaded if the storage size specified is not
valid.
2. The STORAGE command is ignored in a CMS Batch job. Use a /SET
SIZE statement to specify storage size in a batch job.
Messages and Return Codes
DMKDEG025E STORAGE SIZE MISSING OR INVALID.
DMKDEG094E STORAGE SIZE EXCEEDS ALLOWED MAXIMUM.
Messages will also be produced during the re-IPL of CMS.
Section 2: Command Descriptions 274
CMS Reference
SUBMIT
Use the SUBMIT command to send a CMS disk file (or files) containing a
job to the OS batch system.
+--------------------------------------------------------------------+
| | + + ++ |
| SUBMIT | fn |ft |fm|| [(options... [)]] |
| | |JOB |* || |
| | |JCL + +| |
| | + + |
| | |
| | Options: |
| | |
| | + + + + |
| | |PRint destination| |Terminal | [For userid] |
| | |PRT destination | |Central | |
| | |Route destination| |Hot | [Ignore] |
| | + + |RMTnn | |
| | |PRMTnn | [COunts] |
| | [PUnch destination] |Prtcentral| |
| | + + |
+--------------------------------------------------------------------+
where
fn is the filename of the CMS disk file to be submitted.
ft is the filetype of the file. The defaults are "JOB" and
"JCL," in that order.
fm is the filemode of the file. The default is "*."
Options
Central routes printed and punched output to the UKCC Computer Room.
CENTRAL is equivalent to PRT CENTRAL PUN CENTRAL. The runid
assigned by the OS batch system when the job is submitted is
required to claim output. The RUNID command can be used to
display runids.
COunts displays the number of lines read from disk and the number
of lines transmitted.
For userid
makes the specified userid the owner of the job. This
userid receives the messages from the OS batch system
describing the progress of the job, and can use the STATUS
and CANCEL commands to control the job. The TERMINAL
routing options refer to this userid rather than your own.
Section 2: Command Descriptions 275
CMS Reference
SUBMIT
You will not receive messages regarding the job, and STATUS
and CANCEL cannot be used from your userid for this job.
Hot routes printed output to the hands-on (HOT) printer at the
UKCC and punched output back to your userid. HOT is
equivalent to PRT HOT PUN TERM.
Ignore causes SUBMIT control statements to be ignored (treated as
data) in included files.
Local is a synonym for CENTRAL. This option is provided for
compatibility with earlier versions SUBMIT and is not
recommended.
PRint destination
is the destination for printed output from the job. (This
does not affect the routing of punched output.) The
destination may be any of:
Central HASP Printer in the UKCC Computer Room
Hot HASP Hands-on (HOT) Printer at the UKCC
Pnnnn RSCS Remote Printer "nnnn"
RMTnn HASP Remote Site "nn"
Terminal Your Userid (Reader Spool File)
userid Any VM/SP Userid (Reader Spool File)
PRMTnn routes printed output to HASP remote site "nn" and punched
output back to your userid. Specifying a non-existent
remote number will cause the printed output to be lost.
PRMTnn is equivalent to PRT RMTnn PUN TERM.
Prt is a synonym for PRINT.
Prtcentr routes printed output to the UKCC Computer Room and punched
output back to your userid. PRTCENTRAL is equivalent to PRT
CENTRAL PUN TERM. The runid assigned by the OS batch system
when the job is submitted is required to claim output.
PRTHot is a synonym for HOT. This option is provided for
compatibility with earlier versions of SUBMIT and is not
recommended.
Prtlocal is a synonym for PRTCENTRAL. This option is provided for
compatibility with earlier versions of SUBMIT and is not
recommended.
PUnch destination
is the destination for punched output from the job. (This
does not affect the routing of printed output.) You cannot
route your punched output to CENTRAL unless your printed
output is also routed to CENTRAL. Not all HASP remote sites
have punches. The destination may be any of:
Section 2: Command Descriptions 276
CMS Reference
SUBMIT
Central HASP Punch in the UKCC Computer Room
RMTnn HASP Remote Site "nn"
Terminal Your Userid (Reader Spool File)
userid Any VM/SP Userid (Reader Spool File)
RMTnn routes printed and punched output to HASP remote site "nn."
Not all remote sites are equipped with punches. Specifying
a non-existent remote number will cause the output to be
lost. RMTnn is equivalent to PRT RMTnn PUN RMTnn.
Route is a synonym for PRINT.
Terminal routes printed and punched output back to your userid as
reader spool files. TERMINAL is equivalent to PRT TERM PUN
TERM. Output routed to a CMS userid can be processed with
the ACCEPT, RBROWSE, PEEK, and OUTPUT commands.
SUBMIT Control Statements
| SUBMIT supports several control statements that may be placed in
| submitted and included files. All SUBMIT control statements begin
with two dots starting in column one and a keyword beginning in column
three. All keywords and options must be in uppercase.
..* is a SUBMIT comment. The entire line is ignored and is not
included in the submitted job.
..END marks the end of a submitted or included file. If no END
statement is found, SUBMIT continues to the end of the file.
Anything after an END statement is ignored.
..EOF is a synonym for END.
..INClude fn [ft [fm]] [( [Variable] [Ignore] [)]]
| includes the file named "fn ft fm" in the submitted job.
| Any part of the fileid can be specified with equal signs to
| indicate the corresponding value from the including file
(this is the default). The VARIABLE option can be specified
to process files with long variable-length records (refer to
the Usage Notes for details). The VARIABLE option is reset
when an INCLUDE statement is encountered in an included
file. The IGNORE option causes SUBMIT control statements in
the included file to be ignored (treated as data).
..READ [MASK]
reads a line from the stack (or terminal if the stack is
empty) and inserts it into the submitted job. This could be
thought of as an INCLUDE from the terminal. The entered
line is restricted to eighty characters and is not
translated to uppercase or edited in any way (except CMS SET
Section 2: Command Descriptions 277
CMS Reference
SUBMIT
INPUT translation). If MASK is specified, the input at the
terminal is masked. READ can be used to enter passwords or
small amounts of variable data.
..TYPE text
types the specified text on the terminal. The text is
assumed to begin in column eight and may extend through
column 72. The text is not edited in any way (except CMS
SET OUTPUT or CASE translation). TYPE can be used to prompt
a user before a READ.
Usage Notes
1. SUBMIT removes any /*ROUTE statements from the job and generates
new statements that conform to the specified routing option. If
more than one routing option is specified, the last one
encountered on the command line is used.
2. Submitted and included files may contain either fixed- or
variable-length records up to 80 bytes long. If the VARIABLE
option of the INCLUDE statement is specified the included file
| may contain lines up to 65,531 bytes long.
3. INCLUDE loops are not permitted (A includes B, B includes A) and
cause SUBMIT to terminate and issue an error message.
4. The VARIABLE option of the INCLUDE statement causes the lines of
the included file to be punched in a special format that allows
lines up to 65,531 bytes long. This special format consists of
fixed-length 80-byte records. The CJSPREP command and CJSPREP OS
batch program are used to recreate the original data. CJSPREP
output records are always variable-length, regardless of the
original format.
Messages and Return Codes
DMSSUB001E No filename specified. RC=24
DMSSUB002E File not found. RC=28
DMSSUB003E Invalid option "option". RC=24
DMSSUB003E Invalid option "option" on ..INCLUDE. RC=24
DMSSUB044E Record length exceeds allowable maximum. RC=32
DMSSUB062E Invalid character "*" in fileid. RC=20
DMSSUB070E Invalid parameter "parameter". RC=24
DMSSUB104S Error n reading file "fn ft fm" from disk. RC=100
DMSSUB901T Unexpected error at "address". RC=256
DMSSUB910E Missing or invalid job statement. RC=99
DMSSUB911E Include card in error. RC=99
DMSSUB932I n records read, m records punched.
DMSSUB984E INCLUDE in "fileid" refers to active file "fileid". RC=24
Section 2: Command Descriptions 278
CMS Reference
SUBMIT
You will also receive messages tracking the progress of your job
through the OS batch system. HASP or RSCS will send messages if they
process your printed or punched output.
Section 2: Command Descriptions 279
CMS Reference
SYSID
Use the SYSID command to display information about the system and your
userid.
+--------------------------------------------------------------------+
| | |
| SYSID | |
| | |
+--------------------------------------------------------------------+
Usage Note
SYSID will display information describing the real computing system,
the system control program, and your userid.
Messages and Return Codes
SYSID produces no error messages or non-zero return codes.
Section 2: Command Descriptions 280
CMS Reference
TDISK (EXEC)
Use the TDISK command to define and format temporary disk space.
+--------------------------------------------------------------------+
| | |
| TDISK | [size [mode [address [type]]]] [(options...] |
| | |
+--------------------------------------------------------------------+
where
size is the amount of space requested. The value is assumed to
be in kilobytes unless a suffix of "M" is used to indicate
megabytes. The default is 200K (you can change the default
with the DEFAULTS command). Depending on the available disk
devices, you may be given slightly more space than you
request.
mode is the disk mode used to access the disk. The default is
the first unused mode (usually "B").
address is the virtual device address of the temporary disk. The
default is the first available address (beginning with 195).
Any address not already in use by your virtual machine may
be specified.
type is the device type to be used. The default is to use any
available device. The valid device types are 3330, 3350,
and 3380.
options are FORMAT command options. The BLKSIZE 2K option is
supplied by default. Refer to the description of the FORMAT
command for more information.
Usage Notes
1. Temporary disks are discarded when you log off, when the system
is shut down, or if there is a system failure. It is not
possible to recover data that was on temporary disk space after
it has been discarded.
2. You are charged for temporary disk space at a rate three times
the current rate for permanent rental disk space.
3. The specified size is used to determine the number of cylinders
of disk space defined. The following cylinder capacities (which
assume 2K blocks) are used in the calculation:
3330 228K/Cylinder
3350 480K/Cylinder
Section 2: Command Descriptions 281
CMS Reference
TDISK (EXEC)
3380 540K/Cylinder
4. There is a limited amount of disk space available for t-disk, and
it is shared by all users. Use the DROP command to discard t-
disk space that you no longer need.
5. The temporary disk is formatted with 2K blocks by default. You
may use the BLKSIZE option to specify other block sizes. Refer
to the description of the FORMAT command for more information.
Messages and Return Codes
Device [address] is already accessed as the [mode]-disk.
The existing device [address] will be accessed as the [mode]-disk.
T-disk [mode] ([address]) defined and accessed.
DMSTDI070E Not enough space is available. RC=24
DMSTDI070E [string] is not a valid size. RC=24
DMSTDI070E [string] is not a valid disk filemode. RC=24
DMSTDI070E [string] is not a valid disk address. RC=24
DMSTDI070E [string] is not a valid type. RC=24
Section 2: Command Descriptions 282
CMS Reference
TELL (EXEC)
Use the TELL command to send a brief message to one or more logged on
users. This is a description of the simplest use of the TELL command;
other functions are available.
+--------------------------------------------------------------------+
| | |
| TELL | name message |
| | |
+--------------------------------------------------------------------+
where
name is the name of the user to receive the message. A "name"
may be a userid or a nickname (from a NAMES file). A
nickname may refer to more than one userid.
message is the text of the message to be sent. The text is not
translated to uppercase. If the first word of the message
| is "at" you must use "TELL name AT UKCC message."
Usage Notes
1. To receive a message, a user must be logged on (and not
disconnected) and must not have SET MSG OFF. You will receive a
warning if the message cannot be sent.
2. The nicknames used by the TELL 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 NOTE, 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.
Messages and Return Codes
DMSWTL647E Userid not specified for 'nickname' in 'userid names'
file. RC=32
DMSWTL648E Userid [name] not found. No message sent. RC=32
DMSWTL676E Invalid character '*' for network id. RC=20
| Messages may also be produced by the CP command MESSAGE, and by RSCS
| for network messages.
Section 2: Command Descriptions 283
CMS Reference
TERMINAL (CP)
Use the TERMINAL command to control functions associated with your
terminal.
+--------------------------------------------------------------------+
| | |
| TERMinal | function [functions...] |
| | |
| | Functions: |
| | |
| | APL [ON|OFf] LINESize [nnn|OFF] |
| | APLT [ON|OFf] Mask [ON|OFf] |
| | ATtn [ON|OFf] MODE [VM|NOCP|CP] |
| | AUTocr [ON|OFf] NUlls [ON|OFf|char] |
| | BREakin [IMmed|GUESTctl] PROMpt [ON|OFf|char|VM|TTY] |
| | BRKkey [PA1|PFn] PROTOCOL [n x|OFF] |
| | BUrst [ON|OFf] RUbs [nnn|AUTO|NOAUTO] |
| | BYpass [ON|OFf] SCRNsave [ON|OFf] |
| | CHardel [ON|OFf|char] SCROll [nnn|CONT] |
| | | CONMODE [3215|3270] TABchar [ON|OFf|char] |
| | EScape [ON|OFf|char] TEXT [ON|OFf] |
| | HIlight [ON|OFf] TIMEstmp [ON|OFf] |
| | IDles [nnn|AUTO|NOAUTO] TYpe [TTY|3101] |
| | LINEDel [ON|OFf|char] XOFF [ON|OFf] |
| | LINEnd [ON|OFf|char] XON [ON|OFf] |
| | |
+--------------------------------------------------------------------+
where
APL controls the use of APL character translation tables. If ON
is specified, the APL bit-paired character set will be used.
If OFF is specified, the normal character set will be used.
APL ON will force APLT and TEXT OFF. APL OFF is the initial
setting unless the APL option of the LOGON command is used.
APLT controls the use of APL character translation tables. If ON
is specified, the APL typewriter-paired character set (used
by DECwriters) will be used. If OFF is specified, the
normal character set will be used. APLT ON will force APL
and TEXT OFF. APLT OFF is set at logon unless the APLT
option of the LOGON command is used.
ATtn controls the signaling of an attention interrupt. If ON is
specified, an exclamation point and carriage return is sent
to the terminal when an attention interrupt occurs. If OFF
is specified, the exclamation point and carriage return are
suppressed. ATTN is valid only on ASCII terminals. ATTN ON
is the initial setting.
Section 2: Command Descriptions 284
CMS Reference
TERMINAL (CP)
AUTocr controls the transmission of the carriage return/linefeed
sequence at the end of a line. If ON is specified, the
sequence is not sent if the number of characters in a line
is exactly equal to the current LINESIZE setting. This is
useful for terminals (such as the TeleVideo model 920) that
generate an automatic new line sequence. AUTOCR is valid
only for asynchronous ASCII terminals. AUTOCR OFF is the
initial setting.
BREakin controls when CP will display messages on a local 3270-type
terminal. The initial value (IMMED) will cause CP messages
to be displayed when the BRKKEY (see below) is pressed, or
when a full-screen read or write is performed with an
inactive keyboard. Specifying GUESTCTL will cause CP
messages to be displayed only when you press the BRKKEY or
request a CP function. Priority messages will override
GUESTCTL.
BRKkey allows you to specify the key used to control break-in by CP
when using full-screen support (see BREAKIN). The initial
value is PA1. Any Program Function key (PF1 through PF24)
may be used. Specifying a PF key that does not actually
exist on your terminal may cause CP mode to be locked out.
PA1 will still be interpreted as the BRKKEY in line (not
full-screen) mode.
BUrst controls the transmission of the linefeed, carriage return,
XOFF sequence after the completion of a read from the
terminal. If ON is specified, the sequence is transmitted.
If OFF is specified, it is not. This option is used only
with asynchronous ASCII terminals. BURST ON is the initial
setting.
BYpass controls the translation of output data. If ON is
specified, a string beginning with a hexadecimal FF will not
be translated and will be transmitted without change. If
OFF is specified, normal translation will be performed.
This option is useful for some terminals that have plotting
or graphics display features, and can be used only with
asynchronous ASCII terminals. BYPASS OFF is the initial
setting.
CHardel defines the logical character delete symbol. If ON is
specified, the symbol will be "@." If OFF is specified, no
logical character delete symbol is allowed. If "char" is
specified, then that character becomes the logical delete
symbol. The symbol chosen should be one that is not common
in the input data, since that would require frequent use of
the logical ESCAPE character. Users of ASCII terminals
might want to use the ASCII backspace (BS) character as the
logical delete symbol. CHARDEL ON is the initial setting.
Section 2: Command Descriptions 285
CMS Reference
TERMINAL (CP)
| CONMODE [3215|3270]
| selects 3215 or 3270 console support for local 3270-type
| display terminals. CONMODE 3215 allows 3215-type CCW's to
| be used, CONMODE 3270 allows 3270-type CCW's. CONMODE 3215
| is the default and is required to run CMS. CMS sets CONMODE
| 3215 during IPL, and if you set CONMODE 3270 while CMS is
| running the results are unpredictable.
EScape defines the logical escape character. If ON is specified,
the symbol will be '"'. If OFF is specified, no logical
escape character is allowed. If "char" is specified, then
that character becomes the logical escape character. The
character chosen should not be common in the input data.
ESCAPE ON is the initial setting.
HIlight controls highlighting of input data when it is redisplayed
on the terminal. This option is valid only for 3270-type
terminals. HILIGHT OFF is the initial setting.
IDles specifies the number of idle characters to be appended to
each line transmitted to the terminal and cancels any
previous RUBS specification. If "nnn" is specified, that
number of idles will be used. The maximum allowed is 240.
If AUTO is specified, the number of idles used will depend
on the length of the line transmitted, with a full line
using the full number of idles. This will allow the
terminal to receive data at a higher rate. If NOAUTO is
specified, the full number of idles will always be
transmitted. To specify both a number of idles and AUTO,
the IDLES keyword must be given twice: "TERM IDLES nnn
IDLES AUTO." If no count is specified with the AUTO or
NOAUTO option, the last count set will be used. IDLES are
only used with asynchronous ASCII terminals.
LINEDel defines the logical line delete symbol. If ON is specified,
the symbol will be "¢". If OFF is specified, no logical
line delete symbol is allowed. If "char" is specified, then
that character becomes the logical delete symbol. The
symbol chosen should be one that is not common in the input
data, since that would require frequent use of the logical
ESCAPE character. LINEDEL ON is set at logon. Note that
the symbol "¢" is not available on ASCII terminals.
LINEnd defines the logical line end symbol. If ON is specified,
the symbol will be "#". If OFF is specified, no logical
line end symbol is allowed. If "char" is specified, then
that character becomes the logical line end symbol. The
symbol chosen should be one that is not common in the input
data, since that would require frequent use of the logical
ESCAPE character. LINEND ON is set at logon.
Section 2: Command Descriptions 286
CMS Reference
TERMINAL (CP)
LINESize specifies the maximum allowable line length for terminal
output. A value from 1 to 255 may be specified. OFF will
suppress all checking of the line length by CP. The line
size is ignored when APL is ON. The initial setting is 80.
Mask controls the typing of a masking line at a hardcopy terminal
that is not equipped with a print-inhibit feature, when a
password is to be entered. MASK OFF inhibits the masking
line. MASK ON is set at logon.
MODE controls the terminal attention environment. MODE CP
specifies that one or more attentions will force you into
the CP environment. MODE VM specifies that one attention is
passed to CMS, and more than one attention forces you into
the CP environment. MODE VM is set when you log on. MODE
NOCP prevents you from entering the CP environment. MODE
NOCP also provides an automatic re-IPL of CMS if CMS
terminates because of a severe error. A second severe error
will cause you to be logged off. MODE NOCP forces SET RUN
OFF.
NUlls defines the character to replace nulls (X'00') received in
the input stream. If ON is specified, nulls will not be
changed. If OFF is specified, nulls will be removed from
the input stream. If "char" is specified, then that
character will replace nulls on input. NULLS is most useful
when another processor or device other than a keyboard is
being used as the terminal input device. The NULLS setting
is used only with asynchronous ASCII terminals. NULLS ON is
the initial setting.
PRompt defines the character to be issued as a prompt when the
system is ready for input from an ASCII terminal. If ON is
specified, the symbol will be the current prompt character
(initially "."). If OFF is specified, no prompt will be
issued. If "char" is specified, then that character becomes
the current prompt character. VM may be specified if TERM
TYPE 3101 is in effect; this will position the cursor to
column one of the input line for each read. The prompt is
used only on asynchronous ASCII terminals. PROMPT ON is the
initial setting.
PROTOCOL specifies the communication protocol used with asynchronous
ASCII terminals. The initial setting (OFF) sends data to
the terminal as it is produced. If "PROTOCOL 1 x" is
specified, an ETX/ACK protocol will be used. The value "x"
is the size of a buffer in the terminal (it may be from 64
bytes to 32,768 bytes). Data for the terminal will be sent
| in blocks of up to the size specified, terminated with an
| ETX. VM/SP will then wait for a character to be sent from
the terminal (usually an ACK) indicating that it is ready
Section 2: Command Descriptions 287
CMS Reference
TERMINAL (CP)
for the next buffer. This PROTOCOL is supported by several
kinds of ASCII terminals, including the Anderson Jacobson
model 833 and the Diablo model 1640.
RUbs specifies the number of rubout (DEL, delete) characters to
be appended to each line transmitted to the terminal and
cancels any previous IDLES specification. If "nnn" is
specified, that number of rubouts will be used. The maximum
allowed is 240. If AUTO is specified, the number used will
depend on the length of the line transmitted, with a full
line using the full number of rubouts. This will allow the
terminal to receive data at a higher rate. If NOAUTO is
specified, the full number will always be transmitted. To
specify both a number of rubouts and AUTO, the RUBS keyword
must be given twice: "TERM RUBS nnn RUBS AUTO." If no
count is specified with the AUTO or NOAUTO option, the last
count set will be used. RUBS are only used with
asynchronous ASCII terminals. RUBS 2 is the initial
setting.
SCRNsave controls the saving and restoring of the screen image for a
local 3270-type terminal operating in CONMODE 3270. With
SCRNSAVE ON, CP will save and restore the screen when
entering and leaving CP mode. OFF is the default.
SCROll is used to define the number of lines to be displayed on
each screen of an IBM 3101 display terminal. This option
may only be specified if TERMINAL TYPE 3101 is in effect.
The initial setting is CONT.
TABchar defines a logical tab character for 3270-type terminals. If
ON is specified, the symbol will be the one used by the
system. If OFF is specified, then the character will be
X'00'. If "char" is specified, that character becomes the
logical tab character. The TABCHAR may be entered by using
a Program Function (PF) key set to TAB. Refer to the Usage
Notes for more information. TABCHAR is only valid for
3270-type terminals.
TEXT controls the use of the TEXT character translation tables.
If ON is specified, the TEXT character set will be used. If
OFF is specified, the normal character set will be used.
TEXT ON will force APL and APLT OFF. TEXT ON should only be
used at 3270-type terminals with the TEXT feature. TEXT OFF
is the initial setting.
TIMEstmp controls display of the current time with each line of CP
output to the terminal. TIMESTMP OFF is the initial
setting.
Section 2: Command Descriptions 288
CMS Reference
TERMINAL (CP)
TYpe enables support for some of the features of the IBM 3101
ASCII display terminal, including the use of the TERMINAL
PROMPT VM and TERMINAL SCROLL commands. TYPE may be used
only on asynchronous ASCII terminals. TYPE TTY is the
initial setting.
XOFf controls transmission of an ASCII XOFF at the end of each
output line. The XOFF character is used by some terminals
to control their operating mode. This option is valid only
on asynchronous ASCII terminals. The initial setting is
OFF.
XON controls the transmission of an ASCII XON prior to each
read. The XON character is used by some terminals to
control their operating mode. This option is valid only on
asynchronous ASCII terminals. The initial setting is ON.
Usage Notes
1. More than one function may be specified with the TERMINAL
command. If an error occurs during the processing of the
command, all functions preceding the first error are performed.
When specifying a "char" operand the letters "A" through "Z" and
the digits "0" through "9" cannot be used.
2. The settings specified with the TERMINAL command are in effect
only for the duration of a terminal session. When you log on the
initial settings are based on the kind of terminal you are using.
Many settings are reset at a log on after a disconnect. Some
that are not reset are the line editing symbols, MODE, NULLS,
IDLES, RUBS, XON, and XOFF. More information about reconnecting
can be found in the Usage Notes for the LOGON command in this
manual.
3. Line editing is also under the control of the SET LINEDIT
command.
4. Use the QUERY TERMINAL command to display the settings of the
TERMINAL command.
5. A detailed description of the protocols used with asynchronous
ASCII terminals is available in another section of this manual.
6. The function of the tab key found on many typewriter terminals
may be simulated on a 3270-type terminal by using a combination
of the SET PF TAB command and the TERMINAL TABCHAR command.
TERMINAL TABCHAR sets the character to be entered by the PF key
set to TAB. The initial value is an HT (Horizontal Tab, X'05')
character. The tab stops are set by issuing the following
command:
Section 2: Command Descriptions 289
CMS Reference
TERMINAL (CP)
SET PFnn TAB c1 c2 c3 ...
where "nn" is the PF key number and "c1 c2 c3 ..." are the tab
stop columns. Be sure that the keyword "TAB" is preceded and
followed by exactly one blank.
Pressing the TAB PF key will cause the TABCHAR character to be
inserted into the line and the cursor to be moved to the next tab
column. The intervening columns are unchanged and existing data
will not be affected. The TABCHAR character will not overlay any
non-blank character.
This method of tabbing may be used with a CMS editor in
typewriter (non-display) mode. The editor's tab settings should
match those used on the TAB PF key.
Section 2: Command Descriptions 290
CMS Reference
| TESTCOB
Use the TESTCOB 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. See also the COBDCG and COBDG
commands.
+--------------------------------------------------------------------+
| | |
| TESTCOB | filename (program debug [options]) [PRINT(print)] |
| | |
| | [PARMS(parms)] |
| | |
+--------------------------------------------------------------------+
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." This can also refer to
a member of a TXTLIB.
program is the name of the program to be executed. This is the name
used on the PROGRAM-ID in the COBOL program.
debug is the DD name that refers to the debug data file produced
by the VS COBOL compiler. The file is usually named
"filename SYSUT5."
options are TESTCOB options.
PRINT(print)
is the DD name used for output from the PRINT subcommand.
PARM(parms)
are parameters passed to the executed program.
Debug Subcommands
AT stmt Unconditional interrupt
DROP symbol Delete the established symbols
DUMP System dump
END End a debugging session
EQUATE symbol dataname Establish symbols
GO stmt Start program execution
IF expr HALT/GO Create contingency situations
LIST addr Display contents of data
LISTBRKS List active breakpoints
LISTFILE filename Display status of files
NEXT Unconditional interrupt
OFF stmt Remove unconditional breakpoints
Section 2: Command Descriptions 291
CMS Reference
| TESTCOB
OFFWN identifier Remove conditional breakpoints
QUALIFY prog name Qualify program line numbers & data names
RUN stmt Ignore breakpoints
SET addr1 = addr2 Initialize and modify data
SOURCE line number Display selected source statements
TRACE option Trace program execution
WHEN identifier Conditional interrupt
Usage Notes
1. A more comprehensive explanation of the TESTCOB command and its
subcommands can be found in the IBM OS COBOL Interactive Debug
Terminal User's Guide and Reference or the COBOL Debug manual
available from the manual command.
2. Before executing a program with TESTCOB, you must define all DD
names and subroutine libraries (including the COBOL libraries).
For example:
FILEDEF DEBUG DISK program SYSUT5 A
FILEDEF SYSPRINT TERMINAL
FILEDEF SYSOUT TERMINAL
GLOBAL TXTLIB PTF8LIB COBLIBVS
TESTCOB program (program DEBUG)
Section 2: Command Descriptions 292
CMS Reference
TKPLOT
Use the TKPLOT command to display a CMS file created by the Tektronix
plot preview routines on a Tektronix graphic display terminal. Plots
produced with the standard Zeta plot subroutines may be drawn on a
Tektronix graphics terminal with the PLOTTEK command.
+--------------------------------------------------------------------+
| | + + ++ |
| TKPLOT | fn |ft |fm|| |
| | |PLOT |A1|| |
| | + + ++ |
+--------------------------------------------------------------------+
where
fn is the filename of the file to be plotted.
ft is the filetype of the file to be plotted. The default is
"PLOT."
fm is the filemode of the file to be plotted. The default
value is "A1."
Usage Notes
1. TKPLOT will read the specified file and display it on the
terminal without a carriage return/linefeed (CR LF) sequence
between lines. When a page erase sequence (ESC FF SYN) is
detected, a read will be issued to the terminal before erasing
the screen. Output resumes when RETURN is pressed.
2. Since a terminal read will cause a prompt character to be
displayed, the beam should be moved to an unused part of the
screen before calling NEWPAG or NEWPLT. As an alternative the
prompt character could be changed with the CP TERMINAL command to
one that is non-displayable, such as a "bell" (CTL/G).
Messages and Return Codes
DMSTKP002E "fileid" NOT FOUND. RC=28
DMSTKP104S ERROR n READING FILE 'fn ft fm' FROM DISK. RC=100
Section 2: Command Descriptions 293
CMS Reference
TPRINT
Use the TPRINT command to print a CMS disk file on your terminal.
TPRINT supports a subset of American National Standard (ANS) carriage
control characters.
+--------------------------------------------------------------------+
| | + + + +++ |
| TPRINT | |fn |ft |fm||| [( options... [)]] |
| | |LAST |LISTING |* ||| |
| | | |DOCUMENT | ||| |
| | | |MANUAL | ||| |
| | | |LABELS | ||| |
| | + + + +++ |
| | Options: |
| | |
| | + + + + + + |
| | |FROm n | |TO n | |FOR n| |
| | |STArt n| |FINish n| + + |
| | + + + + |
| | |
| | + + + + + + |
| | |LINESIZE n| |PAGESIZE n| |CC | |
| | |LS n | |PS n | |NOCC| |
| | + + |LINECoun n| + + |
| | + + |
| | |
| | + + + + + + + + |
| | |PAUse | |NOSTop| |WAit | |FF | |
| | |NOPAUse| |STop | |NOWAit| |NOFF| |
| | + + + + + + + + |
+--------------------------------------------------------------------+
where
fn is the filename of the CMS disk file to be printed at the
terminal. The default is "LAST."
ft is the filetype of the file. The defaults are "LISTING,"
"DOCUMENT," "MANUAL," and "LABELS."
fm is the filemode of the file. The default is "*."
Options
CC interprets the first character of each record as a carriage
control character. The CC option is assumed if the filetype
is LISTING, DOCUMENT, MANUAL, or LABELS.
Section 2: Command Descriptions 294
CMS Reference
TPRINT
FF causes ASCII Form Feed characters to be used to start each
output page. This is the default unless PAUSE or STOP is
specified.
FINish n is a synonym for TO.
FOR n is the number of pages to be printed. This option should be
specified after the FROM or START option, if one of them is
used.
FROm n is the number of the first page to be printed at the
terminal. The default is one. This page number refers to
the physical page of the output. Files containing carriage
control will often have title pages or other pages before
the numbered pages of text. The page numbers in these
documents will not correspond directly to the page numbers
used by this option.
LINECoun is a synonym for PAGESIZE.
LINESIZE is the maximum length of the lines printed at the terminal.
The minimum value is two, the maximum is 252, and the
default is the current CP TERMINAL LINESIZE setting. You
should have the CP TERMINAL LINESIZE set large enough for
your output data. Generally it should be set to OFF to
eliminate all line breaks by the Control Program (CP).
LS n is a synonym for LINESIZE.
NOCC does not interpret the first character of each record as a
carriage control character. TPRINT will start a new page
every PAGESIZE lines and print a header line that includes
the page number and fileid. NOCC is assumed if the filetype
is not LISTING, DOCUMENT, MANUAL, or LABELS.
NOFF suppresses the use of ASCII Form Feed characters to start
new output pages. This is the default when PAUSE or STOP is
specified. When NOFF is in effect you must manually
position the paper to the top of each new page.
NOPAUse combines the NOSTOP and NOWAIT options.
NOSTop will not stop before each page. This is the default.
NOWAit will cause TPRINT to begin printing immediately.
PAGESIZE is the number of lines per page. The default value is 66.
This option is generally needed only when NOCC is in effect.
PAUse combines the NOFF, STOP, and WAIT options.
PS n is a synonym for PAGESIZE.
Section 2: Command Descriptions 295
CMS Reference
TPRINT
STArt n is a synonym for FROM.
STop causes TPRINT to stop before printing each page at the
terminal, to allow the next page to be prepared. Printing
is resumed by pressing RETURN. STOP is usually used when
printing on cut sheets rather than continuous forms. STOP
implies the NOFF option.
TO n is the number of the last page to be printed at the
terminal. The default is "*", the last page in the file.
The FOR option may also be used to set a page limit. Refer
to the FROM option for information about page numbering.
WAit will cause TPRINT to stop before printing the first page at
the terminal. This is the default.
Usage Notes
1. TPRINT uses standard ASCII Line Feed (LF) and Form Feed (FF)
control characters to control the output at the terminal. Some
terminals will not eject a page when a formfeed character is
received. The PAUSE and STOP options can be used with these
terminals to allow time for manual forms positioning between
pages. The PAUSE option is also useful when printing on cut
sheets, since the formfeed at the start of each page would eject
the sheet. Before using TPRINT with PAUSE or STOP, you should
use the TERMINAL PROMPT command to set the prompt character to
something that won't print. A good choice is the BELL (CTL/G)
character.
2. Most terminals will require some preliminary forms alignment
before printing the file. Usually this will require positioning
the paper at the first line of a page and pressing some control
keys to indicate to the terminal that this is the top of the
page. Anderson Jacobson 832 and 833 terminals use the sequence
ESC (escape) F. Some DECwriters have a special SET TOP OF FORM
button. Some terminals have a switch or other means to set the
form length. Refer to the terminal manufacturer's documentation
for details.
3. TPRINT supports a subset of the American National Standard (ANS)
carriage control characters in the input file. The single space
(blank), double space (0), triple space (-), overprint (+), and
new page (1) characters are supported. All other characters are
currently treated as triple spaces.
4. Be certain that you have set the CP TERMINAL LINESIZE large
enough to print the widest data line in your file, allowing for
three additional characters added to each line for carriage
control. Generally you should set the CP TERMINAL LINESIZE to
Section 2: Command Descriptions 296
CMS Reference
TPRINT
OFF to eliminate line breaks. This can be done automatically in
a PROFILE EXEC.
5. Output from TPRINT may be interrupted with the HT or HX commands,
but this is more complicated if the PAUSE or STOP options are
used. With these options HT will only halt typing for the
current page. Either HT or HX may be entered at the pause before
a page is printed by first causing an attention. On an ASCII
terminal this is done by pressing the BREAK key. On a 3270-type
terminal move the cursor to the left of the input area (it should
be on the last column of the previous line), press ENTER, and
move the cursor back to the input area.
6. You should issue the AJ833 command before using TPRINT on an
Anderson Jacobson 833 terminal.
Messages and Return Codes
DMSTPR002E Input file "fileid" not found. RC=28
DMSTPR003E "name" is not an option. RC=24
DMSTPR029E "value" is not valid in the [name] option field. RC=24
Section 2: Command Descriptions 297
CMS Reference
TYPE
Use the TYPE command to display a CMS disk file on your terminal.
This is only a summary of the most frequently needed functions of the
TYPE command, not a complete description. The TYPE command does not
support carriage control; use the TPRINT command to type a file with
carriage control.
+--------------------------------------------------------------------+
| | + + + +++ |
| Type | filename filetype |filemode |start |stop ||| |
| | |A |1 |* ||| |
| | + + + +++ |
+--------------------------------------------------------------------+
where
filename is the filename of the file to be typed.
filetype is the filetype of the file to be typed.
filemode is the filemode of the file to be typed. The default is
"A."
start is the number of the first line in the file to be typed.
The default is "1."
stop is the number of the last line in the file to be typed. The
default is "*," the end of the file.
Usage Note
TYPE has other options and capabilities. Refer to the VM/SP CMS
Command and Macro Reference or the online Help information for
details.
Section 2: Command Descriptions 298
CMS Reference
UNPACK (EXEC)
Use the UNPACK command to convert a CMS disk file in packed format to
its original format.
+--------------------------------------------------------------------+
| | + + + + + +++++ |
| UNPACK | ifn |ift |ifm |ofn |oft |ofm||||| |
| | |* |A |= |= |= ||||| |
| | + + + + + +++++ |
+--------------------------------------------------------------------+
where
ifn is the filename of the CMS disk file to be unpacked.
ift is the filetype of the file.
ifm is the filemode of the file. The default is "A."
ofn is the filename of the unpacked 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 Note
Refer to the description of the PACK command for more information
about packed files.
Messages and Return Codes
Messages may be generated by the CMS command COPYFILE.
Section 2: Command Descriptions 299
CMS Reference
VERIFY (EXEC)
Use the VERIFY command to write a message to the terminal and read a
response.
+--------------------------------------------------------------------+
| | |
| VERIFY | [text...] |
| | |
+--------------------------------------------------------------------+
where
| text is the text of the message to be typed. When called from
| EXEC (but not REXX or EXEC 2) the text is tokenized. The
| text is always truncated to a length of 130 characters. If
no text is specified, no message is displayed.
Usage Note
VERIFY is intended to aid EXEC writers when a "yes" or "no" response
is needed from the user at the terminal. The specified message text
is displayed and a response read from the terminal (or stack). The
return code depends on the user's response. Return code 0 indicates a
positive response, 100 indicates a negative response, and 101
indicates a bypass response. The following responses are accepted:
Response Code Response Code Response Code
Yes 0 Non 100 ESCape 101
ON 0 OFf 100 BYPASS 101
GO 0 STOP 100
OK 0 NOPE 100
SURE 0
OUI 0
Other responses cause the user to be prompted again.
Section 2: Command Descriptions 300
CMS Reference
WAITRDR
Use the WAITRDR command to cause execution to stop until a reader
spool file arrives.
+--------------------------------------------------------------------+
| | |
| WAITRDR | |
| | |
+--------------------------------------------------------------------+
Usage Notes
| 1. The wait may be terminated prematurely by issuing a CP READY 00C
command or the CMS immediate command HX (Halt Execution). READY
00C causes execution to continue as if a file had arrived.
2. The following EXEC demonstrates how the WAITRDR command might be
used. The EXEC attempts to read a file with the ACCEPT command,
and if none is found uses WAITRDR to wait until one arrives. The
file is then read with ACCEPT the cycle is repeated.
| /* Wait for reader files */
| do forever
| "close rdr"
| do until rc¬=0
| "accept"
| end
| "waitrdr"
| end
Messages and Return Codes
DMSWAI927I Waiting for reader.
Section 2: Command Descriptions 301
CMS Reference
WATFIV
Use the WATFIV command to run a FORTRAN program with WATFIV.
+--------------------------------------------------------------------+
| | |
| WATFIV | filename [filename...] [( [options...] [)]] |
| | |
| | Options: |
| | |
| | + + + + + + + + |
| | |DIsk | |Concat | |NODebug| |NOXtype| |
| | |Print| |NOConcat| |Debug | |XType | |
| | |TYpe | + + + + |NOWarn | |
| | + + |Ext | |
| | + + |
| | + + + + |
| | |Term | |NOStats| |
| | |NOTerm| |Stats | |
| | + + + + |
+--------------------------------------------------------------------+
where
filename is the name of the input file. The filetype of this file
must be "WATFIV" or "FORTRAN," and it must contain fixed-
length, 80-byte records. Multiple input files may be
specified. If you specify an asterisk for a filename, input
is be read from the terminal.
Options
Concat causes WATFIV to treat all input files as one continuous job
stream. All output is written to a disk file named
"filename LISTING". If "*" is specified, the filename
defaults to "WATFIV" and a $JOB card is be generated.
Debug enables the interactive debugger.
DIsk sends the program listing and all unit 6 output to a disk
file. If CONCAT is in effect, all output will be directed
to a single file named "filename LISTING." If NOCONCAT is
in effect, each input file will cause a separate output file
to be created. A filename of "*" (terminal input) causes
"WATFIV" to be used as the output filename.
Ext causes extension messages to be typed at the terminal.
NOConcat causes each input file to be treated as a separate batch.
Input for each filename is compiled separately. Each input
file should contain at least one complete WATFIV job.
Section 2: Command Descriptions 302
CMS Reference
WATFIV
NODebug disables the interactive debugger. This is the default.
NOStats suppresses job statistics at the terminal.
NOTerm suppresses error, warning, and extension messages at the
terminal (except in debug mode).
NOWarn suppresses all but error messages at the terminal.
NOXtype See the XTYPE option. NOXTYPE is the default.
Print sends the program listing and unit 6 output to the printer.
Prt is the same as PRINT.
Stats displays job statistics at the terminal.
Term displays error and warning messages at the terminal.
TYpe sends the program listing and unit 6 output to the terminal.
This is the default when the input file is "*."
XType duplicates unit 6 output on the terminal.
Interactive Debugger Subcommands
EXIT Terminate WATFIV
GOTO stmt-no Resume execution at "stmt-no"
OFF End tracing
RUN Resume execution
STOP isn Stop at statement "isn"
TRACE isn-range Begin tracing
variable ? Display a variable
variable = value Set a variable
Usage Note
Refer to WATFIV Under CMS (available from the MANUAL command) for more
information.
Section 2: Command Descriptions 303
CMS Reference
WBASIC
Use the WBASIC command to run a program with Waterloo BASIC.
+--------------------------------------------------------------------+
| | |
| WBASIC | [filename] [( [options...] [)]] |
| | |
| | options: |
| | |
| | + + + + + + + + |
| | |LOAD| |RUN | |BYE | |VERBOSE| |
| | |OLD | |NORUN| |NOBYE| |TERSE | |
| | |EXEC| + + + + + + |
| | + + |
+--------------------------------------------------------------------+
where
filename is the filename of an input file. The filetype must be
either "WBASIC" or "WSTORE," depending on the options
specified.
Options
BYE specifies that WBASIC should terminate after program
execution. This is the default when a filename is
specified.
EXEC specifies that commands are to be read and processed from a
WBASIC file.
LOAD specifies that a program is to be loaded into the workspace
from a WSTORE file. This is the default if a filename is
specified and a WSTORE file with the given name is found.
OLD specifies that a program is to be compiled into the
workspace from a WBASIC file. This is the default if a
filename is specified, no WSTORE file is found, and a WBASIC
file with the given name is found.
NOBYE specifies that WBASIC should not terminate after program
execution.
NORUN specifies that the loaded or compiled program should not be
run. The program remains available in the workspace.
RUN specifies that the loaded or compiled program should be run.
This is the default when a filename is specified.
TERSE will suppress informational messages.
Section 2: Command Descriptions 304
CMS Reference
WBASIC
VERBOSE specifies that all informational messages should be
displayed. This is the default.
Usage Note
Additional information can be found in the Introduction to Waterloo
BASIC for VM/370 CMS (available from the MANUAL command).
Section 2: Command Descriptions 305
CMS Reference
XEDIT
Use the XEDIT command to invoke the System Product Editor to create,
examine, and modify CMS disk files. XEDIT can also be used to examine
OS disk data sets and can be used to copy them to CMS disk files.
Once XEDIT has been invoked, the XEDIT environment is entered and
XEDIT subcommands and macros, CP commands, and CMS commands and EXEC's
can be entered. XEDIT is the editor used by the PEEK, NOTE, OSXEDIT,
and RXEDIT commands.
| Return control to the CMS environment with the CANCEL, QUIT, QQUIT,
| FILE, or FFILE subcommands.
This is not a complete description of the facilities available from
XEDIT. Consult the VM/SP System Product Editor Command and Macro
Reference, the VM/SP System Product Editor User's Guide, and the
online HELP command for more information.
+--------------------------------------------------------------------+
| | |
| Xedit | [fn [ft [fm]]] [(options... [)]] |
| | |
| | Options: |
| | |
| | [Width n] [NOSCreen] + + |
| | |PROFile macroname| |
| | [NOCLear] |NOPROFile | |
| | + + |
| | | [NOMsg] |
| | |
| | UPDATE Mode Options: |
| | |
| | + + + + + + |
| | |Update | |Seq8 | |Ctl cntrlname| |
| | |NOUpdate| |NOSeq8| |NOCtl | |
| | + + + + + + |
| | |
| | | [Merge] [Incr n] [SIDcode string] [UNtil filetype] |
| | |
+--------------------------------------------------------------------+
where
fn is the filename of the file to be edited or created. If not
specified, it must be provided by the LOAD subcommand in the
XEDIT PROFILE.
ft is the filetype of the file. If not specified, it must be
provided by the LOAD subcommand in the XEDIT profile.
Section 2: Command Descriptions 306
CMS Reference
XEDIT
fm is the filemode of the file. If no filemode is specified,
all accessed disks are searched for an existing file with a
matching name and type. If none is found, a new file is
created using filemode "A1."
Options
Ctl cntrlname
controls the XEDIT multi-level update facility. Use of the
CTL option implies the UPDATE and SEQ8 options. Consult the
description of the CMS UPDATE command in the VM/SP CMS
Command and Macro Reference for details.
Incr n specifies the minimum serial number increment between two
adjacent lines used by XEDIT when assigning numbers to new
lines. The default is one. This option implies the UPDATE
option.
Merge specifies that all the updates made using the control file
and all the changes made while editing will be merged and
written into the most recent update file. This option
implies the UPDATE option.
NOCLear specifies that the screen is not to be cleared by XEDIT.
The screen will be placed in "MORE..." status and any
messages on the screen will still be visible. Either press
CLEAR or wait one minute to clear the screen and begin
normal XEDIT processing. This option is useful only on
3270-type display terminals.
| NOMsg causes XEDIT to start with MSGMODE OFF.
NOPROFil suppresses execution of the profile macro.
NOSCreen forces XEDIT to operate in line (typewriter) mode when used
on a 3270-type terminal.
NOSeq8 If NOSEQ8 is specified, columns 73 through 75 are assumed to
contain a label field, and columns 76 through 80 are assumed
to contain sequence numbers. Specifying NOSEQ8 will force
the UPDATE option and cause XEDIT to operate in update mode.
| NOUpdate disables the XEDIT update facility. This is the default
| unless CTL, NOSEQ8, SIDCODE, SEQ8, or UNTIL are specified.
PROFile macroname
specifies the name of the XEDIT profile. The profile is an
XEDIT macro (filetype must be XEDIT) executed each time the
XEDIT command or subcommand is issued. It can be used to
tailor the XEDIT environment to your own needs and
Section 2: Command Descriptions 307
CMS Reference
XEDIT
preferences. The Usage Notes contain more information about
writing a profile macro. If this option is not specified
the macro name "PROFILE" will be used.
Seq8 if SEQ8 is specified, columns 73 through 80 are assumed to
contain sequence numbers. SEQ8 is the default in update
mode. Specifying SEQ8 also implies the UPDATE option and
will cause XEDIT to operate in update mode.
SIDcode string
specifies an identifier used to mark all new or changed
lines in an update file. The string is placed in columns 64
through 71 (padded on the right with blanks to a length of
eight), overlaying any other data in these columns, unless
column 72 contains a non-blank character. This option
implies the UPDATE option.
| UNtil filetype
| specifies the filetype of the last update to be applied.
| The filetype cannot be that of an UPDATE AUX file. This
| option implies the UPDATE option.
Update enables the XEDIT update facility. XEDIT supports an update
mode which is compatible with all of the features of the CMS
UPDATE command, including multi-level updating. Consult the
VM/SP CMS Command and Macro Reference and the VM/SP System
Product Editor Command and Macro Reference for details.
Width n sets the maximum length used to store one record from the
file. The WIDTH may also be specified with the LOAD
subcommand in an XEDIT profile. If no value is specified,
the default is either the actual record length of the file,
or the default record length for the filetype, whichever is
larger. The WIDTH is used to set the default values for
LRECL and TRUNC. Specifying a width less than the actual
record length of an existing file can cause records to be
truncated.
Display and Typewriter Modes
XEDIT supports all terminal types supported by CMS. When used from a
3270-type display terminal it will operate in DISPLAY mode. On other
types of terminals it will operate in TYPEWRITER (line) mode.
Typewriter mode can be forced on a 3270-type terminal with the
NOSCREEN option or the SET TERMINAL subcommand. This may be desirable
on a remote 3270-type terminal when the line transmission rate is low.
Some XEDIT subcommands will function only in display mode.
Section 2: Command Descriptions 308
CMS Reference
XEDIT
The XEDIT Display Screen Format
When operating in display mode, XEDIT will control the format of the
screen. The display screen will appear as follows:
+-----------------------------------------------------+
| fn ft fm V 80 TRUNC=n SIZE=n LINE=n COLUMN=n ALT=n |<--File Id Line
| |<--Message Line
|===== * * * TOP OF FILE * * * |
|===== |
|===== |
|===== |<--Current Line
| |...+....1....+....2... ... ...6....+....7..> |<--Scale
|===== |
|===== |
|===== * * * END OF FILE * * * |
| |
|===> |<--Command Line
| X E D I T 1 FILE |<--Status Area
+-----------------------------------------------------+
| | | |
+---+ +---------------------------------------------+
| |
Prefix Area File Area
The first line of the display is the File Identification Line. It
contains the filename, filetype, and filemode of the file being
edited. The next two items are the record format (V for variable-
length, F for fixed-length, VP for packed variable-length, or FP for
packed fixed-length) and the maximum record length. Following these
are the truncation column (TRUNC), the number of lines in the file
(SIZE), the current line number (LINE), and the column pointer
| (COLUMN). The last item on this line is the alteration count (ALT).
| The count is incremented for each subcommand that causes a change in
the file and for every line that is directly modified. When the
alteration count reaches the SET AUTOSAVE value (if you have set one),
the file is automatically saved. The alteration count is reset to
| zero after an automatic save and by the SAVE subcommand. You may use
| the QUERY ALT subcommand to determine the alteration count at any
time. You cannot type on the File Id Line.
Following the File Id Line is the Message Line. This line is used to
display XEDIT error and informational messages. You can't type on
this line either.
Following the Message Line is the File Area. The lines in this area
are used to display and enter data. You may type directly in this
area to enter new lines or modify existing lines. One line in the
File Area is designated the Current Line. This line appears in the
middle of the screen and will be highlighted to make it easy to find.
Many XEDIT subcommands perform their functions on the current line or
on a group of lines beginning with the current line.
Section 2: Command Descriptions 309
CMS Reference
XEDIT
Each line in the File Area is preceded by a special command area
called the Prefix Area (marked with "====="). The commands entered in
the Prefix Areas are called prefix subcommands and generally operate
on or following the line on which they are entered. Prefix
subcommands can be used to add, delete, duplicate, move, and copy
lines in the file. The SET PREFIX subcommand can be used to move the
Prefix Areas to the right of the screen, or remove them entirely. The
SET NUMBER subcommand can be used to cause line numbers to be
displayed in the Prefix Areas.
The Command Line is actually about one and three-quarters of a line at
the bottom of the screen. XEDIT subcommands and macros, CP commands,
and CMS commands and EXECs can be entered on the Command Line. The
SET CMDLINE subcommand can be used to move the Command Line to the top
of the screen, where it will share the space occupied by the Message
Line.
The Status Area is on the right at the bottom of the screen, following
the Command Line. The Status Area indicates the current operating
mode (XEDIT, COPY/MOVE PENDING, BLOCK INCOMPLETE, INPUT-MODE, UPDATE-
MODE, or MACRO-READ) and the number of files currently being edited.
The SET CMDLINE subcommand can be used to remove the Status Area from
the display.
The Scale Line appears under the current line and indicates the column
numbers, the position of the column pointer (marked "|"), the left and
right zone columns (marked "<" and ">"), and the truncation column
(marked "T"). The Scale Line can be repositioned on the screen (or
removed entirely) with the SET SCALE subcommand.
Keyboard Functions (for 3270 Displays)
CLEAR will clear the screen and cause the display to be rebuilt as
it was after the last time ENTER or a PF key was pressed.
CLEAR also clears the CMS stack.
ERASE INPUT
will erase everything in the input and command areas.
ERASE EOF will erase everything from the cursor to the end of the
line. In power or long input mode ERASE EOF will erase
everything from the cursor to the end of the screen.
ENTER causes XEDIT to read the screen and analyze its contents.
PA1 will transfer control to CP and clear the screen. A CP READ
status will be displayed. Enter BEGIN to return to XEDIT.
PA2 will have the effect of setting nulls on for the line that
contains the cursor. This allows insert mode (see INS MODE
below) to be used on the line.
Section 2: Command Descriptions 310
CMS Reference
XEDIT
Cursor Movement
keys are available to move the cursor forward, backward, up,
and down on the screen. A cluster of four keys marked with
arrows are used to move the cursor one space at a time. The
New Line key (marked <- is used to move the cursor to the
beginning of the next line. Tabbing between input and
command areas can be done with the forward and backward tab
keys (marked ->| and |<-).
PFnn will cause the information associated with the Program
Function key pressed to be processed. This data is stacked
and may contain commands or data or some combination. The
data associated with each PF key may be set with the SET PFn
subcommand. The current settings may be displayed with the
QUERY PF subcommand. Initially, the PF keys have the
following assignments:
| PF1 BEFORE HELP MENU PF7 BEFORE BACKWARD
| PF2 BEFORE SOS LINEADD PF8 BEFORE FORWARD
| PF3 BEFORE QUIT PF9 ONLY =
| PF4 BEFORE TABKEY PF10 BEFORE RGTLEFT
| PF5 BEFORE SCHANGE 6 PF11 BEFORE SPLTJOIN
| PF6 ONLY ? PF12 BEFORE CURSOR HOME
INS MODE places the terminal in insert mode. This causes typed
characters to be inserted at the cursor position and shifts
other characters on the line to the right. To use insert
mode on a data line requires that SET NULLS ON be in effect,
or that PA2 be pressed while the cursor is on the line. To
leave insert mode, press RESET. You should not use INS MODE
while in long input mode.
DEL will delete the character at the cursor position and shift
any following characters to the left. You should not use
DEL while in long input mode.
RESET will reset insert mode and error conditions. You should not
use this key to reset an "INPUT INHIBITED" condition caused
by slow system response time. This can confuse XEDIT and
may cause loss of data.
FIELD MARK
will enter a unique character (hexadecimal 1E, an EBCDIC
Record Separator). A FIELD MARK will appear on most screens
as either ";" or a right-arrow. FIELD MARK is entered as a
shifted PA2.
DUP will enter a unique character (hexadecimal 1C, an EBCDIC
Field Separator) and physically move the cursor to the start
of the next field (usually the start of the next line or
Prefix Area). On most terminals the DUP character will be
Section 2: Command Descriptions 311
CMS Reference
XEDIT
displayed as either "*" or "/" until the field is rewritten.
DUP is entered as a shifted PA1.
XEDIT Subcommands
XEDIT has two types of subcommands: subcommands entered on the Command
Line and those entered in Prefix Areas. Those entered on the command
line are generally called subcommands, while those entered in Prefix
Areas are known as prefix subcommands. The Command Line may also be
| used to enter XEDIT macros, CP commands, and CMS commands and EXEC's.
| XEDIT macros are REXX or EXEC 2 files with a filetype of "XEDIT."
| These can be used to combine XEDIT subcommands and macros, CP
commands, CMS commands and EXEC's, and EXEC functions to create new
functions. Macros are executed by entering their name on the Command
Line just like a subcommand.
Commands on the Command Line may be preceded by the character "&" in
column one; this will cause XEDIT to leave the string on the screen.
The command, or commands, may then be repeated by simply pressing the
ENTER key. Multiple subcommands may be entered on the Command Line by
separating them with a line end character. The default line end
character is a pound sign (#). If any error occurs when processing a
command, the command will be left on the Command Line for correction.
Prefix subcommands generally correspond to similar subcommands that
would be entered on the Command Line. While subcommands generally
operate on or following the current line, prefix subcommands usually
operate on or following the line on which they are entered. Prefix
subcommand arguments may either precede or follow the subcommand in
| the Prefix Area. Prefix subcommands also can be executed with the
| LPREFIX subcommand.
When the ENTER key or a PF key is pressed, XEDIT will read and process
the screen. Processing proceeds in the following order:
1. Record any changes made in the data display area.
2. Process any prefix commands.
3. Process any commands from a Program Function key.
4. Process any commands found on the command line.
If a PF key is set to a special PF key function (like TABKEY),
pressing the PF key will not cause commands on the screen to be
processed. When all processing is complete, the file will be written
to disk if the number of lines altered, added, or deleted since the
last SAVE has reached or exceeded the SET AUTOSAVE threshold (see
Usage Note 2). The new screen is then displayed.
XEDIT commands make use of several important concepts. Most important
is the concept of the current line. Many subcommands operate either
on or beginning on the current line, and several subcommands exist to
Section 2: Command Descriptions 312
CMS Reference
XEDIT
make some specified line the current line. In display mode the
current line is highlighted and appears in the center of the display;
on other kinds of terminals the current line is generally the line
most recently typed.
Another important concept is that of targets. A target is used to
identify a particular line to XEDIT. Targets may be absolute line
numbers (in the form ":n"), relative line numbers (either "n", "+n",
or "-n"), names (".name" assigned with the SET POINT subcommand or the
"." prefix subcommand), or string expressions. A string expression is
from one to four character strings delimited by any non-blank
character that does not appear in the string. The string expression
may be preceded with a "+" or "-" to indicate the search direction (a
"+" is assumed). As many as four separate delimited strings
(separated with vertical bars) may be included in the expression.
This will match a line containing any one of the strings. Each string
may also be preceded with a "¬" to locate a line that does not contain
the string. String expressions may also make use of several SET
subcommand options. SET ARBCHAR allows a string of unknown characters
to be specified. SET CASE specifies whether or not the difference
between upper and lowercase is significant. SET HEX ON allows the
characters to be specified as hexadecimal values. SET SPAN can be
used to allow targets to span multiple lines in the file. SET
VARBLANK specifies whether or not the number of blanks between words
is significant. Targets are used as arguments by some subcommands
(particularly LOCATE), as subcommand prefixes, or may be entered alone
to make the line specified by the target the current line.
XEDIT also makes use of a column pointer and column targets, which are
similar in some respects to the current line and targets. Column
pointer movement is controlled and used by a set of special column-
oriented subcommands (CLOCATE, CINSERT, CDELETE, etc.). In display
mode the current line and column pointer is indicated in the header
line and the scale line. On other types of terminals the column
pointer position is marked by underscoring. Column-targets may be
absolute or relative column numbers, or string expressions. Use -* to
refer to the left zone column and * or +* to refer to the right zone
column.
The following describes the XEDIT subcommands and supplied macros.
Default parameter values are listed immediately following the general
form.
&[command]
causes the specified command to be retained in the input
area on a 3270-type terminal. The command may be repeated
by pressing ENTER.
= [command]
repeats the execution of the last command entered for this
file, or executes a specified command and then repeats the
Section 2: Command Descriptions 313
CMS Reference
XEDIT
last command. The = buffer may be changed with the SET =
subcommand.
? displays the last command entered for this file. Repeated
execution of the ? subcommand displays previous commands. ?
cannot be used from a macro, and cannot have a synonym.
Add [n] adds lines after the current line. The number of lines
added is specified by "n." The default is one line. ADD is
allowed only in display mode.
ALL target
displays the target lines and excludes all others. ALL is a
macro.
ALter char1 char2 [target|1 [n|1|* [p|1]]]
changes a single character to another character. The
characters can be specified as two hexadecimal digits. The
remaining arguments correspond to those of the CHANGE
subcommand. ALTER is a macro.
BAckward [n]
scrolls backward (toward the top of the file) the indicated
number of screens. The default is one screen.
Bottom makes the last data line of the file or range the new
current line.
BURN erases the current file from disk and issues a QUIT
subcommand. If you are using RXEDIT to edit a reader spool
file the spool file is purged. This will completely destroy
the file you are editing. BURN is a macro.
CANCEL immediately terminates XEDIT. It is equivalent to entering
QUIT for each file being edited. CANCEL is a macro.
CAPPEND [text]
appends the specified text to the end of the current line.
The column pointer is moved to the first appended character,
or the first trailing blank if no text is given. CAPPEND is
a macro.
CDELETE [column target|1]
deletes characters from the current line, beginning at the
column pointer and deleting up to the column target. SET
STREAM ON (the initial setting) allows text on multiple
lines to be deleted.
CFIRST moves the column pointer to the beginning of the ZONE.
Change /string1 [/string2/ [target|1 [n|1|* [f|1]]]]
Section 2: Command Descriptions 314
CMS Reference
XEDIT
replaces occurrences of "string1" with "string2." The
delimiter (/) may be any non-blank character that does not
appear in the strings. If "string2" is omitted, a null
string is used. The target specifies the number of lines to
be searched. Lines are searched beginning with the current
line and ending before the target line. The value "n" is
the number of occurrences of "string1" that may be changed
on each line, and "f" is the relative number of the first
occurrence on each line to be changed. The search for
string1 is limited by the current ZONE columns, but the
| change may affect data from the left ZONE column to the
| TRUNC column. SET SPILL controls what happens to characters
| pushed past the TRUNC column. SET STAY controls current
line positioning after multiple line changes. SET VERIFY ON
causes all changed lines to be displayed. The strings may
make use of the ARBCHAR. SPAN and VARBLANK settings are
ignored.
CINSERT text
inserts text immediately before the column pointer in the
current line.
CLAST moves the column pointer to the end of the ZONE.
CLocate column-target
makes the column specified by the column target the column
pointer value. Searching begins at the column pointer
position in the current line. If SET STREAM ON (the initial
setting) is in effect searching continues beyond the current
line.
CMS [text]
will pass "text" to CMS as a command. If "text" is not
specified CMS subset mode is entered. Use the RETURN
command to return to XEDIT.
CMSG [text]
puts a message on the command line of a 3270-type terminal.
CMSG is intended for use in macros.
COMMAND [text]
executes "text" as an XEDIT subcommand, without checking for
synonyms or macros. If "text" is not an XEDIT subcommand,
and SET IMPCMSCP is ON, it is passed to CMS or CP as a
command. The & and ? subcommands cannot be used.
COMPRESS [target|1]
replaces blank (or FILLER) characters immediately preceding
the current tab columns with a single tab character. The
SET TABS and EXPAND subcommands are used to align the
compressed text to new columns.
Section 2: Command Descriptions 315
CMS Reference
XEDIT
COpy target1 target2
copies one or more lines, beginning with the current line
and ending before the "target1" line, to the "target2" line.
The last line copied becomes the current line.
COUnt /string[/target|1]
counts the occurrences of "string," beginning with the
current line and ending before the target. The count is the
number of strings that would be affected by a CHANGE
subcommand specifying the same string.
COVerlay text
overlays the current line (starting at the column pointer)
with the non-blank characters in "text." Use underscores in
"text" to force blanks on the current line.
CP [text] passes "text" to the Control Program (CP) as a command. If
"text" is not specified, control transfers to CP mode; use
the BEGIN command to return to XEDIT.
CReplace text
replaces the characters in the current line (starting at the
column pointer) with the "text." This is similar to
COVERLAY, except blanks and underscores have no special
significance.
| CURsor CMdline [column|1] [Priority n]
| Column [Priority n]
| File line [column] [Priority n]
| Home [Priority n]
| Screen line [column] [Priority n]
| moves the cursor to the specified column on the command
| line, the current line and column pointer position, a file
| line, switches between a screen line and the command line,
| or moves to a screen line. It also assigns a priority to
| the new position. This subcommand is allowed only in
display mode.
DBLANK removes all of the blank lines from a file. DBLANK is a
macro.
DELete [target|1]
deletes one or more lines, beginning with the current line
and ending before the target.
Down [n|1|*]
advances the current line "n" lines toward the end of the
file.
DUPlicat [n|1 [target|1]]
Section 2: Command Descriptions 316
CMS Reference
XEDIT
duplicates one or more lines, beginning with the current
line and ending before the target, "n" times.
EMSG [code] [text]
displays an error message. Refer to the description of the
CMSEMSG command elsewhere in this manual for a description
of the optional message identifier code. If the code is not
supplied, or if the severity is E, S, or T, the alarm will
be sounded. EMSG is intended for use in macros.
EXPAND [target|1]
replaces tab characters in the specified lines with blanks
(or the SET FILLER character) to align to the current tab
columns. EXPAND can be used in conjunction with COMPRESS
and SET TABS to realign tables and other text.
EXPLAIN displays the HELP information for the most recently issued
XEDIT error message. For EXPLAIN to work properly, CP SET
EMSG must be ON before the error occurs. This can be done
automatically with a CP SET EMSG ON command in your PROFILE
EXEC or XEDIT PROFILE. EXPLAIN is a macro.
| EXTract /operand[/operands...
| returns information to an EXEC or XEDIT macro by setting
| variables in the EXEC or macro. EXTRACT can obtain
| information not obtainable with TRANSFER. Refer to the
| XEDIT Reference or online HELP for more information.
| FFile is a synonym for COMMAND FILE. See FILE and PFILE for more
| information.
FILE [fn [ft [fm]]]
= = =
puts the current file into a CMS disk file and removes it
from the set of files being edited. If only one file was
being edited XEDIT terminates. Optionally, a fileid may be
specified to override the current fileid. An "=" may be
used in place of "fn", "ft", or "fm" to specify that the
| current setting for this identifier is to be used. A FILE
| issued from a macro when only one file is being edited is
| not executed until the macro ends. FILE cannot be used from
| a prefix macro. By default, FILE is a synonym of PFILE.
Find text searches forward from the line following the current line
for a line beginning with "text." Columns containing blanks
in "text" are not checked; columns containing underscores
are matched for blanks. The search starts at the first tab
position in each line. The first line containing "text"
becomes the current line. SET WRAP controls wraparound from
the bottom of the file.
Section 2: Command Descriptions 317
CMS Reference
XEDIT
FINDUp text
FUp is similar to FIND, but searches up (toward the top of the
file), rather than down.
FLOW [target|2 [l|1 [r|70]]]
reformats lines beginning with the current line and ending
before the target. The lines are concatenated and then
broken at word boundaries to fit within the specified left
and right column margins. FLOW is a macro that uses SCRIPT
to format the text, and SCRIPT control words in the text are
processed (.AD, .CO, .FO, .JU, .LL, and .NF should not be
used).
FOrward [n|1|*]
scrolls toward the end of the file the specified number of
screens. FORWARD is allowed only in display mode.
GET [fn|= [ft|= [fm|*|=] [f|1 [n|*]]]]
inserts lines after the current line. The lines come from
the PUT/PUTD buffer, or a specified CMS file. When a CMS
fileid is specified, "f" (the first record to be read) and
"n" (the number of records to be read) may also be
specified. The new records are truncated or filled to the
required record length. Packed files are not unpacked.
HELP [MENU|topic]
displays information about XEDIT subcommands and macros.
The "topic" may not use abbreviations. MENU displays a list
of all XEDIT subcommands and macros. The "topic" can also
be anything accepted by the CMS HELP command.
HEXTYPE [target|1]
displays lines beginning with the current line and ending
before the target in both hexadecimal and character form.
HEXTYPE is a macro.
INLong enters long input mode. In this mode you can enter data
lines as wide as the display screen (or to the current
truncation column, whichever is shorter). Each line on the
screen is entered into the file as a data line. Pressing
the ENTER key causes the lines to be entered and a new input
screen to be displayed. Pressing the ENTER key with no new
data on the screen terminates input mode. The last line
entered becomes the current line. The current line and the
SCALE and TABLINE indicators are displayed at the top of the
screen in protected form. The remaining lines on the screen
can be used for input. Each input line contains the current
SET MASK data (initially all blank). VERIFY is forced to
begin with column one and end at the truncation column or
the end of the screen line. The normal operation of the
Program Function (PF) keys and PA2 key are suspended; these
Section 2: Command Descriptions 318
CMS Reference
XEDIT
keys are ignored with the exception of PF keys set to
TABKEY, SOS TABF, or SOS TABB. The multiple tab features of
SOS TABF and TABB are not supported. Tabbing beyond the
last tab column moves the cursor to the first tab column of
the next line. Backward tabbing will not move to the left
of the first tab column. The LINEND character is treated as
a normal data character. XEDIT SET CASE and CMS SET INPUT
translations are made. Use the insert (INS MODE) and delete
(DEL) keys with care; the entire screen is one long field
and inserting or deleting characters causes the input data
to become aligned to other than the normal line boundaries.
INLONG is allowed only in display mode.
Input [text]
enters new lines into a file after the current line. If
"text" is specified, one line containing "text" is inserted;
otherwise, XEDIT enters input mode and new lines may be
| entered. Only data typed within the VERIFY columns is
| accepted. In display mode, press ENTER once for a new input
screen, twice to return to edit mode. In typewriter mode,
enter an empty line to return to edit mode. The last line
entered becomes the current line.
| Join [ALigned] [Column|CURSOR]
| [ALigned] [column|/string/]...
joins two or more lines, beginning with the current line,
into one new line, and deletes the original lines from the
| file. ALIGNED attempts to correct for leading blanks on the
| lines being joined. If no operand is specified the current
| line and the following line are joined following the last
non-blank on the current line. COLUMN can be specified to
join two lines at the column pointer position. Column
numbers will append additional lines at the specified
columns. "String" will append the specified string to the
current line and then append a line. CURSOR is used to join
the line containing the cursor and the following line (for
display mode only). The new line will be truncated to fit
| within the current record length. JOIN is a macro. See
| also SPLTJOIN.
JUSTIFY [target|* [l|1 [r|70]]]
reformats lines beginning with the current line and ending
before the target. The lines are concatenated, broken at
word boundaries, and aligned to the left and right column
margins. JUSTIFY is a macro that uses SCRIPT to format the
text, and SCRIPT control words in the text are be processed
(although .AD and .LL should not be used).
LEft [n|1]
changes the columns displayed so that data to the left of
the first column on the screen is visible. The data appears
| to move to the right. See also RGTLEFT.
Section 2: Command Descriptions 319
CMS Reference
XEDIT
LOAD [fn [ft [fm]]] [(options... [)]]
is used from a profile macro to load the file into storage
for editing. The format of the LOAD subcommand is the same
as that of the XEDIT command. All XEDIT parameters and
options may be specified, although options specified on the
XEDIT command will override those specified on the LOAD
subcommand. If used, LOAD must be the first XEDIT
subcommand in the XEDIT profile. The WIDTH option of the
LOAD subcommand is overridden if it would cause truncation
of existing file lines. The default SET LRECL, SET TRUNC,
and SET ZONE values are assigned when LOAD is executed.
[Locate] target [subcommand]
searches the file, starting after the current line, for the
specified target. The first line containing the target
becomes the new current line. A subcommand may be specified
to be executed after positioning at the new current line.
SET STAY and SET WRAP control the operation of LOCATE.
LOWercas [target|1]
converts uppercase letters to lowercase, beginning with the
current line and ending before the target line.
| LPrefix text
| executes "text" as a prefix subcommand on the current line.
| This can be used in display or typewriter mode.
MACRO [text]
executes "text" as an XEDIT macro, without checking for
synonyms or subcommands.
| MErge target1 target2 [column|1]
| overlays the second group of lines with data from the first
| group and then deletes the first group. The first group of
| lines contains the lines from the current line and ending
| before "target1." The second group begins with "target2."
| The data from the first group can be shifted with the
| "column" parameter. MERGE treats underscores as ordinary
| data characters.
MODify keyword
displays a subcommand and its current setting on the command
line where it can be modified (if desired) and entered.
MODIFY is allowed only in display mode. Refer to the XEDIT
Reference or online HELP for a list of valid keywords.
MOVE target1 target2
moves one or more lines, beginning with the current line and
ending before the "target1" line, to the "target2" line.
The original lines are deleted. The last line moved becomes
the current line.
Section 2: Command Descriptions 320
CMS Reference
XEDIT
MSG [text]
displays a message. MSG is intended for use in macros.
Next [n] is the same as the DOWN subcommand.
NFind text
searches forward from the line following the current line
for a line not beginning with "text". Columns containing
blanks in "text" are not checked; columns containing
underscores are matched for blanks. Searching begins at the
first tab position in each line. The first line not
containing "text" becomes the current line. SET WRAP
controls wraparound from the bottom of the file.
NFINDUp text
NFUp is similar to NFIND, but searching is up (toward the top of
the file), rather than down.
Overlay text
overlays the current line with "text." Blanks in the text
do not change existing characters, and underscores in the
text cause blanks to be placed in the current line.
PARSE column keyword ...
is a macro used for parameter processing in macros. Refer
to the XEDIT Reference or online HELP for details.
| PFILE [fn [ft [fm]]]
| = = =
| saves the current file in a CMS disk file and removes it
| from the ring of files being edited. XEDIT ends if this was
| the last file in the ring. If you changed the identifier of
| the file, and a with the new name already exists, you will
| be prompted to enter FFILE to overwrite the file on disk.
| By default, FILE is a synonym of PFILE.
POWerinp enters "power input" mode. The entire display screen is
treated as one line, and text may be entered without regard
to physical line boundaries on the screen. Pressing ENTER
once causes a new input screen to be displayed, twice
returns to edit mode. When input mode ends lines entered
are broken to fit within the current truncation setting, and
words broken over line boundaries are reassembled. Use the
LINEND character to force data to the beginning of a line.
The last line entered becomes the current line. POWERINP is
allowed only in display mode.
PQUIT [n] terminates editing of the current file and returns control
to CMS if there is only one file being edited. If the file
has been altered you will be prompted to enter QQUIT. The
optional argument is a return code for use with macros. By
default, QUIT is a synonym of PQUIT.
Section 2: Command Descriptions 321
CMS Reference
XEDIT
| PSAVE [fn [ft [fm]]]
| = = =
| saves the current file in a CMS disk file. If you changed
| the identifier of the file, and a with the new name already
| exists, you will be prompted to enter SSAVE to overwrite the
| file on disk. By default, SAVE is a synonym of PSAVE.
| PREServe saves the current settings of several XEDIT SET subcommand
| variables for later restoration with the RESTORE command.
| The current line pointer, column pointer, and some SET
| values are not saved. Refer to the XEDIT Reference or
| online HELP for more information.
| PURge macroname
purges the current copy of the named macro from storage.
PUT [target|1 [fn|= [ft|= [fm|=]]]]
saves records beginning with the current line and ending
before the target line. If no fileid is specified the lines
are placed in a special buffer for later use by the GET
| subcommand. (The buffer is cleared by each PUT and PUTD).
| If a CMS fileid is specified, a CMS disk file will be
created. If the file already exists, the lines will be
added to the end. The target line becomes the current line.
PUTD [target|1 [fn|= [ft|= [fm|=]]]]
is similar to PUT, except the specified lines are deleted
from the current file.
QQUIT [n] terminates editing of the current file and ends XEDIT if
only one file is being edited. The optional argument is a
| return code for use with macros. By default, QQUIT is a
| synonym for COMMAND QUIT, and QUIT is a synonym for PQUIT.
Query keyword
| displays the current value of the specified XEDIT setting.
| Use EXTRACT (or TRANSFER) to obtain these values in an EXEC
| or macro. Refer to the XEDIT Reference or online HELP for a
| list of keywords.
QUIT [n] terminates editing of the current file and ends XEDIT if
there is only one file being edited. The optional argument
| is a return code for use with macros. By default, QUIT is a
| synonym for COMMAND PQUIT, and QQUIT is a synonym for
COMMAND QUIT. PQUIT also clears the stack.
RBLANK target
changes all multiple blanks to single blanks, beginning with
the current line and ending before the target.
| Cmdline
| READ All [Number] [Tag|Notag]
Section 2: Command Descriptions 322
CMS Reference
XEDIT
| Nochange [Number]
stacks the specified information. CMDLINE (the default)
stacks the command input area. ALL stacks all changed lines
on the screen, followed by the CMDLINE. NOCHANGE is similar
to ALL, but the changes on the screen are not made to the
file. The NUMBER operand causes stacked lines to be
prefixed with their file line number. Specifying TAG causes
| each line to include additional information. READ is
| intended for use in macros. Refer to the XEDIT Reference or
| online HELP for more information.
| RECover [n|1|*]
recovers lines deleted by DELETE, MERGE, or PUTD. The
recovered lines are inserted before the current line. All
deleted lines (within the limits of available storage) are
saved in one buffer and are moved from this buffer by the
| RECOVER subcommand. RECOVER usually can't be used in UPDATE
| mode.
| REFRESH updates the display. It can be used from a macro to update
| the display without ending the macro or waiting for input.
| REFRESH is allowed only in display mode.
RENum [start|10 [incr]]
renumbers the lines in files with a filetype of BASIC,
COBOL, FREEFORT, VSBASIC, or WBASIC. The default increment
is the value of the starting number.
REPEat [target|1]
will advance the current line and repeat the last command.
REPEAT is equivalent to entering =UP or =DOWN until the
| target is reached, or a non-zero return code occurs.
Replace [text]
replaces the current line with "text," or deletes the
current line and enters input mode.
RESet removes all pending prefix subcommands.
RESTore restores the settings saved by the PRESERVE subcommand.
| RGTLEFT [n]
| changes the view columns to display data currently not
| visible on the screen. You can specify the number of
| columns to move. SET VERSHIFT controls the direction of the
| shift. RGTLEFT is a macro and is allowed only in display
| mode.
RIght [n] changes the columns displayed so that data to the right of
the last column on the screen is visible. The data will
| appear to move to the left. See also RGTLEFT.
Section 2: Command Descriptions 323
CMS Reference
XEDIT
RINPUT id1 id2 [(options...]
uses the CMS command INPUT to read a reader spool file into
the file being edited. The parameters and options are the
same as those of the CMS command INPUT. Except for the file
destination options (APPEND, DISK, DSTACK, REPLACE, SELECT,
and XEDIT), any INPUT option may be specified. The NOHOLD
option is ignored and the spool file is be retained in your
reader. RINPUT inserts the file after the current line (or
at the end of the file if the current line is the EOF
| indicator). The current line does not change and the
| alteration count is incremented by one. RINPUT is a macro.
SAVE [fn [ft [fm]]]
= = =
| saves the current file in a CMS disk file. By default, SAVE
| is a synonym of PSAVE.
SCHANGE [pfkey]
locates and selectively changes occurrences of a specified
string. SCHANGE can only be used in display mode and only
from a Program Function key. To use SCHANGE, place a CHANGE
or CLOCATE subcommand in the command area and press the
SCHANGE PF key instead of ENTER. The cursor is placed under
the specified string (if found). Pressing the PF key again
will move the cursor to the next occurrence of the string.
Pressing the key indicated by "pfkey" on the SCHANGE command
will execute the CHANGE subcommand. Searching begins with
| the current line and column pointer. If you press the
| SCHANGE PF key without a CHANGE subcommand on the command
| line the subcommand in the LASTLORC buffer is used. SCHANGE
| is a macro.
SET keyword [operands...]
| is used to control an assortment of XEDIT options. The
| various settings can be examined with the QUERY, EXTRACT,
| and TRANSFER subcommands. The SET subcommand name is only
required with the SET =, SET ALT, SET MACRO, and SET MSGLINE
subcommands.
SET = text
sets the command reuse (=) buffer. This is intended for use
in macros.
| SET ALT n [m]
| sets the alteration count to the specified value. The first
| value is the number of alterations since the last autosave,
| the second value is the number since the last SAVE.
[SET] APL ON|OFF
controls support for the 3270 APL character set. The
initial setting is determined by the CP TERMINAL APL
command.
Section 2: Command Descriptions 324
CMS Reference
XEDIT
[SET] ARBchar ON [char]
OFF
defines a character to represent an arbitrary character in a
target. The initial setting is ARBCHAR OFF $.
[SET] AUtosave n [fm|A]
OFF
causes a SAVE subcommand to be issued automatically when "n"
lines have been added, changed, or deleted. A filemode may
be specified. The file is written to a special CMS disk
| file named "rrrnnnnn AUTOSAVE fm." The SAVE and FILE
| subcommands erase the autosave file; QUIT does not. See the
Usage Notes for more information on AUTOSAVE. The initial
setting is AUTOSAVE OFF.
[SET] CASE Uppercase [Respect|Ignore]
Mixed [Respect|Ignore]
determines how alphabetic characters are treated when
entered as data and when used in targets. UPPERCASE causes
all data to be translated to uppercase when entered; MIXED
bypasses this translation. Data is always displayed with
mixed case. RESPECT causes the case of alphabetic
characters to be significant during target searches; IGNORE
causes the difference to be ignored ("a" matches both "a"
and "A"). The default is CASE MIXED RESPECT for LISTING,
MEMO, and SCRIPT files; CASE UPPER RESPECT for all other
filetypes.
| [SET] CMDline On|OFf|Top|Bottom
sets the location of the command line in display mode.
CMDLINE TOP causes the command line and default message line
to share the same space, and messages must be cleared before
| you can enter commands. CMDLINE OFF removes the command
| line. The status are is not displayed with CMDLINE OFF,
| BOTTOM, or TOP. The initial setting is CMDLINE ON.
| [SET] COLOR field [color] [exthi] [High|Nohigh]
| controls color and highlighting used for some areas of the
| screen. Refer to the XEDIT Reference or online HELP for
| details.
[SET] COLPtr ON|OFF
controls marking the column pointer position in typewriter
mode. The column pointer position is marked with an
underscore, and requires that the terminal have a backspace-
and-overstrike capability. The initial setting is COLPTR
ON.
[SET] CTLCHAR OFF
char Escape
| char OFF
| char [Protect] [color] [exthi] [High|Nohigh|Invisible]
Section 2: Command Descriptions 325
CMS Reference
XEDIT
| char [Noprotect] [color] [exthi] [High|Nohigh|Invisible]
defines screen formatting control characters for display
mode. The SET RESERVE subcommand can be used to display
data on the screen using these characters. CTLCHAR is
intended to be used in macros. Refer to the XEDIT Reference
or online HELP for details.
| [SET] CURLine ON [M] [n|+n|-n|]
| specifies the line on a display screen where the current
| line will appear. The current line is highlighted. M
| refers to the middle of the screen; CURLINE ON M is the
| initial setting. CURLINE is allowed only in display mode.
| [SET] DISPlay n [m|*]
| specifies the selection levels of lines to be displayed.
| SET DISPLAY is used in conjunction with SET SELECT, SCOPE,
| and SHADOW. DISPLAY 0 0 is the initial setting. Refer to
| the XEDIT Reference or online HELP for details.
| [SET] ENTer [BEFORE|AFTER|ONLY|IGNORE]|[string|NULLKEY|COPYKEY|TABKEY]
| defines the function of the ENTER key. ENTER IGNORE COMMAND
| CURSOR CMDLINE 1 PRIORITY 30 is the initial setting. Refer
| to the XEDIT Reference or online HELP for details.
[SET] ESCape ON [char]
OFF
defines the input-mode subcommand escape character.
Preceding a line with the escape character in column one
while in input mode will cause the line to be treated as a
command rather than data. This function is not provided in
| display mode. The initial setting is ESCAPE ON + for BATCH,
| JCL, and JOB files, and ESCAPE ON / for other filetypes.
[SET] FILler [char]
defines the character used to expand tab characters. The
initial value is a blank.
[SET] FMode fm
FName fn
FType ft
changes the current fileid. The new fileid is used by the
SAVE and FILE subcommands. A copy of the file already on
disk with the old name is not affected. No warning is given
if a file with the new fileid already exists on disk.
| [SET] FULLread [ON|OFF]
| controls the way nulls are treated on a 3270-type display
| screen. Do not use FULLREAD ON when using the 3270
| Simulator (S3270). FULLREAD OFF is the initial setting.
| Refer to the XEDIT Reference or online HELP for details.
[SET] HEX ON|OFF
Section 2: Command Descriptions 326
CMS Reference
XEDIT
specifies whether subcommand string operands and targets can
be specified in hexadecimal notation. XEDIT will convert
the hexadecimal notation to the equivalent EBCDIC
characters. The initial setting is HEX OFF.
[SET] IMage ON|OFF|Canon
specifies how backspace and tab characters are handled when
entered. IMAGE ON causes backspaces to be interpreted as
corrections (deleting the preceding character from the line)
and tabs to be expanded with the FILLER character. IMAGE
OFF causes both characters to be treated as normal data
characters. IMAGE CANON causes tabs to be unchanged, but
sequences using backspaces will be sorted into canonical
order (the characters in collating sequence separated by
single backspaces). The IMAGE setting affects the operation
of FIND (and FINDUP, NFIND, and NFINDUP), input mode,
OVERLAY, and targets. Use the SET TABS subcommand when
IMAGE ON is in effect to set the columns used for tab
| expansion. The initial setting is IMAGE CANON for SCRIPT
| files, and IMAGE ON for most other filetypes.
[SET] IMPcmscp ON|OFF
controls how entries not recognized as XEDIT subcommands are
handled. IMPCMSCP ON causes unrecognized entries to be
passed to CMS and CP as commands. IMPCMSCP OFF inhibits
this action. The initial setting is IMPCMSCP ON.
| [SET] LASTLorc text
| sets the LASTLORC (Last Locate or Change) buffer. The
| buffer is set by each CHANGE, LOCATE, CLOCATE, and FIND-type
| command. The initial setting is a null string. LASTLORC is
| intended to be used in macros.
[SET] LINENd ON [char]
OFF
defines a logical line end character. The line end
character can be used to separate multiple subcommands
entered on one line, and to mark new lines when entering
data. The initial setting is LINEND ON #.
[SET] LRecl n
changes the current logical record (line) length. The value
cannot exceed the WIDTH option value. For files with
variable-length records, the LRECL is the maximum line
length. For files with fixed-length records, the LRECL is
the length of all lines. Setting an LRECL value less than
the current value may cause the settings of TRUNC and ZONE
to be reduced and can cause truncation of existing data.
The initial setting depends on the filetype.
SET MACRO ON|OFF
Section 2: Command Descriptions 327
CMS Reference
XEDIT
controls the search order for macros and subcommands. MACRO
ON causes macros to be searched for first. MACRO OFF causes
subcommands to be searched for first. The initial setting
is SET MACRO OFF.
[SET] MASK Immed [text]
Define
Modify
sets the initial contents of new lines added to the file.
MASK IMMED sets the mask to the specified text. MASK DEFINE
displays a scale in the command line on which the mask is
entered. MASK MODIFY writes the current mask into the
command line to be modified. The initial setting is a blank
line. DEFINE and MODIFY can be used only in display mode.
| SET MSGLine ON [M[+n|-n]|[+n|-n] [m|1] [Overlay]
| OFF
| defines the location of the message line. The second value
| (m) defines the number of lines used for messages. If
| OVERLAY is specified the message lines are used for data
| until needed for a message. SET MSGLINE ON 2 2 is the
| initial setting.
[SET] MSGMode ON [Short|Long]
OFF
controls the display of XEDIT messages. MSGMODE ON SHORT
suppresses informational (I) and warning (W) messages, and
shortens error (E) messages to the not-sign (¬). MSGMODE ON
LONG displays all of every message. MSGMODE OFF suppresses
the display of all messages. The initial setting is MSGMODE
ON LONG. The CP command SET EMSG controls the format of the
message when MSGMODE ON LONG is in effect.
[SET] NONDisp [char]
specifies the character to be used to represent characters
that cannot be displayed in display mode. Avoid using the
character insert (INS MODE) and delete (DEL) functions of a
3270-type terminal on lines containing non-displayable
characters, since XEDIT will not always be able to determine
| the correct positions of the characters. NONDISP " is the
| initial setting.
[SET] NULls ON|OFF
controls how trailing blanks are represented on a 3270-type
screen. NULLS ON causes the blanks at the end of lines to
be represented as nulls, thus allowing the use of the
character insert function (INS MODE) of the terminal. NULLS
OFF fills lines with blanks, which disables the insert
| function. The PA2 key (or any key set to NULLKEY) sets
NULLS ON for the line containing the cursor. The initial
setting is NULLS OFF.
Section 2: Command Descriptions 328
CMS Reference
XEDIT
[SET] NUMber ON|OFF
controls the display of file line numbers in the prefix
area. NUMBER ON causes the prefix area to contain a five-
digit file line number. NUMBER OFF causes five equal signs
| to be displayed (unless the prefix area has been set to
| NULLS). The initial setting is NUMBER OFF.
| [SET] PAn [BEFORE|AFTER|ONLY|IGNORE]|[string|NULLKEY|COPYKEY|TABKEY]
| defines the function of a PA (Program Attention) key. PA1
| BEFORE COMMAND CP, PA2 BEFORE NULLKEY, and PA3 ONLY ? are
| the initial settings. The setting of the CP break key
| overrides the XEDIT PA settings. Refer to the TERMINAL
| command for details about the break key. Refer to the XEDIT
| Reference or online HELP for more about SET PAn.
[SET] PACK ON|OFF
specifies how the file is written to disk. PACK ON causes
the file to be written in packed format. Packed format is
also used by the CMS commands PACK and UNPACK. PACK OFF
causes the file to be written in normal format. PACK OFF is
the initial setting. Refer to the Usage Notes for more
information.
| [SET] PENDing [ON|BLOCK|ERROR] string
| OFF
| controls the execution of prefix macros and the status
| display. PENDING is intended to be used from macros. Refer
| to the XEDIT Reference or online HELP for details.
| [SET] PFn [BEFORE|AFTER|ONLY|IGNORE]|[string|NULLKEY|COPYKEY|TABKEY]
| defines the function of a PF (Program Function) key. The
| initial settings are listed under Keyboard Functions. Refer
| to the XEDIT Reference or online HELP for details.
[SET] Point .name [OFF]
assigns a name to the current line. This name can then be
used as a target to refer to this line, even if its position
in the file changes. The name must be in the form of a
period followed by from one to eight characters. The OFF
operand removes the name. You must remove a name before it
can be assigned to a new line.
| [SET] PREfix ON [Left|Right]
Nulls [Left|Right]
OFF
Synonym new old
controls the position of the prefix areas, and defines
synonyms for prefix subcommands. PREFIX ON LEFT displays
the prefix areas on the left side of the screen, PREFIX ON
| RIGHT on the right side. PREFIX NULLS fills the prefix
| areas with nulls. PREFIX OFF removes the prefix areas.
Section 2: Command Descriptions 329
CMS Reference
XEDIT
PREFIX SYNONYM is used to define synonyms for existing
prefix subcommands. Prefix subcommand names can be up to
five characters (numbers cannot be used). The initial
| setting is PREFIX ON LEFT.
[SET] RANge target1 target2
defines limits for movement within the file. The top range
(target1) acts as the new top-of-file, the bottom range
(target2) as the end-of-file. Only the SAVE and FILE
subcommands can act outside of the defined range. The
initial range is the entire file, which is equivalent to
RANGE :1 *.
[SET] RECFm V|VP|F|FP
changes the record format of the file. "V" indicates
variable-length records, "VP" indicates packed variable-
length records, "F" indicates fixed-length records, and "FP"
indicates packed fixed-length records. Trailing blanks are
discarded when variable-length records are written to disk,
which saves a great deal of disk space for most files.
Setting RECFM VP or FP will also set PACK ON. The initial
value of RECFM depends on the filetype. Refer to the Usage
Notes for more information about packed files.
| [SET] REMote [ON|OFF]
| controls data transmission to a terminal in display mode.
| REMOTE ON reduces the amount of data transmitted, but
| increases the overhead. Initially, REMOTE ON is set for
| remote terminals, REMOTE OFF for locally attached terminals.
[SET] RESERved [M][+|-]n [color] [exthi] [High|Nohigh] [text]
Off
reserves the specified line on the screen in display mode.
XEDIT will not use reserved lines. The OFF operand returns
the line to XEDIT for its use. Use SET CTLCHAR to define
attribute characters for use on reserved lines. RESERVE is
intended for use in macros, and is allowed only in display
mode. Refer to the XEDIT Reference or online HELP for
details.
| [SET] SCALe ON [n]|[M][+n|-n]
OFF
controls the display of a scale line in display mode. SCALE
ON places the scale under a specified line or the current
| line. SCALE OFF suppresses the scale display. SCALE ON M+1
| is the initial setting. SCALE is allowed only in display
mode
| [SET] SCReen n [Horizontal|Vertical]
| Size s [s...]
| Width w [w...]
| Define ...
Section 2: Command Descriptions 330
CMS Reference
XEDIT
defines the logical screens displayed on the physical
screen. The first form divides the physical screen into "n"
| logical screens of equal size. The screen can be divided
| horizontally or vertically. The screen can be divided into
| unequal parts, and with both horizontal and vertical
| divisions. Refer to the XEDIT Reference or online HELP for
details. The initial setting is one logical screen using
the entire physical screen. SCREEN is allowed only in
display mode.
| [SET] SELect [+|-] [target]
| sets the selection level for the specified lines. SET
| SELECT is used in conjunction with SET DISPLAY, SCOPE, and
| SHADOW. SELECT 0 is the initial setting. Refer to the
| XEDIT Reference or online HELP for details.
[SET] SERial ON [incr|10 [start|10]]
ALL [incr|1000 [start|1000]]
string [incr|10 [start|10]]
OFF
puts sequence numbers in the last columns of each line in
the current file when the file is written to disk with SAVE
or FILE. Only files with fixed-length records can be
serialized. SERIAL ON uses the first three characters of
the filename and five digits to create the serial numbers,
SERIAL ALL uses eight digits, and SERIAL string uses the
string as a prefix and as many digits as will fit in an
eight-character field. The initial setting depends on the
filetype.
| [SET] SHADow [ON|OFF]
| controls the display of shadow lines to indicate lines
| excluded from display. SHADOW ON is the initial setting.
| [SET] SIDcode [string]
| sets the string placed in columns 64 through 71 of update
| lines. The initial setting is blanks unless overridden by
| the SIDCODE option of the XEDIT command.
[SET] SPAN ON [Blank|Noblank [n|*]]
OFF
specifies the number of lines which a string may span and
still match a string target. SPAN OFF requires that a
string be contained within one line. SPAN ON defines the
number of lines that may be concatenated for searching
purposes. The BLANK operand will cause a blank to be
inserted between lines for search purposes. NOBLANK will
concatenate lines with no intervening blank. The initial
setting is SPAN OFF BLANK 2.
| [SET] SPILL [ON|OFF|WORD]
Section 2: Command Descriptions 331
CMS Reference
XEDIT
| controls what happens to characters that would be truncated
| as the result of a CHANGE, CINSERT, SHIFT, and other
| subcommands. ON creates a new line containing spilled
| characters, OFF discards spilled characters, and WORD breaks
| spilled characters at a word boundary (blank). The initial
| setting depends on the filetype.
[SET] STAY ON|OFF
specifies how the current line will be set after a failed
target search or FIND-type subcommand. ON leaves the
current line position unaffected, and OFF causes the top or
end of the file or range to become the current line. The
initial setting is STAY OFF.
[SET] STReam ON|OFF
controls string column target searching. STREAM ON allows
multiple lines to be searched, beginning with the current
line and column pointer. OFF restricts the search to the
current line. The initial setting is STREAM ON.
[SET] SYNonym ON
| OFF
| [LINEND char] syn [n] cmd
| [LINEND char] syn [n [form...] cmd [parms...]]
both controls searching for subcommand synonyms and defines
synonyms. SYNONYM OFF disables synonyms. Refer to the
XEDIT Reference or online HELP for details. The initial
setting is SYNONYM ON.
| [SET] TABLine ON [n]|[M][+n|-n]
OFF
controls the display of a tab ruler in display mode. ON
| places the ruler under a specified line or the current line.
| OFF suppresses the line. TABLINE OFF -3 is the initial
setting. TABLINE is allowed only in display mode
[SET] TABS n [n...]
defines logical tab columns. IMAGE ON must be set for tabs
in the input data to be expanded in the file. The TABKEY PF
key function is also controlled by the tab settings. As
many as 28 tab stops may be specified. The FIND subcommands
are affected by the first tab column. The initial setting
depends on the filetype.
[SET] TERMinal Typewriter
Display
controls the mode in which XEDIT will operate. DISPLAY is
the full-screen mode used by default with 3270-type
terminals. TYPEWRITER is the line mode used on other types
| of terminals. DISPLAY is allowed only on 3270-type
| terminals.
Section 2: Command Descriptions 332
CMS Reference
XEDIT
[SET] TEXT ON|OFF
controls support for the 3270 TEXT character set. The
initial setting is determined by the CP TERMINAL TEXT
command.
[SET] TOFEOF ON|OFF
controls the display of the top and end of file and range
indicators. ON displays the indicators, OFF suppresses the
display. The initial setting is TOFEOF ON.
| [SET] TRANSLat char1 char2 [char1 char2...]
| OFF
| defines an uppercase/lowercase pair of characters. This
| subcommand is provided to support non-English language
| keyboards. The initial setting defines uppercase/lowercase
| pairs of English letters.
[SET] TRUNC n|*
| sets the truncation column. Data entered (or already
| existing) beyond the truncation column will be spilled (see
| SET SPILL). The setting may not exceed the record length
(LRECL). The initial setting is based on the filetype.
[SET] VARblank ON|OFF
specifies whether or not the number of blanks between words
is significant in string target searches. ON ignores the
number of blanks between words, OFF requires that the number
of blanks between words match. The initial setting depends
on the filetype.
[SET] Verify [ON|OFF] [[Hex] start end] ...
controls the display of lines changed by subcommands, and
the manner in which data is displayed in display mode. The
ON and OFF operands control the display of changed lines.
ON displays them, OFF does not. HEX causes all data to be
displayed in hexadecimal rather than the normal graphic
character form. "Start" and "end" are starting and ending
columns that define an area to be displayed. Multiple pairs
of column numbers, optionally preceded by HEX, may be
specified. The same area may be displayed more than once,
and in both graphic and hexadecimal form. The initial
VERIFY settings depend on the terminal type and the
filetype.
[SET] WRap ON|OFF
controls wraparound during target searches. ON causes
searching to wrap around when the top or end of the file or
range is encountered, and stop at the line preceding the
current line (and in some cases the column pointer). OFF
suppresses wraparound. The initial setting is WRAP OFF.
[SET] Zone start end|*
Section 2: Command Descriptions 333
CMS Reference
XEDIT
specifies the starting and ending zone columns. Target
searching and column pointer movement is confined to within
the zone. The end column may not exceed the truncation
| column. The initial setting is from the first tab to the
| truncation column.
SHift Left|Right [cols [target]]
shifts data in the current zone either left or right the
number of columns specified by "cols." Lines are shifted
beginning with the current line and ending before the
| target. Data shifted past the left zone is lost. Data
| shifted past the right zone is spilled (see SET SPILL).
SORT target [A|D] start end ...
sorts lines beginning with the current line and ending
before the target in either ascending (A) or descending (D)
order, based on the contents of the fields described by the
starting and ending column pairs. The total length of the
sort fields cannot exceed 255 characters. If CASE is set to
IGNORE, sorting is alphabetic, with the difference between
uppercase and lowercase letters ignored. Changes made with
| the SORT subcommand are not retained in update mode. SORT
| operates outside of the current SCOPE. SORT is a macro.
SOS operands
provides screen operation simulation that can be used from a
macro or PF key. Refer to the XEDIT Reference or online
HELP for details.
SPELL [word]
checks the spelling of a word. If no word is specified on
the command line, the word beginning at the cursor position
| is used (in display mode). SPELL displays a list of
| alternative spellings. SPELL is a macro and uses the
SPELLCHK command.
SPELLFIX checks the spelling in the current file. The file is first
saved on disk (using SAVE) and then each error detected is
indicated for correction. The SPELLFIX subcommand operates
in the same manner as the CMS command SPELLFIX. SPELLFIX is
a macro, and is allowed only in display mode
SPlit [ALigned] Column
CURSOR
col
[Before|After] /string/
splits a line into two or more lines. COLUMN splits the
current line at the column pointer position. CURSOR splits
the line containing the cursor at the cursor position (only
valid in display mode). The "col" form specifies a column
number at which to split the current line. The /string/
Section 2: Command Descriptions 334
CMS Reference
XEDIT
| form splits the current line either BEFORE or AFTER the
| string. ALIGNED causes created lines to have the same
| number of leading blanks as the original line. See also
| SPLTJOIN. SPLIT is a macro.
| SPLTJOIN splits a line or joins two lines, based on the cursor
| position. SPLTJOIN is a macro
| SSave is a synonym for COMMAND SAVE. See SAVE and PSAVE for more
| information.
STack target [start [length]]
stacks lines beginning with the current line and ending
before the target in first in, first out (FIFO) order. The
starting column and length of the data from each line to be
stacked may be specified. The maximum length is 256
characters. STACK is intended for use in macros.
STATus [filename]
displays some SET subcommand settings, or creates a macro
named "filename" that will contain the SET subcommands and
| their values. Not all settings are included.
TOP makes a null line preceding the first data line in the file
(or range) the current line. TOP does not alter the column
pointer position.
TRAnsfer keyword...
| is used within a macro to stack the values of specified
| XEDIT variables. EXTRACT should be used instead of TRANSFER
| for new applications. Refer to the XEDIT Reference or
| online HELP for details.
Type [target|1]
displays data lines beginning with the current line and
ending before the target line. The format of the data is
determined by the SET VERIFY subcommand. The last line
| displayed becomes the current line. Typed output is limited
| to 160 columns.
Up [n|*|1]
advances the current line "n" lines toward the top of the
file.
UPPercas [target|1]
converts lowercase to uppercase beginning with the current
line and ending before the target line. The last line
converted becomes the current line.
Xedit [fn|= [ft|= [fm|=]]] [(options...[)]]
Section 2: Command Descriptions 335
CMS Reference
XEDIT
begins editing for another file, or resumes editing a file
already in storage. If a fileid is specified, a file not
being edited is added to a ring of files in storage. In any
case, editing switches to the new file. If no fileid is
specified on the XEDIT subcommand, the next file in the ring
is edited. The FILE and QUIT subcommands remove the current
file from the ring and editing resumes with the preceding
file (if any). The SET SCREEN subcommand can be used on a
3270-type terminal to allow several files to be viewed
simultaneously on the screen, or to view several parts of a
single file. The options are the same as those of the XEDIT
CMS command. Care must be taken when using this subcommand,
because issuing the CMS XEDIT command causes XEDIT to be
entered recursively and create a new file ring. The number
of files currently being edited is displayed in the status
area in display mode, or may be obtained with the QUERY
NBFILE subcommand.
| Prefix Subcommands and Macros (For Display Mode Only)
| [n]< or <[n] or [n]<< or <<[n]
| shifts the data on the indicated lines left one or more
| columns.
| [n]> or >[n] or [n]>> or >>[n]
| shifts the data on the indicated lines right one or more
| columns.
[n]/ or /[n]
marks the line to become the next current line. The column
pointer may be set by specifying "n".
[n]" or "[n] or [n]"" or ""[n]
marks a line or block of lines to be duplicated. Specifying
"n" will cause the lines to be duplicated "n" times. "" is
used to mark the first and last lines of a block of lines to
be duplicated.
.name assigns a name to a line. The name can later be used as a
target. This function is identical to the SET POINT
subcommand, except that the name is limited to four
characters and replaces an existing name.
[n]A or A[n]
marks the line after which one or more new lines are to be
added.
[n]C or C[n] or CC
marks one or more lines to be copied. Specifying "n" will
cause "n" lines to be copied. CC is used to mark the first
Section 2: Command Descriptions 336
CMS Reference
XEDIT
and last lines of a block of lines to be copied. The
destination line is marked with the F (following) or P
(preceding) prefix subcommand.
[n]D or D[n] or DD
marks one or more lines to be deleted. Specifying "n" will
cause "n" lines to be deleted. DD is used to mark the first
and last lines of a block of lines to be deleted.
| E extends a logical line by one additional screen line. You
| cannot extend a line on a vertically-split screen.
Extension is limited by the SET VERIFY subcommand.
F marks the destination for a copy or move prefix subcommand.
The new lines follow the line marked.
[n]I or I[n]
inserts new lines into the file. The I prefix subcommand
has the same function as the A prefix subcommand.
[n]M or M[n] or MM
marks one or more lines to be moved. Specifying "n" will
cause "n" lines to be moved. MM is used to mark the first
and last lines of a block of lines to be moved. The
destination line is marked with the F (following) or P
(preceding) prefix subcommand. The original lines are
deleted.
P marks the destination for a copy or move prefix subcommand.
The new lines precede the line marked.
| [n]S or S[n]
| (show) causes the specified lines to be displayed after
| having been excluded by the X prefix macro, ALL macro, SET
| DISPLAY subcommand, or SET SELECT subcommand. The S prefix
| macro can only be used in the prefix area of a shadow line.
SCALE causes the scale line to be displayed on the marked line.
TABL causes the tab line to be displayed on the marked line.
| [n]X or X[n] or XX
| excludes the indicated lines from the display and the scope
| of editing subcommands.
The XEDIT Profile
When the XEDIT command (or subcommand) is executed, it will cause an
XEDIT macro named "PROFILE" to be executed (if one exists). You may
supply an alternate name for the profile with the XEDIT option
Section 2: Command Descriptions 337
CMS Reference
XEDIT
| PROFILE. The filetype must always be "XEDIT" (this is true of all
| XEDIT macros). The profile macro may contain REXX or EXEC 2
statements, CP commands, CMS commands and EXECs, and XEDIT subcommands
and macros. These statements and commands can be used to tailor the
XEDIT environment to your requirements. For example, Program Function
keys can be defined, the screen layout altered, the file format set,
and so on.
The arguments passed to the profile macro are the arguments that were
specified on the XEDIT command or subcommand. Additional operands
(including the fileid) and options may be specified by the profile
with the LOAD subcommand. The LOAD subcommand must be the first XEDIT
subcommand issued by the profile.
The following example demonstrates what sort of things might be placed
in a "PROFILE XEDIT:"
| /* Sample XEDIT Profile */
| address command "MAKEBUF"
| /* Default filetype will be SCRIPT */
| arg fn ft fm . "(" options
| if ft="" then ft = "SCRIPT"
| /* Load the file (and exit in case of error) */
| address xedit
| "COMMAND LOAD" fn ft fm
| if rc¬=0 then exit rc
| /* Common Setup */
| "COMMAND SET AUTOSAVE 25"
| "COMMAND SET CASE MIXED IGNORE"
| "COMMAND SET ESCAPE OFF"
| "COMMAND SET IMAGE ON"
| "COMMAND SET RECFM V"
| "COMMAND SET SPAN ON BLANK 2"
| "COMMAND SET STAY ON"
| "COMMAND SET VARBLANK ON"
| "COMMAND SET VERIFY OFF 1 *"
| "COMMAND SET WRAP ON"
| /* Determine what sort of terminal we are using.
| If it's not a 3270, exit now. */
| "COMMAND EXTRACT/TERMINAL/"
| if terminal.1¬="DISPLAY" then exit
| /* Additional setup for 3270-type terminals. */
Section 2: Command Descriptions 338
CMS Reference
XEDIT
| "COMMAND SET CURLINE ON 2"
| "COMMAND SET MSGLINE ON 2 15 OVERLAY"
| "COMMAND SET PF1 SPELL"
| "COMMAND SET PF4 SPLTJOIN"
| "COMMAND SET PF10 ?"
| "COMMAND SET PF11 SOS TABB"
| "COMMAND SET PF12 TABKEY"
| "COMMAND SET NULLS ON"
| "COMMAND SET NUMBER ON"
| "COMMAND SET PREFIX ON RIGHT"
| "COMMAND SET SCALE OFF"
This file is available as "SAMPLE XEDIT Y2" for use as a base for your
own profile.
Usage Notes
1. The XEDIT SET AUTOSAVE subcommand provides an automatic
checkpoint to ease recovery in case of system failure during an
edit session. The facility is enabled with the XEDIT "SET
AUTOSAVE n" command. The value "n" specifies how often a
checkpoint should be taken. When the specified number of lines
have been added, changed, or deleted, a SAVE subcommand will be
| issued to write the AUTOSAVE file. AUTOSAVE files are named
| "rrrnnnnn AUTOSAVE," where "rrr" is the number of times XEDIT was
| called recursively and "nnnnn" is the current AUTOSAVE number.
| These numbers begin with 100001 and are incremented when multiple
files are edited, or if an AUTOSAVE file already exists on your
disk. The AUTOSAVE files are automatically erased when you issue
a FILE or SAVE subcommand, but not if you QUIT, so you may want
to eliminate these files with the CMS command ERASE.
If the system should fail during a session, the most recent copy
| of the file being edited will be the file named "rrrnnnnn
| AUTOSAVE". You may edit this file to determine if it contains
information that you want; if it does, you can replace the older
version of the file with the AUTOSAVE file by erasing the
original file and renaming the AUTOSAVE file. This can also be
used to recover from erroneous global changes made to a file.
Immediately QUIT, erase the original file, and rename the
AUTOSAVE file.
Most users will find that setting AUTOSAVE to 20 or 30 will
provide sufficient protection against loss of data. This can be
done automatically at the beginning of each session in an XEDIT
profile.
2. XEDIT can directly manipulate files that are in packed format.
Packed files are kept on disk in a special compressed format that
Section 2: Command Descriptions 339
CMS Reference
XEDIT
generally requires much less disk space than files in normal
format. Files may be converted to this format with the CMS PACK
command, or with XEDIT by specifying SET PACK ON or SET RECFM VP
or FP. Files can be restored to normal format with the CMS
UNPACK command, or with XEDIT by specifying SET PACK OFF or SET
RECFM V or F. Packed files cannot be processed by most CMS
commands (like SCRIPT, PRINT, SUBMIT, etc.). Only XEDIT should
be used to modify a packed file. Modifying a packed file
improperly will make it impossible to unpack the file or recover
the data. Refer to the description of the CMS PACK command for
more information.
3. Remember that a 3270-type terminal is a buffered device; data is
only read after ENTER or a PF key is pressed. This allows a
great deal of data to be entered or changed on a screen without
any interaction with the computing system, which is especially
desirable during periods of heavy system load. However, since
data is not read until one of these keys is pressed, pressing the
CLEAR or ERASE INPUT keys will destroy any new data on the
screen.
4. Since XEDIT controls a 3270-type terminal's screen and PF keys
while it is operating, normal system messages cannot be
displayed. When the system has a message waiting to display on
your terminal, it will wait until an interrupt-producing key
(such as ENTER) is pressed to display the message. After you
have read the message, press the CLEAR key once to return to
XEDIT. Pressing any other key or pressing CLEAR more than once
may cause data on the screen to be lost. Warning messages from
the system operator will cause the screen to be cleared
immediately.
| 5. Refer to the Appendix "XEDIT Default Filetype Attributes" for the
| default values of RECFM, WIDTH, LRECL, TRUNC, SPILL, CASE,
| SERIAL, and TABS.
6. XEDIT may be used to examine an OS disk data set. The data set
cannot be modified, but it can be saved as a CMS disk file, with
or without modifications. To edit an OS data set you must first
access the OS disk volumes and then define a name to be used by
XEDIT to refer to the file. The following commands could be
used:
OSDISKS
FILEDEF SYSIN DISK filename filetype H DSN data set name (options
XEDIT filename filetype H
The OSXEDIT command simplifies this process.
7. XEDIT has a feature that allows you to create your own XEDIT
subcommands by combining existing commands and subcommands into
Section 2: Command Descriptions 340
CMS Reference
XEDIT
XEDIT macros. A macro is a file with a filetype of "XEDIT" and
| is very similar to an EXEC (REXX and EXEC 2 are used by XEDIT to
| process macros). Refer to the VM/SP System Product Editor User's
Guide, the VM/SP System Product Editor Command and Macro
| Reference, the VM/SP System Product Interpreter Reference, and
| the VM/SP EXEC 2 Reference for more information.
Messages and Return Codes
XEDIT subcommands use the following return codes (to be checked in
XEDIT macros):
0 Normal.
1 Error. Meaning depends on subcommand.
2 Target not found.
3 Operand is valid only in display mode, or other error.
4 Error. Meaning depends on subcommand.
5 Missing or invalid operand.
| 6 Rejected in profile due to LOAD error, or QUIT subcommand
| issued in macro called from last file being edited.
7 Error building update file.
8 Pending or incomplete prefix subcommand.
12 Disk is read-only.
13 Disk is full.
20 Invalid character in fileid.
24 Invalid filemode, or invalid parameter.
28 File not found.
32 Error during update.
36 Disk not accessed.
88 File too large to fit in storage.
100 Error writing file to disk.
104 No storage available.
Details on return codes and messages may be found in the VM/SP System
Product Editor Command and Macro Reference and VM/SP System Messages
and Codes.
Section 2: Command Descriptions 341
CMS Reference
XMENU
| Use XMENU to create and modify panel definitions for use with the
| MENUEXEC command and programs using XMENU functions. XMENU can only
be used with 3270-type display terminals.
+--------------------------------------------------------------------+
| | + + |
| XMENU | |menuname| [( options... [)]] |
| | |? | |
| | + + |
| | |
| | Options: |
| | |
| | [LIB library] [USING menu] [ULIB library] |
| | [EXT] [ALT] [SIZE n] |
| | [CHAR c1 c2] [SKIP] [MDT] |
| | [ALARM] [NOALARM] [UPCASE] |
| | [MENTEXT] [TEXT] [DSECT] |
| | [NAME] [AUTONAME] [TRUNC] |
| | [FNUM n] [FNAME name] [FGROUP n1 n2] |
| | |
+--------------------------------------------------------------------+
where
menuname is the filename of the panel to be created or modified. The
filetype will always be "MENU". Refer to the Usage Notes
for more information about the files used by XMENU. If no
name is specified the XMENU option menu is displayed.
? displays online HELP information for XMENU.
Usage Notes
1. XMENU creates or modifies a file named "menuname MENU."
Specifying the TEXT or MENTEXT option causes a TEXT file to be
generated. Specifying DSECT or MENTEXT causes a COPY file
containing a DSECT description of the menu to be generated.
2. Use the MENUEXEC command to display a panel defined with XMENU
from an EXEC.
3. Use the XMENULIB command to create and maintain XMENULIB
libraries.
| 4. Refer to XMENU and DMSCVT User's Guide and XMENU Subroutine
| Library User Reference and online HELP for more information.
Section 2: Command Descriptions 342
CMS Reference
XMENULIB
Use the XMENULIB command to create and maintain XMENU menu libraries.
+--------------------------------------------------------------------+
| | + + |
| | | + + | |
| XMENULIB | | |GEN | | |
| | | |ADD | library menuname [menuname...] | |
| | | |REP | | |
| | | |EXTRACT| | |
| | | + + | |
| | | | |
| | | DEL library membername [membername...] | |
| | | | |
| | | MAP library [( option [)]] | |
| | + + |
| | |
| | Options: |
| | |
| | + + |
| | |DISK | |
| | |PRINT| |
| | |TERM | |
| | + + |
+--------------------------------------------------------------------+
Usage Notes
1. Use the XMENU command to create and modify menu definitions.
XMENU can read a menu from a menu library, but only the XMENULIB
command can update the contents of the library.
| 2. Refer to XMENU and DMSCVT User's Guide and XMENU Subroutine
| Library User Reference for more information.
Section 2: Command Descriptions 343
CMS Reference
| YCALC (EXEC)
YCALC is a spreadsheet calculator much like the personal computer
"CALC" programs. YCALC uses a matrix of cells to hold values,
formulas, and labels to organize financial or other data that use
tables of information. Worksheets may be saved and reloaded later
when you wish to work on the same worksheet again.
+--------------------------------------------------------------------+
| | |
| YCALC | [filename [filemode]] |
| | |
+--------------------------------------------------------------------+
where
filename is the name of a YCALC worksheet file. If no filename is
specified an empty worksheet will be used. The filetype of
worksheet files is "YCALC."
filemode is the filemode of the worksheet file. The default is "*"
which will search all accessed disks.
Usage Notes
1. YCALC will not operate in a virtual machine smaller than 800K.
You can use the STORAGE command to define a larger virtual
machine size.
2. You can enter "HELP YCALC TOPICS" for more information. Within
YCALC (when a worksheet is displayed on the screen), you may use
the /H command to get additional information. A YCALC manual is
available from the MANUAL command.
Section 2: Command Descriptions 344
CMS Reference
Section 3: Command Return Codes
Commands issued under CMS set a return code to indicate success or
failure. The return code is displayed in the CMS ready message unless
it is zero, and may be tested in an EXEC. This section describes some
codes used by CMS and CMS commands. The return codes set by XEDIT
subcommands are documented elsewhere in this manual under the XEDIT
command.
A non-zero return code is usually set by a command to indicate an
error or unusual condition. Some commands (like MAKEBUF and RANDOM)
return a result as a return code. If the command was entered from the
| terminal, the return code is displayed in the CMS ready message. In
| REXX this sets the RC variable, in EXEC 2 it sets &RC and &RETCODE,
| and in EXEC it sets &RETCODE. If you explicitly set these variables
| in EXEC 2 or EXEC they will no longer have this special function. You
may set the return code to any desired value with the RETCODE command.
CP commands issued through CMS set a return code that is the message
number of the CP message issued. A special code of -1 indicates that
no CP command with the specified name exists.
Some CMS commands set a return code that indicates the general class
of the error. Generally an error message is issued when a non-zero
return code is set. The following return code values are used by many
CMS commands:
-5 Wrong environment. (valid characters are
-4 LOADMOD (module load) failed. uppercase and lowercase
-3 No CMS command with this name letters, numbers, $, @, and
was found. #).
-2 The CMS command could not be 24 Invalid or missing parameter
issued from CMS subset mode. or option.
-1 No CP command with this name 28 Error accessing or
was found. manipulating a file. Usually
1 Requested item or record not means file not found.
found. 32 Error in input file.
4 Not enough information was 36 Device error. Usually means
supplied, or a non-fatal disk not accessed.
error (warning) condition 40 Error during processing.
occurred. 41 Insufficient storage to
8 A device warning condition execute the command.
occurred, or the command 88 Command could not execute
completed but the output may because of a restriction.
not be correct. 100 Device error.
12 Errors in the input file. 101 Userid not available.
16 Serious errors in the input 104 System error.
file. 256 Serious system error.
20 Invalid character in a fileid
Section 3: Command Return Codes 345
CMS Reference
Section 4: Communicating With Asynchronous ASCII Terminals
Asynchronous ASCII terminals may communicate with the VM/SP system at
the UKCC through individual switched telephone lines, through short
direct cables (over limited distances), or as part of a cluster
sharing a single multiplexed communication line.
There are hundreds of kinds of ASCII terminals, but they can be
divided into two general types: typewriter (printing) terminals and
display terminals. VM/SP treats all ASCII terminals as typewriter
terminals unless they are connected through S3270, the 3270 simulator.
A number of kinds of ASCII terminals are supported by S3270.
Personal computers and other systems with appropriate software can be
| used as terminals with VM/SP, and some can be used with S3270. The
| UKCC also provides KERMIT, HOSTCM, and FSEND to exchange files with a
personal computer or other system connected as an ASCII terminal.
4.A Asynchronous Protocols
All asynchronous ASCII terminals must use the following protocol to
communicate with VM/SP:
Line Speed Data Stop
(Baud) Parity Bits Bits
| 110 Even 7 2
| 300 Even 7 1
1200 Even 7 1
VM/SP always transmits with even parity, but accepts both even or mark
parity. Control characters handled by the terminal control hardware
(such as Carriage Return) will not be recognized unless they have even
parity.
VM/SP always uses half-duplex, so your terminal should be set to half-
duplex mode. Some terminals will not transmit control characters to
the host system when in half-duplex, and it may be necessary to
operate such terminals in duplex mode with a special connector or a
modem that will provide local character echo.
Since VM/SP uses EBCDIC internally, all data to and from ASCII
terminals must be translated. Most users need not be aware of this
process, but it can cause problems a few special cases. EBCDIC is an
eight-bit code, so it has 256 unique characters. ASCII is usually a
seven-bit code, so it only has 128 unique characters. Furthermore,
Section 4: Communicating With Asynchronous ASCII Terminals 346
CMS Reference
each code has some characters that are not found in the other. The
most common characters (letters, digits, simple punctuation) appear in
both codes, so they don't present a translation problem. However, a
number of control and special graphic characters cannot be correctly
translated from one code to the other. An Appendix in this manual
describes in detail the translations performed by VM/SP.
All communication with asynchronous terminals is controlled by
terminal control units (TCU) at the UKCC. A CR (Carriage Return)
entered from an ASCII terminal is treated as an end-of-input signal by
the TCU. The ACK, CAN, ENQ, and EOT characters also act as end-of-
input signals, but should not normally used as such. Ending a line
with any character other than CR will usually cause the entire line to
be ignored. No data will be read following an end-of-input character
until after the next prompt is issued by VM/SP.
| DEL characters from an ASCII terminal are removed by the TCU and are
| not passed to VM/SP as data. NUL characters from an ASCII terminal
may be deleted or translated to another character under the control of
the TERMINAL NULLS command. CMS uses NUL to indicate the end of the
data on an input line; the NUL and any following characters are
ignored.
The BREAK key found on most ASCII terminals does not transmit a
character, but rather causes a special condition on the communication
line which is recognized by the TCU and VM/SP as an attention request.
To cause a break, a SPACE condition (not a SPACE character!) must be
placed on the line for at least 200 milliseconds.
4.B ASCII Typewriter Mode
When operating in typewriter mode (not using S3270), VM/SP sends a
prompt sequence to an asynchronous ASCII terminal before issuing a
read command. The form of this prompt sequence is:
General Form: CR LF xoff prompt xon
Initial Setting: CR LF . DC1
where:
CR Carriage Return
LF Line Feed
DC1 Device Control 1 (also called XON)
DC3 Device Control 3 (also called XOFF)
prompt The PROMPT character (initially ".")
xon XON character (DC1)
xoff XOFF character (DC3)
Section 4: Communicating With Asynchronous ASCII Terminals 347
CMS Reference
The XOFF, XON, and PROMPT parameters of the TERMINAL command can be
used to modify this sequence.
When the TCU senses an end-of-input character (usually CR) the read
operation is completed and VM/SP will quickly respond with the
following sequence:
CR LF xoff
where "xoff" is an optional XOFF (DC3) character. This sequence may
be suppressed by specifying TERMINAL BURST OFF.
Each output line sent to an ASCII terminal is followed by the
sequence:
CR LF xoff pad
where "pad" indicates one or more rubout (DEL) or idle characters.
The initial setting is two rubouts. This is controlled with the
TERMINAL RUBS and TERMINAL IDLES commands. The CR and LF can be
suppressed for some lines with the TERMINAL AUTOCR command.
VM/SP provides a simple block-oriented protocol (sometimes called
ETX/ACK protocol) intended for use with buffered printing terminals
operating at 1200 baud. Since few letter-quality printing mechanisms
can operate at 120 characters/second some terminals provide buffers
that can be filled at 1200 baud and keep the printing mechanism
operating at its top speed. To use this feature specify:
TERMINAL PROTOCOL 1 n
where "n" is the size of the terminal's buffer (up to 32768 bytes).
VM/SP sends a block of data (possibly as large as the buffer) ending
with an ETX character. When the terminal is ready for more data it
must send a character (usually ACK) to VM/SP. The Anderson Jacobson
model 833 terminal supports this protocol and the AJ833 command is
available for starting and stopping this mode of operation.
4.C ASCII Display Mode Using S3270
S3270 is a facility that provides most of the functions of a 3270-type
display terminal on an ASCII display terminal. Software simulation in
combination with the functions provided by the terminal hardware allow
many ASCII display terminals to be used in a full-screen mode with
XEDIT, BROWSE, RBROWSE, FLIST and other CMS commands. There is a
connection surcharge for this service to pay for the system overhead
caused by the software simulation.
Section 4: Communicating With Asynchronous ASCII Terminals 348
CMS Reference
No ASCII terminal can support all 3270 functions, and support for
various brands and models must differ to allow for different keyboard
arrangements and control mechanisms.
To use S3270, first connect to VM/SP in the usual manner. Once you
have established a connection you will receive the message:
VM/370 ONLINE
Then, instead of logging on, enter the command:
dial s3270
The normal response from the system is:
CONNECTED TO S3270 nnn
ENTER YOUR TERMINAL TYPE OR "?":
You may type a question mark and press the RETURN key for a list of
supported terminal types and their corresponding numbers. Enter the
number that corresponds to the type of terminal you are using and
press the RETURN key. Your screen will then be cleared and the VM/370
logo displayed. You may then log on as if you were using a 3270-type
terminal.
When you are ready to end your terminal session be sure to LOGOFF or
DISCONNECT before turning off or leaving your terminal. Failure to
follow this procedure can cause your userid to become "stuck" at that
terminal, preventing you from logging on again.
A number of kinds of ASCII terminals are supported by S3270, including
models made by DEC, IBM, Lear Siegler, and TeleVideo. Support is also
available for the IBM Personal Computer and Commodore SuperPET. Other
brands and models that are compatible with one of these terminals may
also work. If your terminal is not listed on the S3270 menu contact a
UKCC consultant for more information.
While you are using S3270 several keys on your keyboard have special
meanings. All ASCII terminals use the RETURN key in place of the 3270
ENTER key. The 3270 New Line key (crooked arrow) is simulated by
pressing ESC followed by RETURN. The ERASE INPUT function is
simulated by pressing the BREAK key twice. Almost all ASCII terminals
have cursor movement keys that correspond to the 3270 cursor keys.
The PF and PA keys and the forward and backward field tab keys of the
3270 are simulated in various ways on different ASCII terminals
(online HELP is available for each terminal type). Not all ASCII
terminals provide all of these functions.
Most ASCII terminals do not support protected and highlighted fields
in a manner compatible with the 3270, so you may type in areas of the
screen that would ordinarily be protected. S3270 will detect this,
discard the invalid data, and rewrite the entire screen.
Section 4: Communicating With Asynchronous ASCII Terminals 349
CMS Reference
S3270 attempts to minimize transmission time by rewriting only the
changed portions of the screen when possible. If your screen becomes
garbled because of transmission errors or other problems the entire
current buffer can be displayed by pressing the CLEAR key on your
keyboard, typing RESHOW (in uppercase), and pressing RETURN. S3270
also provides two special commands: #### and ##BACK. Entering "####"
causes your terminal to be immediately disconnected. Entering
"##BACK" redisplays the previous screen buffer. (Note that you must
then use CLEAR-RESHOW to return to the current buffer.)
Remember that all communication with VM/SP is in half-duplex mode.
This means that you must not type when the system is updating your
screen, and the system cannot update your screen while you are typing.
Violation of this rule will cause some loss of data, either your
input, the output from the system, or both. Usually CLEAR/RESHOW will
recover at least some of the lost data. Using S3270 is not exactly
like using a real 3270, and each kind of ASCII terminal has its own
set of idiosyncrasies, but with experience you can become acclimated
to the imperfections and acquire a feel for the use of the facility.
| Do not use the XEDIT FULLREAD ON feature with S3270. S3270 does not
| simulate the function used by this feature, and when FULLREAD is ON
| XEDIT and VM/SP ignore your keyboard. Use the #### command to
| disconnect if you get into this state.
4.D Exchanging Files With Personal Computers
Several methods can be used to exchange data with a personal computer
(or any other computer system) that can act as an asynchronous ASCII
terminal. The simplest method is to use XEDIT to copy data from the
other system into a CMS disk file. A program on the other system must
issue the XEDIT command, the INPUT subcommand, transmit each line of
data, transmit an empty line (just a CR) to indicate the end of the
data, and issue the FILE subcommand. The FSEND command is available
to transmit a CMS disk file to a personal computer, one line at time.
The personal computer software must wait for prompts from VM/SP and
end each of its data lines with a Carriage Return (CR). VM/SP
performs no error checking during this process, so characters garbled
by line noise or other errors will not be detected.
| A more elaborate mechanism is provided by KERMIT (KL10 Error-free
| Reciprocal Micro Interface Transfer). This requires a program running
| under CMS (the KERMIT command) and a version of KERMIT running on the
| other system. KERMIT provides two-way file transmission and provides
| error checking and automatic retransmission in case of error. KERMIT
| is available without charge for the IBM Personal Computer and a number
| of other systems. More information is available from UKCC consultants
| and online from the MANUAL command.
Section 4: Communicating With Asynchronous ASCII Terminals 350
CMS Reference
Another method is provided by the Waterloo Computing Systems
microSoftware packages and the HOSTCM command. These allow programs
running on the other system to read and write CMS disk files directly
and provide error checking and automatic retransmission in case of
error. You must purchase the microSoftware from Waterloo Computing
Systems for your system. The IBM Personal Computer, the Commodore
SuperPET, and the Northern Digital microWAT are currently supported.
You could also write your own software to use with HOSTCM. Detailed
specifications for HOSTCM are available online from the MANUAL
command.
Section 4: Communicating With Asynchronous ASCII Terminals 351
CMS Reference
APPENDIX A: XEDIT Default Filetype Attributes
Use the XEDIT profile to alter these settings. Note: The "Format"
column lists the RECFM and WIDTH; the LRECL defaults to the WIDTH.
+--------------------------------------------------------------------+
|Filetype|Format|TRUNC|SPILL|CASE|SERIAL|SET TABS Columns |
|--------|------|-----|-----|----|------|----------------------------|
| |$EXEC | F 80 | 72 | OFF | U R| ON |2 5 10 15 20 25 30 35 |
| |$XEDIT | F 80 | 72 | OFF | U R| ON |2 5 10 15 20 25 30 35 |
|AMSERV | F 80 | 72 | OFF | U R| ON |2 5 10 15 20 25 30 35 |
| | | | | | |40 45 50 55 60 |
|ASM3705 | F 80 | 72 | OFF | U R| ON |1 10 16 30 35 40 45 50 |
| | | | | | |55 60 65 70 |
|ASSEMBLE| F 80 | 72 | OFF | U R| ON |1 10 16 30 35 40 45 50 |
| | | | | | |55 60 64 72 |
|BASDATA | F 80 | 80 | OFF | U R| OFF |see BASIC |
|BASIC | F 80 | 80 | OFF | U R| OFF |7 10 15 20 25 30 80 |
| |BATCH | V 80 | 72 | OFF | U R| OFF |see DIRECT |
|CNTRL | F 80 | 80 | OFF | U R| OFF |1 5 8 17 27 31 |
|COBOL | F 80 | 72 | OFF | U R| ON |1 8 12 20 28 36 44 68 |
| | | | | | |72 80 |
|COPY | F 80 | 72 | OFF | U R| ON |see ASSEMBLE |
|DIRECT | F 80 | 72 | OFF | U R| ON |1 5 10 15 20 25 30 35 |
| | | | | | |40 45 50 55 60 65 70 |
|ESERV | F 80 | 71 | OFF | U R| ON |see AMSERV |
|EXEC | V 80 | 80 | OFF | U R| OFF |1 5 10 15 20 25 30 35 |
| | | | | | |40 45 50 55 60 65 70 |
|FORTRAN | F 80 | 72 | OFF | U R| ON |1 7 10 15 20 25 30 80 |
|FREEFORT| V 81 | 81 | OFF | U R| OFF |9 15 18 23 28 33 38 81 |
|JCL | V 80 | 80 | OFF | U R| OFF |1 3 12 16 18 72 80 |
|JOB | V 80 | 80 | OFF | U R| OFF |see JCL |
|LISTING | V 121| 121 | OFF | M R| OFF |1 5 10 15 20 25 30 35 |
| | | | | | |40 45 50 55 60 65 70 |
| | | | | | |75 80 85 90 95 100 105 |
| | | | | | |110 115 120 |
|MACLIB | F 80 | 72 | OFF | U R| ON |see ASSEMBLE |
|MACRO | F 80 | 72 | OFF | U R| ON |see ASSEMBLE |
| |MEMO | V 80 | 80 | WORD| M R| OFF |see LISTING |
| |MODULE | V 80 | 80 | WORD| M R| OFF |see LISTING |
| |NAMES | V 255| 255 | OFF | M R| OFF |see LISTING |
| |NETLOG | V 255| 255 | OFF | M R| OFF |see LISTING |
| |NOTE | V 132| 132 | WORD| M R| OFF |see LISTING |
| |NOTEBOOK| V 132| 132 | WORD| M R| OFF |see LISTING |
| |PASCAL | V 72 | 72 | OFF | U R| OFF |see DIRECT |
|PLI | F 80 | 72 | OFF | U R| ON |2 4 7 10 13 16 19 22 25 |
| | | | | | |31 37 43 49 55 79 80 |
|PLIOPT | F 80 | 72 | OFF | U R| ON |see PLI |
+--------------------------------------------------------------------+
Appendix A: XEDIT Default Filetype Attributes 352
CMS Reference
+--------------------------------------------------------------------+
|Filetype|Format|TRUNC|SPILL|CASE|SERIAL|SET TABS Columns |
|--------|------|-----|-----|----|------|----------------------------|
| |SAS | F 80 | 80 | OFF | M R| OFF |see DIRECT |
|SCRIPT | V 80 | 80 | WORD| M R| OFF |see LISTING |
|SYNONYM | F 80 | 80 | OFF | U R| OFF |see CNTRL |
| |TEXT | F 80 | 80 | OFF | U R| OFF |see CNTRL |
|UPDATE | F 80 | 72 | OFF | U R| ON |see ASSEMBLE |
|UPDT | F 80 | 72 | OFF | U R| ON |see ASSEMBLE |
|VSBASIC | F 80 | 80 | OFF | U R| OFF |see BASIC |
|VSBDATA | V 132| 132 | OFF | U R| OFF |see LISTING |
| |WATFIV | F 80 | 80 | OFF | U R| OFF |see FORTRAN |
|WBASIC | V 80 | 80 | OFF | U R| OFF |see BASIC |
|XEDIT | V 80 | 80 | OFF | U R| OFF |see EXEC |
|other | V 80 | 80 | OFF | U R| OFF |see LISTING |
+--------------------------------------------------------------------+
Appendix A: XEDIT Default Filetype Attributes 353
CMS Reference
APPENDIX B: Character Translation for ASCII Communication
The tables on the following pages describe the translations performed
on data sent to or received from an ASCII terminal. Data (such as
data in a CMS disk file) is generally represented as EBCDIC characters
within VM/SP and must be translated to ASCII when sent to an ASCII
terminal. Conversely, input data from an ASCII terminal must be
translated to EBCDIC. These translations are performed automatically
by the VM/SP Control Program, and users do not generally need to be
aware of the process. However, users with special requirements may
need this information.
The input translations described are performed before any CMS SET
INPUT translations; the output translations described are performed
after any CMS SET OUTPUT or CMS CASE translations. The translations
for the APL character set support are not shown here. ASCII input is
accepted with even or mark parity; all output will be even parity.
Each character is given both by its graphic representation and
hexadecimal value. The following special names are used in the tables
for control characters and some special characters:
acc Accent ENQ Enquiry RES Restore
ACK Acknowledge EOT End Transmission RLF Reverse LF
bar Broken Vertical Bar ESC Escape RS Record Separator
BEL Bell (Alarm) ETB End Trans. Block SI Shift In
BS Back Space ETX End Text SM Set Mode
bsl Back-Slash FF Form Feed SMM Start Manual Msg
BYP Bypass FS File Separator SO Shift Out
CAN Cancel GE Graphic Escape SOH Start of Header
car Caret or Up-Arrow GS Group Separator SOS Start Signature
CC Cursor Control HT Horizontal Tab SP Space or Blank
CR Carriage Return IFS Int. Field Sep. STX Start of Text
CU1 Customer Use 1 IGS Int. Group Sep. SUB Substitute
CU2 Customer Use 2 IL Idle SYN Synchronous Idle
CU3 Customer Use 3 IRS Int. Record Sep. til Tilde
DC1 Device Control 1 IUS Int. Unit Sep. TM Tape Mark
DC2 Device Control 2 LC Lower Case UC Uppercase
DC3 Device Control 3 LF Line Feed US Unit Separator
DC4 Device Control 4 NAK Negative Ack. VT Vertical Tab
DEL Delete NL New Line XOF Punch Off (DC3)
DLE Data Link Escape NUL Null XON Punch On (DC1)
DS Digit Select PF Punch Off
EM End of Medium PN Punch On
Not all ASCII terminals will perform the functions indicated by all
control characters. Refer to the section on Asynchronous ASCII
Terminals for a description of the control characters used by VM/SP.
Appendix B: Character Translation for ASCII Communication 354
CMS Reference
Input Translation
+-------------+ +-------------+ +-------------+ +-------------+
|ASCII | | |ASCII | | |ASCII | | |ASCII | |
| Input|EBCDIC| | Input|EBCDIC| | Input|EBCDIC| | Input|EBCDIC|
|------|------| |------|------| |------|------| |------|------|
|NUL©00|NUL 00| |SP 20|SP 40| | @ 40| @ 7C| |acc 60|acc 79|
|SOH 01|SOH 01| | ! 21| ! 5A| | A 41| A C1| | a 61| a 81|
|STX 02|STX 02| | " 22| " 7F| | B 42| B C2| | b 62| b 82|
|ETX 03|ETX 03| | # 23| # 7B| | C 43| C C3| | c 63| c 83|
|------|------| |------|------| |------|------| |------|------|
|EOT£04|EOT 37| | $ 24| $ 5B| | D 44| D C4| | d 64| d 84|
|ENQ£05|ENQ 2D| | % 25| % 6C| | E 45| E C5| | e 65| e 85|
|ACK£06|ACK 2E| | & 26| & 50| | F 46| F C6| | f 66| f 86|
|BEL 07|BEL 2F| | ' 27| ' 7D| | G 47| G C7| | g 67| g 87|
|------|------| |------|------| |------|------| |------|------|
|BS 08|BS 16| | ( 28| ( 4D| | H 48| H C8| | h 68| h 88|
|HT 09|HT 05| | ) 29| ) 5D| | I 49| I C9| | i 69| i 89|
|LF 0A|LF 25| | * 2A| * 5C| | J 4A| J D1| | j 6A| j 91|
|VT 0B|VT 0B| | + 2B| + 4E| | K 4B| K D2| | k 6B| k 92|
|------|------| |------|------| |------|------| |------|------|
|FF 0C|FF 0C| | , 2C| , 6B| | L 4C| L D3| | l 6C| l 93|
|CR£ 0D|CR 0D| | - 2D| - 60| | M 4D| M D4| | m 6D| m 94|
|SO 0E|SO 0E| | . 2E| . 4B| | N 4E| N D5| | n 6E| n 95|
|SI 0F|SI 0F| | / 2F| / 61| | O 4F| O D6| | o 6F| o 96|
|------|------| |------|------| |------|------| |------|------|
|DLE 10|DLE 10| | 0 30| 0 F0| | P 50| P D7| | p 70| p 97|
|DC1 11|DC1 11| | 1 31| 1 F1| | Q 51| Q D8| | q 71| q 98|
|DC2 12|DC2 12| | 2 32| 2 F2| | R 52| R D9| | r 72| r 99|
|DC3 13|TM 13| | 3 33| 3 F3| | S 53| S E2| | s 73| s A2|
|------|------| |------|------| |------|------| |------|------|
|DC4 14|DC4 3C| | 4 34| 4 F4| | T 54| T E3| | t 74| t A3|
|NAK 15|NAK 3D| | 5 35| 5 F5| | U 55| U E4| | u 75| u A4|
|SYN 16|SYN 32| | 6 36| 6 F6| | V 56| V E5| | v 76| v A5|
|ETB 17|ETB 26| | 7 37| 7 F7| | W 57| W E6| | w 77| w A6|
|------|------| |------|------| |------|------| |------|------|
|CAN£18|CAN 18| | 8 38| 8 F8| | X 58| X E7| | x 78| x A7|
|EM 19|EM 19| | 9 39| 9 F9| | Y 59| Y E8| | y 79| y A8|
|SUB 1A|SUB 3F| | : 3A| : 7A| | Z 5A| Z E9| | z 7A| z A9|
|ESC 1B|ESC 27| | ; 3B| ; 5E| | [ 5B| [ AD| | »¶ 7B| » C0|
|------|------| |------|------| |------|------| |------|------|
|FS 1C|IFS 1C| | < 3C| < 4C| |bsl 5C|bsl E0| |bar½7C| | 4F|
|GS 1D|IGS 1D| | = 3D| = 7E| | ] 5D| ] BD| | º¶ 7D| º D0|
|RS 1E|IRS 1E| | > 3E| > 6E| |car¼5E| ¬ 5F| |til 7E|til A1|
|US 1F|IUS 1F| | ? 3F| ? 6F| | _ 5F| _ 6D| |DEL 7F|Note 2|
+-------------+ +-------------+ +-------------+ +-------------+
Appendix B: Character Translation for ASCII Communication 355
CMS Reference
Output Translation
+-------------+ +-------------+ +-------------+ +-------------+
| |ASCII | | |ASCII | | |ASCII | | |ASCII |
|EBCDIC|Output| |EBCDIC|Output| |EBCDIC|Output| |EBCDIC|Output|
|------|------| |------|------| |------|------| |------|------|
| |NUL 00|NUL 00| |DS 20|DEL 7F| |SP 40|SP 20| | - 60| - 2D|
|SOH 01|SOH 01| |SOS 21|DEL 7F| | 41|DEL 7F| | / 61| / 2F|
|STX 02|STX 02| |FS 22|FS 1C| | 42|DEL 7F| | 62|DEL 7F|
|ETX 03|ETX 03| | 23|DEL 7F| | 43|DEL 7F| | 63|DEL 7F|
|------|------| |------|------| |------|------| |------|------|
|PF 04|DEL 7F| |BYP 24|DEL 7F| | 44|DEL 7F| | 64|DEL 7F|
|HT 05|HT 09| |LF 25|LF 0A| | 45|DEL 7F| | 65|DEL 7F|
|LC 06|DEL 7F| |ETB 26|ETB 17| | 46|DEL 7F| | 66|DEL 7F|
|DEL 07|DEL 7F| |ESC 27|ESC 1B| | 47|DEL 7F| | 67|DEL 7F|
|------|------| |------|------| |------|------| |------|------|
|GE 08|DEL 7F| | 28|DEL 7F| | 48|DEL 7F| | 68|DEL 7F|
|RLF 09|DEL 7F| | 29|DEL 7F| | 49|DEL 7F| | 69|DEL 7F|
|SMM 0A|DEL 7F| |SM 2A|DEL 7F| | ¢ 4A| [ 5B| |bar½6A|bar 7C|
|VT 0B|VT 0B| |CU2 2B|DEL 7F| | . 4B| . 2E| | , 6B| , 2C|
|------|------| |------|------| |------|------| |------|------|
|FF 0C|FF 0C| | 2C|DEL 7F| | < 4C| < 3C| | % 6C| % 25|
|CR 0D|CR 0D| |ENQ 2D|ENQ 05| | ( 4D| ( 28| | _ 6D| _ 5F|
|SO 0E|SO 0E| |ACK 2E|ACK 06| | + 4E| + 2B| | > 6E| > 3E|
|SI 0F|SI 0F| |BEL 2F|BEL 07| | |½ 4F|bar 7C| | ? 6F| ? 3F|
|------|------| |------|------| |------|------| |------|------|
|DLE 10|DLE 10| | 30|DEL 7F| | & 50| & 26| | 70|DEL 7F|
|DC1 11|DC1 11| | 31|DEL 7F| | 51|DEL 7F| | 71|DEL 7F|
|DC2 12|DC2 12| |SYN 32|SYN 16| | 52|DEL 7F| | 72|DEL 7F|
|TM 13|DC3 13| | 33|DEL 7F| | 53|DEL 7F| | 73|DEL 7F|
|------|------| |------|------| |------|------| |------|------|
|RES 14|DEL 7F| |PN 34|DEL 7F| | 54|DEL 7F| | 74|DEL 7F|
|NL 15|LF 0A| |RS 35|RS 1E| | 55|DEL 7F| | 75|DEL 7F|
|BS 16|BS 08| |UC 36|DEL 7F| | 56|DEL 7F| | 76|DEL 7F|
|IL 17|DEL 7F| |EOT 37|EOT 04| | 57|DEL 7F| | 77|DEL 7F|
|------|------| |------|------| |------|------| |------|------|
|CAN 18|CAN 18| | 38|DEL 7F| | 58|DEL 7F| | 78|DEL 7F|
|EM 19|EM 19| | 39|DEL 7F| | 59|DEL 7F| |acc 79|acc 60|
|CC 1A|DEL 7F| | 3A|DEL 7F| | ! 5A| ! 21| | : 7A| : 3A|
|CU1 1B|DEL 7F| |CU3 3B|DEL 7F| | $ 5B| $ 24| | # 7B| # 23|
|------|------| |------|------| |------|------| |------|------|
|IFS 1C|FS 1C| |DC4 3C|DC4 14| | * 5C| * 2A| | @ 7C| @ 40|
|IGS 1D|GS 1D| |NAK 3D|NAK 15| | ) 5D| ) 29| | ' 7D| ' 27|
|IRS 1E|RS 1E| | 3E|DEL 7F| | ; 5E| ; 3B| | = 7E| = 3D|
|IUS 1F|US 1F| |SUB 3F|SUB 1A| | ¬¼ 5F|car 5E| | " 7F| " 22|
+-------------+ +-------------+ +-------------+ +-------------+
(Continued on Following Page)
Appendix B: Character Translation for ASCII Communication 356
CMS Reference
Output Translation (Continued)
+-------------+ +-------------+ +-------------+ +-------------+
| |ASCII | | |ASCII | | |ASCII | | |ASCII |
|EBCDIC|Output| |EBCDIC|Output| |EBCDIC|Output| |EBCDIC|Output|
|------|------| |------|------| |------|------| |------|------|
| 80|DEL 7F| | A0|DEL 7F| | »¶ C0| » 7B| |bsl E0|bsl 5C|
| a 81| a 61| |til A1|til 7E| | A C1| A 41| | E1|DEL 7F|
| b 82| b 62| | s A2| s 73| | B C2| B 42| | S E2| S 53|
| c 83| c 63| | t A3| t 74| | C C3| C 43| | T E3| T 54|
|------|------| |------|------| |------|------| |------|------|
| d 84| d 64| | u A4| u 75| | D C4| D 44| | U E4| U 55|
| e 85| e 65| | v A5| v 76| | E C5| E 45| | V E5| V 56|
| f 86| f 66| | w A6| w 77| | F C6| F 46| | W E6| W 57|
| g 87| g 67| | x A7| x 78| | G C7| G 47| | X E7| X 58|
|------|------| |------|------| |------|------| |------|------|
| h 88| h 68| | y A8| y 79| | H C8| H 48| | Y E8| Y 59|
| i 89| i 69| | z A9| z 7A| | I C9| I 49| | Z E9| Z 5A|
| 8A|DEL 7F| | AA|DEL 7F| | CA|DEL 7F| | EA|DEL 7F|
| ¶ 8B| » 7B| | AB|DEL 7F| | CB|DEL 7F| | EB|DEL 7F|
|------|------| |------|------| |------|------| |------|------|
| 8C|DEL 7F| | AC|DEL 7F| | CC|DEL 7F| | EC|DEL 7F|
| 8D|DEL 7F| | [ AD| [ 5B| | CD|DEL 7F| | ED|DEL 7F|
| 8E|DEL 7F| | AE|DEL 7F| | CE|DEL 7F| | EE|DEL 7F|
| 8F|DEL 7F| | AF|DEL 7F| | CF|DEL 7F| | EF|DEL 7F|
|------|------| |------|------| |------|------| |------|------|
| 90|DEL 7F| | B0|DEL 7F| | º¶ D0| º 7D| | 0 F0| 0 30|
| j 91| j 6A| | B1|DEL 7F| | J D1| J 4A| | 1 F1| 1 31|
| k 92| k 6B| | B2|DEL 7F| | K D2| K 4B| | 2 F2| 2 32|
| l 93| l 6C| | B3|DEL 7F| | L D3| L 4C| | 3 F3| 3 33|
|------|------| |------|------| |------|------| |------|------|
| m 94| m 6D| | B4|DEL 7F| | M D4| M 4D| | 4 F4| 4 34|
| n 95| n 6E| | B5|DEL 7F| | N D5| N 4E| | 5 F5| 5 35|
| o 96| o 6F| | B6|DEL 7F| | O D6| O 4F| | 6 F6| 6 36|
| p 97| p 70| | B7|DEL 7F| | P D7| P 50| | 7 F7| 7 37|
|------|------| |------|------| |------|------| |------|------|
| q 98| q 71| | B8|DEL 7F| | Q D8| Q 51| | 8 F8| 8 38|
| r 99| r 72| | B9|DEL 7F| | R D9| R 52| | 9 F9| 9 39|
| 9A|DEL 7F| | BA|DEL 7F| | DA|DEL 7F| | FA|DEL 7F|
| 9B| º¶ 7D| | BB|DEL 7F| | DB|DEL 7F| | FB|DEL 7F|
|------|------| |------|------| |------|------| |------|------|
| 9C|DEL 7F| | BC|DEL 7F| | DC|DEL 7F| | FC|DEL 7F|
| 9D|DEL 7F| | ] BD| ] 5D| | DD|DEL 7F| | FD|DEL 7F|
| 9E|DEL 7F| | BE|DEL 7F| | DE|DEL 7F| | FE|DEL 7F|
| 9F|DEL 7F| | BF|DEL 7F| | DF|DEL 7F| | FF|DEL 7F|
+-------------+ +-------------+ +-------------+ +-------------+
Appendix B: Character Translation for ASCII Communication 357
CMS Reference
Notes:
1. A CR (Carriage Return) entered from an ASCII terminal is treated
as an end-of-input signal by the terminal control hardware. ACK,
CAN, ENQ, and EOT also act as end-of-input signals, but are not
normally used as such. Ending a line with any character other
than CR will usually cause data on the line to be lost. No data
will be read following an end-of-input character until after the
next prompt is issued.
2. DEL characters from an ASCII terminal are removed by the terminal
control hardware and are not passed to VM/SP as data.
3. The BREAK key found on most ASCII terminals does not transmit a
character, but rather causes a special condition on the
communication line which is recognized as an attention request.
4. NUL characters entered from an ASCII terminal may be deleted or
translated to another character under the control of the TERMINAL
NULLS command. CMS uses NUL to indicate the end of the data on
an input line; the NUL and any following characters are ignored.
5. The ASCII left and right braces are translated to the EBCDIC
brace characters on input. Both the EBCDIC and TN braces are
translated to ASCII braces on output.
6. An EBCDIC "not" (¬) is translated to an ASCII caret (or up-
arrow), and an ASCII caret is translated to an EBCDIC "not".
ASCII does not have a "not" character.
7. The EBCDIC vertical bar and broken vertical bar are both
translated to the ASCII broken vertical bar. The ASCII broken
vertical bar becomes an EBCDIC vertical bar. ASCII does not have
a vertical bar.
Appendix B: Character Translation for ASCII Communication 358
CMS Reference
APPENDIX C: Glossary
This appendix contains definitions for a number of important terms
used in connection with CMS. These terms are frequently used in this
manual and others. This is not intended to be a general computer-
related dictionary, but rather a summary of terms that have specific
meanings when used in the context of CMS and are important for an
understanding of the CMS documentation.
attention
You can interrupt the execution of a command at your terminal by
causing an attention. This allows you to stop output from the
command by entering HT (halt typing), or terminate the command by
| entering HX (halt execution) or HI (halt interpretation). Other
| commands can also be entered. These commands are stacked and are
| executed after the current command completes. Note that HX and
| HI clear the stack.
An attention can be caused at an ASCII terminal by pressing the
BREAK key. At a 3270-type terminal press ENTER to cause an
attention if the terminal is in RUNNING status. If the terminal
is in VM READ status you must move the cursor to the left of the
input area (to the last column of the previous line), press
ENTER, and move the cursor back to the input area.
| You can usually enter commands on a 3270 when RUNNING is
| displayed.
On an ASCII terminal, pressing BREAK twice will cause the
terminal to enter CP mode. On a 3270-type terminal, pressing PA1
will enter CP mode. Use the BEGIN command to return to normal
CMS execution.
byte A data item containing eight bits. A byte usually represents one
character.
CJS The Conversational Job System. CJS was a subset of CMS provided
at the UKCC from 1976 through 1983. CJS was used to submit batch
jobs, examine output, and format documents with SCRIPT.
CMS The Conversational Monitor System. CMS is the interactive
terminal system that is supplied with the IBM Virtual Machine
System Product (VM/SP).
CP The Control Program. CP is the part of the IBM Virtual Machine
System Product (VM/SP) that manages the computing system.
Appendix C: Glossary 359
CMS Reference
display terminal
Only 3270-type terminals and asynchronous ASCII terminals using
the S3270 facility are supported as display terminals. All other
kinds of terminals, including ASCII display terminals not using
S3270, are treated as typewriter (or line mode) terminals. The
CMS editors support full-screen modes on display terminals.
EDF The Extended Disk Format is the recommended format for all CMS
minidisks. EDF minidisks are formatted to contain physical
| blocks of 512, 1K, 2K, or 4K bytes (the default is 1K). A number
| of restrictions that existed under the old format (which used
800-byte blocks) have been removed under EDF. The old format is
still supported. EDF has been used for all new users at the UKCC
since 1979.
EXEC A CMS disk file with a filetype of "EXEC" that contains commands
and EXEC control statements. This allows existing commands to be
combined by the user to build new commands. An EXEC is executed
from the terminal by entering its name.
| CMS has three EXEC interpreters. The oldest is known simply as
EXEC. A newer version is called EXEC 2 and supports a more
powerful language.
| The newest EXEC interpreter is called the System Product
| Interpreter or REXX (for Restructured Extended Executor). It
| provides a much more powerful language and should be used for new
| applications.
file A collection of records kept together on a disk. CMS users can
manipulate three kinds of files: CMS disk files, spool files, and
OS data sets. CMS disk files are the files that may be created
and examined with the CMS editors and are used for permanent data
storage. CMS disk files are identified with a fileid. Spool
files are special files that represent printed or punched output
and are used for temporary storage or for transferring data
between users. Spool files are identified with a spool file
number. OS data sets are files that are created under the OS
batch system and may be examined from CMS. OS data sets are
identified with a data set name.
fileid
A three-part CMS disk file identifier. The three parts are the
filename, the filetype, and the filemode. In many cases a fileid
may be specified using only the first two parts.
filemode
| The third part of the CMS fileid. It always consists of one
| letter and one digit (0 through 6). The filemode letter is
determined by the ACCESS command and indicates on which disk the
file resides. The filemode number may be set by the user.
Usually it is only necessary to specify the letter and a default
number will be supplied. Some commands will also supply a
default letter.
Appendix C: Glossary 360
CMS Reference
filename
The first part of the CMS fileid. The name may consist of from
one to eight characters (limited to letters, digits, $, #, @, -,
+, _ and :).
filetype
The second part of the CMS fileid. It may consist of from one to
eight characters (limited to letters, digits, $, #, @, -, +, _
and :). Some CMS commands attach special significance to certain
filetypes. For example, the SCRIPT command uses only files with
a filetype of "SCRIPT," and the PLOT command uses a default
filetype of "PLOT." The CMS editors set certain default file
attributes based on the filetype (refer to the XEDIT filetype
Appendix for details).
HASP Houston Automatic Spooling Program. HASP runs with the OS batch
system and controls the printers on the computer system, both at
the Computing Center and at remote sites around the state.
| HPO is the High Performance Option of VM/SP. HPO is required for
| some processors, including the IBM 3083 used at the UKCC.
minidisk
A permanent area of disk storage used to contain CMS disk files.
Every CMS user has write-access to a least one minidisk for
permanent data storage.
program stack
See "stack."
| REXX The Restructured Extended Executor language supported by the
| System Product Interpreter. REXX is the new EXEC language
| provided with Release 3 of VM/SP. Also see "EXEC."
RSCS Remote Spooling Communication Subsystem. RSCS is a subsystem
that runs under VM/SP and controls the transfer of data across
communication lines. RSCS controls 328x printers.
spool file
See "file."
stack
| The CMS stack (or program stack) is a series of buffers used to
| hold data lines. Lines are placed in the stack with REXX PUSH
| and QUEUE statements, the EXEC &STACK function, and by a number
| of CMS commands. Stacked lines may be read with REXX PULL and
| PARSE statements, and the EXEC &READ function. CMS will also
| read commands from the stack. The stack may be controlled with
the MAKEBUF and DROPBUF commands. Lines entered at the terminal
pass through console buffers and for most purposes may be
considered an extension to the stack.
Appendix C: Glossary 361
CMS Reference
| supported
| This means that the organization that originally supplied a
| command, program, or other software will investigate and correct
| problems, and that the UKCC probably will be able to supply
| consulting assistance. Unsupported software can often be used
| successfully, but if you encounter a problem you are on your own.
| You use unsupported software at your own risk!
token
| An eight-character string. The old EXEC processor (this is not
| true of REXX or EXEC 2) tokenizes each line by truncating each
| group of non-blank characters (words) to a length of eight.
Characters after the first eight are discarded. CP and CMS
command parameters are often tokenized (and converted to
uppercase).
typewriter terminal
A terminal that produces printed (hardcopy) output, rather than a
display. VM/SP treats all asynchronous ASCII terminals as
typewriter terminals unless they are using the S3270 facility.
Compare this with "display terminal."
virtual
Something that appears to be there, but really isn't. VM/SP
simulates the functions of a real computer for each user by
creating a "virtual machine." Each virtual machine has virtual
memory, virtual input/output devices, and a virtual console
(terminal). These facilities are provided by software simulation
and sharing the resources of the computing system among all of
the logged on users.
| word A group of characters. REXX and EXEC 2 consider contiguous
strings of non-blank characters to be a word. CMS limits words
to eight characters in some situations (see "token").
3270-type terminal
See "display terminal."
Appendix C: Glossary 362
CMS Reference
BIBLIOGRAPHY
CMS
VM/SP CMS Primer (IBM Order No. SC24-5236)
VM/SP Introduction (IBM Order No. GC19-6200)
| VM/SP HPO System Messages and Codes (IBM Order No. SC19-6226)
VM/SP Terminal User's Guide (IBM Order No. GC19-6206)
VM/SP CMS Command and Macro Reference (IBM Order No. SC19-6209)
VM/SP CMS User's Guide (IBM Order No. SC19-6210)
| VM/SP HPO CP Command Reference for General Users
| (IBM Order No. SC19-6227)
VM/SP System Product Editor Command and Macro Reference
(IBM Order No. SC24-5221)
VM/SP System Product Editor User's Guide (IBM Order No. SC24-5220)
VM/SP System Product Interpreter Reference
(IBM Order No. SC24-5239)
VM/SP System Product Interpreter User's Guide
(IBM Order No. SC24-5238)
VM/SP System Product Interpreter Language Reference Summary
(REXX Reference Card, IBM Order No. SC24-5238)
VM/SP EXEC 2 Reference (IBM Order No. SC24-5219)
VM/SP System Product Editor Command Language Reference Summary
(XEDIT Reference Card, IBM Order No. SX24-5122)
VM/SP EXEC 2 Language Reference Summary
(EXEC 2 Reference Card, IBM Order No. SX24-5124)
Programming Languages
OS/VS-DOS/VSE-VM/370 Assembler Language
(IBM Order No. GC33-4010)
Bibliography 363
CMS Reference
Introduction to Waterloo BASIC for VM/370 CMS
IBM VM/370 CMS User's Guide for COBOL (IBM Order No. SC28-6469)
IBM VS COBOL for OS/VS (IBM Order No. GC26-3857)
IBM OS/VS COBOL Compiler and Library Programmer's Guide
(IBM Order No. SC28-6483)
IBM OS COBOL Interactive Debug Terminal User's Guide and Reference.
(IBM Order No. SC28-6465)
VS FORTRAN Application Programming: Language Reference
(IBM Order No. GC26-3986)
VS FORTRAN Application Programming: Guide
(IBM Order No. SC26-3985)
VS FORTRAN Application Programming: System Services Reference
Supplement (IBM Order No. SC26-3989)
VS FORTRAN Application Programming: Library Reference
(IBM Order No. SC26-3989)
IBM System/360 and System/370 FORTRAN IV Language
(IBM Order No. GC28-6515)
IBM System/360 OS FORTRAN IV (G and H) Programmer's Guide
(IBM Order No. GC28-6817)
IBM FORTRAN IV (H Extended) Compiler for OS and VM/370 (CMS)
Program Logic (IBM Order No. LY28-6403)
IBM OS FORTRAN IV (H Extended) Compiler Programmer's Guide
(IBM Order No. SC28-6852)
UKCC CMS Pascal P4 User's Guide
Pascal User Manual and Report, Kathleen Jensen and Niklaus Wirth,
Springer-Verlag
Waterloo Pascal User's Guide
OS PL/I Optimizing Compiler: CMS User's Guide (IBM Order No. SC33-0037)
OS and DOS PL/I Language Reference Manual (IBM Order No. GC26-3977)
PL/CT User's Guide for CMS
The SNOBOL4 Programming Language, Griswold, Poage, and Polonsky,
Prentice-Hall
WATFIV Under CMS
Bibliography 364
CMS Reference
Other
Guide to Typesetting at the UKCC
KERMIT Protocol Manual
KERMIT User's Guide
MATLAB User's Guide
SAS User's Guide: Basics
SAS Companion for the VM/CMS Operating System
SAS/FSP User's Guide
SyncSort CMS Programmer's Guide
UKCC CMS Batch User's Guide
UKCC Plotting Manual (Third Edition)
Waterloo SCRIPT GML User's Guide
Waterloo SCRIPT Reference Manual
Waterloo SCRIPT User's Guide
XMENU and DMSCVT User's Guide
XMENU Subroutine Library User Reference
YCALC Spreadsheet Manual
Bibliography 365
CMS Reference
INDEX
-&- AUTOLINK, 22, 133, 204
&, 11, 313 AUTOSAVE, 325
&JOBSTAT, 34
&RC, 345 -B-
&RETCODE, 345 BACKWARD, 314
&SYSJOBID, 34 BALANCE, 25
&USRJOBID, 34 BASIC, 28, 304
BATCH, 29, 35
-/- batch jobs, 44, 275
/, 336 batch macros, 34
batch server, 33
-?- BATKILL, 35
?, 10, 314, 336 baud, 346
BOTTOM, 314
-=- break, 347
=, 12, 314, 324 break key, 329, 358-359
BREAKIN, 285
-"- BRKKEY, 285
", 336 BROWSE, 36
"", 336 BURN, 41, 121, 314
BURST, 285
-A- BYPASS, 285
A, 336 byte, 359
abbreviations, 80, 203, 233
ACCEPT, 13, 230 -C-
ACCESS, 15, 75, 133, 160, 204 C, 337
account balance, 25 CALC, 42
acknowledgment, 13, 41, 175, 230 calculator, 42
ADD, 314 CALL/OS BASIC, 28
address, 111 CANCEL, 44, 314
ADDRESS function, 80 CAPPEND, 314
AJ833, 17, 297, 348 carriage control, 119, 198-199,
ALL, 314 294
ALT, 324 CASE, 45, 205, 235, 325, 354
ALTER, 314 CC, 46, 337
alteration count, 309 CDELETE, 314
APL, 284, 324 Central, 163, 238, 241, 244
APLT, 284 CFIRST, 314
ARBCHAR, 325 CHANGE, 315
ASCII, 346, 354 characters, 354
ASMXC, 18 CHARDEL, 285
ASMXCG, 19 CHECKBUF, 47
ASMXG, 20 CINSERT, 315
ASSEMBLE, 18-21 CJS, 359
asynchronous communication, 346 CJSPREP, 48, 278
attention, 358-359 CLAST, 315
ATTN, 284 CLEAR, 49
AUTOCR, 285 CLEAR key, 310
Index 366
CMS Reference
CLOCATE, 315 -D-
CMDLINE, 325 D, 337
CMS, 315, 359 data bits, 346
CMS Batch, 29, 35 date, 80
CMSCMSG, 50 DBLANK, 316
CMSDIO, 51 DD, 337
CMSG, 315 DEFAULTS, 74, 159, 231
CMSPMSG, 54 DEL, 311
CMSREAD, 55 delete, 311, 316
CMSTIO, 56 desk calculator, 42
COBDC, 57 DETACH, 75
COBDCG, 58 device address, 111
COBDG, 59 disconnect, 145
COBOL, 57-60, 66-68, 291 disk files, 33
COBOL Interactive Debug, 57-59, DISPLAY, 326
291 display mode, 308, 348
COBVC, 66 display terminal, 360
COBVCG, 67 DOWN, 316
COBVG, 68 DROP, 75, 134
codes, 32, 354 DROPBUF, 76
CODETRAN, 69 DUP key, 312
COLOR, 325 duplex, 346
COLPTR, 325 DUPLICATE, 317
column pointer, 313
column targets, 313 -E-
COMMAND, 315 E, 337
commands, 79 EBCDIC, 346, 354
Commodore SuperPET, 350 EDF, 360
communications, 107, 115, 124 editor, 36, 129, 161, 175, 208,
COMPARE, 150 216, 290, 306
COMPRESS, 315 EMSG, 317
console buffer, 147 end-of-input, 347
console log, 144, 237 ENTER, 326
console spooling, 144 ENTER key, 310
control characters, 354 ENVIRON, 77
COPY, 316 ERASE, 41, 78
COPYFILE, 71, 82 ERASE EOF key, 310
cost, 46, 73 ERASE INPUT key, 310
COUNT, 316 ESCAPE, 286, 326
COVERLAY, 316 ETX/ACK, 348
CP, 316, 359 even parity, 346
CP mode, 359 EXEC, 8, 79, 204, 234, 345, 360
CREPLACE, 316 EXEC 2, 8, 114, 345
cross-reference, 63-64, 97, 103, EXEC 2, 79
168, 171, 184 EXECTRACE, 234
CTL, 307 EXPAND, 317
CTLCHAR, 326 EXPLAIN, 81, 317
CURLINE, 326 EXTRACT, 317
Current Cost, 46
current line, 313 -F-
cursor, 311, 316 F, 337
FCOPY, 71, 82
FFILE, 317
FIELD MARK key, 311
Index 367
CMS Reference
field separator, 312 HELP, 9, 113, 318
FILE, 317, 360 HEX, 327
file sharing, 33 HEXTYPE, 318
file transmission, 107, 115, 124, HI, 114
350 highlighting, 325
FILEDEF, 204 HILIGHT, 286
fileid, 360 HOSTCM, 115, 350
filemode, 110, 360 HOT, 163, 238, 241, 244
filemode number, 210 HPO, 361
filename, 361 HT, 116, 234, 359
filetype, 361 HX, 117, 359
FILLER, 326
FIND, 317 -I-
FINDUP, 318 I, 337
FLIST, 84 IBM Personal Computer, 350
FLOW, 318 IDLES, 286
FMODE, 326 IMAGE, 327
FNAME, 326 immediate commands, 204, 234
forms, 164 IMPCMSCP, 79, 327
FORTG, 90 IMPCP, 204, 234
FORTGC, 92 IMPEX, 204, 234
FORTGCG, 93 implied CP, 79, 204, 234
FORTGG, 94 implied EXEC, 79, 204, 234
FORTHX, 95 IMSG, 235
FORTRAN, 90, 92-95, 98-101, INLONG, 319
104-106, 302 INPUT, 118, 319
FORTVC, 98 input translations, 204, 235
FORTVCG, 99 INS MODE, 311
FORTVG, 100 insert mode, 311
FORTVS, 101 Interactive Debug (COBOL), 57-59,
FORTXC, 104 291
FORTXCG, 105 interpreter, 79
FORTXG, 106 IPL, 123, 146
FORWARD, 318
FSEND, 107, 350 -J-
FTYPE, 326 job status codes, 32
full-screen, 348 JOIN, 319
FULLREAD, 326, 350 JUSTIFY, 319
FUP, 318
-K-
-G- Kentucky Register, 125
GATHER, 109 KERMIT, 124, 350
GET, 318 keyboard, 310
GETFMODE, 110 KYREG, 125
GETVADDR, 111
GLOBAL, 21, 64, 184 -L-
GRIPE, 112 LABELS, 126
LASTLORC, 327
-H- LEDIT, 129
half-duplex, 346 LEFT, 319
Halt Execution, 117, 359 libraries, 64, 184
Halt Interpretation, 114 line editing, 235, 289
Halt Typing, 116, 234, 359 line mode, 308
HASP, 361 line speed, 346
Index 368
CMS Reference
LINEDEL, 286 NFIND, 321
LINEND, 286, 327 NFINDUP, 321
LINESIZE, 287, 297 NFUP, 321
LINK, 22, 75, 133, 204 nicknames, 159, 231, 283
LISP, 136 NONDISP, 328
LISTDS, 137 Northern Digital microWAT, 350
LISTX, 139 NOSEQ8, 307
LOAD, 320 NOTE, 13, 159
LOCATE, 320 NOUPDATE, 307
LOGIN, 145 null, 358
LOGOFF, 144 NULLS, 287, 328
LOGON, 145 NUMBER, 329
LOGOUT, 144
long input, 319 -O-
LOWERCASE, 320 online news, 158
LPREFIX, 320 OS batch jobs, 44, 275
LRECL, 327 OS data sets, 160-161, 306, 340
OSDISKS, 160
-M- OSXEDIT, 161, 306
M, 337 OUTPUT, 162
MACLIB, 21, 64, 184 output translations, 205, 235
MACRO, 320, 328, 337 OVERLAY, 321
macro libraries, 21
macros, 34, 80, 341 -P-
MAKEBUF, 147 P, 337
MANUAL, 148 PA keys, 329
mark parity, 346 PACK, 165, 329
MASK, 287, 328 packed files, 165, 329, 340
MATCH, 150 PAn, 329
MATLAB, 156 parity, 346, 354
matrix arithmetic, 156 PARSE, 321
member, 161 partitioned data set, 161
MENUEXEC, 157 PASCAL, 166, 171-174, 201-202
MERGE, 320 PASSWORD, 169
messages, 235 PASXREF, 171
microcomputers, 107, 115, 124, PAS4C, 172
350 PAS4CG, 173
microSoftware, 350 PAS4G, 174
microWAT, 350 PA1 key, 37, 310, 359
minidisk, 75, 361 PA2 key, 37, 310
MM, 337 PDS, 161
mode, 110, 287 PEEK, 175, 230, 306
MODIFY, 320 PENDING, 329
MOVE, 320 personal computers, 107, 115,
MSG, 321 124, 350
MSGLINE, 328 PF, 329
MSGMODE, 328 PF keys, 37, 205, 212, 235, 289,
311, 329
-N- PFILE, 321
NETDATA, 13, 159, 175, 231 PL/CT, 176
new line, 311 PL/I, 176-177, 179-180, 186-188
NEWS, 158, 204 PLC, 176
newsletter, 125 PLIC, 177
NEXT, 321 PLICR, 179
Index 369
CMS Reference
PLIOPT, 180 QUERY LOGMSG, 204
PLIXC, 186 QUERY NAMES, 204
PLIXCG, 187 QUERY OUTPUT, 205
PLIXG, 188 QUERY PF, 205
PLOT, 189 QUERY RATE, 205
PLOTAJ, 191 QUERY RDR, 205
PLOTHP, 193 QUERY READER, 205
PLOTTEK, 195, 293 QUERY SEARCH, 205
POINT, 329 QUERY SET, 205
POWERINP, 321 QUERY SYNONYM, 205
PQUIT, 321 QUERY TERMINAL, 205, 289
PREFIX, 330, 336 QUERY TIME, 205
prefix subcommands, 312, 320 QUERY USER, 205
PRESERVE, 322 QUERY USERID, 205
PRHELP, 197 QUIT, 322
PRINT, 119, 198, 294
printing, 2 -R-
printing terminals, 348 RANGE, 330
PROFILE, 308 RATES, 207
PROFILE EXEC, 80, 146, 239, 242, RBLANK, 322
245, 297, 317 RBROWSE, 208
PROFILE XEDIT, 337 RDRCOST, 209
program attention keys, 329 READ, 323
program function keys, 205, 212, READY command, 301
235, 289, 311, 329 ready message, 236
program stack, 47, 76, 147, 232, RECALL, 212, 314
263, 361 recall function, 10
programming languages, 5 RECFM, 330
PROMPT, 287 reconnect, 145, 289
prompts, 347 record separator, 311
PROTOCOL, 288, 348 RECOVER, 323
PSAVE, 322 RELEASE, 75
PSCRIPT, 224 REMOTE, 330
PUBLIC, 200 RENAME, 210
Public disk, 200 RENUM, 323
PURGE, 41, 322 REPEAT, 323
PUT, 322 REPLACE, 323
PUTD, 322 REPRINT, 211
PW, 201 RESERVED, 330
P4 Pascal, 166, 172-174 RESET, 311, 323
P8000, 171, 202 RESTORE, 323
Resume Typing, 214, 234
-Q- retain, 313
QQUIT, 322 retain function, 11
QUERY, 203, 236, 322 RETCODE, 345
QUERY ABBREV, 203 RETRIEVE, 205, 212, 235
QUERY DISK, 204 return codes, 345
QUERY FILEDEF, 204 reuse, 314
QUERY FILES, 204 reuse function, 12
QUERY IMMEDIATE, 204 REXX, 8, 79, 114, 345, 361
QUERY IMPCP, 204 RGTLEFT, 323
QUERY IMPEX, 204 RH, 213
QUERY INPUT, 204 RIGHT, 323
QUERY LINKS, 204 RINPUT, 324
Index 370
CMS Reference
RSCS, 163, 238, 241, 244, 276, special characters, 354
361 SPELL, 248, 334
RT, 214, 234 SPELLCHK, 249
RUBS, 288 SPELLFIX, 254, 334
RUNID, 215 SPILL, 332
RXEDIT, 216, 306 SPITBOL, 256
SPLIT, 335
-S- SPLTJOIN, 335
S, 337 spool file, 41, 109, 175, 204,
SAS, 217 208-209, 211, 216, 361
SAVE, 324 spooling console, 144
SCALE, 330, 337 spreadsheet, 344
SCAN, 219 SSAVE, 335
SCHANGE, 324 SSORT, 259
SCREEN, 331 stack, 47, 76, 147, 232, 263,
SCRIPT, 223, 318 335, 361
SCRNSAVE, 288 STATE, 8
SCROLL, 288 STATEW, 8
SELECT, 225, 331 Statistical Analysis System, 217
SENDFILE, 13, 230 STATUS, 261, 335
SENTRIES, 232 status codes, 32
SEQ8, 308 STAY, 332
SERIAL, 331 STK, 263
SET, 205, 233, 324 STKDATE, 264
SET =, 324 STKDISK, 265
SET ABBREV, 203, 233 STKID, 267
SET AUTOREAD, 146, 233 STKRDR, 268
SET BLIP, 146, 234 STKTERM, 269
SET CMSTYPE, 116, 214, 234 STKTIME, 271
SET EMSG, 234, 328 STKXRDR, 272
SET EXECTRACE, 234 stop bits, 346
SET IMMEDIATE, 204, 234 storage, 6, 274
SET IMPCP, 79, 204, 234 STREAM, 332
SET IMPEX, 79, 204, 234 SUBMIT, 275
SET IMSG, 235 SuperPET, 350
SET INPUT, 204, 235 supported, 362
SET LINEDIT, 235, 289 SyncSort, 259
SET MACRO, 79 SYNONYM, 80, 205, 233, 332
SET MSG, 235 SYSID, 280
SET OUTPUT, 205, 235 System Product Editor, 306
SET PF, 205, 235 System Product Interpreter, 79
SET RDYMSG, 236 S3270, 269, 326, 348
SETCON, 237
SETPRT, 198, 240 -T-
SETPUN, 243 TABCHAR, 288
SFILE, 230 TABL, 337
SHADOW, 331 TABLINE, 332
SHIFT, 334 tabs, 288-289, 332
SIDCODE, 308, 331 targets, 313
SNOBOL4, 256 TCU, 347
SORT, 246, 259, 334 TDISK, 75, 281
SORTF, 246 TELL, 283
SOS, 334 temporary disk, 75, 281
SPAN, 331 TERMINAL, 205, 284, 332, 354
Index 371
CMS Reference
terminal control unit, 347 -Y-
TERMINAL LINESIZE, 146, 297 YCALC, 344
TERMINAL PROTOCOL, 348
TESTCOB, 57-59, 291 -Z-
TEXT, 288, 333 ZETALIB, 3
time, 80 ZONE, 334
TIMESTMP, 288
TKPLOT, 293 -3-
TOFEOF, 333 3101, 289
token, 362 3270 simulation, 269, 348
TOP, 335 3270 simulator, 326
TPRINT, 119, 294 3270-type terminal, 362
tracing, 234
TRANSFER, 335
TRANSLAT, 333
translation, 354
TRUNC, 333
TYPE, 289, 294, 298, 335
typewriter mode, 308, 347
typewriter terminal, 362
-U-
UNPACK, 299
UP, 335
UPDATE, 308
UPPERCASE, 335
-V-
VARBLANK, 333
VERIFY, 300, 333
virtual, 362
virtual address, 111
VS COBOL, 57-60, 66-68, 291
VS FORTRAN, 98-99
-W-
WAITRDR, 301
Waterloo microSoftware, 115, 350
WATFIV, 302
WBASIC, 304
WIDTH, 308
word, 362
word processing, 2
WRAP, 333
-X-
X, 337
XEDIT, 79, 161, 175, 216, 306,
336
XEDIT macros, 80, 341
XMENU, 157, 342
XMENULIB, 343
XOFF, 289
XON, 289
Index 372