Synopsis Of The Command

Purpose of the Command

Briefly tell the reader what this command or feature does, and why someone would want to use it. Conclude with a link to a topic that provides more detailed information. Something like this:

For more information, see Detail of Command Purpose.

Syntax

Concisely show the syntax for this command. If it is complex, you may need to include a picture of the syntax diagram. If it is simple, you can show the syntax in text, like this:

If further explanation of the syntax is needed, you can link to a separate page of syntax descriptions.

Options

Briefly list the command's main options, explaining what each provides. If the options are sufficiently complicated, make each item each a link to the part of the "Options" page that fully explains that option. Like this:

• OPTION_A allows you to set AAA.
• OPTION_B allows you to set BBB
• OPTION_C allows you to set CCC

(Of course, if this level of your Online Reference cluster is sufficiently detailed, you can also create separate pages for each option, and link to them individually.)

Examples

Include a list of the available examples. Make this list a menu so the reader can jump directly to the example of interest. Like this:

• Statement of what Example A shows
• Statement of what Example B shows
• Statement of what Example C shows