This documentation uses the following typographical and keying conventions.
Convention | Meaning |
---|---|
Bold | When referring to graphical user interfaces (GUIs), bold face indicates menus, menu items, labels, buttons, icons, and folders. It also can be used to emphasize command names that otherwise might be confused with the surrounding text. |
Monospace | Indicates text you must enter at a command prompt. Monospace also indicates screen text, code examples, and file excerpts. |
Italics | Indicates variable values that you must provide (for example, you supply the name of a file for fileName). Italics also indicates emphasis and the titles of books. |
Ctrl-x | Where x is the name of a key, indicates a control-character sequence. For example, Ctrl-c means hold down the Ctrl key while you press the c key. |
Return | Refers to the key labeled with the word Return, the word Enter, or the left arrow. |
% | Represents the Linux® and UNIX® command-shell prompt for a command that does not require root privileges. |
# | Represents the Linux and UNIX command-shell prompt for a command that requires root privileges. |
C:\ | Represents the Windows® command prompt. |
Entering commands | When instructed to "enter" or "issue" a command, type the command and then press Return. For example, the instruction "Enter the ls command" means type ls at a command prompt and then press Return. |
[ ] | Enclose optional items in syntax descriptions. |
{ } | Enclose lists from which you must choose an item in syntax descriptions. |
| | Separates items in a list of choices enclosed in { }(braces) in syntax descriptions. |
... | Ellipses in syntax descriptions indicate that you can repeat the preceding item one or more times. Ellipses in examples indicate that information was omitted from the example for the sake of brevity. |