From: Harlan Stenn Date: Sat, 21 Dec 2013 10:12:36 +0000 (+0000) Subject: More build cleanup around Oliver's GSoC project X-Git-Tag: NTP_4_2_7P402~2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=2e7aca53921f050a5a31560418b1f22a69336b87;p=thirdparty%2Fntp.git More build cleanup around Oliver's GSoC project bk: 52b56994TEjJFPKC1wXRJt82Gue4vw --- diff --git a/scripts/Makefile.am b/scripts/Makefile.am index cf4194276..c1389cfdf 100644 --- a/scripts/Makefile.am +++ b/scripts/Makefile.am @@ -35,7 +35,11 @@ install-data-local: install-html EXTRA_DIST = \ deprecated \ monitoring \ + plot_summary-opts \ + plot_summary-opts.def \ rc \ + summary-opts \ + summary-opts.def \ stats \ $(NULL) diff --git a/scripts/calc_tickadj/Makefile.am b/scripts/calc_tickadj/Makefile.am index 3c3b275a4..c7294205f 100644 --- a/scripts/calc_tickadj/Makefile.am +++ b/scripts/calc_tickadj/Makefile.am @@ -8,14 +8,23 @@ libexec_SCRIPTS= $(CALC_TICKADJ_DL) sbin_SCRIPTS= $(CALC_TICKADJ_DS) EXTRA_SCRIPTS= calc_tickadj +manpage_HACK= if WANT_CALC_TICKADJ_MS man_MANS= calc_tickadj.$(CALC_TICKADJ_MS) +else +manpage_HACK+= calc_tickadj. +# Note that if we don't WANT_CALC_TICKADJ then CALC_TICKADJ_MS will +# be empty. But we still need the .texi and other files to be built, as +# they are general prerequisites. +# The manpage_HACK is listed in noinst_DATA so that takes care of these. endif EXTRA_DIST = \ calc_tickadj.in \ calc_tickadj.1calc_tickadjman \ calc_tickadj.1calc_tickadjmdoc \ + calc_tickadj.man.in \ + calc_tickadj.mdoc.in \ calc_tickadj.texi \ calc_tickadj.html \ calc_tickadj-opts.def \ @@ -25,7 +34,6 @@ EXTRA_DIST = \ $(NULL) noinst_DATA = \ - calc_tickadj.in \ calc_tickadj.1calc_tickadjman \ calc_tickadj.1calc_tickadjmdoc \ calc_tickadj.texi \ @@ -34,6 +42,7 @@ noinst_DATA = \ calc_tickadj-opts \ invoke-calc_tickadj.texi \ invoke-calc_tickadj.menu \ + $(manpage_HACK) \ $(NULL) calc_tickadj: $(srcdir)/calc_tickadj-opts @@ -41,12 +50,6 @@ calc_tickadj: $(srcdir)/calc_tickadj-opts $(srcdir)/calc_tickadj-opts: $(srcdir)/calc_tickadj-opts.def $(srcdir)/../../sntp/ag-tpl/perlopt.tpl $(run_ag) calc_tickadj-opts.def -clean-local: extra-clean - -extra-clean: - rm calc_tickadj - rm *.html *man *mdoc *.1 invoke-calc_tickadj.* calc_tickadj.*.in - ### Nroff $(srcdir)/calc_tickadj.1calc_tickadjman: $(srcdir)/calc_tickadj-opts.def $(std_def_list) @@ -76,7 +79,7 @@ calc_tickadj.$(CALC_TICKADJ_MS): $(srcdir)/calc_tickadj.$(MANTAGFMT).in $(top_bu $(srcdir)/invoke-calc_tickadj.menu: $(srcdir)/invoke-calc_tickadj.texi @: do-nothing action to avoid default SCCS get, .menu built with .texi -$(srcdir)/invoke-calc_tickadj.texi: calc_tickadj $(srcdir)/calc_tickadj-opts.def $(std_def_list) +$(srcdir)/invoke-calc_tickadj.texi: $(srcdir)/calc_tickadj-opts $(srcdir)/calc_tickadj-opts.def $(std_def_list) $(run_ag) -Tagtexi-cmd.tpl -DLEVEL=section calc_tickadj-opts.def $(top_srcdir)/scripts/build/check--help $@ diff --git a/scripts/calc_tickadj/calc_tickadj.man.in b/scripts/calc_tickadj/calc_tickadj.man.in new file mode 100644 index 000000000..5615dda93 --- /dev/null +++ b/scripts/calc_tickadj/calc_tickadj.man.in @@ -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/invoke-calc_tickadj.texi b/scripts/calc_tickadj/invoke-calc_tickadj.texi index 99d51bb99..4ad1a3333 100644 --- a/scripts/calc_tickadj/invoke-calc_tickadj.texi +++ b/scripts/calc_tickadj/invoke-calc_tickadj.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-calc_tickadj.texi) # -# It has been AutoGen-ed December 19, 2013 at 07:48:41 AM by AutoGen 5.18.3pre7 +# It has been AutoGen-ed December 19, 2013 at 11:28:34 AM by AutoGen 5.18.3pre7 # From the definitions calc_tickadj-opts.def # and the template file agtexi-cmd.tpl @end ignore diff --git a/scripts/lib/Makefile.am b/scripts/lib/Makefile.am index f57bc3406..d7c0c0e2c 100644 --- a/scripts/lib/Makefile.am +++ b/scripts/lib/Makefile.am @@ -2,4 +2,4 @@ perllibdir = @PERLLIBDIR@ nobase_perllib_DATA = NTP/Util.pm -EXTRA_DIST = ${perllib_DATA} +EXTRA_DIST = ${nobase_perllib_DATA} diff --git a/scripts/ntp-wait/Makefile.am b/scripts/ntp-wait/Makefile.am index 07c3c059c..109f44ea1 100644 --- a/scripts/ntp-wait/Makefile.am +++ b/scripts/ntp-wait/Makefile.am @@ -12,30 +12,33 @@ run_ag= cd $(srcdir) && env PATH="$(abs_builddir):$(PATH)" PERL5LIB="$(abs_top_ EXTRA_SCRIPTS = ntp-wait -EXTRA_DIST = \ - $(srcdir)/ntp-wait.in \ - $(srcdir)/ntp-wait.1ntp-waitman \ - $(srcdir)/ntp-wait.1ntp-waitmdoc \ - $(srcdir)/ntp-wait.texi \ - $(srcdir)/ntp-wait.html \ - $(srcdir)/ntp-wait-opts.def \ - $(srcdir)/ntp-wait-opts \ - $(srcdir)/invoke-ntp-wait.texi \ - $(srcdir)/invoke-ntp-wait.menu \ +EXTRA_DIST = \ + ntp-wait.in \ + ntp-wait.1ntp-waitman \ + ntp-wait.1ntp-waitmdoc \ + ntp-wait.man.in \ + ntp-wait.mdoc.in \ + ntp-wait.texi \ + ntp-wait.html \ + ntp-wait-opts.def \ + ntp-wait-opts \ + invoke-ntp-wait.texi \ + invoke-ntp-wait.menu \ $(NULL) html_DATA = $(srcdir)/ntp-wait.html -noinst_DATA = \ - $(srcdir)/ntp-wait.in \ - $(srcdir)/ntp-wait.1ntp-waitman \ - $(srcdir)/ntp-wait.1ntp-waitmdoc \ - $(srcdir)/ntp-wait.texi \ - $(srcdir)/ntp-wait.html \ - $(srcdir)/ntp-wait-opts.def \ - $(srcdir)/ntp-wait-opts \ - $(srcdir)/invoke-ntp-wait.texi \ - $(srcdir)/invoke-ntp-wait.menu \ +noinst_DATA = \ + ntp-wait.1ntp-waitman \ + ntp-wait.1ntp-waitmdoc \ + ntp-wait.man.in \ + ntp-wait.mdoc.in \ + ntp-wait.texi \ + ntp-wait.html \ + ntp-wait-opts.def \ + ntp-wait-opts \ + invoke-ntp-wait.texi \ + invoke-ntp-wait.menu \ $(NULL) ntp-wait: $(srcdir)/ntp-wait-opts @@ -43,12 +46,6 @@ ntp-wait: $(srcdir)/ntp-wait-opts $(srcdir)/ntp-wait-opts: $(srcdir)/ntp-wait-opts.def ../../sntp/ag-tpl/perlopt.tpl $(run_ag) ntp-wait-opts.def -clean-local: extra-clean - -extra-clean: - rm ntp-wait - rm *.html *man *mdoc *.1 invoke-ntp-wait.* ntp-wait.man.in - ### Nroff $(srcdir)/ntp-wait.1ntp-waitman: $(srcdir)/ntp-wait-opts.def $(std_def_list) @@ -78,7 +75,7 @@ ntp-wait.$(NTP_WAIT_MS): $(srcdir)/ntp-wait.$(MANTAGFMT).in $(top_builddir)/conf $(srcdir)/invoke-ntp-wait.menu: $(srcdir)/invoke-ntp-wait.texi @: do-nothing action to avoid default SCCS get, .menu built with .texi -$(srcdir)/invoke-ntp-wait.texi: ntp-wait $(srcdir)/ntp-wait-opts.def $(std_def_list) +$(srcdir)/invoke-ntp-wait.texi: ntp-wait-opts $(srcdir)/ntp-wait-opts.def $(std_def_list) $(run_ag) -Tagtexi-cmd.tpl -DLEVEL=section ntp-wait-opts.def $(top_srcdir)/scripts/build/check--help $@ diff --git a/scripts/ntp-wait/invoke-ntp-wait.texi b/scripts/ntp-wait/invoke-ntp-wait.texi index f5c8f42b3..1f44ba5af 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 December 19, 2013 at 07:48:46 AM by AutoGen 5.18.3pre7 +# It has been AutoGen-ed December 19, 2013 at 11:28:37 AM by AutoGen 5.18.3pre7 # From the definitions ntp-wait-opts.def # and the template file agtexi-cmd.tpl @end ignore diff --git a/scripts/ntpsweep/Makefile.am b/scripts/ntpsweep/Makefile.am index 32837e261..04fb40ec7 100644 --- a/scripts/ntpsweep/Makefile.am +++ b/scripts/ntpsweep/Makefile.am @@ -5,77 +5,75 @@ run_ag= cd $(srcdir) && env PATH="$(abs_builddir):$(PATH)" PERL5LIB="$(abs_top_ noinst_SCRIPTS = ntpsweep -EXTRA_DIST = \ - $(srcdir)/ntpsweep.in \ - $(srcdir)/ntpsweep.1ntpsweepman \ - $(srcdir)/ntpsweep.1ntpsweepmdoc \ - $(srcdir)/ntpsweep.texi \ - $(srcdir)/ntpsweep.html \ - $(srcdir)/ntpsweep-opts.def \ - $(srcdir)/ntpsweep-opts \ - $(srcdir)/invoke-ntpsweep.texi \ - $(srcdir)/invoke-ntpsweep.menu \ +EXTRA_DIST = \ + ntpsweep.in \ + ntpsweep.1ntpsweepman \ + ntpsweep.1ntpsweepmdoc \ + ntpsweep.man.in \ + ntpsweep.mdoc.in \ + ntpsweep.texi \ + ntpsweep.html \ + ntpsweep-opts.def \ + ntpsweep-opts \ + invoke-ntpsweep.texi \ + invoke-ntpsweep.menu \ $(NULL) -html_DATA = $(srcdir)/ntpsweep.html - -noinst_DATA = \ - $(srcdir)/ntpsweep.in \ - $(srcdir)/ntpsweep.1ntpsweepman \ - $(srcdir)/ntpsweep.1ntpsweepmdoc \ - $(srcdir)/ntpsweep.texi \ - $(srcdir)/ntpsweep.html \ - $(srcdir)/ntpsweep-opts.def \ - $(srcdir)/ntpsweep-opts \ - $(srcdir)/invoke-ntpsweep.texi \ - $(srcdir)/invoke-ntpsweep.menu \ +html_DATA = ntpsweep.html + +noinst_DATA = \ + ntpsweep.1 \ + ntpsweep.1ntpsweepman \ + ntpsweep.1ntpsweepmdoc \ + ntpsweep.man.in \ + ntpsweep.mdoc.in \ + ntpsweep.texi \ + ntpsweep.html \ + ntpsweep-opts.def \ + ntpsweep-opts \ + invoke-ntpsweep.texi \ + invoke-ntpsweep.menu \ $(NULL) ntpsweep: $(srcdir)/ntpsweep-opts -$(srcdir)/ntpsweep-opts: $(srcdir)/ntpsweep-opts.def ../../sntp/ag-tpl/perlopt.tpl +$(srcdir)/ntpsweep-opts: ntpsweep-opts.def ../../sntp/ag-tpl/perlopt.tpl $(run_ag) ntpsweep-opts.def -clean-local: extra-clean - -extra-clean: - rm ntpsweep - rm *.html *man *mdoc *.1 invoke-ntpsweep.* ntpsweep.man.in - ### Nroff -$(srcdir)/ntpsweep.1ntpsweepman: $(srcdir)/ntpsweep-opts.def $(std_def_list) +$(srcdir)/ntpsweep.1ntpsweepman: ntpsweep-opts.def $(std_def_list) $(run_ag) -DMAN_SECTION=1ntpsweepman -Tagman-cmd.tpl ntpsweep-opts.def -$(srcdir)/ntpsweep.man.in: $(srcdir)/ntpsweep.1ntpsweepman $(top_srcdir)/sntp/scripts/mansec2subst.sed +$(srcdir)/ntpsweep.man.in: ntpsweep.1ntpsweepman $(top_srcdir)/sntp/scripts/mansec2subst.sed sed -f $(top_srcdir)/sntp/scripts/mansec2subst.sed $(srcdir)/ntpsweep.1ntpsweepman > $(srcdir)/ntpsweep.man.in+ mv $(srcdir)/ntpsweep.man.in+ $(srcdir)/ntpsweep.man.in ### Mdoc -$(srcdir)/ntpsweep.1ntpsweepmdoc: $(srcdir)/ntpsweep-opts.def $(std_def_list) +$(srcdir)/ntpsweep.1ntpsweepmdoc: ntpsweep-opts.def $(std_def_list) $(run_ag) -DMAN_SECTION=1ntpsweepmdoc -Tagmdoc-cmd.tpl ntpsweep-opts.def -$(srcdir)/ntpsweep.mdoc.in: $(srcdir)/ntpsweep.1ntpsweepmdoc $(top_srcdir)/sntp/scripts/mansec2subst.sed +$(srcdir)/ntpsweep.mdoc.in: ntpsweep.1ntpsweepmdoc $(top_srcdir)/sntp/scripts/mansec2subst.sed sed -f $(top_srcdir)/sntp/scripts/mansec2subst.sed $(srcdir)/ntpsweep.1ntpsweepmdoc > $(srcdir)/ntpsweep.mdoc.in+ mv $(srcdir)/ntpsweep.mdoc.in+ $(srcdir)/ntpsweep.mdoc.in ### Manpage -ntpsweep.1: $(srcdir)/ntpsweep.$(MANTAGFMT).in $(top_builddir)/config.status +ntpsweep.1: ntpsweep.$(MANTAGFMT).in $(top_builddir)/config.status $(top_builddir)/config.status --file=ntpsweep.1+:$(srcdir)/ntpsweep.$(MANTAGFMT).in mv ntpsweep.1+ ntpsweep.1 ### Texinfo -$(srcdir)/invoke-ntpsweep.menu: $(srcdir)/invoke-ntpsweep.texi +$(srcdir)/invoke-ntpsweep.menu: invoke-ntpsweep.texi @: do-nothing action to avoid default SCCS get, .menu built with .texi -$(srcdir)/invoke-ntpsweep.texi: ntpsweep $(srcdir)/ntpsweep-opts.def $(std_def_list) +$(srcdir)/invoke-ntpsweep.texi: ntpsweep-opts ntpsweep-opts.def $(std_def_list) $(run_ag) -Tagtexi-cmd.tpl -DLEVEL=section ntpsweep-opts.def $(top_srcdir)/scripts/build/check--help $@ ### HTML -$(srcdir)/ntpsweep.html: $(srcdir)/invoke-ntpsweep.menu $(srcdir)/invoke-ntpsweep.texi $(srcdir)/ntpsweep.texi $(top_srcdir)/sntp/include/version.texi +$(srcdir)/ntpsweep.html: invoke-ntpsweep.menu invoke-ntpsweep.texi ntpsweep.texi $(top_srcdir)/sntp/include/version.texi cd $(srcdir) && ( makeinfo --force --html --no-split -I ../sntp -o ntpsweep.html ntpsweep.texi || true ) diff --git a/scripts/ntpsweep/invoke-ntpsweep.texi b/scripts/ntpsweep/invoke-ntpsweep.texi index 5ccc2af51..801bdd81e 100644 --- a/scripts/ntpsweep/invoke-ntpsweep.texi +++ b/scripts/ntpsweep/invoke-ntpsweep.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntpsweep.texi) # -# It has been AutoGen-ed December 19, 2013 at 07:48:51 AM by AutoGen 5.18.3pre7 +# It has been AutoGen-ed December 19, 2013 at 11:28:40 AM by AutoGen 5.18.3pre7 # From the definitions ntpsweep-opts.def # and the template file agtexi-cmd.tpl @end ignore diff --git a/scripts/ntpsweep/ntpsweep.man.in b/scripts/ntpsweep/ntpsweep.man.in new file mode 100644 index 000000000..c71badcce --- /dev/null +++ b/scripts/ntpsweep/ntpsweep.man.in @@ -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/ntptrace/Makefile.am b/scripts/ntptrace/Makefile.am index fe484b455..79a807e2f 100644 --- a/scripts/ntptrace/Makefile.am +++ b/scripts/ntptrace/Makefile.am @@ -1,3 +1,4 @@ +NULL= man_MANS= ntptrace.$(NTPTRACE_MS) bin_SCRIPTS = $(NTPTRACE_DB) @@ -10,41 +11,39 @@ run_ag= cd $(srcdir) && env PATH="$(abs_builddir):$(PATH)" PERL5LIB="$(abs_top_ EXTRA_SCRIPTS = ntptrace -EXTRA_DIST = \ - $(srcdir)/ntptrace.in \ - $(srcdir)/ntptrace.1ntptraceman \ - $(srcdir)/ntptrace.1ntptracemdoc \ - $(srcdir)/ntptrace.texi \ - $(srcdir)/ntptrace.html \ - $(srcdir)/ntptrace-opts.def \ - $(srcdir)/ntptrace-opts \ - $(srcdir)/invoke-ntptrace.texi \ - $(srcdir)/invoke-ntptrace.menu +EXTRA_DIST = \ + ntptrace.1ntptraceman \ + ntptrace.1ntptracemdoc \ + ntptrace.mdoc.in \ + ntptrace.man.in \ + ntptrace.texi \ + ntptrace.html \ + ntptrace-opts.def \ + ntptrace-opts \ + invoke-ntptrace.texi \ + invoke-ntptrace.menu \ + $(NULL) html_DATA = $(srcdir)/ntptrace.html -noinst_DATA = \ - $(srcdir)/ntptrace.in \ - $(srcdir)/ntptrace.1ntptraceman \ - $(srcdir)/ntptrace.1ntptracemdoc \ - $(srcdir)/ntptrace.texi \ - $(srcdir)/ntptrace.html \ - $(srcdir)/ntptrace-opts.def \ - $(srcdir)/ntptrace-opts \ - $(srcdir)/invoke-ntptrace.texi \ - $(srcdir)/invoke-ntptrace.menu +noinst_DATA = \ + ntptrace.1ntptraceman \ + ntptrace.1ntptracemdoc \ + ntptrace.mdoc.in \ + ntptrace.man.in \ + ntptrace.texi \ + ntptrace.html \ + ntptrace-opts.def \ + ntptrace-opts \ + invoke-ntptrace.texi \ + invoke-ntptrace.menu \ + $(NULL) ntptrace: $(srcdir)/ntptrace-opts $(srcdir)/ntptrace-opts: $(srcdir)/ntptrace-opts.def ../../sntp/ag-tpl/perlopt.tpl $(run_ag) ntptrace-opts.def -clean-local: extra-clean - -extra-clean: - rm ntptrace - rm *.html *man *mdoc *.1 invoke-ntptrace.* ntptrace.man.in - ### Nroff $(srcdir)/ntptrace.1ntptraceman: $(srcdir)/ntptrace-opts.def $(std_def_list) @@ -74,7 +73,7 @@ ntptrace.$(NTPTRACE_MS): $(srcdir)/ntptrace.$(MANTAGFMT).in $(top_builddir)/conf $(srcdir)/invoke-ntptrace.menu: $(srcdir)/invoke-ntptrace.texi @: do-nothing action to avoid default SCCS get, .menu built with .texi -$(srcdir)/invoke-ntptrace.texi: ntptrace $(srcdir)/ntptrace-opts.def $(std_def_list) +$(srcdir)/invoke-ntptrace.texi: ntptrace-opts $(srcdir)/ntptrace-opts.def $(std_def_list) $(run_ag) -Tagtexi-cmd.tpl -DLEVEL=section ntptrace-opts.def $(top_srcdir)/scripts/build/check--help $@ diff --git a/scripts/ntptrace/invoke-ntptrace.texi b/scripts/ntptrace/invoke-ntptrace.texi index bf523ffcc..366e0995d 100644 --- a/scripts/ntptrace/invoke-ntptrace.texi +++ b/scripts/ntptrace/invoke-ntptrace.texi @@ -6,7 +6,7 @@ # # EDIT THIS FILE WITH CAUTION (invoke-ntptrace.texi) # -# It has been AutoGen-ed December 19, 2013 at 07:48:56 AM by AutoGen 5.18.3pre7 +# It has been AutoGen-ed December 19, 2013 at 11:28:45 AM by AutoGen 5.18.3pre7 # From the definitions ntptrace-opts.def # and the template file agtexi-cmd.tpl @end ignore diff --git a/scripts/ntptrace/ntptrace.man.in b/scripts/ntptrace/ntptrace.man.in new file mode 100644 index 000000000..3cf7f4de6 --- /dev/null +++ b/scripts/ntptrace/ntptrace.man.in @@ -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 @NTPTRACE_MS@ "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.