From: Harlan Stenn Date: Sun, 22 Dec 2013 10:28:11 +0000 (+0000) Subject: Create doc framework for summary and plot_summary X-Git-Tag: NTP_4_2_7P402~1 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=854c9db652d79ed76a85084ea35b24e497eaf9ec;p=thirdparty%2Fntp.git Create doc framework for summary and plot_summary bk: 52b6bebbA0J-UYZORq7D7vwwBjsU2A --- diff --git a/scripts/Makefile.am b/scripts/Makefile.am index c1389cfdf..d1b72916a 100644 --- a/scripts/Makefile.am +++ b/scripts/Makefile.am @@ -32,15 +32,50 @@ noinst_SCRIPTS = \ install-data-local: install-html -EXTRA_DIST = \ - deprecated \ - monitoring \ - plot_summary-opts \ - plot_summary-opts.def \ - rc \ - summary-opts \ - summary-opts.def \ - stats \ +EXTRA_DIST = \ + deprecated \ + monitoring \ + invoke-plot_summary.texi \ + invoke-plot_summary.menu \ + plot_summary.1plot_summaryman \ + plot_summary.1plot_summarymdoc \ + plot_summary.mdoc.in \ + plot_summary.man.in \ + plot_summary.texi \ + plot_summary.html \ + plot_summary-opts \ + plot_summary-opts.def \ + rc \ + invoke-summary.texi \ + invoke-summary.menu \ + summary.1summaryman \ + summary.1summarymdoc \ + summary.mdoc.in \ + summary.man.in \ + summary.texi \ + summary.html \ + summary-opts \ + summary-opts.def \ + stats \ + $(NULL) + +noinst_DATA = \ + invoke-plot_summary.texi \ + invoke-plot_summary.menu \ + plot_summary.1plot_summaryman \ + plot_summary.1plot_summarymdoc \ + plot_summary.mdoc.in \ + plot_summary.man.in \ + plot_summary.texi \ + plot_summary.html \ + invoke-summary.texi \ + invoke-summary.menu \ + summary.1summaryman \ + summary.1summarymdoc \ + summary.mdoc.in \ + summary.man.in \ + summary.texi \ + summary.html \ $(NULL) OPTTPL = ../sntp/ag-tpl/perlopt.tpl @@ -52,6 +87,45 @@ plot_summary: plot_summary-opts plot_summary-opts: plot_summary-opts.def $(OPTTPL) $(run_ag) plot_summary-opts.def +### Nroff + +$(srcdir)/plot_summary.1plot_summaryman: $(srcdir)/plot_summary-opts.def $(std_def_list) + $(run_ag) -DMAN_SECTION=1plot_summaryman -Tagman-cmd.tpl plot_summary-opts.def + +$(srcdir)/plot_summary.man.in: $(srcdir)/plot_summary.1plot_summaryman $(top_srcdir)/sntp/scripts/mansec2subst.sed + sed -f $(top_srcdir)/sntp/scripts/mansec2subst.sed $(srcdir)/plot_summary.1plot_summaryman > $(srcdir)/plot_summary.man.in+ + mv $(srcdir)/plot_summary.man.in+ $(srcdir)/plot_summary.man.in + +### Mdoc + +$(srcdir)/plot_summary.1plot_summarymdoc: $(srcdir)/plot_summary-opts.def $(std_def_list) + $(run_ag) -DMAN_SECTION=1plot_summarymdoc -Tagmdoc-cmd.tpl plot_summary-opts.def + +$(srcdir)/plot_summary.mdoc.in: $(srcdir)/plot_summary.1plot_summarymdoc $(top_srcdir)/sntp/scripts/mansec2subst.sed + sed -f $(top_srcdir)/sntp/scripts/mansec2subst.sed $(srcdir)/plot_summary.1plot_summarymdoc > $(srcdir)/plot_summary.mdoc.in+ + mv $(srcdir)/plot_summary.mdoc.in+ $(srcdir)/plot_summary.mdoc.in + +### Manpage (local) + +plot_summary.1: $(srcdir)/plot_summary.$(MANTAGFMT).in $(top_builddir)/config.status + $(top_builddir)/config.status --file=plot_summary.1+:$(srcdir)/plot_summary.$(MANTAGFMT).in + mv plot_summary.1+ plot_summary.1 + +### Texinfo + +$(srcdir)/invoke-plot_summary.menu: $(srcdir)/invoke-plot_summary.texi + @: do-nothing action to avoid default SCCS get, .menu built with .texi + +$(srcdir)/invoke-plot_summary.texi: plot_summary-opts $(srcdir)/plot_summary-opts.def $(std_def_list) + $(run_ag) -Tagtexi-cmd.tpl -DLEVEL=section plot_summary-opts.def + $(top_srcdir)/scripts/build/check--help $@ + +### HTML + +$(srcdir)/plot_summary.html: $(srcdir)/invoke-plot_summary.menu $(srcdir)/invoke-plot_summary.texi $(srcdir)/plot_summary.texi $(top_srcdir)/sntp/include/version.texi + cd $(srcdir) && ( makeinfo --force --html --no-split -I ../sntp -o plot_summary.html plot_summary.texi || true ) + + ## summary: summary-opts @@ -59,4 +133,41 @@ summary: summary-opts summary-opts: summary-opts.def $(OPTTPL) $(run_ag) summary-opts.def +### Nroff + +$(srcdir)/summary.1summaryman: $(srcdir)/summary-opts.def $(std_def_list) + $(run_ag) -DMAN_SECTION=1summaryman -Tagman-cmd.tpl summary-opts.def + +$(srcdir)/summary.man.in: $(srcdir)/summary.1summaryman $(top_srcdir)/sntp/scripts/mansec2subst.sed + sed -f $(top_srcdir)/sntp/scripts/mansec2subst.sed $(srcdir)/summary.1summaryman > $(srcdir)/summary.man.in+ + mv $(srcdir)/summary.man.in+ $(srcdir)/summary.man.in + +### Mdoc + +$(srcdir)/summary.1summarymdoc: $(srcdir)/summary-opts.def $(std_def_list) + $(run_ag) -DMAN_SECTION=1summarymdoc -Tagmdoc-cmd.tpl summary-opts.def + +$(srcdir)/summary.mdoc.in: $(srcdir)/summary.1summarymdoc $(top_srcdir)/sntp/scripts/mansec2subst.sed + sed -f $(top_srcdir)/sntp/scripts/mansec2subst.sed $(srcdir)/summary.1summarymdoc > $(srcdir)/summary.mdoc.in+ + mv $(srcdir)/summary.mdoc.in+ $(srcdir)/summary.mdoc.in + +### Manpage (local) + +summary.1: $(srcdir)/summary.$(MANTAGFMT).in $(top_builddir)/config.status + $(top_builddir)/config.status --file=summary.1+:$(srcdir)/summary.$(MANTAGFMT).in + mv summary.1+ summary.1 + +### Texinfo + +$(srcdir)/invoke-summary.menu: $(srcdir)/invoke-summary.texi + @: do-nothing action to avoid default SCCS get, .menu built with .texi + +$(srcdir)/invoke-summary.texi: summary-opts $(srcdir)/summary-opts.def $(std_def_list) + $(run_ag) -Tagtexi-cmd.tpl -DLEVEL=section summary-opts.def + $(top_srcdir)/scripts/build/check--help $@ + +### HTML + +$(srcdir)/summary.html: $(srcdir)/invoke-summary.menu $(srcdir)/invoke-summary.texi $(srcdir)/summary.texi $(top_srcdir)/sntp/include/version.texi + cd $(srcdir) && ( makeinfo --force --html --no-split -I ../sntp -o summary.html summary.texi || true ) diff --git a/scripts/invoke-plot_summary.menu b/scripts/invoke-plot_summary.menu new file mode 100644 index 000000000..b287f20a0 --- /dev/null +++ b/scripts/invoke-plot_summary.menu @@ -0,0 +1 @@ +* plot_summary Invocation:: Invoking plot_summary diff --git a/scripts/invoke-plot_summary.texi b/scripts/invoke-plot_summary.texi new file mode 100644 index 000000000..2cc29849f --- /dev/null +++ b/scripts/invoke-plot_summary.texi @@ -0,0 +1,121 @@ +@node plot_summary Invocation +@section Invoking plot_summary +@pindex plot_summary +@cindex plot statistics generated by summary script +@ignore +# +# EDIT THIS FILE WITH CAUTION (invoke-plot_summary.texi) +# +# It has been AutoGen-ed December 22, 2013 at 10:04:28 AM by AutoGen 5.18.3pre7 +# From the definitions plot_summary-opts.def +# and the template file agtexi-cmd.tpl +@end ignore + + +This section was generated by @strong{AutoGen}, +using the @code{agtexi-cmd} template and the option descriptions for the @code{plot_summary} program. + +@menu +* plot_summary usage:: plot_summary help/usage (@option{--help}) +* plot_summary directory:: directory option +* plot_summary identifier:: identifier option +* plot_summary peer:: peer option +* plot_summary plot-term:: plot-term option +* plot_summary output-file:: output-file option +* plot_summary exit status:: exit status +@end menu + +@node plot_summary usage +@subsection plot_summary help/usage (@option{--help}) +@cindex plot_summary help + +This is the automatically generated usage text for plot_summary. + +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 +plot_summary - plot statistics generated by summary script +USAGE: plot_summary [ - [] | --[@{=| @}] ]... + + , --directory=str Where the summary files are + , --identifier=str Origin of the data + , --offset-limit=float Limit of absolute offset + , --peer=str Peers to generate plots for + - may appear multiple times + , --plot-term=str Gnuplot terminal + , --output-file=str Output file + , --dont-wait Don't wait for keystroke between plots + -?, --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 plot_summary directory +@subsection directory option +@cindex plot_summary-directory + +This is the ``where the summary files are'' option. +This option takes a string argument. + The directory where the @code{plot_summary} will search for the + *_summary files generated by @code{summary} script. +@node plot_summary identifier +@subsection identifier option +@cindex plot_summary-identifier + +This is the ``origin of the data'' option. +This option takes a string argument. + Where does the plotted data come from, default to string "host" plus + current hostname +@node plot_summary peer +@subsection peer option +@cindex plot_summary-peer + +This is the ``peers to generate plots for'' 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 + + By default the peer_summary plots are not generated. Use this option to + specify list of peers if you want to generate plots for them. +@node plot_summary plot-term +@subsection plot-term option +@cindex plot_summary-plot-term + +This is the ``gnuplot terminal'' option. +This option takes a string argument. + This is string is passed directly to the @code{gnuplot set terminal} + command. Default is @code{x11} if @code{DISPLAY} is set and + @code{dumb} is it's not'. See output from @code(gnuplot -e "set + terminal") for the list of avalaible options. +@node plot_summary output-file +@subsection output-file option +@cindex plot_summary-output-file + +This is the ``output file'' option. +This option takes a str argument. + Output file for @code{gnuplot}, default to stdout. +@node plot_summary exit status +@subsection plot_summary 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/invoke-summary.menu b/scripts/invoke-summary.menu new file mode 100644 index 000000000..f6adfe1d1 --- /dev/null +++ b/scripts/invoke-summary.menu @@ -0,0 +1 @@ +* summary Invocation:: Invoking summary diff --git a/scripts/invoke-summary.texi b/scripts/invoke-summary.texi new file mode 100644 index 000000000..ddcf7f1e6 --- /dev/null +++ b/scripts/invoke-summary.texi @@ -0,0 +1,103 @@ +@node summary Invocation +@section Invoking summary +@pindex summary +@cindex compute various stastics from NTP stat files +@ignore +# +# EDIT THIS FILE WITH CAUTION (invoke-summary.texi) +# +# It has been AutoGen-ed December 22, 2013 at 10:12:44 AM by AutoGen 5.18.3pre7 +# From the definitions summary-opts.def +# and the template file agtexi-cmd.tpl +@end ignore + + + + +This section was generated by @strong{AutoGen}, +using the @code{agtexi-cmd} template and the option descriptions for the @code{summary} program. + +@menu +* summary usage:: summary help/usage (@option{--help}) +* summary directory:: directory option +* summary end-date:: end-date option +* summary output-directory:: output-directory option +* summary start-date:: start-date option +* summary exit status:: exit status +@end menu + +@node summary usage +@subsection summary help/usage (@option{--help}) +@cindex summary help + +This is the automatically generated usage text for summary. + +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 +summary - compute various stastics from NTP stat files +USAGE: summary [ - [] | --[@{=| @}] ]... + + , --directory=str Directory containing stat files + , --end-date=num End date + , --output-directory=str Output directory + , --peer-dist-limit=float Peer dist limit + , --skip-time-steps=float Ignore time offsets larger that this + , --start-date=num Start date + -?, --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 summary directory +@subsection directory option +@cindex summary-directory + +This is the ``directory containing stat files'' option. +This option takes a string argument. + The directory where @code{ntpd} will search for .stat files generated + by @code{ntpd}. +@node summary end-date +@subsection end-date option +@cindex summary-end-date + +This is the ``end date'' option. +This option takes a number argument. + Process all files with the date suffix less or equal to value of this + option. Defaults to today minus one day (Use @code{date -u +%Y%m%d}) + to get the timestamp. +@node summary output-directory +@subsection output-directory option +@cindex summary-output-directory + +This is the ``output directory'' option. +This option takes a str argument. + The output directory @code{summary} will write all output files to. +@node summary start-date +@subsection start-date option +@cindex summary-start-date + +This is the ``start date'' option. +This option takes a num argument. + Process all files with the date suffix more or equal to value of + this option. Defaults to 197000101. +@node summary exit status +@subsection summary 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/Makefile.am b/scripts/ntptrace/Makefile.am index 79a807e2f..6e8acd57d 100644 --- a/scripts/ntptrace/Makefile.am +++ b/scripts/ntptrace/Makefile.am @@ -65,8 +65,8 @@ $(srcdir)/ntptrace.mdoc.in: $(srcdir)/ntptrace.1ntptracemdoc $(top_srcdir)/sntp/ ### Manpage (local) ntptrace.$(NTPTRACE_MS): $(srcdir)/ntptrace.$(MANTAGFMT).in $(top_builddir)/config.status - $(top_builddir)/config.status --file=ntptrace.$(NTPTRCE_MS)+:$(srcdir)/ntptrace.$(MANTAGFMT).in - mv ntptrace.$(NTPTRCE_MS)+ ntptrace.$(NTPTRCE_MS) + $(top_builddir)/config.status --file=ntptrace.$(NTPTRACE_MS)+:$(srcdir)/ntptrace.$(MANTAGFMT).in + mv ntptrace.$(NTPTRACE_MS)+ ntptrace.$(NTPTRACE_MS) ### Texinfo diff --git a/scripts/plot_summary.1plot_summaryman b/scripts/plot_summary.1plot_summaryman new file mode 100644 index 000000000..5a842beb9 --- /dev/null +++ b/scripts/plot_summary.1plot_summaryman @@ -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 plot_summary 1plot_summaryman "22 Dec 2013" "" "User Commands" +.\" +.\" EDIT THIS FILE WITH CAUTION (in-mem file) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:04:41 AM by AutoGen 5.18.3pre7 +.\" From the definitions plot_summary-opts.def +.\" and the template file agman-cmd.tpl +.SH NAME +\f\*[B-Font]plot_summary\fP +\- plot statistics generated by summary script +.SH SYNOPSIS +\f\*[B-Font]plot_summary\fP +[\f\*[B-Font]\-\-option-name\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" +There is no description for this command. +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-\-directory\f[]=\f\*[I-Font]string\f[] +Where the summary files are. +The default +\f\*[I-Font]string\f[] +for this option is: +.ti +4 + /tmp +.sp + The directory where the \fBplot_summary\fP will search for the + *_summary files generated by \fBsummary\fP script. +.TP +.NOP \f\*[B-Font]\-\-identifier\f[]=\f\*[I-Font]string\f[] +Origin of the data. +.sp + Where does the plotted data come from, default to string "host" plus + current hostname +.TP +.NOP \f\*[B-Font]\-\-offset\-limit\f[]=\f\*[I-Font]float\f[] +Limit of absolute offset. +The default +\f\*[I-Font]float\f[] +for this option is: +.ti +4 + 0.128 +.sp +.TP +.NOP \f\*[B-Font]\-\-peer\f[]=\f\*[I-Font]string\f[] +Peers to generate plots for. +This option may appear an unlimited number of times. +.sp + By default the peer_summary plots are not generated. Use this option to + specify list of peers if you want to generate plots for them. +.TP +.NOP \f\*[B-Font]\-\-plot\-term\f[]=\f\*[I-Font]string\f[] +Gnuplot terminal. +.sp + This is string is passed directly to the \fBgnuplot set terminal\fP + command. Default is \fBx11\fP if \fBDISPLAY\fP is set and + \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set + terminal") for the list of avalaible options. +.TP +.NOP \f\*[B-Font]\-\-output\-file\f[]=\f\*[I-Font]str\f[] +Output file. +.sp + Output file for \fBgnuplot\fP, default to stdout. +.TP +.NOP \f\*[B-Font]\-\-dont\-wait\f[] +Don't wait for keystroke between plots. +.sp +.TP +.NOP \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \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 \fBplot_summary\fP +option definitions. diff --git a/scripts/plot_summary.1plot_summarymdoc b/scripts/plot_summary.1plot_summarymdoc new file mode 100644 index 000000000..abb6ef4cc --- /dev/null +++ b/scripts/plot_summary.1plot_summarymdoc @@ -0,0 +1,84 @@ +.Dd December 22 2013 +.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands +.Os FreeBSD 6.4-STABLE +.\" EDIT THIS FILE WITH CAUTION (plot_summary-opts.mdoc) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:04:50 AM by AutoGen 5.18.3pre7 +.\" From the definitions plot_summary-opts.def +.\" and the template file agmdoc-cmd.tpl +.Sh NAME +.Nm plot_summary +.Nd plot statistics generated by summary script +.Sh SYNOPSIS +.Nm +.Op Fl \-option\-name +.Op Fl \-option\-name Ar value +.Pp +All arguments must be options. +.Pp +.Sh "DESCRIPTION" +There is no description for this command. +.Sh "OPTIONS" +.Bl -tag +.It Fl \-directory Ns = Ns Ar string +Where the summary files are. +The default +.Ar string +for this option is: +.ti +4 + /tmp +.sp + The directory where the \fBplot_summary\fP will search for the + *_summary files generated by \fBsummary\fP script. +.It Fl \-identifier Ns = Ns Ar string +Origin of the data. +.sp + Where does the plotted data come from, default to string "host" plus + current hostname +.It Fl \-offset\-limit Ns = Ns Ar float +Limit of absolute offset. +The default +.Ar float +for this option is: +.ti +4 + 0.128 +.sp +.It Fl \-peer Ns = Ns Ar string +Peers to generate plots for. +This option may appear an unlimited number of times. +.sp + By default the peer_summary plots are not generated. Use this option to + specify list of peers if you want to generate plots for them. +.It Fl \-plot\-term Ns = Ns Ar string +Gnuplot terminal. +.sp + This is string is passed directly to the \fBgnuplot set terminal\fP + command. Default is \fBx11\fP if \fBDISPLAY\fP is set and + \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set + terminal") for the list of avalaible options. +.It Fl \-output\-file Ns = Ns Ar str +Output file. +.sp + Output file for \fBgnuplot\fP, default to stdout. +.It Fl \-dont\-wait +Don't wait for keystroke between plots. +.sp +.It Fl \-help +Display usage information and exit. +.It 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 \fBplot_summary\fP +option definitions. diff --git a/scripts/plot_summary.html b/scripts/plot_summary.html new file mode 100644 index 000000000..405bbe12b --- /dev/null +++ b/scripts/plot_summary.html @@ -0,0 +1,225 @@ + + +Plot_summary User's Manual + + + + + + + + + +

