Merge pull request #10194 from Icinga/docs-extend-ecape-characters

docs: Add $ to the escape sequences section
This commit is contained in:
Yonas Habteab 2024-10-21 14:19:35 +02:00 committed by GitHub
commit c6de69cfe4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 6 additions and 1 deletions

View File

@ -106,7 +106,7 @@ The current naming schema is defined as follows. The [Icinga Web 2 Graphite modu
depends on this schema. depends on this schema.
The default prefix for hosts and services is configured using The default prefix for hosts and services is configured using
[runtime macros](03-monitoring-basics.md#runtime-macros)like this: [runtime macros](03-monitoring-basics.md#runtime-macros) like this:
``` ```
icinga2.$host.name$.host.$host.check_command$ icinga2.$host.name$.host.$host.check_command$

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