xref: /freebsd/contrib/ntp/scripts/ntp-wait/ntp-wait.man.in (revision a64729f5077d77e13b9497cb33ecb3c82e606ee8)
. it 1 an-trap . if \\n[.$] \,\\$*\/ ..
ntp-wait @NTP_WAIT_MS@ "25 May 2024" "ntp (4.2.8p18)" "User Commands"

EDIT THIS FILE WITH CAUTION (in-mem file)

It has been AutoGen-ed May 25, 2024 at 12:05:40 AM by AutoGen 5.18.16
From the definitions ntp-wait-opts.def
and the template file agman-cmd.tpl
NAME
\f\*[B-Font]ntp-wait - Wait for ntpd to stabilize the system clock
SYNOPSIS
\f\*[B-Font]ntp-wait Mixture of short (flag) options and long options
[\f\*[B-Font]-flags\f[]] [\f\*[B-Font]-flag\f[] [\f\*[I-Font]value\f[]]] [\f\*[B-Font]--option-name\f[][[=| ]\f\*[I-Font]value\f[]]] All arguments must be options.
DESCRIPTION
\f\*[B-Font]ntp-wait will send at most \f\*[I-Font]num-tries\f[] queries to ntpd\f[](8)\f[], sleeping for \f\*[I-Font]secs-between-tries\f[] after each status return that says ntpd\f[](8)\f[] has not yet produced a synchronized and stable system clock. \f\*[B-Font]ntp-wait will do this quietly, unless the \f\*[B-Font]-v\f[] flag is provided. This can be useful at boot time, to delay the boot sequence until after \f\*[I-Font]ntpd\f[] \f\*[I-Font]-g\f[] has set the time.
"OPTIONS"

.NOP \f\*[B-Font]-n\f[] \f\*[I-Font]number\f[], \f\*[B-Font]--tries\f[]=\f\*[I-Font]number\f[] Number of times to check ntpd. This option takes an integer number as its argument. The default \f\*[I-Font]number\f[] for this option is: 100 The maximum number of times we will check ntpd to see if it has been able to synchronize and stabilize the system clock.

.NOP \f\*[B-Font]-s\f[] \f\*[I-Font]secs-between-tries\f[], \f\*[B-Font]--sleep\f[]=\f\*[I-Font]secs-between-tries\f[] How long to sleep between tries. This option takes an integer number as its argument. The default \f\*[I-Font]secs-between-tries\f[] for this option is: 6 We will sleep for secs-between-tries after each query of ntpd that returns "the time is not yet stable".

.NOP \f\*[B-Font]-v\f[], \f\*[B-Font]--verbose\f[] Be verbose. By default, ntp-wait is silent. With this option, ntp-wait will provide status information.

.NOP \f\*[B-Font]-?\f[], \f\*[B-Font]--help\f[] Display usage information and exit.

.NOP \f\*[B-Font]-!\f[], \f\*[B-Font]--more-help\f[] Pass the extended usage information through a pager.

.NOP \f\*[B-Font]-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]--version\f[] [{\f\*[I-Font]v|c|n\f[]}]}] Output version of program and exit. The default mode is `v', a simple version. The `c' mode will print copyright information and `n' will print the full copyright notice.

"EXIT STATUS"
One of the following exit values will be returned:

.NOP 0 " (EXIT_SUCCESS)" Successful program execution.

.NOP 1 " (EXIT_FAILURE)" The operation failed or the command syntax was not valid.

.NOP 70 " (EX_SOFTWARE)" libopts had an internal operational error. Please report it to autogen-users@lists.sourceforge.net. Thank you.

AUTHORS
.NOP "Harlan Stenn"

NOTES
This document corresponds to version @VERSION@ of NTP. This manual page was AutoGen-erated from the ntp-wait option definitions.