In order to clearly differentiate special words from the text flow, the documentation team uses different renderings. The following table shows examples of each special word or group of words with its actual rendering, as well as its signification.
Formatted Example | Meaning | |
---|---|---|
inode | Used to stress a technical term. | |
ls -lta | Indicates commands or arguments to a command. Applied to commands, options and file names. Also see the section about Section , “Commands Synopsis”. | |
ls(1) | Reference to a man page. To read the page in a shell (or command line), simply type man 1 ls. | |
| We use this formatting for text snapshots of what you may see on your screen. It includes computer interactions, program listings, etc. | |
localhost | This is literal data which does not generally fit in any of the previously defined categories. For example, a key word taken from a configuration file. | |
Apache | Defines application names. The example used (“Apache”) is not a command name. However, in some contexts, the application and command name may be the same but formatted differently. | |
This is used for menu entries or graphical interface labels. The underlined letter indicates the keyboard shortcut, if applicable. | ||
SCSI-Bus | Denotes a computer part or a computer itself. | |
Le petit chaperon rouge | This formatting identifies foreign language words. | |
Warning! | Of course, this is reserved for special warnings in order to stress the importance of words. Read out loud :-) |
This icon highlights a note. Generally, it is a remark which gives additional information about a specific context.
The example below shows the symbols you will see when the writer describes the arguments of a command:
command <non literal argument> [--option={arg1,arg2,arg3}] [optional arg. ...] |
These conventions are standard and you may find them elsewhere such as in the man pages.
The “<” (lesser than) and “>” (greater than) symbols denote a mandatory argument not to be copied verbatim, which should be replaced according to your needs. For example, <filename> refers to the actual name of a file. If this name is foo.txt, you should type foo.txt, not <foo.txt> or <filename>.
The square brackets (“[ ]”) denote optional arguments, which you may or may not include in the command.
The ellipsis (“...”) means an arbitrary number of items can be included.
The curly brackets (“{ }”) contain the arguments authorized at this specific place. One of them is to be placed here.
From time to time, you will be asked to press, for example, the keys Ctrl+R, which means you need to press and hold the Ctrl key and tap the R character as well. The same applies for the Alt and Shift keys.
Also about menus, going to menu item -> (Ctrl+R) means: click on the text displayed on the menu (generally located in the upper-left of the window). Then in the pull-down menu, click on the item. Additionally, you are informed that you can use the Ctrl+R key combination (as described above) to get the same result.