~ubuntu-branches/debian/squeeze/ntp/squeeze-201010051545

« back to all changes in this revision

Viewing changes to debian/man/ntpd.8

  • Committer: Bazaar Package Importer
  • Author(s): Kurt Roeckx
  • Date: 2009-01-05 21:10:03 UTC
  • mfrom: (1.2.4 upstream)
  • Revision ID: james.westby@ubuntu.com-20090105211003-mh6zc3um4k1uhsj7
Tags: 1:4.2.4p4+dfsg-8
It did not properly check the return value of EVP_VerifyFinal
which results in an malformed DSA signature being treated as
a good signature rather than as an error.  (CVE-2009-0021)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH NTPD 8 "2007-12-07" "Debian" "The Network Time Protocol (NTP) Distribution"
 
2
.SH NAME
 
3
ntpd \- Network Time Protocol (NTP) daemon
 
4
.SH SYNOPSIS
 
5
.B ntpd
 
6
[ -46aAbgLmnNqx ]
 
7
[ -c \fIconffile\fR ]
 
8
[ -f \fIdriftfile\fR ]
 
9
[ -i \fIjaildir\fR ]
 
10
[ -k \fIkeyfile\fR ]
 
11
[ -l \fIlogfile\fR ]
 
12
[ -p \fIpidfile\fR ]
 
13
[ -P \fIpriority\fR ]
 
14
[ -r \fIbroadcastdelay\fR ]
 
15
[ -s \fIstatsdir\fR ]
 
16
[ -t \fIkey\fR ]
 
17
[ -u \fIuser\fR[:\fIgroup\fR] ]
 
18
[ -U \fIinterface_update_interval\fR ]
 
19
[ -v \fIvariable\fR ]
 
20
[ -V \fIvariable\fR ]
 
21
.SH DESCRIPTION
 
22
The \fBntpd\fR program is an operating system daemon which sets and maintains the system time of day in synchronism with Internet standard time servers.
 
23
It is a complete implementation of the 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.
 
24
\fBntpd\fR 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.
 
25
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.
 
26
.PP
 
27
The daemon can operate in any of several modes, including symmetric
 
28
active/passive, client/server broadcast/multicast and manycast.  A
 
29
broadcast/multicast or manycast client can discover remote servers,
 
30
compute server-client propagation delay correction factors and configure
 
31
itself automatically.  This makes it possible to deploy a fleet of
 
32
workstations without specifying configuration details specific to the
 
33
local environment.
 
34
.PP
 
35
Ordinarily, \fBntpd\fR reads the \fIntp.conf\fR configuration file at startup time
 
36
in order to determine the synchronization sources and operating modes.
 
37
It is also possible to specify a working, although limited
 
38
configuration entirely on the command line, obviating the need for a
 
39
configuration file.  This may be particularly appropriate when the
 
40
local host is to be configured as a broadcast/multicast client or manycast
 
41
client, with all peers being determined by listening to broadcasts at
 
42
run time.
 
43
.PP
 
44
Various internal
 
45
.B ntpd
 
46
variables can be displayed and configuration
 
47
options altered while the daemon is running using the
 
48
.B ntpq
 
49
and
 
50
.B ntpd
 
51
utility programs.
 
52
.PP
 
53
When
 
54
.B ntpd
 
55
starts it looks at the value of umask, and if it is zero
 
56
.B ntpd
 
57
will set the umask to 0222.
 
58
.SH OPTIONS
 
59
.TP
 
60
.B -a
 
61
Require cryptographic authentication for broadcast client, multicast client and symmetric passive associations.
 
62
This is the default.
 
63
.TP
 
64
.B -A
 
65
Do not require cryptographic authentication for broadcast client, multicast client and symmetric passive associations.
 
66
This is almost never a good idea.
 
67
.TP
 
68
.B -b
 
69
Enable the client to synchronize to broadcast servers.
 
70
.TP
 
71
\fB-c\fR \fIconffile\fR
 
72
Specify the name and path of the configuration file, default \fI/etc/ntp.conf\fR.
 
73
.TP
 
74
\fB-f\fR \fIdriftfile\fR
 
75
Specify the name and path of the frequency file, default \fI/etc/ntp.drift\fR.
 
76
This is the same operation as the driftfile \fIdriftfile\fR configuration command.
 
77
.TP
 
78
.B -g
 
79
Normally, \fBntpd\fR exits with a message to the system log if the offset exceeds the panic threshold, which is 1000 s by default.
 
