Commit fe247e30 authored by Eric S. Raymond's avatar Eric S. Raymond

Names of the project and its binaries are now stabilized.

Expand those macros to make the documentation masters easier to read.
parent 1b64550b
......@@ -18,7 +18,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
......
# All names and websites particular to the project's name, hosting location,
# and public communications channels indirect through here.
[attributes]
project-shortname=NTPsec
project-domain=ntpsec.org
project-website=http://www.ntpsec.org
project-weblink=http://www.ntpsec.org[www.ntpsec.org]
project-fullname=Secure NTP
project-page=Secure NTP page
project-issuetracker=https://gitlab.com/NTPsec/ntpsec/issues
project-contact=http://www.ntpsec.org/channels.html
project-security-list=security@ntpsec.org
project-bug-list=bugs@ntpsec.org
millshome=http://www.eecis.udel.edu/~mills/
GPSD=http://www.catb.org/gpsd/
ntp=ntp
ntpd=ntpd
ntpdig=ntpdig
ntpdconf=ntpd.conf
ntpfrob=ntpfrob
ntpkeygen=ntpkeygen
ntpkeys=ntp.keys
ntpleapfetch=ntpleapfetch
ntpq=ntpq
ntptime=ntptime
ntpwait=ntpwait
ntpviz=ntpviz
# Annoyingly, these have to be *manually* synchronized with the headers
# on their manual pages - asciidoc doesn't expand attributes in header lines.
ntpdconfman=ntp.conf(5)
......
......@@ -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 sec. Under normal conditions when the clock
discipline has stabilized, the interval increases in steps to the
default maximum 1024 sec. In addition, should a server become unreachable
......
......@@ -83,9 +83,7 @@ operation, and the configuration files for all clients can be
identical.
The security model and protocol schemes for symmetric key
are summarized below; further details are in the
briefings, papers and reports at the {project-fullname} page linked from
{project-website}.
are summarized below.
[[symm]]
=== Symmetric-Key Cryptography ===
......@@ -94,7 +92,7 @@ NTP allows any one of possibly 65,534 keys, each distinguished by a
32-bit key identifier, to authenticate an association. The servers and
clients involved must agree on the key and key identifier to
authenticate NTP packets. Keys and related information are specified
in a key file, usually called _{ntpkeys}_, which must be distributed
in a key file, usually called _ntp.keys_, 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 {ntpqman} utility
......@@ -200,10 +198,8 @@ US.
Authentication is configured separately for each association using the
+key+ option of the +server+ configuration command, as
described in the link:confopt.html[Server Options] page. The
link:ntpkeygen.html[{ntpkeygen}] page describes the files required for the
various authentication schemes. Further details are in the briefings,
papers and reports at the {project-shortname} project page linked from
{project-weblink}.
link:ntpkeygen.html[ntpkeygen] page describes the files required for the
various authentication schemes.
By default, the client sends non-authenticated packets and the server
responds with non-authenticated packets. If the client sends
......@@ -243,9 +239,9 @@ 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}+
utility program. Ordinarily, the +{ntpkeys}+ file is generated by the
+{ntpkeygen}+ program, but it can be constructed and edited using an
additional keys can be used as passwords for the +ntpq+
utility program. Ordinarily, the +ntp.keys+ file is generated by the
+ntpkeygen+ program, but it can be constructed and edited using an
ordinary text editor.
Each line of the keys file consists of three fields: a key ID in the
......@@ -270,18 +266,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
......
......@@ -30,7 +30,7 @@ include::includes/install.txt[]
The autoconf build system used in NTP Classic has been replaced with
waf, a more modern and much faster build engine. It is not necessary
to install any separate waf package; the build engine is a Python
script included in your {project-shortname} distribution.
script included in your NTPsec distribution.
[[build]]
== Building and Installing the Distribution ==
......@@ -74,7 +74,7 @@ the executables by default in +/usr/local/bin+.
You are now ready to configure the daemon. You will need to create a NTP
configuration file by default in +/etc/{ntpconf}+. Newbies should see the
link:quick.html[Quick Start] page for orientation. Seasoned veterans can
start with the link:ntpd.html[+{ntpd}+ - Network Time Protocol (NTP)
start with the link:ntpd.html[+ntpd+ - Network Time Protocol (NTP)
daemon] page and move on to the specific configuration option pages from
there.
......@@ -85,10 +85,10 @@ 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
The first line of general assistance is the NTPsec web site
{project-weblink} and the helpful documents resident
there. Requests for assistance of a general nature and of interest to
other timekeepers should be sent to the NTP newsgroup
......
......@@ -70,7 +70,7 @@ Burnicki is:
-----------------------------------------------------------------------
The following individuals have contributed significantly to
{project-shortname}:
NTPsec:
* mailto:esr@thyrsus.com[Eric S. Raymond <esr@thyrsus.com>] Massive
code reduction/refactoring/hardening, documentation cleanup and update,
......
......@@ -17,15 +17,15 @@ 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
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
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
......@@ -47,7 +47,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.
......@@ -74,7 +74,7 @@ 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
......@@ -133,7 +133,7 @@ select threshold, the server is considered invalid.
Sometimes the time distribution of errors can be revealing. It's a
good idea to look occasionally at the plots produced by
link:ntpviz.html[{ntpviz}].
link:ntpviz.html[ntpviz].
== Large Frequency Errors ==
......@@ -141,10 +141,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,
......@@ -155,7 +155,7 @@ 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,
......@@ -181,20 +181,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 ==
......@@ -205,12 +205,12 @@ cryptography servers and clients share session keys contained in a
secret key file In public key cryptography, which requires the OpenSSL
software library, the server has a private key, never shared, and a
public key with unrestricted distribution. The cryptographic media
required are produced by the link:ntpkeygen.html[+{ntpkeygen}+] program.
required are produced by the link:ntpkeygen.html[+ntpkeygen+] program.
Problems with symmetric key authentication are usually due to mismatched
keys or improper use of the +trustedkey+ command. A simple way to check
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,25 +227,29 @@ easily strike up an association and inject false time values.
== 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
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.
......@@ -253,25 +257,28 @@ If this counter does increment, but the received counter does not
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
find a majority of truechimers among the server population.
8. If all else fails, see the FAQ and/or the discussion and briefings
at the {project-page}.
at the project website.
'''''
......
......@@ -31,13 +31,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.
......@@ -58,7 +58,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%"]
|=======================
......@@ -126,7 +126,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%"]
|===============================
......@@ -151,7 +151,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="70%",cols=">10%,<25%,^10%,<55%",]
|============================================================================
......@@ -195,7 +195,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%"]
|=========================
......@@ -224,7 +224,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="70%",cols=">10%,<15%,<25%,<50%",]
......@@ -253,7 +253,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="50%",cols=">20%,<80%"]
|==================================================================
......
......@@ -310,7 +310,7 @@ Some administrators prefer to avoid running {ntpdman} continuously and
run {ntpdman} +-q+ as a cron job. In either case the servers must be
configured in advance and the program fails if none are available when
the cron job runs. A really slick application of manycast is with
{ntpd} +-q+. The program wakes up, scans the local landscape looking
ntpd +-q+. The program wakes up, scans the local landscape looking
for the usual suspects, selects the best from among the rascals, sets
the clock and then departs. Servers do not have to be configured in
advance and all clients throughout the network can have the same
......@@ -350,7 +350,7 @@ 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+
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.
......
......@@ -25,13 +25,13 @@ include::includes/misc.txt[]
== When Not to Write a Driver ==
If the device you are trying to support is an exotic GPS, you should
probably not write an +{ntpd}+ driver for it. Instead, check to see
if it is already supported by {GPSD}, a project with which
{project-shortname} cooperates closely. The GPSD people are
specialists in managing GPSes and better at it than we are,
supporting a much broader range of devices, and GPSD is designed
to feed clock samples to +{ntpd}+ from any of them. If you need
to write a driver for a GPS, they'll take it and should have it.
probably not write an +ntpd+ driver for it. Instead, check to see if
it is already supported by {GPSD}, a project with which NTPsec
cooperates closely. The GPSD people are specialists in managing GPSes
and better at it than we are, supporting a much broader range of
devices, and GPSD is designed to feed clock samples to +ntpd+ from any
of them. If you need to write a driver for a GPS, they'll take it and
should have it.
If you have a non-GPS time source (like a time radio or GPSDO) that
you want to support, consider link:generic_howto.html[writing a mode
......@@ -114,7 +114,7 @@ is used to distinguish multiple instances of clocks of the same type.
These addresses used to be exposed as part of the refclock
configuration syntax, but are no longer. Nothing in ntpd now actually
requires this form of address for clocks, but it is still generated
so as not to hand surprises to legacy +{ntpq}+ instances that still make
so as not to hand surprises to legacy +ntpq+ instances that still make
the assumption.
Most clocks require a serial or parallel port or special bus peripheral.
......@@ -159,12 +159,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
......
......@@ -11,9 +11,9 @@ Features: tty_clk
== Deprecation warning ==
This refclock is deprecated and obsolete. The {project-shortname}
maintainers plan to remove it in a future release. If you have a
requirement for it, please make this known to us.
This refclock is deprecated and obsolete. The NTPsec maintainers plan
to remove it in a future release. If you have a requirement for it,
please make this known to us.
== Description ==
......
......@@ -9,9 +9,9 @@ Serial Port: /dev/dumbclock_u_; 9600bps 8N1
== Deprecation warning ==
This refclock is deprecated and obsolete. The {project-shortname}
maintainers plan to remove it in a future release. If you have a
requirement for it, please make this known to us.
This refclock is deprecated and obsolete. The NTPsec maintainers plan
to remove it in a future release. If you have a requirement for it,
please make this known to us.
== Description ==
......
......@@ -38,7 +38,7 @@ 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.
......@@ -47,7 +47,7 @@ than 1ms.
== 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::
......@@ -76,11 +76,11 @@ refclock_ppstime::
Currently, twenty-five clock types are supported by the GENERIC driver
and any number of these clocks may be operational at any one time.
Note: In {project-shortname}, you _must_ use the new configuration
syntax (refclock generic subtype N) to declare generic clocks, rather
than the old-style syntax with a magic address, unless the software
has been built with the --enable-classic-mode option in which case
*only* the old-style syntax will work.
Note: Under NTPsec, you _must_ use the new configuration syntax
(refclock generic subtype N) to declare generic clocks, rather than
the old-style syntax with a magic address, unless the software has
been built with the --enable-classic-mode option in which case *only*
the old-style syntax will work.
A note on the implementations:
......@@ -152,7 +152,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.
......@@ -350,7 +350,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
......@@ -358,10 +358,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
......@@ -371,11 +371,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
----------------------------------------
......@@ -383,7 +383,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:
......@@ -402,7 +402,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
......
......@@ -212,7 +212,7 @@ since the last poll.
using automatic mode (mode 2).
+flag3 {0 | 1}+::
_[Primary Unit]_ If set, [underline]#disables# the log throttle. Useful when
tracking problems in the interaction between _GPSD_ and _{ntpd}_, since
tracking problems in the interaction between _GPSD_ and _ntpd_, since
now all error events are logged. Persistent/recurrent errors can
easily fill up the log, so this should only be enabled during bug
hunts.
......
......@@ -343,7 +343,7 @@ clock, and the modem into the +clockstats+ file.
[subs="normal"]
----------------------------------------------------------------
statsdir /var/log/{ntpd}/
statsdir /var/log/ntpd/
filegen clockstats file clockstats type day enable
----------------------------------------------------------------
......
......@@ -14,9 +14,9 @@ As of 2015 Rockwell Jupiter chips are no longer generally available
and have not been manufactured for many years; they will be found only
in remaindered and legacy equipment.
This refclock is deprecated and obsolete. The {project-shortname}
maintainers plan to remove it in a future release. If you have a
requirement for it, please make this known to us.
This refclock is deprecated and obsolete. The NTPsec maintainers plan
to remove it in a future release. If you have a requirement for it,
please make this known to us.
== Description ==
......
......@@ -10,9 +10,9 @@ Features: +ppsclock+ (required)
== Deprecation warning ==
This refclock is deprecated and obsolete. The {project-shortname}
maintainers plan to remove it in a future release. If you have a
requirement for it, please make this known to us.
This refclock is deprecated and obsolete. The NTPsec maintainers plan
to remove it in a future release. If you have a requirement for it,
please make this known to us.
== Description ==
......
......@@ -39,7 +39,7 @@ can be overridden by setting the extended system variable
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 the +flag1+ option. 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.
......@@ -51,7 +51,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) the +flag1+
option is reset manually using +{ntpq}+.
option 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
......
......@@ -131,7 +131,7 @@ and
filters.
The driver uses 9600 bits per second by default, unless
{project-shortname} was built in Classic strict-compatiblity in which
NTPsec was built in Classic strict-compatibility mode, in which
case the old default of 4800bps is used. Faster bitrates can be
selected using the +baud+ option.
......@@ -147,7 +147,7 @@ jitter by reducing variation in transmission times.
== 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.
......@@ -178,7 +178,7 @@ example:
|=============================================================================
The clock identification in field 3 is normally the driver type and
unit, but if your {ntpd} was built in strict Classic compatibility
unit, but if your ntpd was built in strict Classic compatibility
mode it will be a magic clock address expressing the same information
in a more opaque way.
......@@ -236,7 +236,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.
......
......@@ -44,7 +44,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
......@@ -161,7 +161,7 @@ If clockstats is enabled, the driver will log a few counters. Examples:
|=============================================================================
The clock identification is normally the driver type and unit, but if
your {ntpd} was built in strict Classic compatibility mode it will
your ntpd was built in strict Classic compatibility mode it will
be a magic clock address expressing the same information in a more
opaque way.
......
......@@ -48,7 +48,7 @@ checked:
If set, the values in the record (clockTimeStampSec, clockTimeStampUSec,
receiveTimeStampSec, receiveTimeStampUSec, leap, precision) are passed
to +{ntpd}+, and +valid+ is cleared and +count+ is bumped.
to +ntpd+, and +valid+ is cleared and +count+ is bumped.
If not set, +count+ is bumped.
......@@ -60,10 +60,10 @@ If set, the +count+ field of the record is remembered, and the values in
the record (clockTimeStampSec, clockTimeStampUSec, receiveTimeStampSec,
receiveTimeStampUSec, leap, precision) are read. Then, the remembered
+count+ is compared to current value of +count+ now in the record. If
both are equal, the values read from the record are passed to _{ntpd}_. If
both are equal, the values read from the record are passed to _ntpd_. If
they differ, another process has modified the record while it was read
out (was not able to produce this case), and failure is reported to
_{ntpd}_. The +valid+ flag is cleared and +count+ is bumped.
_ntpd_. The +valid+ flag is cleared and +count+ is bumped.
If not set, +count+ is bumped
......@@ -82,7 +82,7 @@ discarded. This check is disabled when _flag1_ is set to 1.
== GPSD ==
http://www.catb.org/gpsd/[_GPSD_] knows how to talk to many GPS devices.
It can work with _{ntpd}_ through the SHM driver.
It can work with _ntpd_ through the SHM driver.
The _GPSD_ man page suggests setting minpoll and maxpoll to 4. That was
an attempt to reduce jitter. The SHM driver was fixed (ntp-4.2.5p138) to
......@@ -91,11 +91,11 @@ suggestion is no longer reasonable.
*Note:* The _GPSD_ client driver uses the _GPSD_ client
protocol to connect and talk to _GPSD_, but using the SHM driver is the
ancient way to have _GPSD_ talk to _{ntpd}_. There are some tricky points
ancient way to have _GPSD_ talk to _ntpd_. There are some tricky points
when using the SHM interface to interface with _GPSD_, because _GPSD_
will use two SHM clocks, one for the serial data stream and one for the
PPS information when available. Receivers with a loose/sloppy timing
between PPS and serial data can easily cause trouble here because _{ntpd}_
between PPS and serial data can easily cause trouble here because _ntpd_
has no way to join the two data streams and correlate the serial data
with the PPS events.
......@@ -107,9 +107,9 @@ common to all clockstats records.
The 4th field is the number of second ticks since the last poll. The 5th
field is the number of good data samples found. The last 64 will be used
by _{ntpd}_. The 6th field is the number of sample that didn't have valid
by _ntpd_. The 6th field is the number of sample that didn't have valid
data ready. The 7th field is the number of bad samples. The 8th field is
the number of times the mode 1 info was update while _{ntpd}_ was
the number of times the mode 1 info was update while _ntpd_ was
trying to grab a sample.
Here is a sample showing the GPS reception fading out:
......@@ -131,7 +131,7 @@ Here is a sample showing the GPS reception fading out: