1275970Scy@node summary Invocation 2275970Scy@section Invoking summary 3275970Scy@pindex summary 4275970Scy@cindex compute various stastics from NTP stat files 5275970Scy@ignore 6275970Scy# 7275970Scy# EDIT THIS FILE WITH CAUTION (invoke-summary.texi) 8275970Scy# 9338531Sdelphij# It has been AutoGen-ed August 14, 2018 at 08:09:47 AM by AutoGen 5.18.5 10275970Scy# From the definitions summary-opts.def 11275970Scy# and the template file agtexi-cmd.tpl 12275970Scy@end ignore 13275970Scy 14275970Scy 15275970Scy 16275970Scy 17275970ScyThis section was generated by @strong{AutoGen}, 18275970Scyusing the @code{agtexi-cmd} template and the option descriptions for the @code{summary} program. 19275970Scy 20275970Scy@menu 21275970Scy* summary usage:: summary help/usage (@option{--help}) 22275970Scy* summary directory:: directory option 23275970Scy* summary end-date:: end-date option 24275970Scy* summary output-directory:: output-directory option 25275970Scy* summary start-date:: start-date option 26275970Scy* summary exit status:: exit status 27275970Scy@end menu 28275970Scy 29275970Scy@node summary usage 30275970Scy@subsection summary help/usage (@option{--help}) 31275970Scy@cindex summary help 32275970Scy 33275970ScyThis is the automatically generated usage text for summary. 34275970Scy 35275970ScyThe text printed is the same whether selected with the @code{help} option 36275970Scy(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 37275970Scythe usage text by passing it through a pager program. 38275970Scy@code{more-help} is disabled on platforms without a working 39275970Scy@code{fork(2)} function. The @code{PAGER} environment variable is 40275970Scyused to select the program, defaulting to @file{more}. Both will exit 41275970Scywith a status code of 0. 42275970Scy 43275970Scy@exampleindent 0 44275970Scy@example 45338531Sdelphijsummary - compute various stastics from NTP stat files - Ver. 4.2.8p12 46275970ScyUSAGE: summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 47275970Scy 48275970Scy --directory=str Directory containing stat files 49275970Scy --end-date=num End date 50275970Scy --output-directory=str Output directory 51275970Scy --peer-dist-limit=float Peer dist limit 52275970Scy --skip-time-steps=float Ignore time offsets larger that this 53275970Scy --start-date=num Start date 54275970Scy -?, --help Display usage information and exit 55275970Scy --more-help Pass the extended usage text through a pager 56275970Scy 57275970ScyOptions are specified by doubled hyphens and their name or by a single 58275970Scyhyphen and the flag character. 59275970Scy@end example 60275970Scy@exampleindent 4 61275970Scy 62275970Scy@node summary directory 63275970Scy@subsection directory option 64275970Scy@cindex summary-directory 65275970Scy 66275970ScyThis is the ``directory containing stat files'' option. 67275970ScyThis option takes a string argument. 68275970Scy The directory where @code{ntpd} will search for .stat files generated 69275970Scy by @code{ntpd}. 70275970Scy@node summary end-date 71275970Scy@subsection end-date option 72275970Scy@cindex summary-end-date 73275970Scy 74275970ScyThis is the ``end date'' option. 75275970ScyThis option takes a number argument. 76275970Scy Process all files with the date suffix less or equal to value of this 77275970Scy option. Defaults to today minus one day (Use @code{date -u +%Y%m%d}) 78275970Scy to get the timestamp. 79275970Scy@node summary output-directory 80275970Scy@subsection output-directory option 81275970Scy@cindex summary-output-directory 82275970Scy 83275970ScyThis is the ``output directory'' option. 84275970ScyThis option takes a str argument. 85275970Scy The output directory @code{summary} will write all output files to. 86275970Scy@node summary start-date 87275970Scy@subsection start-date option 88275970Scy@cindex summary-start-date 89275970Scy 90275970ScyThis is the ``start date'' option. 91275970ScyThis option takes a num argument. 92275970Scy Process all files with the date suffix more or equal to value of 93275970Scy this option. Defaults to 197000101. 94275970Scy@node summary exit status 95275970Scy@subsection summary exit status 96275970Scy 97275970ScyOne of the following exit values will be returned: 98275970Scy@table @samp 99275970Scy@item 0 (EXIT_SUCCESS) 100275970ScySuccessful program execution. 101275970Scy@item 1 (EXIT_FAILURE) 102275970ScyThe operation failed or the command syntax was not valid. 103275970Scy@end table 104