80
This option allows the time to be set to any value without restriction; however, this can happen only once.
 
81
If the threshold is exceeded after that, \fBntpd\fR will exit with a message to the system log.
 
82
This option can be used with the \fB-q\fR and \fB-x\fR options.
 
83
.TP
 
84
\fB-i\fR \fIjaildir\fR
 
85
Chroot the server to the directory \fIjaildir\fR.
 
86
This option also implies that the server attempts to drop root privileges at startup (otherwise, chroot gives very little additional security).
 
87
You may need to also specify a \fB-u\fR option.
 
88
.TP
 
89
\fB-k\fR \fIkeyfile\fR
 
90
Specify the name and path of the symmetric key file, default \fI/etc/ntp.keys\fR.
 
91
This is the same operation as the keys \fIkeyfile\fR configuration command.
 
92
.TP
 
93
\fB-l\fR \fIlogfile\fR
 
94
Specify the name and path of the log file.
 
95
The default is the system log file.
 
96
This is the same operation as the logfile \fIlogfile\fR configuration command.
 
97
.TP
 
98
.B -L
 
99
Do not listen to virtual IPs.
 
100
The default is to listen.
 
101
.TP
 
102
.B -n
 
103
Don't fork.
 
104
.TP
 
105
.B -N
 
106
To the extent permitted by the operating system, run the \fBntpd\fR at the highest priority.
 
107
.TP
 
108
\fB-p\fR \fIpidfile\fR
 
109
Specify the name and path of the file used to record the \fBntpd\fR process ID.
 
110
This is the same operation as the pidfile \fIpidfile\fR configuration command.
 
111
.TP
 
112
\fB-P\fR \fIpriority\fR
 
113
To the extent permitted by the operating system, run the \fBntpd\fR at the specified priority.
 
114
.TP
 
115
.B -q
 
116
Exit the \fBntpd\fR just after the first time the clock is set.
 
117
This behavior mimics that of the \fBntpdate\fR program, which is to be retired.
 
118
The \fB-g\fR and \fB-x\fR options can be used with this option.
 
119
Note: The kernel time discipline is disabled with this option.
 
120
.TP
 
121
\fB-r\fR \fIbroadcastdelay\fR
 
122
Specify the default propagation delay from the broadcast/multicast server to this client.
 
123
This is necessary only if the delay cannot be computed automatically by the protocol.
 
124
.TP
 
125
\fB-s\fR \fIstatsdir\fR
 
126
Specify the directory path for files created by the statistics facility.
 
127
This is the same operation as the statsdir \fIstatsdir\fR configuration command.
 
128
.TP
 
129
\fB-t\fR \fIkey\fR
 
130
Add a key number to the trusted key list.
 
131
This option can occur more than once.
 
132
.TP
 
133
\fB-u\fR \fIuser\fR[:\fIgroup\fR]
 
134
Specify a user, and optionally a group, to switch to.
 
135
.TP
 
136
\fB-U\fR \fIinterface_update_interval\fR
 
137
Number of seconds to wait between interface list scans to pick up new and delete network interface.
 
138
Set to 0 to disable dynamic interface list updating.
 
139
The default is to scan every 5 minutes.
 
140
.TP
 
141
\fB-v\fR \fIvariable\fR, \fB-V\fR \fIvariable\fR
 
142
Add a system variable listed by default.
 
143
.TP
 
144
.B -x
 
145
Normally, the time is slewed if the offset is less than the step threshold, which is 128 ms by default, and stepped if above the threshold.
 
146
This option sets the threshold to 600 s, which is well within the accuracy window to set the clock manually.
 
147
Note: Since the slew rate of typical Unix kernels is limited to 0.5 ms/s, each second of adjustment requires an amortization interval of 2000 s.
 
148
Thus, an adjustment as much as 600 s will take almost 14 days to complete.
 
149
This option can be used with the \fB-g\fR and \fB-q\fR options.
 
150
Note: The kernel time discipline is disabled with this option.
 
151
.SH FILES
 
152
.TP
 
153
.I /etc/ntp.conf
 
154
default name of the configuration file
 
155
.TP
 
156
.I /etc/ntp.drift
 
157
default name of the drift file
 
158
.SH SEE ALSO
 
159
.BR ntp.conf (5),
 
160
.BR ntpdate (8)
 
161
.PP
 
162
The complete documentation can be found at \fI/usr/share/doc/ntp\-doc/html/ntpd.html\fR in the package ntp\-doc.