Syntax Conventions

Monospaced font

Indicates command names and options, filenames and code samples.

italic font

Indicates variables or placeholders that you replace with a user-defined value or name.

< >

Same as italics. Variables are enclosed in angle brackets in contexts that do not allow italics.

[ ]

Square brackets indicate optional items or parameters.

x | y

A vertical bar separates items in a list of options from which you must select one. If options are not separated by |, you may use combinations.

{ x | y | z }

Items separated by vertical bars and enclosed in braces indicate a choice of required elements.

[ x { y | z } ]

Vertical bars and braces within square brackets indicate a required choice within an optional element.