invoke-summary.texi revision 285612
1215976Sjmallett@node summary Invocation 2232812Sjmallett@section Invoking summary 3215976Sjmallett@pindex summary 4215976Sjmallett@cindex compute various stastics from NTP stat files 5215976Sjmallett@ignore 6215976Sjmallett# 7215976Sjmallett# EDIT THIS FILE WITH CAUTION (invoke-summary.texi) 8215976Sjmallett# 9215976Sjmallett# It has been AutoGen-ed June 29, 2015 at 04:27:14 PM by AutoGen 5.18.5 10215976Sjmallett# From the definitions summary-opts.def 11215976Sjmallett# and the template file agtexi-cmd.tpl 12215976Sjmallett@end ignore 13215976Sjmallett 14215976Sjmallett 15215976Sjmallett 16215976Sjmallett 17215976SjmallettThis section was generated by @strong{AutoGen}, 18232812Sjmallettusing the @code{agtexi-cmd} template and the option descriptions for the @code{summary} program. 19215976Sjmallett 20215976Sjmallett@menu 21215976Sjmallett* summary usage:: summary help/usage (@option{--help}) 22215976Sjmallett* summary directory:: directory option 23215976Sjmallett* summary end-date:: end-date option 24215976Sjmallett* summary output-directory:: output-directory option 25215976Sjmallett* summary start-date:: start-date option 26215976Sjmallett* summary exit status:: exit status 27215976Sjmallett@end menu 28215976Sjmallett 29232812Sjmallett@node summary usage 30215976Sjmallett@subsection summary help/usage (@option{--help}) 31215976Sjmallett@cindex summary help 32215976Sjmallett 33215976SjmallettThis is the automatically generated usage text for summary. 34215976Sjmallett 35215976SjmallettThe text printed is the same whether selected with the @code{help} option 36215976Sjmallett(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 37215976Sjmallettthe usage text by passing it through a pager program. 38215976Sjmallett@code{more-help} is disabled on platforms without a working 39215976Sjmallett@code{fork(2)} function. The @code{PAGER} environment variable is 40215976Sjmallettused to select the program, defaulting to @file{more}. Both will exit 41215976Sjmallettwith a status code of 0. 42215976Sjmallett 43215976Sjmallett@exampleindent 0 44215976Sjmallett@example 45215976Sjmallettsummary - compute various stastics from NTP stat files - Ver. 4.2.8p3 46215976SjmallettUSAGE: summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 47215976Sjmallett 48215976Sjmallett --directory=str Directory containing stat files 49215976Sjmallett --end-date=num End date 50215976Sjmallett --output-directory=str Output directory 51215976Sjmallett --peer-dist-limit=float Peer dist limit 52215976Sjmallett --skip-time-steps=float Ignore time offsets larger that this 53215976Sjmallett --start-date=num Start date 54215976Sjmallett -?, --help Display usage information and exit 55215976Sjmallett --more-help Pass the extended usage text through a pager 56215976Sjmallett 57215976SjmallettOptions are specified by doubled hyphens and their name or by a single 58215976Sjmalletthyphen and the flag character. 59215976Sjmallett@end example 60215976Sjmallett@exampleindent 4 61215976Sjmallett 62215990Sjmallett@node summary directory 63215976Sjmallett@subsection directory option 64215990Sjmallett@cindex summary-directory 65215976Sjmallett 66215976SjmallettThis is the ``directory containing stat files'' option. 67215976SjmallettThis option takes a string argument. 68215976Sjmallett The directory where @code{ntpd} will search for .stat files generated 69215976Sjmallett by @code{ntpd}. 70215976Sjmallett@node summary end-date 71215976Sjmallett@subsection end-date option 72215976Sjmallett@cindex summary-end-date 73215976Sjmallett 74215976SjmallettThis is the ``end date'' option. 75215976SjmallettThis option takes a number argument. 76215976Sjmallett Process all files with the date suffix less or equal to value of this 77215976Sjmallett option. Defaults to today minus one day (Use @code{date -u +%Y%m%d}) 78215976Sjmallett to get the timestamp. 79215976Sjmallett@node summary output-directory 80215976Sjmallett@subsection output-directory option 81215976Sjmallett@cindex summary-output-directory 82215976Sjmallett 83215976SjmallettThis is the ``output directory'' option. 84215976SjmallettThis option takes a str argument. 85215976Sjmallett The output directory @code{summary} will write all output files to. 86215976Sjmallett@node summary start-date 87215976Sjmallett@subsection start-date option 88215976Sjmallett@cindex summary-start-date 89215976Sjmallett 90215976SjmallettThis is the ``start date'' option. 91215976SjmallettThis option takes a num argument. 92232812Sjmallett Process all files with the date suffix more or equal to value of 93232812Sjmallett this option. Defaults to 197000101. 94232812Sjmallett@node summary exit status 95215976Sjmallett@subsection summary exit status 96215976Sjmallett 97215976SjmallettOne of the following exit values will be returned: 98215976Sjmallett@table @samp 99215976Sjmallett@item 0 (EXIT_SUCCESS) 100215976SjmallettSuccessful program execution. 101215976Sjmallett@item 1 (EXIT_FAILURE) 102215976SjmallettThe operation failed or the command syntax was not valid. 103215976Sjmallett@end table 104215976Sjmallett