command syntax

Command-Line Syntax

The following table describes the notation used to specify command-line syntax.

Notation	Description
Text without square or curly brackets	Elements that must be entered exactly as shown.
<Text enclosed in angle brackets>	A placeholder for which you must provide a value.
{Text enclosed in curly brackets}	A set of required alternatives. You must choose one option.
[Text enclosed in square brackets]	Optional elements.
Vertical bar (|)	Separates mutually exclusive alternatives. You must choose one option.

The following examples illustrate the notation.

Example 1

Given the following syntax:

ocl export
    {--file | -f} <file-path>

The parameter after the export command can be either --file or -f, but one of them is required. The following commands are valid:

ocl export --file c:\MyFolder\MyFile.ocl
ocl export -f c:\MyFolder\MyFile.ocl

Example 3

Given the following syntax:

ocl export
    --to-format {csv | excel}

The parameter after the export command must be --to-format. Its value must be either csv or excel. The following commands are valid:

ocl export --to-format csv
ocl export --to-format excel