Syntax

Describes the conventions used in Platform syntax.

Syntax rules

bold

Type the text exactly as shown.

user logoff

italics

The argument is a variable, which must be replaced with a real value you provide.

job_ID

Argument in square brackets [  ]

The argument surrounded by square brackets is optional. Do not enter the brackets.

user list [-l]

Argument in brace brackets {  }

One of the arguments surrounded by square brackets is required. You cannot use both options together in the same command. Do not enter the brackets.

user list {-s | -n processors}

OR bar |

The OR bar separates items in a list. You may only enter one of the items in the list. Do not enter the bar.

config [-h | -V]

Quotes " or '

Double or single quotes must be entered exactly as shown.

"job_ID[index_list]"

Commas ,

Commas must be entered exactly as shown.

-C time0,time1

Ellipsis following an argument ...

You can repeat the item that precedes the ellipsis. You must separate items with a space. Do not enter the ellipsis.

host_name ...

Comma followed by ellipsis ,...

You can repeat the item that precedes the ellipsis. You must separate items with a comma. Do not enter the ellipsis.

host_name[,host_name...]

Parentheses (  )

Parentheses must be entered exactly as shown.

EXCLUDE(exit_code ...)

Subcommand syntax

Commands that have subcommands follow the same syntax rules, but have an additional layer of complexity. The syntax for commands that have subcommands appears as follows:

commandcommand subcommand [options] command -h | -V
command

The command can be issued without any options, usually to open a command shell. From within this command shell, subcommands can be issued without prefacing them with the command, until such time as the command shell is closed. The command can also be issued with subcommands and options in a single string, to open the command shell, perform the action, and close the command shell in a single command string.

subcommand

This is a list of subcommands that can be entered from within the open command shell, or can be prefaced by the command, to open the command shell, perform the action, and close the command shell in a single command string.

options

These are the options that apply to the subcommand. The basic syntax rules apply.