xref: /src/external/bsd/ntp/dist/scripts/ntp-wait/ntp-wait.1ntp-waitmdoc

.Dd November 30 2013
.Dt NTP_WAIT 1ntp-waitmdoc User Commands
.Os SunOS 5.10
.\"  EDIT THIS FILE WITH CAUTION  (ntp-wait-opts.mdoc)
.\"
.\"  It has been AutoGen-ed  November 30, 2013 at 11:24:47 AM by AutoGen 5.18.3pre5
.\"  From the definitions    ntp-wait-opts.def
.\"  and the template file   agmdoc-cmd.tpl
.Sh NAME
.Nm ntp-wait
.Nd Wait for ntpd to stabilize the system clock
.Sh SYNOPSIS
.Nm
.\" Mixture of short (flag) options and long options
.Op Fl flags
.Op Fl flag Ar value
.Op Fl \-option\-name Ar value
.Pp
All arguments must be options.
.Pp
.Sh DESCRIPTION
.Nm
will send at most
.Ar num\-tries
queries to
.Xr ntpd 8 ,
sleeping for
.Ar secs\-between\-tries
after each status return that says
.Xr ntpd 8
has not yet produced a synchronized and stable system clock.
.Pp
.Nm
will do this quietly, unless the
.Fl v
flag is provided.
.Sh "OPTIONS"
.Bl -tag
.It  \-n " \fInum\-tries\fP, " \-\- "=" \fInum\-tries\fP
Number of times to check ntpd.
This option takes an integer number as its argument.
The default \fInum\-tries\fP for this option is:
.ti +4
 100
.sp
The maximum number of times we will check \fBntpd\fP to see if
it has been able to synchronize and stabilize the system clock.
.It  \-s " \fIsecs\-between\-tries\fP, " \-\- "=" \fIsecs\-between\-tries\fP
How long to sleep between tries.
This option takes an integer number as its argument.
The default \fIsecs\-between\-tries\fP for this option is:
.ti +4
 6
.sp
We will sleep for \fIsecs\-between\-tries\fP after each query
of \fBntpd\fP that returns "the time is not yet stable".
.It  \-v ", " \-\-
Be verbose.
.sp
By default, \fBntp\-wait\fP is silent.
With this option, \fBntp\-wait\fP will provide status information.
.It \-? , " \-\-help"
Display usage information and exit.
.It \-! , " \-\-more\-help"
Pass the extended usage information through a pager.
.It \-\-version "[={\fIv|c|n\fP}]"
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.
.El
.Sh "OPTION PRESETS"
Any option that is not marked as \fInot presettable\fP may be preset
by loading values from environment variables named:
.nf
  \fBNTP_WAIT_<option\-name>\fP or \fBNTP_WAIT\fP
.fi
.ad
cvt_prog='/usr/local/gnu/share/autogen/texi2mdoc'
cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd
         `/`basename "$cvt_prog"`
cd $tmp_dir
test \-x "$cvt_prog" || die "'$cvt_prog' is not executable"
{
    list='synopsis description options option\-presets'
    for f in $list ; do cat $f ; echo ; done
    rm \-f $list name
    list='implementation\-notes environment files examples exit\-status errors
        compatibility see\-also conforming\-to history authors copyright bugs
        notes'
    for f in $list ; do cat $f ; echo ; done > .end\-doc
    rm \-f $list
    list=`ls \-1 *`' .end\-doc'
    for f in $list ; do cat $f ; echo ; done
    rm \-f $list
} 1>.doc 2>/dev/null
sed \-f .cmds .doc | /usr/local/gnu/bin/grep \-E \-v '^[ 	]*$' | $cvt_prog
.Sh "ENVIRONMENT"
See \fBOPTION PRESETS\fP for configuration environment variables.
.Sh "EXIT STATUS"
One of the following exit values will be returned:
.Bl -tag
.It 0 " (EXIT_SUCCESS)"
Successful program execution.
.It 1 " (EXIT_FAILURE)"
The operation failed or the command syntax was not valid.
.It 70 " (EX_SOFTWARE)"
libopts had an internal operational error.  Please report
it to autogen\-users (a] lists.sourceforge.net.  Thank you.
.El
.Sh AUTHORS
.An "Harlan Stenn"
.Sh "COPYRIGHT"
Copyright (C) 1970\-2013 The University of Delaware all rights reserved.
This program is released under the terms of the NTP license, <http://ntp.org/license>.
.Sh "BUGS"
Please send bug reports to: http://bugs.ntp.org, bugs (a] ntp.org
.Sh NOTES
This document corresponds to version 4.2.7p401 of NTP.
.Pp
This manual page was \fIAutoGen\fP\-erated from the \fBntp\-wait\fP
option definitions.