Conventions

In this resource regular monospaced font is used for generic code, monospaced bolt font for Bash reserved keywords and monospaced italic font for parts that must be modified in order to match the actual needs.

As defined in EBNF,1 square brackets [ and ] in regular monospaced font contain an optional part and curled brackets { and } in regular monospaced font an optional part that may be repeated.

 

We use uppercase for constants, as well as for values that are set during the initialisation, and lowercase for variables and function names: ${THIS_IS_A_CONSTANT} and ${that_is_a_variable}. In addition, we always use curled brackets for the value of variables and constants, also when they are optional because separated from the surrounding code.


Note

1
The Extended Backus–Naur Form (EBNF) has been standardised as ISO/IEC 14977:1996. This document is shamefully behind a paywall and its 12 pages cost the incredibly excessive amount of CHF 58, but it is also available for free.

2021-12-21