Typographic Conventions

A percent sign represents the C shell system prompt. A dollar sign represents the system prompt for the Bourne, Korn, and POSIX shells. A number sign represents the superuser prompt.

A manpage. The manpage name is audit, and it is located in Section 5.

A command name or qualified command phrase.

Text displayed by the computer.

A key sequence. A sequence such as Ctrl+x indicates that you must hold down the key labeled Ctrl while you press another key or mouse button.

The name of an environmental variable, for example, PATH.

The name of an error, usually returned in the errno variable.

The name of a keyboard key. Return and Enter both refer to the same key.

The defined use of an important word or phrase.

Commands and other text that you type.

The name of a placeholder in a command, function, or other syntax display that you replace with an actual value.

The contents are optional in syntax. If the contents are separated by |, you can only choose one of the items.

The contents are required in syntax. If the contents are separated by |, you can only choose one of the items.

The preceding element can be repeated an arbitrary number of times.

Indicates the continuation of a code example.

Separates items in a list of choices.

A warning calls attention to important information that if not understood or followed will result in nonrecoverable system problems.

A caution calls attention to important information that if not understood or followed will result in data loss, data corruption, or damage to hardware or software.

An important alert provides essential information to explain a concept or to complete a task

A note contains additional information to emphasize or supplement important points of the main text.