12b3787f6Schristos@node ntp-wait Invocation 22b3787f6Schristos@section Invoking ntp-wait 32b3787f6Schristos@pindex ntp-wait 42b3787f6Schristos@cindex Wait for ntpd to stabilize the system clock 52b3787f6Schristos@ignore 62b3787f6Schristos# 72b3787f6Schristos# EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi) 82b3787f6Schristos# 9*3323ceb7Schristos# It has been AutoGen-ed June 23, 2020 at 02:21:32 AM by AutoGen 5.18.5 102b3787f6Schristos# From the definitions ntp-wait-opts.def 112b3787f6Schristos# and the template file agtexi-cmd.tpl 122b3787f6Schristos@end ignore 132b3787f6Schristos 142b3787f6Schristos 152b3787f6Schristos 162b3787f6Schristos@code{ntp-wait} 172b3787f6Schristoswill send at most 182b3787f6Schristos@kbd{num-tries} 192b3787f6Schristosqueries to 202b3787f6Schristos@code{ntpd(8)}, 212b3787f6Schristossleeping for 222b3787f6Schristos@kbd{secs-between-tries} 232b3787f6Schristosafter each status return that says 242b3787f6Schristos@code{ntpd(8)} 252b3787f6Schristoshas not yet produced a synchronized and stable system clock. 262b3787f6Schristos 272b3787f6Schristos@code{ntp-wait} 282b3787f6Schristoswill do this quietly, unless the 292b3787f6Schristos@code{-v} 302b3787f6Schristosflag is provided. 312b3787f6SchristosThis can be useful at boot time, to delay the boot sequence until after 322b3787f6Schristos@kbd{ntpd} @kbd{-g} 332b3787f6Schristoshas set the time. 342b3787f6Schristos 352b3787f6SchristosThis section was generated by @strong{AutoGen}, 362b3787f6Schristosusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program. 372b3787f6Schristos 382b3787f6Schristos@menu 392b3787f6Schristos* ntp-wait usage:: ntp-wait help/usage (@option{--help}) 402b3787f6Schristos* ntp-wait tries:: tries option (-n) 412b3787f6Schristos* ntp-wait sleep:: sleep option (-s) 422b3787f6Schristos* ntp-wait verbose:: verbose option (-v) 432b3787f6Schristos* ntp-wait exit status:: exit status 442b3787f6Schristos* ntp-wait Authors:: Authors 452b3787f6Schristos* ntp-wait Notes:: Notes 462b3787f6Schristos@end menu 472b3787f6Schristos 482b3787f6Schristos@node ntp-wait usage 492b3787f6Schristos@subsection ntp-wait help/usage (@option{--help}) 502b3787f6Schristos@cindex ntp-wait help 512b3787f6Schristos 522b3787f6SchristosThis is the automatically generated usage text for ntp-wait. 532b3787f6Schristos 542b3787f6SchristosThe text printed is the same whether selected with the @code{help} option 552b3787f6Schristos(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 562b3787f6Schristosthe usage text by passing it through a pager program. 572b3787f6Schristos@code{more-help} is disabled on platforms without a working 582b3787f6Schristos@code{fork(2)} function. The @code{PAGER} environment variable is 592b3787f6Schristosused to select the program, defaulting to @file{more}. Both will exit 602b3787f6Schristoswith a status code of 0. 612b3787f6Schristos 622b3787f6Schristos@exampleindent 0 632b3787f6Schristos@example 64*3323ceb7Schristosntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p15 652b3787f6SchristosUSAGE: ntp-wait [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 662b3787f6Schristos 672b3787f6Schristos -n, --tries=num Number of times to check ntpd 682b3787f6Schristos -s, --sleep=num How long to sleep between tries 692b3787f6Schristos -v, --verbose Be verbose 702b3787f6Schristos -?, --help Display usage information and exit 711b6f2cd4Schristos --more-help Pass the extended usage text through a pager 722b3787f6Schristos 732b3787f6SchristosOptions are specified by doubled hyphens and their name or by a single 742b3787f6Schristoshyphen and the flag character. 752b3787f6Schristos@end example 762b3787f6Schristos@exampleindent 4 772b3787f6Schristos 782b3787f6Schristos@node ntp-wait tries 792b3787f6Schristos@subsection tries option (-n) 802b3787f6Schristos@cindex ntp-wait-tries 812b3787f6Schristos 822b3787f6SchristosThis is the ``number of times to check ntpd'' option. 832b3787f6SchristosThis option takes a number argument. 842b3787f6Schristos The maximum number of times we will check @code{ntpd} to see if 852b3787f6Schristos it has been able to synchronize and stabilize the system clock. 862b3787f6Schristos@node ntp-wait sleep 872b3787f6Schristos@subsection sleep option (-s) 882b3787f6Schristos@cindex ntp-wait-sleep 892b3787f6Schristos 902b3787f6SchristosThis is the ``how long to sleep between tries'' option. 912b3787f6SchristosThis option takes a number argument @file{secs-between-tries}. 922b3787f6Schristos We will sleep for @file{secs-between-tries} after each query 932b3787f6Schristos of @code{ntpd} that returns "the time is not yet stable". 942b3787f6Schristos@node ntp-wait verbose 952b3787f6Schristos@subsection verbose option (-v) 962b3787f6Schristos@cindex ntp-wait-verbose 972b3787f6Schristos 982b3787f6SchristosThis is the ``be verbose'' option. 992b3787f6Schristos By default, @code{ntp-wait} is silent. 1002b3787f6Schristos With this option, @code{ntp-wait} will provide status information. 1012b3787f6Schristos@node ntp-wait exit status 1022b3787f6Schristos@subsection ntp-wait exit status 1032b3787f6Schristos 1042b3787f6SchristosOne of the following exit values will be returned: 1052b3787f6Schristos@table @samp 1062b3787f6Schristos@item 0 (EXIT_SUCCESS) 1072b3787f6SchristosSuccessful program execution. 1082b3787f6Schristos@item 1 (EXIT_FAILURE) 1092b3787f6SchristosThe operation failed or the command syntax was not valid. 1102b3787f6Schristos@end table 1112b3787f6Schristos@node ntp-wait Authors 1122b3787f6Schristos@subsection ntp-wait Authors 1132b3787f6Schristos@node ntp-wait Notes 1142b3787f6Schristos@subsection ntp-wait Notes 115