From 6c0b1a6431540c074920252a3b2a964fe9bdf99b Mon Sep 17 00:00:00 2001 From: Sergey Poznyakoff Date: Sat, 19 Sep 2020 21:24:38 +0300 Subject: Proof-read the docs. --- README | 32 +++++++++++++------------------- 1 file changed, 13 insertions(+), 19 deletions(-) (limited to 'README') diff --git a/README b/README index 94ec8d9..7de1140 100644 --- a/README +++ b/README @@ -48,7 +48,7 @@ discussion of available options to configure and their effect. After installing the package, copy the file src/ping903.conf to /etc/ping903.conf and edit it to your liking. This file contains 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 it. You will find a detailed discussion of the configuration file in the manpage ping903.conf(5). What follows is a short outline, intended @@ -86,9 +86,9 @@ of them in a separate ip-list statement. IP addresses listed in ip-list files form the "immutable" IP list, 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. This means that actually the immutable IP list is optional. You may choose to keep monitored addresses in an external storage (an SQL @@ -102,8 +102,8 @@ from . Normally, the ip-list file should contain IP addresses of the hosts to 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. By default, the server will wake up each minute and send 10 echo requests within 1 second intervals to each registered IP. If the @@ -148,9 +148,9 @@ operational, run 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 ping903q IP @@ -181,11 +181,11 @@ Note, that depending on your settings the output can be huge. 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. * Nagios external check @@ -209,12 +209,6 @@ makes use of it: retry_interval 1 } -* 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 If you are building from a clone of the Git repository, you will need -- cgit v1.2.1