From: Harlan Stenn Date: Wed, 18 Dec 2013 11:09:54 +0000 (+0000) Subject: updates X-Git-Tag: NTP_4_2_7P402~6 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bd3734c112d2e2751a205e11a553b67389987633;p=thirdparty%2Fntp.git updates bk: 52b18282gqP5z5cTPOfVxi9_J8xVXQ --- diff --git a/configure.ac b/configure.ac index dec54e786..033dd5cdd 100644 --- a/configure.ac +++ b/configure.ac @@ -4267,17 +4267,17 @@ AC_CONFIG_FILES([util/Makefile]) perllibdir="${datadir}/ntp/lib" AC_DEFINE_DIR([PERLLIBDIR], [perllibdir], [data dir]) -calc_tickadj_opts="scripts/calc_tickadj/calc_tickadj-opts" +calc_tickadj_opts="$srcdir/scripts/calc_tickadj/calc_tickadj-opts" AC_SUBST_FILE([calc_tickadj_opts]) -ntp_wait_opts="scripts/ntp-wait/ntp-wait-opts" +ntp_wait_opts="$srcdir/scripts/ntp-wait/ntp-wait-opts" AC_SUBST_FILE([ntp_wait_opts]) -ntpsweep_opts="scripts/ntpsweep/ntpsweep-opts" +ntpsweep_opts="$srcdir/scripts/ntpsweep/ntpsweep-opts" AC_SUBST_FILE([ntpsweep_opts]) -ntptrace_opts="scripts/ntptrace/ntptrace-opts" +ntptrace_opts="$srcdir/scripts/ntptrace/ntptrace-opts" AC_SUBST_FILE([ntptrace_opts]) -summary_opts="scripts/summary-opts" +summary_opts="$srcdir/scripts/summary-opts" AC_SUBST_FILE([summary_opts]) -plot_summary_opts="scripts/plot_summary-opts" +plot_summary_opts="$srcdir/scripts/plot_summary-opts" AC_SUBST_FILE([plot_summary_opts]) AC_CONFIG_SUBDIRS([sntp]) diff --git a/scripts/calc_tickadj/calc_tickadj.1calc_tickadjman b/scripts/calc_tickadj/calc_tickadj.1calc_tickadjman new file mode 100644 index 000000000..5615dda93 --- /dev/null +++ b/scripts/calc_tickadj/calc_tickadj.1calc_tickadjman @@ -0,0 +1,103 @@ +.de1 NOP +. it 1 an-trap +. if \\n[.$] \,\\$*\/ +.. +.ie t \ +.ds B-Font [CB] +.ds I-Font [CI] +.ds R-Font [CR] +.el \ +.ds B-Font B +.ds I-Font I +.ds R-Font R +.TH calc_tickadj 1calc_tickadjman "16 Dec 2013" "" "User Commands" +.\" +.\" EDIT THIS FILE WITH CAUTION (in-mem file) +.\" +.\" It has been AutoGen-ed December 16, 2013 at 09:07:36 PM by AutoGen 5.18.3pre7 +.\" From the definitions calc_tickadj-opts.def +.\" and the template file agman-cmd.tpl +.SH NAME +\f\*[B-Font]calc_tickadj\fP +\- Calculates optimal value for tick given ntp drift file. +.SH SYNOPSIS +\f\*[B-Font]calc_tickadj\fP +.\" 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[]]] +.sp \n(Ppu +.ne 2 + +All arguments must be options. +.sp \n(Ppu +.ne 2 + +.SH DESCRIPTION +The \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal +tick value. Generally, ntpd can do better job if the drift value is the +smallest possible number. +.sp +The example output of +.br +.in +4 +.nf +$ ./calc_tickadj +81.699 (drift) +9999 usec; 9999779 nsec +$ cat /etc/ntp/drift +-23.159 +.in -4 +.fi +.sp +means the following. If tick on that box is 10,000, by making the value 9999 +we'll shift the box from its current drift of \-23.159 to a drift of 81.699, and +in doing so we'll speed the clock up a little every second instead of slowing +the clock down a little. +.sp +If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift +value will be somewhere around 0.0. +.sp +\fBcalc_tickadj\fP tries to determine the the tick value by using +\fBtickadj\fP program from ntp package. If this doesn't work you can specify +current tick manually on command line. +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-drift\-file\f[]=\f\*[I-Font]string\f[] +Ntp drift file to use. +The default +\f\*[I-Font]string\f[] +for this option is: +.ti +4 + /etc/ntp/drift +.sp +Use the specified drift file for calculations +.TP +.NOP \f\*[B-Font]\-t\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-tick\f[]=\f\*[I-Font]number\f[] +Tick value of this host. +This option takes an integer number as its argument. +.sp +The current tick which to adjustment will be calculated +.TP +.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[] +Pass the extended usage information through a pager. +.PP +.SH "EXIT STATUS" +One of the following exit values will be returned: +.TP +.NOP 0 " (EXIT_SUCCESS)" +Successful program execution. +.TP +.NOP 1 " (EXIT_FAILURE)" +The operation failed or the command syntax was not valid. +.TP +.NOP 70 " (EX_SOFTWARE)" +libopts had an internal operational error. Please report +it to autogen-users@lists.sourceforge.net. Thank you. +.PP +.SH "NOTES" +This manual page was \fIAutoGen\fP-erated from the \fBcalc_tickadj\fP +option definitions. diff --git a/scripts/calc_tickadj/calc_tickadj.1calc_tickadjmdoc b/scripts/calc_tickadj/calc_tickadj.1calc_tickadjmdoc new file mode 100644 index 000000000..603a72e52 --- /dev/null +++ b/scripts/calc_tickadj/calc_tickadj.1calc_tickadjmdoc @@ -0,0 +1,80 @@ +.Dd December 16 2013 +.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands +.Os FreeBSD 6.4-STABLE +.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) +.\" +.\" It has been AutoGen-ed December 16, 2013 at 09:07:38 PM by AutoGen 5.18.3pre7 +.\" From the definitions calc_tickadj-opts.def +.\" and the template file agmdoc-cmd.tpl +.Sh NAME +.Nm calc_tickadj +.Nd Calculates "optimal" value for tick given ntp drift file. +.Sh SYNOPSIS +.Nm +.\" Mixture of short (flag) options and long options +.Op Fl flags +.Op Fl flag Op Ar value +.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc +.Pp +All arguments must be options. +.Pp +.Sh DESCRIPTION +The \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal +tick value. Generally, ntpd can do better job if the drift value is the +smallest possible number. +.sp +The example output of +.Bd -literal -offset indent +$ ./calc_tickadj +81.699 (drift) +9999 usec; 9999779 nsec +$ cat /etc/ntp/drift +-23.159 +.Ed +.sp +means the following. If tick on that box is 10,000, by making the value 9999 +we'll shift the box from its current drift of \-23.159 to a drift of 81.699, and +in doing so we'll speed the clock up a little every second instead of slowing +the clock down a little. +.sp +If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift +value will be somewhere around 0.0. +.sp +\fBcalc_tickadj\fP tries to determine the the tick value by using +\fBtickadj\fP program from ntp package. If this doesn't work you can specify +current tick manually on command line. +.Sh "OPTIONS" +.Bl -tag +.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string +Ntp drift file to use. +The default +.Ar string +for this option is: +.ti +4 + /etc/ntp/drift +.sp +Use the specified drift file for calculations +.It Fl t Ar number , Fl \-tick Ns = Ns Ar number +Tick value of this host. +This option takes an integer number as its argument. +.sp +The current tick which to adjustment will be calculated +.It Fl \&? , Fl \-help +Display usage information and exit. +.It Fl \&! , Fl \-more\-help +Pass the extended usage information through a pager. +.El +.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@lists.sourceforge.net. Thank you. +.El +.Sh "NOTES" +This manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP +option definitions. diff --git a/scripts/calc_tickadj/calc_tickadj.html b/scripts/calc_tickadj/calc_tickadj.html new file mode 100644 index 000000000..9a072fff6 --- /dev/null +++ b/scripts/calc_tickadj/calc_tickadj.html @@ -0,0 +1,178 @@ + + +calc_tickadj User's Manual + + + + + + + + + +

calc_tickadj User's Manual

+
+ +

