| 1 | [[convention]] |
| 2 | === Convention |
| 3 | |
| 4 | Function names, parameter names, variable names, command names, argument |
| 5 | names, file system paths, file names, and other literal strings are |
| 6 | written using a `monospace typeface` in this document. An +_italic_ |
| 7 | word+ within such a block is a placeholder, usually described in the |
| 8 | following sentence. |
| 9 | |
| 10 | Practical tips and notes are given throughout the document using the |
| 11 | following style: |
| 12 | |
| 13 | TIP: Make sure you read the tips. |
| 14 | |
| 15 | Terminal boxes are used to show command lines: |
| 16 | |
| 17 | [role="term"] |
| 18 | ---- |
| 19 | echo This is a terminal box |
| 20 | ---- |
| 21 | |
| 22 | Typical command prompts, like `$` and `#`, are not shown in terminal |
| 23 | boxes to make copy operations easier, especially for multiline commands |
| 24 | which you can copy and paste as is to your terminal. Command lines |
| 25 | which you need to execute as a root user start with cmd:sudo. |