[Git][NTPsec/ntpsec][master] Documentation polishing.

[Eric S. Raymond]

Eric S. Raymond pushed to branch master at NTPsec / ntpsec


Commits:
23c746f5 by Eric S. Raymond at 2016-12-17T22:25:12-05:00
Documentation polishing.

- - - - -


2 changed files:

- docs/includes/ntpmon-body.txt
- ntpclients/ntpmon


Changes:

=====================================
docs/includes/ntpmon-body.txt
=====================================
--- a/docs/includes/ntpmon-body.txt
+++ b/docs/includes/ntpmon-body.txt
@@ -9,10 +9,10 @@
 == Description ==
 
 This program is a real-time status monitor for NTP.  It presents the
-same information as the 'peers' and 'mrulist' commands of {ntpqman},
-but using a split-window display that also includes a status summary
-bar, and updates at intervals guaranteed to show status changes as
-soon as they occur.
+same information as the 'peers', 'mrulist', 'rv', and 'cv' commands of
+{ntpqman}, but using a split-window display that also includes a
+status summary bar, and updates at intervals guaranteed to show status
+changes almost as soon as they occur.
 
 (Specifically, the display begins updating once per second and
 adjusts itself to poll at twice the frequency of the shortest
@@ -22,14 +22,14 @@ The status bar includes the version string of the server being
 watched, the (local) time at which it was last updated, and the
 current query interval.
 
-^C cleanly terminates the program.
+^C cleanly terminates the program. Any keystroke will trigger a poll
+and update. A few single-keystroke commands are also interpreted as
+commands.
 
 If no hostname is specified on the command line, localhost is monitored.
 
 == Commands ==
 
-A few single-keystroke commands are available.
-
 a:: Change peer display to apeers mode, showing association IDs.
 
 d:: Toggle select mode (some peer will be reverse-video highlighted when on).
@@ -56,7 +56,7 @@ x:: Cleanly terminate the program.
 
 ?:: List these commands.
 
-When no peer is selected, <space> rotates through a/n/o display modes
+When no peer is selected, <space> rotates through a/n/o/p display modes
 for the whole peers list. When a peer is selected, <space> toggles
 detail-display mode.
 


=====================================
ntpclients/ntpmon
=====================================
--- a/ntpclients/ntpmon
+++ b/ntpclients/ntpmon
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # SPDX-License-Identifier: BSD-2-clause
 '''\
-Keystroke commands:
+Any keystroke causes a poll and update. Keystroke commands:
 
 'a': Change peer display to apeers mode, showing association IDs.
 'd': Toggle select mode (some peer will be reverse-video highlighted when on).
@@ -17,7 +17,7 @@ Keystroke commands:
 ' ': Rotate through display modes. 
 '?': Display helpscreen.
 
-When no peer is selected, <space> rotates through a/n/o display modes
+When no peer is selected, <space> rotates through a/n/o/p display modes
 for the whole peers list. When a peer is selected, <space> toggles
 detail-display mode.
 '''



View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/23c746f5099755abb9548475fdab587a0fafe355
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20161218/3de6fda3/attachment.html>