1275970Scy@node ntpsweep Invocation 2275970Scy@section Invoking ntpsweep 3275970Scy@pindex ntpsweep 4275970Scy@cindex Print various informations about given ntp servers 5275970Scy@ignore 6275970Scy# 7275970Scy# EDIT THIS FILE WITH CAUTION (invoke-ntpsweep.texi) 8275970Scy# 9338531Sdelphij# It has been AutoGen-ed August 14, 2018 at 08:09:13 AM by AutoGen 5.18.5 10275970Scy# From the definitions ntpsweep-opts.def 11275970Scy# and the template file agtexi-cmd.tpl 12275970Scy@end ignore 13275970Scy 14275970Scy@code{ntpsweep} 15275970Scyprints per host the NTP stratum level, the clock offset in seconds, the daemon 16275970Scyversion, the operating system and the processor. Optionally recursing through 17275970Scyall peers. 18275970Scy 19275970ScyThis section was generated by @strong{AutoGen}, 20275970Scyusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsweep} program. 21275970Scy 22275970Scy@menu 23275970Scy* ntpsweep usage:: ntpsweep help/usage (@option{--help}) 24275970Scy* ntpsweep host-list:: host-list option (-l) 25275970Scy* ntpsweep peers:: peers option (-p) 26275970Scy* ntpsweep maxlevel:: maxlevel option (-m) 27275970Scy* ntpsweep strip:: strip option (-s) 28275970Scy* ntpsweep host:: host option (-h) 29275970Scy* ntpsweep exit status:: exit status 30275970Scy@end menu 31275970Scy 32275970Scy@node ntpsweep usage 33275970Scy@subsection ntpsweep help/usage (@option{--help}) 34275970Scy@cindex ntpsweep help 35275970Scy 36275970ScyThis is the automatically generated usage text for ntpsweep. 37275970Scy 38275970ScyThe text printed is the same whether selected with the @code{help} option 39275970Scy(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 40275970Scythe usage text by passing it through a pager program. 41275970Scy@code{more-help} is disabled on platforms without a working 42275970Scy@code{fork(2)} function. The @code{PAGER} environment variable is 43275970Scyused to select the program, defaulting to @file{more}. Both will exit 44275970Scywith a status code of 0. 45275970Scy 46275970Scy@exampleindent 0 47275970Scy@example 48338531Sdelphijntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p12 49275970ScyUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostfile] 50275970Scy 51275970Scy -l, --host-list=str Host to execute actions on 52275970Scy - may appear multiple times 53275970Scy -p, --peers Recursively list all peers a host synchronizes to 54275970Scy -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 55275970Scy -s, --strip=str Strip this string from hostnames 56275970Scy -?, --help Display usage information and exit 57275970Scy --more-help Pass the extended usage text through a pager 58275970Scy 59275970ScyOptions are specified by doubled hyphens and their name or by a single 60275970Scyhyphen and the flag character. 61275970Scy@end example 62275970Scy@exampleindent 4 63275970Scy 64275970Scy@node ntpsweep host-list 65275970Scy@subsection host-list option (-l) 66275970Scy@cindex ntpsweep-host-list 67275970Scy 68275970ScyThis is the ``host to execute actions on'' option. 69275970ScyThis option takes a string argument. 70275970Scy 71275970Scy@noindent 72275970ScyThis option has some usage constraints. It: 73275970Scy@itemize @bullet 74275970Scy@item 75275970Scymay appear an unlimited number of times. 76275970Scy@end itemize 77275970Scy 78275970Scy Use this option to specify the host on which this script operates. 79275970Scy May appear multiple times. 80275970Scy@node ntpsweep peers 81275970Scy@subsection peers option (-p) 82275970Scy@cindex ntpsweep-peers 83275970Scy 84275970ScyThis is the ``recursively list all peers a host synchronizes to'' option. 85275970ScyThis option has no @samp{doc} documentation. 86275970Scy@node ntpsweep maxlevel 87275970Scy@subsection maxlevel option (-m) 88275970Scy@cindex ntpsweep-maxlevel 89275970Scy 90275970ScyThis is the ``traverse peers up to this level (4 is a reasonable number)'' option. 91275970ScyThis option takes a number argument. 92275970ScyThis option has no @samp{doc} documentation. 93275970Scy@node ntpsweep strip 94275970Scy@subsection strip option (-s) 95275970Scy@cindex ntpsweep-strip 96275970Scy 97275970ScyThis is the ``strip this string from hostnames'' option. 98275970ScyThis option takes a string argument. 99275970ScyThis option has no @samp{doc} documentation. 100275970Scy@node ntpsweep host 101275970Scy@subsection host option (-h) 102275970Scy@cindex ntpsweep-host 103275970Scy 104275970ScyThis is the ``specify a single host'' option. 105275970ScyThis option takes a string argument. 106275970ScyThis option has no @samp{doc} documentation. 107275970Scy 108275970Scy@strong{NOTE}@strong{: THIS OPTION IS DEPRECATED} 109275970Scy@node ntpsweep exit status 110275970Scy@subsection ntpsweep exit status 111275970Scy 112275970ScyOne of the following exit values will be returned: 113275970Scy@table @samp 114275970Scy@item 0 (EXIT_SUCCESS) 115275970ScySuccessful program execution. 116275970Scy@item 1 (EXIT_FAILURE) 117275970ScyThe operation failed or the command syntax was not valid. 118275970Scy@end table 119