Aren
/
NetBSD
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Make these a little more readable.

This commit is contained in:
simonb 2000-03-30 01:49:23 +00:00
parent dd7160dcba
commit e06c3570b8
6 changed files with 158 additions and 223 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
usr.sbin/ntp/ntpd/ntpd.8
View File

@ -1,4 +1,4 @@
.\" $NetBSD: ntpd.8,v 1.1 2000/03/29 13:54:44 simonb Exp $ .\" $NetBSD: ntpd.8,v 1.2 2000/03/30 01:49:23 simonb Exp $
.\" Converted from HTML to mandoc by html-to-mdoc.pl .\" Converted from HTML to mandoc by html-to-mdoc.pl
.\" .\"
.Dd Mar 29, 2000 .Dd Mar 29, 2000
@ -223,14 +223,14 @@ refer to
.Pa /usr/share/doc/ntp/miscopt.htm . .Pa /usr/share/doc/ntp/miscopt.htm .
.Pp .Pp
.Sh FILES .Sh FILES
.Pa /etc/ntp.conf .Bl -tag -width /etc/ntp.drift -compact
- the default name of the configuration file .It Pa /etc/ntp.conf
<BR> the default name of the configuration file
.Pa /etc/ntp.drift .It Pa /etc/ntp.drift
- the default name of the drift file the default name of the drift file
<BR> .It Pa /etc/ntp.keys
.Pa /etc/ntp.keys the default name of the key file
- the default name of the key file .El
.Sh BUGS .Sh BUGS
.Nm .Nm
has gotten rather fat. While not huge, it has gotten has gotten rather fat. While not huge, it has gotten

11
usr.sbin/ntp/ntpdate/ntpdate.8
View File

@ -1,4 +1,4 @@
.\" $NetBSD: ntpdate.8,v 1.1 2000/03/29 13:54:45 simonb Exp $ .\" $NetBSD: ntpdate.8,v 1.2 2000/03/30 01:49:24 simonb Exp $
.\" Converted from HTML to mandoc by html-to-mdoc.pl .\" Converted from HTML to mandoc by html-to-mdoc.pl
.\" .\"
.Dd Mar 29, 2000 .Dd Mar 29, 2000
@ -187,10 +187,11 @@ Be verbose. This option will cause
string to be logged. string to be logged.
.El .El
.Sh FILES .Sh FILES
.Pa /etc/ntp.keys .Bl -tag -width /etc/ntp.keys -compact
- encryption keys used by .It Pa /etc/ntp.keys
.Nm encryption keys used by
. .Nm "" .
.El
.Sh BUGS .Sh BUGS
The slew adjustment is actually 50% larger than the measured offset, since The slew adjustment is actually 50% larger than the measured offset, since
this (it is argued) will tend to keep a badly drifting clock more accurate. this (it is argued) will tend to keep a badly drifting clock more accurate.

128
usr.sbin/ntp/ntpdc/ntpdc.8
View File

