summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorroberto <roberto@FreeBSD.org>2002-01-21 20:12:02 +0000
committerroberto <roberto@FreeBSD.org>2002-01-21 20:12:02 +0000
commitcf6abdc2e0a3d4c3b6fe7f5550f23761207c0a4d (patch)
tree8a7e57ea99e5c12636106f148911ece47bacfb0c
parent590d306747e211057f089ee9f21cda8d6f9b9b08 (diff)
downloadFreeBSD-src-cf6abdc2e0a3d4c3b6fe7f5550f23761207c0a4d.zip
FreeBSD-src-cf6abdc2e0a3d4c3b6fe7f5550f23761207c0a4d.tar.gz
Correct typos and macro usage.
PR: 33179, 33181, 33295 Submitted by: Norihiro Kumagai <kumagai@attbi.com> Reviewed by: sheldonh (MAINTAINER) MFC after: 2 days
-rw-r--r--usr.sbin/ntp/doc/ntpdate.878
-rw-r--r--usr.sbin/ntp/doc/ntpdc.812
-rw-r--r--usr.sbin/ntp/doc/ntpq.814
3 files changed, 52 insertions, 52 deletions
diff --git a/usr.sbin/ntp/doc/ntpdate.8 b/usr.sbin/ntp/doc/ntpdate.8
index 5c50590..7ff96da 100644
--- a/usr.sbin/ntp/doc/ntpdate.8
+++ b/usr.sbin/ntp/doc/ntpdate.8
@@ -22,21 +22,21 @@
.Em Note :
The functionality of this program is now available
in the
-.Xr ntpd 8
+.Xr ntpd 8
program.
See the
-.Fl q
+.Fl q
command line
option in the
-.Xr ntpd 8
+.Xr ntpd 8
page.
After a suitable period of
mourning, the
-.Nm
+.Nm
program is to be retired from this
distribution.
.Pp
-.Nm
+.Nm
sets the local date and time by polling the
Network Time Protocol (NTP) server(s) given as the
.Ar server
@@ -48,7 +48,7 @@ servers specified and a subset of the NTP clock filter and
selection algorithms are applied to select the best of these.
Note
that the accuracy and reliability of
-.Nm
+.Nm
depends on
the number of servers, the number of polls each time it is run and
the interval between runs.
@@ -58,7 +58,7 @@ The following options are available:
.It Fl a Ar key
Enable the authentication function and specify the key
identifier to be used for authentication as the argument
-.Ar key
+.Ar key .
The keys and key identifiers must match
in both the client and server key files.
The default is to disable
@@ -74,9 +74,9 @@ default is to step the time using
if the offset is
greater than +-128 ms.
Note that, if the offset is much greater
-than +-128 ms in this case, that it can take a long time (hours) to
+than +-128 ms in this case, it can take a long time (hours) to
slew the clock to the correct value.
-During this time. the host
+During this time, the host
should not be used to synchronize clients.
.It Fl b
Force the time to be stepped using the
@@ -89,7 +89,7 @@ This option should be used when called from a startup file at boot
time.
.It Fl d
Enable the debugging mode, in which
-.Nm
+.Nm
will go
through all the steps, but not adjust the local clock.
Information
@@ -100,7 +100,7 @@ function as the value
.Ar authdelay ,
in seconds and fraction
(see
-.Xr ntpd 8
+.Xr ntpd 8
for details).
This number is usually small
enough to be negligible for most purposes, though specifying a
@@ -112,14 +112,14 @@ The default is
.Pa /etc/ntp.keys .
This file
should be in the format described in
-.Xr ntpd 8 .
+.Xr ntpd 8 .
.It Fl o Ar version
Specify the NTP version for outgoint packets as the integer
.Ar version ,
which can be 1 or 2.
The default is 3.
This allows
-.Nm
+.Nm
to be used with older NTP versions.
.It Fl p Ar samples
Specify the number of samples to be acquired from each server
@@ -132,31 +132,31 @@ Query only - don't set the clock.
.It Fl s
Divert logging output from the standard output (default) to the
system
-.Xr syslog 3
+.Xr syslog 3
facility.
This is designed primarily for
convenience of
-.Xr cron 8
+.Xr cron 8
scripts.
.It Fl t Ar timeout
Specify the maximum time waiting for a server response as the
value
.Ar timeout ,
in seconds and fraction.
-The value is is
+The value is
rounded to a multiple of 0.2 seconds.
The default is 1 second, a
value suitable for polling across a LAN.
.It Fl u
Direct
-.Nm
-to use an unprivileged port or outgoing
+.Nm
+to use an unprivileged port for outgoing
packets.
This is most useful when behind a firewall that blocks
incoming traffic to privileged ports, and you want to synchronise
with hosts beyond the firewall.
Note that the
-.Fl d
+.Fl d
option
always uses unprivileged ports.
.It Fl v
@@ -167,43 +167,43 @@ version
identification string to be logged.
.El
.Pp
-.Nm
+.Nm
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
clock initially before starting the NTP daemon
-.Xr ntpd 8 .
+.Xr ntpd 8 .
It is
also possible to run
-.Nm
+.Nm
from a
-.Xr cron 8
+.Xr cron 8
script.
However, it is important to note that
-.Nm
+.Nm
with
contrived
-.Xr cron 8
+.Xr cron 8
scripts is no substitute for the NTP
daemon, which uses sophisticated algorithms to maximize accuracy
and reliability while minimizing resource use.
Finally, since
-.Nm
+.Nm
does not discipline the host clock frequency as
does
-.Xr ntpd 8 ,
+.Xr ntpd 8 ,
the accuracy using
-.Nm
+.Nm
is
limited.
.Pp
Time adjustments are made by
-.Nm
+.Nm
in one of two
ways.
If
-.Nm
+.Nm
determines the clock is in error more
than 0.5 second it will simply step the time by calling the system
.Xr settimeofday 2
@@ -215,22 +215,22 @@ routine.
The latter technique is less disruptive
and more accurate when the error is small, and works quite well
when
-.Nm
+.Nm
is run by
-.Xr cron 8
+.Xr cron 8
every hour or
two.
.Pp
-.Nm
+.Nm
will decline to set the date if an NTP server
daemon (e.g.,
-.Xr ntpd 8 )
+.Xr ntpd 8 )
is running on the same host.
When
running
-.Nm
+.Nm
on a regular basis from
-.Xr cron 8
+.Xr cron 8
as
an alternative to running a daemon, doing so once every hour or two
will result in precise enough timekeeping to avoid stepping the
@@ -239,12 +239,12 @@ clock.
If NetInfo support is compiled into
.Nm ,
then the
-.Ic server
+.Ic server
argument is optional if
-.Nm
+.Nm
can find a
time server in the NetInfo configuration for
-.Xr ntpd 8 .
+.Xr ntpd 8 .
.Sh FILES
.Bl -tag -width /etc/ntp.keys -compact
.It Pa /etc/ntp.keys
diff --git a/usr.sbin/ntp/doc/ntpdc.8 b/usr.sbin/ntp/doc/ntpdc.8
index febd02d..bca7479 100644
--- a/usr.sbin/ntp/doc/ntpdc.8
+++ b/usr.sbin/ntp/doc/ntpdc.8
@@ -130,7 +130,7 @@ uniquely 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
-.Ql \&; ,
+.Ql \&> ,
followed by a file name, to the command line.
.Pp
A number of interactive format commands are executed entirely
@@ -378,7 +378,7 @@ signal.
The
.Sq stability
is the residual frequency error remaining
-afterthe system frequency correction is applied and is intended for
+after the system frequency correction is applied and is intended for
maintenance and debugging.
In most architectures, this value will
initially decrease from as high as 500 ppm to a nominal value in
@@ -391,7 +391,7 @@ may be
incorrect.
.Pp
The
-.Ic broadcastdelay
+.Sq broadcastdelay
shows the default broadcast delay,
as set by the
.Ic broadcastdelay
@@ -425,7 +425,7 @@ Obtain and print traffic counts collected and maintained by the
monitor facility.
The version number should not normally need to be
specified.
-.It Ic clkbug clock_peer_address ...
+.It Ic clkbug Ar clock_peer_address ...
Obtain debugging information for a reference clock driver.
This
information is provided only by some clock drivers and is mostly
@@ -548,8 +548,8 @@ is willing to continue on in this fashion.
This command provides a way to set certain data for a reference
clock.
See the source listing for further information.
-.It enable Ar flag ...
-.It disable Ar flag ...
+.It Ic enable Ar flag ...
+.It Ic disable Ar flag ...
These commands operate in the same way as the
.Ic enable
and
diff --git a/usr.sbin/ntp/doc/ntpq.8 b/usr.sbin/ntp/doc/ntpq.8
index 717a8e2..d47afbd 100644
--- a/usr.sbin/ntp/doc/ntpq.8
+++ b/usr.sbin/ntp/doc/ntpq.8
@@ -113,7 +113,7 @@ uniquely 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
-.Ql \&< ,
+.Ql \&> ,
followed by a file name, to the command line.
A
number of interactive format commands are executed entirely within
@@ -322,7 +322,7 @@ in
The index is then of use when dealing with stupid
servers which use association identifiers which are hard for humans
to type, in that for any subsequent commands which require an
-association identifier as an argument, the form and index may be
+association identifier as an argument, the form of index may be
used as an alternative.
.It Xo Ic clockvar Op Ar assocID
.Oo
@@ -411,7 +411,7 @@ An old form of the
.Ic peers
command with the reference ID
replaced by the local interface address.
-.It Ic passocations
+.It Ic passociations
Displays association data concerning in-spec peers from the
internally cached list of associations.
This command performs
@@ -455,14 +455,14 @@ further consideration.
The peer is discarded by the clustering algorithm as an
outlyer.
.It \&+
-.Pq candidat
+.Pq candidate
The peer is a survivor and a candidate for the combining
algorithm.
.It \&#
.Pq selected
The peer is a survivor, but not among the first six peers
sorted by synchronization distance.
-If the assocation is ephemeral,
+If the association is ephemeral,
it may be demobilized to conserve resources.
.It \&*
.Pq peer
@@ -471,7 +471,7 @@ variables to the system variables.
.It o
.Pq (pps.peer)
The peer has been declared the system peer and lends its
-variables to thesystem variables.
+variables to the system variables.
However, the actual system
synchronization is derived from a pulse-per-second (PPS) signal,
either indirectly via the PPS reference clock driver or directly
@@ -688,7 +688,7 @@ association.
The names and values of the peer variables returned
will be printed.
Note that the status word from the header is
-displayed preceding the variables, both in hexidecimal and in
+displayed preceding the variables, both in hexadecimal and in
pidgeon English.
.It Ic readlist Ar assocID
.It Ic rl Ar assocID
OpenPOWER on IntegriCloud