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