@ -1,4 +1,4 @@
.\" $NetBSD: ntpdc.8,v 1.1 2000/03/29 13:54:45 simonb Exp $ .\" $NetBSD: ntpdc.8,v 1.2 2000/03/30 01:49:24 simonb Exp $
.\" Converted from HTML to mandoc by html-to-mdoc.pl .\" Converted from HTML to mandoc by html-to-mdoc.pl
.\" .\"
.Dd Mar 29, 2000 .Dd Mar 29, 2000
@ -118,10 +118,8 @@ the
program itself and do not result in NTP mode 7 requests program itself and do not result in NTP mode 7 requests
being sent to a server. These are described following. being sent to a server. These are described following.
.Bl -tag -width indent .Bl -tag -width indent
.It Fl Ar ? [ command_keyword ] .It Ar ? [ command_keyword ]
<BR><TT>helpl [ .It Ar helpl [ command_keyword ]
.Ar command_keyword
]</TT>
A A
.Pa ? .Pa ?
by itself will print a list of all the command keywords known by itself will print a list of all the command keywords known
@ -134,39 +132,41 @@ keyword will print funcation and usage information about the command. This
command is probably a better source of information about command is probably a better source of information about
.Pa ntpq .Pa ntpq
than this manual page. than this manual page.
.It Fl Ar delay milliseconds .It Ar delay milliseconds
Specify a time interval to be added to timestamps included in requests Specify a time interval to be added to timestamps included in requests
which require authentication. This is used to enable (unreliable) server which require authentication. This is used to enable (unreliable) server
reconfiguration over long delay network paths or between machines whose reconfiguration over long delay network paths or between machines whose
clocks are unsynchronized. Actually the server does not now require timestamps clocks are unsynchronized. Actually the server does not now require timestamps
in authenticated requests, so this command may be obsolete. in authenticated requests, so this command may be obsolete.
.It Fl Ar host hostname .It Ar host hostname
Set the host to which future queries will be sent. Hostname may be either Set the host to which future queries will be sent. Hostname may be either
a host name or a numeric address. a host name or a numeric address.
.It Fl Ar hostnames [ yes | no ] .It Ar hostnames [ yes | no ]
If If
.Pa yes .Pa yes
is specified, host names are printed in information displays. is specified, host names are printed in information displays.
If If
.Pa no .Pa no
is specified, numeric addresses are printed instead. The is specified, numeric addresses are printed instead. The
default is <TT>yes, unless modified using the command line default is
.Em yes ,
unless modified using the command line
.Fl n .Fl n
switch. switch.
.It Fl Ar keyid keyid .It Ar keyid keyid
This command allows the specification of a key number to be used to authenticate This command allows the specification of a key number to be used to authenticate
configuration requests. This must correspond to a key number the server configuration requests. This must correspond to a key number the server
has been configured to use for this purpose. has been configured to use for this purpose.
.It Fl Ar quit .It Ar quit
Exit Exit
.Nm .Nm
. .
.It Fl Ar passwd .It Ar passwd
This command prompts you to type in a password (which will not be echoed) This command prompts you to type in a password (which will not be echoed)
which will be used to authenticate configuration requests. The password which will be used to authenticate configuration requests. The password
must correspond to the key configured for use by the NTP server for this must correspond to the key configured for use by the NTP server for this
purpose if such requests are to be successful. purpose if such requests are to be successful.
.It Fl Ar timeout millseconds .It Ar timeout millseconds
Specify a timeout period for responses to server queries. The default is Specify a timeout period for responses to server queries. The default is
about 8000 milliseconds. Note that since about 8000 milliseconds. Note that since
.Nm .Nm
@ -179,12 +179,12 @@ Query commands result in NTP mode 7 packets containing requests for information
being sent to the server. These are read-only commands in that they make being sent to the server. These are read-only commands in that they make
no modification of the server configuration state. no modification of the server configuration state.
.Bl -tag -width indent .Bl -tag -width indent
.It Fl Ar listpeers .It Ar listpeers
Obtains and prints a brief list of the peers for which the server is maintaining Obtains and prints a brief list of the peers for which the server is maintaining
state. These should include all configured peer associations as well as state. These should include all configured peer associations as well as
those peers whose stratum is such that they are considered by the server those peers whose stratum is such that they are considered by the server
to be possible future synchonization candidates. to be possible future synchonization candidates.
.It Fl Ar peers .It Ar peers
Obtains a list of peers for which the server is maintaining state, along Obtains a list of peers for which the server is maintaining state, along
with a summary of that state. Summary information includes the address with a summary of that state. Summary information includes the address
of the remote peer, the local interface address (0.0.0.0 if a local address of the remote peer, the local interface address (0.0.0.0 if a local address
@ -193,8 +193,10 @@ has yet to be determined), the stratum of the remote peer (a stratum of
in seconds, the reachability register, in octal, and the current estimated in seconds, the reachability register, in octal, and the current estimated
delay, offset and dispersion of the peer, all in seconds. In addition, delay, offset and dispersion of the peer, all in seconds. In addition,
the character in the left margin indicates the mode this peer entry is the character in the left margin indicates the mode this peer entry is
operating in. A <TT>+ denotes symmetric active, a operating in. A
.Fl .Pa +
denotes symmetric active, a
.Pa ^
indicates indicates
symmetric passive, a symmetric passive, a
.Pa = .Pa =
@ -211,15 +213,13 @@ marks the peer the server is currently synchonizing to.
.Pp .Pp
The contents of the host field may be one of four forms. It may be a The contents of the host field may be one of four forms. It may be a
host name, an IP address, a reference clock implementation name with its host name, an IP address, a reference clock implementation name with its
parameter or <TT>REFCLK( parameter or REFCLK(
.Ar implementation number .Ar implementation number ,
, .Ar parameter ).
.Ar parameter
)</TT>.
On On
.Pa hostnames no .Pa "hostnames no"
only IP-addresses will be displayed. only IP-addresses will be displayed.
.It Fl Ar dmpeers .It Ar dmpeers
A slightly different peer summary list. Identical to the output of the A slightly different peer summary list. Identical to the output of the
.Pa peers .Pa peers
command, except for the character in the leftmost column. command, except for the character in the leftmost column.
@ -234,20 +234,20 @@ that the peer made it through. A
.Pa * .Pa *
denotes the peer the server denotes the peer the server
is currently synchronizing with. is currently synchronizing with.
.It Fl Ar showpeer peer_address [...] .It Ar showpeer peer_address [...]
Shows a detailed display of the current peer variables for one or more Shows a detailed display of the current peer variables for one or more
peers. Most of these values are described in the NTP Version 2 specification. peers. Most of these values are described in the NTP Version 2 specification.
.It Fl Ar pstats peer_address [...] .It Ar pstats peer_address [...]
Show per-peer statistic counters associated with the specified peer(s). Show per-peer statistic counters associated with the specified peer(s).
.It Fl Ar clockinfo clock_peer_address [...] .It Ar clockinfo clock_peer_address [...]
Obtain and print information concerning a peer clock. The values obtained Obtain and print information concerning a peer clock. The values obtained
provide information on the setting of fudge factors and other clock performance provide information on the setting of fudge factors and other clock performance
information. information.
.It Fl Ar kerninfo .It Ar kerninfo
Obtain and print kernel phase-lock loop operating parameters. This information Obtain and print kernel phase-lock loop operating parameters. This information
is available only if the kernel has been specially modified for a precision is available only if the kernel has been specially modified for a precision
timekeeping function. timekeeping function.
.It Fl Ar loopinfo [ oneline | multiline ] .It Ar loopinfo [ oneline | multiline ]
Print the values of selected loop filter variables. The loop filter is Print the values of selected loop filter variables. The loop filter is
the part of NTP which deals with adjusting the local system clock. The the part of NTP which deals with adjusting the local system clock. The
.Pa offset .Pa offset
@ -271,7 +271,7 @@ options specify
the format in which this information is to be printed, with the format in which this information is to be printed, with
.Pa multiline .Pa multiline
as the default. as the default.
.It Fl Ar sysinfo .It Ar sysinfo
Print a variety of system state variables, i.e., state related to the local Print a variety of system state variables, i.e., state related to the local
server. All except the last four lines are described in the NTP Version server. All except the last four lines are described in the NTP Version
3 specification, RFC-1305. 3 specification, RFC-1305.
@ -332,22 +332,22 @@ the
.Pa authdelay .Pa authdelay
configuration command. configuration command.
.El .El
.It Fl Ar sysstats .It Ar sysstats
Print statistics counters maintained in the protocol module. Print statistics counters maintained in the protocol module.
.It Fl Ar memstats .It Ar memstats
Print statistics counters related to memory allocation code. Print statistics counters related to memory allocation code.
.It Fl Ar iostats .It Ar iostats
Print statistics counters maintained in the input-output module. Print statistics counters maintained in the input-output module.
.It Fl Ar timerstats .It Ar timerstats
Print statistics counters maintained in the timer/event queue support code. Print statistics counters maintained in the timer/event queue support code.
.It Fl Ar reslist .It Ar reslist
Obtain and print the server's restriction list. This list is (usually) Obtain and print the server's restriction list. This list is (usually)
printed in sorted order and may help to understand how the restrictions printed in sorted order and may help to understand how the restrictions
are applied. are applied.
.It Fl Ar monlist [ version ] .It Ar monlist [ version ]
Obtain and print traffic counts collected and maintained by the monitor Obtain and print traffic counts collected and maintained by the monitor
facility. The version number should not normally need to be specified. facility. The version number should not normally need to be specified.
.It Fl Ar clkbug clock_peer_address [...] .It Ar clkbug clock_peer_address [...]
Obtain debugging information for a reference clock driver. This information Obtain debugging information for a reference clock driver. This information
is provided only by some clock drivers and is mostly undecodable without is provided only by some clock drivers and is mostly undecodable without
a copy of the driver source in hand. a copy of the driver source in hand.
@ -382,7 +382,7 @@ should provide an adequate level of security.
.Pp .Pp
The following commands all make authenticated requests. The following commands all make authenticated requests.
.Bl -tag -width indent .Bl -tag -width indent
.It Fl Ar addpeer peer_address [ keyid ] [ version ] [ prefer ] .It Ar addpeer peer_address [ keyid ] [ version ] [ prefer ]
Add a configured peer association at the given address and operating in Add a configured peer association at the given address and operating in
symmetric active mode. Note that an existing association with the same symmetric active mode. Note that an existing association with the same
peer may be deleted when this command is executed, or may simply be converted peer may be deleted when this command is executed, or may simply be converted
@ -399,27 +399,25 @@ a preferred peer (and thus will be used primarily for clock synchronisation
if possible). The preferred peer also determines the validity of the PPS if possible). The preferred peer also determines the validity of the PPS
signal - if the preferred peer is suitable for synchronisation so is the signal - if the preferred peer is suitable for synchronisation so is the
PPS signal. PPS signal.
.It Fl Ar addserver peer_address [ keyid ] [ version ] [ prefer ] .It Ar addserver peer_address [ keyid ] [ version ] [ prefer ]
Identical to the addpeer command, except that the operating mode is client. Identical to the addpeer command, except that the operating mode is client.
.It Fl Ar broadcast peer_address [ keyid ] [ version ] [ prefer ] .It Ar broadcast peer_address [ keyid ] [ version ] [ prefer ]
Identical to the addpeer command, except that the operating mode is broadcast. Identical to the addpeer command, except that the operating mode is broadcast.
In this case a valid key identifier and key are required. The In this case a valid key identifier and key are required. The
.Pa peer_address .Pa peer_address
parameter can be the broadcast address of the local network or a multicast parameter can be the broadcast address of the local network or a multicast
group address assigned to NTP. If a multicast address, a multicast-capable group address assigned to NTP. If a multicast address, a multicast-capable
kernel is required. kernel is required.
.It Fl Ar unconfig peer_address [...] .It Ar unconfig peer_address [...]
This command causes the configured bit to be removed from the specified This command causes the configured bit to be removed from the specified
peer(s). In many cases this will cause the peer association to be deleted. peer(s). In many cases this will cause the peer association to be deleted.
When appropriate, however, the association may persist in an unconfigured When appropriate, however, the association may persist in an unconfigured
mode if the remote peer is willing to continue on in this fashion. mode if the remote peer is willing to continue on in this fashion.
.It Fl Ar fudge peer_address [ time1 ] [ time2 ] [ stratum ] [ refid ] .It Ar fudge peer_address [ time1 ] [ time2 ] [ stratum ] [ refid ]
This command provides a way to set certain data for a reference clock. This command provides a way to set certain data for a reference clock.
See the source listing for further information. See the source listing for further information.
.It Fl Ar enable [ flag ] [ ... ] .It Ar enable [ flag ] [ ... ]
<BR><TT>disable [ .It Ar disable [ flag ] [ ... ]
.Ar flag
] [ ... ]</TT>
These commands operate in the same way as the These commands operate in the same way as the
.Pa enable .Pa enable
and and
@ -448,24 +446,24 @@ and
.Pa pps_kernel .Pa pps_kernel
flags are read-only. flags are read-only.
.Bl -tag -width indent .Bl -tag -width indent
.It Fl Ar auth .It Ar auth
Enables the server to synchronize with unconfigured peers only if the peer Enables the server to synchronize with unconfigured peers only if the peer
has been correctly authenticated using a trusted key and key identifier. has been correctly authenticated using a trusted key and key identifier.
The default for this flag is enable. The default for this flag is enable.
.It Fl Ar bclient .It Ar bclient
Enables the server to listen for a message from a broadcast or multicast Enables the server to listen for a message from a broadcast or multicast
server, as in the server, as in the
.Pa multicastclient .Pa multicastclient
command with default address. command with default address.
The default for this flag is disable. The default for this flag is disable.
.It Fl Ar monitor .It Ar monitor
Enables the monitoring facility. See the Enables the monitoring facility. See the
.Nm .Nm
program and the program and the
.Pa monlist .Pa monlist
command or further information. The default for this flag command or further information. The default for this flag
is enable. is enable.
.It Fl Ar pll .It Ar pll
Enables the server to adjust its local clock by means of NTP. If disabled, Enables the server to adjust its local clock by means of NTP. If disabled,
the local clock free-runs at its intrinsic time and frequency offset. This the local clock free-runs at its intrinsic time and frequency offset. This
flag is useful in case the local clock is controlled by some other device flag is useful in case the local clock is controlled by some other device
@ -476,7 +474,7 @@ page in
.Pa /usr/share/doc/ntp/refclock.htm .Pa /usr/share/doc/ntp/refclock.htm
for further information. The default for this flag for further information. The default for this flag
is enable. is enable.
.It Fl Ar pps .It Ar pps
Enables the pulse-per-second (PPS) signal when frequency and time is disciplined Enables the pulse-per-second (PPS) signal when frequency and time is disciplined
by the precision time kernel modifications. See the by the precision time kernel modifications. See the
.%T "A Kernel Model for Precision Timekeeping" .%T "A Kernel Model for Precision Timekeeping"
@ -484,18 +482,18 @@ page in
.Pa /usr/share/doc/ntp/kern.htm .Pa /usr/share/doc/ntp/kern.htm
for further information. for further information.
The default for this flag is disable. The default for this flag is disable.
.It Fl Ar stats .It Ar stats
Enables the statistics facility. See the Enables the statistics facility. See the
.%T "Monitoring Options" .%T "Monitoring Options"
page in page in
.Pa /usr/share/doc/ntp/monopt.htm .Pa /usr/share/doc/ntp/monopt.htm
for further information. The default for this flag is for further information. The default for this flag is
enable. enable.
.It Fl Ar pll_kernel .It Ar pll_kernel
When the precision time kernel modifications are installed, this indicates When the precision time kernel modifications are installed, this indicates
the kernel controls the clock discipline; otherwise, the daemon controls the kernel controls the clock discipline; otherwise, the daemon controls
the clock discipline. the clock discipline.
.It Fl Ar pps_kernel .It Ar pps_kernel
When the precision time kernel modifications are installed and a pulse-per-second When the precision time kernel modifications are installed and a pulse-per-second
(PPS) signal is available, this indicates the PPS signal controls the clock (PPS) signal is available, this indicates the PPS signal controls the clock
discipline; otherwise, the daemon or kernel controls the clock discipline, discipline; otherwise, the daemon or kernel controls the clock discipline,
@ -503,26 +501,26 @@ as indicated by the
.Pa pll_kernel .Pa pll_kernel
flag. flag.
.El .El
.It Fl Ar restrict address mask flag [ flag ] .It Ar restrict address mask flag [ flag ]
This command operates in the same way as the This command operates in the same way as the
.Pa restrict .Pa restrict
configuration configuration
file commands of file commands of
.Pa ntpd .Pa ntpd
. .
.It Fl Ar unrestrict address mask flag [ flag ] .It Ar unrestrict address mask flag [ flag ]
Unrestrict the matching entry from the restrict list. Unrestrict the matching entry from the restrict list.
.It Fl Ar delrestrict address mask [ ntpport ] .It Ar delrestrict address mask [ ntpport ]
Delete the matching entry from the restrict list. Delete the matching entry from the restrict list.
.It Fl Ar readkeys .It Ar readkeys
Causes the current set of authentication keys to be purged and a new set Causes the current set of authentication keys to be purged and a new set
to be obtained by rereading the keys file (which must have been specified to be obtained by rereading the keys file (which must have been specified
in the in the
.Pa ntpd .Pa ntpd
configuration file). This allows encryption keys to configuration file). This allows encryption keys to
be changed without restarting the server. be changed without restarting the server.
.It Fl Ar trustkey keyid [...] .It Ar trustkey keyid [...]
.It Fl Ar untrustkey keyid [...] .It Ar untrustkey keyid [...]
These commands operate in the same way as the These commands operate in the same way as the
.Pa trustedkey .Pa trustedkey
and and
@ -530,19 +528,19 @@ and
configuration file commands of configuration file commands of
.Pa ntpd .Pa ntpd
. .
.It Fl Ar authinfo .It Ar authinfo
Returns information concerning the authentication module, including known Returns information concerning the authentication module, including known
keys and counts of encryptions and decryptions which have been done. keys and counts of encryptions and decryptions which have been done.
.It Fl Ar traps .It Ar traps
Display the traps set in the server. See the source listing for further Display the traps set in the server. See the source listing for further
information. information.
.It Fl Ar addtrap [ address [ port ] [ interface ] .It Ar addtrap [ address [ port ] [ interface ]
Set a trap for asynchronous messages. See the source listing for further Set a trap for asynchronous messages. See the source listing for further
information. information.
.It Fl Ar clrtrap [ address [ port ] [ interface] .It Ar clrtrap [ address [ port ] [ interface]
Clear a trap for asynchronous messages. See the source listing for further Clear a trap for asynchronous messages. See the source listing for further
information. information.
.It Fl Ar reset .It Ar reset
Clear the statistics counters in various modules of the server. See the Clear the statistics counters in various modules of the server. See the
source listing for further information. source listing for further information.
.El .El

205
usr.sbin/ntp/ntpq/ntpq.8
View File

@ -1,4 +1,4 @@
.\" $NetBSD: ntpq.8,v 1.1 2000/03/29 13:54:45 simonb Exp $ .\" $NetBSD: ntpq.8,v 1.2 2000/03/30 01:49:24 simonb Exp $
.\" Converted from HTML to mandoc by html-to-mdoc.pl .\" Converted from HTML to mandoc by html-to-mdoc.pl
.\" .\"
.Dd Mar 29, 2000 .Dd Mar 29, 2000
@ -81,10 +81,8 @@ within the
program itself and do not result in NTP mode 6 program itself and do not result in NTP mode 6
requests being sent to a server. These are described following. requests being sent to a server. These are described following.
.Bl -tag -width indent .Bl -tag -width indent
.It Fl Ar ? [command_keyword] .It Ar ? [ command_keyword ]
<BR><TT>helpl [ .It Ar helpl [ command_keyword ]
.Ar command_keyword
]</TT>
A A
.Pa "?" .Pa "?"
by itself will print a list of all the command keywords by itself will print a list of all the command keywords
@ -97,21 +95,17 @@ a command keyword will print funcation and usage information about the
command. This command is probably a better source of information about command. This command is probably a better source of information about
.Pa ntpq .Pa ntpq
than this manual page. than this manual page.
.It Fl Ar addvars variable_name [ = value] [...] .It Ar addvars variable_name [ = value] [...]
<BR><TT>rmvars .It Ar rmvars variable_name [...]
.Ar variable_name .It Ar clearvars
[...]</TT>
<BR>
.Pa clearvars
The data carried by NTP mode 6 messages consists of a list of items of The data carried by NTP mode 6 messages consists of a list of items of
the form <TT> the form
.Ar variable_name .Ar variable_name
= =
.Ar value ,
where the " =
.Ar value .Ar value
</TT>, where the <TT>" " is ignored, and can be omitted, in requests to the
=
.Ar value
"</TT> is ignored, and can be omitted, in requests to the
server to read variables. server to read variables.
.Pa ntpq .Pa ntpq
maintains an internal list in which maintains an internal list in which
@ -122,7 +116,7 @@ more than one variable is to be added, the list should be comma-separated
and not contain white space. The rmvars command can be used to remove individual and not contain white space. The rmvars command can be used to remove individual
variables from the list, while the clearlist command removes all variables variables from the list, while the clearlist command removes all variables
from the list. from the list.
.It Fl Ar authenticate yes | no .It Ar authenticate yes | no
Normally Normally
.Pa ntpq .Pa ntpq
does not authenticate requests unless they are write does not authenticate requests unless they are write
@ -132,7 +126,7 @@ to send authentication
with all requests it makes. Authenticated requests causes some servers with all requests it makes. Authenticated requests causes some servers
to handle requests slightly differently, and can occasionally melt the to handle requests slightly differently, and can occasionally melt the
CPU in fuzzballs if you turn authentication on before doing a peer display. CPU in fuzzballs if you turn authentication on before doing a peer display.
.It Fl Ar cooked .It Ar cooked
Causes output from query commands to be Causes output from query commands to be
.Pa "cooked" . .Pa "cooked" .
Variables which Variables which
@ -143,52 +137,54 @@ thinks should have a decodeable
value but didn't are marked with a trailing value but didn't are marked with a trailing
.Pa "?" .Pa "?"
. .
.It Fl Ar debug more | less | off .It Ar debug more | less | off
Turns internal query program debugging on and off. Turns internal query program debugging on and off.
.It Fl Ar delay milliseconds .It Ar delay milliseconds
Specify a time interval to be added to timestamps included in requests Specify a time interval to be added to timestamps included in requests
which require authentication. This is used to enable (unreliable) server which require authentication. This is used to enable (unreliable) server
reconfiguration over long delay network paths or between machines whose reconfiguration over long delay network paths or between machines whose
clocks are unsynchronized. Actually the server does not now require timestamps clocks are unsynchronized. Actually the server does not now require timestamps
in authenticated requests, so this command may be obsolete. in authenticated requests, so this command may be obsolete.
.It Fl Ar host hostname .It Ar host hostname
Set the host to which future queries will be sent. Hostname may be either Set the host to which future queries will be sent. Hostname may be either
a host name or a numeric address. a host name or a numeric address.
.It Fl Ar hostnames [yes | no] .It Ar hostnames [yes | no]
If If
.Pa "yes" .Pa "yes"
is specified, host names are printed in information displays. is specified, host names are printed in information displays.
If If
.Pa "no" .Pa "no"
is specified, numeric addresses are printed instead. The is specified, numeric addresses are printed instead. The
default is <TT>"yes", unless modified using the command line default is
.Em yes ,
unless modified using the command line
.Fl n .Fl n
switch. switch.
.It Fl Ar keyid keyid .It Ar keyid keyid
This command allows the specification of a key number to be used to authenticate This command allows the specification of a key number to be used to authenticate
configuration requests. This must correspond to a key number the server configuration requests. This must correspond to a key number the server
has been configured to use for this purpose. has been configured to use for this purpose.
.It Fl Ar ntpversion 1 | 2 | 3 | 4 .It Ar ntpversion 1 | 2 | 3 | 4
Sets the NTP version number which Sets the NTP version number which
.Pa ntpq .Pa ntpq
claims in packets. Defaults claims in packets. Defaults
to 3, Note that mode 6 control messages (and modes, for that matter) didn't to 3, Note that mode 6 control messages (and modes, for that matter) didn't
exist in NTP version 1. There appear to be no servers left which demand exist in NTP version 1. There appear to be no servers left which demand
version 1. version 1.
.It Fl Ar quit .It Ar quit
Exit Exit
.Pa ntpq .Pa ntpq
. .
.It Fl Ar passwd .It Ar passwd
This command prompts you to type in a password (which will not be echoed) This command prompts you to type in a password (which will not be echoed)
which will be used to authenticate configuration requests. The password which will be used to authenticate configuration requests. The password
must correspond to the key configured for use by the NTP server for this must correspond to the key configured for use by the NTP server for this
purpose if such requests are to be successful. purpose if such requests are to be successful.
.It Fl Ar raw .It Ar raw
Causes all output from query commands is printed as received from the remote Causes all output from query commands is printed as received from the remote
server. The only formating/intepretation done on the data is to transform server. The only formating/intepretation done on the data is to transform
nonascii data into a printable (but barely understandable) form. nonascii data into a printable (but barely understandable) form.
.It Fl Ar timeout millseconds .It Ar timeout millseconds
Specify a timeout period for responses to server queries. The default is Specify a timeout period for responses to server queries. The default is
about 5000 milliseconds. Note that since about 5000 milliseconds. Note that since
.Pa ntpq .Pa ntpq
@ -211,7 +207,7 @@ send a preprogrammed series of messages to obtain the data it needs, and
the mreadlist and mreadvar commands, which will iterate over a range of the mreadlist and mreadvar commands, which will iterate over a range of
associations. associations.
.Bl -tag -width indent .Bl -tag -width indent
.It Fl Ar associations .It Ar associations
Obtains and prints a list of association identifiers and peer statuses Obtains and prints a list of association identifiers and peer statuses
for in-spec peers of the server being queried. The list is printed in columns. for in-spec peers of the server being queried. The list is printed in columns.
The first of these is an index numbering the associations from 1 for internal The first of these is an index numbering the associations from 1 for internal
@ -230,8 +226,8 @@ 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 identifiers which are hard for humans to type, in that for any subsequent
commands which require an association identifier as an argument, the form commands which require an association identifier as an argument, the form
and index may be used as an alternative. and index may be used as an alternative.
.It Fl Ar clockvar [assocID] [variable_name [ = value [...] ] [...] .It Ar clockvar [assocID] [variable_name [ = value [...] ] [...]
.It Fl Ar cv [assocID] [variable_name [ = value [...] ] [...] .It Ar cv [assocID] [variable_name [ = value [...] ] [...]
Requests that a list of the server's clock variables be sent. Servers which Requests that a list of the server's clock variables be sent. Servers which
have a radio clock or other external synchronization will respond positively have a radio clock or other external synchronization will respond positively
to this. If the association identifier is omitted or zero the request is to this. If the association identifier is omitted or zero the request is
@ -243,7 +239,7 @@ clocks as pseudo-peers, and hence can possibly have more than one clock
connected at once, referencing the appropriate peer association ID will connected at once, referencing the appropriate peer association ID will
show the variables of a particular clock. Omitting the variable list will show the variables of a particular clock. Omitting the variable list will
cause the server to return a default variable display. cause the server to return a default variable display.
.It Fl Ar lassocations .It Ar lassocations
Obtains and prints a list of association identifiers and peer statuses Obtains and prints a list of association identifiers and peer statuses
for all associations for which the server is maintaining state. This command for all associations for which the server is maintaining state. This command
differs from the differs from the
@ -255,20 +251,17 @@ associations are normally omitted from the display when the
command is used, but are included in the output of command is used, but are included in the output of
.Pa "lassociations" .Pa "lassociations"
. .
.It Fl Ar lpassociations .It Ar lpassociations
Print data for all associations, including out-of-spec client associations, Print data for all associations, including out-of-spec client associations,
from the internally cached list of associations. This command differs from from the internally cached list of associations. This command differs from
.Pa "passociations" .Pa "passociations"
only when dealing with fuzzballs. only when dealing with fuzzballs.
.It Fl Ar lpeers .It Ar lpeers
Like R peers, except a summary of all associations for which the server Like R peers, except a summary of all associations for which the server
is maintaining state is printed. This can produce a much longer list of is maintaining state is printed. This can produce a much longer list of
peers from fuzzball servers. peers from fuzzball servers.
.It Fl Ar mreadlist assocID assocID .It Ar mreadlist assocID assocID
<BR><TT>mrl .It Ar mrl assocID assocID
.Ar assocID
.Ar assocID
</TT>
Like the Like the
.Pa readlist .Pa readlist
command, except the query is done for each of command, except the query is done for each of
@ -276,15 +269,8 @@ a range of (nonzero) association IDs. This range is determined from the
association list cached by the most recent association list cached by the most recent
.Pa associations .Pa associations
command. command.
.It Fl Ar mreadvar assocID assocID [ variable_name [ = value [ ... ] .It Ar mreadvar assocID assocID [ variable_name [ = value [ ... ]
<BR><TT>mrv .It Ar mrv assocID assocID [ variable_name [ = [ ... ]
.Ar assocID
.Ar assocID
[
.Ar variable_name
[ =
.Ar value
[ ... ]</TT>
Like the Like the
.Pa readvar .Pa readvar
command, except the query is done for each of command, except the query is done for each of
@ -292,18 +278,18 @@ a range of (nonzero) association IDs. This range is determined from the
association list cached by the most recent association list cached by the most recent
.Pa associations .Pa associations
command. command.
.It Fl Ar opeers .It Ar opeers
An old form of the An old form of the
.Pa peers .Pa peers
command with the reference ID replaced command with the reference ID replaced
by the local interface address. by the local interface address.
.It Fl Ar passociations .It Ar passociations
Prints association data concerning in-spec peers from the internally cached Prints association data concerning in-spec peers from the internally cached
list of associations. This command performs identically to the list of associations. This command performs identically to the
.Pa "associations" .Pa "associations"
except that it displays the internally stored data rather than making a except that it displays the internally stored data rather than making a
new query. new query.
.It Fl Ar peers .It Ar peers
Obtains a current list peers of the server, along with a summary of each Obtains a current list peers of the server, along with a summary of each
peer's state. Summary information includes the address of the remote peer, peer's state. Summary information includes the address of the remote peer,
the reference ID (0.0.0.0 if this is unknown), the stratum of the remote the reference ID (0.0.0.0 if this is unknown), the stratum of the remote
@ -317,47 +303,33 @@ used in the
.Pa rv .Pa rv
command, and a short explanation of the condition command, and a short explanation of the condition
revealed. revealed.
.Pa space reject
.Bl -tag -width indent .Bl -tag -width indent
.It space reject
The peer is discarded as unreachable, synchronized to this server (synch The peer is discarded as unreachable, synchronized to this server (synch
loop) or outrageous synchronization distance. loop) or outrageous synchronization distance.
.El .It x falsetick
.Pa x falsetick
.Bl -tag -width indent
The peer is discarded by the intersection algorithm as a falseticker. The peer is discarded by the intersection algorithm as a falseticker.
.El .It . excess
.Pa . excess
.Bl -tag -width indent
The peer is discarded as not among the first ten peers sorted by synchronization The peer is discarded as not among the first ten peers sorted by synchronization
distance and so is probably a poor candidate for further consideration. distance and so is probably a poor candidate for further consideration.
.El .It - outlyer
.Fl outlyer
.Bl -tag -width indent
The peer is discarded by the clustering algorithm as an outlyer. The peer is discarded by the clustering algorithm as an outlyer.
.El .It + candidat
.Pa + candidat
.Bl -tag -width indent
The peer is a survivor and a candidate for the combining algorithm. The peer is a survivor and a candidate for the combining algorithm.
.El .It # selected
.Pa # selected
.Bl -tag -width indent
The peer is a survivor, but not among the first six peers sorted by synchronization The peer is a survivor, but not among the first six peers sorted by synchronization
distance. If the assocation is ephemeral, it may be demobilized to conserve distance. If the assocation is ephemeral, it may be demobilized to conserve
resources. resources.
.El .It * sys.peer
.Pa * sys.peer
.Bl -tag -width indent
The peer has been declared the system peer and lends its variables to the The peer has been declared the system peer and lends its variables to the
system variables. system variables.
.El .It o pps.peer
.Pa
.Pa o pps.peer
.Bl -tag -width indent
The peer has been declared the system peer and lends its variables to the The peer has been declared the system peer and lends its variables to the
system variables. However, the actual system synchronization is derived system variables. However, the actual system synchronization is derived
from a pulse-per-second (PPS) signal, either indirectly via the PPS reference from a pulse-per-second (PPS) signal, either indirectly via the PPS reference
clock driver or directly via kernel interface. clock driver or directly via kernel interface.
.El .El
.Pp
The The
.Pa flash .Pa flash
variable is not defined in the NTP specification, but variable is not defined in the NTP specification, but
@ -365,8 +337,8 @@ is included as a valuable debugging aid. It displays the results of the
packet sanity checks defined in the NTP specification packet sanity checks defined in the NTP specification
.Pa TEST1 .Pa TEST1
through through
.Pa TEST9 .Pa TEST9 .
. The bits for each test read in increasing sequency from The bits for each test read in increasing sequency from
the least significant bit and are defined as follows. the least significant bit and are defined as follows.
The following The following
.Pa TEST1 .Pa TEST1
@ -376,28 +348,19 @@ enumerate procedure
errors. The packet timestamps may or may not be believed, but the remaining errors. The packet timestamps may or may not be believed, but the remaining
header data are ignored. header data are ignored.
.Bl -tag -width indent .Bl -tag -width indent
.El .It TEST1
.Pa TEST1
.Bl -tag -width indent
Duplicate packet. A copy from somewhere. Duplicate packet. A copy from somewhere.
.El .It TEST2
.Bl -tag -width indent
.El
.Pa TEST2
.Bl -tag -width indent
Bogus packet. It is not a reply to a message previously sent. This can Bogus packet. It is not a reply to a message previously sent. This can
happen when the NTP daemon is restarted and before a peer notices. happen when the NTP daemon is restarted and before a peer notices.
.El .It TEST3
.Pa TEST3
.Bl -tag -width indent
Unsynchronized. One or more timestamp fields are missing. This normally Unsynchronized. One or more timestamp fields are missing. This normally
happens when the first packet from a peer is received. happens when the first packet from a peer is received.
.El .It TEST4
.Pa TEST4
.Bl -tag -width indent
Either peer delay or peer dispersion is greater than one second. Ya gotta Either peer delay or peer dispersion is greater than one second. Ya gotta
be kidding. be kidding.
.El .El
.Pp
The following The following
.Pa TEST5 .Pa TEST5
through through
@ -405,79 +368,55 @@ through
ennumerate errors ennumerate errors
in the packet header. The packet is discarded without inspecting its contents. in the packet header. The packet is discarded without inspecting its contents.
.Bl -tag -width indent .Bl -tag -width indent
.El .It TEST5
.Pa TEST5 Cryptographic authentication fails. See the
.Bl -tag -width indent
Cryptographic authentication fails. See the For
.%T "Authentication Options" , .%T "Authentication Options" ,
refer to refer to
.Pa /usr/share/doc/ntp/authopt.htm . .Pa /usr/share/doc/ntp/authopt.htm
.Pp
page. page.
.El .It TEST6
.Pa TEST6
.Bl -tag -width indent
Peer is unsynchronized. Wind up its clock first. Peer is unsynchronized. Wind up its clock first.
.El .It TEST7
.Pa TEST7
.Bl -tag -width indent
Peer stratum is greater than 15. The peer is probably unsynchronized. Peer stratum is greater than 15. The peer is probably unsynchronized.
.El .It TEST8
.Pa TEST8
.Bl -tag -width indent
Either root delay or root dispersion is greater than one second. Too far Either root delay or root dispersion is greater than one second. Too far
from home. from home.
.El .It TEST9
.Bl -tag -width indent
.El
.Pa TEST9
.Bl -tag -width indent
Peer cryptographic authentication fails. Either the key identifier or key Peer cryptographic authentication fails. Either the key identifier or key
is wrong or somebody trashed our packet. is wrong or somebody trashed our packet.
.El .It TEST10
.Pa TEST10 Access is denied. See the
.Bl -tag -width indent
Access is denied. See the For
.%T "Access Control Options" , .%T "Access Control Options" ,
refer to refer to
.Pa /usr/share/doc/ntp/accopt.htm . .Pa /usr/share/doc/ntp/accopt.htm
.Pp
page. page.
.El .El
.It Fl Ar pstatus assocID .Pp
.It Ar pstatus assocID
Sends a read status request to the server for the given association. The Sends a read status request to the server for the given association. The
names and values of the peer variables returned will be printed. Note that 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 the status word from the header is displayed preceding the variables, both
in hexidecimal and in pidgeon English. in hexidecimal and in pidgeon English.
.It Fl Ar readlist [ assocID ] .It Ar readlist [ assocID ]
<BR><TT>rl [ .It rl [ assocID ]
.Ar assocID
]</TT>
Requests that the values of the variables in the internal variable list Requests that the values of the variables in the internal variable list
be returned by the server. If the association ID is omitted or is 0 the be returned by the server. If the association ID is omitted or is 0 the
variables are assumed to be system variables. Otherwise they are treated variables are assumed to be system variables. Otherwise they are treated
as peer variables. If the internal variable list is empty a request is as peer variables. If the internal variable list is empty a request is
sent without data, which should induce the remote server to return a default sent without data, which should induce the remote server to return a default
display. display.
.It Fl Ar readvar assocID variable_name [ = value ] [ ... ] .It Ar readvar assocID variable_name [ = value ] [ ... ]
<BR><TT>rv .It Ar rv assocID variable_name [ = value ] [ ... ]
.Ar assocID
[
.Ar variable_name
[ =
.Ar value
] [ ...
]</TT>
Requests that the values of the specified variables be returned by the Requests that the values of the specified variables be returned by the
server by sending a read variables request. If the association ID is omitted server by sending a read variables request. If the association ID is omitted
or is given as zero the variables are system variables, otherwise they or is given as zero the variables are system variables, otherwise they
are peer variables and the values returned will be those of the corresponding are peer variables and the values returned will be those of the corresponding
peer. Omitting the variable list will send a request with no data which peer. Omitting the variable list will send a request with no data which
should induce the server to return a default display. should induce the server to return a default display.
.It Fl Ar writevar assocID variable_name [ = value [ ... ] .It Ar writevar assocID variable_name [ = value [ ... ]
Like the readvar request, except the specified variables are written instead Like the readvar request, except the specified variables are written instead
of read. of read.
.It Fl Ar writelist [ assocID ] .It Ar writelist [ assocID ]
Like the readlist request, except the internal list variables are written Like the readlist request, except the internal list variables are written
instead of read. instead of read.
.El .El

4
usr.sbin/ntp/ntptime/ntptime.8
View File

@ -1,4 +1,4 @@
.\" $NetBSD: ntptime.8,v 1.1 2000/03/29 13:54:45 simonb Exp $ .\" $NetBSD: ntptime.8,v 1.2 2000/03/30 01:49:24 simonb Exp $
.\" Converted from HTML to mandoc by html-to-mdoc.pl .\" Converted from HTML to mandoc by html-to-mdoc.pl
.\" .\"
.Dd Mar 29, 2000 .Dd Mar 29, 2000
@ -26,7 +26,7 @@ time-related kernel variables using the
.Pa ntp_gettime() .Pa ntp_gettime()
system call. system call.
A similar display can be obtained using the A similar display can be obtained using the
.Pa ntpdc .Nm ntpdc
program and program and
.Pa kerninfo .Pa kerninfo
command. command.

15
usr.sbin/ntp/ntptrace/ntptrace.8
View File

@ -1,4 +1,4 @@
.\" $NetBSD: ntptrace.8,v 1.1 2000/03/29 13:54:46 simonb Exp $ .\" $NetBSD: ntptrace.8,v 1.2 2000/03/30 01:49:25 simonb Exp $
.\" Converted from HTML to mandoc by html-to-mdoc.pl .\" Converted from HTML to mandoc by html-to-mdoc.pl
.\" .\"
.Dd Mar 29, 2000 .Dd Mar 29, 2000
@ -18,27 +18,24 @@
determines where a given Network Time Protocol (NTP) determines where a given Network Time Protocol (NTP)
server gets its time from, and follows the chain of NTP servers back to 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 their master time source. If given no arguments, it starts with
.Pa localhost .Pa localhost .
.
Here is an example of the output from Here is an example of the output from
.Nm .Nm "" :
:
.Pp .Pp
.nf .nf
% ntptrace % ntptrace
localhost: stratum 4, offset 0.0019529, synch distance 0.144135 localhost: stratum 4, offset 0.0019529, synch distance 0.144135
server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784
usndh.edu: stratum 1, offset 0.0019298, synch distance 0.011993, refid usndh.edu: stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
'WWVB'
.fi .fi
.Pp .Pp
On each line, the fields are (left to right): the host name, the host stratum, On each line, the fields are (left to right): the host name, the host stratum,
the time offset between that host and the local host (as measured by the time offset between that host and the local host (as measured by
.Nm .Nm
; ;
this is why it is not always zero for " this is why it is not always zero for
.Pa localhost .Pa localhost
"), the host synchronization ), the host synchronization
distance, and (only for stratum-1 servers) the reference clock ID. All distance, and (only for stratum-1 servers) the reference clock ID. All
times are given in seconds. Note that the stratum is the server hop count times are given in seconds. Note that the stratum is the server hop count
to the primary source, while the synchronization distance is the estimated to the primary source, while the synchronization distance is the estimated