Describes the conventions used in Platform syntax.
The argument is a variable, which must be replaced with a real value you provide.
The argument surrounded by square brackets is optional. Do not enter the 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.
The OR bar separates items in a list. You may only enter one of the items in the list. Do not enter the bar.
You can repeat the item that precedes the ellipsis. You must separate items with a space. Do not enter the ellipsis.
You can repeat the item that precedes the ellipsis. You must separate items with a comma. Do not enter the ellipsis.
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 | -VThe 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.
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.
These are the options that apply to the subcommand. The basic syntax rules apply.