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