Diffstat (limited to 'doc/ping903q.1')
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/ping903q.1 b/doc/ping903q.1
index cf6172e..9352ca9 100644
@@ -10,13 +10,13 @@
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\" You should have received a copy of the GNU General Public License
.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>.
-.TH PING903Q 1 "March 10, 2020" "PING903Q" "User Commands"
+.TH PING903Q 1 "September 19, 2020" "PING903Q" "User Commands"
ping903q \- ping903 query tool
@@ -48,14 +48,14 @@ information can be requested with the
command line option. When given this option, the program will output
detailed information about round trip times and lost packets.
By default, the program attempts to connect to the default REST API
port of (localhost:8080). If the file
-exists, it will obtain the socket address from the \fBlisten\fR
+exists and contains the \fBlisten\fR statement, the value of this
+statement will be used instead. See
.BR ping903.conf (5),
for detailed description of the configuration file.
.SS Nagios check mode
When the \fB\-H\fR, \fB\-c\fR, and \fB\-w\fR options are used, the
program enters \fINagios check mode\fR. In this mode its output
complies with the requirements for external \fBNagios\fR check
@@ -73,26 +73,26 @@ for a detailed discussion of the file). The file is scanned for
an entry that matches the server name and port (as given in the
\fBlisten\fR statement of the \fBping903.conf\fR file) and the
authorization \fIrealm\fR name presented by the server. If such an
entry is found, the user name and password listed in it will be used
to send the authorized request.
-Using the \fB\-R\fR option, you can force using a specific realm for
+The \fB\-R\fR option allows you to use a specific realm for
authorization. In this case, the \fB.ping903.cred\fR file is scanned
at startup and the credentials found in it are used to authorize the
request, without sending unauthorized request first and consulting the
.SH EXIT CODE
When called with one argument, the program exits with code 0 (success)
if the IP is alive, 2 if it is not, and 3 if the host status is unknown.
When called without arguments, the program exits with code 0 if all
monitored IP addresses are alive, 2 if none of them is reachable and 1
if some of them are.
-Exit codes in nagios check mode:
+In Nagios check mode, exit codes are:
@@ -164,13 +164,13 @@ also that the use of the percent sign is mandatory.
Sets the warning threshold value. See above for the discussion of the
Other options valid in this mode:
-By default hosts in initial state (i.e. for which no data has been
+By default, hosts in initial state (i.e. for which no data has been
collected) are treated as "OK" (exit status 0). This option changes
the default to treat them as "UNKNOWN" (exit status 3).
Supplies the prefix to be displayed before Nagios status string. The
default is "PING". The \fIPREFIX\fR string can contain the
@@ -180,13 +180,14 @@ host being monitored. E.g. \fB\-p 'PING %h'\fR.
Switch to the host match mode.
.SH SEE ALSO
.BR ping903 (8),
.BR ping903.cred (5),
-.BR Nagios <https://www.nagios.org/>.
Copyright \(co 2020 Sergey Poznyakoff
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>