xref: /freebsd/contrib/ntp/scripts/ntp-wait/ntp-wait.1ntp-waitmdoc (revision 2b15cb3d0922bd70ea592f0da9b4a5b167f4d53f)
1*2b15cb3dSCy Schubert.Dd February 4 2015
2*2b15cb3dSCy Schubert.Dt NTP_WAIT 1ntp-waitmdoc User Commands
3*2b15cb3dSCy Schubert.Os
4*2b15cb3dSCy Schubert.\"  EDIT THIS FILE WITH CAUTION  (ntp-wait-opts.mdoc)
5*2b15cb3dSCy Schubert.\"
6*2b15cb3dSCy Schubert.\"  It has been AutoGen-ed  February  4, 2015 at 02:37:26 AM by AutoGen 5.18.5pre4
7*2b15cb3dSCy Schubert.\"  From the definitions    ntp-wait-opts.def
8*2b15cb3dSCy Schubert.\"  and the template file   agmdoc-cmd.tpl
9*2b15cb3dSCy Schubert.Sh NAME
10*2b15cb3dSCy Schubert.Nm ntp-wait
11*2b15cb3dSCy Schubert.Nd Wait for ntpd to stabilize the system clock
12*2b15cb3dSCy Schubert.Sh SYNOPSIS
13*2b15cb3dSCy Schubert.Nm
14*2b15cb3dSCy Schubert.\" Mixture of short (flag) options and long options
15*2b15cb3dSCy Schubert.Op Fl flags
16*2b15cb3dSCy Schubert.Op Fl flag Op Ar value
17*2b15cb3dSCy Schubert.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
18*2b15cb3dSCy Schubert.Pp
19*2b15cb3dSCy SchubertAll arguments must be options.
20*2b15cb3dSCy Schubert.Pp
21*2b15cb3dSCy Schubert.Sh DESCRIPTION
22*2b15cb3dSCy Schubert.Nm
23*2b15cb3dSCy Schubertwill send at most
24*2b15cb3dSCy Schubert.Ar num\-tries
25*2b15cb3dSCy Schubertqueries to
26*2b15cb3dSCy Schubert.Xr ntpd 8 ,
27*2b15cb3dSCy Schubertsleeping for
28*2b15cb3dSCy Schubert.Ar secs\-between\-tries
29*2b15cb3dSCy Schubertafter each status return that says
30*2b15cb3dSCy Schubert.Xr ntpd 8
31*2b15cb3dSCy Schuberthas not yet produced a synchronized and stable system clock.
32*2b15cb3dSCy Schubert.Pp
33*2b15cb3dSCy Schubert.Nm
34*2b15cb3dSCy Schubertwill do this quietly, unless the
35*2b15cb3dSCy Schubert.Fl v
36*2b15cb3dSCy Schubertflag is provided.
37*2b15cb3dSCy SchubertThis can be useful at boot time, to delay the boot sequence until after
38*2b15cb3dSCy Schubert.Ar ntpd \-g
39*2b15cb3dSCy Schuberthas set the time.
40*2b15cb3dSCy Schubert.Sh "OPTIONS"
41*2b15cb3dSCy Schubert.Bl -tag
42*2b15cb3dSCy Schubert.It  Fl n Ar number , Fl \-tries Ns = Ns Ar number
43*2b15cb3dSCy SchubertNumber of times to check ntpd.
44*2b15cb3dSCy SchubertThis option takes an integer number as its argument.
45*2b15cb3dSCy SchubertThe default
46*2b15cb3dSCy Schubert.Ar number
47*2b15cb3dSCy Schubertfor this option is:
48*2b15cb3dSCy Schubert.ti +4
49*2b15cb3dSCy Schubert 100
50*2b15cb3dSCy Schubert.sp
51*2b15cb3dSCy Schubert        The maximum number of times we will check \fBntpd\fP to see if
52*2b15cb3dSCy Schubert        it has been able to synchronize and stabilize the system clock.
53*2b15cb3dSCy Schubert.It  Fl s Ar secs\-between\-tries , Fl \-sleep Ns = Ns Ar secs\-between\-tries
54*2b15cb3dSCy SchubertHow long to sleep between tries.
55*2b15cb3dSCy SchubertThis option takes an integer number as its argument.
56*2b15cb3dSCy SchubertThe default
57*2b15cb3dSCy Schubert.Ar secs\-between\-tries
58*2b15cb3dSCy Schubertfor this option is:
59*2b15cb3dSCy Schubert.ti +4
60*2b15cb3dSCy Schubert 6
61*2b15cb3dSCy Schubert.sp
62*2b15cb3dSCy Schubert        We will sleep for \fIsecs\-between\-tries\fP after each query
63*2b15cb3dSCy Schubert        of \fBntpd\fP that returns "the time is not yet stable".
64*2b15cb3dSCy Schubert.It  Fl v , Fl \-verbose
65*2b15cb3dSCy SchubertBe verbose.
66*2b15cb3dSCy Schubert.sp
67*2b15cb3dSCy Schubert        By default, \fBntp\-wait\fP is silent.
68*2b15cb3dSCy Schubert        With this option, \fBntp\-wait\fP will provide status information.
69*2b15cb3dSCy Schubert.It Fl \&? , Fl \-help
70*2b15cb3dSCy SchubertDisplay usage information and exit.
71*2b15cb3dSCy Schubert.It Fl \&! , Fl \-more\-help
72*2b15cb3dSCy SchubertPass the extended usage information through a pager.
73*2b15cb3dSCy Schubert.It Fl v Op Brq Ar v|c|n  Fl \-version Op Brq Ar v|c|n
74*2b15cb3dSCy SchubertOutput version of program and exit.  The default mode is `v', a simple
75*2b15cb3dSCy Schubertversion.  The `c' mode will print copyright information and `n' will
76*2b15cb3dSCy Schubertprint the full copyright notice.
77*2b15cb3dSCy Schubert.El
78*2b15cb3dSCy Schubert.Sh "EXIT STATUS"
79*2b15cb3dSCy SchubertOne of the following exit values will be returned:
80*2b15cb3dSCy Schubert.Bl -tag
81*2b15cb3dSCy Schubert.It 0 " (EXIT_SUCCESS)"
82*2b15cb3dSCy SchubertSuccessful program execution.
83*2b15cb3dSCy Schubert.It 1 " (EXIT_FAILURE)"
84*2b15cb3dSCy SchubertThe operation failed or the command syntax was not valid.
85*2b15cb3dSCy Schubert.It 70 " (EX_SOFTWARE)"
86*2b15cb3dSCy Schubertlibopts had an internal operational error.  Please report
87*2b15cb3dSCy Schubertit to autogen\-users@lists.sourceforge.net.  Thank you.
88*2b15cb3dSCy Schubert.El
89*2b15cb3dSCy Schubert.Sh AUTHORS
90*2b15cb3dSCy Schubert.An "Harlan Stenn"
91*2b15cb3dSCy Schubert.Sh NOTES
92*2b15cb3dSCy SchubertThis document corresponds to version @VERSION@ of NTP.
93*2b15cb3dSCy Schubert.Pp
94*2b15cb3dSCy SchubertThis manual page was \fIAutoGen\fP\-erated from the \fBntp\-wait\fP
95*2b15cb3dSCy Schubertoption definitions.
96