+* Update ntp-wait autogen docs.
* Update the ntpd autogen docs.
* Update the ntpsnmpd autogen docs.
* Use autogen to produce ntp-keygen docs.
NULL=
+man_MANS= $(srcdir)/ntp-wait.1
+run_ag= cd $(srcdir) && env PATH="$(abs_builddir):$(PATH)" \
+ autogen -L ../sntp/include -L ../sntp/ag-tpl --writable
+std_def_list = \
+ $(top_srcdir)/sntp/include/debug-opt.def \
+ $(top_srcdir)/sntp/include/autogen-version.def \
+ $(top_srcdir)/sntp/include/copyright.def \
+ $(top_srcdir)/sntp/include/homerc.def \
+ $(top_srcdir)/sntp/include/ntp.lic \
+ $(top_srcdir)/sntp/include/version.def \
+ $(NULL)
+
if NTP_BINSUBDIR_IS_BIN
bin_SCRIPTS = ntp-wait ntptrace
else
summary \
$(NULL)
+noinst_DATA= \
+ $(srcdir)/ntp-wait.html \
+ $(srcdir)/ntp-wait-opts.texi \
+ $(srcdir)/ntp-wait-opts.menu \
+ $(NULL)
+
EXTRA_DIST = \
check--help \
checkChangeLog \
ntp-groper \
ntp-restart \
ntp-status \
+ ntp-wait.1 \
+ ntp-wait.html \
+ ntp-wait.texi \
+ ntp-wait-opts.def \
+ ntp-wait-opts.menu \
+ ntp-wait-opts.texi \
rc1 \
rc2 \
stats \
UpdatePoint \
VersionName \
$(NULL)
+
+# For man pages, use agman-cmd.tpl
+# For mdoc pages, use agmdoc-cmd.tpl
+$(srcdir)/ntp-wait.1: $(srcdir)/ntp-wait-opts.def $(std_def_list)
+ $(run_ag) -DMAN_SECTION=1 -Tagmdoc-cmd.tpl ntp-wait-opts.def
+
+$(srcdir)/ntp-wait-opts.menu: $(srcdir)/ntp-wait-opts.texi
+ @: do-nothing action to avoid default SCCS get, .menu built with .texi
+
+$(srcdir)/ntp-wait-opts.texi: $(srcdir)/ntp-wait-opts.def $(std_def_list)
+ $(run_ag) -Taginfo.tpl -DLEVEL=section ntp-wait-opts.def
+ -$(top_srcdir)/../scripts/check--help $@
+
+$(srcdir)/ntp-wait.html: $(srcdir)/ntp-wait-opts.menu $(srcdir)/ntp-wait-opts.texi $(srcdir)/ntp-wait.texi $(top_srcdir)/sntp/include/version.texi
+ cd $(srcdir) && ( makeinfo --force --html --no-split -o ntp-wait.html ntp-wait.texi || true )
+
--- /dev/null
+/* -*- Mode: Text -*- */
+
+autogen definitions options;
+
+#include copyright.def
+// #include homerc.def
+#include autogen-version.def
+
+prog-name = "ntp-wait";
+prog-title = "Wait for ntpd to stabilize the system clock";
+package = ntp;
+
+test-main;
+
+// #include version.def
+
+flag = {
+ value = n;
+ arg-type = number;
+ arg-name = num-tries;
+ descrip = "Number of times to check ntpd";
+ doc = <<- _EndOfDoc_
+ The maximum number of times we will check ntpd to see if it
+ has been able to synchronize and stabilize the system clock.
+
+ The default is 100 times.
+ _EndOfDoc_;
+};
+
+flag = {
+ value = s;
+ arg-type = number;
+ arg-name = secs-between-tries;
+ descrip = "How long to sleep between tries";
+ doc = <<- _EndOfDoc_
+ We will sleep for secs-between-tries after each query of ntpd
+ that returns "the time is not yet stable".
+
+ The default is 6 seconds.
+ _EndOfDoc_;
+};
+
+flag = {
+ value = v;
+ descrip = "Be verbose";
+ doc = <<- _EndOfDoc_
+ By default, ntp-wait is silent. With this option, ntp-wait
+ will provide status information.
+ _EndOfDoc_;
+};
+
+/* explain: Additional information whenever the usage routine is invoked */
+explain = <<- _END_EXPLAIN
+ _END_EXPLAIN;
+
+doc-section = {
+ ds-type = 'DESCRIPTION';
+ ds-format = 'mdoc';
+ ds-text = <<- _END_PROG_MDOC_DESCRIP
+.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.
+ _END_PROG_MDOC_DESCRIP;
+};
+
+/*
+prog-info-descrip = <<- _END_PROG_INFO_DESCRIP
+ _END_PROG_INFO_DESCRIP;
+*/
+
+/*
+doc-section = {
+ ds-type = 'USAGE';
+ ds-format = 'mdoc';
+ ds-text = <<- _END_MDOC_USAGE
+ _END_MDOC_USAGE;
+};
+*/
+
+doc-section = {
+ ds-type = 'AUTHORS';
+ ds-format = 'mdoc';
+ ds-text = <<- _END_MDOC_NOTES
+.An "Harlan Stenn"
+ _END_MDOC_NOTES;
+};
+
+/*
+doc-section = {
+ ds-type = 'BUGS';
+ ds-format = 'mdoc';
+ ds-text = <<- _END_MDOC_BUGS
+ _END_MDOC_BUGS;
+};
+*/
--- /dev/null
+* ntp-wait Invocation:: Invoking ntp-wait
--- /dev/null
+@node ntp-wait Invocation
+@section Invoking ntp-wait
+@pindex ntp-wait
+@cindex Wait for ntpd to stabilize the system clock
+@ignore
+#
+# EDIT THIS FILE WITH CAUTION (ntp-wait-opts.texi)
+#
+# It has been AutoGen-ed June 14, 2011 at 09:07:45 AM by AutoGen 5.11.10pre10
+# From the definitions ntp-wait-opts.def
+# and the template file aginfo.tpl
+@end ignore
+
+
+
+This section was generated by @strong{AutoGen},
+the aginfo template and the option descriptions for the @command{ntp-wait} program. It documents the @command{ntp-wait} usage text and option meanings.
+
+This software is released under a specialized copyright license.
+
+@menu
+* ntp-wait usage:: ntp-wait usage help (-?)
+* ntp-wait :: option (-n)
+* ntp-wait :: option (-s)
+* ntp-wait :: option (-v)
+@end menu
+
+@node ntp-wait usage
+@subsection ntp-wait usage help (-?)
+@cindex ntp-wait usage
+
+This is the automatically generated usage text for ntp-wait:
+
+@exampleindent 0
+@example
+/home/stenn/ntp-dev/A.psp-fb2/scripts/ntp-wait version [unknown] calling Getopt::Std::getopts (version 1.06 [paranoid]),
+running under Perl version 5.8.9.
+
+Usage: ntp-wait [-OPTIONS [-MORE_OPTIONS]] [--] [PROGRAM_ARG1 ...]
+
+The following single-character options are accepted:
+ With arguments: -n -s
+ Boolean (without arguments): -v
+
+Options may be merged together. -- stops processing of options.
+Space is not required between options and their arguments.
+ [Now continuing due to backward compatibility and excessive paranoia.
+ See ``perldoc Getopt::Std'' about $Getopt::Std::STANDARD_HELP_VERSION.]
+@end example
+@exampleindent 4
+
+@node ntp-wait
+@subsection option (-v)
+@cindex ntp-wait-
+
+This is the ``be verbose'' option.
+By default, ntp-wait is silent. With this option, ntp-wait
+will provide status information.
--- /dev/null
+.Dd June 14 2011
+.Dt NTP_WAIT 1 User Commands
+.Os FreeBSD 6.4-STABLE
+.\" EDIT THIS FILE WITH CAUTION (ntp-wait-opts.mdoc)
+.\"
+.\" It has been AutoGen-ed June 14, 2011 at 09:07:43 AM by AutoGen 5.11.10pre10
+.\" 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.
+.sp
+The maximum number of times we will check ntpd to see if it
+has been able to synchronize and stabilize the system clock.
+The default is 100 times.
+.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.
+.sp
+We will sleep for secs-between-tries after each query of ntpd
+that returns "the time is not yet stable".
+The default is 6 seconds.
+.It \-v ", " -\-
+Be verbose.
+.sp
+By default, ntp-wait is silent. With this option, ntp-wait
+will provide status information.
+.It \-? , " \-\-help"
+Display usage information and exit.
+.It \-! , " \-\-more-help"
+Pass the extended usage information through a pager.
+.It \- " [{\fIv|c|n\fP}]," " \-\-version" "[=\fI{v|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
+.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
+Successful program execution.
+.It 1
+The operation failed or the command syntax was not valid.
+.El
+.Sh AUTHORS
+.An "Harlan Stenn"
+.Sh "COPYRIGHT"
+Copyright (C) 1970-2011 The University of Delaware, David L. Mills, and/or others 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@ntp.org
+.Sh "NOTES"
+This manual page was \fIAutoGen\fP-erated from the \fBntp-wait\fP
+option definitions.
--- /dev/null
+<html lang="en">
+<head>
+<title>Ntp-wait User's Manual</title>
+<meta http-equiv="Content-Type" content="text/html">
+<meta name="description" content="Ntp-wait User's Manual">
+<meta name="generator" content="makeinfo 4.8">
+<link title="Top" rel="top" href="#Top">
+<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
+<meta http-equiv="Content-Style-Type" content="text/css">
+<style type="text/css"><!--
+ pre.display { font-family:inherit }
+ pre.format { font-family:inherit }
+ pre.smalldisplay { font-family:inherit; font-size:smaller }
+ pre.smallformat { font-family:inherit; font-size:smaller }
+ pre.smallexample { font-size:smaller }
+ pre.smalllisp { font-size:smaller }
+ span.sc { font-variant:small-caps }
+ span.roman { font-family:serif; font-weight:normal; }
+ span.sansserif { font-family:sans-serif; font-weight:normal; }
+--></style>
+</head>
+<body>
+<h1 class="settitle">Ntp-wait User's Manual</h1>
+<div class="node">
+<p><hr>
+<a name="Top"></a>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait-Description">ntp-wait Description</a>,
+Previous: <a rel="previous" accesskey="p" href="#dir">(dir)</a>,
+Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
+
+</div>
+
+<h2 class="unnumbered">Simple Network Time Protocol User Manual</h2>
+
+<p>This document describes the use of the NTP Project's <code>ntp-wait</code> program,
+that can be used to query a Network Time Protocol (NTP) server and
+display the time offset of the system clock relative to the server
+clock. Run as root, it can correct the system clock to this offset as
+well. It can be run as an interactive command or from a cron job.
+
+ <p>This document applies to version {No value for `VERSION'} of <code>ntp-wait</code>.
+
+ <p>The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
+IETF specification.
+
+ <div class="shortcontents">
+<h2>Short Contents</h2>
+<ul>
+<a href="#Top">Simple Network Time Protocol User Manual</a>
+</ul>
+</div>
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002dwait-Description">ntp-wait Description</a>: Description
+<li><a accesskey="2" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>: Invoking ntp-wait
+<li><a accesskey="3" href="#Usage">Usage</a>: Usage
+</ul>
+
+<div class="node">
+<p><hr>
+<a name="ntp-wait-Description"></a>
+<a name="ntp_002dwait-Description"></a>
+
+
+</div>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Description</h3>
+
+<p>By default, <code>ntp-wait</code> writes the local data and time (i.e., not UTC) to the
+standard output in the format:
+
+<pre class="example"> 1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
+</pre>
+ <p>where
+YYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time,
+(+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC),
+and
+the +4.567 +/- 0.089 secs indicates the time offset and
+error bound of the system clock relative to the server clock.
+
+<div class="node">
+<p><hr>
+<a name="ntp-wait-Invocation"></a>
+<a name="ntp_002dwait-Invocation"></a>
+
+
+</div>
+
+<h3 class="section">Invoking ntp-wait</h3>
+
+<p><a name="index-ntp_002dwait-1"></a><a name="index-Wait-for-ntpd-to-stabilize-the-system-clock-2"></a>
+
+ <p>This section was generated by <strong>AutoGen</strong>,
+the aginfo template and the option descriptions for the <samp><span class="command">ntp-wait</span></samp> program. It documents the <samp><span class="command">ntp-wait</span></samp> usage text and option meanings.
+
+ <p>This software is released under a specialized copyright license.
+
+<ul class="menu">
+<li><a accesskey="1" href="#ntp_002dwait-usage">ntp-wait usage</a>: ntp-wait usage help (-?)
+<li><a accesskey="2" href="#ntp_002dwait">ntp-wait </a>: option (-n)
+<li><a accesskey="3" href="#ntp_002dwait">ntp-wait </a>: option (-s)
+<li><a accesskey="4" href="#ntp_002dwait">ntp-wait </a>: option (-v)
+</ul>
+
+<div class="node">
+<p><hr>
+<a name="ntp-wait-usage"></a>
+<a name="ntp_002dwait-usage"></a>
+Next: <a rel="next" accesskey="n" href="#ntp_002dwait">ntp-wait</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
+</div>
+
+<h4 class="subsection">ntp-wait usage help (-?)</h4>
+
+<p><a name="index-ntp_002dwait-usage-3"></a>
+This is the automatically generated usage text for ntp-wait:
+
+<pre class="example">/home/stenn/ntp-dev/A.psp-fb2/scripts/ntp-wait version [unknown] calling Getopt::Std::getopts (version 1.06 [paranoid]),
+running under Perl version 5.8.9.
+
+Usage: ntp-wait [-OPTIONS [-MORE_OPTIONS]] [--] [PROGRAM_ARG1 ...]
+
+The following single-character options are accepted:
+ With arguments: -n -s
+ Boolean (without arguments): -v
+
+Options may be merged together. -- stops processing of options.
+Space is not required between options and their arguments.
+ [Now continuing due to backward compatibility and excessive paranoia.
+ See ``perldoc Getopt::Std'' about $Getopt::Std::STANDARD_HELP_VERSION.]
+</pre>
+ <div class="node">
+<p><hr>
+<a name="ntp-wait"></a>
+<a name="ntp_002dwait"></a>
+Previous: <a rel="previous" accesskey="p" href="#ntp_002dwait">ntp-wait</a>,
+Up: <a rel="up" accesskey="u" href="#ntp_002dwait-Invocation">ntp-wait Invocation</a>
+
+</div>
+
+<h4 class="subsection">option (-v)</h4>
+
+<p><a name="index-ntp_002dwait_002d-4"></a>
+This is the “be verbose” option.
+By default, ntp-wait is silent. With this option, ntp-wait
+will provide status information.
+
+<div class="node">
+<p><hr>
+<a name="Usage"></a>
+
+
+</div>
+
+<!-- node-name, next, previous, up -->
+<h3 class="section">Usage</h3>
+
+<p>The simplest use of this program is as an unprivileged command to
+check the current time, offset, and error in the local clock.
+For example:
+
+<pre class="example"> ntp-wait ntpserver.somewhere
+</pre>
+ <p>With suitable privilege, it can be run as a command or in a
+<code>crom</code> job to reset the local clock from a reliable server, like
+the <code>ntpdate</code> and <code>rdate</code> commands.
+For example:
+
+<pre class="example"> ntp-wait -a ntpserver.somewhere
+</pre>
+ </body></html>
+
--- /dev/null
+\input texinfo @c -*-texinfo-*-
+@c %**start of header
+@setfilename ntp-wait.info
+@settitle Ntp-wait User's Manual
+@include include/version.texi
+@paragraphindent 2
+@c %**end of header
+
+@ifinfo
+This file documents the use ntp-wait,
+a program from
+the NTP Project
+that is used to wait until @code{ntpd} has been able to
+synchronize and stabilize the time on the current host.
+@end ifinfo
+
+@direntry
+* ntp-wait: (ntp-wait). Wait for ntpd to synchronize and stabilize the system clock.
+@end direntry
+
+@titlepage
+@title ntp-wait User's Manual
+@subtitle ntp-wait, version @value{VERSION}, @value{UPDATED}
+@c @author Max @email{foo@ntp.org}
+@end titlepage
+
+@c @page
+@c @vskip 0pt plus 1filll
+
+@node Top, ntp-wait Description, (dir), (dir)
+@top Simple Network Time Protocol User Manual
+
+This document describes the use of the NTP Project's @code{ntp-wait} program,
+that can be used to query a Network Time Protocol (NTP) server and
+display the time offset of the system clock relative to the server
+clock. Run as root, it can correct the system clock to this offset as
+well. It can be run as an interactive command or from a cron job.
+
+This document applies to version @value{VERSION} of @code{ntp-wait}.
+
+The program implements the SNTP protocol as defined by RFC 5905, the NTPv4
+IETF specification.
+
+@shortcontents
+
+@menu
+* ntp-wait Description:: Description
+* ntp-wait Invocation:: Invoking ntp-wait
+* Usage:: Usage
+@end menu
+
+@node ntp-wait Description
+@comment node-name, next, previous, up
+@section Description
+
+By default, @code{ntp-wait} writes the local data and time (i.e., not UTC) to the
+standard output in the format:
+
+@example
+1996-10-15 20:17:25.123 (+0800) +4.567 +/- 0.089 secs
+@end example
+
+where
+YYYY-MM-DD HH:MM:SS.SUBSEC is the local date and time,
+(+0800) is the local timezone adjustment (so we would add 8 hours and 0 minutes to convert the reported local time to UTC),
+and
+the +4.567 +/- 0.089 secs indicates the time offset and
+error bound of the system clock relative to the server clock.
+
+@include ntp-wait-opts.texi
+
+@node Usage
+@comment node-name, next, previous, up
+@section Usage
+
+The simplest use of this program is as an unprivileged command to
+check the current time, offset, and error in the local clock.
+For example:
+
+@example
+ntp-wait ntpserver.somewhere
+@end example
+
+With suitable privilege, it can be run as a command or in a
+@code{crom} job to reset the local clock from a reliable server, like
+the @code{ntpdate} and @code{rdate} commands.
+For example:
+
+@example
+ntp-wait -a ntpserver.somewhere
+@end example
projects / thirdparty / ntp.git / commitdiff