Plot_summary User's Manual

+
+ +

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

Plot_summary User Manual

+ +

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

+

Short Contents

+ +
+ + + +
+ + +

+Previous: plot_summary Description, +Up: Top + +
+ +

Invoking plot_summary

+ +

+ +

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

+ +
+ + +

+Next: , +Up: plot_summary Invocation + +
+ +

plot_summary help/usage (--help)

+ +

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

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. + +

plot_summary - plot statistics generated by summary script
+USAGE: plot_summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
+
+      , --directory=str          Where the summary files are
+      , --identifier=str         Origin of the data
+      , --offset-limit=float     Limit of absolute offset
+      , --peer=str               Peers to generate plots for
+                                   - may appear multiple times
+      , --plot-term=str          Gnuplot terminal
+      , --output-file=str        Output file
+      , --dont-wait              Don't wait for keystroke between plots
+    -?, --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: plot_summary usage, +Up: plot_summary Invocation + +
+ +

directory option

+ +

+This is the “where the summary files are” option. +This option takes a string argument. + The directory where the plot_summary will search for the + *_summary files generated by summary script. +

+ + +

+Next: , +Previous: plot_summary directory, +Up: plot_summary Invocation + +
+ +

identifier option

+ +

+This is the “origin of the data” option. +This option takes a string argument. + Where does the plotted data come from, default to string "host" plus + current hostname +

