invoke-summary.texi revision 290001 
1@node summary Invocation
2@section Invoking summary
3@pindex summary
4@cindex compute various stastics from NTP stat files
5@ignore
6#
7# EDIT THIS FILE WITH CAUTION  (invoke-summary.texi)
8#
9# It has been AutoGen-ed  October 21, 2015 at 12:34:54 PM by AutoGen 5.18.5
10# From the definitions    summary-opts.def
11# and the template file   agtexi-cmd.tpl
12@end ignore
13
14
15
16
17This section was generated by @strong{AutoGen},
18using the @code{agtexi-cmd} template and the option descriptions for the @code{summary} program.
19
20@menu
21* summary usage::                  summary help/usage (@option{--help})
22* summary directory::              directory option
23* summary end-date::               end-date option
24* summary output-directory::       output-directory option
25* summary start-date::             start-date option
26* summary exit status::            exit status
27@end menu
28
29@node summary usage
30@subsection summary help/usage (@option{--help})
31@cindex summary help
32
33This is the automatically generated usage text for summary.
34
35The text printed is the same whether selected with the @code{help} option
36(@option{--help}) or the @code{more-help} option (@option{--more-help}).  @code{more-help} will print
37the usage text by passing it through a pager program.
38@code{more-help} is disabled on platforms without a working
39@code{fork(2)} function.  The @code{PAGER} environment variable is
40used to select the program, defaulting to @file{more}.  Both will exit
41with a status code of 0.
42
43@exampleindent 0
44@example
45summary - compute various stastics from NTP stat files - Ver. 4.2.8p4
46USAGE: summary [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... 
47
48        --directory=str          Directory containing stat files
49        --end-date=num           End date
50        --output-directory=str   Output directory
51        --peer-dist-limit=float  Peer dist limit
52        --skip-time-steps=float  Ignore time offsets larger that this
53        --start-date=num         Start date
54    -?, --help                   Display usage information and exit
55        --more-help              Pass the extended usage text through a pager
56
57Options are specified by doubled hyphens and their name or by a single
58hyphen and the flag character.
59@end example
60@exampleindent 4
61
62@node summary directory
63@subsection directory option
64@cindex summary-directory
65
66This is the ``directory containing stat files'' option.
67This option takes a string argument.
68        The directory where @code{ntpd} will search for .stat files generated
69        by @code{ntpd}.
70@node summary end-date
71@subsection end-date option
72@cindex summary-end-date
73
74This is the ``end date'' option.
75This option takes a number argument.
76        Process all files with the date suffix less or equal to value of this
77        option.  Defaults to today minus one day (Use @code{date -u +%Y%m%d})
78        to get the timestamp.
79@node summary output-directory
80@subsection output-directory option
81@cindex summary-output-directory
82
83This is the ``output directory'' option.
84This option takes a str argument.
85        The output directory @code{summary} will write all output files to.
86@node summary start-date
87@subsection start-date option
88@cindex summary-start-date
89
90This is the ``start date'' option.
91This option takes a num argument.
92        Process all files with the date suffix more or equal to value of
93        this option.  Defaults to 197000101.
94@node summary exit status
95@subsection summary exit status
96
97One of the following exit values will be returned:
98@table @samp
99@item 0 (EXIT_SUCCESS)
100Successful program execution.
101@item 1 (EXIT_FAILURE)
102The operation failed or the command syntax was not valid.
103@end table
104