invoke-ntpsweep.texi revision 294905
1249268Sglebius@node ntpsweep Invocation 2249268Sglebius@section Invoking ntpsweep 3249268Sglebius@pindex ntpsweep 4249268Sglebius@cindex Print various informations about given ntp servers 5249268Sglebius@ignore 6249268Sglebius# 7249268Sglebius# EDIT THIS FILE WITH CAUTION (invoke-ntpsweep.texi) 8249268Sglebius# 9249268Sglebius# It has been AutoGen-ed January 20, 2016 at 04:10:03 AM by AutoGen 5.18.5 10249268Sglebius# From the definitions ntpsweep-opts.def 11249268Sglebius# and the template file agtexi-cmd.tpl 12249268Sglebius@end ignore 13249268Sglebius 14249268Sglebius@code{ntpsweep} 15249268Sglebiusprints per host the NTP stratum level, the clock offset in seconds, the daemon 16249268Sglebiusversion, the operating system and the processor. Optionally recursing through 17249268Sglebiusall peers. 18249268Sglebius 19249268SglebiusThis section was generated by @strong{AutoGen}, 20249268Sglebiususing the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsweep} program. 21249268Sglebius 22249268Sglebius@menu 23249268Sglebius* ntpsweep usage:: ntpsweep help/usage (@option{--help}) 24249268Sglebius* ntpsweep host-list:: host-list option (-l) 25249268Sglebius* ntpsweep peers:: peers option (-p) 26249268Sglebius* ntpsweep maxlevel:: maxlevel option (-m) 27249268Sglebius* ntpsweep strip:: strip option (-s) 28249268Sglebius* ntpsweep host:: host option (-h) 29249268Sglebius* ntpsweep exit status:: exit status 30249268Sglebius@end menu 31249268Sglebius 32249268Sglebius@node ntpsweep usage 33249268Sglebius@subsection ntpsweep help/usage (@option{--help}) 34249268Sglebius@cindex ntpsweep help 35249268Sglebius 36249268SglebiusThis is the automatically generated usage text for ntpsweep. 37249268Sglebius 38249268SglebiusThe text printed is the same whether selected with the @code{help} option 39249268Sglebius(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 40252434Skibthe usage text by passing it through a pager program. 41252434Skib@code{more-help} is disabled on platforms without a working 42252434Skib@code{fork(2)} function. The @code{PAGER} environment variable is 43252434Skibused to select the program, defaulting to @file{more}. Both will exit 44252434Skibwith a status code of 0. 45252434Skib 46252434Skib@exampleindent 0 47252434Skib@example 48252434Skibntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p6 49252434SkibUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostfile] 50252434Skib 51252434Skib -l, --host-list=str Host to execute actions on 52252434Skib - may appear multiple times 53252434Skib -p, --peers Recursively list all peers a host synchronizes to 54252434Skib -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 55252434Skib -s, --strip=str Strip this string from hostnames 56252434Skib -?, --help Display usage information and exit 57252434Skib --more-help Pass the extended usage text through a pager 58252434Skib 59252434SkibOptions are specified by doubled hyphens and their name or by a single 60252434Skibhyphen and the flag character. 61252434Skib@end example 62252434Skib@exampleindent 4 63252434Skib 64252434Skib@node ntpsweep host-list 65252434Skib@subsection host-list option (-l) 66252434Skib@cindex ntpsweep-host-list 67252434Skib 68252434SkibThis is the ``host to execute actions on'' option. 69252434SkibThis option takes a string argument. 70252434Skib 71252434Skib@noindent 72252434SkibThis option has some usage constraints. It: 73252434Skib@itemize @bullet 74252434Skib@item 75252434Skibmay appear an unlimited number of times. 76252434Skib@end itemize 77252434Skib 78252434Skib Use this option to specify the host on which this script operates. 79249268Sglebius May appear multiple times. 80249268Sglebius@node ntpsweep peers 81249268Sglebius@subsection peers option (-p) 82249268Sglebius@cindex ntpsweep-peers 83249268Sglebius 84249268SglebiusThis is the ``recursively list all peers a host synchronizes to'' option. 85249268SglebiusThis option has no @samp{doc} documentation. 86249268Sglebius@node ntpsweep maxlevel 87249268Sglebius@subsection maxlevel option (-m) 88249268Sglebius@cindex ntpsweep-maxlevel 89249268Sglebius 90249268SglebiusThis is the ``traverse peers up to this level (4 is a reasonable number)'' option. 91249268SglebiusThis option takes a number argument. 92249268SglebiusThis option has no @samp{doc} documentation. 93249268Sglebius@node ntpsweep strip 94@subsection strip option (-s) 95@cindex ntpsweep-strip 96 97This is the ``strip this string from hostnames'' option. 98This option takes a string argument. 99This option has no @samp{doc} documentation. 100@node ntpsweep host 101@subsection host option (-h) 102@cindex ntpsweep-host 103 104This is the ``specify a single host'' option. 105This option takes a string argument. 106This option has no @samp{doc} documentation. 107 108@strong{NOTE}@strong{: THIS OPTION IS DEPRECATED} 109@node ntpsweep exit status 110@subsection ntpsweep exit status 111 112One of the following exit values will be returned: 113@table @samp 114@item 0 (EXIT_SUCCESS) 115Successful program execution. 116@item 1 (EXIT_FAILURE) 117The operation failed or the command syntax was not valid. 118@end table 119