invoke-ntp-wait.texi revision 362716
1141261Sdelphij@node ntp-wait Invocation 2141261Sdelphij@section Invoking ntp-wait 3141261Sdelphij@pindex ntp-wait 4141261Sdelphij@cindex Wait for ntpd to stabilize the system clock 5141261Sdelphij@ignore 6141261Sdelphij# 7141261Sdelphij# EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi) 8141261Sdelphij# 9141261Sdelphij# It has been AutoGen-ed June 23, 2020 at 02:21:32 AM by AutoGen 5.18.5 10141261Sdelphij# From the definitions ntp-wait-opts.def 11141261Sdelphij# and the template file agtexi-cmd.tpl 12141261Sdelphij@end ignore 13141261Sdelphij 14141261Sdelphij 15141261Sdelphij 16141261Sdelphij@code{ntp-wait} 17141261Sdelphijwill send at most 18141261Sdelphij@kbd{num-tries} 19141261Sdelphijqueries to 20141261Sdelphij@code{ntpd(8)}, 21141261Sdelphijsleeping for 22141261Sdelphij@kbd{secs-between-tries} 23141261Sdelphijafter each status return that says 24141261Sdelphij@code{ntpd(8)} 25141261Sdelphijhas not yet produced a synchronized and stable system clock. 26141261Sdelphij 27141261Sdelphij@code{ntp-wait} 28141261Sdelphijwill do this quietly, unless the 29141261Sdelphij@code{-v} 30141261Sdelphijflag is provided. 31141261SdelphijThis can be useful at boot time, to delay the boot sequence until after 32141261Sdelphij@kbd{ntpd} @kbd{-g} 33141261Sdelphijhas set the time. 34141261Sdelphij 35141261SdelphijThis section was generated by @strong{AutoGen}, 36141261Sdelphijusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program. 37141261Sdelphij 38141261Sdelphij@menu 39141261Sdelphij* ntp-wait usage:: ntp-wait help/usage (@option{--help}) 40141261Sdelphij* ntp-wait tries:: tries option (-n) 41141261Sdelphij* ntp-wait sleep:: sleep option (-s) 42141261Sdelphij* ntp-wait verbose:: verbose option (-v) 43141261Sdelphij* ntp-wait exit status:: exit status 44141261Sdelphij* ntp-wait Authors:: Authors 45141261Sdelphij* ntp-wait Notes:: Notes 46141261Sdelphij@end menu 47141261Sdelphij 48141261Sdelphij@node ntp-wait usage 49141261Sdelphij@subsection ntp-wait help/usage (@option{--help}) 50141261Sdelphij@cindex ntp-wait help 51141261Sdelphij 52141261SdelphijThis is the automatically generated usage text for ntp-wait. 53141261Sdelphij 54141261SdelphijThe text printed is the same whether selected with the @code{help} option 55141261Sdelphij(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 56141261Sdelphijthe usage text by passing it through a pager program. 57141261Sdelphij@code{more-help} is disabled on platforms without a working 58141261Sdelphij@code{fork(2)} function. The @code{PAGER} environment variable is 59141261Sdelphijused to select the program, defaulting to @file{more}. Both will exit 60141261Sdelphijwith a status code of 0. 61141261Sdelphij 62141261Sdelphij@exampleindent 0 63141261Sdelphij@example 64141261Sdelphijntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p15 65141261SdelphijUSAGE: ntp-wait [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 66141261Sdelphij 67141261Sdelphij -n, --tries=num Number of times to check ntpd 68141261Sdelphij -s, --sleep=num How long to sleep between tries 69141261Sdelphij -v, --verbose Be verbose 70141261Sdelphij -?, --help Display usage information and exit 71141261Sdelphij --more-help Pass the extended usage text through a pager 72141261Sdelphij 73141261SdelphijOptions are specified by doubled hyphens and their name or by a single 74141261Sdelphijhyphen and the flag character. 75141261Sdelphij@end example 76141261Sdelphij@exampleindent 4 77141261Sdelphij 78141261Sdelphij@node ntp-wait tries 79141261Sdelphij@subsection tries option (-n) 80141261Sdelphij@cindex ntp-wait-tries 81141261Sdelphij 82141261SdelphijThis is the ``number of times to check ntpd'' option. 83141261SdelphijThis option takes a number argument. 84141261Sdelphij The maximum number of times we will check @code{ntpd} to see if 85141261Sdelphij it has been able to synchronize and stabilize the system clock. 86141261Sdelphij@node ntp-wait sleep 87141261Sdelphij@subsection sleep option (-s) 88141261Sdelphij@cindex ntp-wait-sleep 89141261Sdelphij 90141261SdelphijThis is the ``how long to sleep between tries'' option. 91141261SdelphijThis option takes a number argument @file{secs-between-tries}. 92141261Sdelphij We will sleep for @file{secs-between-tries} after each query 93141261Sdelphij of @code{ntpd} that returns "the time is not yet stable". 94141261Sdelphij@node ntp-wait verbose 95141261Sdelphij@subsection verbose option (-v) 96141261Sdelphij@cindex ntp-wait-verbose 97141261Sdelphij 98141261SdelphijThis is the ``be verbose'' option. 99141261Sdelphij By default, @code{ntp-wait} is silent. 100141261Sdelphij With this option, @code{ntp-wait} will provide status information. 101141261Sdelphij@node ntp-wait exit status 102141261Sdelphij@subsection ntp-wait exit status 103141261Sdelphij 104141261SdelphijOne of the following exit values will be returned: 105141261Sdelphij@table @samp 106141261Sdelphij@item 0 (EXIT_SUCCESS) 107141261SdelphijSuccessful program execution. 108141261Sdelphij@item 1 (EXIT_FAILURE) 109141261SdelphijThe operation failed or the command syntax was not valid. 110141261Sdelphij@end table 111141261Sdelphij@node ntp-wait Authors 112141261Sdelphij@subsection ntp-wait Authors 113141261Sdelphij@node ntp-wait Notes 114141261Sdelphij@subsection ntp-wait Notes 115141261Sdelphij