xref: /freebsd/contrib/ntp/scripts/ntp-wait/ntp-wait-opts.def (revision 416ba5c74546f32a993436a99516d35008e9f384)
1*2b15cb3dSCy Schubert/* -*- Mode: Text -*- */
2*2b15cb3dSCy SchubertAutoGen Definitions perlopt;
3*2b15cb3dSCy Schubert
4*2b15cb3dSCy Schubert#include autogen-version.def
5*2b15cb3dSCy Schubert
6*2b15cb3dSCy Schubertprog-name	= "ntp-wait";
7*2b15cb3dSCy Schubertprog-title	= "Wait for ntpd to stabilize the system clock";
8*2b15cb3dSCy Schubertpackage		= ntp;
9*2b15cb3dSCy Schubert#include	version.def
10*2b15cb3dSCy Schubert
11*2b15cb3dSCy Schubertlong-opts;
12*2b15cb3dSCy Schubertgnu-usage;
13*2b15cb3dSCy Schubert
14*2b15cb3dSCy Schubertflag = {
15*2b15cb3dSCy Schubert    name        = tries;
16*2b15cb3dSCy Schubert    value       = n;
17*2b15cb3dSCy Schubert    arg-type    = number;
18*2b15cb3dSCy Schubert    arg-default = 100;
19*2b15cb3dSCy Schubert    descrip     = "Number of times to check ntpd";
20*2b15cb3dSCy Schubert    doc         = <<-  _EndOfDoc_
21*2b15cb3dSCy Schubert        The maximum number of times we will check @code{ntpd} to see if
22*2b15cb3dSCy Schubert        it has been able to synchronize and stabilize the system clock.
23*2b15cb3dSCy Schubert	_EndOfDoc_;
24*2b15cb3dSCy Schubert};
25*2b15cb3dSCy Schubert
26*2b15cb3dSCy Schubertflag = {
27*2b15cb3dSCy Schubert    name        = sleep;
28*2b15cb3dSCy Schubert    value       = s;
29*2b15cb3dSCy Schubert    arg-type    = number;
30*2b15cb3dSCy Schubert    arg-name    = "secs-between-tries";
31*2b15cb3dSCy Schubert    arg-default = 6;
32*2b15cb3dSCy Schubert    descrip     = "How long to sleep between tries";
33*2b15cb3dSCy Schubert    doc         = <<-  _EndOfDoc_
34*2b15cb3dSCy Schubert        We will sleep for @file{secs-between-tries} after each query
35*2b15cb3dSCy Schubert        of @code{ntpd} that returns "the time is not yet stable".
36*2b15cb3dSCy Schubert	_EndOfDoc_;
37*2b15cb3dSCy Schubert};
38*2b15cb3dSCy Schubert
39*2b15cb3dSCy Schubertflag = {
40*2b15cb3dSCy Schubert    name    = verbose;
41*2b15cb3dSCy Schubert    value   = v;
42*2b15cb3dSCy Schubert    descrip = "Be verbose";
43*2b15cb3dSCy Schubert    doc     = <<-  _EndOfDoc_
44*2b15cb3dSCy Schubert        By default, @code{ntp-wait} is silent.
45*2b15cb3dSCy Schubert        With this option, @code{ntp-wait} will provide status information.
46*2b15cb3dSCy Schubert	_EndOfDoc_;
47*2b15cb3dSCy Schubert};
48*2b15cb3dSCy Schubert
49*2b15cb3dSCy Schubertexplain = <<- _END_EXPLAIN
50*2b15cb3dSCy Schubert	_END_EXPLAIN;
51*2b15cb3dSCy Schubert
52*2b15cb3dSCy Schubertdoc-section	= {
53*2b15cb3dSCy Schubert  ds-type	= 'DESCRIPTION';
54*2b15cb3dSCy Schubert  ds-format	= 'mdoc';
55*2b15cb3dSCy Schubert  ds-text	= <<- _END_PROG_MDOC_DESCRIP
56*2b15cb3dSCy Schubert.Nm
57*2b15cb3dSCy Schubertwill send at most
58*2b15cb3dSCy Schubert.Ar num-tries
59*2b15cb3dSCy Schubertqueries to
60*2b15cb3dSCy Schubert.Xr ntpd 8 ,
61*2b15cb3dSCy Schubertsleeping for
62*2b15cb3dSCy Schubert.Ar secs-between-tries
63*2b15cb3dSCy Schubertafter each status return that says
64*2b15cb3dSCy Schubert.Xr ntpd 8
65*2b15cb3dSCy Schuberthas not yet produced a synchronized and stable system clock.
66*2b15cb3dSCy Schubert.Pp
67*2b15cb3dSCy Schubert.Nm
68*2b15cb3dSCy Schubertwill do this quietly, unless the
69*2b15cb3dSCy Schubert.Fl v
70*2b15cb3dSCy Schubertflag is provided.
71*2b15cb3dSCy SchubertThis can be useful at boot time, to delay the boot sequence until after
72*2b15cb3dSCy Schubert.Ar ntpd -g
73*2b15cb3dSCy Schuberthas set the time.
74*2b15cb3dSCy Schubert	_END_PROG_MDOC_DESCRIP;
75*2b15cb3dSCy Schubert};
76*2b15cb3dSCy Schubert
77*2b15cb3dSCy Schubert/*
78*2b15cb3dSCy Schubertdoc-section	= {
79*2b15cb3dSCy Schubert  ds-type	= 'USAGE';
80*2b15cb3dSCy Schubert  ds-format	= 'mdoc';
81*2b15cb3dSCy Schubert  ds-text	= <<- _END_MDOC_USAGE
82*2b15cb3dSCy Schubert	_END_MDOC_USAGE;
83*2b15cb3dSCy Schubert};
84*2b15cb3dSCy Schubert*/
85*2b15cb3dSCy Schubert
86*2b15cb3dSCy Schubertdoc-section	= {
87*2b15cb3dSCy Schubert  ds-type	= 'AUTHORS';
88*2b15cb3dSCy Schubert  ds-format	= 'mdoc';
89*2b15cb3dSCy Schubert  ds-text	= <<- _END_MDOC_AUTH
90*2b15cb3dSCy Schubert.An "Harlan Stenn"
91*2b15cb3dSCy Schubert	_END_MDOC_AUTH;
92*2b15cb3dSCy Schubert};
93*2b15cb3dSCy Schubert
94*2b15cb3dSCy Schubertdoc-section	= {
95*2b15cb3dSCy Schubert  ds-type	= 'NOTES';
96*2b15cb3dSCy Schubert  ds-format	= 'mdoc';
97*2b15cb3dSCy Schubert  ds-text	= <<- _END_MDOC_NOTES
98*2b15cb3dSCy SchubertThis document corresponds to version @VERSION@ of NTP.
99*2b15cb3dSCy Schubert	_END_MDOC_NOTES;
100*2b15cb3dSCy Schubert};
101*2b15cb3dSCy Schubert
102*2b15cb3dSCy Schubert/*
103*2b15cb3dSCy Schubertdoc-section	= {
104*2b15cb3dSCy Schubert  ds-type	= 'BUGS';
105*2b15cb3dSCy Schubert  ds-format	= 'mdoc';
106*2b15cb3dSCy Schubert  ds-text	= <<- _END_MDOC_BUGS
107*2b15cb3dSCy Schubert	_END_MDOC_BUGS;
108*2b15cb3dSCy Schubert};
109*2b15cb3dSCy Schubert*/
110