1290001Sglebius@node summary Invocation 2290001Sglebius@section Invoking summary 3290001Sglebius@pindex summary 4290001Sglebius@cindex compute various stastics from NTP stat files 5290001Sglebius@ignore 6290001Sglebius# 7290001Sglebius# EDIT THIS FILE WITH CAUTION (invoke-summary.texi) 8290001Sglebius# 9310419Sdelphij# It has been AutoGen-ed November 21, 2016 at 07:59:32 AM by AutoGen 5.18.5 10290001Sglebius# From the definitions summary-opts.def 11290001Sglebius# and the template file agtexi-cmd.tpl 12290001Sglebius@end ignore 13290001Sglebius 14290001Sglebius 15290001Sglebius 16290001Sglebius 17290001SglebiusThis section was generated by @strong{AutoGen}, 18290001Sglebiususing the @code{agtexi-cmd} template and the option descriptions for the @code{summary} program. 19290001Sglebius 20290001Sglebius@menu 21290001Sglebius* summary usage:: summary help/usage (@option{--help}) 22290001Sglebius* summary directory:: directory option 23290001Sglebius* summary end-date:: end-date option 24290001Sglebius* summary output-directory:: output-directory option 25290001Sglebius* summary start-date:: start-date option 26290001Sglebius* summary exit status:: exit status 27290001Sglebius@end menu 28290001Sglebius 29290001Sglebius@node summary usage 30290001Sglebius@subsection summary help/usage (@option{--help}) 31290001Sglebius@cindex summary help 32290001Sglebius 33290001SglebiusThis is the automatically generated usage text for summary. 34290001Sglebius 35290001SglebiusThe text printed is the same whether selected with the @code{help} option 36290001Sglebius(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 37290001Sglebiusthe usage text by passing it through a pager program. 38290001Sglebius@code{more-help} is disabled on platforms without a working 39290001Sglebius@code{fork(2)} function. The @code{PAGER} environment variable is 40290001Sglebiusused to select the program, defaulting to @file{more}. Both will exit 41290001Sglebiuswith a status code of 0. 42290001Sglebius 43290001Sglebius@exampleindent 0 44290001Sglebius@example 45310419Sdelphijsummary - compute various stastics from NTP stat files - Ver. 4.2.8p9 46290001SglebiusUSAGE: summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 47290001Sglebius 48290001Sglebius --directory=str Directory containing stat files 49290001Sglebius --end-date=num End date 50290001Sglebius --output-directory=str Output directory 51290001Sglebius --peer-dist-limit=float Peer dist limit 52290001Sglebius --skip-time-steps=float Ignore time offsets larger that this 53290001Sglebius --start-date=num Start date 54290001Sglebius -?, --help Display usage information and exit 55290001Sglebius --more-help Pass the extended usage text through a pager 56290001Sglebius 57290001SglebiusOptions are specified by doubled hyphens and their name or by a single 58290001Sglebiushyphen and the flag character. 59290001Sglebius@end example 60290001Sglebius@exampleindent 4 61290001Sglebius 62290001Sglebius@node summary directory 63290001Sglebius@subsection directory option 64290001Sglebius@cindex summary-directory 65290001Sglebius 66290001SglebiusThis is the ``directory containing stat files'' option. 67290001SglebiusThis option takes a string argument. 68290001Sglebius The directory where @code{ntpd} will search for .stat files generated 69290001Sglebius by @code{ntpd}. 70290001Sglebius@node summary end-date 71290001Sglebius@subsection end-date option 72290001Sglebius@cindex summary-end-date 73290001Sglebius 74290001SglebiusThis is the ``end date'' option. 75290001SglebiusThis option takes a number argument. 76290001Sglebius Process all files with the date suffix less or equal to value of this 77290001Sglebius option. Defaults to today minus one day (Use @code{date -u +%Y%m%d}) 78290001Sglebius to get the timestamp. 79290001Sglebius@node summary output-directory 80290001Sglebius@subsection output-directory option 81290001Sglebius@cindex summary-output-directory 82290001Sglebius 83290001SglebiusThis is the ``output directory'' option. 84290001SglebiusThis option takes a str argument. 85290001Sglebius The output directory @code{summary} will write all output files to. 86290001Sglebius@node summary start-date 87290001Sglebius@subsection start-date option 88290001Sglebius@cindex summary-start-date 89290001Sglebius 90290001SglebiusThis is the ``start date'' option. 91290001SglebiusThis option takes a num argument. 92290001Sglebius Process all files with the date suffix more or equal to value of 93290001Sglebius this option. Defaults to 197000101. 94290001Sglebius@node summary exit status 95290001Sglebius@subsection summary exit status 96290001Sglebius 97290001SglebiusOne of the following exit values will be returned: 98290001Sglebius@table @samp 99290001Sglebius@item 0 (EXIT_SUCCESS) 100290001SglebiusSuccessful program execution. 101290001Sglebius@item 1 (EXIT_FAILURE) 102290001SglebiusThe operation failed or the command syntax was not valid. 103290001Sglebius@end table 104