SimpliVity documentation conventions
4
SimpliVity documentation conventions
SimpliVity documentation uses the following conventions to assist your reading.
General formatting
Monospace font
represents a command line syntax, file path, system output, or similar code.
Italic font
represents a user-defined name or variable.
Bold font
represents a user interface element, such as a button or tab, with which a user interacts.
Command Line formatting
SimpliVity documentation uses the following format for CLI commands:
command --option
variable
where
■
command
is the name of the command and should be typed exactly as shown.
■
--option
is a command option and should be typed exactly as shown.
■
variable
is an option variable and should be replaced with the required value.