This documentation uses standard conventions for describing the user interface and for alerting you to important information.
Notes are used to alert you to important or helpful information. They use the following format:
Take note. Contains important or helpful information.
Cautions are used to alert you to important information that may help prevent unexpected results or data loss. They use the following format:
Exercise caution. Contains important information that may help prevent unexpected results or data loss.
Warnings are used to alert you to the potential for catastrophic data loss or personal injury. They use the following format:
Be extremely careful and obey all safety and security measures. In this situation you might do something that could result in catastrophic data loss or personal injury.
Tips are used to highlight information that helps to complete a task more efficiently.
This is some information that will allow you to complete your task more efficiently.
Command Syntax and Typeface Conventions
|bold||The bold attribute is used to indicate the following: |
|Command line commands and options (Type |
|In command descriptions, angle brackets represent variables. You must substitute a value for command line arguments that are enclosed in angle brackets.|
|Represent optional keywords or |
|Represent required alternate keywords or |
|Represent optional alternate keywords or variables in a command line description. Choose one command line argument enclosed within the braces, if desired. Choices are separated by vertical (OR) bars.|
|italics||The italic attribute is used for emphasis or to indicate a related document (See the Installation Guide for more information)|