xref: /netbsd-src/external/bsd/ntp/dist/scripts/ntp-wait/ntp-wait.1ntp-waitmdoc (revision 6cf6fe02a981b55727c49c3d37b0d8191a98c0ee)
1.Dd November 30 2013
2.Dt NTP_WAIT 1ntp-waitmdoc User Commands
3.Os SunOS 5.10
4.\"  EDIT THIS FILE WITH CAUTION  (ntp-wait-opts.mdoc)
5.\"
6.\"  It has been AutoGen-ed  November 30, 2013 at 11:24:47 AM by AutoGen 5.18.3pre5
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 Ar value
17.Op Fl \-option\-name Ar value
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.
37.Sh "OPTIONS"
38.Bl -tag
39.It  \-n " \fInum\-tries\fP, " \-\- "=" \fInum\-tries\fP
40Number of times to check ntpd.
41This option takes an integer number as its argument.
42The default \fInum\-tries\fP for this option is:
43.ti +4
44 100
45.sp
46The maximum number of times we will check \fBntpd\fP to see if
47it has been able to synchronize and stabilize the system clock.
48.It  \-s " \fIsecs\-between\-tries\fP, " \-\- "=" \fIsecs\-between\-tries\fP
49How long to sleep between tries.
50This option takes an integer number as its argument.
51The default \fIsecs\-between\-tries\fP for this option is:
52.ti +4
53 6
54.sp
55We will sleep for \fIsecs\-between\-tries\fP after each query
56of \fBntpd\fP that returns "the time is not yet stable".
57.It  \-v ", " \-\-
58Be verbose.
59.sp
60By default, \fBntp\-wait\fP is silent.
61With this option, \fBntp\-wait\fP will provide status information.
62.It \-? , " \-\-help"
63Display usage information and exit.
64.It \-! , " \-\-more\-help"
65Pass the extended usage information through a pager.
66.It \-\-version "[={\fIv|c|n\fP}]"
67Output version of program and exit.  The default mode is `v', a simple
68version.  The `c' mode will print copyright information and `n' will
69print the full copyright notice.
70.El
71.Sh "OPTION PRESETS"
72Any option that is not marked as \fInot presettable\fP may be preset
73by loading values from environment variables named:
74.nf
75  \fBNTP_WAIT_<option\-name>\fP or \fBNTP_WAIT\fP
76.fi
77.ad
78cvt_prog='/usr/local/gnu/share/autogen/texi2mdoc'
79cvt_prog=`cd \`dirname "$cvt_prog"\` >/dev/null && pwd
80         `/`basename "$cvt_prog"`
81cd $tmp_dir
82test \-x "$cvt_prog" || die "'$cvt_prog' is not executable"
83{
84    list='synopsis description options option\-presets'
85    for f in $list ; do cat $f ; echo ; done
86    rm \-f $list name
87    list='implementation\-notes environment files examples exit\-status errors
88        compatibility see\-also conforming\-to history authors copyright bugs
89        notes'
90    for f in $list ; do cat $f ; echo ; done > .end\-doc
91    rm \-f $list
92    list=`ls \-1 *`' .end\-doc'
93    for f in $list ; do cat $f ; echo ; done
94    rm \-f $list
95} 1>.doc 2>/dev/null
96sed \-f .cmds .doc | /usr/local/gnu/bin/grep \-E \-v '^[ 	]*$' | $cvt_prog
97.Sh "ENVIRONMENT"
98See \fBOPTION PRESETS\fP for configuration environment variables.
99.Sh "EXIT STATUS"
100One of the following exit values will be returned:
101.Bl -tag
102.It 0 " (EXIT_SUCCESS)"
103Successful program execution.
104.It 1 " (EXIT_FAILURE)"
105The operation failed or the command syntax was not valid.
106.It 70 " (EX_SOFTWARE)"
107libopts had an internal operational error.  Please report
108it to autogen\-users@lists.sourceforge.net.  Thank you.
109.El
110.Sh AUTHORS
111.An "Harlan Stenn"
112.Sh "COPYRIGHT"
113Copyright (C) 1970\-2013 The University of Delaware all rights reserved.
114This program is released under the terms of the NTP license, <http://ntp.org/license>.
115.Sh "BUGS"
116Please send bug reports to: http://bugs.ntp.org, bugs@ntp.org
117.Sh NOTES
118This document corresponds to version 4.2.7p401 of NTP.
119.Pp
120This manual page was \fIAutoGen\fP\-erated from the \fBntp\-wait\fP
121option definitions.
122