ntp-wait.1ntp-waitmdoc revision 301301
1212795Sdim.Dd June 2 2016 2212795Sdim.Dt NTP_WAIT 1ntp-waitmdoc User Commands 3212795Sdim.Os 4212795Sdim.\" EDIT THIS FILE WITH CAUTION (ntp-wait-opts.mdoc) 5212795Sdim.\" 6212795Sdim.\" It has been AutoGen-ed June 2, 2016 at 07:24:44 AM by AutoGen 5.18.5 7212795Sdim.\" From the definitions ntp-wait-opts.def 8212795Sdim.\" and the template file agmdoc-cmd.tpl 9263508Sdim.Sh NAME 10263508Sdim.Nm ntp-wait 11263508Sdim.Nd Wait for ntpd to stabilize the system clock 12263508Sdim.Sh SYNOPSIS 13263508Sdim.Nm 14263508Sdim.\" Mixture of short (flag) options and long options 15263508Sdim.Op Fl flags 16263508Sdim.Op Fl flag Op Ar value 17263508Sdim.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18263508Sdim.Pp 19263508SdimAll arguments must be options. 20212795Sdim.Pp 21212795Sdim.Sh DESCRIPTION 22212795Sdim.Nm 23212795Sdimwill send at most 24212795Sdim.Ar num\-tries 25239462Sdimqueries to 26212795Sdim.Xr ntpd 8 , 27212795Sdimsleeping for 28212795Sdim.Ar secs\-between\-tries 29212795Sdimafter each status return that says 30212795Sdim.Xr ntpd 8 31212795Sdimhas not yet produced a synchronized and stable system clock. 32212795Sdim.Pp 33212795Sdim.Nm 34212795Sdimwill do this quietly, unless the 35212795Sdim.Fl v 36212795Sdimflag is provided. 37212795SdimThis can be useful at boot time, to delay the boot sequence until after 38212795Sdim.Ar ntpd \-g 39212795Sdimhas set the time. 40212795Sdim.Sh "OPTIONS" 41212795Sdim.Bl -tag 42212795Sdim.It Fl n Ar number , Fl \-tries Ns = Ns Ar number 43212795SdimNumber of times to check ntpd. 44239462SdimThis option takes an integer number as its argument. 45212795SdimThe default 46212795Sdim.Ar number 47212795Sdimfor this option is: 48212795Sdim.ti +4 49212795Sdim 100 50212795Sdim.sp 51239462Sdim The maximum number of times we will check \fBntpd\fP to see if 52212795Sdim it has been able to synchronize and stabilize the system clock. 53212795Sdim.It Fl s Ar secs\-between\-tries , Fl \-sleep Ns = Ns Ar secs\-between\-tries 54239462SdimHow long to sleep between tries. 55212795SdimThis option takes an integer number as its argument. 56212795SdimThe default 57212795Sdim.Ar secs\-between\-tries 58212795Sdimfor this option is: 59212795Sdim.ti +4 60212795Sdim 6 61212795Sdim.sp 62239462Sdim We will sleep for \fIsecs\-between\-tries\fP after each query 63212795Sdim of \fBntpd\fP that returns "the time is not yet stable". 64212795Sdim.It Fl v , Fl \-verbose 65212795SdimBe verbose. 66212795Sdim.sp 67212795Sdim By default, \fBntp\-wait\fP is silent. 68212795Sdim With this option, \fBntp\-wait\fP will provide status information. 69212795Sdim.It Fl \&? , Fl \-help 70212795SdimDisplay usage information and exit. 71212795Sdim.It Fl \&! , Fl \-more\-help 72212795SdimPass the extended usage information through a pager. 73212795Sdim.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 74212795SdimOutput version of program and exit. The default mode is `v', a simple 75212795Sdimversion. The `c' mode will print copyright information and `n' will 76212795Sdimprint the full copyright notice. 77212795Sdim.El 78212795Sdim.Sh "EXIT STATUS" 79212795SdimOne of the following exit values will be returned: 80212795Sdim.Bl -tag 81212795Sdim.It 0 " (EXIT_SUCCESS)" 82212795SdimSuccessful program execution. 83212795Sdim.It 1 " (EXIT_FAILURE)" 84212795SdimThe operation failed or the command syntax was not valid. 85212795Sdim.It 70 " (EX_SOFTWARE)" 86212795Sdimlibopts had an internal operational error. Please report 87212795Sdimit to autogen\-users@lists.sourceforge.net. Thank you. 88212795Sdim.El 89212795Sdim.Sh AUTHORS 90212795Sdim.An "Harlan Stenn" 91212795Sdim.Sh NOTES 92212795SdimThis document corresponds to version @VERSION@ of NTP. 93212795Sdim.Pp 94212795SdimThis manual page was \fIAutoGen\fP\-erated from the \fBntp\-wait\fP 95212795Sdimoption definitions. 96212795Sdim