common/convention.txt

   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: Read the tips.
  14
  15 Terminal boxes are used to show command lines:
  16
  17 [role="term"]
  18 ----
  19 $ echo Command line as a regular user
  20 # echo Command line as a the `root` user
  21 ----
  22
  23 Command lines which you need to execute as a priviledged user start with
  24 the `#` prompt or with `sudo`. Other command lines start with the `$`
  25 prompt.