[Git][NTPsec/ntpsec][master] 8 commits: Fix a couple typos
Eric S. Raymond
gitlab at mg.gitlab.com
Sun Dec 11 06:39:07 UTC 2016
Eric S. Raymond pushed to branch master at NTPsec / ntpsec
Commits:
9325b6e1 by Richard Laager at 2016-12-10T22:46:07-06:00
Fix a couple typos
- - - - -
c375fcb6 by Richard Laager at 2016-12-10T22:47:00-06:00
Be more consistent with spacing around options
This is another round of fixes, similar to before.
- - - - -
83b462b3 by Richard Laager at 2016-12-10T22:48:59-06:00
Fix missing sntp to ntpdig renames
- - - - -
cf4a2973 by Richard Laager at 2016-12-10T23:31:23-06:00
Rename GNUPLOT to gnuplot
The correct name of the project is all lowercase.
- - - - -
21d9b16d by Richard Laager at 2016-12-10T23:31:27-06:00
Cleanup text around a link
- - - - -
1d8c1704 by Richard Laager at 2016-12-10T23:32:29-06:00
Capitalize GPS and TDOP
- - - - -
dca47b4d by Richard Laager at 2016-12-10T23:32:43-06:00
Capitalize "NTP" in man pages
Since the protocol name is an acronym, it should be capitalized when
standing alone.
- - - - -
d91840c0 by Richard Laager at 2016-12-10T23:32:43-06:00
Improve man page and usage message consistency
- - - - -
11 changed files:
- devel/hacking.txt
- docs/includes/ntpviz-body.txt
- ntpclients/ntpdig
- ntpclients/ntpkeygen
- ntpclients/ntpmon
- ntpclients/ntpq
- ntpclients/ntpsweep
- ntpclients/ntptrace
- ntpclients/ntpviz
- ntpclients/ntpwait-man.txt
- pylib/statfiles.py
Changes:
=====================================
devel/hacking.txt
=====================================
--- a/devel/hacking.txt
+++ b/devel/hacking.txt
@@ -157,7 +157,7 @@ to assume the code will never run on a 16-bit machine. When in doubt,
use the fixed-width integral types from <stdint.h>.
You *may* assume that the compiler supports POSIX 64-bit integral types
-(int64_t, uint64_t and friends) even if the target hardware is 32-bit).
+(int64_t, uint64_t and friends) even if the target hardware is 32-bit.
Do not assume any particular endianness. When in doubt, use
htons()/htonl()/ntohs()/ntohl() and do your bit-bashing in network
@@ -264,7 +264,7 @@ conditions on derived works; we cannot accept such code.
It is your responsibility to make sure you have the necessary rights
to contribute a patch to the project.
-We use the SPDX convention for inclusion by reference You can read
+We use the SPDX convention for inclusion by reference. You can read
about this at
http://spdx.org/licenses
=====================================
docs/includes/ntpviz-body.txt
=====================================
--- a/docs/includes/ntpviz-body.txt
+++ b/docs/includes/ntpviz-body.txt
@@ -31,7 +31,7 @@ ntpviz [-d LOGDIR] [-g] [-n name] [-p DAYS]
This utility analyzes files in an NTP log directory and generates
statistical plots from them. It can output either PNG images or the
-GNUPLOT programs to generate them to standard output. In its default
+gnuplot programs to generate them to standard output. In its default
mode it generates an HTML directory containing an index page and
either (a) all plots, for a single statfiles directory, or (b) a
subset of comparative plots for multiple directories.
@@ -44,7 +44,7 @@ subset of comparative plots for multiple directories.
-g or --generate::
Run plot through gnuplot to make png. The default is to generate
- GNUPLOT programs.
+ gnuplot programs.
-o OUTDIR or --outdir OUTDIR::
Set the directory for all output to be OUTDIR. If OUTDIR does
@@ -96,7 +96,7 @@ subset of comparative plots for multiple directories.
=== Individual Plots ===
The plot options choose what graph is generated; invoke only one. By
-default, the GNUPLOT for the graph is reported; with -g you get the
+default, the gnuplot for the graph is reported; with -g you get the
rendered PNG.
The following plots are available:
@@ -203,13 +203,13 @@ These two ways to invoke ntpviz are equivalent:
== REQUIREMENTS ==
-Python and GNUPLOT. The plots will look better with the 'liberation'
+Python and gnuplot. The plots will look better with the 'liberation'
font package installed.
== AUTHORS ==
-Eric S. Raymond, Gary E. Miller, and Daniel Drown. The GNUPLOT in this
+Eric S. Raymond, Gary E. Miller, and Daniel Drown. The gnuplot in this
package is largely based on templates in Daniel Drown's 'chrony-graph'
-project, https://github.com/ddrown/chrony-graph/tree/ntpd .
+project: https://github.com/ddrown/chrony-graph/tree/ntpd
// end
=====================================
ntpclients/ntpdig
=====================================
--- a/ntpclients/ntpdig
+++ b/ntpclients/ntpdig
@@ -213,7 +213,7 @@ def report(packet, json):
say(" s%d %s\n" % (packet.stratum, packet.leap()))
usage = """
-USAGE: sntp [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
+USAGE: ntpdig [-<flag> [<val>] | --<name>[{=| }<val>]]...
[ hostname-or-IP ...]
Flg Arg Option-Name Description
-4 no ipv4 Force IPv4 DNS name resolution
@@ -234,7 +234,7 @@ USAGE: sntp [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
-s no slew Set (slew) the time with adjtime()
- prohibits the option 'slew'
-t Num timeout Request timeout in seconds (default 5)
- -k Str keyfile Specify a keyfile. SNTP will look in this file
+ -k Str keyfile Specify a keyfile. ntpdig will look in this file
for the key specified with -a
-V no version Output version information and exit
-h no help Display extended usage information and exit
=====================================
ntpclients/ntpkeygen
=====================================
--- a/ntpclients/ntpkeygen
+++ b/ntpclients/ntpkeygen
@@ -1,6 +1,6 @@
#!/usr/bin/env python
#
-# ntpkeygen - program to generate cryptographic keys for ntp clients and servers
+# ntpkeygen - program to generate cryptographic keys for NTP clients and servers
#
# All file names are like "ntpkey_<type>_<hostname>.<filestamp>", where
# <type> is the file type, <hostname> the generating host name and
=====================================
ntpclients/ntpmon
=====================================
--- a/ntpclients/ntpmon
+++ b/ntpclients/ntpmon
@@ -61,7 +61,7 @@ class OutputContext:
curses.endwin()
usage = '''
-USAGE: ntpmon [-anw] [--all] [--numeric] [--wide] [ host ]
+USAGE: ntpmon [-anw] [--all] [--numeric] [--wide] [host]
Flg Arg Option-Name Description
-a no all Show all hosts, not just reachable ones.
-n no numeric numeric host addresses
=====================================
ntpclients/ntpq
=====================================
--- a/ntpclients/ntpq
+++ b/ntpclients/ntpq
@@ -674,7 +674,7 @@ usage: delay [ msec ]
def help_host(self):
self.say("""\
function: specify the host whose NTP server we talk to
-usage: host [ -4|-6 ] [ hostname ]
+usage: host [-4|-6] [hostname]
""")
def do_poll(self, line):
@@ -685,7 +685,7 @@ usage: host [ -4|-6 ] [ hostname ]
def help_poll(self):
self.say("""\
function: poll an NTP server in client mode `n' times
-usage: poll [ n ] [ verbose ]
+usage: poll [n] [verbose]
""")
def do_passwd(self, line):
@@ -698,7 +698,7 @@ usage: poll [ n ] [ verbose ]
def help_passwd(self):
self.say("""\
function: specify a password to use for authenticated requests
-usage: passwd [ ]
+usage: passwd []
""")
def do_hostnames(self, line):
@@ -719,7 +719,7 @@ usage: passwd [ ]
def help_hostnames(self):
self.say("""\
function: specify whether hostnames or net numbers are printed
-usage: hostnames [ yes|no ]
+usage: hostnames [yes|no]
""")
def do_debug(self, line):
@@ -743,7 +743,7 @@ usage: hostnames [ yes|no ]
def help_debug(self):
self.say("""\
function: set/change debugging level
-usage: debug [ no|more|less|n ]
+usage: debug [no|more|less|n]
""")
def do_exit(self, line):
@@ -779,7 +779,7 @@ usage: quit
def help_keyid(self):
self.say("""\
function: set keyid to use for authenticated requests
-usage: keyid [ key# ]
+usage: keyid [key#]
""")
def do_version(self, line):
@@ -832,7 +832,7 @@ usage: cooked
def help_authenticate(self):
self.say("""\
function: always authenticate requests to this server
-usage: authenticate [ yes|no ]
+usage: authenticate [yes|no]
""")
def do_ntpversion(self, line):
@@ -854,7 +854,7 @@ usage: authenticate [ yes|no ]
def help_ntpversion(self):
self.say("""\
function: set the NTP version number to use for requests
-usage: ntpversion [ version number ]
+usage: ntpversion [version number]
""")
def do_keytype(self, line):
@@ -872,7 +872,7 @@ usage: ntpversion [ version number ]
self.say("""\
function: set key type to use for authenticated requests, one of:
DSA, DSA-SHA, MD4, MD5, MDC2, RIPEMD160, SHA, SHA1
-usage: keytype [ digest-name ]
+usage: keytype [digest-name]
""")
def do_associations(self, line):
@@ -990,7 +990,7 @@ usage: showvars
def help_readlist(self):
self.say("""\
function: read the system or peer variables included in the variable list
-usage: readlist [ assocID ]
+usage: readlist [assocID]
""")
def do_rl(self, line):
@@ -1000,7 +1000,7 @@ usage: readlist [ assocID ]
def help_rl(self):
self.say("""\
function: read the system or peer variables included in the variable list
-usage: rl [ assocID ]
+usage: rl [assocID]
""")
def do_writelist(self, line):
@@ -1023,7 +1023,7 @@ usage: writelist [ assocID ]
def help_readvar(self):
self.say("""\
function: read system or peer variables
-usage: readvar [ assocID ] [ varname1 ] [ varname2 ] [ varname3 ]
+usage: readvar [assocID] [varname1] [varname2] [varname3]
""")
def do_rv(self, line):
@@ -1033,7 +1033,7 @@ usage: readvar [ assocID ] [ varname1 ] [ varname2 ] [ varname3 ]
def help_rv(self):
self.say("""\
function: read system or peer variables
-usage: rv [ assocID ] [ varname1 ] [ varname2 ] [ varname3 ]
+usage: rv [assocID] [varname1] [varname2] [varname3]
""")
def do_writevar(self, line):
@@ -1099,20 +1099,20 @@ usage: mrl assocIDlow assocIDhigh
def help_mreadvar(self):
self.say("""\
function: read peer variables from multiple peers
-usage: mreadvar assocIDlow assocIDhigh [ name=value[,...] ]
+usage: mreadvar assocIDlow assocIDhigh [name=value[,...]]
""")
def do_mrv(self, line):
"read peer variables from multiple peers"
if not line:
- self.warn("usage: mrv assocIDlow assocIDhigh [ name=value[,...] ]\n")
+ self.warn("usage: mrv assocIDlow assocIDhigh [name=value[,...]]\n")
return
self.do_mreadvar(line)
def help_mrv(self):
self.say("""\
function: read peer variables from multiple peers
-usage: mrv assocIDlow assocIDhigh [ name=value[,...] ]
+usage: mrv assocIDlow assocIDhigh [name=value[,...]]
""")
def do_clocklist(self, line):
@@ -1125,7 +1125,7 @@ usage: mrv assocIDlow assocIDhigh [ name=value[,...] ]
def help_clocklist(self):
self.say("""\
function: read the clock variables included in the variable list
-usage: clocklist [ assocID ]
+usage: clocklist [assocID]
""")
def do_cl(self, line):
@@ -1135,7 +1135,7 @@ usage: clocklist [ assocID ]
def help_cl(self):
self.say("""\
function: read the clock variables included in the variable list
-usage: cl [ assocID ]
+usage: cl [assocID]
""")
def do_clockvar(self, line):
@@ -1149,7 +1149,7 @@ usage: cl [ assocID ]
def help_clockvar(self):
self.say("""\
function: read clock variables
-usage: clockvar [ assocID ] [ name=value[,...] ]
+usage: clockvar [assocID] [name=value[,...]]
""")
def do_cv(self, line):
@@ -1342,7 +1342,7 @@ usage: config_from_file <configuration filename>
def help_mrulist(self):
self.say("""\
function: display the list of most recently seen source addresses, tags mincount=... resall=0x... resany=0x...
-usage: mrulist [ tag=value ] [ tag=value ] [ tag=value ] [ tag=value ]
+usage: mrulist [tag=value] [tag=value] [tag=value] [tag=value]
""")
def do_ifstats(self, line):
@@ -1558,7 +1558,7 @@ DEFHOST = "localhost" # default host name
#
usage = '''
-USAGE: ntpq [-46dphinOV] [-c str] [-D lvl] [ host ...]
+USAGE: ntpq [-46dphinOV] [-c str] [-D lvl] [host ...]
Flg Arg Option-Name Description
-4 no ipv4 Force IPv4 DNS name resolution
- prohibits the option 'ipv6'
=====================================
ntpclients/ntpsweep
=====================================
--- a/ntpclients/ntpsweep
+++ b/ntpclients/ntpsweep
@@ -1,7 +1,7 @@
#!/usr/bin/env python
"""
-ntpsweep - Print various information about given ntp servers.
-USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile]
+ntpsweep - print various information about given NTP servers
+USAGE: ntpsweep [-<flag> [<val>] | --<name>[{=| }<val>]]... [hostfile]
-l, --host-list=str Host to execute actions on
- may appear multiple times
=====================================
ntpclients/ntptrace
=====================================
--- a/ntpclients/ntptrace
+++ b/ntpclients/ntptrace
@@ -86,8 +86,8 @@ def ntp_read_vars(peer, vars, host):
return outvars
-usage = r"""ntptrace - Trace peers of an NTP server.
-USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [host]
+usage = r"""ntptrace - trace peers of an NTP server
+USAGE: ntptrace [-<flag> [<val>] | --<name>[{=| }<val>]]... [host]
-n, --numeric Print IP addresses instead of hostnames
-m, --max-hosts=num Maximum number of peers to trace
=====================================
ntpclients/ntpviz
=====================================
--- a/ntpclients/ntpviz
+++ b/ntpclients/ntpviz
@@ -6,8 +6,8 @@ ntpviz - logfile visualizer for NTP log files
ntpviz [-d LOGDIR] [-g] [-n name] [-p DAYS]
[-s starttime] [-e endtime]
[-o OUTDIR]
- [ -c | --clip ]
- [ -w SIZE | --width SIZE]
+ [-c | --clip]
+ [-w SIZE | --width SIZE]
[--all-peer-jitters |
--all-peer-offsets |
--local-error |
@@ -28,7 +28,7 @@ ntpviz [-d LOGDIR] [-g] [-n name] [-p DAYS]
See the manual page for details.
-Python by ESR, concept and GNUPLOT code by Dan Drown.
+Python by ESR, concept and gnuplot code by Dan Drown.
"""
#SPDX-License-Identifier: BSD-2-Clause
from __future__ import print_function, division
@@ -278,7 +278,7 @@ class VizStats(ntp.statfiles.NTPStats):
# Investigate.
def gnuplot(template, outfile=None):
- "Run a specified GNUPLOT program."
+ "Run a specified gnuplot program."
if not len( template ):
# silently ignore empty plots
return ''
@@ -378,7 +378,7 @@ set rmargin 10
return plot_data
def local_offset_gnuplot(self):
- "Generate GNUPLOT code graphing local clock loop statistics"
+ "Generate gnuplot code graphing local clock loop statistics"
if not len( self.loopstats):
sys.stderr.write("ntpviz: WARNING: no loopstats to graph\n")
return ''
@@ -438,7 +438,7 @@ file.</p>
return ret
def local_freq_temps_plot(self):
- "Generate GNUPLOT code graphing local frequency and temps"
+ "Generate gnuplot code graphing local frequency and temps"
if not len( self.loopstats):
sys.stderr.write("ntpviz: WARNING: no loopstats to graph\n")
return ''
@@ -522,7 +522,7 @@ file, and field 3 from the temp log .</p>
return ret
def local_temps_gnuplot(self):
- "Generate GNUPLOT code graphing local temperature statistics"
+ "Generate gnuplot code graphing local temperature statistics"
sitename = self.sitename
tempsmap = self.tempssplit()
tempslist = tempsmap.keys()
@@ -573,7 +573,7 @@ component of frequency drift.</p>
return ret
def local_gps_gnuplot(self):
- "Generate GNUPLOT code graphing local gps statistics"
+ "Generate gnuplot code graphing local GPS statistics"
sitename = self.sitename
gpsmap = self.gpssplit()
gpslist = gpsmap.keys()
@@ -581,7 +581,7 @@ component of frequency drift.</p>
if not len( gpsmap) or not len( gpslist):
if 1 <= args.debug_level:
- sys.stderr.write("ntpviz: INFO: no gps data to graph\n")
+ sys.stderr.write("ntpviz: INFO: no GPS data to graph\n")
return ''
stats = []
@@ -680,7 +680,7 @@ line at 0ppm. Expected values of 99%-1% percentiles: 0.4ppm</p>
return ret
def loopstats_gnuplot(self, fld, title, legend, freq):
- "Generate GNUPLOT code of a given loopstats field"
+ "Generate gnuplot code of a given loopstats field"
if not len( self.loopstats):
sys.stderr.write("ntpviz: WARNING: no loopstats to graph\n")
return ''
@@ -745,11 +745,11 @@ plot \
return ret
def local_offset_jitter_gnuplot(self):
- "Generate GNUPLOT code of local clock loop standard deviation"
+ "Generate gnuplot code of local clock loop standard deviation"
return self.loopstats_gnuplot(4, "Local RMS Time Jitter", "Jitter", 0)
def local_offset_stability_gnuplot(self):
- "Generate GNUPLOT code graphing local clock stability"
+ "Generate gnuplot code graphing local clock stability"
return self.loopstats_gnuplot(5, "Local RMS Frequency Jitter",
"Stability", 1)
@@ -1161,7 +1161,7 @@ You can place command line options in a file, one per line.
See the manual page for details.
-Python by ESR, concept and GNUPLOT code by Dan Drown.
+Python by ESR, concept and gnuplot code by Dan Drown.
""")
group = parser.add_mutually_exclusive_group()
@@ -1245,7 +1245,7 @@ Python by ESR, concept and GNUPLOT code by Dan Drown.
default = False,
action="store_true",
dest='show_gps',
- help="Plot gpsd tdop and nSats")
+ help="Plot gpsd TDOP and nSats")
group.add_argument( '--local-jitter',
default=False,
action="store_true",
=====================================
ntpclients/ntpwait-man.txt
=====================================
--- a/ntpclients/ntpwait-man.txt
+++ b/ntpclients/ntpwait-man.txt
@@ -2,7 +2,7 @@
:doctype: manpage
== NAME ==
-ntpwait - Wait for ntpd to stabilize the system clock
+ntpwait - wait for ntpd to stabilize the system clock
include::../docs/includes/ntpwait-body.txt[]
=====================================
pylib/statfiles.py
=====================================
--- a/pylib/statfiles.py
+++ b/pylib/statfiles.py
@@ -1,7 +1,7 @@
"""
statfiles.py - class for digesting and plotting NTP logfiles
-Requires GNUPLOT and liberation fonts installed.
+Requires gnuplot and liberation fonts installed.
"""
#SPDX-License-Identifier: BSD-2-Clause
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/compare/e2ce5325be9535c5a35e8ff3f0b698d0668e8c7a...d91840c013e1e69c67c861716c24e592189a3660
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.ntpsec.org/pipermail/vc/attachments/20161211/cc77451b/attachment.html>
More information about the vc
mailing list