+Next: , +Previous: (dir), +Up: (dir) + +
+ +

calc_tickadj User's Manual

+ +

This document describes the use of the NTP Project's calc_tickadj program. +This document applies to version 4.2.7p401 of calc_tickadj. + +

+

Short Contents

+ +
+ + + +
+ + +

+Previous: calc_tickadj Description, +Up: Top + +
+ +

Invoking calc_tickadj

+ +

+The calc_tickadj script uses provided ntp drift file to generate optimal +tick value. Generally, ntpd can do better job if the drift value is the +smallest possible number. + +

The example output of +

     $ ./calc_tickadj
+     81.699 (drift)
+     9999 usec; 9999779 nsec
+     $ cat /etc/ntp/drift
+     -23.159
+
+

means the following. If tick on that box is 10,000, by making the value 9999 +we'll shift the box from its current drift of -23.159 to a drift of 81.699, and +in doing so we'll speed the clock up a little every second instead of slowing +the clock down a little. + +

If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift +value will be somewhere around 0.0. + +

calc_tickadj tries to determine the the tick value by using +tickadj program from ntp package. If this doesn't work you can specify +current tick manually on command line. + +

This section was generated by AutoGen, +using the agtexi-cmd template and the option descriptions for the calc_tickadj program. + +

+ +
+ + +

+Next: , +Up: calc_tickadj Invocation + +
+ +

calc_tickadj help/usage (--help)

+ +

+This is the automatically generated usage text for calc_tickadj. + +

The text printed is the same whether selected with the help option +(--help) or the more-help option (--more-help). more-help will print +the usage text by passing it through a pager program. +more-help is disabled on platforms without a working +fork(2) function. The PAGER environment variable is +used to select the program, defaulting to more. Both will exit +with a status code of 0. + +

