invoke-ntpsweep.texi revision 298699
1238104Sdes@node ntpsweep Invocation 2238104Sdes@section Invoking ntpsweep 3238104Sdes@pindex ntpsweep 4238104Sdes@cindex Print various informations about given ntp servers 5238104Sdes@ignore 6238104Sdes# 7238104Sdes# EDIT THIS FILE WITH CAUTION (invoke-ntpsweep.texi) 8238104Sdes# 9238104Sdes# It has been AutoGen-ed April 26, 2016 at 08:24:29 PM by AutoGen 5.18.5 10238104Sdes# From the definitions ntpsweep-opts.def 11238104Sdes# and the template file agtexi-cmd.tpl 12238104Sdes@end ignore 13238104Sdes 14238104Sdes@code{ntpsweep} 15238104Sdesprints per host the NTP stratum level, the clock offset in seconds, the daemon 16238104Sdesversion, the operating system and the processor. Optionally recursing through 17238104Sdesall peers. 18238104Sdes 19238104SdesThis section was generated by @strong{AutoGen}, 20238104Sdesusing the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsweep} program. 21238104Sdes 22238104Sdes@menu 23238104Sdes* ntpsweep usage:: ntpsweep help/usage (@option{--help}) 24238104Sdes* ntpsweep host-list:: host-list option (-l) 25238104Sdes* ntpsweep peers:: peers option (-p) 26238104Sdes* ntpsweep maxlevel:: maxlevel option (-m) 27238104Sdes* ntpsweep strip:: strip option (-s) 28238104Sdes* ntpsweep host:: host option (-h) 29238104Sdes* ntpsweep exit status:: exit status 30238104Sdes@end menu 31238104Sdes 32238104Sdes@node ntpsweep usage 33238104Sdes@subsection ntpsweep help/usage (@option{--help}) 34238104Sdes@cindex ntpsweep help 35238104Sdes 36238104SdesThis is the automatically generated usage text for ntpsweep. 37238104Sdes 38238104SdesThe text printed is the same whether selected with the @code{help} option 39238104Sdes(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print 40238104Sdesthe usage text by passing it through a pager program. 41238104Sdes@code{more-help} is disabled on platforms without a working 42238104Sdes@code{fork(2)} function. The @code{PAGER} environment variable is 43238104Sdesused to select the program, defaulting to @file{more}. Both will exit 44238104Sdeswith a status code of 0. 45238104Sdes 46238104Sdes@exampleindent 0 47238104Sdes@example 48238104Sdesntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p7 49238104SdesUSAGE: ntpsweep [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostfile] 50238104Sdes 51238104Sdes -l, --host-list=str Host to execute actions on 52238104Sdes - may appear multiple times 53238104Sdes -p, --peers Recursively list all peers a host synchronizes to 54238104Sdes -m, --maxlevel=num Traverse peers up to this level (4 is a reasonable number) 55238104Sdes -s, --strip=str Strip this string from hostnames 56238104Sdes -?, --help Display usage information and exit 57238104Sdes --more-help Pass the extended usage text through a pager 58238104Sdes 59238104SdesOptions are specified by doubled hyphens and their name or by a single 60238104Sdeshyphen and the flag character. 61238104Sdes@end example 62238104Sdes@exampleindent 4 63238104Sdes 64238104Sdes@node ntpsweep host-list 65238104Sdes@subsection host-list option (-l) 66238104Sdes@cindex ntpsweep-host-list 67238104Sdes 68238104SdesThis is the ``host to execute actions on'' option. 69238104SdesThis option takes a string argument. 70238104Sdes 71238104Sdes@noindent 72238104SdesThis option has some usage constraints. It: 73238104Sdes@itemize @bullet 74238104Sdes@item 75238104Sdesmay appear an unlimited number of times. 76238104Sdes@end itemize 77238104Sdes 78238104Sdes Use this option to specify the host on which this script operates. 79238104Sdes May appear multiple times. 80238104Sdes@node ntpsweep peers 81238104Sdes@subsection peers option (-p) 82238104Sdes@cindex ntpsweep-peers 83238104Sdes 84238104SdesThis is the ``recursively list all peers a host synchronizes to'' option. 85238104SdesThis option has no @samp{doc} documentation. 86238104Sdes@node ntpsweep maxlevel 87238104Sdes@subsection maxlevel option (-m) 88238104Sdes@cindex ntpsweep-maxlevel 89238104Sdes 90238104SdesThis is the ``traverse peers up to this level (4 is a reasonable number)'' option. 91238104SdesThis option takes a number argument. 92238104SdesThis option has no @samp{doc} documentation. 93238104Sdes@node ntpsweep strip 94238104Sdes@subsection strip option (-s) 95238104Sdes@cindex ntpsweep-strip 96238104Sdes 97238104SdesThis is the ``strip this string from hostnames'' option. 98238104SdesThis option takes a string argument. 99238104SdesThis option has no @samp{doc} documentation. 100238104Sdes@node ntpsweep host 101238104Sdes@subsection host option (-h) 102238104Sdes@cindex ntpsweep-host 103238104Sdes 104238104SdesThis is the ``specify a single host'' option. 105238104SdesThis option takes a string argument. 106238104SdesThis option has no @samp{doc} documentation. 107238104Sdes 108238104Sdes@strong{NOTE}@strong{: THIS OPTION IS DEPRECATED} 109238104Sdes@node ntpsweep exit status 110238104Sdes@subsection ntpsweep exit status 111238104Sdes 112238104SdesOne of the following exit values will be returned: 113238104Sdes@table @samp 114238104Sdes@item 0 (EXIT_SUCCESS) 115238104SdesSuccessful program execution. 116238104Sdes@item 1 (EXIT_FAILURE) 117238104SdesThe operation failed or the command syntax was not valid. 118238104Sdes@end table 119238104Sdes