tyler.durden
/
icinga2
mirror of https://github.com/Icinga/icinga2.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: Add `$` to the escape sequences section 

feat: Add the `$` character to the escape sequences table.
This commit is contained in:
Yonas Habteab 2024-10-21 12:35:09 +02:00
parent f4e61ef9bd
commit 39337fbeae
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/17-language-reference.md
View File

@ -97,6 +97,7 @@ Character | Escape sequence
--------------------------|------------------------------------ --------------------------|------------------------------------
" | \\" " | \\"
\\ | \\\\ \\ | \\\\
$ | $$
<TAB> | \\t <TAB> | \\t
<CARRIAGE-RETURN> | \\r <CARRIAGE-RETURN> | \\r
<LINE-FEED> | \\n <LINE-FEED> | \\n
@ -107,6 +108,10 @@ In addition to these pre-defined escape sequences you can specify
arbitrary ASCII characters using the backslash character (\\) followed arbitrary ASCII characters using the backslash character (\\) followed
by an ASCII character in octal encoding. by an ASCII character in octal encoding.
In Icinga 2, the `$` character is reserved for resolving [runtime macros](03-monitoring-basics.md#runtime-macros).
However, in situations where a string that isn't intended to be used as a runtime macro contains the `$` character,
it is necessary to escape it with another `$` character.
### Multi-line String Literals <a id="multiline-string-literals"></a> ### Multi-line String Literals <a id="multiline-string-literals"></a>
Strings spanning multiple lines can be specified by enclosing them in Strings spanning multiple lines can be specified by enclosing them in