ntp-wait.1ntp-waitmdoc revision 338531
1194701Srpaulo.Dd August 14 2018 2194701Srpaulo.Dt NTP_WAIT 1ntp-waitmdoc User Commands 3194701Srpaulo.Os 4194701Srpaulo.\" EDIT THIS FILE WITH CAUTION (ntp-wait-opts.mdoc) 5194701Srpaulo.\" 6194701Srpaulo.\" It has been AutoGen-ed August 14, 2018 at 08:09:10 AM by AutoGen 5.18.5 7194701Srpaulo.\" From the definitions ntp-wait-opts.def 8194701Srpaulo.\" and the template file agmdoc-cmd.tpl 9194701Srpaulo.Sh NAME 10194701Srpaulo.Nm ntp-wait 11194701Srpaulo.Nd Wait for ntpd to stabilize the system clock 12194701Srpaulo.Sh SYNOPSIS 13194701Srpaulo.Nm 14194701Srpaulo.\" Mixture of short (flag) options and long options 15194701Srpaulo.Op Fl flags 16194701Srpaulo.Op Fl flag Op Ar value 17194701Srpaulo.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18194701Srpaulo.Pp 19194701SrpauloAll arguments must be options. 20194701Srpaulo.Pp 21194701Srpaulo.Sh DESCRIPTION 22194701Srpaulo.Nm 23194701Srpaulowill send at most 24194701Srpaulo.Ar num\-tries 25194701Srpauloqueries to 26194701Srpaulo.Xr ntpd 8 , 27227823Sjhsleeping for 28203687Sgavin.Ar secs\-between\-tries 29194701Srpauloafter each status return that says 30194701Srpaulo.Xr ntpd 8 31194701Srpaulohas not yet produced a synchronized and stable system clock. 32194701Srpaulo.Pp 33194701Srpaulo.Nm 34194701Srpaulowill do this quietly, unless the 35194701Srpaulo.Fl v 36194701Srpauloflag is provided. 37194701SrpauloThis can be useful at boot time, to delay the boot sequence until after 38194701Srpaulo.Ar ntpd \-g 39194701Srpaulohas set the time. 40194701Srpaulo.Sh "OPTIONS" 41194701Srpaulo.Bl -tag 42194701Srpaulo.It Fl n Ar number , Fl \-tries Ns = Ns Ar number 43194701SrpauloNumber of times to check ntpd. 44194701SrpauloThis option takes an integer number as its argument. 45194701SrpauloThe default 46194701Srpaulo.Ar number 47194701Srpaulofor this option is: 48194701Srpaulo.ti +4 49194701Srpaulo 100 50233648Seadler.sp 51195325Srpaulo The maximum number of times we will check \fBntpd\fP to see if 52227823Sjh it has been able to synchronize and stabilize the system clock. 53194701Srpaulo.It Fl s Ar secs\-between\-tries , Fl \-sleep Ns = Ns Ar secs\-between\-tries 54194701SrpauloHow long to sleep between tries. 55227823SjhThis option takes an integer number as its argument. 56227823SjhThe default 57194701Srpaulo.Ar secs\-between\-tries 58194701Srpaulofor this option is: 59194701Srpaulo.ti +4 60205076Suqs 6 61227823Sjh.sp 62194701Srpaulo We will sleep for \fIsecs\-between\-tries\fP after each query 63194701Srpaulo of \fBntpd\fP that returns "the time is not yet stable". 64194701Srpaulo.It Fl v , Fl \-verbose 65194701SrpauloBe verbose. 66194701Srpaulo.sp 67194701Srpaulo By default, \fBntp\-wait\fP is silent. 68194701Srpaulo With this option, \fBntp\-wait\fP will provide status information. 69194701Srpaulo.It Fl \&? , Fl \-help 70194701SrpauloDisplay usage information and exit. 71194701Srpaulo.It Fl \&! , Fl \-more\-help 72194701SrpauloPass the extended usage information through a pager. 73194701Srpaulo.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 74194701SrpauloOutput version of program and exit. The default mode is `v', a simple 75194701Srpauloversion. The `c' mode will print copyright information and `n' will 76194701Srpauloprint the full copyright notice. 77269498Sgjb.El 78194701Srpaulo.Sh "EXIT STATUS" 79194701SrpauloOne of the following exit values will be returned: 80194701Srpaulo.Bl -tag 81194701Srpaulo.It 0 " (EXIT_SUCCESS)" 82198441SrpauloSuccessful program execution. 83194701Srpaulo.It 1 " (EXIT_FAILURE)" 84194701SrpauloThe operation failed or the command syntax was not valid. 85194701Srpaulo.It 70 " (EX_SOFTWARE)" 86194701Srpaulolibopts had an internal operational error. Please report 87194701Srpauloit to autogen\-users@lists.sourceforge.net. Thank you. 88235317Sgjb.El 89194701Srpaulo.Sh AUTHORS 90235317Sgjb.An "Harlan Stenn" 91194701Srpaulo.Sh NOTES 92194701SrpauloThis document corresponds to version @VERSION@ of NTP. 93194701Srpaulo.Pp 94194701SrpauloThis manual page was \fIAutoGen\fP\-erated from the \fBntp\-wait\fP 95194701Srpaulooption definitions. 96235317Sgjb