aboutsummaryrefslogtreecommitdiff
path: root/usr.sbin/ntp
diff options
context:
space:
mode:
authorPhilippe Charnier <charnier@FreeBSD.org>2002-07-14 14:47:15 +0000
committerPhilippe Charnier <charnier@FreeBSD.org>2002-07-14 14:47:15 +0000
commit490d5836b5ab0c76675986696b1637fff97dfae2 (patch)
tree1cffbfcbeace5b3e6b01d3c6b67a9c10233bc810 /usr.sbin/ntp
parentfb9f73c4dd34b5748d573f1eb7edad1b4e0a3666 (diff)
downloadsrc-490d5836b5ab0c76675986696b1637fff97dfae2.tar.gz
src-490d5836b5ab0c76675986696b1637fff97dfae2.zip
The .Nm utility
Notes
Notes: svn path=/head/; revision=99968
Diffstat (limited to 'usr.sbin/ntp')
-rw-r--r--usr.sbin/ntp/doc/ntp-genkeys.86
-rw-r--r--usr.sbin/ntp/doc/ntpd.813
-rw-r--r--usr.sbin/ntp/doc/ntpdate.811
-rw-r--r--usr.sbin/ntp/doc/ntpdc.819
-rw-r--r--usr.sbin/ntp/doc/ntpq.819
-rw-r--r--usr.sbin/ntp/doc/ntptime.84
-rw-r--r--usr.sbin/ntp/doc/ntptrace.83
7 files changed, 48 insertions, 27 deletions
diff --git a/usr.sbin/ntp/doc/ntp-genkeys.8 b/usr.sbin/ntp/doc/ntp-genkeys.8
index 3af0f47b3c3e..7a1b116f2c4f 100644
--- a/usr.sbin/ntp/doc/ntp-genkeys.8
+++ b/usr.sbin/ntp/doc/ntp-genkeys.8
@@ -14,7 +14,9 @@
.Op Fl g Ar target
.Op Fl k Ar keyfile
.Sh DESCRIPTION
-This program generates random keys used by either or both the
+The
+.Nm
+utility generates random keys used by either or both the
NTPv3/NTPv4 symmetric key or the NTPv4 public key (Autokey)
cryptographic authentication schemes.
.Pp
@@ -105,7 +107,7 @@ the same security compartment.
While the key identifiers for MD5
and DES keys must be in the range 1-65534, inclusive, the
.Nm
-program uses only the identifiers from 1 to
+utility uses only the identifiers from 1 to
16.
The key identifier for each association is specified as the key
argument in the
diff --git a/usr.sbin/ntp/doc/ntpd.8 b/usr.sbin/ntp/doc/ntpd.8
index f4107aafc98a..0f5646762ce2 100644
--- a/usr.sbin/ntp/doc/ntpd.8
+++ b/usr.sbin/ntp/doc/ntpd.8
@@ -25,7 +25,7 @@
.Sh DESCRIPTION
The
.Nm
-program is an operating system daemon which sets
+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
@@ -33,8 +33,9 @@ Network Time Protocol (NTP) version 4, but also retains
compatibility with version 3, as defined by RFC-1305, and version 1
and 2, as defined by RFC-1059 and RFC-1119, respectively.
.Pp
+The
.Nm
-does most computations in 64-bit floating point
+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.
@@ -206,7 +207,7 @@ option.
.Ss "How NTP Operates"
The
.Nm
-program operates by exchanging messages with
+utility operates by exchanging messages with
one or more configured servers at designated poll intervals.
When
started, whether for the first or subsequent times, the program
@@ -360,8 +361,9 @@ immediately.
After that the current frequency offset is written to
the file at hourly intervals.
.Ss "Operating Modes"
+The
.Nm
-can operate in any of several modes, including
+utility can operate in any of several modes, including
symmetric active/passive, client/server broadcast/multicast and
manycast, as described in the
.Qq Association Management
@@ -574,8 +576,9 @@ A snapshot of this documentation is available in HTML format in
.%O RFC1305
.Re
.Sh BUGS
+The
.Nm
-has gotten rather fat.
+utility has gotten rather fat.
While not huge, it has gotten
larger than might be desirable for an elevated-priority
.Nm
diff --git a/usr.sbin/ntp/doc/ntpdate.8 b/usr.sbin/ntp/doc/ntpdate.8
index 7ff96da49200..139d7389b6dd 100644
--- a/usr.sbin/ntp/doc/ntpdate.8
+++ b/usr.sbin/ntp/doc/ntpdate.8
@@ -33,11 +33,12 @@ page.
After a suitable period of
mourning, the
.Nm
-program is to be retired from this
+utility is to be retired from this
distribution.
.Pp
+The
.Nm
-sets the local date and time by polling the
+utility sets the local date and time by polling the
Network Time Protocol (NTP) server(s) given as the
.Ar server
arguments to determine the correct time.
@@ -167,8 +168,9 @@ version
identification string to be logged.
.El
.Pp
+The
.Nm
-can be run manually as necessary to set the
+utility can be run manually as necessary to set the
host clock, or it can be run from the host startup script to set
the clock at boot time.
This is useful in some cases to set the
@@ -221,8 +223,9 @@ is run by
every hour or
two.
.Pp
+The
.Nm
-will decline to set the date if an NTP server
+utility will decline to set the date if an NTP server
daemon (e.g.,
.Xr ntpd 8 )
is running on the same host.
diff --git a/usr.sbin/ntp/doc/ntpdc.8 b/usr.sbin/ntp/doc/ntpdc.8
index bca7479255e1..acc8990fb9f4 100644
--- a/usr.sbin/ntp/doc/ntpdc.8
+++ b/usr.sbin/ntp/doc/ntpdc.8
@@ -13,8 +13,9 @@
.Op Fl c Ar command
.Op Ar host ...
.Sh DESCRIPTION
+The
.Nm
-is used to query the
+utility is used to query the
.Xr ntpd 8
daemon about its
current state and to request changes in that state.
@@ -81,19 +82,22 @@ 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.
+The
.Nm
-will prompt for
+utility will prompt for
commands if the standard input is a terminal device.
.Pp
+The
.Nm
-uses NTP mode 7 packets to communicate with the
+utility uses NTP mode 7 packets to communicate with the
NTP server, and hence can be used to query any compatable 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.
+The
.Nm
-makes
+utility makes
no attempt to retransmit requests, and will time requests out if
the remote host is not heard from within a suitable timeout
time.
@@ -107,7 +111,7 @@ daemon and can be expected to
work only with this and maybe some previous versions of the daemon.
Requests from a remote
.Nm
-program which affect the
+utility which affect the
state of the local server must be authenticated, which requires
both the remote program and local server share a common key and key
identifier.
@@ -136,7 +140,7 @@ followed by a file name, to the command line.
A number of interactive format commands are executed entirely
within the
.Nm
-program itself and do not result in NTP
+utility itself and do not result in NTP
mode 7 requests being sent to a server.
These are described
following.
@@ -709,8 +713,9 @@ See the source listing for further information.
.%O RFC1305
.Re
.Sh BUGS
+The
.Nm
-is a crude hack.
+utility is a crude hack.
Much of the information it shows is
deadly boring and could only be loved by its implementer.
The
diff --git a/usr.sbin/ntp/doc/ntpq.8 b/usr.sbin/ntp/doc/ntpq.8
index d47afbd1348c..6fc08c4109b8 100644
--- a/usr.sbin/ntp/doc/ntpq.8
+++ b/usr.sbin/ntp/doc/ntpq.8
@@ -15,7 +15,7 @@
.Sh DESCRIPTION
The
.Nm
-utility program is used to query NTP servers
+utility is used to query NTP servers
which implement the recommended NTP mode 6 control message format
about current state and to request changes in that state.
The
@@ -24,8 +24,9 @@ command line arguments.
Requests to read and write arbitrary
variables can be assembled, with raw and pretty-printed output
options being available.
+The
.Nm
-can also obtain and print a
+utility can also obtain and print a
list of peers in a common format by sending multiple queries to the
server.
.Pp
@@ -42,19 +43,22 @@ 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.
+The
.Nm
-will prompt for
+utility will prompt for
commands if the standard input is a terminal device.
.Pp
+The
.Nm
-uses NTP mode 6 packets to communicate with the
+utility 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.
+The
.Nm
-makes
+utility makes
one attempt to retransmit requests, and will time requests out if
the remote host is not heard from within a suitable timeout
time.
@@ -119,7 +123,7 @@ A
number of interactive format commands are executed entirely within
the
.Nm
-program itself and do not result in NTP mode 6
+utility itself and do not result in NTP mode 6
requests being sent to a server.
These are described following.
.Bl -tag -width indent
@@ -151,8 +155,9 @@ where the
.Ql =value
is ignored, and can be omitted,
in requests to the server to read variables.
+The
.Nm
-maintains an internal list in which data to be included in control
+utility maintains an internal list in which data to be included in control
messages can be assembled, and sent using the
.Ic readlist
and
diff --git a/usr.sbin/ntp/doc/ntptime.8 b/usr.sbin/ntp/doc/ntptime.8
index 2572cdff57b9..f130307457f3 100644
--- a/usr.sbin/ntp/doc/ntptime.8
+++ b/usr.sbin/ntp/doc/ntptime.8
@@ -17,7 +17,9 @@
.Op Fl s Ar status
.Op Fl t Ar time_constant
.Sh DESCRIPTION
-This program is useful only with special kernels
+The
+.Nm
+utility is useful only with special kernels
described in the
.Qo
A Kernel Model for Precision Timekeeping
diff --git a/usr.sbin/ntp/doc/ntptrace.8 b/usr.sbin/ntp/doc/ntptrace.8
index c76288f746a2..82e1ff38e478 100644
--- a/usr.sbin/ntp/doc/ntptrace.8
+++ b/usr.sbin/ntp/doc/ntptrace.8
@@ -14,8 +14,9 @@
.Op Fl t Ar timeout
.Op Ar server
.Sh DESCRIPTION
+The
.Nm
-determines where a given Network Time Protocol (NTP) server gets
+utility determines where a given Network Time Protocol (NTP) server gets
its time from, and follows the chain of NTP servers back to their
master time source.
If given no arguments, it starts with