1 @node ntp-wait Invocation
2 @section Invoking ntp-wait
4 @cindex Wait for ntpd to stabilize the system clock
7 # EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi)
9 # It has been AutoGen-ed April 26, 2016 at 08:24:23 PM by AutoGen 5.18.5
10 # From the definitions ntp-wait-opts.def
11 # and the template file agtexi-cmd.tpl
22 @kbd{secs-between-tries}
23 after each status return that says
25 has not yet produced a synchronized and stable system clock.
28 will do this quietly, unless the
31 This can be useful at boot time, to delay the boot sequence until after
35 This section was generated by @strong{AutoGen},
36 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program.
39 * ntp-wait usage:: ntp-wait help/usage (@option{--help})
40 * ntp-wait tries:: tries option (-n)
41 * ntp-wait sleep:: sleep option (-s)
42 * ntp-wait verbose:: verbose option (-v)
43 * ntp-wait exit status:: exit status
44 * ntp-wait Authors:: Authors
45 * ntp-wait Notes:: Notes
49 @subsection ntp-wait help/usage (@option{--help})
52 This is the automatically generated usage text for ntp-wait.
54 The text printed is the same whether selected with the @code{help} option
55 (@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print
56 the usage text by passing it through a pager program.
57 @code{more-help} is disabled on platforms without a working
58 @code{fork(2)} function. The @code{PAGER} environment variable is
59 used to select the program, defaulting to @file{more}. Both will exit
60 with a status code of 0.
64 ntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p7
65 USAGE: ntp-wait [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
67 -n, --tries=num Number of times to check ntpd
68 -s, --sleep=num How long to sleep between tries
69 -v, --verbose Be verbose
70 -?, --help Display usage information and exit
71 --more-help Pass the extended usage text through a pager
73 Options are specified by doubled hyphens and their name or by a single
74 hyphen and the flag character.
79 @subsection tries option (-n)
80 @cindex ntp-wait-tries
82 This is the ``number of times to check ntpd'' option.
83 This option takes a number argument.
84 The maximum number of times we will check @code{ntpd} to see if
85 it has been able to synchronize and stabilize the system clock.
87 @subsection sleep option (-s)
88 @cindex ntp-wait-sleep
90 This is the ``how long to sleep between tries'' option.
91 This option takes a number argument @file{secs-between-tries}.
92 We will sleep for @file{secs-between-tries} after each query
93 of @code{ntpd} that returns "the time is not yet stable".
94 @node ntp-wait verbose
95 @subsection verbose option (-v)
96 @cindex ntp-wait-verbose
98 This is the ``be verbose'' option.
99 By default, @code{ntp-wait} is silent.
100 With this option, @code{ntp-wait} will provide status information.
101 @node ntp-wait exit status
102 @subsection ntp-wait exit status
104 One of the following exit values will be returned:
106 @item 0 (EXIT_SUCCESS)
107 Successful program execution.
108 @item 1 (EXIT_FAILURE)
109 The operation failed or the command syntax was not valid.
111 @node ntp-wait Authors
112 @subsection ntp-wait Authors
114 @subsection ntp-wait Notes