xref: /freebsd/contrib/ntp/scripts/ntp-wait/ntp-wait.texi (revision 911f0260390e18cf85f3dbf2c719b593efdc1e3c)
1\input texinfo    @c -*-texinfo-*-
2@c %**start of header
3@setfilename ntp-wait.info
4@settitle Ntp-wait User's Manual
5@include ../../sntp/include/version.texi
6@paragraphindent 2
7@c %**end of header
8
9@ifinfo
10This file documents the use of @code{ntp-wait},
11a program from
12the NTP Project,
13that is used to wait until @code{ntpd} has been able to
14synchronize and stabilize the time on the current host.
15@end ifinfo
16
17@direntry
18* ntp-wait: (ntp-wait).                 Wait for ntpd to synchronize and stabilize the system clock.
19@end direntry
20
21@titlepage
22@title ntp-wait User's Manual
23@subtitle ntp-wait, version @value{VERSION}, @value{UPDATED}
24@c @author Max @email{foo@ntp.org}
25@end titlepage
26
27@c @page
28@c @vskip 0pt plus 1filll
29
30@node Top, ntp-wait Description, (dir), (dir)
31
32This document describes the use of the NTP Project's @code{ntp-wait} program.
33
34If there are time-sensitive applications,
35the proper sequence of events is to
36run @code{ntpd -g} as early as possible,
37then invoke all of the non-time-sensitive process,
38run @code{ntp-wait} to block
39until the system's time has stabilized and synchronized,
40and only then start any applicaitons (like database servers) that require
41accurate and stable time.
42
43This document applies to version @value{VERSION} of @code{ntp-wait}.
44
45@shortcontents
46
47@menu
48* ntp-wait Description::            Description
49* ntp-wait Invocation::		Invoking ntp-wait
50@end menu
51
52@include invoke-ntp-wait.texi
53