Added the SysDB homepage to all manpages.

[sysdb.git] / doc / sysdbql.7.txt

diff --git a/doc/sysdbql.7.txt b/doc/sysdbql.7.txt
index a6d7314b41844108c4368b10a1e8c584b1a4ae7e..c4f52a9a8c1110ac3880b7c03b849eeb6b75d991 100644 (file)
--- a/doc/sysdbql.7.txt
+++ b/doc/sysdbql.7.txt
@@ -1,7 +1,5 @@
 sysdbql(7)
 ==========
 sysdbql(7)
 ==========

-Sebastian "tokkee" Harl <sh@tokkee.org>
-version {package_version}, {build_date}

 :doctype: manpage
 
 NAME
 :doctype: manpage
 
 NAME


@@ -69,19 +67,28 @@ are supported by SysDB:
 
 The following fields may be queried:
 
 
 The following fields may be queried:
 

-*host.name*::
+*host*::

        The full name of the host.
 
        The full name of the host.
 

-*service.name*::
+*service*::

        The full service name as referenced by the host.
 
        The full service name as referenced by the host.
 

-*attribute.name*::
+*attribute*::

        The full name of a host attribute.
 
 *attribute.*'<name>'::
        The value of the named host attribute. If an attribute of the specified
        does not exist, each comparison is treated as if the value does not match.
 
        The full name of a host attribute.
 
 *attribute.*'<name>'::
        The value of the named host attribute. If an attribute of the specified
        does not exist, each comparison is treated as if the value does not match.
 

+'<value>' may either be a string (when matching by object names) or match the
+type of the attribute's value (when matching attribute values). Attribute
+values may either be a string, integer, or decimal number (booleans and binary
+data are not supported by the frontend yet).
+
+When comparing an attribute's value using a regular expression matcher, the
+value will be cast to a string before doing so. No other casts are supported
+at this time.
+

 The following operators may be used to match field values:
 
 *=*::
 The following operators may be used to match field values:
 
 *=*::


@@ -99,6 +106,16 @@ The following operators may be used to match field values:
        Evalues to true if the field value does not match the specified regular
        expression.
 
        Evalues to true if the field value does not match the specified regular
        expression.
 

+The following operators may be used, in addition, to match attribute values:
+
+*<*, *\<=*, *>=*, *>*::
+       Evaluates to true if the attribute value is less than, less than or equal
+       to, greater than or equal to or greater than the specified value.
+
+In addition, a named attribute may be check for existence using the *IS NULL*
+and *IS NOT NULL* expressions. An attribute is considered to be *NULL* if it
+is not set for a host.
+

 RESPONSE FORMAT
 ---------------
 The JavaScript Object Notation (JSON) format, as specified in RFC 4627, is
 RESPONSE FORMAT
 ---------------
 The JavaScript Object Notation (JSON) format, as specified in RFC 4627, is


@@ -166,7 +183,9 @@ replies look like. The replies are pretty-printed to more easily follow them.
 
 SEE ALSO
 --------
 
 SEE ALSO
 --------

-*sysdb*(1)
+manpage:sysdb[1], manpage:sysdb[7]
+
+The SysDB homepage: http://sysdb.io/

 
 AUTHOR
 ------
 
 AUTHOR
 ------