+ + +

+Next: , +Previous: plot_summary identifier, +Up: plot_summary Invocation + +
+ +

peer option

+ +

+This is the “peers to generate plots for” option. +This option takes a string argument. + +

This option has some usage constraints. It: +

    +
  • may appear an unlimited number of times. +
+ +

By default the peer_summary plots are not generated. Use this option to + specify list of peers if you want to generate plots for them. +

+ + +

+Next: , +Previous: plot_summary peer, +Up: plot_summary Invocation + +
+ +

plot-term option

+ +

+This is the “gnuplot terminal” option. +This option takes a string argument. + This is string is passed directly to the gnuplot set terminal + command. Default is x11 if DISPLAY is set and + dumb is it's not'. See output from -e "set + terminal") for the list of avalaible options. +

+ + +

+Next: , +Previous: plot_summary plot-term, +Up: plot_summary Invocation + +
+ +

output-file option

+ +

+This is the “output file” option. +This option takes a str argument. + Output file for gnuplot, default to stdout. +

+ + +

+Previous: plot_summary output-file, +Up: plot_summary Invocation + +
+ +

plot_summary 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/plot_summary.man.in b/scripts/plot_summary.man.in new file mode 100644 index 000000000..5a842beb9 --- /dev/null +++ b/scripts/plot_summary.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 plot_summary 1plot_summaryman "22 Dec 2013" "" "User Commands" +.\" +.\" EDIT THIS FILE WITH CAUTION (in-mem file) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:04:41 AM by AutoGen 5.18.3pre7 +.\" From the definitions plot_summary-opts.def +.\" and the template file agman-cmd.tpl +.SH NAME +\f\*[B-Font]plot_summary\fP +\- plot statistics generated by summary script +.SH SYNOPSIS +\f\*[B-Font]plot_summary\fP +[\f\*[B-Font]\-\-option-name\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" +There is no description for this command. +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-\-directory\f[]=\f\*[I-Font]string\f[] +Where the summary files are. +The default +\f\*[I-Font]string\f[] +for this option is: +.ti +4 + /tmp +.sp + The directory where the \fBplot_summary\fP will search for the + *_summary files generated by \fBsummary\fP script. +.TP +.NOP \f\*[B-Font]\-\-identifier\f[]=\f\*[I-Font]string\f[] +Origin of the data. +.sp + Where does the plotted data come from, default to string "host" plus + current hostname +.TP +.NOP \f\*[B-Font]\-\-offset\-limit\f[]=\f\*[I-Font]float\f[] +Limit of absolute offset. +The default +\f\*[I-Font]float\f[] +for this option is: +.ti +4 + 0.128 +.sp +.TP +.NOP \f\*[B-Font]\-\-peer\f[]=\f\*[I-Font]string\f[] +Peers to generate plots for. +This option may appear an unlimited number of times. +.sp + By default the peer_summary plots are not generated. Use this option to + specify list of peers if you want to generate plots for them. +.TP +.NOP \f\*[B-Font]\-\-plot\-term\f[]=\f\*[I-Font]string\f[] +Gnuplot terminal. +.sp + This is string is passed directly to the \fBgnuplot set terminal\fP + command. Default is \fBx11\fP if \fBDISPLAY\fP is set and + \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set + terminal") for the list of avalaible options. +.TP +.NOP \f\*[B-Font]\-\-output\-file\f[]=\f\*[I-Font]str\f[] +Output file. +.sp + Output file for \fBgnuplot\fP, default to stdout. +.TP +.NOP \f\*[B-Font]\-\-dont\-wait\f[] +Don't wait for keystroke between plots. +.sp +.TP +.NOP \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \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 \fBplot_summary\fP +option definitions. diff --git a/scripts/plot_summary.mdoc.in b/scripts/plot_summary.mdoc.in new file mode 100644 index 000000000..abb6ef4cc --- /dev/null +++ b/scripts/plot_summary.mdoc.in @@ -0,0 +1,84 @@ +.Dd December 22 2013 +.Dt PLOT_SUMMARY 1plot_summarymdoc User Commands +.Os FreeBSD 6.4-STABLE +.\" EDIT THIS FILE WITH CAUTION (plot_summary-opts.mdoc) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:04:50 AM by AutoGen 5.18.3pre7 +.\" From the definitions plot_summary-opts.def +.\" and the template file agmdoc-cmd.tpl +.Sh NAME +.Nm plot_summary +.Nd plot statistics generated by summary script +.Sh SYNOPSIS +.Nm +.Op Fl \-option\-name +.Op Fl \-option\-name Ar value +.Pp +All arguments must be options. +.Pp +.Sh "DESCRIPTION" +There is no description for this command. +.Sh "OPTIONS" +.Bl -tag +.It Fl \-directory Ns = Ns Ar string +Where the summary files are. +The default +.Ar string +for this option is: +.ti +4 + /tmp +.sp + The directory where the \fBplot_summary\fP will search for the + *_summary files generated by \fBsummary\fP script. +.It Fl \-identifier Ns = Ns Ar string +Origin of the data. +.sp + Where does the plotted data come from, default to string "host" plus + current hostname +.It Fl \-offset\-limit Ns = Ns Ar float +Limit of absolute offset. +The default +.Ar float +for this option is: +.ti +4 + 0.128 +.sp +.It Fl \-peer Ns = Ns Ar string +Peers to generate plots for. +This option may appear an unlimited number of times. +.sp + By default the peer_summary plots are not generated. Use this option to + specify list of peers if you want to generate plots for them. +.It Fl \-plot\-term Ns = Ns Ar string +Gnuplot terminal. +.sp + This is string is passed directly to the \fBgnuplot set terminal\fP + command. Default is \fBx11\fP if \fBDISPLAY\fP is set and + \fBdumb\fP is it's not'. See output from @code(gnuplot \-e "set + terminal") for the list of avalaible options. +.It Fl \-output\-file Ns = Ns Ar str +Output file. +.sp + Output file for \fBgnuplot\fP, default to stdout. +.It Fl \-dont\-wait +Don't wait for keystroke between plots. +.sp +.It Fl \-help +Display usage information and exit. +.It 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 \fBplot_summary\fP +option definitions. diff --git a/scripts/plot_summary.texi b/scripts/plot_summary.texi new file mode 100644 index 000000000..33fa1fdc8 --- /dev/null +++ b/scripts/plot_summary.texi @@ -0,0 +1,40 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename plot_summary.info +@settitle Plot_summary User's Manual +@include ../sntp/include/version.texi +@paragraphindent 2 +@c %**end of header + +@ifinfo +This file documents the use of @code{plot_summary}, +a program from the NTP Project +@end ifinfo + +@direntry +* plot_summary: (plot_summary). Summarize (something) +@end direntry + +@titlepage +@title plot_summary User's Manual +@subtitle plot_summary, version @value{VERSION}, @value{UPDATED} +@c @author Max @email{foo@ntp.org} +@end titlepage + +@c @page +@c @vskip 0pt plus 1filll + +@node Top, plot_summary Description, (dir), (dir) +@top Plot_summary User Manual + +This document describes the use of the NTP Project's @code{plot_summary} program. +This document applies to version @value{VERSION} of @code{plot_summary}. + +@shortcontents + +@menu +* plot_summary Description:: Description +* plot_summary Invocation:: Invoking plot_summary +@end menu + +@include invoke-plot_summary.texi diff --git a/scripts/summary.1summaryman b/scripts/summary.1summaryman new file mode 100644 index 000000000..619642591 --- /dev/null +++ b/scripts/summary.1summaryman @@ -0,0 +1,118 @@ +.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 summary 1summaryman "22 Dec 2013" "" "User Commands" +.\" +.\" EDIT THIS FILE WITH CAUTION (in-mem file) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:13:06 AM by AutoGen 5.18.3pre7 +.\" From the definitions summary-opts.def +.\" and the template file agman-cmd.tpl +.SH NAME +\f\*[B-Font]summary\fP +\- compute various stastics from NTP stat files +.SH SYNOPSIS +\f\*[B-Font]summary\fP +[\f\*[B-Font]\-\-option-name\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 +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-\-directory\f[]=\f\*[I-Font]string\f[] +Directory containing stat files. +The default +\f\*[I-Font]string\f[] +for this option is: +.ti +4 + /var/log/ntp +.sp + The directory where \fBntpd\fP will search for .stat files generated + by \fBntpd\fP. +.TP +.NOP \f\*[B-Font]\-\-end\-date\f[]=\f\*[I-Font]number\f[] +End date. +This option takes an integer number as its argument. +.sp + Process all files with the date suffix less or equal to value of this + option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) + to get the timestamp. +.TP +.NOP \f\*[B-Font]\-\-output\-directory\f[]=\f\*[I-Font]str\f[] +Output directory. +The default +\f\*[I-Font]str\f[] +for this option is: +.ti +4 + /tmp +.sp + The output directory \fBsummary\fP will write all output files to. +.TP +.NOP \f\*[B-Font]\-\-peer\-dist\-limit\f[]=\f\*[I-Font]float\f[] +Peer dist limit. +The default +\f\*[I-Font]float\f[] +for this option is: +.ti +4 + 400 +.sp +.TP +.NOP \f\*[B-Font]\-\-skip\-time\-steps\f[]=\f\*[I-Font]float\f[] +Ignore time offsets larger that this. +The default +\f\*[I-Font]float\f[] +for this option is: +.ti +4 + 3600 +.sp +.TP +.NOP \f\*[B-Font]\-\-start\-date\f[]=\f\*[I-Font]num\f[] +Start date. +This option takes an integer number as its argument. +The default +\f\*[I-Font]num\f[] +for this option is: +.ti +4 + 19700101 +.sp + Process all files with the date suffix more or equal to value of + this option. Defaults to 197000101. +.TP +.NOP \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \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 \fBsummary\fP +option definitions. diff --git a/scripts/summary.1summarymdoc b/scripts/summary.1summarymdoc new file mode 100644 index 000000000..8612b4dfb --- /dev/null +++ b/scripts/summary.1summarymdoc @@ -0,0 +1,94 @@ +.Dd December 22 2013 +.Dt SUMMARY 1summarymdoc User Commands +.Os FreeBSD 6.4-STABLE +.\" EDIT THIS FILE WITH CAUTION (summary-opts.mdoc) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:13:19 AM by AutoGen 5.18.3pre7 +.\" From the definitions summary-opts.def +.\" and the template file agmdoc-cmd.tpl +.Sh NAME +.Nm summary +.Nd compute various stastics from NTP stat files +.Sh SYNOPSIS +.Nm +.Op Fl \-option\-name +.Op Fl \-option\-name Ar value +.Pp +All arguments must be options. +.Pp +.Sh DESCRIPTION +.sp +.Sh "OPTIONS" +.Bl -tag +.It Fl \-directory Ns = Ns Ar string +Directory containing stat files. +The default +.Ar string +for this option is: +.ti +4 + /var/log/ntp +.sp + The directory where \fBntpd\fP will search for .stat files generated + by \fBntpd\fP. +.It Fl \-end\-date Ns = Ns Ar number +End date. +This option takes an integer number as its argument. +.sp + Process all files with the date suffix less or equal to value of this + option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) + to get the timestamp. +.It Fl \-output\-directory Ns = Ns Ar str +Output directory. +The default +.Ar str +for this option is: +.ti +4 + /tmp +.sp + The output directory \fBsummary\fP will write all output files to. +.It Fl \-peer\-dist\-limit Ns = Ns Ar float +Peer dist limit. +The default +.Ar float +for this option is: +.ti +4 + 400 +.sp +.It Fl \-skip\-time\-steps Ns = Ns Ar float +Ignore time offsets larger that this. +The default +.Ar float +for this option is: +.ti +4 + 3600 +.sp +.It Fl \-start\-date Ns = Ns Ar num +Start date. +This option takes an integer number as its argument. +The default +.Ar num +for this option is: +.ti +4 + 19700101 +.sp + Process all files with the date suffix more or equal to value of + this option. Defaults to 197000101. +.It Fl \-help +Display usage information and exit. +.It 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 \fBsummary\fP +option definitions. diff --git a/scripts/summary.html b/scripts/summary.html new file mode 100644 index 000000000..30d5b48f5 --- /dev/null +++ b/scripts/summary.html @@ -0,0 +1,194 @@ + + +Summary User's Manual + + + + + + + + + +

