-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathinvoke-ntp-wait.texi
146 lines (119 loc) · 4.84 KB
/
invoke-ntp-wait.texi
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
@node ntp-wait Invocation
@section Invoking ntp-wait
@pindex ntp-wait
@cindex Wait for ntpd to stabilize the system clock
@ignore
#
# EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi)
#
# It has been AutoGen-ed May 1, 2013 at 11:29:23 AM by AutoGen 5.17.3
# From the definitions ntp-wait-opts.def
# and the template file agtexi-cmd.tpl
@end ignore
@code{ntp-wait}
will send at most
@kbd{num-tries}
queries to
@code{ntpd(8)},
sleeping for
@kbd{secs-between-tries}
after each status return that says
@code{ntpd(8)}
has not yet produced a synchronized and stable system clock.
@code{ntp-wait}
will do this quietly, unless the
@code{-v}
flag is provided.
This section was generated by @strong{AutoGen},
using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program.
This software is released under the NTP license, <http://ntp.org/license>.
@menu
* ntp-wait usage:: ntp-wait help/usage (@option{--help})
* ntp-wait :: option (-n)
* ntp-wait :: option (-s)
* ntp-wait :: option (-v)
* ntp-wait config:: presetting/configuring ntp-wait
* ntp-wait exit status:: exit status
* ntp-wait Authors:: Authors
* ntp-wait Notes:: Notes
@end menu
@node ntp-wait usage
@subsection ntp-wait help/usage (@option{--help})
@cindex ntp-wait help
This is the automatically generated usage text for ntp-wait.
The text printed is the same whether selected with the @code{help} option
(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print
the usage text by passing it through a pager program.
@code{more-help} is disabled on platforms without a working
@code{fork(2)} function. The @code{PAGER} environment variable is
used to select the program, defaulting to @file{more}. Both will exit
with a status code of 0.
@exampleindent 0
@example
/deacon/backroom/snaps/ntp-dev/A.snap/scripts/ntp-wait version [unknown] calling Getopt::Std::getopts (version 1.05 [paranoid]),
running under Perl version 5.8.8.
Usage: ntp-wait [-OPTIONS [-MORE_OPTIONS]] [--] [PROGRAM_ARG1 ...]
The following single-character options are accepted:
With arguments: -n -s
Boolean (without arguments): -v
Options may be merged together. -- stops processing of options.
Space is not required between options and their arguments.
[Now continuing due to backward compatibility and excessive paranoia.
See ``perldoc Getopt::Std'' about $Getopt::Std::STANDARD_HELP_VERSION.]
@end example
@exampleindent 4
@node ntp-wait
@subsection option (-n)
@cindex ntp-wait-
This is the ``number of times to check ntpd'' option.
This option takes an argument number @file{num-tries}.
The maximum number of times we will check @code{ntpd} to see if
it has been able to synchronize and stabilize the system clock.
@node ntp-wait
@subsection option (-s)
@cindex ntp-wait-
This is the ``how long to sleep between tries'' option.
This option takes an argument number @file{secs-between-tries}.
We will sleep for @file{secs-between-tries} after each query
of @code{ntpd} that returns "the time is not yet stable".
@node ntp-wait
@subsection option (-v)
@cindex ntp-wait-
This is the ``be verbose'' option.
By default, @code{ntp-wait} is silent.
With this option, @code{ntp-wait} will provide status information.
@node ntp-wait config
@subsection presetting/configuring ntp-wait
Any option that is not marked as @i{not presettable} may be preset by
loading values from environment variables named @code{NTP-WAIT} and @code{NTP-WAIT_<OPTION_NAME>}. @code{<OPTION_NAME>} must be one of
the options listed above in upper case and segmented with underscores.
The @code{NTP-WAIT} variable will be tokenized and parsed like
the command line. The remaining variables are tested for existence and their
values are treated like option arguments.
The command line options relating to configuration and/or usage help are:
@subsubheading version (-)
Print the program version to standard out, optionally with licensing
information, then exit 0. The optional argument specifies how much licensing
detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument.
Only the first letter of the argument is examined:
@table @samp
@item version
Only print the version. This is the default.
@item copyright
Name the copyright usage licensing terms.
@item verbose
Print the full copyright usage licensing terms.
@end table
@node ntp-wait exit status
@subsection ntp-wait exit status
One of the following exit values will be returned:
@table @samp
@item 0 (EXIT_SUCCESS)
Successful program execution.
@item 1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid.
@end table
@node ntp-wait Authors
@subsection ntp-wait Authors
@node ntp-wait Notes
@subsection ntp-wait Notes