Typographic Conventions¶
Throughout this documentation the authors use conventions to denote certain concepts, information, or actions. The following list gives examples of how to format these items in the documentation.
- Menu Selections
Firewall > Rules
- GUI Item Labels/Names
Destination
- Buttons
Add
- Prompt for input
Proceed?
- Input from the user (text)
Rule Description
- Input from the user (selection)
WAN
- File Names
/boot/loader.conf
- Names of commands or programs
gzip
- Commands Typed at a shell prompt
# ls -l
Long shell command-line examples may be split using the backslash (\) for shell line continuation.
- Command Output
-rw-r--r-- 2 root wheel 887 Apr 12 09:49 .cshrc
- Special Notes
Note
Consider this …
- Warnings
Warning
Watch out!
- Tips
Tip
The best practice is …
- References
See also
For more information …
The list above also servers as an example of a “definition list” used to define sets of terms or options and their meanings.