invoke-summary.texi revision 309008
1157642Sps@node summary Invocation 2205300Sdavidch@section Invoking summary 3157642Sps@pindex summary 4157642Sps@cindex compute various stastics from NTP stat files 5157642Sps@ignore 6157642Sps# 7157642Sps# EDIT THIS FILE WITH CAUTION (invoke-summary.texi) 8157642Sps# 9157642Sps# It has been AutoGen-ed November 21, 2016 at 07:59:32 AM by AutoGen 5.18.5 10157642Sps# From the definitions summary-opts.def 11157642Sps# and the template file agtexi-cmd.tpl 12157642Sps@end ignore 13157642Sps 14157642Sps 15157642Sps 16157642Sps 17157642SpsThis section was generated by @strong{AutoGen}, 18157642Spsusing the @code{agtexi-cmd} template and the option descriptions for the @code{summary} program. 19157642Sps 20157642Sps@menu 21157642Sps* summary usage:: summary help/usage (@option{--help}) 22157642Sps* summary directory:: directory option 23157642Sps* summary end-date:: end-date option 24157642Sps* summary output-directory:: output-directory option 25157642Sps* summary start-date:: start-date option 26157642Sps* summary exit status:: exit status 27157642Sps@end menu 28157642Sps 29157642Sps@node summary usage 30157642Sps@subsection summary help/usage (@option{--help}) 31157642Sps@cindex summary help 32189325Sdavidch 33189325SdavidchThis is the automatically generated usage text for summary. 34157642Sps 35157642SpsThe text printed is the same whether selected with the @code{help} option 36157642Sps(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 37157642Spsthe usage text by passing it through a pager program. 38157642Sps@code{more-help} is disabled on platforms without a working 39157642Sps@code{fork(2)} function. The @code{PAGER} environment variable is 40157642Spsused to select the program, defaulting to @file{more}. Both will exit 41157642Spswith a status code of 0. 42157642Sps 43157642Sps@exampleindent 0 44157642Sps@example 45157642Spssummary - compute various stastics from NTP stat files - Ver. 4.2.8p9 46157642SpsUSAGE: summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 47169632Sdavidch 48169632Sdavidch --directory=str Directory containing stat files 49157642Sps --end-date=num End date 50157642Sps --output-directory=str Output directory 51157642Sps --peer-dist-limit=float Peer dist limit 52157642Sps --skip-time-steps=float Ignore time offsets larger that this 53157642Sps --start-date=num Start date 54157642Sps -?, --help Display usage information and exit 55157642Sps --more-help Pass the extended usage text through a pager 56157642Sps 57157642SpsOptions are specified by doubled hyphens and their name or by a single 58157642Spshyphen and the flag character. 59169632Sdavidch@end example 60157642Sps@exampleindent 4 61169632Sdavidch 62169632Sdavidch@node summary directory 63169632Sdavidch@subsection directory option 64170392Sdavidch@cindex summary-directory 65157642Sps 66157642SpsThis is the ``directory containing stat files'' option. 67157642SpsThis option takes a string argument. 68157642Sps The directory where @code{ntpd} will search for .stat files generated 69157642Sps by @code{ntpd}. 70157642Sps@node summary end-date 71157642Sps@subsection end-date option 72157642Sps@cindex summary-end-date 73157642Sps 74157642SpsThis is the ``end date'' option. 75157642SpsThis option takes a number argument. 76157642Sps Process all files with the date suffix less or equal to value of this 77157642Sps option. Defaults to today minus one day (Use @code{date -u +%Y%m%d}) 78157642Sps to get the timestamp. 79157642Sps@node summary output-directory 80157642Sps@subsection output-directory option 81157642Sps@cindex summary-output-directory 82157642Sps 83157642SpsThis is the ``output directory'' option. 84206268SdavidchThis option takes a str argument. 85206268Sdavidch The output directory @code{summary} will write all output files to. 86206268Sdavidch@node summary start-date 87157642Sps@subsection start-date option 88157642Sps@cindex summary-start-date 89157642Sps 90157642SpsThis is the ``start date'' option. 91157642SpsThis option takes a num argument. 92157642Sps Process all files with the date suffix more or equal to value of 93157642Sps this option. Defaults to 197000101. 94157642Sps@node summary exit status 95178132Sdavidch@subsection summary exit status 96178132Sdavidch 97206268SdavidchOne of the following exit values will be returned: 98206268Sdavidch@table @samp 99206268Sdavidch@item 0 (EXIT_SUCCESS) 100206268SdavidchSuccessful program execution. 101206268Sdavidch@item 1 (EXIT_FAILURE) 102206268SdavidchThe operation failed or the command syntax was not valid. 103206268Sdavidch@end table 104206268Sdavidch