Summary User's Manual

+
+ +

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

Summary User Manual

+ +

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

+

Short Contents

+ +
+ + + +
+ +

+Previous: summary Description, +Up: Top + +
+ +

Invoking summary

+ +

+ +

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

+ +
+ +

+Next: , +Up: summary Invocation + +
+ +

summary help/usage (--help)

+ +

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

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. + +

summary - compute various stastics from NTP stat files
+USAGE: summary [ -<flag> [<val>] | --<name>[{=| }<val>] ]...
+
+      , --directory=str          Directory containing stat files
+      , --end-date=num           End date
+      , --output-directory=str   Output directory
+      , --peer-dist-limit=float  Peer dist limit
+      , --skip-time-steps=float  Ignore time offsets larger that this
+      , --start-date=num         Start date
+    -?, --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: summary usage, +Up: summary Invocation + +
+ +

directory option

+ +

+This is the “directory containing stat files” option. +This option takes a string argument. + The directory where ntpd will search for .stat files generated + by ntpd. +

+ + +

+Next: , +Previous: summary directory, +Up: summary Invocation + +
+ +

end-date option

+ +

+This is the “end date” option. +This option takes a number argument. + Process all files with the date suffix less or equal to value of this + option. Defaults to today minus one day (Use date -u +%Y%m%d) + to get the timestamp. +

