Each XSCF shell command is described in the order of sections below. When there's no relevant description provided, the section itself is omitted.
Section | Description |
| |
|
| ||
NAME | This section gives the names of the XSCF shell commands, | ||
| followed by a brief description of what they do. | ||
SYNOPSIS | This section gives the syntax of commands. | ||
| The use of font style complies with the following rule. | ||
| bold | Enters the command name or the constants as | |
|
| displayed. |
|
| Italic | Substitutes the variables and so forth with the | |
|
| appropriate values when the command executed. | |
| The use of symbols such as parenthesis complies with the | ||
| following rule. |
| |
| [ ] | Brackets. The OPTIONS or OPERANDS enclosed in | |
|
| these brackets can be omitted. Those not enclosed can't | |
|
| be omitted. |
|
| { } | Braces. The OPTIONS or OPERANDS enclosed in these | |
|
| braces are treated as a unit. | |
| Separator. You should specify one of the OPTIONS or | ||
|
| OPERANDS delimited with this symbol "". | |
| ... | Ellipsis. You can specify multiple OPTIONS or | |
|
| OPERANDS just before. | |
DESCRIPTION | This section gives the detailed description such as the | ||
| command function. It describes the behavior after the | ||
| command executed and the content to be displayed. It doesn't | ||
| describe how to specify the OPTIONS or OPERANDS. | ||
Privileges | This section gives the privileges required for command | ||
| execution. In case that what can be executed varies by the user | ||
| privileges, it is described here. |
| |
OPTIONS | This section gives the meaning of and how to specify the | ||
| OPTIONS. In case the OPERANDS required for the OPTIONS, | ||
| it is described here. |
| |
| To specify multiple | ||
| first OPTION followed by the alphabetic part of the second. | ||
| e.g. fmadm | fmadm | |
|
|
|
|
Preface xi