Merge from vendor branch NTPD:
[dragonfly.git] / contrib / ntpd / ntpd.8
1 .\" $OpenBSD: ntpd.8,v 1.5 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 July 9, 2004
18 .Dt NTPD 8
19 .Os
20 .Sh NAME
21 .Nm ntpd
22 .Nd "Network Time Protocol daemon"
23 .Sh SYNOPSIS
24 .Nm ntpd
25 .Bk -words
26 .Op Fl d
27 .Op Fl f Ar file
28 .Ek
29 .Sh DESCRIPTION
30 The
31 .Nm
32 daemon synchronizes the local clock to one or more remote NTP servers,
33 and can also act as an NTP server itself,
34 redistributing the local time.
35 It implements the Simple Network Time Protocol version 4,
36 as described in RFC 2030,
37 and the Network Time Protocol version 3,
38 as described in RFC 1305.
39 .Pp
40 .Nm
41 is usually started at boot time, and can be enabled by
42 setting the following in
43 .Pa /etc/rc.conf.local :
44 .Pp
45 .Dl ntpd_flags=\&"\&"
46 .Pp
47 See
48 .Xr rc 8
49 and
50 .Xr rc.conf 8
51 for more information on the boot process
52 and enabling daemons.
53 .Pp
54 When
55 .Nm
56 starts up, it reads settings from a configuration file,
57 typically
58 .Xr ntpd.conf 5 .
59 .Pp
60 The options are as follows:
61 .Bl -tag -width "-f fileXXX"
62 .It Fl d
63 Do not daemonize.
64 If this option is specified,
65 .Nm
66 will run in the foreground and log to
67 .Em stderr .
68 .It Fl f Ar file
69 Use
70 .Ar file
71 as the configuration file,
72 instead of the default
73 .Pa /etc/ntpd.conf .
74 .El
75 .Sh FILES
76 .Bl -tag -width "/etc/ntpd.confXXX" -compact
77 .It Pa /etc/ntpd.conf
78 default
79 .Nm
80 configuration file
81 .El
82 .Sh SEE ALSO
83 .Xr date 1 ,
84 .Xr ntpd.conf 5 ,
85 .Xr rdate 8 ,
86 .Xr timed 8
87 .Rs
88 .%R RFC 1305
89 .%T "Network Time Protocol (Version 3)"
90 .%D March 1992
91 .Re
92 .Rs
93 .%R RFC 2030
94 .%T "Simple Network Time Protocol (SNTP) Version 4"
95 .%D October 1996
96 .Re
97 .Sh HISTORY
98 The
99 .Nm
100 program first appeared in
101 .Ox 3.6 .