+ + +

+Next: , +Previous: summary end-date, +Up: summary Invocation + +
+ +

output-directory option

+ +

+This is the “output directory” option. +This option takes a str argument. + The output directory summary will write all output files to. +

+ + +

+Next: , +Previous: summary output-directory, +Up: summary Invocation + +
+ +

start-date option

+ +

+This is the “start date” option. +This option takes a num argument. + Process all files with the date suffix more or equal to value of + this option. Defaults to 197000101. +

+ +

+Previous: summary start-date, +Up: summary Invocation + +
+ +

summary 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/summary.man.in b/scripts/summary.man.in new file mode 100644 index 000000000..619642591 --- /dev/null +++ b/scripts/summary.man.in @@ -0,0 +1,118 @@ +.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 summary 1summaryman "22 Dec 2013" "" "User Commands" +.\" +.\" EDIT THIS FILE WITH CAUTION (in-mem file) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:13:06 AM by AutoGen 5.18.3pre7 +.\" From the definitions summary-opts.def +.\" and the template file agman-cmd.tpl +.SH NAME +\f\*[B-Font]summary\fP +\- compute various stastics from NTP stat files +.SH SYNOPSIS +\f\*[B-Font]summary\fP +[\f\*[B-Font]\-\-option-name\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 +.sp +.SH "OPTIONS" +.TP +.NOP \f\*[B-Font]\-\-directory\f[]=\f\*[I-Font]string\f[] +Directory containing stat files. +The default +\f\*[I-Font]string\f[] +for this option is: +.ti +4 + /var/log/ntp +.sp + The directory where \fBntpd\fP will search for .stat files generated + by \fBntpd\fP. +.TP +.NOP \f\*[B-Font]\-\-end\-date\f[]=\f\*[I-Font]number\f[] +End date. +This option takes an integer number as its argument. +.sp + Process all files with the date suffix less or equal to value of this + option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) + to get the timestamp. +.TP +.NOP \f\*[B-Font]\-\-output\-directory\f[]=\f\*[I-Font]str\f[] +Output directory. +The default +\f\*[I-Font]str\f[] +for this option is: +.ti +4 + /tmp +.sp + The output directory \fBsummary\fP will write all output files to. +.TP +.NOP \f\*[B-Font]\-\-peer\-dist\-limit\f[]=\f\*[I-Font]float\f[] +Peer dist limit. +The default +\f\*[I-Font]float\f[] +for this option is: +.ti +4 + 400 +.sp +.TP +.NOP \f\*[B-Font]\-\-skip\-time\-steps\f[]=\f\*[I-Font]float\f[] +Ignore time offsets larger that this. +The default +\f\*[I-Font]float\f[] +for this option is: +.ti +4 + 3600 +.sp +.TP +.NOP \f\*[B-Font]\-\-start\-date\f[]=\f\*[I-Font]num\f[] +Start date. +This option takes an integer number as its argument. +The default +\f\*[I-Font]num\f[] +for this option is: +.ti +4 + 19700101 +.sp + Process all files with the date suffix more or equal to value of + this option. Defaults to 197000101. +.TP +.NOP \f\*[B-Font]\-\-help\f[] +Display usage information and exit. +.TP +.NOP \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 \fBsummary\fP +option definitions. diff --git a/scripts/summary.mdoc.in b/scripts/summary.mdoc.in new file mode 100644 index 000000000..8612b4dfb --- /dev/null +++ b/scripts/summary.mdoc.in @@ -0,0 +1,94 @@ +.Dd December 22 2013 +.Dt SUMMARY 1summarymdoc User Commands +.Os FreeBSD 6.4-STABLE +.\" EDIT THIS FILE WITH CAUTION (summary-opts.mdoc) +.\" +.\" It has been AutoGen-ed December 22, 2013 at 10:13:19 AM by AutoGen 5.18.3pre7 +.\" From the definitions summary-opts.def +.\" and the template file agmdoc-cmd.tpl +.Sh NAME +.Nm summary +.Nd compute various stastics from NTP stat files +.Sh SYNOPSIS +.Nm +.Op Fl \-option\-name +.Op Fl \-option\-name Ar value +.Pp +All arguments must be options. +.Pp +.Sh DESCRIPTION +.sp +.Sh "OPTIONS" +.Bl -tag +.It Fl \-directory Ns = Ns Ar string +Directory containing stat files. +The default +.Ar string +for this option is: +.ti +4 + /var/log/ntp +.sp + The directory where \fBntpd\fP will search for .stat files generated + by \fBntpd\fP. +.It Fl \-end\-date Ns = Ns Ar number +End date. +This option takes an integer number as its argument. +.sp + Process all files with the date suffix less or equal to value of this + option. Defaults to today minus one day (Use \fBdate \-u +%Y%m%d\fP) + to get the timestamp. +.It Fl \-output\-directory Ns = Ns Ar str +Output directory. +The default +.Ar str +for this option is: +.ti +4 + /tmp +.sp + The output directory \fBsummary\fP will write all output files to. +.It Fl \-peer\-dist\-limit Ns = Ns Ar float +Peer dist limit. +The default +.Ar float +for this option is: +.ti +4 + 400 +.sp +.It Fl \-skip\-time\-steps Ns = Ns Ar float +Ignore time offsets larger that this. +The default +.Ar float +for this option is: +.ti +4 + 3600 +.sp +.It Fl \-start\-date Ns = Ns Ar num +Start date. +This option takes an integer number as its argument. +The default +.Ar num +for this option is: +.ti +4 + 19700101 +.sp + Process all files with the date suffix more or equal to value of + this option. Defaults to 197000101. +.It Fl \-help +Display usage information and exit. +.It 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 \fBsummary\fP +option definitions. diff --git a/scripts/summary.texi b/scripts/summary.texi new file mode 100644 index 000000000..5f1548ac4 --- /dev/null +++ b/scripts/summary.texi @@ -0,0 +1,40 @@ +\input texinfo @c -*-texinfo-*- +@c %**start of header +@setfilename summary.info +@settitle Summary User's Manual +@include ../sntp/include/version.texi +@paragraphindent 2 +@c %**end of header + +@ifinfo +This file documents the use of @code{summary}, +a program from the NTP Project +@end ifinfo + +@direntry +* summary: (summary). Summarize (something) +@end direntry + +@titlepage +@title summary User's Manual +@subtitle summary, version @value{VERSION}, @value{UPDATED} +@c @author Max @email{foo@ntp.org} +@end titlepage + +@c @page +@c @vskip 0pt plus 1filll + +@node Top, summary Description, (dir), (dir) +@top Summary User Manual + +This document describes the use of the NTP Project's @code{summary} program. +This document applies to version @value{VERSION} of @code{summary}. + +@shortcontents + +@menu +* summary Description:: Description +* summary Invocation:: Invoking summary +@end menu + +@include invoke-summary.texi