Command documentation format

Command documentation is provided for i5/OS™ commands in the form of online help and information in the iSeries™ Information Center. In the Information Center, each command description follows the same format.

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

It should be noted that, because a command is an i5/OS 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.

• Environment
  At the very top of the command description documentation are environment classification. The environment information describes where the command is allowed to run.
• Threadsafe classification
  The threadsafe classification indicates whether a command is threadsafe. Each command has a threadsafe classification.
• Command description
  The general description of the command follows the environment and threadsafe classification. 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
  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.
• 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.
• Error messages
  The Error messages section lists error messages that can be issued for the command.