[Git][NTPsec/ntpsec][master] strip header trailers 3
Eric S. Raymond
gitlab at mg.gitlab.com
Mon Feb 4 16:54:08 UTC 2019
Eric S. Raymond pushed to branch master at NTPsec / ntpsec
Commits:
788242b2 by James Browning at 2019-02-04T16:46:04Z
strip header trailers 3
- - - - -
19 changed files:
- docs/includes/manual.adoc
- docs/includes/ntp-conf-body.adoc
- docs/includes/ntp.keys-body.adoc
- docs/includes/ntpd-body.adoc
- docs/includes/ntpdig-body.adoc
- docs/includes/ntpfrob-body.adoc
- docs/includes/ntpkeygen-body.adoc
- docs/includes/ntpleapfetch-body.adoc
- docs/includes/ntploggps-body.adoc
- docs/includes/ntplogtemp-body.adoc
- docs/includes/ntpmon-body.adoc
- docs/includes/ntpq-body.adoc
- docs/includes/ntpsnmpd-body.adoc
- docs/includes/ntpsweep-body.adoc
- docs/includes/ntptime-body.adoc
- docs/includes/ntptrace-body.adoc
- docs/includes/ntpviz-body.adoc
- docs/includes/ntpwait-body.adoc
- docs/includes/ntsd-body.adoc
Changes:
=====================================
docs/includes/manual.adoc
=====================================
@@ -1,4 +1,4 @@
-=== Manual Pages ===
+=== Manual Pages
* link:ntp_conf.html[+ntp.conf(5)+ - ntpd Configuration File]
* link:ntp_keys.html[+ntp.keys(5)+ - NTP symmetric key file format]
=====================================
docs/includes/ntp-conf-body.adoc
=====================================
@@ -2,10 +2,10 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
/etc/ntp.conf
-== DESCRIPTION ==
+== DESCRIPTION
The `ntp.conf` configuration file is read at initial startup by the
{ntpdman} daemon in order to specify the synchronization
@@ -49,7 +49,7 @@ While there is a rich set of options available, the only required
option is one or more `pool`, `server`, `peer`, or `broadcast`
commands.
-== Configuration Support ==
+== Configuration Support
Following is a description of the configuration commands in
NTPv4. There are two classes of commands, association commands that
@@ -57,7 +57,7 @@ configure a persistent association with a remote server or peer or
reference clock, and auxiliary commands that specify environment
variables that control various related operations.
-=== Association Commands ===
+=== Association Commands
Only those options applicable to each command are listed below. Use of
options not listed may not be caught as an error, but may result in
@@ -70,20 +70,20 @@ the IPv6 namespace.
include::../includes/assoc-commands.adoc[]
-=== Association Options ===
+=== Association Options
include::../includes/assoc-options.adoc[]
-=== Association Auxiliary Commands ===
+=== Association Auxiliary Commands
include::../includes/assoc-auxcommands.adoc[]
-=== Authentication Commands ===
+=== Authentication Commands
include::../includes/auth-commands.adoc[]
[[monit]]
-== Monitoring Support ==
+== Monitoring Support
{ntpdman} includes a comprehensive monitoring facility suitable
for continuous, long term recording of server and client timekeeping
@@ -94,11 +94,11 @@ distribution. Using these facilities and UNIX cron(8) jobs, the data
can be automatically summarized and archived for retrospective
analysis.
-=== Monitoring Commands ===
+=== Monitoring Commands
include::../includes/mon-commands.adoc[]
-== Access Control Support ==
+== Access Control Support
The {ntpdman} daemon implements a general purpose address/mask
based restriction list. The list contains address/match entries sorted
@@ -132,7 +132,7 @@ When a client or network is denied access for an indefinite period, the
only way at present to remove the restrictions is by restarting the
server.
-=== The Kiss-of-Death Packet ===
+=== The Kiss-of-Death Packet
Ordinarily, packets denied service are simply dropped with no further
action except incrementing statistics counters. Sometimes a more
@@ -157,18 +157,18 @@ both the client and server. This happens automatically at the client
when the association times out. It will happen at the server only if the
server operator cooperates.
-== Access Control Commands ==
+== Access Control Commands
include::../includes/access-commands.adoc[]
-== Automatic NTP Configuration Options ==
+== Automatic NTP Configuration Options
-=== Manycasting ===
+=== Manycasting
For a detailed description of manycast operation, see the "Server
Discovery" page (available as part of the HTML documentation).
-=== Manycast Options ===
+=== Manycast Options
// This is a subset of the tos options applicable to manycast.
// It omits the more general tinkering options. If you change this,
@@ -202,7 +202,7 @@ Discovery" page (available as part of the HTML documentation).
agreement, _minsane_ should be at least 4 in order to detect and
discard a single falseticker.
-== Reference Clock Support ==
+== Reference Clock Support
For a detailed description of reference-clock configuration, see the
"Reference Clock Drivers" page (available as part of the HTML
@@ -212,11 +212,11 @@ documentation provided in `/usr/share/doc/ntp`).
include::../includes/clock-options.adoc[]
-== Miscellaneous Options ==
+== Miscellaneous Options
include::../includes/misc-options.adoc[]
-== FILES ==
+== FILES
`/etc/ntp.conf`::
the default name of the configuration file
@@ -230,7 +230,7 @@ One of the following exit values will be returned:
1 (EXIT_FAILURE)::
The operation failed or the command syntax was not valid.
-== SEE ALSO ==
+== SEE ALSO
{ntpdman}, {ntpqman}.
@@ -240,7 +240,7 @@ this documentation is available in HTML format in `/usr/share/doc/ntp`.
David L. Mills, _Network Time Protocol (Version 4)_, RFC 5905
-== BUGS ==
+== BUGS
The syntax checking is not picky; some combinations of ridiculous and
even hilarious options and modes may not be detected.
=====================================
docs/includes/ntp.keys-body.adoc
=====================================
@@ -1,4 +1,4 @@
-== DESCRIPTION ==
+== DESCRIPTION
This document describes the format of an NTP symmetric key file. For a
description of the use of this type of file, see the "Authentication
@@ -49,7 +49,7 @@ checked against passwords entered by hand, so it is generally
appropriate to specify these keys in ASCII format. Or you can
cut-paste a hex string from your password manager.
-== USAGE ==
+== USAGE
In order to use symmetric keys, the client side configuration file needs:
-----
@@ -67,7 +67,7 @@ Note that the client and server key files must both contain identical
copies of the line specified by keyno.
-== FILES ==
+== FILES
`/etc/ntp.keys`::
is a common location for the keys file
=====================================
docs/includes/ntpd-body.adoc
=====================================
@@ -2,7 +2,7 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
ntpd
[-46aghLmnNqx] [assert] [-c 'conffile'] [-f 'driftfile']
@@ -11,7 +11,7 @@ ntpd
[-u 'user'[:'group']] [-U 'interface_update_interval']
[-v 'variable'] [-V 'variable'] [server...]
-== DESCRIPTION ==
+== DESCRIPTION
The +ntpd+ utility is an operating system daemon which sets and
maintains the system time of day in synchronism with Internet standard
@@ -53,7 +53,7 @@ monitored using {ntpmonman}.
When +ntpd+ starts it looks at the value of umask(2), and if
zero +ntpd+ will set the umask(2) to 022.
-== OPTIONS ==
+== OPTIONS
+-4+, +--ipv4+::
Force IPv4 DNS name resolution. This option must not appear in
@@ -273,9 +273,9 @@ or hostnames, with the _iburst_ option implied. Associations with
these are formed before any associations implied by the configuration
file.
-== USAGE ==
+== USAGE
-=== How NTP Operates ===
+=== How NTP Operates
The +ntpd+ utility operates by exchanging messages with one or more
configured servers over a range of designated poll intervals. When
@@ -365,7 +365,7 @@ There is a way to start {ntpdman} that often addresses all of
the problems mentioned above.
[[starting]]
-=== Starting NTP (Best Current Practice) ===
+=== Starting NTP (Best Current Practice)
First, use the _iburst_ option on your _server_ and _pool_ entries.
@@ -385,7 +385,7 @@ late as possible in the boot sequence (perhaps with the +-v+ flag) and
after {ntpwaitman} exits successfully it is as safe as it
will ever be to start any processes that require stable time.
-=== Frequency Discipline ===
+=== Frequency Discipline
The +ntpd+ behavior at startup depends on whether the frequency file,
usually _ntp.drift_, exists. This file contains the latest estimate of
@@ -401,7 +401,7 @@ written to it. When the +ntpd+ is started and the file does exist, the
immediately. After that, the current frequency offset is written to the
file at hourly intervals.
-=== Operating Modes ===
+=== Operating Modes
+ntpd+ normally operates continuously while monitoring for small
changes in frequency and trimming the clock for the ultimate
@@ -442,7 +442,7 @@ the +ntpd+ is stopped and run in one-time mode as required. At each
startup, the frequency is read from the file and initializes the kernel
frequency.
-=== Poll Interval Control ===
+=== Poll Interval Control
This version of NTP includes an intricate state machine to reduce the
network load while maintaining a quality of synchronization consistent
@@ -474,7 +474,7 @@ this limit. Once this is done, the drift file is automatically updated
once per hour and is available to initialize the frequency on subsequent
daemon restarts.
-=== The huff-n'-puff Filter ===
+=== The huff-n'-puff Filter
In scenarios where a considerable amount of data are to be downloaded or
uploaded over telephone modems, timekeeping quality can be seriously
@@ -498,7 +498,7 @@ sign of the offset.
The filter is activated by the _tinker_ command and _huffpuff_ keyword,
as described in {ntpdconfman}.
-== FILES ==
+== FILES
[options="header"]
|===================================================================
@@ -528,7 +528,7 @@ Configuration files are parsed according to the following rules:
of their pathnames. Files with other extensions or no extensions
are ignored.
-== SIGNALS ==
+== SIGNALS
SIGQUIT, SIGINT, and SIGTERM will cause ntpd to clean up and exit.
@@ -546,12 +546,12 @@ SIGUSR2 will decrease it by 1. This may be helpful if you are
running with +-n+, either just to see the logging on your screen
or with gdb.
-== BUGS ==
+== BUGS
The '-V' option is not backward-compatible with its use (as the
equivalent of -Z) in older versions.
-== STANDARDS ==
+== STANDARDS
RFC 1059::
David L. Mills, _Network Time Protocol (Version 1)_, RFC 1059
=====================================
docs/includes/ntpdig-body.adoc
=====================================
@@ -2,7 +2,7 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
ntpdig
[--help | -?] [-4 | -6] [-a keynum] [-p samples]
@@ -10,7 +10,7 @@ ntpdig
[-l logfile] [-M steplimit] [-S] [-s]
[--wait] [--no-wait] [--version] [address...]+
-== DESCRIPTION ==
+== DESCRIPTION
ntpdig can be used as an SNTP client to query an NTP or SNTP server and
either display the time or set the local system's time (given suitable
@@ -58,7 +58,7 @@ reports whether ntpdig determined it should have slewed or stepped the
time. This may be shown as true even if time was not actually
adjusted due to lack of clock-setting privileges.
-== OPTIONS ==
+== OPTIONS
+-h, --help+::
Displays usage information and exits.
@@ -181,7 +181,7 @@ If we are not setting the time, wait for all pending responses.
+--version+::
Output version of program and exit.
-== USAGE ==
+== USAGE
+ntpdig ntpserver.somewhere+::
is the simplest use of this program and can be run as an unprivileged
@@ -199,7 +199,7 @@ If we are not setting the time, wait for all pending responses.
synchronized specified server, like the +ntpdate+ utility from older
NTP implementations.
-== COMPATIBILITY ==
+== COMPATIBILITY
Not all options of the NTP classic sntp(1) utility have been retained;
don't expect -b, -K, -o, -r, -w, or -W to work. These have either
@@ -214,7 +214,7 @@ different from that found in sntp(1), tracking the newer formula used
in {ntpdman}. Expect offset computations to match but synch-distances
not to.
-== EXIT STATUS ==
+== EXIT STATUS
One of the following exit values will be returned:
@@ -223,7 +223,7 @@ One of the following exit values will be returned:
1 (EXIT_FAILURE)::
The operation failed or the command syntax was not valid.
-== AUTHORS ==
+== AUTHORS
Johannes Maximilian Kuehn, Harlan Stenn, Dave Hart.
=====================================
docs/includes/ntpfrob-body.adoc
=====================================
@@ -2,11 +2,11 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== Synopsis ==
+== Synopsis
+ntpfrob+ [+-A+] [+-b+ 'bump'] [+-a+ 'tick'] [+-p+ 'ppsdev'] [+-c+] [+-e+] [+-r+] [+-?+] [+-h+]
-== Description ==
+== Description
The ntpfrob program frobs the local clock hardware. It collects
several small diagnostic functions into a set that will differ
@@ -15,7 +15,7 @@ it formerly traveled as +tickadj+ and some undocumented small
utilities.
[[cmd]]
-== Command Line Options ==
+== Command Line Options
+-a+ 'tick'::
Set the kernel variable +tick+ to the value _tick_ specifies.
@@ -46,7 +46,7 @@ utilities.
Print the version string and exit.
[[usage]]
-== Usage ==
+== Usage
Documentation for some of these functions is scanty; this is a problem
inherited from ancient days along with their code. If you suspect you
@@ -62,7 +62,7 @@ The reporting formats of this tool should be considered unstable;
they may change as diagnostics are added or improved. JSON
reports will be kept forward-compatible through changes.
-=== Clock tick adjustment ===
+=== Clock tick adjustment
The -A function reads your clock's tick rate in microseconds. The -a
function sets it. Both rely on the adjtimex(2) system call. This
@@ -74,13 +74,13 @@ The -j option applies to this mode.
Tweaking your tick rate is almost never necessary on hardware new
enough to have a fully POSIX.1-2001-conformant Unix.
-=== Clock bump ===
+=== Clock bump
Sometimes it is diagnostically interesting to perturb your clock
to watch how ntpd responds and makes corrections. This
option does that.
-=== Clock jitter measurement ===
+=== Clock jitter measurement
The -c option can be used to determine the timing jitter due to the
operating system in a gettimeofday() call. For most systems, the
@@ -93,12 +93,12 @@ The -j option applies to this mode. With the -r option, write
the raw, unsorted clock samples to standard output for post-analysis.
All but the last -j or -r option before the -c mode flag is ignored.
-=== Pulse-per-second check ===
+=== Pulse-per-second check
The -p option shows whether the PPS-API (RFC 2783 kernel
PPS interface) finds PPS on a specified device.
-=== Measure clock precision ===
+=== Measure clock precision
The -e option measure the resolution of the system clock, watching how
the current time changes as we read it repeatedly.
=====================================
docs/includes/ntpkeygen-body.adoc
=====================================
@@ -2,11 +2,11 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== Synopsis ==
+== Synopsis
[verse]
+ntpkeygen+ [+-MV+]
-== Description ==
+== Description
This program generates a file containing keys that can be used
in NTP's symmetric key cryptography.
@@ -21,7 +21,7 @@ beyond the scope of NTP itself. The keys can also be used as
passwords for the link:ntpq.html[+ntpq+] utility program.
[[cmd]]
-== Command Line Options ==
+== Command Line Options
+-M+, +--md5key+::
Dummy option for backward compatibility in old scripts. This
@@ -30,7 +30,7 @@ passwords for the link:ntpq.html[+ntpq+] utility program.
Print the version string and exit.
[[run]]
-== Running the program ==
+== Running the program
The simplest way to run the +ntpkeygen+ program is logged in directly as
root. The recommended procedure is to change to the keys directory,
@@ -44,7 +44,7 @@ perform well. Do not run this program from any startup scripts. Only
run this program on an active host with a lot of available entropy.
[[access]]
-== Key file access and location ==
+== Key file access and location
File names begin with the prefix _ntpkey_ and end with the postfix
_hostname.filestamp_, where _hostname_ is the owner name, usually the
@@ -55,7 +55,7 @@ the NTP seconds when the file was generated, in decimal digits.
file. +ntp.keys+ is the normal file used in +ntp.conf+.
[[random]]
-== Random Seed File ==
+== Random Seed File
All key generation schemes must have means to randomize the
entropy seed used to initialize the internal pseudo-random
@@ -72,7 +72,7 @@ os.urandom(). The security of os.urandom() is improved in
https://docs.python.org/library/os.html#os.urandom[Python 3.5+].
[[crypto]]
-== Cryptographic Data Files ==
+== Cryptographic Data Files
Since the file contains private shared keys, it should be visible
only to root or ntp.
=====================================
docs/includes/ntpleapfetch-body.adoc
=====================================
@@ -2,7 +2,7 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
+ntpleapfetch+
[+-46+] [+-c+ 'command'] [+-e+ 'expiry'] [+-f+ 'config'] [+-F+] [+-h+]
@@ -10,7 +10,7 @@
[+-r+ 'retries'] [+-s+ 'source-url'] [+-t+ 'path'] [+-v+] [+-z+ 'path']
[+-Z+] ['leapfile'] [+-V+ | +--version+]
-== DESCRIPTION ==
+== DESCRIPTION
`ntpleapfetch` will validate the file currently on the local system and
if necessary, updates leap second definition file.
@@ -34,7 +34,7 @@ need not be run more frequently than about once every three weeks.
For cron-friendly behavior, define CRONJOB=1 in the crontab.
-== OPTIONS ==
+== OPTIONS
+-4+::
Use only IPv4 addresses for DNS name resolution. This option must not
=====================================
docs/includes/ntploggps-body.adoc
=====================================
@@ -2,7 +2,7 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
ntploggps [-h] [-l LOGFILE] [-o] [-w WAIT] [-v] [-V]
@@ -14,7 +14,7 @@ ntploggps [-h] [-l LOGFILE] [-o] [-w WAIT] [-v] [-V]
-v, --verbose be verbose
-V, --version show program's version number and exit
-== DESCRIPTION ==
+== DESCRIPTION
ntploggps connects to a local gpsd daemon and logs the number of satellites
in use and the Time Dilution of Precision (TDOP). ntploggps can run as
@@ -39,7 +39,7 @@ GPS always output a static TDOP.
+nSat+ is the number of satellites in use.
-== OPTIONS ==
+== OPTIONS
+-h, --help+::
Displays usage information and exits.
@@ -61,7 +61,7 @@ GPS always output a static TDOP.
+-V, --version+::
show program's version number and exit
-== USAGE ==
+== USAGE
+ntploggps+::
This the simplest use of this program. It can be used to check the
@@ -71,7 +71,7 @@ GPS always output a static TDOP.
This will continuously log the gpsd data in the background to the file
/var/log/ntpstats/gpsd. Only log every 60 seconds.
-== EXIT STATUS ==
+== EXIT STATUS
One of the following exit values will be returned:
@@ -80,7 +80,7 @@ One of the following exit values will be returned:
1 (EXIT_FAILURE)::
The operation failed or the command syntax was not valid.
-== AUTHORS ==
+== AUTHORS
Gary E. Miller
=====================================
docs/includes/ntplogtemp-body.adoc
=====================================
@@ -2,7 +2,7 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
ntplogtemp [-h] [-l LOGFILE] [-o] [-w WAIT] [-v] [-V]
@@ -15,7 +15,7 @@ ntplogtemp [-h] [-l LOGFILE] [-o] [-w WAIT] [-v] [-V]
-v, --verbose be verbose
-V, --version show program's version number and exit
-== DESCRIPTION ==
+== DESCRIPTION
ntplogtemp gathers temperature readings across a system. The standard user
is ntpuser and should have permissions to execute lm_sensors and smartctl.
@@ -37,7 +37,7 @@ The log file looks like:
+Value+ is the temperature reading in celsius.
-== OPTIONS ==
+== OPTIONS
+-h, --help+::
Displays usage information and exits.
@@ -61,7 +61,7 @@ The log file looks like:
+-V, --version+::
show program's version number and exit
-== USAGE ==
+== USAGE
+ntplogtemp+::
This the simplest use of this program. It can be used to check the
@@ -71,7 +71,7 @@ The log file looks like:
This will continuously log the temperature data in the background
to the file /var/log/ntpstats/temperature. Only log every 60 seconds.
-== EXIT STATUS ==
+== EXIT STATUS
One of the following exit values will be returned:
@@ -80,7 +80,7 @@ One of the following exit values will be returned:
1 (EXIT_FAILURE)::
The operation failed or the command syntax was not valid.
-== AUTHORS ==
+== AUTHORS
Gary E. Miller
=====================================
docs/includes/ntpmon-body.adoc
=====================================
@@ -2,11 +2,11 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== Synopsis ==
+== Synopsis
+ntpmon+ [-dhnuV] [-D lvl] [-l logfile] [host]
-== Description ==
+== Description
This program is a real-time status monitor for NTP. It presents the
same information as the 'peers', 'mrulist', 'rv', and 'cv' commands of
@@ -43,7 +43,7 @@ And the MRU list in the bottom window:
include::mrufmt.adoc[]
-== Commands ==
+== Commands
a:: Change peer display to apeers mode, showing association IDs.
@@ -81,7 +81,7 @@ x:: Cleanly terminate the program.
?:: Display help screen
-== Options ==
+== Options
-d:: Increase output debug message level
- may appear multiple times
@@ -99,7 +99,7 @@ x:: Cleanly terminate the program.
-V:: Display version and exit.
-== Known Bugs ==
+== Known Bugs
When run in a terminal that does not allow UTF-8 ntpmon will downgrade
its unit display to a non-unicode version. ntpmon has to interact with
=====================================
docs/includes/ntpq-body.adoc
=====================================
@@ -2,11 +2,11 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== Synopsis ==
+== Synopsis
+ntpq+ [+-46adhinpkwWu+] [+-c+ 'command'] ['host'] [...]
-== Description ==
+== Description
The +ntpq+ utility program is used to monitor NTP daemon +ntpd+
operations and determine performance. It uses the standard NTP mode 6
@@ -47,7 +47,7 @@ Techniques] page.
For a simpler near-real-time monitor, see {ntpmonman}.
-== Options ==
+== Options
Command line options are described following. Specifying the command line
options +-c+ or +-p+ will cause the specified query (queries) to be sent
@@ -97,7 +97,7 @@ read interactive format commands from the standard input.
+-u+, +--units+::
Display timing information with units.
-== Internal Commands ==
+== Internal Commands
Interactive format commands consist of a keyword followed by zero to
four arguments. Only enough characters of the full keyword to uniquely
@@ -207,7 +207,7 @@ as following.
+version+::
Print the version of the +ntpq+ program.
-== Control Message Commands ==
+== Control Message Commands
Association IDs are used to identify system, peer and clock variables.
System variables are assigned an association ID of zero and system name
@@ -392,7 +392,7 @@ displayed.
than one way, for example by having both a bad length and an old version.
[[auth]]
-== Authentication ==
+== Authentication
Four commands require authentication to the server: config-from-file,
config, ifstats, and reslist. An authkey file must be in place and
@@ -406,7 +406,7 @@ Credentials once entered, are retained and used for the duration
of your ntpq session.
[[status]]
-== Status Words and Kiss Codes ==
+== Status Words and Kiss Codes
The current state of the operating program is shown in a set of status
words maintained by the system and each association separately. These
@@ -424,7 +424,7 @@ an unusual condition. They are now displayed, when appropriate, in the
reference identifier field in various billboards.
[[system]]
-== System Variables ==
+== System Variables
The following system variables appear in the +rv+ billboard. Not all
variables are displayed in some configurations.
@@ -462,7 +462,7 @@ averages. The system jitter is defined in the NTPv4 specification; the
clock jitter statistic is computed by the clock discipline module.
[[peer]]
-== Peer Variables ==
+== Peer Variables
The following peer variables appear in the +rv+ billboard for each
association. Not all variables are displayed in some configurations.
@@ -498,7 +498,7 @@ association. Not all variables are displayed in some configurations.
|=======================================================================
[[clock]]
-== Clock Variables ==
+== Clock Variables
The following clock variables appear in the +cv+ billboard for each
association with a reference clock. Not all variables are displayed in
@@ -522,7 +522,7 @@ some configurations.
|+flags+ |driver flags
|==========================================
-== Compatibility ==
+== Compatibility
When listing refids, addresses of the form 127.127.x.x are no longer
automatically interpreted as local refclocks as in older versions of
@@ -539,7 +539,7 @@ In older versions, no count of control packets was listed under sysstats.
The +-O+ (+--old-rv+) option of legacy versions has been retired.
-== Known Limitations ==
+== Known Limitations
It is possible for a ":config unpeer" command to fail silently, yielding
"Config Succeeded", if it is given a peer identifier that looks like
=====================================
docs/includes/ntpsnmpd-body.adoc
=====================================
@@ -2,11 +2,11 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== Synopsis ==
+== Synopsis
+ntpsnmpd+ [+-nxdDlhV+] [ntp host]
-== Description ==
+== Description
+[experimental]+
@@ -16,7 +16,7 @@ It functions as a bridge between the Mode 6 protocol used for Network
Time Protocol monitoring, and an SNMP master agent. The user must have
running NTP and SNMP daemons for ntpsnmpd to work.
-== Options ==
+== Options
+-c+ filename, +--configfile+=filename::
Alternate path for the configuration file, /etc/ntpsnmpd.conf by default
@@ -35,12 +35,12 @@ running NTP and SNMP daemons for ntpsnmpd to work.
+-V+, +--version+::
Print the version string and exit.
-== Configuration Files ==
+== Configuration Files
Note that filenames in the options should be enclosed in quotes.
This is a temporary measure that will not be the case in future
versions.
-=== /etc/ntpsnmpd.conf ===
+=== /etc/ntpsnmpd.conf
[[master-addr]]
+master-addr+ _addr_::
@@ -59,7 +59,7 @@ running NTP and SNMP daemons for ntpsnmpd to work.
+loglevel+ _level_::
Threshold for log messages. Equivalent to -D
-=== /var/ntpsnmpd/notify.conf ===
+=== /var/ntpsnmpd/notify.conf
This file is used to store the state of options that can be set
by writing to certain OIDs. Any comments will be overwritten by
ntpsnmpd upon write.
@@ -96,13 +96,13 @@ running NTP and SNMP daemons for ntpsnmpd to work.
+heartbeat-interval+ _interval_::
Frequency of heartbeat notification in integer seconds.
-== Known Limitations ==
+== Known Limitations
This program is still experimental in nature. Parts of the AgentX standard
are not yet fully implemented, logging not fleshed out yet, some options
missing, etc.
-== Known Deviations from RFC 5907 ==
+== Known Deviations from RFC 5907
The ntpEntStatusEntityUptime OID specifies a bizarre time format. This
does not match what the SNMP tools expect to see from a TimeTicks variable.
=====================================
docs/includes/ntpsweep-body.adoc
=====================================
@@ -2,11 +2,11 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== Synopsis ==
+== Synopsis
+ntpsweep+ [+-V+ | +--version+] [+-l+ 'host']... [-p] [+-m+ 'number'] [+-s+ 'prefix'] [+-h+ 'string'] [hostfile...]
-== Description ==
+== Description
`ntpsweep` prints per host the NTP stratum level, the clock offset in
seconds, the daemon version, the operating system and the processor.
@@ -20,7 +20,7 @@ queries. Nowadays effectively all public hosts set _noquery_, so this
script is unlikely to be useful unless you have multiple specially-
configured timeservers on a LAN.
-== Options ==
+== Options
+-l+ string, +--host-list+=_string_::
Host to execute actions on. This option may appear an unlimited number
=====================================
docs/includes/ntptime-body.adoc
=====================================
@@ -2,13 +2,13 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== Synopsis ==
+== Synopsis
[verse]
ntptime [+-chr+] [+-e+ 'est_error'] [+-f+ 'frequency'] [-j]
[+-m+ 'max_error'] [+-o+ 'offset'] [+-s+ 'status']
[+-t+ 'time_constant']
-== Description ==
+== Description
Checks the kernel configuration for the NTP user interface
syscalls +ntp_gettime()+ and +ntp_adjtime()+. If present, the current
@@ -23,7 +23,7 @@ This program is useful only with kernels featuring the ntp_adjtime(2)
system call or local equivalent, as described in the link:kern.html[A
Kernel Model for Precision Timekeeping] page,
-== Options ==
+== Options
+-c+::
Display the execution time of +ntptime+ itself.
@@ -48,7 +48,7 @@ Kernel Model for Precision Timekeeping] page,
+-V+::
Print the version string and exit.
-== Bugs ==
+== Bugs
The format for modes and status in the JSON report is less than ideal.
=====================================
docs/includes/ntptrace-body.adoc
=====================================
@@ -2,7 +2,7 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
+ntptrace+ [+-V+ | +--version+] [+-n+ |+--numeric+]
@@ -10,7 +10,7 @@
[+-r+ 'host' | +--host=+'remote']
'hostname'
-== DESCRIPTION ==
+== DESCRIPTION
+ntptrace+ is a python script that uses the ntpq utility program to
follow the chain of NTP servers from a given host back to the primary
@@ -42,7 +42,7 @@ that the stratum is the server hop count to the primary source, while
the synchronization distance is the estimated error relative to the
primary source. These terms are precisely defined in RFC 1305.
-== OPTIONS ==
+== OPTIONS
+-n+, +--numeric+::
Print IP addresses instead of hostnames.
=====================================
docs/includes/ntpviz-body.adoc
=====================================
@@ -2,7 +2,7 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
ntpviz [OPTIONS]
[-c | --clip]
@@ -31,7 +31,7 @@ ntpviz [OPTIONS]
[@OPTIONFILE]
-== DESCRIPTION ==
+== DESCRIPTION
ntpviz analyzes files in an NTP log directory and generates
statistical plots from them. It can output either PNG images or the
@@ -40,7 +40,7 @@ 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.
-=== Basic Options ===
+=== Basic Options
-c or --clip::
Normally all data are plotted. This option limits the range of
@@ -100,7 +100,7 @@ subset of comparative plots for multiple directories.
's' is for browser on small screens (1024x768). 'm' for medium screens
(1388x768). 'l' for large screens (1920x1080). 'm' is the default.
-=== Individual Plots ===
+=== 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
@@ -183,7 +183,7 @@ The code includes various sanity checks and will bail out with a message
to standard error on, for example, missing logfile data required for a
plot.
-=== Argument File ===
+=== Argument File
Any command line options may also be placed into a command file. The
command file name (OPTIONFILE) is prefixed on the command line with an
@@ -207,12 +207,12 @@ These two ways to invoke ntpviz are equivalent:
--outdir=day
$ ntpviz @day/config
-== REQUIREMENTS ==
+== REQUIREMENTS
Python and gnuplot. The plots will look better with the 'liberation'
font package installed.
-== AUTHORS ==
+== AUTHORS
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'
=====================================
docs/includes/ntpwait-body.adoc
=====================================
@@ -1,8 +1,8 @@
-== SYNOPSIS ==
+== SYNOPSIS
+ntpwait+ [+-vV+] [+-n+ 'number'] [+-s+ 'secs']
-== DESCRIPTION ==
+== DESCRIPTION
The +ntpwait+ program blocks until ntpd is in synchronized state. This
can be useful at boot time, to delay the boot sequence until after "ntpd
@@ -14,7 +14,7 @@ yet produced a synchronized and stable system clock.
+ntpwait+ will do this quietly, unless the +-v+ flag is provided.
-== OPTIONS ==
+== OPTIONS
+-n+ _number_, +--tries+=_number_::
Number of times to check ntpd. This option takes an integer number as
@@ -40,7 +40,7 @@ provide status information, including time to synchronization in seconds.
+-V+, +--version+::
Print the version string and exit.
-== BUGS ==
+== BUGS
If you are running Python at a version older than 3.3, the report on time
to synchronization may be thrown off by NTP clock stepping.
=====================================
docs/includes/ntsd-body.adoc
=====================================
@@ -2,11 +2,11 @@
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
-== SYNOPSIS ==
+== SYNOPSIS
[verse]
ntsd
-== DESCRIPTION ==
+== DESCRIPTION
This is a placeholder for a manual page fully describing the
Network Time Security daemon, which is a work in progress.
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/788242b2f3a9c58ae04d92054815ddd9dc6c78ac
--
View it on GitLab: https://gitlab.com/NTPsec/ntpsec/commit/788242b2f3a9c58ae04d92054815ddd9dc6c78ac
You're receiving this email because of your account on gitlab.com.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ntpsec.org/pipermail/vc/attachments/20190204/2605afb4/attachment-0001.html>
More information about the vc
mailing list