[ntpsec commit] In the documentation, more name parameterization by attributes.
Eric S. Raymond
esr at ntpsec.org
Tue Oct 6 20:07:47 UTC 2015
Module: ntpsec
Branch: master
Commit: fd9a4aaff7fd0b85f09f9eb38c6178041368773b
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=fd9a4aaff7fd0b85f09f9eb38c6178041368773b
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Tue Oct 6 14:20:22 2015 -0400
In the documentation, more name parameterization by attributes.
---
docs/asciidoc.conf | 3 +-
docs/authentic.txt | 6 +--
docs/authopt.txt | 6 +--
docs/autokey.txt | 32 ++++++------
docs/build.txt | 2 +-
docs/debug.txt | 2 +-
docs/driver20.txt | 1 +
docs/driver27.txt | 45 ++++++-----------
docs/driver29.txt | 6 +--
docs/driver40.txt | 16 +++---
docs/includes/manual.txt | 10 ++--
docs/includes/misc.txt | 2 +-
docs/index.txt | 6 +--
docs/kern.txt | 2 +-
docs/keygen-body.txt | 44 ++++++++--------
docs/keygen.txt | 2 +-
docs/miscopt.txt | 2 +-
docs/msyslog.txt | 2 +-
docs/ntp-wait.txt | 6 +--
docs/ntpd-body.txt | 12 ++---
docs/ntpdsim.txt | 6 +--
docs/ntptime-body.txt | 4 +-
docs/quick.txt | 2 +-
docs/refclock.txt | 2 +-
docs/sntp-body.txt | 38 +++++++-------
docs/sntp.txt | 2 +-
ntpd/ntp.conf.txt | 94 ++++++++++++++---------------------
ntpd/ntp.keys.txt | 6 +--
scripts/calc_tickadj/calc_tickadj.txt | 12 ++---
scripts/ntp-wait/ntp-wait.txt | 18 +++----
scripts/ntpsweep/ntpsweep.txt | 2 +-
scripts/summary.txt | 6 +--
scripts/update-leap/update-leap.txt | 8 +--
33 files changed, 187 insertions(+), 220 deletions(-)
diff --git a/docs/asciidoc.conf b/docs/asciidoc.conf
index 33a9fed..73399aa 100644
--- a/docs/asciidoc.conf
+++ b/docs/asciidoc.conf
@@ -15,11 +15,12 @@ project-bug-list=bugs at ntpsec.org
project-bugengine=Bugzilla
project-bugtracker="NTPsec"
millshome=http://www.eecis.udel.edu/~mills/
+ntp=ntp
ntpd=ntpd
ntpdconf=ntpd.conf
ntpkeys=ntp.keys
ntpq=ntpq
-ntptime=ntp-time
+ntptime=ntptime
ntpwait=ntp-wait
sntp=sntp
ntpconfman=ntp.conf(5)
diff --git a/docs/authentic.txt b/docs/authentic.txt
index aae64d6..84ee1ca 100644
--- a/docs/authentic.txt
+++ b/docs/authentic.txt
@@ -87,7 +87,7 @@ symmetric key cryptography, since the security is based on private and
public values which are generated by each participant and where the
private value is never revealed. Autokey uses X.509 public certificates,
which can be produced by commercial services, the OpenSSL application
-program, or the link:keygen.html[`ntp-keygen`] utility program in the
+program, or the link:keygen.html[`{ntpkeygen}`] utility program in the
NTP software distribution.
Note that according to US law, NTP binaries including OpenSSL library
@@ -100,7 +100,7 @@ US.
Authentication is configured separately for each association using the
`key` or `autokey` option of the `server` configuration command, as
described in the link:confopt.html[Server Options] page. The
-link:keygen.html[ntp-keygen] page describes the files required for the
+link:keygen.html[{ntpkeygen}] page describes the files required for the
various authentication schemes. Further details are in the briefings,
papers and reports at the {project-shortname} project page linked from
{project-weblink}.
@@ -146,7 +146,7 @@ distributed and stored using secure means beyond the scope of the NTP
protocol itself. Besides the keys used for ordinary NTP associations,
additional keys can be used as passwords for the `{ntpq}`
utility program. Ordinarily, the `{ntpkeys}` file is generated by the
-`ntp-keygen` program, but it can be constructed and edited using an
+`{ntpkeygen}` program, but it can be constructed and edited using an
ordinary text editor.
Each line of the keys file consists of three fields: a key ID in the
diff --git a/docs/authopt.txt b/docs/authopt.txt
index 27374c0..3aa5a86 100644
--- a/docs/authopt.txt
+++ b/docs/authopt.txt
@@ -72,13 +72,13 @@ than to change the cryptographic media file names.#
`pw` 'password';;
Specifies the password to decrypt files previously encrypted by the
- `ntp-keygen` program with the `-p` option. If this option is not
+ `{ntpkeygen}` program with the `-p` option. If this option is not
specified, the default password is the string returned by the Unix
`gethostname()` routine.
`randfile` 'file';;
Specifies the location of the random seed file used by the OpenSSL
library. The defaults are described on the
- link:keygen.html[`ntp-keygen` page].
+ link:keygen.html[`{ntpkeygen}` page].
`ident` 'group'::
Specifies the group name for ephemeral associations mobilized by
broadcast and symmetric passive modes. See the
@@ -88,7 +88,7 @@ than to change the cryptographic media file names.#
Specifies the complete directory path for the key file containing the
key IDs, key types and keys used by `{ntpd}` and `{ntpq}` when
operating with symmetric key cryptography. The format of the keyfile
- is described on the link:keygen.html[`ntp-keygen` page]. This is the
+ is described on the link:keygen.html[`{ntpkeygen}` page]. This is the
same operation as the `-k` command line option. Note that the
directory path for Autokey cryptographic media is specified by the
`keysdir` command.
diff --git a/docs/autokey.txt b/docs/autokey.txt
index 41e45ce..756f63b 100644
--- a/docs/autokey.txt
+++ b/docs/autokey.txt
@@ -88,7 +88,7 @@ symmetric key or public key cryptography.
Autokey uses industry standard X.509 public certificates, which can be
produced by commercial services, utility programs in the OpenSSL
-software library, and the link:keygen.html[`ntp-keygen`] utility program
+software library, and the link:keygen.html[{ntpkeygen}] utility program
in the NTP software distribution. A certificate includes the subject
name of the client, the issuer name of the server, the public key of the
client and the time period over which the the public and private keys
@@ -190,7 +190,7 @@ In some configurations where more than one subnet shares an Ethernet or
when multiple subnets exist in a manycast or pool configuration, it is
useful to isolate one subnet from another. In Autokey this can be done
using group names. An Autokey host name is specified by the
-`-s`` host at group` option of the `ntp-keygen` program, where _`host`_ is
+`-s`` host at group` option of the {ntpkeygen} program, where _`host`_ is
the host name and _`group`_ is the group name. If _`host`_ is omitted,
the name defaults to the string returned by the Unix `gethostname()`
routine, ordinarily the DNS name of the host. Thus, for host
@@ -212,7 +212,7 @@ applies to all hosts sharing a common broadcast, manycast or symmetric
passive modes, while the latter case applies to each individual
client/server or symmetric active mode association. In either case the
host listens to the specified group name in addition to the group name
-specified in the `-s` option of the `ntp-keygen` program.
+specified in the `-s` option of the `{ntpkeygen}` program.
[[secure]]
== Secure Groups ==
@@ -264,7 +264,7 @@ which usually contains a subset of the keys file.
Figure 2 shows how keys and parameters are distributed to servers and
clients. A TA constructs the encrypted keys file and the nonencrypted
parameters file. Hosts with no dependent clients can retrieve client
-parameter files from an archive or web page. The `ntp-keygen` program
+parameter files from an archive or web page. The `{ntpkeygen}` program
can export parameter files using the `-e` option. By convention, the
file name is the name of the secure group and must match the `ident`
option of the `crypto` command or the `ident` option of the `server`
@@ -272,9 +272,9 @@ command.
When more than one TH Is involved in the secure group, it is convenient
for the TAs and THs to use the same encrypted key files. To do this, one
-of the parent TAs includes the `-i group` option on the `ntp-keygen`
+of the parent TAs includes the `-i group` option on the `{ntpkeygen}`
command line, where _`group`_ is the name of the child secure group. The
-`ntp-keygen` program can export server keys files using the `-q` option
+`{ntpkeygen}` program can export server keys files using the `-q` option
and a chosen remote password. The files are installed on the TAs and
then renamed using the name given as the first line in the file, but
without the filestamp. The secure group name must match the `ident`
@@ -314,14 +314,14 @@ Referring to Figure 1, for each TH, A, B, R and X, as root:
["literal",subs="normal"]
`# cd /usr/local/etc`
-`# ntp-keygen -T`
+`# {ntpkeygen} -T`
and for the other hosts the same commands without the `-T` option. This
generates an RSA private/public host key file and a self-signed
certificate file for the RSA digital signature algorithm with the MD5
message digest algorithm. For the THs a trusted certificate is
generated; for the others a nontreusted certificate is generated.
-Include in the `ntp.conf` configuration file for all hosts other than
+Include in the `{ntpconf}` configuration file for all hosts other than
the primary servers, A, B and R, something like
["literal",subs="normal"]
@@ -338,12 +338,12 @@ returned by the Unix `gethostname()` routine, ordinarily the DNS name of
the host. This name is used as the subject and issuer names on the
certificate, as well as the default password for the encrypted keys
file. The host name can be changed using the `-s` option of the
-`ntp-keygen` program. The default password can be changed using the `-p`
-option of the `ntp-keygen` program and the `pw` option of the `crypto`
+`{ntpkeygen}` program. The default password can be changed using the `-p`
+option of the `{ntpkeygen}` program and the `pw` option of the `crypto`
configuration command.
Group names can be added to this configuration by including the
-`-s host at group` option with the `ntp-keygen` program. For the purpose of
+`-s host at group` option with the `{ntpkeygen}` program. For the purpose of
illustration, the `host` string is empty, signifying the default host
name. For example, @`yellow` can be used for the Alice group, @`orange`
for the Helen group and @`blue` for the Carol group. In addition, for TH
@@ -361,19 +361,19 @@ with the subnets of Figure 1 configured as in the previous section.
Recall that the parent subnet TA for Alice is C and for Helen is S. Each
of the TAs generates an encrypted server keys file and nonencrypted
client parameters file for the IFF identity scheme using the `-I` option
-of the `ntp-keygen` program. Note the TAs are not necessarily trusted
+of the `{ntpkeygen}` program. Note the TAs are not necessarily trusted
hosts, so may not need the `-T` option.
The nonencrypted client parameters can be exported using the command
-`ntp-keygen -e >file`,
+`{ntpkeygen} -e >file`,
where the `-e` option redirects the client parameters to _`file`_ via
the standard output stream for a mail application or stored locally for
later distribution to one or more THs. In a similar fashion the
encrypted keys file can be exported using the command
-`ntp-keygen -q passw2 >file`,
+`{ntpkeygen} -q passw2 >file`,
where _`passwd2`_ is the read password for another TA. We won't need
this file here.
@@ -454,7 +454,7 @@ digest schemes or identity schemes and must be corrected by installing
the correct media and/or correcting the configuration file. One of the
most common errors is expired certificates, which must be regenerated
and signed at least once per year using the
-link:keygen.html[`ntp-keygen` - generate public and private keys]
+link:keygen.html[`{ntpkeygen}` - generate public and private keys]
program.
The following error codes are reported via the NTP control and
@@ -501,7 +501,7 @@ file if configured.
[[files]]
== Files ==
-See the link:keygen.html[`ntp-keygen`] page. Note that provisions to
+See the link:keygen.html[`{ntpkeygen}`] page. Note that provisions to
load leap second values from the NIST files have been removed. These
provisions are now available whether or not the OpenSSL library is
available. However, the functions that can download these values from
diff --git a/docs/build.txt b/docs/build.txt
index fc2dbd5..da9a303 100644
--- a/docs/build.txt
+++ b/docs/build.txt
@@ -90,7 +90,7 @@ help or money so we can hire skilled technical help.
== Configuration ==
You are now ready to configure the daemon. You will need to create a NTP
-configuration file by default in `/etc/ntp.conf.` Newbies should see the
+configuration file by default in `/etc/{ntpconf}.` Newbies should see the
link:quick.html[Quick Start] page for orientation. Seasoned veterans can
start with the link:ntpd.html[`{ntpd}` - Network Time Protocol (NTP)
daemon] page and move on to the specific configuration option pages from
diff --git a/docs/debug.txt b/docs/debug.txt
index c324e61..3a7f193 100644
--- a/docs/debug.txt
+++ b/docs/debug.txt
@@ -201,7 +201,7 @@ cryptography servers and clients share session keys contained in a
secret key file In public key cryptography, which requires the OpenSSL
software library, the server has a private key, never shared, and a
public key with unrestricted distribution. The cryptographic media
-required are produced by the link:keygen.html[`ntp-keygen`] program.
+required are produced by the link:keygen.html[`{ntpkeygen}`] program.
Problems with symmetric key authentication are usually due to mismatched
keys or improper use of the `trustedkey` command. A simple way to check
diff --git a/docs/driver20.txt b/docs/driver20.txt
index d0faa31..c1fec43 100644
--- a/docs/driver20.txt
+++ b/docs/driver20.txt
@@ -184,6 +184,7 @@ example:
Sentences like $GPGSV that don't contain the time will get counted in
the total but otherwise ignored.
+//FIXME: ntp.org reference
https://support.ntp.org/bin/view/Support/ConfiguringNMEARefclocks[Configuring
NMEA Refclocks] might give further useful hints for specific hardware
devices that exhibit strange or curious behaviour.
diff --git a/docs/driver27.txt b/docs/driver27.txt
index 1a8f295..812c3ed 100644
--- a/docs/driver27.txt
+++ b/docs/driver27.txt
@@ -7,7 +7,6 @@ Address: 127.127.27.'u'
Reference ID: MSFa | MSF | DCF
Driver ID: MSF_ARCRON
Serial Port: /dev/arc__u__; 300bps, 8N2
-Features: `tty_clk`
== Deprecation warning ==
@@ -24,36 +23,15 @@ This driver supports the Arcron MSF, DCF and WWVB receivers. The clock
reports its ID as `"MSFa"`, `"MSF"`, `"DCF"` to indicate
the time source.
-This documentation describes v1.3 (2003/2/21) of the source and has been
-tested against ntpd 4.1.0 on linux x86. Changes from v1.1 and v1.2
-include patches to work with the new ntp-4 code, clock support for DCF
-and WWVB configurable via mode flag, an option to ignore resync request
-(for those of us at the fringes of the WWVB signal, for instance),
-averaging of the signal quality poll and several bug fixes, code cleanup
-and standardizations. In all other respects, the driver works as per
-v1.1 if a mode is not specified.
-
To use the alternate modes, the mode flag must be specified. If the mode
flag is 0, or unspecified, the original MSF version is assumed. This
should assure backwards compatibility and should not break existing
setups.
-This code has been significantly slimmed down since the V1.0 version,
-roughly halving the memory footprint of its code and data.
-
This driver is designed to allow the unit to run from batteries as
designed, for something approaching the 2.5 years expected in the usual
stand-alone mode, but no battery-life measurements have been taken.
-Much of this code is originally from the other refclock driver files
-with thanks. The code was originally made to work with the clock by
-mailto:derek at toybox.demon.co.uk[Derek Mulcahy], with modifications by
-mailto:d at hd.org[Damon Hart-Davis]. Thanks also to
-mailto:lyndond at sentinet.co.uk[Lyndon David] for some of the
-specifications of the clock. mailto:palfille at partners.org[Paul Alfille]
-added support for the WWVB clock. mailto:cprice at cs-home.com[Christopher
-Price] added enhanced support for the MSF, DCF and WWVB clocks.
-
There is support for a Tcl/Tk monitor written by Derek Mulcahy that
examines the output stats; see the
http://www2.exnet.com/NTP/ARC/ARC.html[ARC Rugby MSF Receiver] page for
@@ -64,12 +42,12 @@ http://www.atomictime.com/Product17.html[Atomic Time PC].
Look at the notes at the start of the code for further information; some
of the more important details follow.
-The driver interrogates the clock at each poll (ie every 64s by default)
+The driver interrogates the clock at each poll (ie every 64sec by default)
for a timestamp. The clock responds at the start of the next second
(with the start bit of the first byte being on-time). In the default or
original MSF mode, the time is in `local' format, including the daylight
savings adjustment when it is in effect. The driver code converts the
-time back to UTC. In modes 1-3 the driver can be configured for UTC or
+time back to UTC. In modes 1-2 the driver can be configured for UTC or
local time depending on the setting of flag1.
The clock claims to be accurate to within about 20ms of the broadcast
@@ -129,7 +107,7 @@ unsuccessful, so the initial timestamps will be close to reality, even
if with up to a day's clock drift in the worst case (the clock by
default resyncs to MSF once per day).
-When alternate modes 1-3 are selected, the driver can be configured to
+When alternate modes 1 or 2 are selected, the driver can be configured to
ignore the resync requests by setting `flag2` to 1. This allows clocks
at the fringe of the signal to resync at night when signals are
stronger.
@@ -396,7 +374,7 @@ May 10 12:41:34 oolong ntpd[615]: ARCRON: sync finished, signal quality 3: OK, w
== Fudge Factors ==
-`mode 0 | 1 | 2 | 3`::
+`mode 0 | 1 | 2`::
Specifies the clock hardware model. This parameter is optional, it
defaults to the original mode of operation.
+
@@ -407,8 +385,6 @@ Supported modes of operation:
1 - Updated MSF
+
2 - New DCF77
-+
-3 - New WWVB
`time1` 'time'::
Specifies the time offset calibration factor, in seconds and fraction,
@@ -435,9 +411,20 @@ Supported modes of operation:
`flag3 0 | 1`::
If set to 1, better precision is reported (and thus lower dispersion)
while clock's received signal quality is known to be good.
-`flag4 0 | 1`
+`flag4 0 | 1`::
Not used by this driver.
+== Authors ==
+
+Much of this code is originally from the other refclock driver files
+with thanks. The code was originally made to work with the clock by
+mailto:derek at toybox.demon.co.uk[Derek Mulcahy], with modifications by
+mailto:d at hd.org[Damon Hart-Davis]. Thanks also to
+mailto:lyndond at sentinet.co.uk[Lyndon David] for some of the
+specifications of the clock. mailto:palfille at partners.org[Paul Alfille]
+added support for the WWVB clock. mailto:cprice at cs-home.com[Christopher
+Price] added enhanced support for the MSF, DCF and WWVB clocks.
+
== Additional Information ==
link:refclock.html[Reference Clock Drivers]
diff --git a/docs/driver29.txt b/docs/driver29.txt
index 5f409b0..ae2b644 100644
--- a/docs/driver29.txt
+++ b/docs/driver29.txt
@@ -72,7 +72,7 @@ No user initialization of the receiver is required. This driver is compatible wi
|======================================================
Note: When using Palisade 26664-00, you must set fudge flag2 to 1 in
-*ntp.conf*. See link:#Configuration[configuration].
+*{ntpconf}*. See link:#Configuration[configuration].
== GPS Installation ==
@@ -120,7 +120,7 @@ parity).
[[Configuration]]
== NTP Configuration ==
-Palisade NTP configuration file "ntp.conf" with event polling:
+Palisade NTP configuration file "{ntpconf}" with event polling:
["literal",subs="normal"]
#------------------------------------------------------------------------------
@@ -188,7 +188,7 @@ UTC almanac.
the interface module. It should flash once per second.
3. Connect Palisade's port A to the NTP host.
4. Configure NTP and the serial I/O port on the host system.
-5. Initially use link:#flag2[`fudge flag2`] in *link:#Configuration[ntp.conf],* to disable event polling (see configuration).
+5. Initially use link:#flag2[`fudge flag2`] in *link:#Configuration[{ntpconf}],* to disable event polling (see configuration).
6. Run NTP in debug mode (-d -d), to observe Palisade_receive events.
7. The driver reports the link:#TrackingStatus[tracking status of the
receiver]. Make sure it is tracking several satellites.
diff --git a/docs/driver40.txt b/docs/driver40.txt
index ea4701f..e5ea806 100644
--- a/docs/driver40.txt
+++ b/docs/driver40.txt
@@ -23,7 +23,7 @@ sold in Japan, and the time service through a telephone line.
* [[mode-1]]Tristate Ltd. TS-JJY01, TS-JJY02 link:http://www.tristate.ne.jp/[] (Japanese only)
+
-NTP configuration ( ntp.conf )::
+NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 1;;
@@ -63,7 +63,7 @@ whether it's before or after midnight.
* [[mode-2]]C-DEX Co.,Ltd. JST2000 link:http://www.c-dex.co.jp/[] (Japanese only)
+
-NTP configuration ( ntp.conf )::
+NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 2;;
@@ -81,7 +81,7 @@ Command -\-> Reply +
* [[mode-3]]Echo Keisokuki Co.,Ltd. LT-2000 link:http://www.clock.co.jp/[] (Japanese only)
+
-NTP configuration ( ntp.conf )::
+NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 3;;
@@ -104,7 +104,7 @@ Time code format::
* [[mode-4]]CITIZEN T.I.C. CO.,LTD. JJY-200 link:http://www.tic-citizen.co.jp/[] (Japanese only)
+
-NTP configuration ( ntp.conf )::
+NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 4;;
@@ -132,7 +132,7 @@ the onboard switches, the TS-GPSclock-01 should be set to command/response mode
Besides this driver ( Type 40 ), link:driver20.html[the generic NMEA
GPS driver ( Type 20 )] supports the TS-GPSclock-01 in NMEA mode.
+
-NTP configuration ( ntp.conf )::
+NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 5;;
@@ -174,7 +174,7 @@ whether it's before or after midnight.
The TDC-300 must be set to the type 3 data format using the front panel
menu display and the switches.
+
-NTP configuration ( ntp.conf )::
+NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode 6;;
@@ -202,12 +202,12 @@ Communications Technology in Japan.
+
ATTENTION; This mode, the telephone JJY, can not be used with the
refclock_acts ( type 18 ) at the same time. Because the "phone"
-statement in the ntp configuration file is not involved with the
+statement in the configuration file is not involved with the
"server" statement, so the both the refclock_acts ( type 18 ) and this
refclock_jjy ( type 40, mode 100 to 180 ) can not recognize the
appropriate "phone" statement among the "phone" statements.
+
-NTP configuration ( ntp.conf )::
+NTP configuration ( {ntpconf} )::
+
--
server 127.127.40.X mode (100, 101 to 180) minpoll N;;
diff --git a/docs/includes/manual.txt b/docs/includes/manual.txt
index f9000d5..31d5310 100644
--- a/docs/includes/manual.txt
+++ b/docs/includes/manual.txt
@@ -1,11 +1,11 @@
== Program Manual Pages ==
-* link:ntpd.html[`ntpd` - Network Time Protocol (NTP) daemon]
-* link:ntpq.html[`ntpq` - standard NTP query program]
-* link:sntp.html[`sntp` - Simple Network Time Protocol (SNTP) client]
+* link:ntpd.html[`{ntpd}` - Network Time Protocol (NTP) daemon]
+* link:ntpq.html[`{ntpq}` - standard NTP query program]
+* link:sntp.html[`{sntp}` - Simple Network Time Protocol (SNTP) client]
* link:ntptrace.html[`ntptrace` - trace a chain of NTP servers back to the primary source]
* link:tickadj.html[`tickadj` - set time-related kernel variables]
-* link:ntptime.html[`ntptime` - read and set kernel time variables]
-* link:keygen.html[`ntp-keygen` - generate public and private keys]
+* link:ntptime.html[`{ntptime}` - read and set kernel time variables]
+* link:keygen.html[`{ntpkeygen}` - generate public and private keys]
* link:ntpdsim_new.html[`ntpdsim` - Network Time Protocol (NTP) simulator]
* link:sitemap.html[Site Map]
diff --git a/docs/includes/misc.txt b/docs/includes/misc.txt
index 1e14416..96b97bf 100644
--- a/docs/includes/misc.txt
+++ b/docs/includes/misc.txt
@@ -2,7 +2,7 @@
* link:copyright.html[Copyright Notice]
* link:decode.html[Event Messages and Status Words]
* link:kern.html[Kernel Model for Precision Timekeeping]
-* link:msyslog.html[`ntpd` System Log Messages]
+* link:msyslog.html[`{ntpd}` System Log Messages]
* link:kernpps.html[PPSAPI Interface for Precision Time Signals]
* link:pps.html[Pulse-per-second (PPS) Signal Interfacing]
* link:sitemap.html[Site Map]
diff --git a/docs/index.txt b/docs/index.txt
index 2840853..8a292f9 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -85,7 +85,7 @@ few will be user-visible:
* A number of obsolete refclocks have been removed.
* The deprecated ntpdate program has been replaced with a shell
- wrapper around sntp.
+ wrapper around {sntp}.
* As noted above, Autokey support has been removed.
@@ -170,10 +170,10 @@ information is available via the External Links collection, including a
book and numerous background papers and briefing presentations.
Background information on computer network time synchronization is on
-the http://www.eecis.udel.edu/%7emills/exec.html[Executive Summary -
+the {millshome}exec.html[Executive Summary -
Computer Network Time Synchronization] page. Background information,
bibliography and briefing slides suitable for presentations are on the
-http://www.eecis.udel.edu/%7emills/ntp.html[Network Time
+{millshome}ntp.html[Network Time
Synchronization Research Project] page. Additional information is at
the {project-shortname} web site {project-weblink}.
diff --git a/docs/kern.txt b/docs/kern.txt
index 82fa577..7d3dc47 100644
--- a/docs/kern.txt
+++ b/docs/kern.txt
@@ -29,7 +29,7 @@ distribution
Ordinarily, the kernel clock discipline function is used with the NTP
daemon, but could be used for other purposes. The
-link:ntptime.html[`ntptime`] utility program can be used to control it
+link:ntptime.html[{ntptime}] utility program can be used to control it
manually.
The kernel model also provides support for an external precision timing
diff --git a/docs/keygen-body.txt b/docs/keygen-body.txt
index c3d54d5..ebb9bb0 100644
--- a/docs/keygen-body.txt
+++ b/docs/keygen-body.txt
@@ -22,7 +22,7 @@ infrastructure.
The `-p` password option specifies the write password and `-q` password
option the read password for previously encrypted files. The
-`ntp-keygen` program prompts for the password if it reads an encrypted
+`{ntpkeygen}` program prompts for the password if it reads an encrypted
file and the password is missing or incorrect. If an encrypted file is
read successfully and no write password is specified, the read password
is used as the write password by default.
@@ -82,14 +82,14 @@ described in the link:#fmt[Cryptographic Data Files] section below
To test and gain experience with Autokey concepts, log in as root and
change to the keys directory, usually `/usr/local/etc`. When run for the
first time, or if all files with names beginning `ntpkey` have been
-removed, use the `ntp-keygen` command without arguments to generate a
+removed, use the `{ntpkeygen}` command without arguments to generate a
default RSA host key and matching RSA-MD5 certificate with expiration
date one year hence. If run again without options, the program uses the
existing keys and parameters and generates only a new certificate with
new expiration date one year hence.
Run the command on as many hosts as necessary. Designate one of them as
-the trusted host (TH) using `ntp-keygen` with the `-T` option and
+the trusted host (TH) using `{ntpkeygen}` with the `-T` option and
configure it to synchronize from reliable Internet servers. Then
configure the other hosts to synchronize to the TH directly or
indirectly. A certificate trail is created when Autokey asks the
@@ -225,7 +225,7 @@ link:autokey.html[Autokey Public-Key Authentication] page.
[[run]]
== Running the program ==
-The safest way to run the `ntp-keygen` program is logged in directly as
+The safest way to run the `{ntpkeygen}` program is logged in directly as
root. The recommended procedure is change to the keys directory, usually
`/usr/local/etc`, then run the program. When run for the first time, or
if all _ntpkey_ files have been removed, the program generates a RSA
@@ -326,7 +326,7 @@ file generations to be activated simply by changing the link. If a link
is present, {ntpd} follows it to the file name to extract the filestamp.
If a link is not present, {ntpdman} extracts the filestamp from
the file itself. This allows clients to verify that the file and
-generation times are always current. The `ntp-keygen` program uses the
+generation times are always current. The `{ntpkeygen}` program uses the
same timestamp extension for all files generated at one time, so each
generation is distinct and can be readily recognized in monitoring data.
@@ -335,7 +335,7 @@ generation is distinct and can be readily recognized in monitoring data.
Each cryptographic configuration involves selection of
a signature scheme and identification scheme, called a cryptotype, as
-explained in the _Authentication_ _Options_ section of _ntp.conf_(5).
+explained in the _Authentication Options_ section of {ntpconfman}.
The default cryptotype uses RSA encryption, MD5 message digest and TC
identification. First, configure a NTP subnet including one or more
low-stratum trusted hosts from which all other hosts derive
@@ -346,7 +346,7 @@ trails to one or more trusted hosts. A trusted group is the set of all
hosts that have, directly or indirectly, a certificate trail ending at a
trusted host. The trail is defined by static configuration file entries
or dynamic means described on the _Automatic_ _NTP_ _Configuration_
-_Options_ section of _ntp.conf_(5).
+_Options_ section of {ntpconfman}.
On each trusted host as root, change to the keys directory. To insure a
fresh fileset, remove all _ntpkey_ files. Then run `ntp-keygen` `-T` to
@@ -358,17 +358,17 @@ Autokey to instantiate the certificate trails throughout the subnet, but
setting up the environment is completely automatic.
If it is necessary to use a different sign key or different
-digest/signature scheme than the default, run `ntp-keygen` with the `-S`
+digest/signature scheme than the default, run `{ntpkeygen}` with the `-S`
type option, where _type_ is either _RSA_ or _DSA_. The most often need
to do this is when a DSA-signed certificate is used. If it is necessary
-to use a different certificate scheme than the default, run `ntp-keygen`
+to use a different certificate scheme than the default, run `{ntpkeygen}`
with the `-c` scheme option and selected _scheme_ as needed. f
-`ntp-keygen` is run again without these options, it generates a new
+`{ntpkeygen}` is run again without these options, it generates a new
certificate using the same scheme and sign key.
After setting up the environment it is advisable to update certificates
from time to time, if only to extend the validity interval. Simply run
-`ntp-keygen` with the same flags as before to generate new certificates
+`{ntpkeygen}` with the same flags as before to generate new certificates
using existing keys. However, if the host or sign key is changed,
{ntpdman} should be restarted. When {ntpdman} is
restarted, it loads any new files and restarts the protocol. Other
@@ -399,7 +399,7 @@ contain both server and client keys. Hosts that operate only as clients
have key files that contain only client keys.
The PC scheme supports only one trusted host in the group. On trusted
-host alice run `ntp-keygen` `-P` `-p` password to generate the host key
+host alice run `{ntpkeygen}` `-P` `-p` password to generate the host key
file _ntpkey_RSAkey_alice.filestamp_ and trusted private certificate
file _ntpkey_RSA-MD5_cert_alice.filestamp_. Copy both files to all group
hosts; they replace the files which would be generated in other schemes.
@@ -413,7 +413,7 @@ to all other hosts in the group.
For the IFF scheme proceed as in the TC scheme to generate keys and
certificates for all group hosts, then for every trusted host in the
group, generate the IFF parameter file. On trusted host alice run
-`ntp-keygen` `-T` `-I` `-p` password to produce her parameter file
+`{ntpkeygen}` `-T` `-I` `-p` password to produce her parameter file
_ntpkey_IFFpar_alice.filestamp_, which includes both server and client
keys. Copy this file to all group hosts that operate as both servers and
clients and install a soft link from the generic _ntpkey_iff_alice_ to
@@ -425,7 +425,7 @@ If a rogue client has the parameter file, it could masquerade as a
legitimate server and present a middleman threat. To eliminate this
threat, the client keys can be extracted from the parameter file and
distributed to all restricted clients. After generating the parameter
-file, on alice run `ntp-keygen` `-e` and pipe the output to a file or
+file, on alice run `{ntpkeygen} -e` and pipe the output to a file or
mail program. Copy or mail this file to all restricted clients. On these
clients install a soft link from the generic _ntpkey_iff_alice_ to this
file. To further protect the integrity of the keys, each file can be
@@ -434,7 +434,7 @@ encrypted with a secret password.
For the GQ scheme proceed as in the TC scheme to generate keys and
certificates for all group hosts, then for every trusted host in the
group, generate the IFF parameter file. On trusted host alice run
-`ntp-keygen` `-T` `-G` `-p` password to produce her parameter file
+`{ntpkeygen} -T -G -p` password to produce her parameter file
_ntpkey_GQpar_alice.filestamp_, which includes both server and client
keys. Copy this file to all group hosts and install a soft link from the
generic _ntpkey_gq_alice_ to this file. In addition, on each host bob
@@ -445,7 +445,7 @@ keys and certificates can be regenerated as needed.
For the MV scheme, proceed as in the TC scheme to generate keys and
certificates for all group hosts. For illustration assume trish is the
TA, alice one of several trusted hosts and bob one of her clients. On TA
-trish run `ntp-keygen` `-V` n `-p` password, where _n_ is the number of
+trish run `{ntpkeygen} -V n -p` password, where _n_ is the number of
revokable keys (typically 5) to produce the parameter file
_ntpkeys_MVpar_trish.filestamp_ and client key files
_ntpkeys_MVkeyd_trish.filestamp_ where _d_ is the key number (0 < _d_ <
@@ -465,7 +465,7 @@ All cryptographically sound key generation schemes must have means to
randomize the entropy seed used to initialize the internal pseudo-random
number generator used by the library routines. The OpenSSL library uses
a designated random seed file for this purpose. The file must be
-available when starting the NTP daemon and `ntp-keygen` program. If a
+available when starting the NTP daemon and `{ntpkeygen}` program. If a
site supports OpenSSL or its companion OpenSSH, it is very likely that
means to do this are already available.
@@ -478,10 +478,10 @@ software documentation, but are outside the scope of this page.
The entropy seed used by the OpenSSL library is contained in a file,
usually called `.rnd`, which must be available when starting the NTP
-daemon or the `ntp-keygen` program. The NTP daemon will first look for
+daemon or the `{ntpkeygen}` program. The NTP daemon will first look for
the file using the path specified by the _randfile_ subcommand of the
_crypto_ configuration command. If not specified in this way, or when
-starting the `ntp-keygen` program, the OpenSSL library will look for the
+starting the `{ntpkeygen}` program, the OpenSSL library will look for the
file using the path specified by the RANDFILE environment variable in
the user home directory, whether root or some other user. If the
RANDFILE environment variable is not present, the library will look for
@@ -510,7 +510,7 @@ the GQ response `GQkey`.
All other file formats begin with two lines. The first contains the file
name, including the generated host name and filestamp. The second
contains the datestamp in conventional Unix date format. Lines beginning
-with # are considered comments and ignored by the `ntp-keygen` program
+with # are considered comments and ignored by the `{ntpkeygen}` program
and {ntpdman} daemon. Cryptographic values are encoded first
using ASN.1 rules, then encrypted if necessary, and finally written
PEM-encoded printable ASCII format preceded and followed by MIME content
@@ -521,11 +521,11 @@ against passwords requested by the programs and entered by hand, so it
is generally appropriate to specify these keys in human readable ASCII
format.
-The `ntp-keygen` program generates a MD5 symmetric keys file
+The `{ntpkeygen}` program generates a MD5 symmetric keys file
_ntpkey_MD5key_hostname.filestamp_. Since the file contains private
shared keys, it should be visible only to root and distributed by secure
means to other subnet hosts. The NTP daemon loads the file _{ntpkeys}_,
-so `ntp-keygen` installs a soft link from this name to the generated
+so `{ntpkeygen}` installs a soft link from this name to the generated
file. Subsequently, similar soft links must be installed by manual or
automated means on the other subnet hosts. While this file is not used
with the Autokey Version 2 protocol, it is needed to authenticate some
diff --git a/docs/keygen.txt b/docs/keygen.txt
index 65b5122..d948b23 100644
--- a/docs/keygen.txt
+++ b/docs/keygen.txt
@@ -1,4 +1,4 @@
-= `ntp-keygen` - generate public and private keys =
+= {ntpkeygen} - generate public and private keys =
[cols="10%,90%",frame="none",grid="none",style="verse"]
|==============================
diff --git a/docs/miscopt.txt b/docs/miscopt.txt
index e0be0bb..5d25881 100644
--- a/docs/miscopt.txt
+++ b/docs/miscopt.txt
@@ -277,7 +277,7 @@ and so on is suppressed.
`mlockall()` function. Defaults to 50 4k pages (200 4k pages in
OpenBSD).
`filenum` 'Nfiledescriptors';;
- Specifies the maximum number of file descriptors ntp may have open
+ Specifies the maximum number of file descriptors {ntpd} may have open
at the same time. Defaults to system default.
`tos` [`beacon` 'beacon' | `ceiling` 'ceiling' | `cohort` {`0` | `1`} | `floor` 'floor' | `maxclock` 'maxclock' | `maxdist` 'maxdist' | `minclock` 'minclock' | `mindist` 'mindist' | `minsane` 'minsane' | `orphan` 'stratum' | `orphanwait` 'delay']::
This command alters certain system variables used by the the clock
diff --git a/docs/msyslog.txt b/docs/msyslog.txt
index 5ecc534..eed0155 100644
--- a/docs/msyslog.txt
+++ b/docs/msyslog.txt
@@ -138,7 +138,7 @@ meaning should be clear from context.
`cert_parse: invalid subject ?`::
There is a problem with a certificate. Operation cannot proceed untill
the problem is fixed. If the certificate is local, it can be
- regenerated using the `ntp-keygen` program. If it is held somewhere
+ regenerated using the {ntpkeygen} program. If it is held somewhere
else, it must be fixed by the holder.
`crypto_?: defective key`::
diff --git a/docs/ntp-wait.txt b/docs/ntp-wait.txt
index ea9d9c3..c50e39f 100644
--- a/docs/ntp-wait.txt
+++ b/docs/ntp-wait.txt
@@ -1,14 +1,14 @@
-= `ntp-wait` - waits until {ntpd} is in synchronized state =
+= `{ntpwait}` - waits until {ntpd} is in synchronized state =
'''''
== Synopsis ==
-`ntp-wait` [ `-v` ] [ `-n` 'tries' ] [ `-s` 'seconds' ]
+`{ntpwait}` [ `-v` ] [ `-n` 'tries' ] [ `-s` 'seconds' ]
== Description ==
-The `ntp-wait` program blocks until {ntpd} is in synchronized state. This
+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}
-g" has set the time.
diff --git a/docs/ntpd-body.txt b/docs/ntpd-body.txt
index 624f1f7..a2bc94c 100644
--- a/docs/ntpd-body.txt
+++ b/docs/ntpd-body.txt
@@ -96,7 +96,7 @@ never a good idea.
`-c` string, `--configfile`=_string_::
configuration file name.
+
-The name and path of the configuration file, `/etc/ntp.conf` by
+The name and path of the configuration file, `/etc/{ntpconf}` by
default.
`-d`, `--debug-level`::
@@ -112,7 +112,7 @@ default.
+
The name and path of the frequency file, `/etc/ntp.drift` by default.
This is the same operation as the _driftfile_
-configuration specification in the `/etc/ntp.conf` file.
+configuration specification in the `/etc/{ntpconf}` file.
`-g`, `--panicgate`::
Allow the first adjustment to be Big. This option may appear an
@@ -220,7 +220,7 @@ specified _sched_setscheduler(SCHED_FIFO)_ priority.
any of the following options: saveconfigquit, wait-sync.
+
`{ntpd}` will not daemonize and will exit after the clock is first
-synchronized. This behavior mimics that of the _ntpdate_ program,
+synchronized. This behavior mimics that of the old _ntpdate_ program,
which has been replaced with a shell script. The `-g` and `-x` options can be
used with this option. Note: The kernel time discipline is disabled
with this option.
@@ -461,7 +461,7 @@ file at hourly intervals.
The `{ntpd}` utility can operate in any of several modes, including
symmetric active/passive, client/server broadcast/multicast and
manycast, as described in the "Association Management" page (available
-as part of the HTML documentation provided in `/usr/share/doc/ntp`). It
+as part of the HTML documentation provided in `/usr/share/doc/{ntp}`). It
normally operates continuously while monitoring for small changes in
frequency and trimming the clock for the ultimate precision. However, it
can operate in a one-time mode where the time is set from an external
@@ -559,7 +559,7 @@ the negative (huff) and positive (puff) correction, which depends on the
sign of the offset.
The filter is activated by the _tinker_ command and _huffpuff_ keyword,
-as described in _ntp.conf_(5)_._
+as described in {ntpconfman}.
[[files]]
== FILES ==
@@ -567,7 +567,7 @@ as described in _ntp.conf_(5)_._
[options="header"]
|================================================================
|File |Default |Option |Option
-|configuration file |`/etc/ntp.conf` |`-c` |`conffile`
+|configuration file |`/etc/{ntpconf}`|`-c` |`conffile`
|frequency file |none |`-f` |`driftfile`
|leapseconds file |none | |`leapfile`
|process ID file |none |`-p` |`pidfile`
diff --git a/docs/ntpdsim.txt b/docs/ntpdsim.txt
index 92ef35a..c901243 100644
--- a/docs/ntpdsim.txt
+++ b/docs/ntpdsim.txt
@@ -50,20 +50,20 @@ Poisson distribution, while the wander generator produces samples from a
Guassian distribution.
The easiest way to use this program is to create a `ntpstats` directory,
-configuration file `ntp.conf` and frequency file `ntp.drift` and test
+configuration file `{ntpconf}` and frequency file `ntp.drift` and test
shell `test.sh` in the base directory. The `ntp.drift` file and
`ntpstats` directory can be empty to start. The `test.sh` script can
contain something like
-------------------------------------------------
rm ./ntpstats/*
-ntpdsim -O 0.1 -C .001 -T 400 -W 1 -c ./ntp.conf,
+ntpdsim -O 0.1 -C .001 -T 400 -W 1 -c ./{ntpconf},
-------------------------------------------------
which starts the simulator with a time offset 100 ms, network jitter 1
ms, frequency offset 400 PPM and oscillator wander 1 PPM/s. These
parameters represent typical conditions with modern workstations on a
-Ethernet LAN. The ntp.conf file should contain something like
+Ethernet LAN. The {ntpconf} file should contain something like
---------------------------------
disable kernel
diff --git a/docs/ntptime-body.txt b/docs/ntptime-body.txt
index ecfad08..1876fd7 100644
--- a/docs/ntptime-body.txt
+++ b/docs/ntptime-body.txt
@@ -5,7 +5,7 @@
== Synopsis ==
["literal",subs="normal"]
-ntptime [ -chr ] [ -e 'est_error' ] [ -f 'frequency' ] [ -m 'max_error' ] [ -o 'offset' ] [ -s 'status' ] [ -t 'time_constant']
+{ntptime} [ -chr ] [ -e 'est_error' ] [ -f 'frequency' ] [ -m 'max_error' ] [ -o 'offset' ] [ -s 'status' ] [ -t 'time_constant']
== Description ==
@@ -18,7 +18,7 @@ and `kerninfo` command.
== Options ==
`-c`::
- Display the execution time of `ntptime` itself.
+ Display the execution time of `{ntptime}` itself.
`-e` 'est_error'::
Specify estimated error, in microseconds.
`-f` 'frequency'::
diff --git a/docs/quick.txt b/docs/quick.txt
index 54353b6..024bd22 100644
--- a/docs/quick.txt
+++ b/docs/quick.txt
@@ -29,7 +29,7 @@ Distribution] page describes how to do this.
While it is possible that certain configurations do not need a
configuration file, most do. The file, called by default
-`/etc/ntp.conf`, need only contain one command specifying a remote
+`/etc/{ntpconf}`, need only contain one command specifying a remote
server, for instance
`server foo.bar.com`
diff --git a/docs/refclock.txt b/docs/refclock.txt
index 7665548..5e07e05 100644
--- a/docs/refclock.txt
+++ b/docs/refclock.txt
@@ -115,7 +115,7 @@ know the radio propagation time from the transmitter to the receiver.
This must be calculated for each specific receiver location and requires
the geographic coordinates of both the transmitter and receiver. The
transmitter coordinates for various radio services are given in the
-http://www.eecis.udel.edu/%7emills/ntp/qth.html[Time and Frequency
+{millshome}ntp/qth.html[Time and Frequency
Standard Station Information] page. Receiver coordinates can be obtained
locally or from Google Earth. The actual calculations are beyond the
scope of this document.
diff --git a/docs/sntp-body.txt b/docs/sntp-body.txt
index 44bdd0a..2e16c80 100644
--- a/docs/sntp-body.txt
+++ b/docs/sntp-body.txt
@@ -1,10 +1,10 @@
-// This is the body of the manual page for ntpd.
+// This is the body of the manual page for sntp.
// It's included in two places: once for the docs/ HTML
// tree, and once to make an individual man page.
== SYNOPSIS ==
-*sntp*
+{sntp}
[--help | -?] [-4 | -6] [-a keynum] [-b bcaddress] [-B bctimeout]
[-c] [-d] [-D debug-level] [-g delay] [-K kodfile] [-k keyfile]
[-l logfile] [-M steplimit] [-o ntpver] [-r] [-S] [-s]
@@ -12,7 +12,7 @@
== DESCRIPTION ==
-`sntp` can be used as an SNTP client to query a NTP or SNTP server and
+{sntp} can be used as an SNTP client to query a NTP or SNTP server and
either display the time or set the local system's time (given suitable
privilege). It can be run as an interactive command or from a _cron_
job. NTP (the Network Time Protocol) and SNTP (the Simple Network Time
@@ -74,7 +74,7 @@ option (`-k`) for more details.
Listen to the address specified for broadcast time sync. This option
may appear an unlimited number of times.
+
-If specified `sntp` will listen to the specified address for NTP
+If specified `{sntp}` will listen to the specified address for NTP
broadcasts. The default maximum wait time can (and probably should) be
modified with `-t`.
@@ -85,7 +85,7 @@ modified with `-t`.
Requests from an NTP "client" to a "server" should never be sent more
rapidly than one every 2 seconds. By default, any IPs returned as part
of a DNS lookup are assumed to be for a single instance of {ntpd}, and
-therefore `sntp` will send queries to these IPs one after another,
+therefore `{sntp}` will send queries to these IPs one after another,
with a 2-second gap in between each query.
+
The `-c` or `--concurrent` flag says that any IPs returned for the DNS
@@ -123,7 +123,7 @@ message will be displayed. The file will not be created.
`-k` file-name, `--keyfile`=_file-name_::
Look in this file for the key specified with `-a`.
+
-This option specifies the keyfile. `sntp` will search for the key
+This option specifies the keyfile. `{sntp}` will search for the key
specified with `-a` keyno in this file. See _{ntpkeysman}_ for more
information.
@@ -149,34 +149,34 @@ situations demand different values.
number as its argument. Defaults to 4. Seldom useful.
`-r`, `--usereservedport`::
- By default, `sntp` uses a UDP source port number selected by the
+ By default, `{sntp}` uses a UDP source port number selected by the
operating system. When this option is used, the reserved NTP port 123
- is used, which most often requires `sntp` be invoked as the superuser
+ is used, which most often requires `{sntp}` be invoked as the superuser
(commonly "root"). This can help identify connectivity failures due to
port-based firewalling which affect `{ntpd}`, which always uses source
port 123.
`-S`, `--step`::
- By default, `sntp` displays the clock offset but does not attempt to
+ By default, `{sntp}` displays the clock offset but does not attempt to
correct it. This option enables offset correction by stepping, that
is, directly setting the clock to the corrected time. This typically
- requires `sntp` be invoked as the superuser ("root").
+ requires `{sntp}` be invoked as the superuser ("root").
`-s`, `--slew`::
- By default, `sntp` displays the clock offset but does not attempt to
+ By default, `{sntp}` displays the clock offset but does not attempt to
correct it. This option enables offset correction by slewing using
adjtime(), which changes the rate of the clock for a period long
enough to accomplish the required offset (phase) correction. This
- typically requires `sntp` be invoked as the superuser ("root").
+ typically requires `{sntp}` be invoked as the superuser ("root").
`-t` seconds, `--timeout`=_seconds_::
The number of seconds to wait for responses. This option takes an
integer number as its argument. The default _seconds_ for this option
is: 5.
+
-When waiting for a reply, `sntp` will wait the number of seconds
+When waiting for a reply, `{sntp}` will wait the number of seconds
specified before giving up. The default should be more than enough for
-a unicast response. If `sntp` is only waiting for a broadcast response
+a unicast response. If `{sntp}` is only waiting for a broadcast response
a longer timeout is likely needed.
`--wait`, `--no-wait`::
@@ -190,19 +190,19 @@ If we are not setting the time, wait for all pending responses.
== USAGE ==
-`sntp ntpserver.somewhere`::
+`{sntp} ntpserver.somewhere`::
is the simplest use of this program and can be run as an unprivileged
command to check the current time and error in the local clock.
-`sntp -Ss -M 128 ntpserver.somewhere`::
+`{sntp} -Ss -M 128 ntpserver.somewhere`::
With suitable privilege, run as a command or from a _cron_(8) job,
- `sntp -Ss -M 128 ntpserver.somewhere` will request the time from the
+ `{sntp} -Ss -M 128 ntpserver.somewhere` will request the time from the
server, and if that server reports that it is synchronized then if the
offset adjustment is less than 128 milliseconds the correction will be
slewed, and if the correction is more than 128 milliseconds the
correction will be stepped.
-`sntp -S ntpserver.somewhere`::
+`{sntp} -S ntpserver.somewhere`::
With suitable privilege, run as a command or from a _cron_(8) job,
- `sntp -S ntpserver.somewhere` will set (step) the local clock from a
+ `{sntp} -S ntpserver.somewhere` will set (step) the local clock from a
synchronized specified server, like the `ntpdate` utility from older
NTP implementations.
diff --git a/docs/sntp.txt b/docs/sntp.txt
index af300b9..810d858 100644
--- a/docs/sntp.txt
+++ b/docs/sntp.txt
@@ -1,4 +1,4 @@
-= `sntp` - Simple Network Time Protocol (SNTP) Client =
+= `{sntp}` - Simple Network Time Protocol (SNTP) Client =
[cols="10%,90%",frame="none",grid="none",style="verse"]
|==============================
diff --git a/ntpd/ntp.conf.txt b/ntpd/ntp.conf.txt
index 78186a5..5015edb 100644
--- a/ntpd/ntp.conf.txt
+++ b/ntpd/ntp.conf.txt
@@ -2,14 +2,14 @@
:doctype: manpage
== NAME ==
-{ntp.conf} - Network Time Protocol (NTP) daemon configuration file format
+{ntpconf} - Network Time Protocol (NTP) daemon configuration file format
== SYNOPSIS ==
-/etc/{ntp.conf}
+/etc/{ntpconf}
== DESCRIPTION ==
-The `ntp.conf` configuration file is read at initial startup by the
+The `{ntpconf}` configuration file is read at initial startup by the
{ntpdman} daemon in order to specify the synchronization
sources, modes and other related information. Usually, it is installed
in the `/etc` directory, but could be installed elsewhere (see the
@@ -26,8 +26,8 @@ times in seconds) and text strings.
The rest of this page describes the configuration and control options.
The "Notes on Configuring NTP and Setting up an NTP Subnet" page
-(available as part of the HTML documentation provided in
-`/usr/share/doc/ntp`) contains an extended discussion of these options.
+(available as part of the HTML documentation provided under
+`/usr/share/doc/{ntp}) contains an extended discussion of these options.
In addition to the discussion of general 'Configuration Options',
there are sections describing the following supported functionality and
the options used to control it:
@@ -68,7 +68,7 @@ FIXME: --enable-ipv6 ??
If the Basic Socket Interface Extensions for IPv6 (RFC-2553) is
detected, support for the IPv6 address family is generated in addition
to the default support of the IPv4 address family. In a few cases,
-including the reslist billboard generated by ntpq, IPv6 addresses are
+including the reslist billboard generated by {ntpq}, IPv6 addresses are
automatically generated. IPv6 addresses can be identified by the
presence of colons ":" in the address field. IPv6 addresses can
be used almost everywhere where IPv4 addresses can be used, with the
@@ -80,20 +80,16 @@ while a `-6` qualifier forces DNS resolution to the IPv6 namespace. See
IPv6 references for the equivalent classes for that address family.
`pool` _address_ [`burst`] [`iburst`] [`version` _version_] [`prefer`] [`minpoll` _minpoll_] [`maxpoll` _maxpoll_]::
-
`server` _address_ [`key` _key_ | `autokey`] [`burst`] [`iburst`] [`version` _version_] [`prefer`] [`minpoll` _minpoll_] [`maxpoll` _maxpoll_]::
-
`peer` _address_ [`key` _key_ | `autokey`] [`version` _version_] [`prefer`] [`minpoll` _minpoll_] [`maxpoll` _maxpoll_]::
-
`broadcast` _address_ [`key` _key_ | `autokey`] [`version` _version_] [`prefer`] [`minpoll` _minpoll_] [`ttl` _ttl_]::
-
`manycastclient` _address_ [`key` _key_ | `autokey`] [`version` _version_] [`prefer`] [`minpoll` _minpoll_] [`maxpoll` _maxpoll_] [`ttl` _ttl_]::
These five commands specify the time server name or address to be used
and the mode in which to operate. The _address_ can be either a DNS
name or an IP address in dotted-quad notation. Additional information
on association behavior can be found in the "Association Management"
page (available as part of the HTML documentation provided in
- `/usr/share/doc/ntp`).
+ `/usr/share/doc/{ntp}`).
`pool`::
For type s addresses, this command mobilizes a persistent client mode
@@ -253,7 +249,7 @@ Options:
If we are participating in mDNS, after we have synched for the first
time we attempt to register with the mDNS system. If that registration
attempt fails, we try again at one minute intervals for up to
- _number_ times. After all, `ntpd` may be starting before mDNS. The
+ _number_ times. After all, `{ntpd}` may be starting before mDNS. The
default value for `mdnstries` is 5.
== Authentication Support ==
@@ -323,21 +319,19 @@ and symmetric active messages and remote configuration commands and, in
particular, the flag has no effect on the authentication process
itself.
-//FIXME: page reference may be invalid
An attractive alternative where multicast support is available is
manycast mode, in which clients periodically troll for servers as
-described in the 'Automatic NTP Configuration Options' page.
-Either symmetric key or public key cryptographic authentication can be
-used in this mode. The principle advantage of manycast mode is that
-potential servers need not be configured in advance, since the client
-finds them during regular operation, and the configuration files for all
-clients can be identical.
-
-//FIXME: Reference to ntp.org
+described in the 'Automatic NTP Configuration Options' page of the Web
+documentation. Either symmetric key or public key cryptographic
+authentication can be used in this mode. The principle advantage of
+manycast mode is that potential servers need not be configured in
+advance, since the client finds them during regular operation, and the
+configuration files for all clients can be identical.
+
The security model and protocol schemes for both symmetric key and
public key cryptography are summarized below; further details are in the
-briefings, papers and reports at the NTP project page linked from
-_http://www.ntp.org/_.
+briefings, papers and reports at the {project-fullname} page linked from
+{project-website}.
=== Symmetric-Key Cryptography ===
@@ -543,6 +537,7 @@ contain the value _trustRoot_;. Other extension fields are ignored.
directory specified in the `keysdir` command or default
`/usr/local/etc`. Following are the subcommands:
+ //NAMECHANGE
`cert` _file_;;
Specifies the location of the required host public certificate file.
This overrides the link _ntpkey_cert_hostname_ in the keys
@@ -755,7 +750,7 @@ values are as received and before processing by the various data
smoothing and mitigation algorithms.
`sysstats`;;
- Enables recording of ntpd statistics counters on a periodic basis.
+ Enables recording of {ntpd} statistics counters on a periodic basis.
Each hour a line of the following form is appended to the file
generation set named _sysstats_:
+
@@ -805,7 +800,7 @@ generated line.
when and how data will be directed to a new element of the set. This
way, information stored in elements of a file set that are currently
unused are available for administrational operations without the
- risk of disturbing the operation of ntpd. (Most important: they can
+ risk of disturbing the operation of {ntpd}. (Most important: they can
be removed to free space for new data produced.)
+
Note that this command can be sent from the
@@ -843,7 +838,7 @@ Note that this command can be sent from the
`none`;;
The file set is actually a single plain file.
`pid`;;
- One element of file set is used per incarnation of a ntpd
+ One element of file set is used per incarnation of a {ntpd}
server. This type does not perform any changes to file set
members during runtime, however it provides an easy way of
separating files belonging to different {ntpdman} server
@@ -888,7 +883,7 @@ Note that this command can be sent from the
specified, a hard link from the current file set element to a file
without suffix is created. When there is already a file with this
name and the number of links of this file is one, it is renamed
- appending a dot, the letter _C_, and the pid of the ntpd server
+ appending a dot, the letter _C_, and the pid of the {ntpd} server
process. When the number of links is greater than one, the file is
unlinked. This allows the current file to be accessed by a
constant name.
@@ -909,7 +904,7 @@ the list. The list is searched in order with the last match found
defining the restriction flags associated with the entry. Additional
information and examples can be found in the "Notes on Configuring NTP
and Setting up a NTP Subnet" page (available as part of the HTML
-documentation provided in `/usr/share/doc/ntp`_).
+documentation provided in `/usr/share/doc/{ntp}`_).
The restriction facility was implemented in conformance with the access
policies for the original NSFnet backbone time servers. Later the
@@ -1027,7 +1022,7 @@ server operator cooperates.
Deny all packets except {ntpqman} and queries.
`notrap`;;
Decline to provide mode 6 control message trap service to matching
- hosts. The trap service is a subsystem of the ntpdq control message
+ hosts. The trap service is a subsystem of the {ntpq} control message
protocol which is intended for use by remote event logging programs.
`notrust`;;
Deny service unless the packet is cryptographically authenticated.
@@ -1291,18 +1286,18 @@ satellite and modem reference clocks plus a special pseudo-clock used
for backup or when no other clock source is available. Detailed
descriptions of individual device drivers and options can be found in
the "Reference Clock Drivers" page (available as part of the HTML
-documentation provided in `/usr/share/doc/ntp`). Additional information
+documentation provided in `/usr/share/doc/{ntp}`). Additional information
can be found in the pages linked there, including the "Debugging Hints
for Reference Clock Drivers" and "How To Write a Reference Clock Driver"
pages (available as part of the HTML documentation provided in
-`/usr/share/doc/ntp`). In addition, support for a PPS signal is
+`/usr/share/doc/{ntp}`). In addition, support for a PPS signal is
available as described in the "Pulse-per-second (PPS) Signal
Interfacing" page (available as part of the HTML documentation provided
-in `/usr/share/doc/ntp`). Many drivers support special line
+in `/usr/share/doc/{ntp}`). Many drivers support special line
discipline/streams modules which can significantly improve the accuracy
using the driver. These are described in the "Line Disciplines and
Streams Drivers" page (available as part of the HTML documentation
-provided in `/usr/share/doc/ntp`).
+provided in `/usr/share/doc/{ntp}`).
A reference clock will generally (though not always) be a radio timecode
receiver which is synchronized to a source of standard time such as the
@@ -1334,7 +1329,7 @@ below. The `prefer` option can be useful to persuade the server to
cherish a reference clock with somewhat more enthusiasm than other
reference clocks or peers. Further information on this option can be
found in the "Mitigation Rules and the prefer Keyword" (available as
-part of the HTML documentation provided in `/usr/share/doc/ntp`) page.
+part of the HTML documentation provided in `/usr/share/doc/{ntp}`) page.
The `minpoll` and `maxpoll` options have meaning only for selected clock
drivers. See the individual clock driver document pages for additional
information.
@@ -1369,7 +1364,7 @@ these options apply to all clock drivers.
equal, this host will be chosen for synchronization among a set of
correctly operating hosts. See the "Mitigation Rules and the prefer
Keyword" page (available as part of the HTML documentation provided
- in `/usr/share/doc/ntp`) for further information.
+ in `/usr/share/doc/{ntp}`) for further information.
`mode` _int_;;
Specifies a mode number which is interpreted in a device-specific
fashion. For instance, it selects a dialing protocol in the ACTS
@@ -1406,13 +1401,13 @@ these options apply to all clock drivers.
the form of an argument to the `enable` command described in
"Miscellaneous` Options" page and operates as described in the
"Reference Clock Drivers" page (available as part of the HTML
- documentation provided in `/usr/share/doc/ntp`).
+ documentation provided in `/usr/share/doc/{ntp}`).
//FIXME: page reference may be invalid
`time2` _secs_;;
Specifies a fixed-point decimal number in seconds, which is
interpreted in a driver-dependent way. See the descriptions of
specific drivers in the "Reference Clock Drivers" page (available as
- part of the HTML documentation provided in `/usr/share/doc/ntp`).
+ part of the HTML documentation provided in `/usr/share/doc/{ntp}`).
`stratum` _int_;;
Specifies the stratum number assigned to the driver, an integer
between 0 and 15. This number overrides the default stratum number
@@ -1632,7 +1627,7 @@ The variables operate as follows:
Specifies the maximum size of the process stack on systems with the
mlockall()_function. Defaults to 50 4k pages (200 4k pages in OpenBSD).
`filenum` _filedescriptors_;;
- Specifies the maximum number of file descriptors ntpd may have open
+ Specifies the maximum number of file descriptors {ntpd} may have open
at once. Defaults to the system default.
`trap` _host_address_ [`port` _port_number_] [`interface` _interface_address_]::
@@ -1684,22 +1679,10 @@ One of the following exit values will be returned:
{ntpdman}, {ntpqman}, {ntpqman}
In addition to the manual pages provided, comprehensive documentation is
-available on the world wide web at _http://www.ntp.org/_. A snapshot of
-this documentation is available in HTML format in `/usr/share/doc/ntp`.
+available on the world wide web at {project-website}. A snapshot of
+this documentation is available in HTML format in `/usr/share/doc/{ntp}`.
David L. Mills, _Network Time Protocol (Version 4)_, RFC5905
-== AUTHORS ==
-
-//FIXME: NTF reference
-The University of Delaware and Network Time Foundation
-
-== COPYRIGHT ==
-
-//FIXME: ntp.org reference
-Copyright (C) 1992-2015 The University of Delaware and Network Time
-Foundation all rights reserved. This program is released under the terms
-of the NTP license, <http://ntp.org/license>.
-
== BUGS ==
The syntax checking is not picky; some combinations of ridiculous and
@@ -1709,9 +1692,4 @@ The _ntpkey_host_ files are really digital certificates. These should be
obtained via secure directory services when they become universally
available.
-//FIXME: ntp.org reference
-Please send bug reports to: http://bugs.ntp.org, bugs at ntp.org
-
-== NOTES ==
-
-This document was derived from FreeBSD.
+// end
diff --git a/ntpd/ntp.keys.txt b/ntpd/ntp.keys.txt
index 6ed25aa..53b5582 100644
--- a/ntpd/ntp.keys.txt
+++ b/ntpd/ntp.keys.txt
@@ -8,7 +8,7 @@
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
-Support" section of the ntp.conf(5) page.
+Support" page of the Web documentation.
{ntpdman} reads its keys from a file specified using the -k command line
option or the 'keys' statement in the configuration file. While key
@@ -28,7 +28,7 @@ where `keyno` is a positive integer (between 1 and 65534),
`key` is the key itself.
The `key` may be given in a format controlled by the `type` field. The
-`type` MD5 is always supported. If ntpd was built with the OpenSSL
+`type` MD5 is always supported. If {ntpd} was built with the OpenSSL
library then any digest library supported by that library may be
specified. However, if compliance with FIPS 140-2 is required the
`type` must be either 'SHA' or 'SHA1'.
@@ -42,7 +42,7 @@ _SHA_; _SHA1_; _RMD160_::
The key is a hex-encoded ASCII string of 40 characters, which is
truncated as necessary.
+
-Note that the keys used by the ntpq(8) programs are
+Note that the keys used by the {ntpqman} programs are
checked against passwords requested by the programs and entered by
hand, so it is generally appropriate to specify these keys in ASCII
format.
diff --git a/scripts/calc_tickadj/calc_tickadj.txt b/scripts/calc_tickadj/calc_tickadj.txt
index 84aae8e..80e1b06 100644
--- a/scripts/calc_tickadj/calc_tickadj.txt
+++ b/scripts/calc_tickadj/calc_tickadj.txt
@@ -2,15 +2,15 @@
:doctype: manpage
== NAME ==
-calc_tickadj - Calculates optimal value for tick given ntp drift file.
+calc_tickadj - Calculates optimal value for tick given NTP drift file.
== SYNOPSIS ==
calc_tickadj [-d 'string' | --drift-file='string'] [-t 'number' | --tick='number']
== DESCRIPTION ==
-The _calc_tickadj_ script uses provided ntp drift file to generate
-optimal tick value. Generally, ntpd can do better job if the drift value
+The _calc_tickadj_ script uses provided NTP drift file to generate
+optimal tick value. Generally, {ntpd} can do better job if the drift value
is the smallest possible number.
The example output of
@@ -31,9 +31,9 @@ instead of slowing the clock down a little.
If 'tick' on that box is 10,000,000 then by setting it to 9999779 the
drift value will be somewhere around 0.0.
-_calc_tickadj_ tries to determine the the tick value by using _tickadj_
-program from ntp package. If this doesn't work you can specify current
-tick manually on command line.
+_calc_tickadj_ tries to determine the the tick value by using the
+_tickadj_ program from the {project-shortname} package. If this
+doesn't work you can specify current tick manually on command line.
== OPTIONS ==
diff --git a/scripts/ntp-wait/ntp-wait.txt b/scripts/ntp-wait/ntp-wait.txt
index bbceb59..1558aac 100644
--- a/scripts/ntp-wait/ntp-wait.txt
+++ b/scripts/ntp-wait/ntp-wait.txt
@@ -2,28 +2,28 @@
:doctype: manpage
== NAME ==
-{ntpwait} - Wait for ntpd to stabilize the system clock
+{ntpwait} - Wait for {ntpd} to stabilize the system clock
== SYNOPSIS ==
{ntpwait} [-v] [-n 'number'] [-s 'secs']
== DESCRIPTION ==
-`ntp-wait` will send at most _num-tries_ queries to _ntpd_(8)_, sleeping
-for _secs-between_ after each status return that says ntpd_(8)_has not
+`{ntpwait}` will send at most _num-tries_ queries to {ntpdman}, sleeping
+for _secs-between_ after each status return that says {ntpdman} has not
yet produced a synchronized and stable system clock._
-`ntp-wait` will do this quietly, unless the `-v` flag is provided. This
+`{ntpwait}` will do this quietly, unless the `-v` flag is provided. This
can be useful at boot time, to delay the boot sequence until after
-_ntpd_ `-g` has set the time.
+_{ntpd}_ `-g` has set the time.
== OPTIONS ==
`-n` number, `--tries`=_number_::
- Number of times to check ntpd. This option takes an integer number as
+ Number of times to check {ntpd}. This option takes an integer number as
its argument. The default _number_ for this option is: 100.
+
-The maximum number of times we will check _ntpd_ to see if it has been
+The maximum number of times we will check _{ntpd}_ to see if it has been
able to synchronize and stabilize the system clock.
`-s` secs-between-tries, `--sleep`=_secs-between-tries_::
@@ -31,13 +31,13 @@ able to synchronize and stabilize the system clock.
as its argument. The default _secs-between-tries_ for this option
is: 6.
+
-We will sleep for _secs-between-tries_ after each query of _ntpd_ that
+We will sleep for _secs-between-tries_ after each query of _{ntpd}_ that
returns "the time is not yet stable".
`-v`, `--verbose`::
Be verbose.
+
-By default, `ntp-wait` is silent. With this option, `ntp-wait` will
+By default, `{ntpwait}` is silent. With this option, `ntp-wait` will
provide status information.
== EXIT STATUS ==
diff --git a/scripts/ntpsweep/ntpsweep.txt b/scripts/ntpsweep/ntpsweep.txt
index ff6f3da..5c9f0d8 100644
--- a/scripts/ntpsweep/ntpsweep.txt
+++ b/scripts/ntpsweep/ntpsweep.txt
@@ -2,7 +2,7 @@
:doctype: manpage
== NAME ==
-ntpsweep - print various informations about given ntp servers
+ntpsweep - print various informations about given NTP servers
== SYNOPSIS ==
ntpsweep [-l 'host']... [-p] [-m 'number'] [-s 'prefix'] [-h 'string']
diff --git a/scripts/summary.txt b/scripts/summary.txt
index 4064bf4..dd08e07 100644
--- a/scripts/summary.txt
+++ b/scripts/summary.txt
@@ -18,11 +18,11 @@ command-line options. It needs updating.
is:
+
____________
-/var/log/ntp
+/var/log/{ntp}
____________
+
-The directory where _ntpd_ will search for .stat files generated by
-_ntpd_.
+The directory where _plot-summary_ will search for .stat files generated by
+_{ntpd}_.
`--end-date`=_number_::
End date. This option takes an integer number as its argument.
+
diff --git a/scripts/update-leap/update-leap.txt b/scripts/update-leap/update-leap.txt
index b74288d..5635de7 100644
--- a/scripts/update-leap/update-leap.txt
+++ b/scripts/update-leap/update-leap.txt
@@ -13,7 +13,7 @@ update-leap [-flags | -flag 'value' | --option-name='value']
if necessary, updates leap-second definition file.
Ordinarily, the file is found using the "leapfile" directive in
-_ntp.conf_(5). However, an alternate location can be specified on the
+_{ntpconfman}_. However, an alternate location can be specified on the
command line.
If the file does not exist, is not valid, has expired, or is expiring
@@ -59,10 +59,10 @@ are required, e.g. "-e 60 days" Note that larger values imply more
frequent refreshes.
`-f` string, `--ntp-conf-file`=_string_::
- Location of the ntp.conf file.
+ Location of the {ntpconf} file.
+
-Specify location of ntp.conf (used to make sure leapfile directive is
-present and to default leapfile) /etc/ntp.conf
+Specify location of {ntpconf} (used to make sure leapfile directive is
+present and to default leapfile) /etc/{ntpconf}
`-F`, `--force-update`::
Force update of the leapfile.
More information about the vc
mailing list