Control Language (CL) Concepts

Command description format

Each command description follows the same format and includes the parts discussed in the following paragraphs. Start of change At the beginning of the command description documentation, there are links to the Parameters, Examples, and Error messages sections. End of change

It should be noted that, because a command is an OS/400(R) object, each command can be authorized for specific users or authorized for use by the public (all users authorized in some way to use the system). Because this is true for nearly every command, it is not stated in each command description. The iSeries Security Reference Link to PDF book contains additional information about IBM(R)-supplied user profiles and the commands authorized for each.

Start of change

Environment and threadsafe classification

At the very top of the command description documentation are environment and threadsafe classifications. Where allowed to run: indicates in which environments the command can be run. Threadsafe: indicates whether a command is threadsafe.

For more details about environment, see Environment. For more details about threadsafe classifications, see Threadsafe classification. End of change

Command description

Start of change The general description of the command follows the environment and threadsafe classification. End of change It briefly explains the function of the command and any relationships it has with a program or with other commands. If there are restrictions on the use of the command, they are described under the heading "Restrictions."

Parameters

Start of change The Parameters section provides a parameter summary table. The parameter summary table shows all the parameters and values that are valid for the command. Possible values are indicated in the Choices column. The default value, as shipped by IBM, is underlined in the Choices column. The default values are used by the system for parameters or parts of parameters that are not coded.

See Parameter summary table for more details. End of change

Parameter descriptions

Start of changeParameter descriptions follow the parameter summary table. Parameter descriptions are presented in the same order as the parameters are listed in the parameter summary table. Each parameter description includes an explanation of the function of the parameter, followed by a description of each possible parameter value. The default parameter value, if there is one, is usually described first and is shown as an underlined heading at the beginning of the text that describes the value. End of change

The description of each parameter explains what the parameter means, what it specifies, and the dependent relationships it has with other parameters in the command. When the parameter has more than one value, the information that applies to the parameter as a whole is covered first, then the specific information for each of the values is described after the name of each value.

Command coding examples

The Examples section provides at least one coded example for the command. Where necessary, several examples are provided for commands with many parameters and several logical combinations.

Start of changeFor clarity, examples are coded in keyword form only. The same examples could be coded either in positional form or in a combination of keyword and positional forms, for commands that support one or more positional parameters. End of change

See Code disclaimer information (page ***) for information pertaining to code examples.

Start of change

Error messages

The Error messages section lists error messages that can be issued for the command. End of change Start of change

Environment

Where allowed to run indicates in which environments the command can be entered. This is the same information that is shown in the output of the Display Command (DSPCMD) command, which reflects what was specified for the ALLOW parameter when the command definition object was created. The "Where allowed to run" value includes the symbolic special values specified for the ALLOW parameter and a brief description that explains the environments where the command is allowed to run.

The majority of commands are created with ALLOW(*ALL); *ALL is also the shipped default value for the ALLOW parameter. In this case, the description will be "All environments (*ALL)".

For commands that must be run interactively, the ALLOW values specified when the command was created are usually (*INTERACT *IPGM *IREXX *EXEC) or (*INTERACT *IPGM *IMOD *IREXX *EXEC). In these two cases, the description shown will be "Interactive environments (*INTERACT *IPGM *IREXX *EXEC)" or "Interactive environments (*INTERACT *IPGM *IMOD *IREXX *EXEC)".

For commands that are created to be run only in a compiled CL or interpreted REXX program, the ALLOW values specified when the command was created are usually (*BPGM *IPGM *BREXX *IREXX) or (*BPGM *IPGM *BMOD *IMOD *BREXX *IREXX). In these two cases, the description shown will be "Compiled CL program or interpreted REXX (*BPGM *IPGM *BREXX *IREXX)" or "Compiled CL or interpreted REXX (*BPGM *IPGM *BMOD *IMOD *BREXX *IREXX)".

If the combination of values specified for the ALLOW parameter when the command was created is not one of the above combinations, a bulleted list is shown that gives a brief description of each value that was specified.

Note: Some command definition objects shipped as part of OS/400(R) are not intended to be used as CL commands. For example, the CMD and PARM command definition objects are used in command definition source. These special-purpose command objects will not have any "Where allowed to run" information. Start of change

Threadsafe classification

The threadsafe classification indicates whether a command is threadsafe. Each command has a threadsafe classification. The three types of threadsafe classifications are as follows:

Note: Some command definition objects shipped as part of OS/400(R) are not intended to be used as CL commands. For example, the CMD and PARM command definition objects are used in command definition source. These special-purpose command objects will not have any "Threadsafe" information.

End of change Start of change

Parameter summary table

The parameter summary table summarizes parameters and values for CL commands. The parameter summary table replaces the syntax diagrams used in past releases.

See the following topics for information about parameter summary table format.

Keyword column

This column shows the parameter keyword name. Every CL command parameter has a keyword name associated with it. When you are viewing the command documentation using a browser, you can click on the keyword name to link to the start of the information for the parameter within the command documentation file.

Description column

This column shows the prompt text defined for the parameter, a parameter qualifier, or a parameter element. Qualifiers are normally used for qualified object names or qualified job names. Elements are used to define multiple input fields for a single parameter. The description for a qualifier or element contains the qualifier or element number within the parameter.

Choices column

This column shows the possible values for the parameter, qualifier, or element.

Notes column

This column shows additional information about each parameter.

End of change


[ Top of Page | Previous Page | Next Page | Table of Contents ]