Skip to content

Commit

Permalink
Merge pull request #10194 from Icinga/docs-extend-ecape-characters
Browse files Browse the repository at this point in the history
docs: Add $ to the escape sequences section
  • Loading branch information
yhabteab authored Oct 21, 2024
2 parents f4e61ef + 9fa438c commit c6de69c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion doc/14-features.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ The current naming schema is defined as follows. The [Icinga Web 2 Graphite modu
depends on this schema.

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$
Expand Down
5 changes: 5 additions & 0 deletions doc/17-language-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@ Character | Escape sequence
--------------------------|------------------------------------
" | \\"
\\ | \\\\
$ | $$
<TAB> | \\t
<CARRIAGE-RETURN> | \\r
<LINE-FEED> | \\n
Expand All @@ -107,6 +108,10 @@ In addition to these pre-defined escape sequences you can specify
arbitrary ASCII characters using the backslash character (\\) followed
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>

Strings spanning multiple lines can be specified by enclosing them in
Expand Down

0 comments on commit c6de69c

Please sign in to comment.