aboutsummaryrefslogtreecommitdiff
path: root/doc/ping903q.1
diff options
context:
space:
mode:
authorSergey Poznyakoff <gray@gnu.org>2020-09-19 21:24:38 +0300
committerSergey Poznyakoff <gray@gnu.org>2020-09-19 21:24:38 +0300
commit6c0b1a6431540c074920252a3b2a964fe9bdf99b (patch)
tree5c238a011e96674430120259b969cddd1eab09d3 /doc/ping903q.1
parenta9974c3f5be1077909849151c14d01f5eed86576 (diff)
downloadping903-master.tar.gz
ping903-master.tar.bz2
Proof-read the docs.HEADmaster
Diffstat (limited to 'doc/ping903q.1')
-rw-r--r--doc/ping903q.115
1 files changed, 8 insertions, 7 deletions
diff --git a/doc/ping903q.1 b/doc/ping903q.1
index cf6172e..9352ca9 100644
--- a/doc/ping903q.1
+++ b/doc/ping903q.1
@@ -13,7 +13,7 @@
.\"
.\" 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"
.SH NAME
ping903q \- ping903 query tool
.SH SYNOPSIS
@@ -51,8 +51,8 @@ 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
.B /etc/ping903.conf
-exists, it will obtain the socket address from the \fBlisten\fR
-statement. See
+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
@@ -76,7 +76,7 @@ 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.
.PP
-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
@@ -89,7 +89,7 @@ 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.
.PP
-Exit codes in nagios check mode:
+In Nagios check mode, exit codes are:
.TP
.B 0
Success
@@ -167,7 +167,7 @@ arguments.
Other options valid in this mode:
.TP
\fB\-N\fR
-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).
.TP
@@ -183,7 +183,8 @@ Switch to the host match mode.
.SH SEE ALSO
.BR ping903 (8),
.BR ping903.cred (5),
-.BR Nagios <https://www.nagios.org/>.
+.B Nagios
+<https://www.nagios.org/>.
.SH COPYRIGHT
Copyright \(co 2020 Sergey Poznyakoff
.br

Return to:

Send suggestions and report system problems to the System administrator.