Dd May 25 2024
Dt NTPD @NTPD_MS@ User Commands
Os
\"  EDIT THIS FILE WITH CAUTION  (ntpd-opts.mdoc)
\"
\"  It has been AutoGen-ed  May 25, 2024 at 12:03:54 AM by AutoGen 5.18.16
\"  From the definitions    ntpd-opts.def
\"  and the template file   agmdoc-cmd.tpl
Sh NAME
Nm ntpd
Nd NTP daemon program
Sh SYNOPSIS
Nm
\" Mixture of short (flag) options and long options
Op Fl flags
Op Fl flag Op Ar value
Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
[ <server1> ... <serverN> ]
Pp
Sh DESCRIPTION
The
Nm
utility is an operating system daemon which sets
and maintains the system time of day in synchronism with Internet
standard time servers.
It is a complete implementation of the
Network Time Protocol (NTP) version 4, as defined by RFC\-5905,
but also retains compatibility with
version 3, as defined by RFC\-1305, and versions 1
and 2, as defined by RFC\-1059 and RFC\-1119, respectively.
Pp
The
Nm
utility does most computations in 64\-bit floating point
arithmetic and does relatively clumsy 64\-bit fixed point operations
only when necessary to preserve the ultimate precision, about 232
picoseconds.
While the ultimate precision is not achievable with
ordinary workstations and networks of today, it may be required
with future gigahertz CPU clocks and gigabit LANs.
Pp
Ordinarily,
Nm
reads the
Xr ntp.conf 5
configuration file at startup time in order to determine the
synchronization sources and operating modes.
It is also possible to
specify a working, although limited, configuration entirely on the
command line, obviating the need for a configuration file.
This may
be particularly useful when the local host is to be configured as a
broadcast/multicast client, with all peers being determined by
listening to broadcasts at run time.
Pp
If NetInfo support is built into
Nm ,
then
Nm
will attempt to read its configuration from the
NetInfo if the default
Xr ntp.conf 5
file cannot be read and no file is
specified by the
Fl c
option.
Pp
Various internal
Nm
variables can be displayed and
configuration options altered while the
Nm
is running
using the
Xr ntpq @NTPQ_MS@
and
Xr ntpdc @NTPDC_MS@
utility programs.
Pp
When
Nm
starts it looks at the value of
Xr umask 2 ,
and if zero
Nm
will set the
Xr umask 2
to 022.
Sh "OPTIONS"
Bl -tag
It  Fl 4 , Fl \-ipv4
Force IPv4 DNS name resolution.
This option must not appear in combination with any of the following options:
ipv6.
sp
Force DNS resolution of following host names on the command line
to the IPv4 namespace.
It  Fl 6 , Fl \-ipv6
Force IPv6 DNS name resolution.
This option must not appear in combination with any of the following options:
ipv4.
sp
Force DNS resolution of following host names on the command line
to the IPv6 namespace.
It  Fl a , Fl \-authreq
Require crypto authentication.
This option must not appear in combination with any of the following options:
authnoreq.
sp
Require cryptographic authentication for broadcast client,
multicast client and symmetric passive associations.
This is the default.
It  Fl A , Fl \-authnoreq
Do not require crypto authentication.
This option must not appear in combination with any of the following options:
authreq.
sp
Do not require cryptographic authentication for broadcast client,
multicast client and symmetric passive associations.
This is almost never a good idea.
It  Fl b , Fl \-bcastsync
Allow us to sync to broadcast servers.
sp
It  Fl c Ar string , Fl \-configfile Ns = Ns Ar string
configuration file name.
sp
The name and path of the configuration file,
\fI/etc/ntp.conf\fP
by default.
It  Fl d , Fl \-debug\-level
Increase debug verbosity level.
This option may appear an unlimited number of times.
sp
It  Fl D Ar number , Fl \-set\-debug\-level Ns = Ns Ar number
Set the debug verbosity level.
This option may appear an unlimited number of times.
This option takes an integer number as its argument.
sp
It  Fl f Ar string , Fl \-driftfile Ns = Ns Ar string
frequency drift file name.
sp
The name and path of the frequency file,
\fI/etc/ntp.drift\fP
by default.
This is the same operation as the
\fBdriftfile\fP \fIdriftfile\fP
configuration specification in the
\fI/etc/ntp.conf\fP
file.
It  Fl g , Fl \-panicgate
Allow the first adjustment to be Big.
This option may appear an unlimited number of times.
sp
Normally,
\fBntpd\fP
exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default. This option allows the time to be set to any value without restriction; however, this can happen only once. If the threshold is exceeded after that,
\fBntpd\fP
will exit with a message to the system log. This option can be used with the
\fB\-q\fP
and
\fB\-x\fP
options.
See the
\fBtinker\fP
configuration file directive for other options.
It  Fl G , Fl \-force\-step\-once
Step any initial offset correction..
sp
Normally,
\fBntpd\fP
steps the time if the time offset exceeds the step threshold,
which is 128 ms by default, and otherwise slews the time.
This option forces the initial offset correction to be stepped,
so the highest time accuracy can be achieved quickly.
However, this may also cause the time to be stepped back
so this option must not be used if
applications requiring monotonic time are running.
See the \fBtinker\fP configuration file directive for other options.
It  Fl i Ar string , Fl \-jaildir Ns = Ns Ar string
Jail directory.
sp
Chroot the server to the directory
\fIjaildir\fP