invoke-ntp-wait.texi revision 298770
183104Sphantom@node ntp-wait Invocation 287659Sphantom@section Invoking ntp-wait 383104Sphantom@pindex ntp-wait 483104Sphantom@cindex Wait for ntpd to stabilize the system clock 5227753Stheraven@ignore 6227753Stheraven# 7227753Stheraven# EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi) 8227753Stheraven# 9227753Stheraven# It has been AutoGen-ed April 26, 2016 at 08:24:23 PM by AutoGen 5.18.5 1083104Sphantom# From the definitions ntp-wait-opts.def 1183104Sphantom# and the template file agtexi-cmd.tpl 1283104Sphantom@end ignore 1383104Sphantom 1483104Sphantom 1583104Sphantom 1683104Sphantom@code{ntp-wait} 1783104Sphantomwill send at most 1883104Sphantom@kbd{num-tries} 1983104Sphantomqueries to 2083104Sphantom@code{ntpd(8)}, 2183104Sphantomsleeping for 2283104Sphantom@kbd{secs-between-tries} 2383104Sphantomafter each status return that says 2483104Sphantom@code{ntpd(8)} 2583104Sphantomhas not yet produced a synchronized and stable system clock. 2683104Sphantom 2783104Sphantom@code{ntp-wait} 2883104Sphantomwill do this quietly, unless the 2983104Sphantom@code{-v} 3083104Sphantomflag is provided. 3183104SphantomThis can be useful at boot time, to delay the boot sequence until after 3283104Sphantom@kbd{ntpd} @kbd{-g} 3392986Sobrienhas set the time. 3492986Sobrien 3583104SphantomThis section was generated by @strong{AutoGen}, 3683104Sphantomusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program. 3783104Sphantom 3883104Sphantom@menu 3983104Sphantom* ntp-wait usage:: ntp-wait help/usage (@option{--help}) 4083104Sphantom* ntp-wait tries:: tries option (-n) 41150065Sstefanf* ntp-wait sleep:: sleep option (-s) 4283104Sphantom* ntp-wait verbose:: verbose option (-v) 4383104Sphantom* ntp-wait exit status:: exit status 4483104Sphantom* ntp-wait Authors:: Authors 4583104Sphantom* ntp-wait Notes:: Notes 46227753Stheraven@end menu 4783104Sphantom 4883104Sphantom@node ntp-wait usage 4983104Sphantom@subsection ntp-wait help/usage (@option{--help}) 5083104Sphantom@cindex ntp-wait help 5183104Sphantom 5283104SphantomThis is the automatically generated usage text for ntp-wait. 53298830Spfg 5483104SphantomThe text printed is the same whether selected with the @code{help} option 5583104Sphantom(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 5683104Sphantomthe usage text by passing it through a pager program. 5783104Sphantom@code{more-help} is disabled on platforms without a working 5883104Sphantom@code{fork(2)} function. The @code{PAGER} environment variable is 5983559Smikeused to select the program, defaulting to @file{more}. Both will exit 6083104Sphantomwith a status code of 0. 6183104Sphantom 6283104Sphantom@exampleindent 0 6383559Smike@example 6483104Sphantomntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p7 6583559SmikeUSAGE: ntp-wait [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 6683104Sphantom 6783104Sphantom -n, --tries=num Number of times to check ntpd 6883104Sphantom -s, --sleep=num How long to sleep between tries 6983559Smike -v, --verbose Be verbose 7083104Sphantom -?, --help Display usage information and exit 7183559Smike --more-help Pass the extended usage text through a pager 7283104Sphantom 7383104SphantomOptions are specified by doubled hyphens and their name or by a single 74178457Sruhyphen and the flag character. 75178457Sru@end example 7683104Sphantom@exampleindent 4 7783104Sphantom 78178312Sru@node ntp-wait tries 79178312Sru@subsection tries option (-n) 8083104Sphantom@cindex ntp-wait-tries 8183104Sphantom 8283559SmikeThis is the ``number of times to check ntpd'' option. 8383104SphantomThis option takes a number argument. 8483559Smike The maximum number of times we will check @code{ntpd} to see if 8583559Smike it has been able to synchronize and stabilize the system clock. 8683559Smike@node ntp-wait sleep 8783559Smike@subsection sleep option (-s) 8883559Smike@cindex ntp-wait-sleep 8983559Smike 9083559SmikeThis is the ``how long to sleep between tries'' option. 9183559SmikeThis option takes a number argument @file{secs-between-tries}. 9283559Smike We will sleep for @file{secs-between-tries} after each query 9383559Smike of @code{ntpd} that returns "the time is not yet stable". 9483559Smike@node ntp-wait verbose 9583559Smike@subsection verbose option (-v) 9683559Smike@cindex ntp-wait-verbose 9783104Sphantom 9883104SphantomThis is the ``be verbose'' option. 9983104Sphantom By default, @code{ntp-wait} is silent. 10083104Sphantom With this option, @code{ntp-wait} will provide status information. 101227753Stheraven@node ntp-wait exit status 102227753Stheraven@subsection ntp-wait exit status 103227753Stheraven 10483104SphantomOne of the following exit values will be returned: 10583104Sphantom@table @samp 10683104Sphantom@item 0 (EXIT_SUCCESS) 10783104SphantomSuccessful program execution. 10883104Sphantom@item 1 (EXIT_FAILURE) 10983104SphantomThe operation failed or the command syntax was not valid. 11083104Sphantom@end table 11183104Sphantom@node ntp-wait Authors 11283104Sphantom@subsection ntp-wait Authors 11383104Sphantom@node ntp-wait Notes 11483104Sphantom@subsection ntp-wait Notes 11583104Sphantom