Import OpenNTPD 3.6 (the OpenBSD version, not the portable).
[dragonfly.git] / contrib / ntpd / ntpd.conf.5
1 .\" $OpenBSD: ntpd.conf.5,v 1.7 2004/07/13 19:51:38 jmc Exp $
2 .\"
3 .\" Copyright (c) 2003, 2004 Henning Brauer <henning@openbsd.org>
4 .\"
5 .\" Permission to use, copy, modify, and distribute this software for any
6 .\" purpose with or without fee is hereby granted, provided that the above
7 .\" copyright notice and this permission notice appear in all copies.
8 .\"
9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13 .\" WHATSOEVER RESULTING FROM LOSS OF MIND, USE, DATA OR PROFITS, WHETHER IN
14 .\" AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
15 .\" OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16 .\"
17 .Dd June 17, 2004
18 .Dt NTPD.CONF 5
19 .Os
20 .Sh NAME
21 .Nm ntpd.conf
22 .Nd Network Time Protocol daemon configuration file
23 .Sh DESCRIPTION
24 This manual page describes the format of the
25 .Xr ntpd 8
26 configuration file.
27 It has the following format:
28 .Pp
29 Empty lines and lines beginning with the
30 .Sq #
31 character are ignored.
32 .Pp
33 The possible keywords are as follows:
34 .Bl -tag -width Ds
35 .It Ic listen on Ar address
36 Specify a local IP address or a hostname the
37 .Xr ntpd 8
38 daemon should listen on.
39 It can appear multiple times:
40 .Xr ntpd 8
41 will listen on each given address.
42 If
43 .Sq *
44 is given as an address,
45 .Xr ntpd 8
46 will listen on all local addresses.
47 .Xr ntpd 8
48 does not listen on any address by default.
49 For example:
50 .Bd -literal -offset indent
51 listen on *
52 listen on 127.0.0.1
53 listen on ::1
54 .Ed
55 .It Ic server Ar address
56 Specify the IP address or the hostname of an NTP
57 server to synchronize to.
58 If the hostname resolves to multiple IPv4 and/or IPv6 addresses,
59 .Xr ntpd 8
60 uses the first address.
61 If it does not get a reply,
62 .Xr ntpd 8
63 retries with the next address and continues to do so until a working address
64 is found.
65 For example:
66 .Bd -literal -offset indent
67 server 10.0.0.2
68 server ntp.example.org
69 .Ed
70 .It Ic servers Ar address
71 As with
72 .Cm server ,
73 specify the IP address or hostname of an NTP server to synchronize to.
74 Should the hostname resolve to multiple IP addresses,
75 .Xr ntpd 8
76 will try to synchronize to all of them.
77 For example:
78 .Bd -literal -offset indent
79 servers pool.ntp.org
80 .Ed
81 .El
82 .Sh FILES
83 .Bl -tag -width "/etc/ntpd.confXXX" -compact
84 .It Pa /etc/ntpd.conf
85 default
86 .Xr ntpd 8
87 configuration file
88 .El
89 .Sh SEE ALSO
90 .Xr ntpd 8
91 .Sh HISTORY
92 The
93 .Nm
94 file format first appeared in
95 .Ox 3.6 .