invoke-ntpsweep.texi revision 298770
1224110Sjchandra@node ntpsweep Invocation 2224110Sjchandra@section Invoking ntpsweep 3224110Sjchandra@pindex ntpsweep 4224110Sjchandra@cindex Print various informations about given ntp servers 5224110Sjchandra@ignore 6224110Sjchandra# 7224110Sjchandra# EDIT THIS FILE WITH CAUTION (invoke-ntpsweep.texi) 8224110Sjchandra# 9224110Sjchandra# It has been AutoGen-ed April 26, 2016 at 08:24:29 PM by AutoGen 5.18.5 10224110Sjchandra# From the definitions ntpsweep-opts.def 11224110Sjchandra# and the template file agtexi-cmd.tpl 12224110Sjchandra@end ignore 13224110Sjchandra 14224110Sjchandra@code{ntpsweep} 15224110Sjchandraprints per host the NTP stratum level, the clock offset in seconds, the daemon 16224110Sjchandraversion, the operating system and the processor. Optionally recursing through 17224110Sjchandraall peers. 18224110Sjchandra 19224110SjchandraThis section was generated by @strong{AutoGen}, 20224110Sjchandrausing the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsweep} program. 21224110Sjchandra 22224110Sjchandra@menu 23224110Sjchandra* ntpsweep usage:: ntpsweep help/usage (@option{--help}) 24224110Sjchandra* ntpsweep host-list:: host-list option (-l) 25224110Sjchandra* ntpsweep peers:: peers option (-p) 26224110Sjchandra* ntpsweep maxlevel:: maxlevel option (-m) 27224110Sjchandra* ntpsweep strip:: strip option (-s) 28225394Sjchandra* ntpsweep host:: host option (-h) 29224110Sjchandra* ntpsweep exit status:: exit status 30225394Sjchandra@end menu 31224110Sjchandra 32225394Sjchandra@node ntpsweep usage 33227722Sjchandra@subsection ntpsweep help/usage (@option{--help}) 34224110Sjchandra@cindex ntpsweep help 35224110Sjchandra 36227722SjchandraThis is the automatically generated usage text for ntpsweep. 37227722Sjchandra 38224110SjchandraThe text printed is the same whether selected with the @code{help} option 39227722Sjchandra(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 40227722Sjchandrathe usage text by passing it through a pager program. 41227722Sjchandra@code{more-help} is disabled on platforms without a working 42227722Sjchandra@code{fork(2)} function. The @code{PAGER} environment variable is 43227722Sjchandraused to select the program, defaulting to @file{more}. Both will exit 44227722Sjchandrawith a status code of 0. 45227722Sjchandra 46224110Sjchandra@exampleindent 0 47227722Sjchandra@example 48227722Sjchandrantpsweep - Print various informations about given ntp servers - Ver. 4.2.8p7 49224110SjchandraUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostfile] 50227722Sjchandra 51227722Sjchandra -l, --host-list=str Host to execute actions on 52224110Sjchandra - may appear multiple times 53224110Sjchandra -p, --peers Recursively list all peers a host synchronizes to 54227722Sjchandra -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 55227722Sjchandra -s, --strip=str Strip this string from hostnames 56227722Sjchandra -?, --help Display usage information and exit 57227722Sjchandra --more-help Pass the extended usage text through a pager 58227722Sjchandra 59227722SjchandraOptions are specified by doubled hyphens and their name or by a single 60227722Sjchandrahyphen and the flag character. 61227722Sjchandra@end example 62227722Sjchandra@exampleindent 4 63227722Sjchandra 64227722Sjchandra@node ntpsweep host-list 65227722Sjchandra@subsection host-list option (-l) 66227722Sjchandra@cindex ntpsweep-host-list 67224110Sjchandra 68224110SjchandraThis is the ``host to execute actions on'' option. 69227722SjchandraThis option takes a string argument. 70227722Sjchandra 71227722Sjchandra@noindent 72227722SjchandraThis option has some usage constraints. It: 73227722Sjchandra@itemize @bullet 74224110Sjchandra@item 75224110Sjchandramay appear an unlimited number of times. 76227722Sjchandra@end itemize 77227722Sjchandra 78227722Sjchandra Use this option to specify the host on which this script operates. 79227722Sjchandra May appear multiple times. 80227722Sjchandra@node ntpsweep peers 81227722Sjchandra@subsection peers option (-p) 82224110Sjchandra@cindex ntpsweep-peers 83224110Sjchandra 84227722SjchandraThis is the ``recursively list all peers a host synchronizes to'' option. 85227722SjchandraThis option has no @samp{doc} documentation. 86227722Sjchandra@node ntpsweep maxlevel 87227722Sjchandra@subsection maxlevel option (-m) 88224110Sjchandra@cindex ntpsweep-maxlevel 89224110Sjchandra 90224110SjchandraThis is the ``traverse peers up to this level (4 is a reasonable number)'' option. 91225394SjchandraThis option takes a number argument. 92225394SjchandraThis option has no @samp{doc} documentation. 93227722Sjchandra@node ntpsweep strip 94225394Sjchandra@subsection strip option (-s) 95227722Sjchandra@cindex ntpsweep-strip 96225394Sjchandra 97224110SjchandraThis is the ``strip this string from hostnames'' option. 98225394SjchandraThis option takes a string argument. 99224110SjchandraThis option has no @samp{doc} documentation. 100224110Sjchandra@node ntpsweep host 101224110Sjchandra@subsection host option (-h) 102224110Sjchandra@cindex ntpsweep-host 103225394Sjchandra 104224110SjchandraThis is the ``specify a single host'' option. 105224110SjchandraThis option takes a string argument. 106225394SjchandraThis option has no @samp{doc} documentation. 107225394Sjchandra 108225394Sjchandra@strong{NOTE}@strong{: THIS OPTION IS DEPRECATED} 109225394Sjchandra@node ntpsweep exit status 110225394Sjchandra@subsection ntpsweep exit status 111224110Sjchandra 112224110SjchandraOne of the following exit values will be returned: 113225394Sjchandra@table @samp 114224110Sjchandra@item 0 (EXIT_SUCCESS) 115224110SjchandraSuccessful program execution. 116225394Sjchandra@item 1 (EXIT_FAILURE) 117225394SjchandraThe operation failed or the command syntax was not valid. 118224110Sjchandra@end table 119224110Sjchandra