calc_tickadj - Calculates "optimal" value for tick given ntp drift file.
+USAGE: calc_tickadj [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
+
+    -d, --drift-file=str         Ntp drift file to use
+    -t, --tick=num               Tick value of this host
+    -?, --help                   Display usage information and exit
+      , --more-help              Pass the extended usage information through a pager
+
+Options are specified by doubled hyphens and their name or by a single
+hyphen and the flag character.
+
+
+ + +

+Next: , +Previous: calc_tickadj usage, +Up: calc_tickadj Invocation + +
+ +

drift-file option (-d)

+ +

+This is the “ntp drift file to use” option. +This option takes a string argument. +Use the specified drift file for calculations +

+ + +

+Next: , +Previous: calc_tickadj drift-file, +Up: calc_tickadj Invocation + +
+ +

tick option (-t)

+ +

+This is the “tick value of this host” option. +This option takes a number argument. +The current tick which to adjustment will be calculated +

+ + +

+Previous: calc_tickadj tick, +Up: calc_tickadj Invocation + +
+ +

calc_tickadj exit status

+ +

One of the following exit values will be returned: +

+
‘0 (EXIT_SUCCESS)’
Successful program execution. +
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. +
+ + + diff --git a/scripts/calc_tickadj/calc_tickadj.mdoc.in b/scripts/calc_tickadj/calc_tickadj.mdoc.in new file mode 100644 index 000000000..603a72e52 --- /dev/null +++ b/scripts/calc_tickadj/calc_tickadj.mdoc.in @@ -0,0 +1,80 @@ +.Dd December 16 2013 +.Dt CALC_TICKADJ 1calc_tickadjmdoc User Commands +.Os FreeBSD 6.4-STABLE +.\" EDIT THIS FILE WITH CAUTION (calc_tickadj-opts.mdoc) +.\" +.\" It has been AutoGen-ed December 16, 2013 at 09:07:38 PM by AutoGen 5.18.3pre7 +.\" From the definitions calc_tickadj-opts.def +.\" and the template file agmdoc-cmd.tpl +.Sh NAME +.Nm calc_tickadj +.Nd Calculates "optimal" value for tick given ntp drift file. +.Sh SYNOPSIS +.Nm +.\" Mixture of short (flag) options and long options +.Op Fl flags +.Op Fl flag Op Ar value +.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc +.Pp +All arguments must be options. +.Pp +.Sh DESCRIPTION +The \fBcalc_tickadj\fP script uses provided ntp drift file to generate optimal +tick value. Generally, ntpd can do better job if the drift value is the +smallest possible number. +.sp +The example output of +.Bd -literal -offset indent +$ ./calc_tickadj +81.699 (drift) +9999 usec; 9999779 nsec +$ cat /etc/ntp/drift +-23.159 +.Ed +.sp +means the following. If tick on that box is 10,000, by making the value 9999 +we'll shift the box from its current drift of \-23.159 to a drift of 81.699, and +in doing so we'll speed the clock up a little every second instead of slowing +the clock down a little. +.sp +If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift +value will be somewhere around 0.0. +.sp +\fBcalc_tickadj\fP tries to determine the the tick value by using +\fBtickadj\fP program from ntp package. If this doesn't work you can specify +current tick manually on command line. +.Sh "OPTIONS" +.Bl -tag +.It Fl d Ar string , Fl \-drift\-file Ns = Ns Ar string +Ntp drift file to use. +The default +.Ar string +for this option is: +.ti +4 + /etc/ntp/drift +.sp +Use the specified drift file for calculations +.It Fl t Ar number , Fl \-tick Ns = Ns Ar number +Tick value of this host. +This option takes an integer number as its argument. +.sp +The current tick which to adjustment will be calculated +.It Fl \&? , Fl \-help +Display usage information and exit. +.It Fl \&! , Fl \-more\-help +Pass the extended usage information through a pager. +.El +.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@lists.sourceforge.net. Thank you. +.El +.Sh "NOTES" +This manual page was \fIAutoGen\fP\-erated from the \fBcalc_tickadj\fP +option definitions. diff --git a/scripts/calc_tickadj/invoke-calc_tickadj.menu b/scripts/calc_tickadj/invoke-calc_tickadj.menu new file mode 100644 index 000000000..865a0d72d --- /dev/null +++ b/scripts/calc_tickadj/invoke-calc_tickadj.menu @@ -0,0 +1 @@ +* calc_tickadj Invocation:: Invoking calc_tickadj diff --git a/scripts/calc_tickadj/invoke-calc_tickadj.texi b/scripts/calc_tickadj/invoke-calc_tickadj.texi new file mode 100644 index 000000000..39c42397c --- /dev/null +++ b/scripts/calc_tickadj/invoke-calc_tickadj.texi @@ -0,0 +1,102 @@ +@node calc_tickadj Invocation +@section Invoking calc_tickadj +@pindex calc_tickadj +@cindex Calculates "optimal" value for tick given ntp drift file. +@ignore +# +# EDIT THIS FILE WITH CAUTION (invoke-calc_tickadj.texi) +# +# It has been AutoGen-ed December 17, 2013 at 09:24:47 AM by AutoGen 5.18.3pre7 +# From the definitions calc_tickadj-opts.def +# and the template file agtexi-cmd.tpl +@end ignore + +The @code{calc_tickadj} script uses provided ntp drift file to generate optimal +tick value. Generally, ntpd can do better job if the drift value is the +smallest possible number. + +The example output of +@example +$ ./calc_tickadj +81.699 (drift) +9999 usec; 9999779 nsec +$ cat /etc/ntp/drift +-23.159 +@end example + +means the following. If tick on that box is 10,000, by making the value 9999 +we'll shift the box from its current drift of -23.159 to a drift of 81.699, and +in doing so we'll speed the clock up a little every second instead of slowing +the clock down a little. + +If 'tick' on that box is 10,000,000 then by setting it to 9999779 the drift +value will be somewhere around 0.0. + +@code{calc_tickadj} tries to determine the the tick value by using +@code{tickadj} program from ntp package. If this doesn't work you can specify +current tick manually on command line. + + +This section was generated by @strong{AutoGen}, +using the @code{agtexi-cmd} template and the option descriptions for the @code{calc_tickadj} program. + +@menu +* calc_tickadj usage:: calc_tickadj help/usage (@option{--help}) +* calc_tickadj drift-file:: drift-file option (-d) +* calc_tickadj tick:: tick option (-t) +* calc_tickadj exit status:: exit status +@end menu + +@node calc_tickadj usage +@subsection calc_tickadj help/usage (@option{--help}) +@cindex calc_tickadj help + +This is the automatically generated usage text for calc_tickadj. + +The text printed is the same whether selected with the @code{help} option +(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print +the usage text by passing it through a pager program. +@code{more-help} is disabled on platforms without a working +@code{fork(2)} function. The @code{PAGER} environment variable is +used to select the program, defaulting to @file{more}. Both will exit +with a status code of 0. + +@exampleindent 0 +@example +calc_tickadj - Calculates "optimal" value for tick given ntp drift file. +USAGE: calc_tickadj [ - [] | --[@{=| @}] ]... + + -d, --drift-file=str Ntp drift file to use + -t, --tick=num Tick value of this host + -?, --help Display usage information and exit + , --more-help Pass the extended usage information through a pager + +Options are specified by doubled hyphens and their name or by a single +hyphen and the flag character. +@end example +@exampleindent 4 + +@node calc_tickadj drift-file +@subsection drift-file option (-d) +@cindex calc_tickadj-drift-file + +This is the ``ntp drift file to use'' option. +This option takes a string argument. +Use the specified drift file for calculations +@node calc_tickadj tick +@subsection tick option (-t) +@cindex calc_tickadj-tick + +This is the ``tick value of this host'' option. +This option takes a number argument. +The current tick which to adjustment will be calculated +@node calc_tickadj exit status +@subsection calc_tickadj exit status + +One of the following exit values will be returned: +@table @samp +@item 0 (EXIT_SUCCESS) +Successful program execution. +@item 1 (EXIT_FAILURE) +The operation failed or the command syntax was not valid. +@end table diff --git a/scripts/ntp-wait/invoke-ntp-wait.texi b/scripts/ntp-wait/invoke-ntp-wait.texi index 12fecfc28..0ea4ac5e1 100644 --- a/scripts/ntp-wait/invoke-ntp-wait.texi +++ b/scripts/ntp-wait/invoke-ntp-wait.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntp-wait.texi) # -# It has been AutoGen-ed November 30, 2013 at 11:24:42 AM by AutoGen 5.18.3pre5 +# It has been AutoGen-ed December 18, 2013 at 10:49:43 AM by AutoGen 5.18.3pre7 # From the definitions ntp-wait-opts.def # and the template file agtexi-cmd.tpl @end ignore @@ -28,17 +28,18 @@ has not yet produced a synchronized and stable system clock. will do this quietly, unless the @code{-v} flag is provided. +This can be useful at boot time, to delay the boot sequence until after +@kbd{ntpd} @kbd{-g} +has set the time. This section was generated by @strong{AutoGen}, using the @code{agtexi-cmd} template and the option descriptions for the @code{ntp-wait} program. -This software is released under the NTP license, . @menu * ntp-wait usage:: ntp-wait help/usage (@option{--help}) -* ntp-wait :: option (-n) -* ntp-wait :: option (-s) -* ntp-wait :: option (-v) -* ntp-wait config:: presetting/configuring ntp-wait +* ntp-wait tries:: tries option (-n) +* ntp-wait sleep:: sleep option (-s) +* ntp-wait verbose:: verbose option (-v) * ntp-wait exit status:: exit status * ntp-wait Authors:: Authors * ntp-wait Notes:: Notes @@ -60,76 +61,43 @@ with a status code of 0. @exampleindent 0 @example -/deacon/backroom/snaps/ntp-dev/A.snap/scripts/ntp-wait version [unknown] calling Getopt::Std::getopts (version 1.05 [paranoid]), -running under Perl version 5.8.8. +ntp-wait - Wait for ntpd to stabilize the system clock +USAGE: ntp-wait [ - [] | --[@{=| @}] ]... -Usage: ntp-wait [-OPTIONS [-MORE_OPTIONS]] [--] [PROGRAM_ARG1 ...] + -n, --tries=num Number of times to check ntpd + -s, --sleep=num How long to sleep between tries + -v, --verbose Be verbose + -?, --help Display usage information and exit + , --more-help Pass the extended usage information through a pager -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.] +Options are specified by doubled hyphens and their name or by a single +hyphen and the flag character. @end example @exampleindent 4 -@node ntp-wait -@subsection option (-n) -@cindex ntp-wait- +@node ntp-wait tries +@subsection tries option (-n) +@cindex ntp-wait-tries This is the ``number of times to check ntpd'' option. -This option takes a number argument @file{num-tries}. -The maximum number of times we will check @code{ntpd} to see if -it has been able to synchronize and stabilize the system clock. -@node ntp-wait -@subsection option (-s) -@cindex ntp-wait- +This option takes a number argument. + The maximum number of times we will check @code{ntpd} to see if + it has been able to synchronize and stabilize the system clock. +@node ntp-wait sleep +@subsection sleep option (-s) +@cindex ntp-wait-sleep This is the ``how long to sleep between tries'' option. This option takes a number argument @file{secs-between-tries}. -We will sleep for @file{secs-between-tries} after each query -of @code{ntpd} that returns "the time is not yet stable". -@node ntp-wait -@subsection option (-v) -@cindex ntp-wait- + We will sleep for @file{secs-between-tries} after each query + of @code{ntpd} that returns "the time is not yet stable". +@node ntp-wait verbose +@subsection verbose option (-v) +@cindex ntp-wait-verbose This is the ``be verbose'' option. -By default, @code{ntp-wait} is silent. -With this option, @code{ntp-wait} will provide status information. - - -@node ntp-wait config -@subsection presetting/configuring ntp-wait - -Any option that is not marked as @i{not presettable} may be preset by -loading values from environment variables named @code{NTP-WAIT} and @code{NTP-WAIT_}. @code{} must be one of -the options listed above in upper case and segmented with underscores. -The @code{NTP-WAIT} variable will be tokenized and parsed like -the command line. The remaining variables are tested for existence and their -values are treated like option arguments. - - -The command line options relating to configuration and/or usage help are: - -@subsubheading version (-) - -Print the program version to standard out, optionally with licensing -information, then exit 0. The optional argument specifies how much licensing -detail to provide. The default is to print just the version. The licensing infomation may be selected with an option argument. -Only the first letter of the argument is examined: - -@table @samp -@item version -Only print the version. This is the default. -@item copyright -Name the copyright usage licensing terms. -@item verbose -Print the full copyright usage licensing terms. -@end table - + By default, @code{ntp-wait} is silent. + With this option, @code{ntp-wait} will provide status information. @node ntp-wait exit status @subsection ntp-wait exit status diff --git a/scripts/ntp-wait/ntp-wait.html b/scripts/ntp-wait/ntp-wait.html index 9bde6cb60..2328bae0b 100644 --- a/scripts/ntp-wait/ntp-wait.html +++ b/scripts/ntp-wait/ntp-wait.html @@ -3,7 +3,7 @@ Ntp-wait User's Manual - + @@ -14,23 +14,23 @@ 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.sc { font-variant:small-caps } + span.roman { font-family:serif; font-weight:normal; } + span.sansserif { font-family:sans-serif; font-weight:normal; } -->

Ntp-wait User's Manual

+

-Next: , +Next: , Previous: (dir), Up: (dir) -
-
-

Simple Network Time Protocol User Manual

+ -

This document describes the use of the NTP Project's ntp-wait program. +

This document describes the use of the NTP Project's ntp-wait program.

If there are time-sensitive applications, the proper sequence of events is to @@ -46,7 +46,6 @@ accurate and stable time.

Short Contents

@@ -56,25 +55,14 @@ accurate and stable time.
+ +

- -
-
- -

Description

-

The ntp-wait program blocks until ntpd is in synchronized state. -This can be useful at boot time, to delay the boot sequence until after -ntpd -g has set the time. - -

-

- -
-

Invoking ntp-wait

+

0.1 Invoking ntp-wait

@@ -92,167 +80,147 @@ has not yet produced a synchronized and stable system clock.

ntp-wait will do this quietly, unless the -v -flag is provided. +flag is provided. +This can be useful at boot time, to delay the boot sequence until after +ntpd -g +has set the time.

This section was generated by AutoGen, -using the agtexi-cmd template and the option descriptions for the ntp-wait program. -This software is released under the NTP license, <http://ntp.org/license>. +using the agtexi-cmd template and the option descriptions for the ntp-wait program.

+ +

-Next: , +Next: , Up: ntp-wait Invocation -
+
-

ntp-wait help/usage (--help)

+

0.1.1 ntp-wait help/usage (--help)

This is the automatically generated usage text for ntp-wait.

The text printed is the same whether selected with the help option -(--help) or the more-help option (--more-help). more-help will print +(--help) or the more-help option (--more-help). more-help will print the usage text by passing it through a pager program. more-help is disabled on platforms without a working fork(2) function. The PAGER environment variable is -used to select the program, defaulting to more. Both will exit +used to select the program, defaulting to more. Both will exit with a status code of 0. -

/deacon/backroom/snaps/ntp-dev/A.snap/scripts/ntp-wait version [unknown] calling Getopt::Std::getopts (version 1.05 [paranoid]),
-running under Perl version 5.8.8.
-
-Usage: ntp-wait [-OPTIONS [-MORE_OPTIONS]] [--] [PROGRAM_ARG1 ...]
+
ntp-wait - Wait for ntpd to stabilize the system clock
+USAGE: ntp-wait [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
 
-The following single-character options are accepted:
-        With arguments: -n -s
-        Boolean (without arguments): -v
+    -n, --tries=num              Number of times to check ntpd
+    -s, --sleep=num              How long to sleep between tries
+    -v, --verbose                Be verbose
+    -?, --help                   Display usage information and exit
+      , --more-help              Pass the extended usage information through a pager
 
-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.]
+Options are specified by doubled hyphens and their name or by a single
+hyphen and the flag character.
 

   

+
+
 

-Next: ,
-Previous: ntp-wait,
+Next: ,
+Previous: ntp-wait usage,
 Up: ntp-wait Invocation
-

+
 

 
-
option (-n)

+
0.1.2 tries option (-n)

 
-

+

 This is the “number of times to check ntpd” option. 
-This option takes a number argument num-tries. 
-The maximum number of times we will check ntpd to see if
-it has been able to synchronize and stabilize the system clock. 
+This option takes a number argument. 
+        The maximum number of times we will check ntpd to see if
+        it has been able to synchronize and stabilize the system clock. 
 

+
+
 

-Next: ,
-Previous: ntp-wait,
+Next: ,
+Previous: ntp-wait tries,
 Up: ntp-wait Invocation
-

+
 

 
-
option (-s)

+
0.1.3 sleep option (-s)

 
-

+

 This is the “how long to sleep between tries” option. 
-This option takes a number argument secs-between-tries. 
-We will sleep for secs-between-tries after each query
-of ntpd that returns "the time is not yet stable". 
+This option takes a number argument secs-between-tries. 
+        We will sleep for secs-between-tries after each query
+        of ntpd that returns "the time is not yet stable". 
 

+
+
 

-Next: ,
-Previous: ntp-wait,
+Next: ,
+Previous: ntp-wait sleep,
 Up: ntp-wait Invocation
-

+
 

 
-
option (-v)

+
0.1.4 verbose option (-v)

 
-

+

 This is the “be verbose” option. 
-By default, ntp-wait is silent. 
-With this option, ntp-wait will provide status information.
-
+        By default, ntp-wait is silent. 
+        With this option, ntp-wait will provide status information. 
 

+
+
 

-Next: ,
-Previous: ntp-wait,
+Next: ,
+Previous: ntp-wait verbose,
 Up: ntp-wait Invocation
-

-

-
-
presetting/configuring ntp-wait

-
-
Any option that is not marked as not presettable may be preset by
-loading values from environment variables named NTP-WAIT and NTP-WAIT_<OPTION_NAME>.  <OPTION_NAME> must be one of
-the options listed above in upper case and segmented with underscores. 
-The NTP-WAIT variable will be tokenized and parsed like
-the command line.  The remaining variables are tested for existence and their
-values are treated like option arguments.
 
-  
The command line options relating to configuration and/or usage help are:
-
-
version (-)

-
-
Print the program version to standard out, optionally with licensing
-information, then exit 0.  The optional argument specifies how much licensing
-detail to provide.  The default is to print just the version.  The licensing infomation may be selected with an option argument. 
-Only the first letter of the argument is examined:
-
-     

-
version
Only print the version.  This is the default. 
-
copyright
Name the copyright usage licensing terms. 
-
verbose
Print the full copyright usage licensing terms. 
-

-
-

-

-Next: ,
-Previous: ntp-wait config,
-Up: ntp-wait Invocation
-

 

 
-
ntp-wait exit status

+
0.1.5 ntp-wait exit status

 
 
One of the following exit values will be returned:
      

-
0 (EXIT_SUCCESS)
Successful program execution. 
-
1 (EXIT_FAILURE)
The operation failed or the command syntax was not valid. 
+
‘0 (EXIT_SUCCESS)’
Successful program execution. 
+
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. 
 

   

+
+
 

-Next: ,
+Next: ,
 Previous: ntp-wait exit status,
 Up: ntp-wait Invocation
-

+
 

 
-
ntp-wait Authors

+
0.1.6 ntp-wait Authors

 
 

+
+
 

-Previous: ntp-wait Authors,
+Previous: ntp-wait Authors,
 Up: ntp-wait Invocation
-

+
 

 
-
ntp-wait Notes

+
0.1.7 ntp-wait Notes

 
 
 
diff --git a/scripts/ntp-wait/ntp-wait.in b/scripts/ntp-wait/ntp-wait.in
index d856b4761..a7a40acb9 100644
--- a/scripts/ntp-wait/ntp-wait.in
+++ b/scripts/ntp-wait/ntp-wait.in
@@ -1,9 +1,11 @@
 #! @PATH_PERL@
+
 package ntp_wait;
 use 5.006_000;
 use strict;
 use warnings;
 use lib "@PERLLIBDIR@";
+use lib "@abs_top_srcdir@/scripts/lib";
 use NTP::Util qw(ntp_read_vars);
 
 exit run(@ARGV) unless caller;
diff --git a/scripts/ntpsweep/invoke-ntpsweep.menu b/scripts/ntpsweep/invoke-ntpsweep.menu
new file mode 100644
index 000000000..6a1faea64
--- /dev/null
+++ b/scripts/ntpsweep/invoke-ntpsweep.menu
@@ -0,0 +1 @@
+* ntpsweep Invocation::            Invoking ntpsweep
diff --git a/scripts/ntpsweep/invoke-ntpsweep.texi b/scripts/ntpsweep/invoke-ntpsweep.texi
new file mode 100644
index 000000000..a00399416
--- /dev/null
+++ b/scripts/ntpsweep/invoke-ntpsweep.texi
@@ -0,0 +1,118 @@
+@node ntpsweep Invocation
+@section Invoking ntpsweep
+@pindex ntpsweep
+@cindex Print various informations about given ntp servers
+@ignore
+#
+# EDIT THIS FILE WITH CAUTION  (invoke-ntpsweep.texi)
+#
+# It has been AutoGen-ed  December 18, 2013 at 10:51:05 AM by AutoGen 5.18.3pre7
+# From the definitions    ntpsweep-opts.def
+# and the template file   agtexi-cmd.tpl
+@end ignore
+
+@code{ntpsweep}
+prints per host the NTP stratum level, the clock offset in seconds, the daemon
+version, the operating system and the processor. Optionally recursing through
+all peers.
+
+This section was generated by @strong{AutoGen},
+using the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsweep} program.
+
+@menu
+* ntpsweep usage::                  ntpsweep help/usage (@option{--help})
+* ntpsweep host-list::              host-list option (-l)
+* ntpsweep peers::                  peers option (-p)
+* ntpsweep maxlevel::               maxlevel option (-m)
+* ntpsweep strip::                  strip option (-s)
+* ntpsweep host::                   host option (-h)
+* ntpsweep exit status::            exit status
+@end menu
+
+@node ntpsweep usage
+@subsection ntpsweep help/usage (@option{--help})
+@cindex ntpsweep help
+
+This is the automatically generated usage text for ntpsweep.
+
+The text printed is the same whether selected with the @code{help} option
+(@option{--help}) or the @code{more-help} option (@option{--more-help}).  @code{more-help} will print
+the usage text by passing it through a pager program.
+@code{more-help} is disabled on platforms without a working
+@code{fork(2)} function.  The @code{PAGER} environment variable is
+used to select the program, defaulting to @file{more}.  Both will exit
+with a status code of 0.
+
+@exampleindent 0
+@example
+ntpsweep - Print various informations about given ntp servers
+USAGE: ntpsweep [ - [] | --[@{=| @}] ]... [hostfile]
+
+    -l, --host-list=str          Host to execute actions on
+                                   - may appear multiple times
+    -p, --peers                  Recursively list all peers a host synchronizes to
+    -m, --maxlevel=num           Traverse peers up to this level (4 is a reasonable number)
+    -s, --strip=str              Strip this string from hostnames
+    -?, --help                   Display usage information and exit
+      , --more-help              Pass the extended usage information through a pager
+
+Options are specified by doubled hyphens and their name or by a single
+hyphen and the flag character.
+@end example
+@exampleindent 4
+
+@node ntpsweep host-list
+@subsection host-list option (-l)
+@cindex ntpsweep-host-list
+
+This is the ``host to execute actions on'' option.
+This option takes a string argument.
+
+@noindent
+This option has some usage constraints.  It:
+@itemize @bullet
+@item
+may appear an unlimited number of times.
+@end itemize
+
+            Use this option to specify the host on which this script operates.
+            May appear multiple times.
+@node ntpsweep peers
+@subsection peers option (-p)
+@cindex ntpsweep-peers
+
+This is the ``recursively list all peers a host synchronizes to'' option.
+This option has no @samp{doc} documentation.
+@node ntpsweep maxlevel
+@subsection maxlevel option (-m)
+@cindex ntpsweep-maxlevel
+
+This is the ``traverse peers up to this level (4 is a reasonable number)'' option.
+This option takes a number argument.
+This option has no @samp{doc} documentation.
+@node ntpsweep strip
+@subsection strip option (-s)
+@cindex ntpsweep-strip
+
+This is the ``strip this string from hostnames'' option.
+This option takes a string argument.
+This option has no @samp{doc} documentation.
+@node ntpsweep host
+@subsection host option (-h)
+@cindex ntpsweep-host
+
+This is the ``specify a single host'' option.
+This option takes a string argument.
+This option has no @samp{doc} documentation.
+
+@strong{NOTE}@strong{: THIS OPTION IS DEPRECATED}
+@node ntpsweep exit status
+@subsection ntpsweep exit status
+
+One of the following exit values will be returned:
+@table @samp
+@item 0 (EXIT_SUCCESS)
+Successful program execution.
+@item 1 (EXIT_FAILURE)
+The operation failed or the command syntax was not valid.
+@end table
diff --git a/scripts/ntpsweep/ntpsweep.1ntpsweepman b/scripts/ntpsweep/ntpsweep.1ntpsweepman
new file mode 100644
index 000000000..c71badcce
--- /dev/null
+++ b/scripts/ntpsweep/ntpsweep.1ntpsweepman
@@ -0,0 +1,92 @@
+.de1 NOP
+.  it 1 an-trap
+.  if \\n[.$] \,\\$*\/
+..
+.ie t \
+.ds B-Font [CB]
+.ds I-Font [CI]
+.ds R-Font [CR]
+.el \
+.ds B-Font B
+.ds I-Font I
+.ds R-Font R
+.TH ntpsweep 1ntpsweepman "29 Nov 2013" "ntp" "User Commands"
+.\"
+.\" EDIT THIS FILE WITH CAUTION (in-mem file)
+.\"
+.\" It has been AutoGen-ed November 29, 2013 at 06:39:25 AM by AutoGen 5.18.3pre5
+.\" From the definitions ntpsweep-opts.def
+.\" and the template file agman-cmd.tpl
+.SH NAME
+\f\*[B-Font]ntpsweep\fP
+\- Print various informations about given ntp servers
+.SH SYNOPSIS
+\f\*[B-Font]ntpsweep\fP
+.\" 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[]]]
+[hostfile]
+.sp \n(Ppu
+.ne 2
+
+.SH DESCRIPTION
+\f\*[B-Font]ntpsweep\fP
+prints per host the NTP stratum level, the clock offset in seconds, the daemon
+version, the operating system and the processor. Optionally recursing through
+all peers.
+.SH "OPTIONS"
+.TP
+.NOP \f\*[B-Font]\-l\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-host\-list\f[]=\f\*[I-Font]string\f[]
+Host to execute actions on.
+This option may appear an unlimited number of times.
+.sp
+            Use this option to specify the host on which this script operates.
+            May appear multiple times.
+.TP
+.NOP \f\*[B-Font]\-p\f[], \f\*[B-Font]\-\-peers\f[]
+Recursively list all peers a host synchronizes to.
+.sp
+This option has not been fully documented.
+.TP
+.NOP \f\*[B-Font]\-m\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-maxlevel\f[]=\f\*[I-Font]number\f[]
+Traverse peers up to this level (4 is a reasonable number).
+This option takes an integer number as its argument.
+.sp
+This option has not been fully documented.
+.TP
+.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-strip\f[]=\f\*[I-Font]string\f[]
+Strip this string from hostnames.
+.sp
+This option has not been fully documented.
+.TP
+.NOP \f\*[B-Font]\-h\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-host\f[]=\f\*[I-Font]string\f[]
+Specify a single host.
+.sp
+This option has not been fully documented.
+.sp
+.B
+NOTE: THIS OPTION IS DEPRECATED
+.TP
+.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
+Display usage information and exit.
+.TP
+.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
+Pass the extended usage information through a pager.
+.PP
+.SH "EXIT STATUS"
+One of the following exit values will be returned:
+.TP
+.NOP 0 " (EXIT_SUCCESS)"
+Successful program execution.
+.TP
+.NOP 1 " (EXIT_FAILURE)"
+The operation failed or the command syntax was not valid.
+.TP
+.NOP 70 " (EX_SOFTWARE)"
+libopts had an internal operational error.  Please report
+it to autogen-users@lists.sourceforge.net.  Thank you.
+.PP
+.SH "NOTES"
+This manual page was \fIAutoGen\fP-erated from the \fBntpsweep\fP
+option definitions.
diff --git a/scripts/ntpsweep/ntpsweep.1ntpsweepmdoc b/scripts/ntpsweep/ntpsweep.1ntpsweepmdoc
new file mode 100644
index 000000000..9f6cde554
--- /dev/null
+++ b/scripts/ntpsweep/ntpsweep.1ntpsweepmdoc
@@ -0,0 +1,71 @@
+.Dd November 29 2013
+.Dt NTPSWEEP 1ntpsweepmdoc User Commands
+.Os FreeBSD 6.4-STABLE
+.\"  EDIT THIS FILE WITH CAUTION  (ntpsweep-opts.mdoc)
+.\"
+.\"  It has been AutoGen-ed  November 29, 2013 at 06:39:26 AM by AutoGen 5.18.3pre5
+.\"  From the definitions    ntpsweep-opts.def
+.\"  and the template file   agmdoc-cmd.tpl
+.Sh NAME
+.Nm ntpsweep
+.Nd Print various informations about given ntp servers
+.Sh SYNOPSIS
+.Nm
+.\" Mixture of short (flag) options and long options
+.Op Fl flags
+.Op Fl flag Op Ar value
+.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
+[hostfile]
+.Pp
+.Sh DESCRIPTION
+.Nm 
+prints per host the NTP stratum level, the clock offset in seconds, the daemon
+version, the operating system and the processor. Optionally recursing through
+all peers.
+.Sh "OPTIONS"
+.Bl -tag
+.It  Fl l Ar string , Fl \-host\-list Ns = Ns Ar string 
+Host to execute actions on.
+This option may appear an unlimited number of times.
+.sp
+            Use this option to specify the host on which this script operates.
+            May appear multiple times.
+.It  Fl p , Fl \-peers 
+Recursively list all peers a host synchronizes to.
+.sp
+This option has not been fully documented.
+.It  Fl m Ar number , Fl \-maxlevel Ns = Ns Ar number 
+Traverse peers up to this level (4 is a reasonable number).
+This option takes an integer number as its argument.
+.sp
+This option has not been fully documented.
+.It  Fl s Ar string , Fl \-strip Ns = Ns Ar string 
+Strip this string from hostnames.
+.sp
+This option has not been fully documented.
+.It  Fl h Ar string , Fl \-host Ns = Ns Ar string 
+Specify a single host.
+.sp
+This option has not been fully documented.
+.sp
+.B
+NOTE: THIS OPTION IS DEPRECATED
+.It Fl \&? , Fl \-help
+Display usage information and exit.
+.It Fl \&! , Fl \-more\-help
+Pass the extended usage information through a pager.
+.El
+.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@lists.sourceforge.net.  Thank you.
+.El
+.Sh "NOTES"
+This manual page was \fIAutoGen\fP\-erated from the \fBntpsweep\fP
+option definitions.
diff --git a/scripts/ntpsweep/ntpsweep.html b/scripts/ntpsweep/ntpsweep.html
new file mode 100644
index 000000000..c2d01a8ad
--- /dev/null
+++ b/scripts/ntpsweep/ntpsweep.html
@@ -0,0 +1,212 @@
+
+
+ntpsweep User's Manual
+
+
+
+
+
+
+
+
+
+
ntpsweep User's Manual

+

+
+

+Next: ,
+Previous: (dir),
+Up: (dir)
+
+

+
+  
This document describes the use of the NTP Project's ntpsweep program.
+
+  
This document applies to version 4.2.7p401 of ntpsweep.
+
+  

+
Short Contents

+
    
+

+

+
+
+
+

+
+

+
+
+

+
+
0.1 Invoking ntpsweep

+
+

+ntpsweep
+prints per host the NTP stratum level, the clock offset in seconds, the daemon
+version, the operating system and the processor. Optionally recursing through
+all peers.
+
+  
This section was generated by AutoGen,
+using the agtexi-cmd template and the option descriptions for the ntpsweep program.
+
+

+
+

+
+

+Next: ,
+Up: ntpsweep Invocation
+
+

+
+
0.1.1 ntpsweep help/usage (--help)

+
+

+This is the automatically generated usage text for ntpsweep.
+
+  
The text printed is the same whether selected with the help option
+(--help) or the more-help option (--more-help).  more-help will print
+the usage text by passing it through a pager program. 
+more-help is disabled on platforms without a working
+fork(2) function.  The PAGER environment variable is
+used to select the program, defaulting to more.  Both will exit
+with a status code of 0.
+
+
ntpsweep - Print various informations about given ntp servers
+USAGE: ntpsweep [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [hostfile]
+
+    -l, --host-list=str          Host to execute actions on
+                                   - may appear multiple times
+    -p, --peers                  Recursively list all peers a host synchronizes to
+    -m, --maxlevel=num           Traverse peers up to this level (4 is a reasonable number)
+    -s, --strip=str              Strip this string from hostnames
+    -?, --help                   Display usage information and exit
+      , --more-help              Pass the extended usage information through a pager
+
+Options are specified by doubled hyphens and their name or by a single
+hyphen and the flag character.
+

+  

+
+
+

+Next: ,
+Previous: ntpsweep usage,
+Up: ntpsweep Invocation
+
+

+
+
0.1.2 host-list option (-l)

+
+

+This is the “host to execute actions on” option. 
+This option takes a string argument.
+
+
This option has some usage constraints.  It:
+     
    
+
  • may appear an unlimited number of times. 
+

+
+  
Use this option to specify the host on which this script operates. 
+            May appear multiple times. 
+

+
+

+Next: ,
+Previous: ntpsweep host-list,
+Up: ntpsweep Invocation
+
+

+
+
0.1.3 peers option (-p)

+
+

+This is the “recursively list all peers a host synchronizes to” option. 
+This option has no ‘doc’ documentation. 
+

+
+

+Next: ,
+Previous: ntpsweep peers,
+Up: ntpsweep Invocation
+
+

+
+
0.1.4 maxlevel option (-m)

+
+

+This is the “traverse peers up to this level (4 is a reasonable number)” option. 
+This option takes a number argument. 
+This option has no ‘doc’ documentation. 
+

+
+

+Next: ,
+Previous: ntpsweep maxlevel,
+Up: ntpsweep Invocation
+
+

+
+
0.1.5 strip option (-s)

+
+

+This is the “strip this string from hostnames” option. 
+This option takes a string argument. 
+This option has no ‘doc’ documentation. 
+

+
+

+Next: ,
+Previous: ntpsweep strip,
+Up: ntpsweep Invocation
+
+

+
+
0.1.6 host option (-h)

+
+

+This is the “specify a single host” option. 
+This option takes a string argument. 
+This option has no ‘doc’ documentation.
+
+  
NOTE: THIS OPTION IS DEPRECATED
+

+
+

+Previous: ntpsweep host,
+Up: ntpsweep Invocation
+
+

+
+
0.1.7 ntpsweep exit status

+
+
One of the following exit values will be returned:
+     

+
‘0 (EXIT_SUCCESS)’
Successful program execution. 
+
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. 
+

+
+
+
diff --git a/scripts/ntpsweep/ntpsweep.in b/scripts/ntpsweep/ntpsweep.in
index 54e13e997..4e640b3f2 100644
--- a/scripts/ntpsweep/ntpsweep.in
+++ b/scripts/ntpsweep/ntpsweep.in
@@ -17,10 +17,12 @@
 # products derived from this software without prior written permission.
 #
 # Hans Lambermont 
+
 package ntpsweep;
 use 5.006_000;
 use strict;
 use lib "@PERLLIBDIR@";
+use lib "@abs_top_srcdir@/scripts/lib";
 use NTP::Util qw(do_dns ntp_read_vars ntp_peers ntp_sntp_line);
 
 (my $program = $0) =~ s%.*/(.+?)(.pl)?$%$1%;
diff --git a/scripts/ntpsweep/ntpsweep.mdoc.in b/scripts/ntpsweep/ntpsweep.mdoc.in
index f6f176689..9f6cde554 100644
--- a/scripts/ntpsweep/ntpsweep.mdoc.in
+++ b/scripts/ntpsweep/ntpsweep.mdoc.in
@@ -1,9 +1,9 @@
-.Dd October 2 2013
+.Dd November 29 2013
 .Dt NTPSWEEP 1ntpsweepmdoc User Commands
 .Os FreeBSD 6.4-STABLE
 .\"  EDIT THIS FILE WITH CAUTION  (ntpsweep-opts.mdoc)
 .\"
-.\"  It has been AutoGen-ed  October  2, 2013 at 09:50:21 PM by AutoGen 5.18.1pre5
+.\"  It has been AutoGen-ed  November 29, 2013 at 06:39:26 AM by AutoGen 5.18.3pre5
 .\"  From the definitions    ntpsweep-opts.def
 .\"  and the template file   agmdoc-cmd.tpl
 .Sh NAME
diff --git a/scripts/ntptrace/invoke-ntptrace.menu b/scripts/ntptrace/invoke-ntptrace.menu
new file mode 100644
index 000000000..bea3b8b23
--- /dev/null
+++ b/scripts/ntptrace/invoke-ntptrace.menu
@@ -0,0 +1 @@
+* ntptrace Invocation::            Invoking ntptrace
diff --git a/scripts/ntptrace/invoke-ntptrace.texi b/scripts/ntptrace/invoke-ntptrace.texi
new file mode 100644
index 000000000..fa8d24cef
--- /dev/null
+++ b/scripts/ntptrace/invoke-ntptrace.texi
@@ -0,0 +1,109 @@
+@node ntptrace Invocation
+@section Invoking ntptrace
+@pindex ntptrace
+@cindex Trace peers of an NTP server
+@ignore
+#
+# EDIT THIS FILE WITH CAUTION  (invoke-ntptrace.texi)
+#
+# It has been AutoGen-ed  December 18, 2013 at 10:51:51 AM by AutoGen 5.18.3pre7
+# From the definitions    ntptrace-opts.def
+# and the template file   agtexi-cmd.tpl
+@end ignore
+
+@code{ntptrace} is a perl script that uses the ntpq utility program to follow
+the chain of NTP servers from a given host back to the primary time source. For
+ntptrace to work properly, each of these servers must implement the NTP Control
+and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
+
+If given no arguments, ntptrace starts with localhost. Here is an example of
+the output from ntptrace:
+
+@example
+% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
+server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
+stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
+@end example
+
+On each line, the fields are (left to right): the host name, the host stratum,
+the time offset between that host and the local host (as measured by
+@code{ntptrace}; this is why it is not always zero for "localhost"), the host
+synchronization distance, and (only for stratum-1 servers) the reference clock
+ID. All times are given in seconds. Note that the stratum is the server hop
+count to the primary source, while the synchronization distance is the
+estimated error relative to the primary source. These terms are precisely
+defined in RFC-1305.
+
+
+This section was generated by @strong{AutoGen},
+using the @code{agtexi-cmd} template and the option descriptions for the @code{ntptrace} program.
+
+@menu
+* ntptrace usage::                  ntptrace help/usage (@option{--help})
+* ntptrace numeric::                numeric option (-n)
+* ntptrace max-hosts::              max-hosts option (-m)
+* ntptrace host::                   host option (-r)
+* ntptrace exit status::            exit status
+@end menu
+
+@node ntptrace usage
+@subsection ntptrace help/usage (@option{--help})
+@cindex ntptrace help
+
+This is the automatically generated usage text for ntptrace.
+
+The text printed is the same whether selected with the @code{help} option
+(@option{--help}) or the @code{more-help} option (@option{--more-help}).  @code{more-help} will print
+the usage text by passing it through a pager program.
+@code{more-help} is disabled on platforms without a working
+@code{fork(2)} function.  The @code{PAGER} environment variable is
+used to select the program, defaulting to @file{more}.  Both will exit
+with a status code of 0.
+
+@exampleindent 0
+@example
+ntptrace - Trace peers of an NTP server
+USAGE: ntptrace [ - [] | --[@{=| @}] ]... [host]
+
+    -n, --numeric                Print IP addresses instead of hostnames
+    -m, --max-hosts=num          Maximum number of peers to trace
+    -r, --host=str               Single remote host
+    -?, --help                   Display usage information and exit
+      , --more-help              Pass the extended usage information through a pager
+
+Options are specified by doubled hyphens and their name or by a single
+hyphen and the flag character.
+@end example
+@exampleindent 4
+
+@node ntptrace numeric
+@subsection numeric option (-n)
+@cindex ntptrace-numeric
+
+This is the ``print ip addresses instead of hostnames'' option.
+Output hosts as dotted-quad numeric format rather than converting to
+the canonical host names.
+@node ntptrace max-hosts
+@subsection max-hosts option (-m)
+@cindex ntptrace-max-hosts
+
+This is the ``maximum number of peers to trace'' option.
+This option takes a number argument.
+This option has no @samp{doc} documentation.
+@node ntptrace host
+@subsection host option (-r)
+@cindex ntptrace-host
+
+This is the ``single remote host'' option.
+This option takes a string argument.
+This option has no @samp{doc} documentation.
+@node ntptrace exit status
+@subsection ntptrace exit status
+
+One of the following exit values will be returned:
+@table @samp
+@item 0 (EXIT_SUCCESS)
+Successful program execution.
+@item 1 (EXIT_FAILURE)
+The operation failed or the command syntax was not valid.
+@end table
diff --git a/scripts/ntptrace/ntptrace.1ntptraceman b/scripts/ntptrace/ntptrace.1ntptraceman
new file mode 100644
index 000000000..47b8594b8
--- /dev/null
+++ b/scripts/ntptrace/ntptrace.1ntptraceman
@@ -0,0 +1,109 @@
+.de1 NOP
+.  it 1 an-trap
+.  if \\n[.$] \,\\$*\/
+..
+.ie t \
+.ds B-Font [CB]
+.ds I-Font [CI]
+.ds R-Font [CR]
+.el \
+.ds B-Font B
+.ds I-Font I
+.ds R-Font R
+.TH ntptrace 1ntptraceman "29 Nov 2013" "" "User Commands"
+.\"
+.\" EDIT THIS FILE WITH CAUTION (in-mem file)
+.\"
+.\" It has been AutoGen-ed November 29, 2013 at 06:39:30 AM by AutoGen 5.18.3pre5
+.\" From the definitions ntptrace-opts.def
+.\" and the template file agman-cmd.tpl
+.SH NAME
+\f\*[B-Font]ntptrace\fP
+\- Trace peers of an NTP server
+.SH SYNOPSIS
+\f\*[B-Font]ntptrace\fP
+.\" 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[]]]
+[host]
+.sp \n(Ppu
+.ne 2
+
+.SH DESCRIPTION
+\fBntptrace\fP is a perl script that uses the ntpq utility program to follow
+the chain of NTP servers from a given host back to the primary time source. For
+ntptrace to work properly, each of these servers must implement the NTP Control
+and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
+.sp
+If given no arguments, ntptrace starts with localhost. Here is an example of
+the output from ntptrace:
+.sp
+.br
+.in +4
+.nf
+% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
+server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
+stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
+.in -4
+.fi
+.sp
+On each line, the fields are (left to right): the host name, the host stratum,
+the time offset between that host and the local host (as measured by
+\fBntptrace\fP; this is why it is not always zero for "localhost"), the host
+synchronization distance, and (only for stratum\-1 servers) the reference clock
+ID. All times are given in seconds. Note that the stratum is the server hop
+count to the primary source, while the synchronization distance is the
+estimated error relative to the primary source. These terms are precisely
+defined in RFC\-1305.
+.SH "OPTIONS"
+.TP
+.NOP \f\*[B-Font]\-n\f[], \f\*[B-Font]\-\-numeric\f[]
+Print IP addresses instead of hostnames.
+.sp
+Output hosts as dotted-quad numeric format rather than converting to
+the canonical host names.
+.TP
+.NOP \f\*[B-Font]\-m\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-max\-hosts\f[]=\f\*[I-Font]number\f[]
+Maximum number of peers to trace.
+This option takes an integer number as its argument.
+The default
+\f\*[I-Font]number\f[]
+for this option is:
+.ti +4
+ 99
+.sp
+This option has not been fully documented.
+.TP
+.NOP \f\*[B-Font]\-r\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-host\f[]=\f\*[I-Font]string\f[]
+Single remote host.
+The default
+\f\*[I-Font]string\f[]
+for this option is:
+.ti +4
+ 127.0.0.1
+.sp
+This option has not been fully documented.
+.TP
+.NOP \f\*[B-Font]\-\&?\f[], \f\*[B-Font]\-\-help\f[]
+Display usage information and exit.
+.TP
+.NOP \f\*[B-Font]\-\&!\f[], \f\*[B-Font]\-\-more-help\f[]
+Pass the extended usage information through a pager.
+.PP
+.SH "EXIT STATUS"
+One of the following exit values will be returned:
+.TP
+.NOP 0 " (EXIT_SUCCESS)"
+Successful program execution.
+.TP
+.NOP 1 " (EXIT_FAILURE)"
+The operation failed or the command syntax was not valid.
+.TP
+.NOP 70 " (EX_SOFTWARE)"
+libopts had an internal operational error.  Please report
+it to autogen-users@lists.sourceforge.net.  Thank you.
+.PP
+.SH "NOTES"
+This manual page was \fIAutoGen\fP-erated from the \fBntptrace\fP
+option definitions.
diff --git a/scripts/ntptrace/ntptrace.1ntptracemdoc b/scripts/ntptrace/ntptrace.1ntptracemdoc
new file mode 100644
index 000000000..ea9b24c94
--- /dev/null
+++ b/scripts/ntptrace/ntptrace.1ntptracemdoc
@@ -0,0 +1,87 @@
+.Dd November 29 2013
+.Dt NTPTRACE 1ntptracemdoc User Commands
+.Os FreeBSD 6.4-STABLE
+.\"  EDIT THIS FILE WITH CAUTION  (ntptrace-opts.mdoc)
+.\"
+.\"  It has been AutoGen-ed  November 29, 2013 at 06:39:32 AM by AutoGen 5.18.3pre5
+.\"  From the definitions    ntptrace-opts.def
+.\"  and the template file   agmdoc-cmd.tpl
+.Sh NAME
+.Nm ntptrace
+.Nd Trace peers of an NTP server
+.Sh SYNOPSIS
+.Nm
+.\" Mixture of short (flag) options and long options
+.Op Fl flags
+.Op Fl flag Op Ar value
+.Op Fl \-option\-name Ns Oo Oo Ns "=| " Oc Ns Ar value Oc
+[host]
+.Pp
+.Sh DESCRIPTION
+\fBntptrace\fP is a perl script that uses the ntpq utility program to follow
+the chain of NTP servers from a given host back to the primary time source. For
+ntptrace to work properly, each of these servers must implement the NTP Control
+and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
+.sp
+If given no arguments, ntptrace starts with localhost. Here is an example of
+the output from ntptrace:
+.sp
+.Bd -literal -offset indent
+% ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
+server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
+stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
+.Ed
+.sp
+On each line, the fields are (left to right): the host name, the host stratum,
+the time offset between that host and the local host (as measured by
+\fBntptrace\fP; this is why it is not always zero for "localhost"), the host
+synchronization distance, and (only for stratum\-1 servers) the reference clock
+ID. All times are given in seconds. Note that the stratum is the server hop
+count to the primary source, while the synchronization distance is the
+estimated error relative to the primary source. These terms are precisely
+defined in RFC\-1305.
+.Sh "OPTIONS"
+.Bl -tag
+.It  Fl n , Fl \-numeric 
+Print IP addresses instead of hostnames.
+.sp
+Output hosts as dotted\-quad numeric format rather than converting to
+the canonical host names.
+.It  Fl m Ar number , Fl \-max\-hosts Ns = Ns Ar number 
+Maximum number of peers to trace.
+This option takes an integer number as its argument.
+The default
+.Ar number
+for this option is:
+.ti +4
+ 99
+.sp
+This option has not been fully documented.
+.It  Fl r Ar string , Fl \-host Ns = Ns Ar string 
+Single remote host.
+The default
+.Ar string
+for this option is:
+.ti +4
+ 127.0.0.1
+.sp
+This option has not been fully documented.
+.It Fl \&? , Fl \-help
+Display usage information and exit.
+.It Fl \&! , Fl \-more\-help
+Pass the extended usage information through a pager.
+.El
+.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@lists.sourceforge.net.  Thank you.
+.El
+.Sh "NOTES"
+This manual page was \fIAutoGen\fP\-erated from the \fBntptrace\fP
+option definitions.
diff --git a/scripts/ntptrace/ntptrace.html b/scripts/ntptrace/ntptrace.html
new file mode 100644
index 000000000..5ed77ce0d
--- /dev/null
+++ b/scripts/ntptrace/ntptrace.html
@@ -0,0 +1,189 @@
+
+
+Ntptrace User's Manual
+
+
+
+
+
+
+
+
+
+
Ntptrace User's Manual

+

+
+

+Next: ,
+Previous: (dir),
+Up: (dir)
+
+

+
+
Simple Network Time Protocol User Manual

+
+
This document describes the use of the NTP Project's ntptrace program. 
+This document applies to version 4.2.7p401 of ntptrace.
+
+  

+
Short Contents

+
+

+
+
+
+

+
+

+Previous: ntptrace Description,
+Up: Top
+
+

+
+
Invoking ntptrace

+
+

+ntptrace is a perl script that uses the ntpq utility program to follow
+the chain of NTP servers from a given host back to the primary time source. For
+ntptrace to work properly, each of these servers must implement the NTP Control
+and Monitoring Protocol specified in RFC 1305 and enable NTP Mode 6 packets.
+
+  
If given no arguments, ntptrace starts with localhost. Here is an example of
+the output from ntptrace:
+
+
     % ntptrace localhost: stratum 4, offset 0.0019529, synch distance 0.144135
+     server2ozo.com: stratum 2, offset 0.0124263, synch distance 0.115784 usndh.edu:
+     stratum 1, offset 0.0019298, synch distance 0.011993, refid 'WWVB'
+

+  
On each line, the fields are (left to right): the host name, the host stratum,
+the time offset between that host and the local host (as measured by
+ntptrace; this is why it is not always zero for "localhost"), the host
+synchronization distance, and (only for stratum-1 servers) the reference clock
+ID. All times are given in seconds. Note that the stratum is the server hop
+count to the primary source, while the synchronization distance is the
+estimated error relative to the primary source. These terms are precisely
+defined in RFC-1305.
+
+  
This section was generated by AutoGen,
+using the agtexi-cmd template and the option descriptions for the ntptrace program.
+
+

+
+

+
+

+Next: ,
+Up: ntptrace Invocation
+
+

+
+
ntptrace help/usage (--help)

+
+

+This is the automatically generated usage text for ntptrace.
+
+  
The text printed is the same whether selected with the help option
+(--help) or the more-help option (--more-help).  more-help will print
+the usage text by passing it through a pager program. 
+more-help is disabled on platforms without a working
+fork(2) function.  The PAGER environment variable is
+used to select the program, defaulting to more.  Both will exit
+with a status code of 0.
+
+
ntptrace - Trace peers of an NTP server
+USAGE: ntptrace [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [host]
+
+    -n, --numeric                Print IP addresses instead of hostnames
+    -m, --max-hosts=num          Maximum number of peers to trace
+    -r, --host=str               Single remote host
+    -?, --help                   Display usage information and exit
+      , --more-help              Pass the extended usage information through a pager
+
+Options are specified by doubled hyphens and their name or by a single
+hyphen and the flag character.
+

+  

+
+

+Next: ,
+Previous: ntptrace usage,
+Up: ntptrace Invocation
+
+

+
+
numeric option (-n)

+
+

+This is the “print ip addresses instead of hostnames” option. 
+Output hosts as dotted-quad numeric format rather than converting to
+the canonical host names. 
+

+
+
+

+Next: ,
+Previous: ntptrace numeric,
+Up: ntptrace Invocation
+
+

+
+
max-hosts option (-m)

+
+

+This is the “maximum number of peers to trace” option. 
+This option takes a number argument. 
+This option has no ‘doc’ documentation. 
+

+
+

+Next: ,
+Previous: ntptrace max-hosts,
+Up: ntptrace Invocation
+
+

+
+
host option (-r)

+
+

+This is the “single remote host” option. 
+This option takes a string argument. 
+This option has no ‘doc’ documentation. 
+

+
+

+Previous: ntptrace host,
+Up: ntptrace Invocation
+
+

+
+
ntptrace exit status

+
+
One of the following exit values will be returned:
+     

+
‘0 (EXIT_SUCCESS)’
Successful program execution. 
+
‘1 (EXIT_FAILURE)’
The operation failed or the command syntax was not valid. 
+

+
+
+
diff --git a/scripts/ntptrace/ntptrace.in b/scripts/ntptrace/ntptrace.in
index dfb7c4868..f87572ed9 100755
--- a/scripts/ntptrace/ntptrace.in
+++ b/scripts/ntptrace/ntptrace.in
@@ -1,9 +1,11 @@
 #! @PATH_PERL@ -w
 # John Hay -- John.Hay@icomtek.csir.co.za / jhay@FreeBSD.org
+
 package ntptrace;
 use 5.006_000;
 use strict;
 use lib "@PERLLIBDIR@";
+use lib "@abs_top_srcdir@/scripts/lib";
 use NTP::Util qw(ntp_read_vars do_dns);
 
 exit run(@ARGV) unless caller;
diff --git a/scripts/ntptrace/ntptrace.mdoc.in b/scripts/ntptrace/ntptrace.mdoc.in
index 63908a7c6..0b60d9673 100644
--- a/scripts/ntptrace/ntptrace.mdoc.in
+++ b/scripts/ntptrace/ntptrace.mdoc.in
@@ -1,9 +1,9 @@
-.Dd October 2 2013
+.Dd November 29 2013
 .Dt NTPTRACE @NTPTRACE_MS@ User Commands
 .Os FreeBSD 6.4-STABLE
 .\"  EDIT THIS FILE WITH CAUTION  (ntptrace-opts.mdoc)
 .\"
-.\"  It has been AutoGen-ed  October  2, 2013 at 09:50:29 PM by AutoGen 5.18.1pre5
+.\"  It has been AutoGen-ed  November 29, 2013 at 06:39:32 AM by AutoGen 5.18.3pre5
 .\"  From the definitions    ntptrace-opts.def
 .\"  and the template file   agmdoc-cmd.tpl
 .Sh NAME