2019-03-07 08:01:16 -05:00
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
< html >
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
2014-12-20 17:52:39 -05:00
< head >
2019-03-07 08:01:16 -05:00
< meta http-equiv = "Content-Type" content = "text/html; charset=utf-8" >
< title > Summary User’ s Manual< / title >
< meta name = "description" content = "Summary User’s Manual" >
< meta name = "keywords" content = "Summary User’s Manual" >
< meta name = "resource-type" content = "document" >
< meta name = "distribution" content = "global" >
< meta name = "Generator" content = "makeinfo" >
< link href = "#Top" rel = "start" title = "Top" >
< link href = "dir.html#Top" rel = "up" title = "(dir)" >
< style type = "text/css" >
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
< / style >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< / head >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< body lang = "en" >
< h1 class = "settitle" align = "center" > Summary User’ s Manual< / h1 >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< a name = "Top" > < / a >
< div class = "header" >
< p >
Previous: < a href = "dir.html#Top" accesskey = "p" rel = "prev" > (dir)< / a > , Up: < a href = "dir.html#Top" accesskey = "u" rel = "up" > (dir)< / a > < / p >
< / div >
< a name = "Summary-User-Manual" > < / a >
< h1 class = "top" > Summary User Manual< / h1 >
< p > This document describes the use of the NTP Project’ s < code > summary< / code > program.
2020-06-23 20:20:45 -04:00
This document applies to version 4.2.8p15 of < code > summary< / code > .
2019-03-07 08:01:16 -05:00
< / p >
< a name = "SEC_Overview" > < / a >
< h2 class = "shortcontents-heading" > Short Table of Contents< / h2 >
< div class = "shortcontents" >
< ul class = "no-bullet" >
< li > < a name = "stoc-Invoking-summary" href = "#toc-Invoking-summary" > 1 Invoking summary< / a > < / li >
2014-12-20 17:52:39 -05:00
< / ul >
2019-03-07 08:01:16 -05:00
< / div >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< table class = "menu" border = "0" cellspacing = "0" >
< tr > < td align = "left" valign = "top" > • summary Description:< / td > < td > < / td > < td align = "left" valign = "top" > Description
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-Invocation" accesskey = "2" > summary Invocation< / a > :< / td > < td > < / td > < td align = "left" valign = "top" > Invoking summary
< / td > < / tr >
< / table >
< hr >
< a name = "summary-Invocation" > < / a >
< div class = "header" >
< p >
Up: < a href = "#Top" accesskey = "u" rel = "up" > Top< / a > < / p >
2014-12-20 17:52:39 -05:00
< / div >
2019-03-07 08:01:16 -05:00
< a name = "Invoking-summary" > < / a >
< h2 class = "chapter" > 1 Invoking summary< / h2 >
< a name = "index-summary" > < / a >
< a name = "index-compute-various-stastics-from-NTP-stat-files" > < / a >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< p > This section was generated by < strong > AutoGen< / strong > ,
using the < code > agtexi-cmd< / code > template and the option descriptions for the < code > summary< / code > program.
< / p >
< table class = "menu" border = "0" cellspacing = "0" >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-usage" accesskey = "1" > summary usage< / a > :< / td > < td > < / td > < td align = "left" valign = "top" > summary help/usage (< samp > --help< / samp > )
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-directory" accesskey = "2" > summary directory< / a > :< / td > < td > < / td > < td align = "left" valign = "top" > directory option
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-end_002ddate" accesskey = "3" > summary end-date< / a > :< / td > < td > < / td > < td align = "left" valign = "top" > end-date option
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-output_002ddirectory" accesskey = "4" > summary output-directory< / a > :< / td > < td > < / td > < td align = "left" valign = "top" > output-directory option
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-start_002ddate" accesskey = "5" > summary start-date< / a > :< / td > < td > < / td > < td align = "left" valign = "top" > start-date option
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-exit-status" accesskey = "6" > summary exit status< / a > :< / td > < td > < / td > < td align = "left" valign = "top" > exit status
< / td > < / tr >
< / table >
< hr >
< a name = "summary-usage" > < / a >
< div class = "header" >
< p >
Next: < a href = "#summary-directory" accesskey = "n" rel = "next" > summary directory< / a > , Up: < a href = "#summary-Invocation" accesskey = "u" rel = "up" > summary Invocation< / a > < / p >
< / div >
< a name = "summary-help_002fusage-_0028_002d_002dhelp_0029" > < / a >
< h3 class = "section" > 1.1 summary help/usage (< samp > --help< / samp > )< / h3 >
< a name = "index-summary-help" > < / a >
< p > This is the automatically generated usage text for summary.
< / p >
< p > The text printed is the same whether selected with the < code > help< / code > option
(< samp > --help< / samp > ) or the < code > more-help< / code > option (< samp > --more-help< / samp > ). < code > more-help< / code > will print
the usage text by passing it through a pager program.
2014-12-20 17:52:39 -05:00
< code > more-help< / code > is disabled on platforms without a working
< code > fork(2)< / code > function. The < code > PAGER< / code > environment variable is
2019-03-07 08:01:16 -05:00
used to select the program, defaulting to < samp > more< / samp > . Both will exit
2014-12-20 17:52:39 -05:00
with a status code of 0.
2019-03-07 08:01:16 -05:00
< / p >
< div class = "example" >
2020-06-23 20:20:45 -04:00
< pre class = "example" > summary - compute various stastics from NTP stat files - Ver. 4.2.8p15
2019-03-07 08:01:16 -05:00
USAGE: summary [ -< flag> [< val> ] | --< name> [{=| }< val> ] ]...
2014-12-20 17:52:39 -05:00
--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 text through a pager
Options are specified by doubled hyphens and their name or by a single
hyphen and the flag character.
2019-03-07 08:01:16 -05:00
< / pre > < / div >
< table class = "menu" border = "0" cellspacing = "0" >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-directory" accesskey = "1" > summary directory< / a > :< / td > < td > < / td > < td align = "left" valign = "top" >
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-end_002ddate" accesskey = "2" > summary end-date< / a > :< / td > < td > < / td > < td align = "left" valign = "top" >
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-output_002ddirectory" accesskey = "3" > summary output-directory< / a > :< / td > < td > < / td > < td align = "left" valign = "top" >
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-start_002ddate" accesskey = "4" > summary start-date< / a > :< / td > < td > < / td > < td align = "left" valign = "top" >
< / td > < / tr >
< tr > < td align = "left" valign = "top" > • < a href = "#summary-exit-status" accesskey = "5" > summary exit status< / a > :< / td > < td > < / td > < td align = "left" valign = "top" >
< / td > < / tr >
< / table >
< hr >
< a name = "summary-directory" > < / a >
< div class = "header" >
< p >
Next: < a href = "#summary-end_002ddate" accesskey = "n" rel = "next" > summary end-date< / a > , Previous: < a href = "#summary-usage" accesskey = "p" rel = "prev" > summary usage< / a > , Up: < a href = "#summary-usage" accesskey = "u" rel = "up" > summary usage< / a > < / p >
2014-12-20 17:52:39 -05:00
< / div >
2019-03-07 08:01:16 -05:00
< a name = "directory-option" > < / a >
< h4 class = "subsection" > 1.1.1 directory option< / h4 >
< a name = "index-summary_002ddirectory" > < / a >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< p > This is the “ directory containing stat files” option.
This option takes a string argument.
2014-12-20 17:52:39 -05:00
The directory where < code > ntpd< / code > will search for .stat files generated
2019-03-07 08:01:16 -05:00
by < code > ntpd< / code > .
< / p > < hr >
< a name = "summary-end_002ddate" > < / a >
< div class = "header" >
< p >
Next: < a href = "#summary-output_002ddirectory" accesskey = "n" rel = "next" > summary output-directory< / a > , Previous: < a href = "#summary-directory" accesskey = "p" rel = "prev" > summary directory< / a > , Up: < a href = "#summary-usage" accesskey = "u" rel = "up" > summary usage< / a > < / p >
2014-12-20 17:52:39 -05:00
< / div >
2019-03-07 08:01:16 -05:00
< a name = "end_002ddate-option" > < / a >
< h4 class = "subsection" > 1.1.2 end-date option< / h4 >
< a name = "index-summary_002dend_002ddate" > < / a >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< p > This is the “ end date” option.
This option takes a number argument.
2014-12-20 17:52:39 -05:00
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< / code > )
2019-03-07 08:01:16 -05:00
to get the timestamp.
< / p > < hr >
< a name = "summary-output_002ddirectory" > < / a >
< div class = "header" >
< p >
Next: < a href = "#summary-start_002ddate" accesskey = "n" rel = "next" > summary start-date< / a > , Previous: < a href = "#summary-end_002ddate" accesskey = "p" rel = "prev" > summary end-date< / a > , Up: < a href = "#summary-usage" accesskey = "u" rel = "up" > summary usage< / a > < / p >
2014-12-20 17:52:39 -05:00
< / div >
2019-03-07 08:01:16 -05:00
< a name = "output_002ddirectory-option" > < / a >
< h4 class = "subsection" > 1.1.3 output-directory option< / h4 >
< a name = "index-summary_002doutput_002ddirectory" > < / a >
< p > This is the “ output directory” option.
This option takes a str argument.
The output directory < code > summary< / code > will write all output files to.
< / p > < hr >
< a name = "summary-start_002ddate" > < / a >
< div class = "header" >
< p >
Next: < a href = "#summary-exit-status" accesskey = "n" rel = "next" > summary exit status< / a > , Previous: < a href = "#summary-output_002ddirectory" accesskey = "p" rel = "prev" > summary output-directory< / a > , Up: < a href = "#summary-usage" accesskey = "u" rel = "up" > summary usage< / a > < / p >
2014-12-20 17:52:39 -05:00
< / div >
2019-03-07 08:01:16 -05:00
< a name = "start_002ddate-option" > < / a >
< h4 class = "subsection" > 1.1.4 start-date option< / h4 >
< a name = "index-summary_002dstart_002ddate" > < / a >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< p > This is the “ start date” option.
This option takes a num argument.
2014-12-20 17:52:39 -05:00
Process all files with the date suffix more or equal to value of
2019-03-07 08:01:16 -05:00
this option. Defaults to 197000101.
< / p > < hr >
< a name = "summary-exit-status" > < / a >
< div class = "header" >
< p >
Previous: < a href = "#summary-start_002ddate" accesskey = "p" rel = "prev" > summary start-date< / a > , Up: < a href = "#summary-usage" accesskey = "u" rel = "up" > summary usage< / a > < / p >
2014-12-20 17:52:39 -05:00
< / div >
2019-03-07 08:01:16 -05:00
< a name = "summary-exit-status-1" > < / a >
< h4 class = "subsection" > 1.1.5 summary exit status< / h4 >
2014-12-20 17:52:39 -05:00
< p > One of the following exit values will be returned:
2019-03-07 08:01:16 -05:00
< / p > < dl compact = "compact" >
< dt > ‘ < samp > 0 (EXIT_SUCCESS)< / samp > ’ < / dt >
< dd > < p > Successful program execution.
< / p > < / dd >
< dt > ‘ < samp > 1 (EXIT_FAILURE)< / samp > ’ < / dt >
< dd > < p > The operation failed or the command syntax was not valid.
< / p > < / dd >
2014-12-20 17:52:39 -05:00
< / dl >
2019-03-07 08:01:16 -05:00
< hr >
2014-12-20 17:52:39 -05:00
2019-03-07 08:01:16 -05:00
< / body >
< / html >
