ntp-wait.1ntp-waitmdoc revision 330106
1.Dd February 27 2018 2.Dt NTP_WAIT 1ntp-waitmdoc User Commands 3.Os 4.\" EDIT THIS FILE WITH CAUTION (ntp-wait-opts.mdoc) 5.\" 6.\" It has been AutoGen-ed February 27, 2018 at 10:49:55 AM by AutoGen 5.18.5 7.\" From the definitions ntp-wait-opts.def 8.\" and the template file agmdoc-cmd.tpl 9.Sh NAME 10.Nm ntp-wait 11.Nd Wait for ntpd to stabilize the system clock 12.Sh SYNOPSIS 13.Nm 14.\" Mixture of short (flag) options and long options 15.Op Fl flags 16.Op Fl flag Op Ar value 17.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc 18.Pp 19All arguments must be options. 20.Pp 21.Sh DESCRIPTION 22.Nm 23will send at most 24.Ar num\-tries 25queries to 26.Xr ntpd 8 , 27sleeping for 28.Ar secs\-between\-tries 29after each status return that says 30.Xr ntpd 8 31has not yet produced a synchronized and stable system clock. 32.Pp 33.Nm 34will do this quietly, unless the 35.Fl v 36flag is provided. 37This can be useful at boot time, to delay the boot sequence until after 38.Ar ntpd \-g 39has set the time. 40.Sh "OPTIONS" 41.Bl -tag 42.It Fl n Ar number , Fl \-tries Ns = Ns Ar number 43Number of times to check ntpd. 44This option takes an integer number as its argument. 45The default 46.Ar number 47for this option is: 48.ti +4 49 100 50.sp 51 The maximum number of times we will check \fBntpd\fP to see if 52 it has been able to synchronize and stabilize the system clock. 53.It Fl s Ar secs\-between\-tries , Fl \-sleep Ns = Ns Ar secs\-between\-tries 54How long to sleep between tries. 55This option takes an integer number as its argument. 56The default 57.Ar secs\-between\-tries 58for this option is: 59.ti +4 60 6 61.sp 62 We will sleep for \fIsecs\-between\-tries\fP after each query 63 of \fBntpd\fP that returns "the time is not yet stable". 64.It Fl v , Fl \-verbose 65Be verbose. 66.sp 67 By default, \fBntp\-wait\fP is silent. 68 With this option, \fBntp\-wait\fP will provide status information. 69.It Fl \&? , Fl \-help 70Display usage information and exit. 71.It Fl \&! , Fl \-more\-help 72Pass the extended usage information through a pager. 73.It Fl v Op Brq Ar v|c|n Fl \-version Op Brq Ar v|c|n 74Output version of program and exit. The default mode is `v', a simple 75version. The `c' mode will print copyright information and `n' will 76print the full copyright notice. 77.El 78.Sh "EXIT STATUS" 79One of the following exit values will be returned: 80.Bl -tag 81.It 0 " (EXIT_SUCCESS)" 82Successful program execution. 83.It 1 " (EXIT_FAILURE)" 84The operation failed or the command syntax was not valid. 85.It 70 " (EX_SOFTWARE)" 86libopts had an internal operational error. Please report 87it to autogen\-users@lists.sourceforge.net. Thank you. 88.El 89.Sh AUTHORS 90.An "Harlan Stenn" 91.Sh NOTES 92This document corresponds to version @VERSION@ of NTP. 93.Pp 94This manual page was \fIAutoGen\fP\-erated from the \fBntp\-wait\fP 95option definitions. 96