Parameters within Syntax (cont.) [ Using Your System The User's Guide ] MPE/iX 5.0 Documentation
Using Your System The User's Guide
Parameters within Syntax (cont.)
Positional parameters (cont.)
HELP
The HELP command provides online reference information for individual
commands. You can request partial or complete information for a
particular command. You can also use the HELP command to display the
contents of a file. You can either enter the HELP command and the
desired parameters directly, or you can access the Help Facility
subsystem and enter individual HELP commands from the subsystem. Refer
to "Operation Notes" for more information.
Syntax
Direct access:
{ [,PARMS ]}
{commandname[,OPERATION]}
{ [,EXAMPLE ]}
{ [,ALL ]}
HELP { }
{filename }
{HELPSTUDY }
{SUMMARY }
{CLASS }
Subsystem access:
{ [,PARMS ]}
{commandname[,OPERATION]}
{ [,EXAMPLE ]}
{ [,ALL ]}
HELPReturn { }
{HELPMENU }
{HELPSTUDY }
{SUMMARY }
{CLASS }
{EXIT }
Parameters
command- name Specifies any command. Without additional
keywords, the system displays the command name,
syntax, and a brief description. Specifying the
following keywords provides the information
indicated:
PARMS This keyword lists and
provides a description for
all parameters of the
specified command.
OPERATION This keyword describes how to
use the specified command.
EXAMPLE This keyword displays an
example showing usage of the
specified command.
ALL This keyword displays the
information from all of the
keywords (PARMS, OPERATION,
EXAMPLE).
If you want to enter a keyword with a command, you
must separate the keyword from the command using a
space or comma.
filename Specifies any existing file name. When you specify
this parameter with the command, the system
displays the contents of the file and a header
indicating whether it is a command file or program
file. You cannot specify this parameter from
within the Help Facility subsystem.
HELPMENU Displays the main menu of the Help Facility
subsystem, from which you can choose several
options. This automatically appears when you
invoke the subsystem, but you can also access this
menu by specifying this parameter after the Help
Facility prompt (>) within any portion of the
facility.
HELPSTUDY Provides a tutorial designed to familiarize novice
users with the fundamentals of commands and command
syntax.
SUMMARY Provides a brief summary of operating system
changes, including a quick overview of the
operation of the Help Facility.
CLASS Lists commands by functional class.
EXIT Exits the Help Facility subsystem. Note that you
cannot obtain help for the EXIT command within the
Help Facility subsystem. You must use the direct
access method instead (HELP EXIT).
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break aborts the execution of this command.
* Methods of access
You can get help by either entering the HELP command directly or
by invoking the Help Facility subsystem. The direct method is
recommended when you want to obtain information about one command
or if you want to display the contents of a file. The subsystem
method is recommended if you want to obtain information about
several commands or prefer to interact with a friendlier
screen-driven information source.
To access the Help Facility directly, you type the HELP command
followed by any of the valid syntax parameters, then press Return.
To access the Help Facility subsystem, you type the HELP command
and press Return. The Help Facility subsystem menu appears,
followed by a right angle bracket (>) prompt. You then type any
of the valid syntax parameters and press Return.
Examples
* To directly access description and syntax information for the
ABORT command, enter:
:HELP ABORT
The system responds by displaying:
___________________________________________
| |
| ABORT |
| |
| Aborts current program or operation.|
| |
| Syntax |
| |
| ABORT |
| |
| KEYWORDS: PARMS,OPERATION,EXAMPLE |
| : |
___________________________________________
* To access description and syntax information for the ABORT command
from the Help Facility subsystem, enter:
:HELP
The system responds by displaying:
_____________________________________________________________________________
| |
| This is the MPE/iX Help Facility |
| |
| * Enter SUMMARY, CLASS, a commandname, or HELPSTUDY * |
| |
| SUMMARY . . . . . . . . . .A summary of changes in MPE/iX. |
| |
| CLASS . . . . . . . . . . .Classes of Commands |
| SESSIONS, JOBS, FILES, SUBSYSTEMS, ETC. |
| |
| < command name >. . COMMAND entries, by name |
| |
| < command name >< keyword> COMMAND entry with keyword |
| PARMS, OPERATION, EXAMPLE |
| |
| HELPSTUDY . . . . . . . . A beginner's introduction to Help|
| |
| EXIT . . . . . . . . . . To leave the Help Facility |
| |
| You can use UPPERCASE or lowercase. |
| |
| >>>>>> The name of this screen is HELPMENU <<<<<< |
| > |
_____________________________________________________________________________
Type ABORT at the prompt located at the bottom of the screen, as
shown:
>ABORT
The system responds by displaying:
___________________________________________
| |
| ABORT |
| |
| Aborts current program or operation.|
| |
| Syntax |
| |
| ABORT |
| |
| KEYWORDS: PARMS,OPERATION,EXAMPLE |
| : |
___________________________________________
* To display a summary of the Help Facility subsystem, enter:
>SUMMARY
The system responds by displaying the following screen:
___________________________________________________________________________
| |
| SUMMARY |
| |
| o Interactive -- enter HELP at the colon prompt. Then enter |
| COMMANDNAME[,[KEYWORD]]. Exit by entering E or EXIT. |
| |
| o Direct Access -- enter HELP COMMANDNAME[,[KEYWORD]] at the colon |
| prompt. Help exits after displaying (and scrolling) the portion |
| that you specified. |
| |
| o This summary contains seven special topics: |
| |
| FUNCTION summary of Help function |
| NM commands that operate in native mode |
| CM commands that have been enhanced for MPE/iX. |
| UNSUPPORTED commands that are NOT SUPPORTED in MPE/iX. |
| UNCHANGED commands that retained their function from MPE V/E.|
| XLSYNTAX discusses SYNTAX FLEXIBILITY with the NM commands. |
| CLASS commands by class (SESSIONS,JOBS, FILES...) |
| |
| KEYWORDS: SUMMARY2,NEW,CHANGED,UNCHANGED,UNCH2,UNCH3,UNSUPPORTED, |
| XLSYNTAX,XLSYNTAX2,XLSYNTAX3 |
___________________________________________________________________________
* To review commands listed by the functional tasks they perform,
enter:
>CLASS
The system responds by displaying the following screen:
____________________________________________________________________________
| |
| COMMANDS LISTED BY CLASS |
| |
| Commands for Enter |
| ........................................................ |
| SUBSYSTEMS SUBSYSTEMS <Return> |
| COMMUNICATE WITH USERS COMMUNICATE <Return> |
| MANAGING ACCOUNT, GROUP, ETC. MANAGE <Return> |
| MANAGE DEVICES DEVICES <Return> |
| MANAGE FILES FILES <Return> |
| VARIABLES (AND JCWs) VARS <Return> |
| MANAGE JOBS & SESSIONS JOBSESS <Return> |
| MANAGE RESOURCES RESOURCES <Return> |
| MANAGE THE SPOOLER SPOOLER <Return> |
| MANAGE SYSTEM & USER LOGGING LOGGING <Return> |
| MANAGE VOLUME SETS VOLUMES <Return> |
| SYSTEM PROGRAMMING PROGRAMMING <Return> |
| CREATING AND MANAGING UDCs UDC <Return> |
| LANGUAGES (BASIC, C, FORTRAN) LANGUAGES <Return> |
| DATA COMMUNICATION DATACOMM <Return> |
| ......................................................... |
| |
| You may at any time enter the name of a command to find that topic.|
| You may enter SUMMARY to return to that topic |
| KEYWORDS: SESSIONS, JOBS, MANAGE, FILES, PROGRAMS, DEVICES, UTILITY |
| RESOURCES, OPERATOR, SPOOLER |
| > |
____________________________________________________________________________
* To display the contents of a file named TEST, enter:
:HELP TEST
The system responds by displaying the following:
_______________________________________________
| |
| USER DEFINED COMMAND FILE: TEST.PUB.VOL|
| |
| This is a test file. |
| Additional lines follow... |
_______________________________________________
Related Commands
None
JOB
The JOB command is used in conjunction with the STREAM command. You can
create an input job file that contains the JOB command. This file
defines a batch job that you submit with the STREAM command. The JOB
command initiates the batch processing and must be the first command line
in the job file.
Syntax
JOB [jobname,]username[/userpass].acctname[/acctpass]
[,groupname[/grouppass]] [;INPRI=inputpriority] [;RESTART]
[;HIPRI ]
[;OUTCLASS=[[device][,[outputpriority][,numcopies]]]]
Parameters
jobname Specifies an arbitrary name used with username and
acctname parameters to form a job identity. The
name must contain from one to eight alphanumeric
characters, beginning with an alphabetic character.
The default is that no job name is assigned.
username Specifies your user name, established by your
system administrator, that enables you to log on to
this account. The name must contain from one to
eight alphanumeric characters, beginning with an
alphabetic character.
userpass Specifies your user password, optionally assigned
by your system administrator. The password must
contain from one to eight alphanumeric characters,
beginning with an alphabetic character. If you
have a password but you do not supply it in the
command syntax, the STREAM command prompts for it
if you:
* Enter the STREAM command from a session.
* Do not redirect either $STDIN or $STDLIST.
* Do not nest the JOB command within a
second-level STREAM command. (The JOB
command is specified as a first-level JOB
command.)
acctname Specifies the account name that the system
administrator establishes. The name must contain
from one to eight alphanumeric characters,
beginning with an alphabetic character. A period
(.) must precede this parameter.
acctpass Specifies the account password that the system
administrator can optionally assign. The password
must contain from one to eight alphanumeric
characters, beginning with an alphabetic character.
If a password exists but you do not supply it in
the command syntax, the STREAM command prompts you
for it if you:
* Enter the STREAM command from a session.
* Do not redirect either $STDIN or $STDLIST.
* Do not nest the JOB command within a
second-level STREAM command. (The JOB
command is specified as a first-level JOB
command.)
groupname Specifies the group name to be used for the local
file domain and for CPU-time charges, as
established by the system administrator. The name
must contain from one to eight alphanumeric
characters, beginning with an alphabetic character.
The default is the home group if one is assigned.
This parameter is required if a home group is not
assigned.
grouppass Specifies the group password that the system
administrator optionally assigns. The password
must contain from one to eight alphanumeric
characters, beginning with an alphabetic character.
You do not need the group password when you log on
to your home group. You need it when you log on in
any other group for which a password exists. If a
password is required but you do not supply it in
the command syntax, the STREAM command prompts you
for it if you:
* Enter the STREAM command from a session.
* Do not redirect either $STDIN or $STDLIST.
* Do not nest the JOB command within a
second-level STREAM command. (The JOB
command is specified as a first-level JOB
command.)
INPRI Specifies the input priority of the job. The
inputpriority value is the relative input priority
used to check against access restrictions imposed
by the jobfence. The inputpriority value becomes
effective at logon time and must be from 1 (lowest
priority) to 13 (highest priority). If you supply
a value less than or equal to the current jobfence,
the job is denied access. The default is 8.
HIPRI Overrides the system jobfence, or overrides the job
limit. When using the HIPRI parameter to override
the jobfence, the system first determines whether
you have system manager (SM) or system operator
(OP) capability. If you have either of these
capabilities, you are logged on, and your INPRI
defaults to the system's jobfence and execution
limit. If you do not have either of these
capabilities, the system attempts to log you on
using INPRI=13 and succeeds if the jobfence is 12
or less, and if the job limit is not exceeded.
You can also specify HIPRI to override the job
limit, but you must have either SM or OP
capability. The system does not override the job
limit automatically. If you use the HIPRI
parameter without SM or OP capability, the
following warning message appears:
MUST HAVE 'SM' OR 'OP' CAP. TO SPECIFY HIPRI,
MAXIMUM INPRI OF 13 IS USED (CIWARN 1460)
RESTART Restarts a spooled job that was interrupted by a
system termination/restart. This parameter
automatically becomes effective when the system is
subsequently restarted with the START RECOVERY
option. The effect is to resubmit the job in its
original form. This parameter applies only to jobs
initiated on spooled input devices. The default is
that spooled jobs are not restarted after a system
termination and restart.
OUTCLASS Specifies the output class with one or more of the
following values:
device Indicates the class name or
logical device number (LDEV)
of the device to receive
listing output. You cannot
specify a magnetic tape unit.
If the value is not a valid
LDEV or class name, an error
occurs. The default is
defined in the system
configuration. You can only
supply a device if you have
nonshareable device (ND) file
access capability.
outputpriority Indicates the output priority
for the job list file, if
destined for a spooled line
printer. You can use
outputpriority to select the
next spooled device file (on
disk) for output from among
all those contending for a
specific printer. This
parameter applies only to
output destined for spooled
output devices and is ignored
for other output.
The value must range from 1
(lowest priority) to 13
(highest priority). When
outputpriority is 1, output
is always deferred. To print
output from disk, use an
outputpriority of 2 or
greater. The default is 8.
If spooling logging is
disabled, the default is 13.
numcopies Indicates the number of job
listing copies to be
produced. The numcopies
parameter only applies when
the listing is directed to a
spooled device, and it is
ignored in other cases. The
default value is 1. If the
number of copies is less than
1, a warning appears;
however, the command still
executes with the default
value of 1. If the number of
copies is greater than 127,
an error message appears, and
127 copies are printed.
Operation Notes
* Usage
You can enter this command only from a job file. You cannot enter
it from a session, a job, a program, or in break mode. Pressing
Break does not affect this command.
* Requirements
To properly use this command, you must adhere to the following
requirements:
* Terminate the JOB command with an EOJ command.
* Precede the JOB command and EOJ command with an appropriate
substitute prompt character for the colon prompt. By
default, the system expects you to use an exclamation point
(!).
* Supply your username and accountname. If you omit either
of these parameters or enter them incorrectly, the system
rejects your job and prints error messages on the standard
listing device and the console. Depending on how your
system administrator has set up users on the system, you
may also have to supply a logon group name as well as user,
account, and/or group passwords.
* Command process
If the system accepts your job, the system displays the following
information on the list device:
* job number, as assigned by the system to identify the job
* date and time
* Job number
The job number that the system assigns always uniquely identifies
your job to the system and other users. The system assigns these
numbers in sequential order as jobs are accepted.
Examples
* To create a job file and submit it for processing, do the
following:
1. Enter the following command to invoke the EDIT subsystem:
:EDITOR
2. Enter the ADD command, then add job file commands, as
shown:
/ADD
1 !JOB SMITH,USER.TECH
2 !COMMENT THIS JOB RUNS THE MONTHLY UPDATE PROGRAM
3 !FILE INPUT01=TRANS.DATA.ENGR
4 !FILE MASTER;DEV=TAPE
5 !FILE OUTPUT=NEWFILE.PUB.TECH
6 !RUN UPDPROG
7 !EOJ
8 //
Note that the first command is the JOB command and that an
exclamation point (!) precedes each command.
3. Enter the KEEP and END commands to save your file and
terminate the EDITOR subsystem:
/KEEP MYJOB,UNN
/END
4. Submit the job file for processing by using the STREAM
command:
:STREAM MYJOB
Note that the file MYJOB remains on disk after you stream it.
Consequently, you can stream it again at any time, if desired.
Related Commands
EOJ
JOBFENCE
LIMIT
STREAM
STREAMS
JOBFENCE
The JOBFENCE command defines the minimum input priority that a job or a
session must have in order to execute.
Syntax
JOBFENCE priorityfence
Parameters
priorityfence The number 0 allows a job or session to log on with
any INPRI value. The number 14 prevents all jobs
and sessions from logging on regardless of their
INPRI value. The use of HIPRI as well as the job
and session limits affects the ability of a job or
session to log on.
The system does not process jobs or sessions with
an input priority less than or equal to the
priorityfence until you raise their input priority
with the ALTJOB command or lower the jobfence.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break does not affect this command.
You must enter this command from the console; however, you can
enter this command from your terminal if your system administrator
has used the ALLOW command, which permits you to enter this
command.
* Overriding the jobfence
If you have SM or OP capability, you can override the jobfence
setting by logging on with the HIPRI parameter of the JOB or HELLO
commands. Alternatively, you can log on with an input priority
greater than the jobfence, as indicated by the SHOWJOB command.
Examples
* To defer all non-HIPRI jobs and sessions and then allow waiting
jobs to log on, do the following:
1. Set the jobfence to 14:
:JOBFENCE 14
16:18/#J7/34/DEFERRED JOB INTRODUCED ON LDEV #10
16:18/#J8/35/DEFERRED JOB INTRODUCED ON LDEV #10
2. Enter the SHOWJOB command to display the effect of the new
jobfence:
:SHOWJOB
JOBNUM STATE IPRI JIN JLIST INTRODUCED JOB NAME
#S26 EXEC 20 20 THU 4:17P OPERATOR.SYS
#J7 WAIT D 8 10S 12 THU 4:18P JOB1,FIELD.SUPT
#J8 WAIT D 8 10S 12 THU 4:18P JOB2,FIELD.SUPT
3 JOBS:
0 INTRO
2 WAIT; INCL 2 DEFERRED
1 EXEC; INCL 1 SESSIONS
0 SUSP
JOBFENCE= 14; JLIMIT= 5; SLIMIT=16
3. Reset the jobfence to 6 to allow waiting jobs to log on:
:JOBFENCE 6
16:21/#J7/34/LOGON FOR: JOB1,FIELD.SUPT ON LDEV #10
16:21/#J8/35/LOGON FOR: JOB2,FIELD.SUPT ON LDEV #10
Related Commands
ALTJOB
HELLO
JOB
LIMIT
SHOWJOB
LIMIT
The LIMIT command limits the number of concurrently running jobs or
sessions. Maximum job and session limits are established during system
configuration. Within these limits, the LIMIT command can redefine the
job and session limits.
Syntax
[{numberjobs }]
LIMIT [{,numbersessions }]
[{numberjobs,numbersessions}]
Parameters
numberjobs Specifies the maximum number of jobs.
number- sessions Specifies the maximum number of sessions.
If you do not specify a parameter value, the system displays the current
limits. If you specify one parameter value but not the other, the limit
changes only for the specified parameter.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break does not affect this command.
You must enter this command from the console; however, you can
enter this command from your terminal if your system administrator
has used the ALLOW command, which permits you to enter this
command.
* Priority and nonpriority jobs and sessions
Ordinarily, no new jobs or sessions can exceed the current job and
session limits; however, you can override these limits by using
the HIPRI parameter of the JOB and HELLO commands. You can
specify the HIPRI parameter only if you have SM or OP capability.
You can submit a non-HIPRI job even if the current job limit is
reached, but your job waits until it can log on without exceeding
the job limit.
You cannot log on as a non-HIPRI session after the session limit
is reached. If you attempt to log on, the message CAN'T INITIATE
NEW SESSIONS NOW appears.
* Existing job and session execution
The number of jobs and sessions may already exceed the new limit
that you specify when you enter this command, however, this does
not abort currently executing jobs or sessions. They continue to
execute, but no new jobs enter the executing state, and no new
sessions are initiated.
Examples
* To limit the number of sessions to 13, but retain the current job
limit, enter:
:LIMIT,13
* To limit the number of jobs to 2 and the number of sessions to 15,
enter:
:LIMIT 2,15
The system responds as follows when you enter the SHOWJOB command:
________________________________________________________________
| |
| JOBNUM STATE IPRI JIN JLIST INTRODUCED JOB NAME |
| |
| #S24 EXEC 20 20 TUE 1:54A OPERATOR.SYS |
| #S26 EXEC 177 177 TUE 5:01A FUNKY,RSPOOL.S|
| #S96 EXEC QUIET 35 35 TUE 8:31A SLIDES.SIMON |
| |
| 3 JOBS: |
| 0 INTRO |
| 0 WAIT; INCL 0 DEFERRED |
| 3 EXC; INCL 3 SESSIONS |
| 0 SUSP |
| JOBFENCE= 6; JLIMIT= 2; SLIMIT= 15 |
________________________________________________________________
Note the JLIMIT and SLIMIT fields showing that the new job limit
is 2 and the new session limit is 15.
Related Commands
HELLO
JOB
JOBFENCE
LISTACCT
The LISTACCT command displays information about one or more accounts in
an ASCII format.
Syntax
LISTACCT [acctset][,listfile][;PASS]
Parameters
acctset Specifies the accounts to be listed. The default
is all accounts for those with system manager (SM)
capability. For all others, the default is their
logon account.
You can use wildcard characters to specify certain
types of characters as follows:
* # specifies a single numeric character.
* ? specifies a single alphanumeric
character.
* @ specifies zero or more alphanumeric
characters.
Each wildcard character is counted toward the
eight-character limit for group, account, and file
names.
listfile Specifies the name of the output file. The default
is $STDLIST, a temporary file that cannot be
overwritten by the BUILD command. It is
automatically specified as a new ASCII file with
variable-length records, closed in the temporary
domain, and with user-supplied carriage-control
characters (CCTL), out access mode, and
EXC (exclusive access) option. All other
characteristics are the same as with the FILE
command default specifications.
PASS Permits those with account manager (AM) and system
manager (SM) capability to see the account
password.
Operation Notes
* Usage
You can enter this command from a session, a job, a program, or in
break mode. Pressing Break aborts the execution of this command.
* Restrictions
If you have system manager (SM) capability, you can list any
account and account password on the system. If you have account
manager (AM) capability, you can list only your own account and
its password. If you do not have either SM or AM capability, you
can only list your logon account and cannot display your password.
Example
* To display information, including the password, for an account
named HPXLII, enter:
:LISTACCT HPXLII;PASS
********************
ACCOUNT: HPXLII
DISC SPACE: 754115(SECTORS) PASSWORD: ACCTPASS
CPU TIME : 3330(SECONDS) LOC ATTR: $00000000
CONNECT TIME: 102(MINUTES) SECURITY-- READ : ANY
DISC LIMIT: UNLIMITED WRITE : AC
CPU LIMIT: UNLIMITED APPEND : AC
CONNECT TIME: UNLIMITED LOCK : ANY
MAX PRI: 150 EXECUTE : ANY
GROUP UFID: $00D0001 $80001050 $00138A20 $00000008 $000001FA
USER UFID : $00D4001 $80001050 $00138C20 $00000008 $000001FB
CAP: AM,AL,GL,DI,CV,UV,LG,CS,ND,SF,IA,BA,PH,DS,MR,PM
Related Commands
ALTACCT
LISTGROUP
LISTUSER
NEWACCT
MPE/iX 5.0 Documentation