aboutsummaryrefslogtreecommitdiff
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
parenta9974c3f5be1077909849151c14d01f5eed86576 (diff)
downloadping903-master.tar.gz
ping903-master.tar.bz2
Proof-read the docs.HEADmaster
-rw-r--r--README32
-rw-r--r--doc/ping903.819
-rw-r--r--doc/ping903.conf.526
-rw-r--r--doc/ping903.cred.58
-rw-r--r--doc/ping903q.115
-rwxr-xr-xexamples/dbload2
-rw-r--r--rc/README6
7 files changed, 54 insertions, 54 deletions
diff --git a/README b/README
index 94ec8d9..7de1140 100644
--- a/README
+++ b/README
@@ -50,3 +50,3 @@ After installing the package, copy the file src/ping903.conf to
configuration settings that control the behavior of the server daemon
-and, to a certain extent, that of a query tool. The file contains
+and, to a certain extent, that of the query tool. The file contains
short annotations before each statement to help you navigate through
@@ -88,5 +88,5 @@ called so because it cannot be altered while the program is running.
The REST API allows the user to add any number of IP addresses at
-runtime as well as remove any of IP addresses added this way. These
-addresses form the "mutable" IP list. Mutable IP list is preserved
-across program restarts.
+runtime as well as to remove any of IP addresses added this way.
+These addresses form the "mutable" IP list. Mutable IP list is
+preserved across program restarts.
@@ -104,4 +104,4 @@ monitor. It is OK, however, to use symbolic DNS names, too. If a
hostname resolves to a single A record, such usage is equivalent to
-placing that IP in the ip-list. However, if the hostnames resolves to
-multiple IPs, only first one will be used.
+placing that IP in the ip-list. However, if it resolves to multiple IPs,
+only the first one will be used.
@@ -150,5 +150,5 @@ This should return the running configuration.
-Within the next 'probe-interval' seconds the server will collect
-enough statistics to answer your queries. You can request information
-about any particular IP from your ip-list by running
+Within the first 'probe-interval' seconds after startup, the daemon will
+collect enough statistics to answer your queries. You can request
+information about any particular IP from your ip-list by running
@@ -183,7 +183,7 @@ Please refer to ping903q(1), for a detailed discussion of the tool.
-* System start-up sequence
+* Startup scripts
-To configure ping903 to start automatically at the system start-up,
-see the "rc" subdirectory. It contains start up scripts for various
-flavors of GNU/Linux distributions.
+The package includes startup scripts for several major GNU/Linux
+distributions. Please refer to rc/README for instructions on
+adding ping903 to the operating system startup and shutdown sequences.
@@ -211,8 +211,2 @@ makes use of it:
-* Startup scripts
-
-The package includes startup scripts for several major GNU/Linux
-distributions. Please refer to rc/README for instructions on
-adding ping903 to the operating system startup and shutdown sequences.
-
* Installation from a git clone
diff --git a/doc/ping903.8 b/doc/ping903.8
index 35cbb4a..f8967af 100644
--- a/doc/ping903.8
+++ b/doc/ping903.8
@@ -15,3 +15,3 @@
.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>.
-.TH PING903 8 "March 11, 2020" "PING903" "System Administration"
+.TH PING903 8 "September 19, 2020" "PING903" "System Administration"
.SH NAME
@@ -54,8 +54,9 @@ run-time. The
IP list, in contrast, is maintained via the REST API and thus can be
-changed while the server runs. The content of mutable IP list is
+changed when the server runs. The content of the mutable IP list is
preserved during server restarts.
.PP
-Probes for each IP from the list are initiated periodically, each
+Each
.B probe\-interval
-seconds. Each probe consists of
+seconds, the daemon wakes up and probes each IP from the list. Each
+probe consists of
.B ping\-count
@@ -78,6 +79,6 @@ changed to "inactive".
An \fBHTTP\fR listener thread is responsible for returning the collected
-statistics and serving other requests. By default the program listens
-for queries on localhost, port 8080. If compiled with the support for
-\fBlibwrap\fR, the access to the HTTP interface can be controlled
-using files
+statistics and serving other requests. By default it listens for
+queries on localhost, port 8080. If compiled with the support for
+\fBlibwrap\fR, the access to the HTTP interface is controlled using
+the files
.B /etc/hosts.allow
@@ -148,3 +149,3 @@ logging of each received echo reply, and four options enable verbose
logging of each echo request sent. Notice that three or more
-\fB\-v\fR options can produce huge amount of logs.
+\fB\-v\fR options can produce a huge amount of output.
.SH BUGS
diff --git a/doc/ping903.conf.5 b/doc/ping903.conf.5
index cf3432e..a5e9cc4 100644
--- a/doc/ping903.conf.5
+++ b/doc/ping903.conf.5
@@ -15,3 +15,3 @@
.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>.
-.TH PING903.CONF 5 "March 10, 2020" "PING903.CONF" "File Formats Manual"
+.TH PING903.CONF 5 "September 19, 2020" "PING903.CONF" "File Formats Manual"
.SH NAME
@@ -69,3 +69,3 @@ Name of the file supplying a list of IP addresses (or hostnames) to
monitor. Each IP must be listed on a separate line. Empty lines,
-leading and trailing whitespace is ignored. Comments are introduced
+leading and trailing whitespace are ignored. Comments are introduced
by a hash sign as the first non-whitespace character on the line.
@@ -84,3 +84,3 @@ Multiple \fBip\-list\fR statements of any form accumulate.
\fBprobe\-interval \fIN\fR
-Sets interval between subsequent probes, in seconds. Default is 60
+Sets interval (in seconds) between subsequent probes. Default is 60
(one minute).
@@ -114,3 +114,3 @@ Either \fIIPADDR\fR or \fIPORT\fR (but not both) can be omitted. Missing
colon before \fIPORT\fR must be present). Missing \fIPORT\fR means
-use the default port number (8080).
+the default port number (8080).
@@ -123,3 +123,3 @@ Default is \fB0.0.0.0:8080\fR.
Configures the size of the
-.BR listen(2)
+.BR listen (2)
backlog queue. Default is the platform-dependent value
@@ -129,3 +129,3 @@ backlog queue. Default is the platform-dependent value
\fBaccess\-log \fIBOOL\fR
-Enable apache-style HTTPD access logging. Valid \fIBOOL\fR values are:
+Enables the apache-style HTTP access logging. Valid \fIBOOL\fR values are:
.BR 1 ,
@@ -158,3 +158,3 @@ header is present, its value overrides that IP. If the
header contains a comma-delimited list of IP addresses, this list is
-processed in right-to-left order, until either a not trusted IP or the
+processed from right to left, until either a not trusted IP or the
first IP in the list is encountered, whichever occurs first.
@@ -172,4 +172,4 @@ single CIDR per line.
It is suggested that HTTP entry points be protected by the HTTP
-authorization. This is especially critical for \fB/config\fR and
-below, which allows the requester to modify \fBping903\fR
+authorization. This is especially critical for the \fB/config\fR
+URL and URLs below it, which allow the requester to modify \fBping903\fR
configuration. This version of \fBping903\fR supports HTTP basic
@@ -181,3 +181,3 @@ accessed using the given HTTP \fIMETHOD\fR.
-\fIMETHOD\fR is either one of HTTP methods (\fBGET\fR, \fBPOST\fR,
+\fIMETHOD\fR is either the name of an HTTP method (\fBGET\fR, \fBPOST\fR,
etc.) or a wildcard \fB*\fR matching any method.
@@ -205,3 +205,3 @@ character must be escaped by prefixing it with a backslash.
These parameters are mandatory only for the very first occurrence of the
-\fBauth\fR statements. The statements that follow it may omit the
+\fBauth\fR statement. The statements that follow it may omit the
\fIIPFILE\fR and/or \fIREALM\fR, if they are the same as in the
@@ -223,4 +223,4 @@ Use this statement to exempt an URL from authorization which is
otherwise required for its parent URL. For example, the two
-statements below require basic authorization for "/config", excepting
-"/config/ip-list":
+statements below require basic authorization for "/config", but not
+for "/config/ip-list":
.sp
diff --git a/doc/ping903.cred.5 b/doc/ping903.cred.5
index ede1b2b..2a4203b 100644
--- a/doc/ping903.cred.5
+++ b/doc/ping903.cred.5
@@ -15,3 +15,3 @@
.\" along with Ping903. If not, see <http://www.gnu.org/licenses/>.
-.TH PING903.CRED 5 "March 22, 2020" "PING903.CRED" "File Formats Manual"
+.TH PING903.CRED 5 "September 19, 2020" "PING903.CRED" "File Formats Manual"
.SH NAME
@@ -46,4 +46,4 @@ Specifies the server to which this entry applies. It consists of the
server IP address or DNS name, optionally followed by a colon and port
-number. A wildcard character \fB*\fR can be used in place of the
-either part, in which case this part will match any IP (or port).
+number. Either part can be replaced with a wildcard character
+\fB*\fR, in which case it will match any IP (or port).
@@ -70,3 +70,3 @@ file for an entry with the \fISERVER\fR matching the IP and port of
the server (as configured by the \fBlisten\fR statement in the
-\fB/etc/ping903.conf\fR file) and the \fIREALM\fR filed matching the
+\fB/etc/ping903.conf\fR file) and the \fIREALM\fR field matching the
authorization realm presented by the server. If such an entry is
diff --git a/doc/ping903q.1 b/doc/ping903q.1
index cf6172e..9352ca9 100644
--- a/doc/ping903q.1
+++ b/doc/ping903q.1
@@ -15,3 +15,3 @@
.\" 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
@@ -53,4 +53,4 @@ 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),
@@ -78,3 +78,3 @@ 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
@@ -91,3 +91,3 @@ if some of them are.
.PP
-Exit codes in nagios check mode:
+In Nagios check mode, exit codes are:
.TP
@@ -169,3 +169,3 @@ Other options valid in this mode:
\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
@@ -185,3 +185,4 @@ Switch to the host match mode.
.BR ping903.cred (5),
-.BR Nagios <https://www.nagios.org/>.
+.B Nagios
+<https://www.nagios.org/>.
.SH COPYRIGHT
diff --git a/examples/dbload b/examples/dbload
index 4502d55..f59dee9 100755
--- a/examples/dbload
+++ b/examples/dbload
@@ -61,3 +61,3 @@ use the B<--query> option instead. See below for details.
On success, prints on standard output the number of IP addresses loaded and
-exits with status 0. On error, displays on stabdard error the detailed
+exits with status 0. On error, displays on standard error the detailed
diagnostic information as obtained from the server and exits with status 1.
diff --git a/rc/README b/rc/README
index 40e716e..e3abc05 100644
--- a/rc/README
+++ b/rc/README
@@ -1,2 +1,3 @@
* Overview
+
This directory contains distribution-specific startup scripts for
@@ -7,2 +8,3 @@ COMMAND variable, located at the start of the script.
* debian.rc
+
The start script for Debian-based systems without systemd. Use it on
@@ -19,3 +21,3 @@ Debian 7, Ubuntu up to 16.04, etc.
-Optionally, you may create the file /etc/default/903, which can
+Optionally, you may create the file /etc/default/ping903, which can
define two shell variables:
@@ -30,2 +32,3 @@ define two shell variables:
* ping903.service
+
Service definition for systems with systemd. Usage:
@@ -45,2 +48,3 @@ Service definition for systems with systemd. Usage:
* slackware.rc
+
Slackware rc script. In fact, it is the most general of all and it

Return to:

Send suggestions and report system problems to the System administrator.