[ntpsec commit] Documentation polishing.
Eric S. Raymond
esr at ntpsec.org
Tue Oct 6 04:13:12 UTC 2015
Module: ntpsec
Branch: master
Commit: e0235130639bd62a0495f427448989f5ccb8c3d8
Changeset: http://git.ntpsec.org/ntpsec/commit/?id=e0235130639bd62a0495f427448989f5ccb8c3d8
Author: Eric S. Raymond <esr at thyrsus.com>
Date: Tue Oct 6 00:12:03 2015 -0400
Documentation polishing.
Indirect a lot of utility names and man oage references through asciidoc macros.
---
conf/README | 16 +++---
docs/access.txt | 2 +-
docs/accopt.txt | 12 ++--
docs/asciidoc.conf | 16 ++++--
docs/assoc.txt | 2 +-
docs/audio.txt | 4 +-
docs/authentic.txt | 10 ++--
docs/authopt.txt | 6 +-
docs/build.txt | 4 +-
docs/clockopt.txt | 2 +-
docs/confopt.txt | 4 +-
docs/debug.txt | 78 +++++++++++++-------------
docs/decode.txt | 18 +++---
docs/discover.txt | 4 +-
docs/driver18.txt | 4 +-
docs/driver20.txt | 4 +-
docs/driver22.txt | 2 +-
docs/driver27.txt | 8 +--
docs/driver28.txt | 4 +-
docs/driver29.txt | 2 +-
docs/driver35.txt | 2 +-
docs/driver4.txt | 2 +-
docs/driver40.txt | 2 +-
docs/driver5.txt | 2 +-
docs/driver7.txt | 4 +-
docs/driver8.txt | 22 ++++----
docs/extern.txt | 8 +--
docs/howto.txt | 4 +-
docs/includes/hand.txt | 1 -
docs/includes/install.txt | 2 -
docs/index.txt | 6 +-
docs/kern.txt | 2 +-
docs/keygen-body.txt | 10 ++--
docs/leap.txt | 2 +-
docs/miscopt.txt | 28 +++++-----
docs/monopt.txt | 12 ++--
docs/msyslog.txt | 10 ++--
docs/ntp-wait.txt | 8 +--
docs/ntpd-body.txt | 116 +++++++++++++++++++--------------------
docs/ntpd.txt | 2 +-
docs/ntpdsim.txt | 6 +-
docs/ntpdsim_new.txt | 2 +-
docs/ntpq-body.txt | 54 +++++++++---------
docs/ntpq.txt | 2 +-
docs/ntptime-body.txt | 2 +-
docs/ntptrace-body.txt | 2 +-
docs/parsedata.txt | 2 +-
docs/parsenew.txt | 2 +-
docs/quick.txt | 12 ++--
docs/rdebug.txt | 14 ++---
docs/sntp-body.txt | 4 +-
docs/stats.txt | 4 +-
docs/tickadj.txt | 10 ++--
libntp/README | 5 +-
ntp-keygen/ntp-keygen-man.txt.in | 4 +-
ntpd/ntp.conf.txt | 9 +--
ntpd/ntp.keys.txt | 2 +-
ntpd/ntpd-man.txt.in | 4 +-
ntpq/ntpq-man.txt.in | 4 +-
scripts/ntp-wait/ntp-wait.txt | 6 +-
sntp/sntp.txt | 4 +-
util/ntptime-man.txt.in | 4 +-
62 files changed, 297 insertions(+), 308 deletions(-)
diff --git a/conf/README b/conf/README
index c6d7609..3848cbb 100644
--- a/conf/README
+++ b/conf/README
@@ -1,13 +1,13 @@
-README file for directory ./conf of the NTP Version 4 distribution
+= README file for directory conf =
This directory contains example run-time configuration files for the
-NTP Version 4 daemon ntpd. These files illustrate some of the more
-obtuse configurations you may run into. They are not likely to do
-anything good if run on machines other than their native spot, so don't
-just blindly copy something and put it up. Additional information can
-be found in the ./html directory of the base directory.
+NTP daemon. These files illustrate some of the more obscure
+configuration options you may run into. They are not likely to do
+anything good if run on machines other than their native spot, so
+don't just blindly copy something and put it up. Additional
+information can be found in the ./docs directory of the base
+directory.
Included also are example public key and symmetric key files produced
by the ntp-genkeys program with names prefixed by ntpkey. These are
-ordinarily kept in /usr/local/etc and used by the Autokey scheme. See
-the authopt.htm pnd genkeys.htm ages for further information.
+ordinarily kept in /usr/local/etc and used by the Autokey scheme.
diff --git a/docs/access.txt b/docs/access.txt
index 35f1f0a..7bbdb80 100644
--- a/docs/access.txt
+++ b/docs/access.txt
@@ -20,7 +20,7 @@ include::includes/accopt.txt[]
== Access Control Support ==
-The `ntpd` daemon implements a general purpose access control list (ACL)
+The `{ntpd}` daemon implements a general purpose access control list (ACL)
containing address/match entries sorted first by increasing address
values and then by increasing mask values. A match occurs when the
bitwise AND of the mask and the packet source address is equal to the
diff --git a/docs/accopt.txt b/docs/accopt.txt
index 9e8b781..51148c5 100644
--- a/docs/accopt.txt
+++ b/docs/accopt.txt
@@ -70,7 +70,7 @@ the link:accopt.html[Access Control Support] page.
The name comes from Bob Braden's _flakeway_, which once did a
similar thing for early Internet testing.
`ignore`;;
- Deny packets of all kinds, including `ntpq` queries.
+ Deny packets of all kinds, including `{ntpq}` queries.
`kod`;;
Send a kiss-o'-death (KoD) packet if the `limited` flag is present
and a packet violates the rate limits established by the `discard`
@@ -79,7 +79,7 @@ the link:accopt.html[Access Control Support] page.
does not have the `limited` flag, no KoD responses will result.
`limited`;;
Deny time service if the packet violates the rate limits established
- by the `discard` command. This does not apply to `ntpq`
+ by the `discard` command. This does not apply to `{ntpq}`
queries.
`lowpriotrap`;;
Declare traps set by matching hosts to be low priority. The number
@@ -96,11 +96,11 @@ the link:accopt.html[Access Control Support] page.
this flag should be used only for a dedicated server with no clients
other than MS-SNTP.*
`nomodify`;;
- Deny `ntpq` queries which attempt to modify the state of
+ Deny `{ntpq}` queries which attempt to modify the state of
the server (i.e., run time reconfiguration). Queries which return
information are permitted.
`noquery`;;
- Deny `ntpq` queries. Time service is not affected.
+ Deny `{ntpq}` queries. Time service is not affected.
`nopeer`;;
Deny packets that might mobilize an association unless
authenticated. This includes broadcast, symmetric-active and
@@ -111,10 +111,10 @@ the link:accopt.html[Access Control Support] page.
does _not_ include the `nopeer` directive. Note that this flag does
not apply to packets that do not attempt to mobilize an association.
`noserve`;;
- Deny all packets except `ntpq` queries.
+ Deny all packets except `{ntpq}` queries.
`notrap`;;
Decline to provide mode 6 control message trap service to matching
- hosts. The trap service is a subsystem of the `ntpq` control
+ hosts. The trap service is a subsystem of the `{ntpq}` control
message protocol which is intended for use by remote event logging
programs.
`notrust`;;
diff --git a/docs/asciidoc.conf b/docs/asciidoc.conf
index aa97da5..70df7a7 100644
--- a/docs/asciidoc.conf
+++ b/docs/asciidoc.conf
@@ -14,12 +14,18 @@ project-security-list=security at ntpsec.org
project-bug-list=bugs at ntpsec.org
project-bugengine=Bugzilla
project-bugtracker="NTPsec"
-daemon=ntpd
millshome=http://www.eecis.udel.edu/~mills/
-ntp-keygen=ntp-keygen(8)
-ntpconf=ntpconf(5)
-ntpdate=ntpdate(8)
+ntpd=ntpd
+ntpdconf=ntpd.conf
+ntpq=ntpq
+sntp=sntp
+ntptime=ntp-time
+ntpwait=ntp-wait
+ntpconfman=ntpconf(5)
+ntokeysman=ntp.keys(5)
ntpdman=ntpd(8)
+ntpkeygenman=ntp-keygen(8)
ntpqman=ntpq(1)
-ntpwait=ntp-wait(1)
+ntptimeman=ntptime(1)
+ntpwaitman=ntp-wait(1)
sntpman=sntp(1)
diff --git a/docs/assoc.txt b/docs/assoc.txt
index f554cde..eda64fe 100644
--- a/docs/assoc.txt
+++ b/docs/assoc.txt
@@ -159,7 +159,7 @@ link:discover.html[Automatic Server Discovery Schemes] page.
NTP uses an intricate heuristic algorithm to automatically control the
poll interval for maximum accuracy consistent with minimum network
overhead. The algorithm measures the incidental offset and jitter to
-determine the best poll interval. When `ntpd` starts, the interval is
+determine the best poll interval. When `{ntpd}` starts, the interval is
the default minimum 64 s. Under normal conditions when the clock
discipline has stabilized, the interval increases in steps to the
default maximum 1024 s. In addition, should a server become unreachable
diff --git a/docs/audio.txt b/docs/audio.txt
index e9b14c9..7f438ee 100644
--- a/docs/audio.txt
+++ b/docs/audio.txt
@@ -83,7 +83,7 @@ order to assure reliable operation, the signal level must be in the
range where the audio gain control is effective. In general, this means
the input signal level must be such as to cause the AGC to set the gain
somewhere in the middle of the range from 0 to 255, as indicated in the
-timecode displayed by the `ntpq` program.
+timecode displayed by the `{ntpq}` program.
The IRIG driver operates by disciplining a logical clock based
on the codec sample clock to the audio signal as received. This is done
@@ -102,7 +102,7 @@ if set to zero or the line-in port if set to one. It does not seem
useful to specify the compact disc player port. The `fudge flag 3`
command enables the input signal monitor using the previously selected
output port and output gain. Both of these flags can be set in the
-configuration file or remotely using the `ntpq` utility program.
+configuration file or remotely using the `{ntpq}` utility program.
[[short]]
== Shortwave Radio Drivers ==
diff --git a/docs/authentic.txt b/docs/authentic.txt
index fb8edec..07a6e9b 100644
--- a/docs/authentic.txt
+++ b/docs/authentic.txt
@@ -145,7 +145,7 @@ intruder cannot disrupt the protocol by sending a bogus crypto-NAK.
Keys and related information are specified in a keys file, which must be
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`
+additional keys can be used as passwords for the `{ntpq}`
utility program. Ordinarily, the `ntp.keys` file is generated by the
`ntp-keygen` program, but it can be constructed and edited using an
ordinary text editor.
@@ -172,18 +172,18 @@ be added to change any field. The key can be change to a password, such
as `2late4Me` for key ID 10. Note that two or more keys files can be
combined in any order as long as the key IDs are distinct.
-When `ntpd` is started, it reads the keys file specified by the `keys`
+When `{ntpd}` is started, it reads the keys file specified by the `keys`
command and installs the keys in the key cache. However, individual keys
must be activated with the `trustedkey` configuration command before
use. This allows, for instance, the installation of possibly several
-batches of keys and then activating a key remotely using `ntpq`.
+batches of keys and then activating a key remotely using `{ntpq}`.
The `controlkey` command selects the key ID used as the password
-for the `ntpq` utility.
+for the `{ntpq}` utility.
[[windows]]
== Microsoft Windows Authentication ==
-In addition to the above means, `ntpd` supports Microsoft Windows
+In addition to the above means, `{ntpd}` supports Microsoft Windows
MS-SNTP authentication using Active Directory services. This support was
contributed by the Samba Team and is still in development. It is enabled
using the `mssntp` flag of the `restrict` command described on the
diff --git a/docs/authopt.txt b/docs/authopt.txt
index d21a6fe..1a8003c 100644
--- a/docs/authopt.txt
+++ b/docs/authopt.txt
@@ -33,7 +33,7 @@ the link:authentic.html[Authentication Support] page.
See the link:autokey.html[Autokey Public Key Authentication] page for
further information.
`controlkey` 'keyid'::
- Specifies the key ID for the link:ntpq.html[`ntpq`] utility, which
+ Specifies the key ID for the link:ntpq.html[`{ntpq}`] utility, which
uses the standard protocol defined in RFC-1305. The `keyid` argument
is the key ID for a link:#trustedkey[trusted key], where the value can
be in the range 1 to 65534, inclusive.
@@ -87,7 +87,7 @@ than to change the cryptographic media file names.#
information.
`keys` 'path'::
Specifies the complete directory path for the key file containing the
- key IDs, key types and keys used by `ntpd` and `ntpq` when
+ 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
same operation as the `-k` command line option. Note that the
@@ -106,7 +106,7 @@ than to change the cryptographic media file names.#
`trustedkey` ['keyid' | ('lowid' ... 'highid')] [...]::
Specifies the key ID(s) which are trusted for the purposes of
authenticating peers with symmetric key cryptography. Key IDs used to
- authenticate `ntpq` operations must be listed here and
+ authenticate `{ntpq}` operations must be listed here and
additionally be enabled with link:#controlkey[controlkey] and/or
link:#requestkey[requestkey]. The authentication procedure for time
transfer requires that both the local and remote NTP servers employ
diff --git a/docs/build.txt b/docs/build.txt
index 118fb74..98e9133 100644
--- a/docs/build.txt
+++ b/docs/build.txt
@@ -93,7 +93,7 @@ help or money so we can hire skilled technical help.
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
link:quick.html[Quick Start] page for orientation. Seasoned veterans can
-start with the link:ntpd.html[`ntpd` - Network Time Protocol (NTP)
+start with the link:ntpd.html[`{ntpd}` - Network Time Protocol (NTP)
daemon] page and move on to the specific configuration option pages from
there.
@@ -104,7 +104,7 @@ If you have problems with your hardware and software environment (e.g.
operating system-specific issues), browse the link:hints.html[Hints and
Kinks] pages. For other problems a tutorial on debugging technique is in
the link:debug.html[NTP Debugging Technique] page. A list of important
-system log messages is on the link:msyslog.html[`ntpd` System Log
+system log messages is on the link:msyslog.html[`{ntpd}` System Log
Messages] page.
The first line of general assistance is the {project-shortname} web site
diff --git a/docs/clockopt.txt b/docs/clockopt.txt
index c7acc95..54bdfb1 100644
--- a/docs/clockopt.txt
+++ b/docs/clockopt.txt
@@ -57,7 +57,7 @@ unit numbers must be unique.
This command can be used to configure reference clocks in special
ways. It must immediately follow the `server` command which configures
the driver. Note that the same capability is possible at run time
- using the link:ntpq.html[`ntpq`] program. The options are interpreted as follows:
+ using the link:ntpq.html[`{ntpq}`] program. The options are interpreted as follows:
`time1` 'sec';;
Specifies a constant to be added to the time offset produced by the
driver, a fixed-point decimal number in seconds. This is used as a
diff --git a/docs/confopt.txt b/docs/confopt.txt
index da36211..4e5d3ba 100644
--- a/docs/confopt.txt
+++ b/docs/confopt.txt
@@ -101,7 +101,7 @@ the link:assoc.html[Association Management] page.
This command removes a previously configured association. An address
or association ID can be used to identify the association. Either an
IP address or DNS name can be used. This command is most useful when
- supplied via `ntpq` runtime configuration commands `:config` and
+ supplied via `{ntpq}` runtime configuration commands `:config` and
`config-from-file`.
[[option]]
@@ -222,7 +222,7 @@ the link:assoc.html[Association Management] page.
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
- `mdnstries` times. After all, `ntpd` may be starting before mDNS. The
+ `mdnstries` times. After all, `{ntpd}` may be starting before mDNS. The
default value for `mdnstries` is 5.
'''''
diff --git a/docs/debug.txt b/docs/debug.txt
index e69f18d..c2d5071 100644
--- a/docs/debug.txt
+++ b/docs/debug.txt
@@ -18,21 +18,19 @@ include::includes/install.txt[]
== Initial Startup ==
-This page discusses `ntpd` program monitoring and debugging techniques
-using the link:ntpq.html[`ntpq` - standard NTP query program], either on
-the local server or from a remote machine. The `ntpq` program implements the
-management functions specified in the NTP specification
-http://www.eecis.udel.edu/%7emills/database/rfc/rfc1305/rfc1305c.ps[RFC-1305,
-Appendix A]. It is used to read and write the variables defined in the
-NTP Version 4 specification now navigating the standards process. In
-addition, the program can be used to send remote configuration commands
-to the server.
-
-The `ntpd` daemon can operate in two modes, depending on the presence of
-the `-d` command-line option. Without the option the daemon detaches
-from the controlling terminal and proceeds autonomously. With one or
-more `-d` options the daemon does not detach and generates special trace
-output useful for debugging. In general, interpretation of this output
+This page discusses `{ntpd}` program monitoring and debugging techniques
+using the link:ntpq.html[`{ntpq}` - standard NTP query program], either
+on the local server or from a remote machine. The `{ntpq}` program
+implements the management functions specified in the NTP specification
+https://tools.ietf.org/html/rfc5905[RFC-5905]. In addition, the
+program can be used to send remote configuration commands to the
+server.
+
+The `{ntpd}` daemon can operate in two modes, depending on the presence
+of the `-n` command-line option. Without the option the daemon
+detaches from the controlling terminal and proceeds autonomously. With
+one or more `-d` options the daemon generates special trace output
+useful for debugging. In general, interpretation of this output
requires reference to the sources. However, a single `-d` does produce
only mildly cryptic output and can be very useful in finding problems
with configuration and network troubles.
@@ -50,7 +48,7 @@ precision value. Event messages at startup and during regular operation
are sent to the optional `protostats` monitor file, as described on the
link:decode.html[Event Messages and Status Words] page. These and other
error messages are sent to the system log, as described on the
-link:msyslog.html[`ntpd` System Log Messages] page. In real emergencies
+link:msyslog.html[`{ntpd}` System Log Messages] page. In real emergencies
the daemon will sent a terminal error message to the system log and then
cease operation.
@@ -65,19 +63,19 @@ problems with the network or firewall configuration.
Unless using the `iburst` option, the client normally takes a few
minutes to synchronize to a server. If the client time at startup
-happens to be more than 1000 s distant from NTP time, the daemon exits
+happens to be more than 1000 sec distant from NTP time, the daemon exits
with a message to the system log directing the operator to manually set
-the time within 1000 s and restart. If the time is less than 1000 s but
-more than 128 s distant, a step correction occurs and the daemon
+the time within 1000 sec and restart. If the time is less than 1000 sec but
+more than 128 sec distant, a step correction occurs and the daemon
restarts automatically.
When started for the first time and a frequency file is not present, the
daemon enters a special mode in order to calibrate the frequency. This
-takes 900 s during which the time is not disciplined. When calibration
+takes 900 sec during which the time is not disciplined. When calibration
is complete, the daemon creates the frequency file and enters normal
mode to amortize whatever residual offset remains.
-The `ntpq` commands `pe`, `as` and `rv` are normally sufficient to
+The `{ntpq}` commands `pe`, `as` and `rv` are normally sufficient to
verify correct operation and assess nominal performance. The
link:ntpq.html#pe[`pe`] command displays a list showing the DNS name or
IP address for each association along with selected status and
@@ -140,10 +138,10 @@ The frequency tolerance of computer clock oscillators varies widely,
sometimes above 500 PPM. While the daemon can handle frequency errors up
to 500 PPM, or 43 seconds per day, values much above 100 PPM reduce the
headroom, especially at the lowest poll intervals. To determine the
-particular oscillator frequency, start `ntpd` using the `noselect`
+particular oscillator frequency, start `{ntpd}` using the `noselect`
option with the `server` configuration command.
-Record the time of day and offset displayed by the `ntpq`
+Record the time of day and offset displayed by the `{ntpq}`
link:ntpq.html#pe[`pe`] command. Wait for an hour or so and record the
time of day and offset. Calculate the frequency as the offset difference
divided by the time difference. If the frequency is much above 100 PPM,
@@ -153,7 +151,7 @@ this program, this might be one using a command in the system startup
file.
== Access Controls ==
-Provisions are included in `ntpd` for access controls which deflect
+Provisions are included in `{ntpd}` for access controls which deflect
unwanted traffic from selected hosts or networks. The controls described
on the link:accopt.html[Access Control Options] include detailed packet
filter operations based on source address and address mask. Normally,
@@ -179,20 +177,20 @@ network delays during some period of the day and moderate to high delays
during other periods. Often the delay on one direction of transmission
dominates, which can result in large time offset errors, sometimes in
the range up to a few seconds. It is not usually convenient to run
-`ntpd` throughout the day in such scenarios, since this could result in
+`{ntpd}` throughout the day in such scenarios, since this could result in
several time steps, especially if the condition persists for greater
than the stepout threshold.
-Specific provisions have been built into `ntpd` to cope with these
+Specific provisions have been built into `{ntpd}` to cope with these
problems. The scheme is called "huff-'n-puff and is described on the
link:miscopt.html[Miscellaneous Options] page. An alternative approach
in such scenarios is first to calibrate the local clock frequency error
-by running `ntpd` in continuous mode during the quiet interval and let
-it write the frequency to the `ntp.drift` file. Then, run `ntpd -q` from
+by running `{ntpd}` in continuous mode during the quiet interval and let
+it write the frequency to the `ntp.drift` file. Then, run `{ntpd} -q` from
a cron job each day at some time in the quiet interval. In systems with
the nanokernel or microkernel performance enhancements, including
Solaris, Tru64, Linux and FreeBSD, the kernel continuously disciplines
-the frequency so that the residual correction produced by `ntpd` is
+the frequency so that the residual correction produced by `{ntpd}` is
usually less than a few milliseconds.
== Cryptographic Authentication ==
@@ -209,7 +207,7 @@ required are produced by the link:keygen.html[`ntp-keygen`] program.
Problems with symmetric key authentication are usually due to mismatched
keys or improper use of the `trustedkey` command. A simple way to check
for problems is to use the trace facility, which is enabled using the
-`ntpd -d` command line. As each packet is received a trace line is
+`{ntpd} -d` command line. As each packet is received a trace line is
displayed which shows the authentication status in the `auth` field. A
status of 1 indicates the packet was successful authenticated; otherwise
it has failed.
@@ -227,7 +225,7 @@ easily strike up an association and inject false time values.
Public key cryptography is supported in NTPv4 using the Autokey
protocol, which is described in briefings on the {project-page}
linked from {project-domain}
-Development of this protocol is mature and the `ntpd` implementation
+Development of this protocol is mature and the `{ntpd}` implementation
is basically complete. Autokey version 2, which is the latest and
current version, includes provisions to hike certificate trails,
operate as certificate authorities and verify identity using
@@ -260,17 +258,17 @@ extension field to show the host name, status word and association ID.
== Debugging Checklist ==
-If the `ntpq` or program does not show that messages are being
+If the `{ntpq}` or program does not show that messages are being
received by the daemon or that received messages do not result in
correct synchronization, verify the following:
1. Verify the `/etc/services` file host machine is configured to accept
UDP packets on the NTP port 123. NTP is specifically designed to use UDP
and does not respond to TCP.
-2. Check the system log for `ntpd` messages about configuration errors,
+2. Check the system log for `{ntpd}` messages about configuration errors,
name-lookup failures or initialization problems. Common system log
-messages are summarized on the link:msyslog.html[`ntpd` System Log
-Messages] page. Check to be sure that only one copy of `ntpd` is
+messages are summarized on the link:msyslog.html[`{ntpd}` System Log
+Messages] page. Check to be sure that only one copy of `{ntpd}` is
running.
3. Verify using `ping` or other utility that packets actually do make
the round trip between the client and server. Verify using `nslookup` or
@@ -278,7 +276,7 @@ other utility that the DNS server names do exist and resolve to valid
Internet addresses.
4. Check that the remote NTP server is up and running. The usual
evidence that it is not is a `Connection refused` message.
-5. Using the `ntpq` program, verify that the packets received and
+5. Using the `{ntpq}` program, verify that the packets received and
packets sent counters are incrementing. If the sent counter does not
increment and the configuration file includes configured servers,
something may be wrong in the host network or interface configuration.
@@ -287,18 +285,18 @@ increment, something may be wrong in the network or the server NTP
daemon may not be running or the server itself may be down or not
responding.
6. If both the sent and received counters do increment, but the `reach`
-values in the `pe` billboard with `ntpq` continues to show zero,
+values in the `pe` billboard with `{ntpq}` continues to show zero,
received packets are probably being discarded for some reason. If this
is the case, the cause should be evident from the `flash` variable as
-discussed above and on the `ntpq` page. It could be that the server has
+discussed above and on the `{ntpq}` page. It could be that the server has
disabled access for the client address, in which case the `refid` field
-in the `ntpq pe` billboard will show a kiss code. See earlier on this
+in the `{ntpq} pe` billboard will show a kiss code. See earlier on this
page for a list of kiss codes and their meaning.
7. If the `reach` values in the `pe` billboard show the servers are
alive and responding, note the tattletale symbols at the left margin,
which indicate the status of each server resulting from the various
grooming and mitigation algorithms. The interpretation of these symbols
-is discussed on the `ntpq` page. After a few minutes of operation, one
+is discussed on the `{ntpq}` page. After a few minutes of operation, one
or another of the reachable server candidates should show a * tattletale
symbol. If this doesn't happen, the intersection algorithm, which
classifies the servers as truechimers or falsetickers, may be unable to
diff --git a/docs/decode.txt b/docs/decode.txt
index aae5506..2994ad8 100644
--- a/docs/decode.txt
+++ b/docs/decode.txt
@@ -32,13 +32,13 @@ include::includes/install.txt[]
== Introduction ==
This page lists the status words, event messages and error codes used
-for `ntpd` reporting and monitoring. Status words are used to display
+for `{ntpd}` reporting and monitoring. Status words are used to display
the current status of the running program. There is one system status
word and a peer status word for each association. There is a clock
status word for each association that supports a reference clock. There
is a flash code for each association which shows errors found in the
last packet received (pkt) and during protocol processing (peer). These
-are commonly viewed using the `ntpq` program.
+are commonly viewed using the `{ntpq}` program.
Significant changes in program state are reported as events. There is
one set of system events and a set of peer events for each association.
@@ -63,7 +63,7 @@ error diagnosis and performance assessment.
The system status word consists of four fields LI (0-1), Source (2-7),
Count (8-11) and Event (12-15). It is reported in the first line of the
-`rv` display produced by the `ntpq` program.
+`rv` display produced by the `{ntpq}` program.
[width="50%"]
|=======================
@@ -131,7 +131,7 @@ The Event Field displays the most recent event message coded as follows:
The peer status word consists of four fields: Status (0-4), Select
(5-7), Count (8-11) and Code (12-15). It is reported in the first line
-of the `rv associd` display produced by the `ntpq` program.
+of the `rv associd` display produced by the `{ntpq}` program.
[width="50%"]
|===============================
@@ -156,7 +156,7 @@ Field is listed in the following table:
The Select Field displays the current selection status. (The T Field in
the following table gives the corresponding tally codes used in the
-`ntpq peers` display.) The values are coded as follows:
+`{ntpq} peers` display.) The values are coded as follows:
[width="100%",cols="<25%,<25%,<25%,<25%",]
|================================================================================
@@ -185,7 +185,7 @@ The Event Field displays the most recent event message coded as follows:
| `03` | `unreachable` | server unreachable
| `04` | `reachable` | server reachable
| `05` | `restart` | association restart
-| `06` | `no_reply` | no server found (`ntpdate` mode)
+| `06` | `no_reply` | no server found
| `07` | `rate_exceeded` | rate exceeded (kiss code `RATE`)
| `08` | `access_denied` | access denied (kiss code `DENY`)
| `09` | `leap_armed` | leap armed from server LI code
@@ -202,7 +202,7 @@ The Event Field displays the most recent event message coded as follows:
The clock status word consists of four fields: Unused (0-7), Count
(8-11) and Code (12-15). It is reported in the first line of the
-`clockvar associd` display produced by the `ntpq` program.
+`clockvar associd` display produced by the `{ntpq}` program.
[width="50%"]
|=========================
@@ -231,7 +231,7 @@ peer event is reported.
[[flash]]
== Flash Status Word ==
-The flash status word is displayed by the `ntpq` program `rv` command.
+The flash status word is displayed by the `{ntpq}` program `rv` command.
It consists of a number of bits coded in hexadecimal as follows:
[width="100%",cols="<25%,<25%,<25%,<25%",]
@@ -262,7 +262,7 @@ Kiss codes are used in kiss-o'-death (KoD) packets, billboard displays
and log messages. They consist of a string of four zero-padded ASCII
charactes. In practice they are informal and tend to change with time
and implementation. Some of these codes can appear in the reference
-identifier field in `ntpq` billboards. Following is the current list:
+identifier field in `{ntpq}` billboards. Following is the current list:
[width="100%",cols="<50%,<50%",]
|==================================================================
diff --git a/docs/discover.txt b/docs/discover.txt
index 9844ec5..314a980 100644
--- a/docs/discover.txt
+++ b/docs/discover.txt
@@ -238,8 +238,8 @@ principle, it is possible to use a configuration file containing a
single line `pool pool.ntp.org`. The
http://www.pool.ntp.org/en/use.html[NTP Pool Project] offers
instructions on using the pool with the `server` command, which is
-suboptimal but works with older versions of `ntpd` predating the `pool`
-command. With recent ntpd, consider replacing the multiple `server`
+suboptimal but works with older versions of `{ntpd}` predating the `pool`
+command. Consider replacing the multiple `server`
commands in their example with a single `pool` command.
'''''
diff --git a/docs/driver18.txt b/docs/driver18.txt
index f62e6f5..5597655 100644
--- a/docs/driver18.txt
+++ b/docs/driver18.txt
@@ -37,7 +37,7 @@ changes for nonstandard modems or special circumstances.
There are three modes of operation selected by the `mode` keyword in the
`server` configuration command. In manual mode (2) the calling program
is initiated by setting fudge `flag1`. This can be done manually using
-`ntpq`, or by a cron job. In auto mode (0) `flag1` is set at each poll
+`{ntpq}`, or by a cron job. In auto mode (0) `flag1` is set at each poll
event. In backup mode (1) `flag1` is set at each poll event, but only if
no other synchronization sources are available.
@@ -49,7 +49,7 @@ including the prefix and long-distance digits and delay code, if
necessary. The `flag1` is reset and the calling program terminated if
(a) valid clock update has been determined, (b) no more numbers remain
in the list, (c) a device fault or timeout occurs or (d) fudge `flag1`
-is reset manually using `ntpq`.
+is reset manually using `{ntpq}`.
The driver automatically recognizes the message format of each modem
time service. It selects the parsing algorithm depending on the message
diff --git a/docs/driver20.txt b/docs/driver20.txt
index 3f57697..d0faa31 100644
--- a/docs/driver20.txt
+++ b/docs/driver20.txt
@@ -151,7 +151,7 @@ be configured to transmit the relevant data only, e.g. one `$GPRMC` or
== Monitor Data ==
The last GPS sentence that is accepted or rejected is written to the
-clockstats file and available with `ntpq -c clockvar`. (Logging the
+clockstats file and available with `{ntpq} -c clockvar`. (Logging the
rejected sentences lets you see/debug why they were rejected.) Filtered
sentences are not logged.
@@ -233,7 +233,7 @@ switched on by sending the following string.
If PPS signal processing is enabled, capture the pulse on the rising
edge if 0 (default); capture on the falling edge if 1.
`flag3 0 | 1`::
- If PPS signal processing is enabled, use the `ntpd` clock discipline
+ If PPS signal processing is enabled, use the `{ntpd}` clock discipline
if 0 (default); use the kernel discipline if 1.
`flag4 0 | 1`::
Obscures location in timecode: 0 for disable (default), 1 for enable.
diff --git a/docs/driver22.txt b/docs/driver22.txt
index 6c88fb6..519c5f5 100644
--- a/docs/driver22.txt
+++ b/docs/driver22.txt
@@ -51,7 +51,7 @@ The PPS source can be connected via a serial or parallel port, depending
on the hardware and operating system. A serial port can be dedicated to
the PPS source or shared with another device; however, if dedicated the
data leads should not be connected, as noise or unexpected signals can
-cause `ntpd` to exit.
+cause `{ntpd}` to exit.
A radio clock is usually connected via a serial port and the PPS source
connected via a level converter to the data carrier detect (DCD) pin
diff --git a/docs/driver27.txt b/docs/driver27.txt
index 62f0618..1a8f295 100644
--- a/docs/driver27.txt
+++ b/docs/driver27.txt
@@ -111,15 +111,15 @@ reported precision (and thus increase reported dispersion).
If we force resyncs to MSF too often we will needlessly exhaust the
batteries the unit runs from. During clock resync this driver tries to
-take enough time samples to avoid `ntpd` losing sync in case this clock
+take enough time samples to avoid the NTP daemon losing sync in case this clock
is the current peer. By default the clock would only resync to MSF about
once per day, which would almost certainly not be acceptable for NTP
purposes.
The driver does not force an immediate resync of the clock to MSF when
-it starts up to avoid excessive battery drain in case `ntpd` is going to
+it starts up to avoid excessive battery drain in case `{ntpd}` is going to
be repeatedly restarted for any reason, and also to allow enough samples
-of the clock to be taken for `ntpd` to sync immediately to this clock
+of the clock to be taken for `{ntpd}` to sync immediately to this clock
(and not remain unsynchronised or to sync briefly to another configured
peer, only to hop back in a few poll times, causing unnecessary
disturbance). This behaviour should not cause problems because the
@@ -343,7 +343,7 @@ There are a few `#defineS` in the code that you might wish to play with:
With this defined, the code is relatively trusting of the clock, and
assumes that you will have the clock as one of a few time sources, so
will bend over backwards to use the time from the clock when available
- and avoid `ntpd` dropping sync from the clock where possible. You may
+ and avoid `{ntpd}` dropping sync from the clock where possible. You may
wish to undefine this, especially if you have better sources of time or
your reception is ropey. However, there are many checks built in even
with this flag defined.
diff --git a/docs/driver28.txt b/docs/driver28.txt
index dea137d..45c3965 100644
--- a/docs/driver28.txt
+++ b/docs/driver28.txt
@@ -197,14 +197,14 @@ be hex-decoded as \'NTP0', \'NTP1',..., with funny characters for units >
Public access means a permission set of 0666, while private access
creates the mapping with a permission set of 0600.
-{daemon} is started as root on most POSIX-like operating systems and uses
+{ntpd} is started as root on most POSIX-like operating systems and uses
the setuid/setgid system API to run under reduced rights once the
initial setup of the process is done. One consequence out of this is
that the allocation of SHM segments must be done early during the clock
setup. The actual polling of the clock is done as the run-time user;
deferring the creation of the SHM segment to this point will create a
SHM segment owned by the runtime-user account. The internal structure of
-{daemon} does not permit the use of a fudge flag if this is to be avoided;
+{ntpd} does not permit the use of a fudge flag if this is to be avoided;
this is the reason why a mode bit is used for the configuration of a
public segment.
diff --git a/docs/driver29.txt b/docs/driver29.txt
index d8c5ee1..5f409b0 100644
--- a/docs/driver29.txt
+++ b/docs/driver29.txt
@@ -192,7 +192,7 @@ the interface module. It should flash once per second.
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.
-8. Remove fudge flag2 and restart *ntpd* in debug mode to observe
+8. Remove fudge flag2 and restart the daemon in debug mode to observe
palisade_receive events.
9. If event polling fails, verify the link:#Pinouts[connections] and
that the host hardware supports RTS control.
diff --git a/docs/driver35.txt b/docs/driver35.txt
index ed2441a..2b5ec86 100644
--- a/docs/driver35.txt
+++ b/docs/driver35.txt
@@ -31,7 +31,7 @@ http://schumann.cx/pcfclock/[FreeBSD] are available.
This driver uses C library functions to convert the received timecode to
UTC and thus requires that the local timezone be CET or CEST. If your
server is not located in Central Europe you have to set the environment
-variable TZ to CET before starting `ntpd`.
+variable TZ to CET before starting `{ntpd}`.
== Monitor Data ==
diff --git a/docs/driver4.txt b/docs/driver4.txt
index 040ff4d..b80f369 100644
--- a/docs/driver4.txt
+++ b/docs/driver4.txt
@@ -103,7 +103,7 @@ received.
If PPS signal processing is enabled, capture the pulse on the rising
edge if 0 (default); capture on the falling edge if 1.
`flag3 0 | 1`::
- If PPS signal processing is enabled, use the `ntpd` clock discipline
+ If PPS signal processing is enabled, use the `{ntpd}` clock discipline
if 0 (default); use the kernel discipline if 1.
`flag4 0 | 1`::
Enable verbose `clockstats` recording if set.
diff --git a/docs/driver40.txt b/docs/driver40.txt
index 3ac8fcf..ea4701f 100644
--- a/docs/driver40.txt
+++ b/docs/driver40.txt
@@ -355,7 +355,7 @@ The driver writes sent and received data to/from the JJY receivers, GPS
clock, and the modem into the `clockstats` file.
----------------------------------------------------------------
-statsdir /var/log/ntpd/
+statsdir /var/log/{ntpd}/
filegen clockstats file clockstats type day enable `
----------------------------------------------------------------
diff --git a/docs/driver5.txt b/docs/driver5.txt
index a9f0f1b..33c1e99 100644
--- a/docs/driver5.txt
+++ b/docs/driver5.txt
@@ -109,7 +109,7 @@ written as-is to the `clockstats` file.
Specifies the driver reference identifier, an ASCII string from one to
four characters, with default `TRUE`.
`flag1 0 | 1`::
- Silence the clock side of ntpd, just reading the clock without trying to
+ Silence the clock side of {ntpd}, just reading the clock without trying to
write to it.
`flag2 0 | 1`::
Generate a debug file /tmp/true%d.
diff --git a/docs/driver7.txt b/docs/driver7.txt
index 1aa8ad4..afce203 100644
--- a/docs/driver7.txt
+++ b/docs/driver7.txt
@@ -227,11 +227,11 @@ two stations in turn in order to measure the metric.
== Debugging Aids ==
-The most convenient way to track the program status is using the `ntpq`
+The most convenient way to track the program status is using the `{ntpq}`
program and the `clockvar` command. This displays the last determined
timecode and related status and error counters, even when the program is
not discipline the system clock. If the debugging trace feature (`-d` on
-the `ntpd` command line) is enabled, the program produces detailed
+the `{ntpd}` command line) is enabled, the program produces detailed
status messages as it operates. If the `fudge flag 4` is set, these
messages are written to the `clockstats` file. All messages produced by
this driver have the prefix `chu` for convenient filtering with the Unix
diff --git a/docs/driver8.txt b/docs/driver8.txt
index 4f650c1..3e826ff 100644
--- a/docs/driver8.txt
+++ b/docs/driver8.txt
@@ -31,16 +31,16 @@ the receiver-generated time stamps for feeding the PPS loopfilter
control for much finer clock synchronization.
CAUTION: The PPS configuration option is different from the hardware PPS
-signal, which is also supported (see below), as it controls the way ntpd
+signal, which is also supported (see below), as it controls the way {ntpd}
is synchronized to the reference clock, while the hardware PPS signal
controls the way time offsets are determined.
The use of the PPS option requires receivers with an accuracy of better
than 1ms.
-== Timecode variables listed by ntpq (8) ==
+== Timecode variables listed by {ntpqman} ==
-The ntpq program can read and display several clock variables. These
+The {ntpq} program can read and display several clock variables. These
hold the following information:
refclock_format::
@@ -133,7 +133,7 @@ http://www.meinberg.de/english/products/gps-pcicard.htm[the GPS PCI
card] or http://www.meinberg.de/english/products/dcf-pcicard.htm[the
DCF77 PCI card]. Please note the
http://www.meinberg.de/english/sw/#linux[Meinberg Linux driver] must be
-installed. That driver emulates a refclock device in order to allow ntpd
+installed. That driver emulates a refclock device in order to allow {ntpd}
to access those cards. For details, please refer to the README file
that comes with the Meinberg driver package.
@@ -316,7 +316,7 @@ via the serial port.
Clock state statistics are written hourly to the syslog
service. Online information can be found by examining the clock
-variables via the ntpq cv command.
+variables via the {ntpq} cv command.
Some devices have quite extensive additional information
(GPS16x/GPS17x, Trimble). The driver reads out much of the internal GPS
@@ -324,10 +324,10 @@ data and makes it accessible via clock variables. To find out about
additional variable names, query for the clock_var_list variable on a
specific clock association as shown below.
-First let ntpq display the table of associations:
+First let {ntpq} display the table of associations:
-------------------------------------------------------------
- ntpq> as
+ {ntpq}> as
ind assID status conf reach auth condition last_event cnt
===========================================================
1 19556 9154 yes yes none falsetick reachable 5
@@ -337,11 +337,11 @@ First let ntpq display the table of associations:
Then switch to raw output. This may be required because of display
-limitations in ntpq/ntpd - so large lists need to be retrieved in
+limitations in {ntpq}/{ntpd} - so large lists need to be retrieved in
several queries.
----------------------------------------
- ntpq> raw
+ {ntpq}> raw
Output set to raw
----------------------------------------
@@ -349,7 +349,7 @@ Use the cv command to read the list of clock variables of a selected
association:
----------------------------------------
- ntpq> cv 19557 clock_var_list
+ {ntpq}> cv 19557 clock_var_list
----------------------------------------
The long output of the command above looks similar to:
@@ -368,7 +368,7 @@ Then use the cv command again to list selected clock variables. The
following command must be entered as a single line:
----------------------------------------
- ntpq> cv 19557 refclock_status,refclock_format,refclock_states,refclock_id, refclock_iomode,refclock_driver_version,meinberg_gps_status,gps_utc_correction, gps_message,meinberg_antenna_status,gps_tot_51,gps_tot_63,gps_t0a,gps_cfg[1], gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3],gps_health[3],gps_cfg[4], gps_health[4],gps_cfg[5]
+ {ntpq}> cv 19557 refclock_status,refclock_format,refclock_states,refclock_id, refclock_iomode,refclock_driver_version,meinberg_gps_status,gps_utc_correction, gps_message,meinberg_antenna_status,gps_tot_51,gps_tot_63,gps_t0a,gps_cfg[1], gps_health[1],gps_cfg[2],gps_health[2],gps_cfg[3],gps_health[3],gps_cfg[4], gps_health[4],gps_cfg[5]
----------------------------------------
The output of the command above is wrapped around depending on the
diff --git a/docs/extern.txt b/docs/extern.txt
index 5710977..accc7ab 100644
--- a/docs/extern.txt
+++ b/docs/extern.txt
@@ -17,7 +17,7 @@ protocol, such as the `Lockclock` algorithm used with NIST Automated
Computer Time Service (ACTS) modem synchronized time.
When external clocks are used in conjunction with NTP service, some way
-needs to be provided for the external clock driver and NTP daemon `ntpd`
+needs to be provided for the external clock driver and NTP daemon `{ntpd}`
to communicate and determine which discipline is in control. This is
necessary in order to provide backup, for instance if the external clock
or protocol were to fail and synchronization service fall back to other
@@ -37,10 +37,10 @@ information, as well as error statistics, to the kernel. Besides
disciplining the system time, the same interface can be used by other
applications to determine the operating parameters of the discipline.
-When the external clock is enabled, `ntpd` does not discipline the
+When the external clock is enabled, `{ntpd}` does not discipline the
system clock, nor does it maintain the error statistics. In this case,
the external clock and driver do this using mechanisms unknown to
-`ntpd`; however, in this case the kernel state variables are retrieved
+`{ntpd}`; however, in this case the kernel state variables are retrieved
at 64-s intervals by the Local Clock driver and used by the clock
selection and mitigation algorithms to determine the system variables
presented to other NTP clients and peers. In this way, downstream
@@ -54,7 +54,7 @@ Boolean variables and certain bits in the kernel clock status word. The
Boolean variables include the following:
`ntp_enable`::
- Set/reset by the `enable` command. Enables ntpd clock discipline
+ Set/reset by the `enable` command. Enables {ntpd} clock discipline
`ntp_control`::
Set during initial configuration if kernel support is available
diff --git a/docs/howto.txt b/docs/howto.txt
index a66c8a5..3e79692 100644
--- a/docs/howto.txt
+++ b/docs/howto.txt
@@ -138,12 +138,12 @@ decidedly beyond the scope of this page.
The `./libntp/clktype` array is used by certain display functions. A
unique short-form name of the driver should be entered together with
its assigned identification code.
-`./ntpd/ntp_control.c`::
+`./{ntpd}/ntp_control.c`::
The `clocktypes` array is used for certain control message displays
functions. It should be initialized with the reference clock class
assigned to the driver, as per the NTP specification RFC-1305. See the
`./include/ntp_control.h` header file for the assigned classes.
-`./ntpd/refclock_conf.c`::
+`./{ntpd}/refclock_conf.c`::
This file contains a list of external structure definitions which are
conditionally defined. A new set of entries should be installed
similar to those already in the table. The `refclock_conf` array is a
diff --git a/docs/includes/hand.txt b/docs/includes/hand.txt
index 3fd3109..3cf426a 100644
--- a/docs/includes/hand.txt
+++ b/docs/includes/hand.txt
@@ -1,5 +1,4 @@
== Handbook Pages ==
-* link:release.html[NTP Version 4 Release Notes]
* link:comdex.html[Command Index]
* link:access.html[Access Control Support]
* link:assoc.html[Association Management]
diff --git a/docs/includes/install.txt b/docs/includes/install.txt
index 071770a..2762d25 100644
--- a/docs/includes/install.txt
+++ b/docs/includes/install.txt
@@ -1,9 +1,7 @@
== Build and Install ==
* link:build.html[Building and Installing the Distribution]
-* link:config.html[Build Options]
* link:rdebug.html[Debugging Reference Clock Drivers]
* link:quick.html[Quick Start]
-* link:release.html[NTP Version 4 Release Notes]
* link:debug.html[NTP Debugging Techniques]
* link:bugs.html[NTP Bug Reporting Procedures]
* link:sitemap.html[Site Map]
diff --git a/docs/index.txt b/docs/index.txt
index fecf31b..2840853 100644
--- a/docs/index.txt
+++ b/docs/index.txt
@@ -80,7 +80,7 @@ few will be user-visible:
* The documentation has been extensively updated and revised.
-* The deprecated ntpdc utility, long since replaced by ntpq, has been removed.
+* The deprecated ntpdc utility, long since replaced by {ntpq}, has been removed.
* A number of obsolete refclocks have been removed.
@@ -112,8 +112,6 @@ A good deal of tutorial and directive information is available on the
handbook pages. These should be read in conjunction with the command and
option information available on the pages listed on the sitemap page.
-link:release.html[NTP Version 4 Release Notes]::
- Lists recent changes and new features in the current distribution.
link:assoc.html[Association Management]::
Describes how to configure servers and peers and manage the various
options. Includes automatic server discovery schemes.
@@ -149,7 +147,7 @@ distribution root.
Like other things in modern Internet life, NTP problems can be
devilishly intricate. This distribution includes a number of utilities
designed to identify and repair problems using an integrated management
-protocol supported by the link:ntpq.html[`ntpq`] utility program.
+protocol supported by the link:ntpq.html[`{ntpq}`] utility program.
The link:debug.html[NTP Debugging Techniques] and link:hints.html[Hints
and Kinks] pages contain useful information for identifying problems and
diff --git a/docs/kern.txt b/docs/kern.txt
index b557e2a..5946f00 100644
--- a/docs/kern.txt
+++ b/docs/kern.txt
@@ -17,7 +17,7 @@ include::includes/misc.txt[]
The technical report [2], which is a revision and update of an earlier
report [3], describes an engineering model for a precision clock
discipline function for a generic operating system. The model is the
-same hybrid phase/frequecy-lock feedback loop used by `ntpd`, but
+same hybrid phase/frequecy-lock feedback loop used by `{ntpd}`, but
implemented in the kernel. The code described in [2] is included in
Solaris and Digital/Compaq/HP Tru64. It provides two system calls
`ntp_gettime()` and `ntp_adjtime()` and can discipline the system clock
diff --git a/docs/keygen-body.txt b/docs/keygen-body.txt
index c13b4fb..8846dc2 100644
--- a/docs/keygen-body.txt
+++ b/docs/keygen-body.txt
@@ -5,7 +5,7 @@
[[synop]]
== Synopsis ==
-`{ntp-keygen}` [ `-deGHIMPT` ] [ `-b` 'modulus' ] [ `-c` [ `RSA-MD2` | `RSA-MD5` | `RSA-SHA` | `RSA-SHA1` | `RSA-MDC2` | `RSA-RIPEMD160` | `DSA-SHA` | `DSA-SHA1` ] ] [ `-C` 'cipher' ] [`-i` 'group' ] [ `-l` 'days'] [ `-m` 'modulus' ] [ `-p` 'passwd1' ] [ `-q` 'passwd2' ] [ `-S` [ `RSA` | `DSA` ] ] [ `-s` 'host' ] [ `-V` 'nkeys' ]
+`{ntpkeygenman}` [ `-deGHIMPT` ] [ `-b` 'modulus' ] [ `-c` [ `RSA-MD2` | `RSA-MD5` | `RSA-SHA` | `RSA-SHA1` | `RSA-MDC2` | `RSA-RIPEMD160` | `DSA-SHA` | `DSA-SHA1` ] ] [ `-C` 'cipher' ] [`-i` 'group' ] [ `-l` 'days'] [ `-m` 'modulus' ] [ `-p` 'passwd1' ] [ `-q` 'passwd2' ] [ `-S` [ `RSA` | `DSA` ] ] [ `-s` 'host' ] [ `-V` 'nkeys' ]
[[descrip]]
== Description ==
@@ -39,7 +39,7 @@ random bit strings suitable for the SHA1 and other message digest
algorithms. The message digest keys file must be distributed and stored
using secure means beyond the scope of NTP itself. Besides the keys used
for ordinary NTP associations, additional keys can be defined as
-passwords for the link:ntpq.html[`ntpq`] utility program.
+passwords for the link:ntpq.html[`{ntpq}`] utility program.
The remaining generated files are compatible with other OpenSSL
applications and other Public Key Infrastructure (PKI) resources.
@@ -58,7 +58,7 @@ The `pw` option of the `crypto` configuration command specifies the read
password for previously encrypted local files. This must match the local
password used by this program. If not specified, the host name is used.
Thus, if files are generated by this program without password, they can
-be read back by `ntpd` without password, but only on the same host.
+be read back by `{ntpd}` without password, but only on the same host.
Normally, encrypted files for each host are generated by that host and
used only by that host, although exceptions exist as noted later on this
@@ -164,7 +164,7 @@ link:autokey.html[Autokey Public-Key Authentication] page.
`-i` or using `-s` following an `@` character, is also used in
certificate subject and issuer names in the form `host at group` and
should match the group specified via `crypto ident` or `server ident`
- in ntpd's configuration file.
+ in {ntpd}'s configuration file.
`-I`::
Generate a new encrypted IFF key file for the Schnorr (IFF) identity
scheme. This option is mutually exclusive with the `-G` and `-V`
@@ -323,7 +323,7 @@ The recommended practice is to keep the file name extensions when
installing a file and to install a soft link from the generic names
specified elsewhere on this page to the generated files. This allows new
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.
+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
diff --git a/docs/leap.txt b/docs/leap.txt
index a16a693..8842047 100644
--- a/docs/leap.txt
+++ b/docs/leap.txt
@@ -38,7 +38,7 @@ clock or downstratum server, a leapseconds file can be downloaded from
time.nist.gov and installed using the
link:miscopt.html#leapfile[leapfile] command. The file includes a list
of historic leap seconds and the NTP time of insertion. It is parsed by
-the `ntpd` daemon at startup and the latest leap time saved for future
+the `{ntpd}` daemon at startup and the latest leap time saved for future
reference. Each time the clock is set, the current time is compared with
the last leap time. If the current time is later than the last leap
time, nothing further is done. If earlier, the leap timer is initialized
diff --git a/docs/miscopt.txt b/docs/miscopt.txt
index c13fe64..23087f0 100644
--- a/docs/miscopt.txt
+++ b/docs/miscopt.txt
@@ -53,7 +53,7 @@ to replace the old version.
`disable [auth | bclient | calibrate | kernel | monitor | ntp | stats]`::
Provides a way to enable or disable various system options. Flags not
mentioned are unaffected. Note that most of these flags can be
- modified remotely using link:ntpq.html[`ntpq`] utility program's
+ modified remotely using link:ntpq.html[`{ntpq}`] utility program's
`:config` and `config-from-file` commands.
`auth`;;
Enables the server to synchronize with unconfigured peers only if
@@ -70,7 +70,7 @@ to replace the old version.
Enables the kernel time discipline, if available. The default for
this flag is enable if support is available, otherwise disable.
`monitor`;;
- Enables the monitoring facility. See the link:ntpq.html[`ntpq`
+ Enables the monitoring facility. See the link:ntpq.html[`{ntpq}`
program] and the `monstats` and `mrulist` commands, as well as the
link:accopt.html#discard[Access Control Options] for details. The
monitoring facility is also enabled by the presence of
@@ -84,22 +84,22 @@ to replace the old version.
Enables the statistics facility. See the link:monopt.html[Monitoring
Options] page for further information. The default for this flag is
enabled. This flag is excluded from runtime configuration using
- `ntpq`.
+ `{ntpq}`.
`includefile` 'includefile'::
This command allows additional configuration commands to be included
from a separate file. Include files may be nested to a depth of five;
upon reaching the end of any include file, command processing resumes
in the previous configuration file. This option is useful for sites
- that run `ntpd` on multiple hosts, with (mostly) common options (e.g.,
+ that run `{ntpd}` on multiple hosts, with (mostly) common options (e.g.,
a restriction list).
`interface` [`listen | ignore | drop] [all | ipv4 | ipv6 | wildcard` | 'name' | 'address'[/'prefixlen']]::
- This command controls which network addresses `ntpd` opens, and
+ This command controls which network addresses `{ntpd}` opens, and
whether input is dropped without processing. The first parameter
determines the action for addresses which match the second parameter.
That parameter specifies a class of addresses, or a specific interface
name, or an address. In the address case, _`prefixlen`_ determines how
many bits must match for this rule to apply. `ignore` prevents opening
- matching addresses, `drop` causes `ntpd` to open the address and drop
+ matching addresses, `drop` causes `{ntpd}` to open the address and drop
all received packets without examination. Multiple `interface`
commands can be used. The last rule which matches a particular address
determines the action for it. `interface` commands are disabled if any
@@ -116,8 +116,8 @@ to replace the old version.
TAI offset. The file can be obtained directly from NIST national time
servers using `ftp` as the ASCII file `pub/leap-seconds`.
+
-The _leapfile_ is scanned when `ntpd` processes the `leapfile`
-directive or when `ntpd` detects that _leapfile_ has changed. `ntpd`
+The _leapfile_ is scanned when `{ntpd}` processes the `leapfile`
+directive or when `{ntpd}` detects that _leapfile_ has changed. `{ntpd}`
checks once a day to see if the _leapfile_ has changed.
+
While not strictly a security function, the Autokey protocol provides
@@ -145,7 +145,7 @@ Thus, a minimal log configuration could look like this:
+
`logconfig=syncstatus +sysevents`
+
-This would just list the synchronizations state of `ntpd` and the
+This would just list the synchronizations state of `{ntpd}` and the
major system events. For a simple reference server, the following
minimum message configuration could be useful:
+
@@ -206,19 +206,19 @@ and so on is suppressed.
ATDT is normally prepended to the number, which can contain other
modem control codes as well.
`reset [allpeers] [auth] [ctl] [io] [mem] [sys] [timer]`::
- Reset one or more groups of counters maintained by ntpd and exposed by
- `ntpq`.
+ Reset one or more groups of counters maintained by {ntpd} and exposed by
+ `{ntpq}`.
`saveconfigdir` 'directory_path'::
Specify the directory in which to write configuration snapshots
- requested with `ntpq`'s link:ntpq.html#saveconfig[saveconfig] command.
+ requested with `{ntpq}`'s link:ntpq.html#saveconfig[saveconfig] command.
If `saveconfigdir` does not appear in the configuration file,
- saveconfig requests are rejected by ntpd.
+ saveconfig requests are rejected by {ntpd}.
`setvar` 'variable' [`default`]::
This command adds an additional system variable. These variables can
be used to distribute additional information such as the access
policy. If the variable of the form `name = value` is followed by the
`default` keyword, the variable will be listed as part of the default
- system variables (`ntpq rv` command). These additional variables serve
+ system variables (`{ntpq} rv` command). These additional variables serve
informational purposes only. They are not related to the protocol
other that they can be listed. The known protocol variables will
always override any variables defined via the `setvar` mechanism.
diff --git a/docs/monopt.txt b/docs/monopt.txt
index 4c3c5b2..f6ab634 100644
--- a/docs/monopt.txt
+++ b/docs/monopt.txt
@@ -26,7 +26,7 @@ include::includes/monopt.txt[]
[[intro]]
== Naming Conventions ==
-The `ntpd` daemon includes a comprehensive monitoring facility which
+The `{ntpd}` daemon includes a comprehensive monitoring facility which
collects statistical data of various types and writes the data to
files associated with each type at defined events or intervals. The
files associated with a particular type are collectively called the
@@ -75,9 +75,9 @@ page.
The file set is actually a single plain file.
`pid`::
- One file set member is created for every incarnation of `ntpd`.
+ One file set member is created for every incarnation of `{ntpd}`.
The file name suffix is the string .`n`, where `n` is the process
- ID of the `ntpd` server process.
+ ID of the `{ntpd}` server process.
`day`::
One file set member is created per day. A day is defined as the
@@ -105,9 +105,9 @@ page.
member created on 1 January 1992 would have suffix `.1992`.
`age`::
- One file set member is generated every 24 hours of `ntpd`
+ One file set member is generated every 24 hours of `{ntpd}`
operation. The filename suffix is the string `.adddddddd`, where
- `a` stands for itself and `dddddddd` is the `ntpd` running time in
+ `a` stands for itself and `dddddddd` is the `{ntpd}` running time in
seconds at the start of the corresponding 24-hour period.
--
+
@@ -118,7 +118,7 @@ page.
hard link from the current file set member to a file without suffix
is created. When there is already a file with this name and the
number of links to this file is one, it is renamed by appending a
- dot, the letter `C`, and the pid of the `ntpd` server process. When
+ 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.
diff --git a/docs/msyslog.txt b/docs/msyslog.txt
index 0839551..46bd4f8 100644
--- a/docs/msyslog.txt
+++ b/docs/msyslog.txt
@@ -1,4 +1,4 @@
-= `ntpd` System Log Messages =
+= `{ntpd}` System Log Messages =
[cols="10%,90%",frame="none",grid="none",style="verse"]
|==============================
@@ -23,7 +23,7 @@ new ones come and old ones go. Generally, however, the most common ones
will be found here. They are listed by program module and log severity
code in bold: *`LOG_ERR`*, *`LOG_NOTICE`* and *`LOG_INFO`*.
-Most of the time *`LOG_ERR`* messages are fatal, but often `ntpd` limps
+Most of the time *`LOG_ERR`* messages are fatal, but often `{ntpd}` limps
onward in the hopes of discovering more errors. The *`LOG_NOTICE`*
messages usually mean the time has changed or some other condition that
probably should be noticed. The *`LOG_INFO`* messages usually say
@@ -42,7 +42,7 @@ meaning should be clear from context.
=== LOG_NOTICE ===
`no reply; clock not set`::
- In `ntpdate` mode no servers have been found. The server(s) and/or
+ No servers have been found. The server(s) and/or
network may be down. Standard debugging procedures apply.
=== LOG_INFO ===
@@ -93,7 +93,7 @@ Program error. Bugs can be reported link:bugs.html[here].::
`time reset ? s`::
The time error exceeds the step threshold and has been reset to the
correct time. Computer scientists don't like this, but they can set
- the `ntpd -x` option and wait forever.
+ the `{ntpd} -x` option and wait forever.
`kernel time sync disabled ?`::
The kernel reports an error. See the codes in the `timex.h` file.
`pps sync disabled`::
@@ -149,7 +149,7 @@ Program error. Bugs can be reported link:bugs.html[here].::
`crypto_?: scheme unavailable`::
There is a problem with the identity scheme. Operation cannot proceed
untill the problem is fixed. Usually errors are due to
- misconfiguration or an orphan association. If the latter, `ntpd` will
+ misconfiguration or an orphan association. If the latter, `{ntpd}` will
usually time out and recover by itself.
`crypto_cert: wrong PEM type ?`::
The certificate does not have MIME type `CERTIFICATE`. You are
diff --git a/docs/ntp-wait.txt b/docs/ntp-wait.txt
index c953c01..ea9d9c3 100644
--- a/docs/ntp-wait.txt
+++ b/docs/ntp-wait.txt
@@ -1,6 +1,4 @@
-= `ntp-wait` - waits until ntpd is in synchronized state =
-
-Last update: 12-Jul-2011 22:03 UTC
+= `ntp-wait` - waits until {ntpd} is in synchronized state =
'''''
@@ -10,8 +8,8 @@ Last update: 12-Jul-2011 22:03 UTC
== Description ==
-The `ntp-wait` program blocks until ntpd is in synchronized state. This
-can be useful at boot time, to delay the boot sequence until after "ntpd
+The `ntp-wait` 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.
== Command Line Options ==
diff --git a/docs/ntpd-body.txt b/docs/ntpd-body.txt
index 3d6aaf1..91532d0 100644
--- a/docs/ntpd-body.txt
+++ b/docs/ntpd-body.txt
@@ -4,7 +4,7 @@
[[synop]]
== SYNOPSIS ==
-*ntpd*
+*{ntpd}*
[-46aAbgLmnNqx ] [ -c 'conffile' ] [ -f 'driftfile' ] [ -i 'jaildir' ]
[ -k 'keyfile' ] [ -l 'logfile' ] [ -p 'pidfile' ] [ -P 'priority' ]
[ -r 'broadcastâ€delay' ] [ -s 'statsdir' ] [ -t 'key' ]
@@ -14,21 +14,21 @@
[[descr]]
== DESCRIPTION ==
-The `ntpd` utility is an operating system daemon which sets and
+The `{ntpd}` utility is an operating system daemon which sets and
maintains the system time of day in synchronism with Internet standard
time servers. It is a complete implementation of the Network Time
Protocol (NTP) version 4, as defined by RFC-5905, but also retains
compatibility with version 3, as defined by RFC-1305, and versions 1 and
2, as defined by RFC-1059 and RFC-1119, respectively.
-The `ntpd` utility does most computations in 64-bit floating point
+The `{ntpd}` utility does most computations in 64-bit floating point
arithmetic and does relatively clumsy 64-bit fixed point operations only
when necessary to preserve the ultimate precision, about 232
picoseconds. While the ultimate precision is not achievable with
ordinary workstations and networks of today, it may be required with
future gigahertz CPU clocks and gigabit LANs.
-Ordinarily, `ntpd` reads the {ntpconf} configuration file at startup
+Ordinarily, `{ntpd}` reads the {ntpconfman} configuration file at startup
time in order to determine the synchronization sources and operating
modes. It is also possible to specify a working, although limited,
configuration entirely on the command line, obviating the need for a
@@ -36,9 +36,9 @@ configuration file. This may be particularly useful when the local host
is to be configured as a broadcast/multicast client, with all peers
being determined by listening to broadcasts at run time.
-The `ntpd` program normally operates continuously while adjusting the
+The `{ntpd}` program normally operates continuously while adjusting the
system time and frequency, but in some cases this might not be
-practical. With the `-q` option `ntpd` operates as in continuous mode,
+practical. With the `-q` option `{ntpd}` operates as in continuous mode,
but exits just after setting the clock for the first time. Most
applications will probably want to specify the `iburst` option with the
`server` command. With this option a volley of messages is exchanged to
@@ -46,17 +46,17 @@ groom the data and set the clock in about ten seconds. If nothing is
heard after a few minutes, the daemon times out and exits without
setting the clock.
-If NetInfo support is built into `ntpd`, then `ntpd` will attempt to
+If NetInfo support is built into `{ntpd}`, then `{ntpd}` will attempt to
read its configuration from the NetInfo if the default
-{ntpconf} file cannot be read and no file is specified by
+{ntpconfman} file cannot be read and no file is specified by
the `-c` option.
-Various internal `ntpd` variables can be displayed and configuration
-options altered while the `ntpd` is running using the
+Various internal `{ntpd}` variables can be displayed and configuration
+options altered while the `{ntpd}` is running using the
{ntpqman} utility program.
-When `ntpd` starts it looks at the value of umask(2), and if
-zero `ntpd` will set the umask(2) to 022.
+When `{ntpd}` starts it looks at the value of umask(2), and if
+zero `{ntpd}` will set the umask(2) to 022.
[[cmd]]
== OPTIONS ==
@@ -118,18 +118,18 @@ configuration specification in the `/etc/ntp.conf` file.
Allow the first adjustment to be Big. This option may appear an
unlimited number of times.
+
-Normally, `ntpd` exits with a message to the system log if the offset
+Normally, `{ntpd}` exits with a message to the system log if the offset
exceeds the panic threshold, which is 1000 s by default. This option
allows the time to be set to any value without restriction; however,
this can happen only once. If the threshold is exceeded after that,
-`ntpd` will exit with a message to the system log. This option can be
+`{ntpd}` will exit with a message to the system log. This option can be
used with the `-q` and `-x` options. See the _tinker_ configuration
file directive for other options.
`-G`, `--force-step-once`::
Step any initial offset correction..
+
-Normally, `ntpd` steps the time if the time offset exceeds the step
+Normally, `{ntpd}` steps the time if the time offset exceeds the step
threshold, which is 128 ms by default, and otherwise slews the time.
This option forces the initial offset correction to be stepped, so the
highest time accuracy can be achieved quickly. However, this may also
@@ -189,7 +189,7 @@ server to be discovered via mDNS client lookup.
Modify Multimedia Timer (Windows only).
+
Set the Windows Multimedia Timer to highest resolution. This ensures
-the resolution does not change while ntpd is running, avoiding
+the resolution does not change while {ntpd} is running, avoiding
timekeeping glitches associated with changes.
`-n`, `--nofork`::
@@ -199,29 +199,29 @@ timekeeping glitches associated with changes.
`-N`, `--nice`::
Run at high priority.
+
-To the extent permitted by the operating system, run `ntpd` at the
+To the extent permitted by the operating system, run `{ntpd}` at the
highest priority.
`-p` string, `--pidfile`=_string_::
path to the PID file.
+
-Specify the name and path of the file used to record `ntpd`'s process
+Specify the name and path of the file used to record `{ntpd}`'s process
ID. This is the same operation as the _pidfile_ _pidfile_
configuration file directive.
`-P` number, `--priority`=_number_::
Process priority. This option takes an integer number as its argument.
+
-To the extent permitted by the operating system, run `ntpd` at the
+To the extent permitted by the operating system, run `{ntpd}` at the
specified _sched_setscheduler(SCHED_FIFO)_ priority.
`-q`, `--quit`::
Set the time and quit. This option must not appear in combination with
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, has
-been replaced with a shell script. The `-g` and `-x` options can be
+`{ntpd}` will not daemonize and will exit after the clock is first
+synchronized. This behavior mimics that of the _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.
@@ -229,7 +229,7 @@ with this option.
Save parsed configuration and quit. This option must not appear in
combination with any of the following options: quit, wait-sync.
+
-Cause `ntpd` to parse its startup configuration file and save an
+Cause `{ntpd}` to parse its startup configuration file and save an
equivalent to the given filename and exit. This option was designed
for automated testing.
@@ -277,12 +277,12 @@ between scans.
combination with any of the following options: nofork, quit,
saveconfigquit. This option takes an integer number as its argument.
+
-If greater than zero, alters `ntpd`'s behavior when forking to
+If greater than zero, alters `{ntpd}`'s behavior when forking to
daemonize. Instead of exiting with status 0 immediately after the
fork, the parent waits up to the specified number of seconds for the
child to first synchronize the clock. The exit status is zero
(success) if the clock was synchronized, otherwise it is ETIMEDOUT.
-This provides the option for a script starting `ntpd` to easily wait
+This provides the option for a script starting `{ntpd}` to easily wait
for the first set of the clock before proceeding.
`-x`, `--slew`::
@@ -331,7 +331,7 @@ discipline is disabled with this option.
=== How NTP Operates ===
-The `ntpd` utility operates by exchanging messages with one or more
+The `{ntpd}` utility operates by exchanging messages with one or more
configured servers over a range of designated poll intervals. When
started, whether for the first or subsequent times, the program requires
several exchanges from the majority of these servers so the signal
@@ -342,32 +342,32 @@ over a few seconds. At the default initial poll interval of 64s, several
minutes can elapse before the clock is set. This initial delay to set
the clock can be safely and dramatically reduced using the _iburst_
keyword with the _server_ configuration command, as described in
-{ntpconf}.
+{ntpconfman}.
Most operating systems and hardware of today incorporate a time-of-year
(TOY) chip to maintain the time during periods when the power is off.
When the machine is booted, the chip is used to initialize the operating
system time. After the machine has synchronized to a NTP server, the
operating system corrects the chip from time to time. In the default
-case, if `ntpd` detects that the time on the host is more than 1000s
-from the server time, `ntpd` assumes something must be terribly wrong
+case, if `{ntpd}` detects that the time on the host is more than 1000s
+from the server time, `{ntpd}` assumes something must be terribly wrong
and the only reliable action is for the operator to intervene and set
the clock by hand. (Reasons for this include there is no TOY chip, or
its battery is dead, or that the TOY chip is just of poor quality.) This
-causes `ntpd` to exit with a panic message to the system log. The `-g`
+causes `{ntpd}` to exit with a panic message to the system log. The `-g`
option overrides this check and the clock will be set to the server time
regardless of the chip time (up to 68 years in the past or future — this
is a limitation of the NTPv4 protocol). However, and to protect against
broken hardware, such as when the CMOS battery fails or the clock
counter becomes defective, once the clock has been set an error greater
-than 1000s will cause `ntpd` to exit anyway.
+than 1000s will cause `{ntpd}` to exit anyway.
-Under ordinary conditions, `ntpd` adjusts the clock in small steps so
+Under ordinary conditions, `{ntpd}` adjusts the clock in small steps so
that the timescale is effectively continuous and without
discontinuities. Under conditions of extreme network congestion, the
roundtrip delay jitter can exceed three seconds and the synchronization
distance, which is equal to one-half the roundtrip delay plus error
-budget terms, can become very large. The `ntpd` algorithms discard
+budget terms, can become very large. The `{ntpd}` algorithms discard
sample offsets exceeding 128 ms, unless the interval during which no
sample offset is less than 128 ms exceeds 900s. The first sample after
that, no matter what the offset, steps the clock to the indicated time.
@@ -376,7 +376,7 @@ in error to a vanishingly low incidence.
As the result of this behavior, once the clock has been set it very
rarely strays more than 128 ms even under extreme cases of network path
-congestion and jitter. Sometimes, in particular when `ntpd` is first
+congestion and jitter. Sometimes, in particular when `{ntpd}` is first
started without a valid drift file on a system with a large intrinsic
drift the error might grow to exceed 128 ms, which would cause the clock
to be set backwards if the local clock time is more than 128 s in the
@@ -399,7 +399,7 @@ In spite of the above precautions, sometimes when large frequency errors
are present the resulting time offsets stray outside the 128-ms range
and an eventual step or slew time correction is required. If following
such a correction the frequency error is so large that the first sample
-is outside the acceptable range, `ntpd` enters the same state as when
+is outside the acceptable range, `{ntpd}` enters the same state as when
the _ntp.drift_ file is not present. The intent of this behavior is to
quickly correct the frequency and restore operation to the normal
tracking mode. In the most extreme cases (the host _time.ien.it_ comes
@@ -409,11 +409,11 @@ keyword when configuring the server, but ONLY when you have permission
to do so from the owner of the target host.
Finally, in the past many startup scripts would run
-{ntpdate} to get the system clock close to correct before
+a separate utility to get the system clock close to correct before
starting {ntpdman}, but this was never more than a mediocre hack
and is no longer needed. If you are following the instructions
in <<starting>> and you still need to set the
-system time before starting_ ntpd`, please open a bug report and
+system time before starting {ntpd}, please open a bug report and
document what is going on, and then look at using {sntpman}.
There is a way to start {ntpdman} that often addresses all of
@@ -435,30 +435,30 @@ Then, start the rest of your "normal" processes. This will give
synchronized and stable.
Finally, if you have processes like _dovecot_ or database servers that
-require monotonically-increasing time, run {ntpwait} as
+require monotonically-increasing time, run {ntpwaitman} as
late as possible in the boot sequence (perhaps with the_`-v`_flag) and
-after {ntpwait} exits successfully it is as safe as it
+after {ntpwaitman} exits successfully it is as safe as it
will ever be to start any process that require stable time.
=== Frequency Discipline ===
-The `ntpd` behavior at startup depends on whether the frequency file,
+The `{ntpd}` behavior at startup depends on whether the frequency file,
usually _ntp.drift_, exists. This file contains the latest estimate of
-clock frequency error. When the `ntpd` is started and the file does not
-exist, the `ntpd` enters a special mode designed to quickly adapt to the
+clock frequency error. When the `{ntpd}` is started and the file does not
+exist, the `{ntpd}` enters a special mode designed to quickly adapt to the
particular system clock oscillator time and frequency error. This takes
approximately 15 minutes, after which the time and frequency are set to
-nominal values and the `ntpd` enters normal mode, where the time and
+nominal values and the `{ntpd}` enters normal mode, where the time and
frequency are continuously tracked relative to the server. After one
hour the frequency file is created and the current frequency offset
-written to it. When the `ntpd` is started and the file does exist, the
-`ntpd` frequency is initialized from the file and enters normal mode
+written to it. When the `{ntpd}` is started and the file does exist, the
+`{ntpd}` frequency is initialized from the file and enters normal mode
immediately. After that the current frequency offset is written to the
file at hourly intervals.
=== Operating Modes ===
-The `ntpd` utility can operate in any of several modes, including
+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
@@ -472,7 +472,7 @@ itself automatically. This makes it possible to deploy a fleet of
workstations without specifying configuration details specific to the
local environment.
-By default, `ntpd` runs in continuous mode where each of possibly
+By default, `{ntpd}` runs in continuous mode where each of possibly
several external servers is polled at intervals determined by an
intricate state machine. The state machine measures the incidental
roundtrip delay jitter and oscillator frequency wander and determines
@@ -484,28 +484,24 @@ servers. In addition, should a server become unreachable for some time,
the poll interval is increased in steps to 1024s in order to reduce
network overhead.
-In some cases it may not be practical for `ntpd` to run continuously. A
-common workaround has been to run the {ntpdate} or
-{sntpman} programs from a cron(8) job at designated times.
-However, these programs do not have the crafted signal processing, error
-checking or mitigation algorithms of `ntpd` . The `-q` option is
-intended for this purpose. Setting this option will cause `ntpd` to exit
+In some cases it may not be practical for `{ntpd}` to run continuously.
+The `-q` option is provided to support running `{ntpd}` periodically
+from a cron(8) job. Setting this option will cause `{ntpd}` to exit
just after setting the clock for the first time. The procedure for
initially setting the clock is the same as in continuous mode; most
applications will probably want to specify the _iburst_ keyword with
the _server_ configuration command. With this keyword a volley of messages
-are exchanged to groom the data and the clock is set in about 10 s. If
+are exchanged to groom the data and the clock is set in about 10 sec. If
nothing is heard after a couple of minutes, the daemon times out and
-exits. After a suitable period of mourning, the
-{ntpdate} program will be retired.
+exits.
When kernel support is available to discipline the clock frequency,
which is the case for stock Solaris, Tru64, Linux and FreeBSD, a useful
-feature is available to discipline the clock frequency. First, `ntpd` is
+feature is available to discipline the clock frequency. First, `{ntpd}` is
run in continuous mode with selected servers in order to measure and
record the intrinsic clock frequency offset in the frequency file. It
may take some hours for the frequency and offset to settle down. Then
-the `ntpd` is stopped and run in one-time mode as required. At each
+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.
@@ -587,8 +583,8 @@ as described in _ntp.conf_(5)_._
The '-V' option is not backward-compatible with its use (as the
equivalent of -Z) in older versions.
-The `ntpd` utility has gotten rather fat. While not huge, it has gotten
-larger than might be desirable for an elevated-priority `ntpd` running
+The `{ntpd}` utility has gotten rather fat. While not huge, it has gotten
+larger than might be desirable for an elevated-priority `{ntpd}` running
on a workstation, particularly since many of the fancy features which
consume the space were designed more with a busy primary server, rather
than a high stratum workstation in mind.
diff --git a/docs/ntpd.txt b/docs/ntpd.txt
index d5f9225..f239979 100644
--- a/docs/ntpd.txt
+++ b/docs/ntpd.txt
@@ -1,4 +1,4 @@
-= `ntpd` - Network Time Protocol (NTP) Daemon =
+= `{ntpd}` - Network Time Protocol (NTP) Daemon =
[cols="10%,90%",frame="none",grid="none",style="verse"]
|==============================
diff --git a/docs/ntpdsim.txt b/docs/ntpdsim.txt
index 06520ec..5f17eed 100644
--- a/docs/ntpdsim.txt
+++ b/docs/ntpdsim.txt
@@ -31,12 +31,12 @@ include::includes/manual.txt[]
[[descr]]
== Description ==
-The `ntpdsim` program is an adaptation of the `ntpd` operating system
+The `ntpdsim` program is an adaptation of the `{ntpd}` operating system
daemon. The program operates as a discrete time simulator using
specified systematic and random driving sources. It includes all the
mitigation and discipline algorithms of the actual daemon, but with the
packet I/O and system clock algorithms driven by simulation. Most
-functions of the real `ntpd` remain intact, including the monitoring,
+functions of the real `{ntpd}` remain intact, including the monitoring,
statistics recording, trace and host name resolution features. Further
information on the simulator is on the
http://www.eecis.udel.edu/%7emills/ntpsim.html[NTP Discrete Event
@@ -80,7 +80,7 @@ filegen peerstats type day enable
Note: The NTP development team is moving to the use of a syntax-directed
configuration file design. When complete these options will be replaced
-by a link:ntpdsim_new.html[new one]. Most of the `ntpd` command line
+by a link:ntpdsim_new.html[new one]. Most of the `{ntpd}` command line
options apply also to `ntpdsim`. In addition, the following command line
`-B` 'bdly'::
diff --git a/docs/ntpdsim_new.txt b/docs/ntpdsim_new.txt
index 6fa7275..1709fc0 100644
--- a/docs/ntpdsim_new.txt
+++ b/docs/ntpdsim_new.txt
@@ -34,7 +34,7 @@ matter of historical interest.
The {project-shortname} maintainers have an internal project
code-named TESTFRAME that intends to create the capability
-for replicable end-to-end testing of `ntpd`. It is likely
+for replicable end-to-end testing of `{ntpd}`. It is likely
that some version of thius code will replace or merge in ntpdsim's
capabilities.
diff --git a/docs/ntpq-body.txt b/docs/ntpq-body.txt
index 3ab6de2..879d3e5 100644
--- a/docs/ntpq-body.txt
+++ b/docs/ntpq-body.txt
@@ -4,11 +4,11 @@
== Synopsis ==
-`ntpq` [`-46dinp`] [`-c` 'command'] ['host'] [...]
+`{ntpq}` [`-46dinp`] [`-c` 'command'] ['host'] [...]
== Description ==
-The `ntpq` utility program is used to monitor NTP daemon `ntpd`
+The `{ntpq}` utility program is used to monitor NTP daemon `{ntpd}`
operations and determine performance. It uses the standard NTP mode 6
control message formats defined in Appendix B of the NTPv3 specification
RFC1305. The same formats are used in NTPv4, although some of the
@@ -18,23 +18,23 @@ page is for the NTPv4 variables.
The program can be run either in interactive mode or controlled using
command line arguments. Requests to read and write arbitrary variables
can be assembled, with raw and pretty-printed output options being
-available. The `ntpq` can also obtain and print a list of peers in a
+available. The `{ntpq}` can also obtain and print a list of peers in a
common format by sending multiple queries to the server.
If one or more request options is included on the command line when
-`ntpq` is executed, each of the requests will be sent to the NTP servers
+`{ntpq}` is executed, each of the requests will be sent to the NTP servers
running on each of the hosts given as command line arguments, or on
-localhost by default. If no request options are given, `ntpq` will
+localhost by default. If no request options are given, `{ntpq}` will
attempt to read commands from the standard input and execute these on
the NTP server running on the first host given on the command line,
-again defaulting to localhost when no other host is specified. `ntpq`
+again defaulting to localhost when no other host is specified. `{ntpq}`
will prompt for commands if the standard input is a terminal device.
-`ntpq` uses NTP mode 6 packets to communicate with the NTP server, and
+`{ntpq}` uses NTP mode 6 packets to communicate with the NTP server, and
hence can be used to query any compatible server on the network which
permits it. Note that since NTP is a UDP protocol this communication
will be somewhat unreliable, especially over large distances in terms of
-network topology. `ntpq` makes one attempt to retransmit requests, and
+network topology. `{ntpq}` makes one attempt to retransmit requests, and
will time requests out if the remote host is not heard from within a
suitable timeout time.
@@ -49,7 +49,7 @@ Techniques] page.
Command line options are described following. Specifying a command line
option other than `-i` or `-n` will cause the specified query (queries)
-to be sent to the indicated host(s) immediately. Otherwise, `ntpq` will
+to be sent to the indicated host(s) immediately. Otherwise, `{ntpq}` will
attempt to read interactive format commands from the standard input.
`-4`::
@@ -65,7 +65,7 @@ attempt to read interactive format commands from the standard input.
`-d`::
Turn on debugging mode.
`-i`::
- Force `ntpq` to operate in interactive mode. Prompts will be written
+ Force `{ntpq}` to operate in interactive mode. Prompts will be written
to the standard output and commands read from the standard input.
`-n`::
Output all host addresses in dotted-quad numeric format rather than
@@ -82,20 +82,20 @@ identify the command need be typed. The output of a command is normally
sent to the standard output, but optionally the output of individual
commands may be sent to a file by appending a `>`, followed by a file
name, to the command line. A number of interactive format commands are
-executed entirely within the `ntpq` program itself and do not result in
+executed entirely within the `{ntpq}` program itself and do not result in
NTP mode-6 requests being sent to a server. These are described
following.
`?` ['command_keyword']::
`help` ['command_keyword']::
A `?` by itself will print a list of all the command keywords known to
- `ntpq`. A `?` followed by a command keyword will print function and
+ `{ntpq}`. A `?` followed by a command keyword will print function and
usage information about the command.
`addvars` _`name`_ [ = value] [...]; `rmvars` _`name`_ [...]; `clearvars`::
The arguments to this command consist of a list of items of the form
`name = value`, where the `= value` is ignored, and can be omitted in
- read requests. `ntpq` maintains an internal list in which data to be
+ read requests. `{ntpq}` maintains an internal list in which data to be
included in control messages can be assembled, and sent using the
`readlist` and `writelist` commands described below. The `addvars`
command allows variables and optional values to be added to the list.
@@ -105,13 +105,13 @@ following.
`clearlist` command removes all variables from the list.
`authenticate` [yes | no]::
- Normally `ntpq` does not authenticate requests unless they are write
- requests. The command `authenticate yes` causes `ntpq` to send
+ Normally `{ntpq}` does not authenticate requests unless they are write
+ requests. The command `authenticate yes` causes `{ntpq}` to send
authentication with all requests it makes. Authenticated requests
causes some servers to handle requests slightly differently, and can
occasionally melt the CPU in fuzzballs if you turn authentication on
before doing a _peer_ display. The command `authenticate` causes
- `ntpq` to display whether or not `ntpq` is currently autheinticating
+ `{ntpq}` to display whether or not `{ntpq}` is currently autheinticating
requests.
`cooked`::
@@ -129,7 +129,7 @@ following.
be obsolete.
`exit`::
- Exit `ntpq`.
+ Exit `{ntpq}`.
`host` 'name'::
Set the host to which future queries will be sent. The name may be
@@ -153,7 +153,7 @@ following.
`SHA1`.
`ntpversion 1 | 2 | 3 | 4`::
- Sets the NTP version number which `ntpq` claims in packets. Defaults
+ Sets the NTP version number which `{ntpq}` claims in packets. Defaults
to 2, Note that mode-6 control messages (and modes, for that matter)
didn't exist in NTP version 1.
@@ -163,7 +163,7 @@ following.
this purpose.
`quit`::
- Exit `ntpq`.
+ Exit `{ntpq}`.
`raw`::
Display server messages as received and without reformatting.
@@ -173,12 +173,12 @@ following.
`timeout` 'millseconds'::
Specify a timeout period for responses to server queries. The default
- is about 5000 milliseconds. Note that since `ntpq` retries each query
+ is about 5000 milliseconds. Note that since `{ntpq}` retries each query
once after a timeout, the total waiting time for a timeout will be
twice the timeout value set.
`version`::
- Print the version of the `ntpq` program.
+ Print the version of the `{ntpq}` program.
== Control Message Commands ==
@@ -244,7 +244,7 @@ ind assid status conf reach auth condition last_event cnt
Display network and reference clock I/O statistics.
`kerninfo`::
- Display kernel loop and PPS statistics. As with other ntpq output,
+ Display kernel loop and PPS statistics. As with other {ntpq} output,
times are in milliseconds. The precision value displayed is in
milliseconds as well, unlike the precision system variable.
@@ -262,7 +262,7 @@ ind assid status conf reach auth condition last_event cnt
`mrulist` [`limited` | `kod` | `mincount=`'count' | `laddr=`'localaddr' | `sort=`'sortorder' | `resany=`'hexmask' | `resall=`'hexmask']::
Obtain and print traffic counts collected and maintained by the
monitor facility. With the exception of `sort=`'sortorder', the options
- filter the list returned by `ntpd`. The `limited` and `kod` options
+ filter the list returned by `{ntpd}`. The `limited` and `kod` options
return only entries representing client addresses from which the last
packet received triggered either discarding or a KoD response. The
`mincount=`'count' option filters entries representing less than 'count'
@@ -280,7 +280,7 @@ The _`sortorder`_ defaults to `lstint` and may be any of `addr`,
|Column |Description
|`lstint` |
Interval in s between the receipt of the most recent packet from this
-address and the completion of the retrieval of the MRU list by `ntpq`.
+address and the completion of the retrieval of the MRU list by `{ntpq}`.
|`avgint` |
Average interval in s between packets from this address.
|`rstr` |
@@ -360,13 +360,13 @@ server, `B`: broadcast server, `M`: multicast server
month of year, DD the day of month and TTTT the time of day.
`reslist`::
- Show the access control (restrict) list for `ntpq`.
+ Show the access control (restrict) list for `{ntpq}`.
`saveconfig` 'filename'::
Write the current configuration, including any runtime modifications
- given with `:config` or `config-from-file`, to the ntpd host's file
+ given with `:config` or `config-from-file`, to the {ntpd} host's file
_filename_. This command will be rejected by the server unless
- link:miscopt.html#saveconfigdir[saveconfigdir] appears in the `ntpd`
+ link:miscopt.html#saveconfigdir[saveconfigdir] appears in the `{ntpd}`
configuration file. _filename_ can use strftime() format specifies to
substitute the current date and time, for example,
`saveconfig ntp-%Y%m%d-%H%M%S.conf`. The filename used is stored in
diff --git a/docs/ntpq.txt b/docs/ntpq.txt
index 09cbb31..69959ea 100644
--- a/docs/ntpq.txt
+++ b/docs/ntpq.txt
@@ -1,4 +1,4 @@
-= `ntpq` - standard NTP query program =
+= `{ntpq}` - standard NTP query program =
[cols="10%,90%",frame="none",grid="none",style="verse"]
|==============================
diff --git a/docs/ntptime-body.txt b/docs/ntptime-body.txt
index 1138216..ecfad08 100644
--- a/docs/ntptime-body.txt
+++ b/docs/ntptime-body.txt
@@ -12,7 +12,7 @@ ntptime [ -chr ] [ -e 'est_error' ] [ -f 'frequency' ] [ -m 'max_error' ] [ -o '
This program is useful only with special kernels described in the
link:kern.html[A Kernel Model for Precision Timekeeping] page. It reads
and displays time-related kernel variables using the `ntp_gettime()`
-system call. A similar display can be obtained using the `ntpq` program
+system call. A similar display can be obtained using the `{ntpq}` program
and `kerninfo` command.
== Options ==
diff --git a/docs/ntptrace-body.txt b/docs/ntptrace-body.txt
index 39d4976..c328669 100644
--- a/docs/ntptrace-body.txt
+++ b/docs/ntptrace-body.txt
@@ -11,7 +11,7 @@ ntptrace [-n|--numeric]
== DESCRIPTION ==
-`ntptrace` is a perl script that uses the ntpq utility program to follow
+`ntptrace` is a perl script that uses the {ntpq} utility program to follow
the chain of NTP servers from a given host back to the primary time
source. For ntptrace to work properly, each of these servers must
implement the NTP Control and Monitoring Protocol specified in RFC 1305
diff --git a/docs/parsedata.txt b/docs/parsedata.txt
index e208e24..88b572a 100644
--- a/docs/parsedata.txt
+++ b/docs/parsedata.txt
@@ -4,7 +4,7 @@ The parse driver currently supports several clocks with different query
mechanisms. In order for you to find a sample that might be similar to a
clock you might want to integrate into parse. I'll sum up the major
features of the clocks (this information is distributed in the
-parse/clk_*.c and ntpd/refclock_parse.c files).
+parse/clk_*.c and {ntpd}/refclock_parse.c files).
Last update: 21-Oct-2010 23:44 UTC
diff --git a/docs/parsenew.txt b/docs/parsenew.txt
index 40450ac..08575c0 100644
--- a/docs/parsenew.txt
+++ b/docs/parsenew.txt
@@ -136,7 +136,7 @@ ntpd/refclock_parse.c.
* Find out the exact tty settings for your clock (baud rate, parity,
stop bits, character size, ...) and note them in terms of termio*.h
c_cflag macros.
-* in ntpd/refclock_parse.c fill out a new the struct clockinfo element
+* in {ntpd}/refclock_parse.c fill out a new the struct clockinfo element
(that allocates a new "IP" address - see comments) (see all the other
clocks for example)
+
diff --git a/docs/quick.txt b/docs/quick.txt
index fc7e0ae..5d63b69 100644
--- a/docs/quick.txt
+++ b/docs/quick.txt
@@ -24,7 +24,7 @@ include::includes/install.txt[]
'''''
For the rank amateur the sheer volume of the documentation collection
-must be intimidating. However, it doesn't take much to fly the `ntpd`
+must be intimidating. However, it doesn't take much to fly the `{ntpd}`
daemon with a simple configuration where a workstation needs to
synchronize to some server elsewhere in the Internet. The first thing is
to build the distribution for the particular workstation and install in
@@ -54,13 +54,13 @@ case of the US, by state. Usually, the best choice is the nearest in
geographical terms, but the terms of engagement specified in each list
entry should be carefully respected.
-During operation `ntpd` measures and corrects for incidental clock
+During operation `{ntpd}` measures and corrects for incidental clock
frequency error and occasionally writes the current value to a file
specified by the
`driftfile /etc/ntp.drift`
-configuration command. If `ntpd` is stopped and restarted, it
+configuration command. If `{ntpd}` is stopped and restarted, it
initializes the frequency from this file and avoids the potentially
lengthy interval to relearn the correction.
@@ -71,12 +71,12 @@ administrators should understand NTP uses UDP port 123 as both the
source and destination port and that NTP does not involve any operating
system interaction other than to set the system clock. While almost all
modern Unix systems have included NTP and UDP port 123 defined in the
-services file, this should be checked if `ntpd` fails to come up at all.
+services file, this should be checked if `{ntpd}` fails to come up at all.
The best way to confirm NTP is working is using the
-link:ntpq.html[`ntpq`] utility. See the documentation pages for
+link:ntpq.html[`{ntpq}`] utility. See the documentation pages for
further information. Don't forget to check for link:msyslog.html[system
-log messages]. In the most extreme cases the `-d` option on the `ntpd`
+log messages]. In the most extreme cases the `-d` option on the `{ntpd}`
command line results in a blow-by-blow trace of the daemon operations.
While the trace output can be cryptic, to say the least, it gives a
general idea of what the program is doing and, in particular, details
diff --git a/docs/rdebug.txt b/docs/rdebug.txt
index 7b11b39..0a99e07 100644
--- a/docs/rdebug.txt
+++ b/docs/rdebug.txt
@@ -17,12 +17,12 @@ include::includes/install.txt[]
'''''
-The link:ntpq.html[`ntpq`] utility program
+The link:ntpq.html[`{ntpq}`] utility program
can be used to debug reference clocks, either on the server itself or
from another machine elsewhere in the network. The server is compiled,
installed and started using the configuration file described in the
-link:ntpd.html[`ntpd`] page and its dependencies. If the clock appears
-in the `ntpq` utility and `pe` command, no errors have occurred and the
+link:ntpd.html[`{ntpd}`] page and its dependencies. If the clock appears
+in the `{ntpq}` utility and `pe` command, no errors have occurred and the
daemon has started, opened the devices specified and waiting for peers
and radios to come up. If not, the first thing to look for are error
messages on the system log. These are usually due to improper
@@ -40,7 +40,7 @@ occurring during installation are due to problems such as miswired
connectors or improperly configured device links at this stage.
If RS232 messages are getting to and from the clock, the variables of
-interest can be inspected using the `ntpq` program and various commands
+interest can be inspected using the `{ntpq}` program and various commands
described on the documentation page. First, use the `pe` and `as`
commands to display billboards showing the peer configuration and
association IDs for all peers, including the radio clock. The assigned
@@ -63,12 +63,12 @@ timecode to be sure it matches what the driver expects. This may require
consulting the clock hardware reference manual, which is probably pretty
dusty at this stage.
-The `ntpq` utility program can be used for detailed inspection of the
+The `{ntpq}` utility program can be used for detailed inspection of the
clock driver status. The most useful are the `clockstat` and `clkbug`
commands described in the document page. While these commands permit
getting quite personal with the particular driver involved, their use is
seldom necessary, unless an implementation bug shows up. If all else
-fails, turn on the debugging trace using two `-d` flags in the `ntpd`
+fails, turn on the debugging trace using two `-d` flags in the `{ntpd}`
startup command line. Most drivers will dump status at every received
message in this case. While the displayed trace can be intimidating,
this provides the most detailed and revealing indicator of how the
@@ -78,7 +78,7 @@ Most drivers write a message to the `clockstats` file as each timecode
or surrogate is received from the radio clock. By convention, this is
the last ASCII timecode (or ASCII gloss of a binary-coded one) received
from the radio clock. This file is managed by the `filegen` facility
-described in the `ntpd` page and requires specific commands in the
+described in the `{ntpd}` page and requires specific commands in the
configuration file. This forms a highly useful record to discover
anomalies during regular operation of the clock. The scripts included in
the `./scripts/stats` directory can be run from a `cron` job to collect
diff --git a/docs/sntp-body.txt b/docs/sntp-body.txt
index 89f05e4..f1d4e9e 100644
--- a/docs/sntp-body.txt
+++ b/docs/sntp-body.txt
@@ -84,7 +84,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
+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,
with a 2-second gap in between each query.
+
@@ -153,7 +153,7 @@ situations demand different values.
operating system. When this option is used, the reserved NTP port 123
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-based firewalling which affect `{ntpd}`, which always uses source
port 123.
`-S`, `--step`::
diff --git a/docs/stats.txt b/docs/stats.txt
index 85268f6..a2048ce 100644
--- a/docs/stats.txt
+++ b/docs/stats.txt
@@ -81,7 +81,7 @@ determined as the RMS differences between the offset samples in the
window relative to the selected offset sample. The peer statistics are
recorded by the `peerstats` option of the
link:monopt.html#filegen[`filegen`] command. Peer variables are
-displayed by the `rv` command of the link:ntpq.html#peer[`ntpq`]
+displayed by the `rv` command of the link:ntpq.html#peer[`{ntpq}`]
program.
The clock filter algorithm continues to process updates in this way
@@ -104,7 +104,7 @@ variables of the same name and the system stratum set one greater than
the system peer stratum. The system statistics are recorded by the
`loopstats` option of the link:monopt.html#filegen[`filegen`] command.
System variables are displayed by the `rv` command of the
-link:ntpq.html#system[`ntpq`] program.
+link:ntpq.html#system[`{ntpq}`] program.
Although it might seem counterintuitive, a cardinal rule in the
selection process is, once a sample has been selected by the clock
diff --git a/docs/tickadj.txt b/docs/tickadj.txt
index 368fc94..c074e6b 100644
--- a/docs/tickadj.txt
+++ b/docs/tickadj.txt
@@ -27,11 +27,11 @@ be members of the `struct timex` that adjtimex(2) operates on.
By default, with no arguments, `tickadj` reads the `struct timex`
variable(s) of interest and displays them. At the same time, it
determines an "optimal" value for the value of the `tickadj` variable
-if the intent is to run the `ntpd` Network Time Protocol (NTP) daemon,
+if the intent is to run the `{ntpd}` Network Time Protocol (NTP) daemon,
and prints this as well. Since the operation of `tickadj` when reading
-the kernel mimics the operation of similar parts of the `ntpd` program
+the kernel mimics the operation of similar parts of the `{ntpd}` program
fairly closely, this can be useful when debugging problems with
-`ntpd`.
+`{ntpd}`.
Note: The support this program formerly had for directly reading and
writing '/dev/kmem' dated from the last century; it has been removed
@@ -80,7 +80,7 @@ many cases they will substantially improve the general accuracy of the
time service.
Unfortunately, the value of `tickadj` set by default is almost always
-too large for `ntpd`. NTP operates by continuously making small
+too large for `{ntpd}`. NTP operates by continuously making small
adjustments to the clock, usually at one-second intervals. If `tickadj`
is set too large, the adjustments will disappear in the roundoff; while,
if `tickadj` is too small, NTP will have difficulty if it needs to make
@@ -93,7 +93,7 @@ optimal value of `tickadj` for NTP use based on the kernel's value of
`tick`.
In order to maintain reasonable correctness bounds, as well as
-reasonably good accuracy with acceptable polling intervals, `ntpd` will
+reasonably good accuracy with acceptable polling intervals, `{ntpd}` will
complain if the frequency error is greater than 500 PPM. For machines
with a value of `tick` in the 10-ms range, a change of one in the value
of `tick` will change the frequency by about 100 PPM.
diff --git a/libntp/README b/libntp/README
index fac7185..932603d 100644
--- a/libntp/README
+++ b/libntp/README
@@ -1,5 +1,4 @@
-README file for directory ./libntp of the NTP Version 4 distribution
+= README file for directory .libntp =
This directory contains the sources for the NTP library used by most
-programs in this distribution. See the README and RELNOTES files in the
-parent directory for directions on how to make this library.
+programs in this distribution.
diff --git a/ntp-keygen/ntp-keygen-man.txt.in b/ntp-keygen/ntp-keygen-man.txt.in
index 6efab27..b93016a 100644
--- a/ntp-keygen/ntp-keygen-man.txt.in
+++ b/ntp-keygen/ntp-keygen-man.txt.in
@@ -1,8 +1,8 @@
-= ntp-keygen(1) =
+= {ntpkeygenman} =
:doctype: manpage
== NAME ==
-ntp-keygen - create and manage NTP host keys
+{ntpkeygen} - create and manage NTP host keys
@../docs/keygen-body.txt@
diff --git a/ntpd/ntp.conf.txt b/ntpd/ntp.conf.txt
index b4bc34c..26e21c1 100644
--- a/ntpd/ntp.conf.txt
+++ b/ntpd/ntp.conf.txt
@@ -1,14 +1,11 @@
-= ntp.conf(5) =
+= {ntpconfman} =
:doctype: manpage
-:ntpdman: ntpd(1)
-:ntpqman: ntpq(1)
-:keygenman: ntp-keygen(1)
== NAME ==
-ntp.conf - Network Time Protocol (NTP) daemon configuration file format
+{ntp.conf} - Network Time Protocol (NTP) daemon configuration file format
== SYNOPSIS ==
-/etc/ntp.conf
+/etc/{ntp.conf}
== DESCRIPTION ==
diff --git a/ntpd/ntp.keys.txt b/ntpd/ntp.keys.txt
index 5f00ca1..69282fe 100644
--- a/ntpd/ntp.keys.txt
+++ b/ntpd/ntp.keys.txt
@@ -1,4 +1,4 @@
-= ntp.keys(5) =
+= {ntpkeysman} =
:doctype: manpage
== NAME ==
diff --git a/ntpd/ntpd-man.txt.in b/ntpd/ntpd-man.txt.in
index dd6ca32..6329cb1 100644
--- a/ntpd/ntpd-man.txt.in
+++ b/ntpd/ntpd-man.txt.in
@@ -1,4 +1,4 @@
-= ntpd(8) =
+= {ntpdman} =
:doctype: manpage
== NAME ==
@@ -18,4 +18,4 @@ One of the following exit values will be returned:
== SEE ALSO ==
-{ntpconf}, {ntpdate}, {ntpqman}, {sntpman}.
+{ntpconfman}, {ntpqman}, {sntpman}.
diff --git a/ntpq/ntpq-man.txt.in b/ntpq/ntpq-man.txt.in
index a4d2b05..08c25db 100644
--- a/ntpq/ntpq-man.txt.in
+++ b/ntpq/ntpq-man.txt.in
@@ -1,8 +1,8 @@
-= ntpq(1) =
+= {ntpqman} =
:doctype: manpage
== NAME ==
-ntpq - standard NTP query program
+{ntpq} - standard NTP query program
@../docs/ntpq-body.txt@
diff --git a/scripts/ntp-wait/ntp-wait.txt b/scripts/ntp-wait/ntp-wait.txt
index 723efe1..bbceb59 100644
--- a/scripts/ntp-wait/ntp-wait.txt
+++ b/scripts/ntp-wait/ntp-wait.txt
@@ -1,11 +1,11 @@
-== ntp-wait(1) ==
+== {ntpwaitman} ==
:doctype: manpage
== NAME ==
-ntp-wait - Wait for ntpd to stabilize the system clock
+{ntpwait} - Wait for ntpd to stabilize the system clock
== SYNOPSIS ==
-ntp-wait [-v] [-n 'number'] [-s 'secs']
+{ntpwait} [-v] [-n 'number'] [-s 'secs']
== DESCRIPTION ==
diff --git a/sntp/sntp.txt b/sntp/sntp.txt
index a35e80f..3710630 100644
--- a/sntp/sntp.txt
+++ b/sntp/sntp.txt
@@ -1,8 +1,8 @@
-= sntp(1) =
+= {sntpman} =
:doctype: manpage
== NAME ==
-sntp - standard Simple Network Time Protocol client program
+{sntp} - standard Simple Network Time Protocol client program
@../docs/sntp-body.txt@
diff --git a/util/ntptime-man.txt.in b/util/ntptime-man.txt.in
index f31fc18..bae42ea 100644
--- a/util/ntptime-man.txt.in
+++ b/util/ntptime-man.txt.in
@@ -1,8 +1,8 @@
-= ntptime(1) =
+= {ntptimeman} =
:doctype: manpage
== NAME ==
-ntptime - read and set kernel time variables
+{ntptime} - read and set kernel time variables
@../docs/ntptime-body.txt@
More information about the vc
mailing list