.TH ntpdate 8
.SH NAME
ntpdate - set the date and time via NTP
.SH \ 

Disclaimer: The functionality of this program is now available in the \fBntpd\fR program. See the \fB-q\fR command line option in the \fBntpd\fR - Network Time Protocol (NTP) daemon page. After a suitable period of mourning, the \fBntpdate\fR program is to be retired from this distribution

.SH SYNOPSIS
\fBntpdate [ -46bBdqsuv ] [ -a \fIkey\fB ] [ -e \fIauthdelay\fB ] [ -k \fIkeyfile\fB ] [ -o \fIversion\fB ] [ -p \fIsamples\fB ] [ -t \fItimeout\fB ] [ -U \fIuser_name\fB ] \fIserver\fB [ ... ]\fR

.SH DESCRIPTION

\fBntpdate\fR sets the local date and time by polling the Network Time Protocol (NTP) server(s) given as the \fIserver\fR arguments to determine the correct time. It must be run as root on the local host. A number of samples are obtained from each of the 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 \fBntpdate\fR depends on the number of servers, the number of polls each time it is run and the interval between runs.

\fBntpdate\fR 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 \fBntpd\fR\[char46] It is also possible to run \fBntpdate\fR from a \fBcron\fR script. However, it is important to note that \fBntpdate\fR with contrived \fBcron\fR scripts is no substitute for the NTP daemon, which uses sophisticated algorithms to maximize accuracy and reliability while minimizing resource use. Finally, since \fBntpdate\fR does not discipline the host clock frequency as does \fBntpd\fR, the accuracy using \fBntpdate\fR is limited.

Time adjustments are made by \fBntpdate\fR in one of two ways. If \fBntpdate\fR determines the clock is in error more than 0.5 second it will simply step the time by calling the system \fBsettimeofday()\fR routine. If the error is less than 0.5 seconds, it will slew the time by calling the system \fBadjtime()\fR routine. The latter technique is less disruptive and more accurate when the error is small, and works quite well when \fBntpdate\fR is run by \fBcron\fR every hour or two.

\fBntpdate\fR will decline to set the date if an NTP server daemon (e.g., \fBntpd\fR) is running on the same host. When running \fBntpdate\fR on a regular basis from \fBcron\fR as an alternative to running a daemon, doing so once every hour or two will result in precise enough timekeeping to avoid stepping the clock.

Note that in contexts where a host name is expected, a \fB-4\fR qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a \fB-6\fR qualifier forces DNS resolution to the IPv6 namespace.

If NetInfo support is compiled into \fBntpdate\fR, then the \fBserver\fR argument is optional if \fBntpdate\fR can find a time server in the NetInfo configuration for \fBntpd\fR\[char46]

.SH COMMAND LINE OPTIONS

.RS 0
.TP 8
\fB-4\fR
Force DNS resolution of following host names on the command line to the IPv4 namespace. 
.TP 8
\fB-6\fR
Force DNS resolution of following host names on the command line to the IPv6 namespace. 
.TP 8
\fB-a \fIkey\fB\fR
Enable the authentication function and specify the key identifier to be used for authentication as the argument \fIkey\fR\[char46] The keys and key identifiers must match in both the client and server key files. The default is to disable the authentication function. 
.TP 8
\fB-B\fR
Force the time to always be slewed using the adjtime() system call, even if the measured offset is greater than +-500 ms. The default is to step the time using settimeofday() if the offset is greater than +-500 ms. Note that, if the offset is much greater than +-500 ms in this case, that it can take a long time (hours) to slew the clock to the correct value. During this time. the host should not be used to synchronize clients. 
.TP 8
\fB-b\fR
Force the time to be stepped using the settimeofday() system call, rather than slewed (default) using the adjtime() system call. This option should be used when called from a startup file at boot time. 
.TP 8
\fB-d\fR
Enable the debugging mode, in which \fBntpdate\fR will go through all the steps, but not adjust the local clock. Information useful for general debugging will also be printed. 
.TP 8
\fB-e \fIauthdelay\fB\fR
Specify the processing delay to perform an authentication function as the value \fIauthdelay\fR, in seconds and fraction (see \fBntpd\fR for details). This number is usually small enough to be negligible for most purposes, though specifying a value may improve timekeeping on very slow CPU's. 
.TP 8
\fB-k \fIkeyfile\fB\fR
Specify the path for the authentication key file as the string \fIkeyfile\fR\[char46] The default is \fB/etc/ntp/keys\fR\[char46] This file should be in the format described in \fBntpd\fR\[char46] 
.TP 8
\fB-o \fIversion\fB\fR
Specify the NTP version for outgoing packets as the integer \fIversion\fR, which can be 1 or 2. The default is 3. This allows \fBntpdate\fR to be used with older NTP versions. 
.TP 8
\fB-p \fIsamples\fB\fR
Specify the number of samples to be acquired from each server as the integer \fIsamples\fR, with values from 1 to 8 inclusive. The default is 4. 
.TP 8
\fI\fB-q\fI\fR
Query only - don't set the clock. 
.TP 8
\fB-s\fR
Divert logging output from the standard output (default) to the system \fBsyslog\fR facility. This is designed primarily for convenience of \fBcron\fR scripts. 
.TP 8
\fB-t \fItimeout\fB\fR
Specify the maximum time waiting for a server response as the value \fItimeout\fR, in seconds and fraction. The value is is rounded to a multiple of 0.2 seconds. The default is 1 second, a value suitable for polling across a LAN. 
.TP 8
\fB-u\fR
Direct \fBntpdate\fR 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 synchronize with hosts beyond the firewall. Note that the \fB-d\fR option always uses unprivileged ports. 
.TP 8
\fB-\fIv\fB\fR
Be verbose. This option will cause \fBntpdate\fR's version identification string to be logged. 
.TP 8
\fB-U \fIuser_name\fB\fR
ntpdate process drops root privileges and changes user ID to \fIuser_name\fR and group ID to the primary group of \fIserver_user\fR\[char46] 
.RE

.SH DIAGNOSTICS
\fBntpdate\fR's exit status is zero if it finds a server and updates the clock, and nonzero otherwise. 

.SH FILES
\fB/etc/ntp/keys\fR - encryption keys used by \fBntpdate\fR\[char46] 

.SH BUGS
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 is probably not a good idea and may cause a troubling hunt for some values of the kernel variables \fBtick\fR and \fBtickadj\fR\[char46]   
.SH SEE ALSO

ntpd(8)

Primary source of documentation: /usr/share/doc/ntp-*

This file was automatically generated from HTML source.