Update documentation.

Refs #5846
This commit is contained in:
Gunnar Beutner 2014-03-24 12:01:56 +01:00
parent 013690e486
commit 05d0d88317

View File

@ -24,8 +24,8 @@ define objects the `object` keyword is used:
Each object is uniquely identified by its type (`Host`) and name Each object is uniquely identified by its type (`Host`) and name
(`host1.example.org`). Objects can contain a comma-separated list of (`host1.example.org`). Objects can contain a comma-separated list of
property declarations. The following data types are available for property declarations. Instead of commas semi-colons may also be used.
property values: The following data types are available for property values:
### Expressions ### Expressions
@ -52,6 +52,9 @@ Example:
Supported suffixes include ms (milliseconds), s (seconds), m (minutes), Supported suffixes include ms (milliseconds), s (seconds), m (minutes),
h (hours) and d (days). h (hours) and d (days).
Duration literals are converted to seconds by the config parser and
are treated like numeric literals.
#### <a id="string-literals"></a> String Literals #### <a id="string-literals"></a> String Literals
A string. A string.
@ -170,7 +173,7 @@ in | "foo" in [ "foo", "bar" ] (true) | Element contained in
!in | "foo" !in [ "bar", "baz" ] (true) | Element not contained in array !in | "foo" !in [ "bar", "baz" ] (true) | Element not contained in array
() | (3 + 3) * 5 | Groups sub-expressions () | (3 + 3) * 5 | Groups sub-expressions
Constants may be used in constant expressions: Constants may be used in expressions:
const MyCheckInterval = 10m const MyCheckInterval = 10m
@ -200,7 +203,7 @@ intersection(array, array, ...) | Returns an array containing all unique element
string(value) | Converts the value to a string. string(value) | Converts the value to a string.
number(value) | Converts the value to a number. number(value) | Converts the value to a number.
bool(value) | Converts to value to a bool. bool(value) | Converts to value to a bool.
log(string) | Writes a message to the log. log(value) | Writes a message to the log. Non-string values are converted to a JSON string.
### <a id="operators"></a> Dictionary Operators ### <a id="operators"></a> Dictionary Operators
@ -353,13 +356,11 @@ override its value by setting it explicitely to `null`.
custom = null custom = null
} }
The same method applies for disabling services defined in the inline `services` The same method applies for disabling services defined in the inline `services`
dictionary by explicitly overriding their value with `null`. dictionary by explicitly overriding their value with `null`.
services["ping6"] = null services["ping6"] = null
### <a id="constants"></a> Constants ### <a id="constants"></a> Constants
Global constants can be set using the `const` keyword: Global constants can be set using the `const` keyword: