Usage Help Manual Conventions

Conventions Used in Usage Help Documents

Italic

• Indicates new terms URLs, email addresses, filenames and file extensions

Constant width

• Used for program listings, as well as within paragraphs to refer to program elements such as variable or function names. databases data types, environment variables, statements and keywords.

Constant width bold

• Shows commands or other text that should be typed literally by the user.

<Required literal argument>

• Shows required arguments or other text that should be typed literally by the user.

[Optional literal argument]

• Shows optional arguments or other text that should be typed literally by the user.

Constant width italic

• Shows text that should be replaced with user-supplied values or by values determined by context.

<Required argument>

• Required arguments that should be replaced with user-supplied values or by value determined by context

[Optional argument]

• Optional arguments that should be replaced with user-supplied values or by value determined by context.