invoke-ntp-wait.texi revision 310419
1135446Strhodes@node ntp-wait Invocation 2254402Serwin@section Invoking ntp-wait 3135446Strhodes@pindex ntp-wait 4135446Strhodes@cindex Wait for ntpd to stabilize the system clock 5174187Sdougb@ignore 6135446Strhodes# 7135446Strhodes# EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi) 8135446Strhodes# 9135446Strhodes# It has been AutoGen-ed November 21, 2016 at 07:58:47 AM by AutoGen 5.18.5 10135446Strhodes# From the definitions ntp-wait-opts.def 11135446Strhodes# and the template file agtexi-cmd.tpl 12135446Strhodes@end ignore 13135446Strhodes 14135446Strhodes 15135446Strhodes 16135446Strhodes@code{ntp-wait} 17135446Strhodeswill send at most 18234010Sdougb@kbd{num-tries} 19135446Strhodesqueries to 20170222Sdougb@code{ntpd(8)}, 21170222Sdougbsleeping for 22135446Strhodes@kbd{secs-between-tries} 23135446Strhodesafter each status return that says 24135446Strhodes@code{ntpd(8)} 25135446Strhodeshas not yet produced a synchronized and stable system clock. 26135446Strhodes 27135446Strhodes@code{ntp-wait} 28135446Strhodeswill do this quietly, unless the 29135446Strhodes@code{-v} 30135446Strhodesflag is provided. 31170222SdougbThis can be useful at boot time, to delay the boot sequence until after 32135446Strhodes@kbd{ntpd} @kbd{-g} 33135446Strhodeshas set the time. 34135446Strhodes 35170222SdougbThis section was generated by @strong{AutoGen}, 36170222Sdougbusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program. 37135446Strhodes 38135446Strhodes@menu 39170222Sdougb* ntp-wait usage:: ntp-wait help/usage (@option{--help}) 40135446Strhodes* ntp-wait tries:: tries option (-n) 41135446Strhodes* ntp-wait sleep:: sleep option (-s) 42170222Sdougb* ntp-wait verbose:: verbose option (-v) 43135446Strhodes* ntp-wait exit status:: exit status 44135446Strhodes* ntp-wait Authors:: Authors 45135446Strhodes* ntp-wait Notes:: Notes 46135446Strhodes@end menu 47135446Strhodes 48135446Strhodes@node ntp-wait usage 49135446Strhodes@subsection ntp-wait help/usage (@option{--help}) 50135446Strhodes@cindex ntp-wait help 51135446Strhodes 52135446StrhodesThis is the automatically generated usage text for ntp-wait. 53135446Strhodes 54135446StrhodesThe text printed is the same whether selected with the @code{help} option 55135446Strhodes(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 56135446Strhodesthe usage text by passing it through a pager program. 57135446Strhodes@code{more-help} is disabled on platforms without a working 58135446Strhodes@code{fork(2)} function. The @code{PAGER} environment variable is 59135446Strhodesused to select the program, defaulting to @file{more}. Both will exit 60135446Strhodeswith a status code of 0. 61135446Strhodes 62135446Strhodes@exampleindent 0 63186462Sdougb@example 64135446Strhodesntp-wait - Wait for ntpd to stabilize the system clock - Ver. 4.2.8p9 65135446StrhodesUSAGE: ntp-wait [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 66254402Serwin 67254402Serwin -n, --tries=num Number of times to check ntpd 68135446Strhodes -s, --sleep=num How long to sleep between tries 69135446Strhodes -v, --verbose Be verbose 70186462Sdougb -?, --help Display usage information and exit 71135446Strhodes --more-help Pass the extended usage text through a pager 72135446Strhodes 73186462SdougbOptions are specified by doubled hyphens and their name or by a single 74135446Strhodeshyphen and the flag character. 75218384Sdougb@end example 76135446Strhodes@exampleindent 4 77186462Sdougb 78135446Strhodes@node ntp-wait tries 79186462Sdougb@subsection tries option (-n) 80174187Sdougb@cindex ntp-wait-tries 81218384Sdougb 82186462SdougbThis is the ``number of times to check ntpd'' option. 83186462SdougbThis option takes a number argument. 84135446Strhodes The maximum number of times we will check @code{ntpd} to see if 85135446Strhodes it has been able to synchronize and stabilize the system clock. 86135446Strhodes@node ntp-wait sleep 87135446Strhodes@subsection sleep option (-s) 88135446Strhodes@cindex ntp-wait-sleep 89135446Strhodes 90186462SdougbThis is the ``how long to sleep between tries'' option. 91135446StrhodesThis option takes a number argument @file{secs-between-tries}. 92135446Strhodes We will sleep for @file{secs-between-tries} after each query 93135446Strhodes of @code{ntpd} that returns "the time is not yet stable". 94135446Strhodes@node ntp-wait verbose 95135446Strhodes@subsection verbose option (-v) 96135446Strhodes@cindex ntp-wait-verbose 97135446Strhodes 98135446StrhodesThis is the ``be verbose'' option. 99135446Strhodes By default, @code{ntp-wait} is silent. 100135446Strhodes With this option, @code{ntp-wait} will provide status information. 101135446Strhodes@node ntp-wait exit status 102135446Strhodes@subsection ntp-wait exit status 103193149Sdougb 104135446StrhodesOne of the following exit values will be returned: 105135446Strhodes@table @samp 106135446Strhodes@item 0 (EXIT_SUCCESS) 107135446StrhodesSuccessful program execution. 108135446Strhodes@item 1 (EXIT_FAILURE) 109135446StrhodesThe operation failed or the command syntax was not valid. 110186462Sdougb@end table 111135446Strhodes@node ntp-wait Authors 112135446Strhodes@subsection ntp-wait Authors 113135446Strhodes@node ntp-wait Notes 114135446Strhodes@subsection ntp-wait Notes 115135446Strhodes