contrib/ntp/scripts/ntpsweep/invoke-ntpsweep.texi

   1 @node ntpsweep Invocation
   2 @section Invoking ntpsweep
   3 @pindex ntpsweep
   4 @cindex Print various informations about given ntp servers
   5 @ignore
   6 #
   7 # EDIT THIS FILE WITH CAUTION  (invoke-ntpsweep.texi)
   8 #
   9 # It has been AutoGen-ed  February 27, 2018 at 10:49:59 AM by AutoGen 5.18.5
  10 # From the definitions    ntpsweep-opts.def
  11 # and the template file   agtexi-cmd.tpl
  12 @end ignore
  13
  14 @code{ntpsweep}
  15 prints per host the NTP stratum level, the clock offset in seconds, the daemon
  16 version, the operating system and the processor. Optionally recursing through
  17 all peers.
  18
  19 This section was generated by @strong{AutoGen},
  20 using the @code{agtexi-cmd} template and the option descriptions for the @code{ntpsweep} program.
  21
  22 @menu
  23 * ntpsweep usage::                  ntpsweep help/usage (@option{--help})
  24 * ntpsweep host-list::              host-list option (-l)
  25 * ntpsweep peers::                  peers option (-p)
  26 * ntpsweep maxlevel::               maxlevel option (-m)
  27 * ntpsweep strip::                  strip option (-s)
  28 * ntpsweep host::                   host option (-h)
  29 * ntpsweep exit status::            exit status
  30 @end menu
  31
  32 @node ntpsweep usage
  33 @subsection ntpsweep help/usage (@option{--help})
  34 @cindex ntpsweep help
  35
  36 This is the automatically generated usage text for ntpsweep.
  37
  38 The text printed is the same whether selected with the @code{help} option
  39 (@option{--help}) or the @code{more-help} option (@option{--more-help}).  @code{more-help} will print
  40 the usage text by passing it through a pager program.
  41 @code{more-help} is disabled on platforms without a working
  42 @code{fork(2)} function.  The @code{PAGER} environment variable is
  43 used to select the program, defaulting to @file{more}.  Both will exit
  44 with a status code of 0.
  45
  46 @exampleindent 0
  47 @example
  48 ntpsweep - Print various informations about given ntp servers - Ver. 4.2.8p11
  49 USAGE: ntpsweep [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [hostfile]
  50
  51     -l, --host-list=str          Host to execute actions on
  52                                    - may appear multiple times
  53     -p, --peers                  Recursively list all peers a host synchronizes to
  54     -m, --maxlevel=num           Traverse peers up to this level (4 is a reasonable number)
  55     -s, --strip=str              Strip this string from hostnames
  56     -?, --help                   Display usage information and exit
  57         --more-help              Pass the extended usage text through a pager
  58
  59 Options are specified by doubled hyphens and their name or by a single
  60 hyphen and the flag character.
  61 @end example
  62 @exampleindent 4
  63
  64 @node ntpsweep host-list
  65 @subsection host-list option (-l)
  66 @cindex ntpsweep-host-list
  67
  68 This is the ``host to execute actions on'' option.
  69 This option takes a string argument.
  70
  71 @noindent
  72 This option has some usage constraints.  It:
  73 @itemize @bullet
  74 @item
  75 may appear an unlimited number of times.
  76 @end itemize
  77
  78             Use this option to specify the host on which this script operates.
  79             May appear multiple times.
  80 @node ntpsweep peers
  81 @subsection peers option (-p)
  82 @cindex ntpsweep-peers
  83
  84 This is the ``recursively list all peers a host synchronizes to'' option.
  85 This option has no @samp{doc} documentation.
  86 @node ntpsweep maxlevel
  87 @subsection maxlevel option (-m)
  88 @cindex ntpsweep-maxlevel
  89
  90 This is the ``traverse peers up to this level (4 is a reasonable number)'' option.
  91 This option takes a number argument.
  92 This option has no @samp{doc} documentation.
  93 @node ntpsweep strip
  94 @subsection strip option (-s)
  95 @cindex ntpsweep-strip
  96
  97 This is the ``strip this string from hostnames'' option.
  98 This option takes a string argument.
  99 This option has no @samp{doc} documentation.
 100 @node ntpsweep host
 101 @subsection host option (-h)
 102 @cindex ntpsweep-host
 103
 104 This is the ``specify a single host'' option.
 105 This option takes a string argument.
 106 This 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
 112 One of the following exit values will be returned:
 113 @table @samp
 114 @item 0 (EXIT_SUCCESS)
 115 Successful program execution.
 116 @item 1 (EXIT_FAILURE)
 117 The operation failed or the command syntax was not valid.
 118 @end table