contrib/ntp/ntpdc/ntpdc-opts.texi

   1 @node ntpdc Invocation
   2 @section Invoking ntpdc
   3 @pindex ntpdc
   4 @cindex vendor-specific NTP query program
   5 @ignore
   6 #
   7 # EDIT THIS FILE WITH CAUTION  (ntpdc-opts.texi)
   8 #
   9 # It has been AutoGen-ed  Sunday August 17, 2008 at 05:26:27 AM EDT
  10 # From the definitions    ntpdc-opts.def
  11 # and the template file   aginfo.tpl
  12 @end ignore
  13 This program has no explanation.
  14
  15 The
  16 [= prog-name =]
  17 utility program is used to query an NTP daemon about its
  18 current state and to request changes in that state.
  19 It uses NTP mode 7 control message formats described in the source code.
  20 The program may
  21 be run either in interactive mode or controlled using command line
  22 arguments.
  23 Extensive state and statistics information is available
  24 through the
  25 [= prog-name =]
  26 interface.
  27 In addition, nearly all the
  28 configuration options which can be specified at startup using
  29 ntpd's configuration file may also be specified at run time using
  30 [= prog-name =] .
  31
  32
  33
  34 This section was generated by @strong{AutoGen},
  35 the aginfo template and the option descriptions for the @command{ntpdc} program.  It documents the ntpdc usage text and option meanings.
  36
  37 This software is released under a specialized copyright license.
  38
  39 @menu
  40 * ntpdc usage::                  ntpdc usage help (-?)
  41 * ntpdc command::                command option (-c)
  42 * ntpdc debug-level::            debug-level option (-d)
  43 * ntpdc interactive::            interactive option (-i)
  44 * ntpdc ipv4::                   ipv4 option (-4)
  45 * ntpdc ipv6::                   ipv6 option (-6)
  46 * ntpdc listpeers::              listpeers option (-l)
  47 * ntpdc numeric::                numeric option (-n)
  48 * ntpdc peers::                  peers option (-p)
  49 * ntpdc set-debug-level::        set-debug-level option (-D)
  50 * ntpdc showpeers::              showpeers option (-s)
  51 @end menu
  52
  53 @node ntpdc usage
  54 @subsection ntpdc usage help (-?)
  55 @cindex ntpdc usage
  56
  57 This is the automatically generated usage text for ntpdc:
  58
  59 @exampleindent 0
  60 @example
  61 ntpdc - vendor-specific NTP query program - Ver. 4.2.5p113
  62 USAGE:  ntpdc [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
  63   Flg Arg Option-Name    Description
  64    -4 no  ipv4           Force IPv4 DNS name resolution
  65    -6 no  ipv6           Force IPv6 DNS name resolution
  66                                 - an alternate for ipv4
  67    -c Str command        run a command and exit
  68                                 - may appear multiple times
  69    -l no  listpeers      Print a list of the peers
  70                                 - prohibits these options:
  71                                 command
  72    -p no  peers          Print a list of the peers
  73                                 - prohibits these options:
  74                                 command
  75    -s no  showpeers      Show a list of the peers
  76                                 - prohibits these options:
  77                                 command
  78    -i no  interactive    Force ntpq to operate in interactive mode
  79                                 - prohibits these options:
  80                                 command
  81                                 listpeers
  82                                 peers
  83                                 showpeers
  84    -d no  debug-level    Increase output debug message level
  85                                 - may appear multiple times
  86    -D Str set-debug-level Set the output debug message level
  87                                 - may appear multiple times
  88    -n no  numeric        numeric host addresses
  89       opt version        Output version information and exit
  90    -? no  help           Display usage information and exit
  91    -! no  more-help      Extended usage information passed thru pager
  92    -> opt save-opts      Save the option state to a config file
  93    -< Str load-opts      Load options from a config file
  94                                 - disabled as --no-load-opts
  95                                 - may appear multiple times
  96
  97 Options are specified by doubled hyphens and their name
  98 or by a single hyphen and the flag character.
  99
 100 The following option preset mechanisms are supported:
 101  - reading file /users/stenn/.ntprc
 102  - reading file /deacon/backroom/snaps/ntp-stable/ntpdc/.ntprc
 103  - examining environment variables named NTPDC_*
 104
 105 The
 106 [= prog-name =]
 107 utility program is used to query an NTP daemon about its
 108 current state and to request changes in that state.
 109 It uses NTP mode 7 control message formats described in the source code.
 110 The program may
 111 be run either in interactive mode or controlled using command line
 112 arguments.
 113 Extensive state and statistics information is available
 114 through the
 115 [= prog-name =]
 116 interface.
 117 In addition, nearly all the
 118 configuration options which can be specified at startup using
 119 ntpd's configuration file may also be specified at run time using
 120 [= prog-name =] .
 121
 122 please send bug reports to:  http://bugs.ntp.org, bugs@@ntp.org
 123 @end example
 124 @exampleindent 4
 125
 126 @node ntpdc ipv4
 127 @subsection ipv4 option (-4)
 128 @cindex ntpdc-ipv4
 129
 130 This is the ``force ipv4 dns name resolution'' option.
 131
 132 This option has some usage constraints.  It:
 133 @itemize @bullet
 134 @item
 135 is a member of the ipv4 class of options.
 136 @end itemize
 137
 138 Force DNS resolution of following host names on the command line
 139 to the IPv4 namespace.
 140
 141 @node ntpdc ipv6
 142 @subsection ipv6 option (-6)
 143 @cindex ntpdc-ipv6
 144
 145 This is the ``force ipv6 dns name resolution'' option.
 146
 147 This option has some usage constraints.  It:
 148 @itemize @bullet
 149 @item
 150 is a member of the ipv4 class of options.
 151 @end itemize
 152
 153 Force DNS resolution of following host names on the command line
 154 to the IPv6 namespace.
 155
 156 @node ntpdc command
 157 @subsection command option (-c)
 158 @cindex ntpdc-command
 159
 160 This is the ``run a command and exit'' option.
 161
 162 This option has some usage constraints.  It:
 163 @itemize @bullet
 164 @item
 165 may appear an unlimited number of times.
 166 @end itemize
 167
 168 The following argument is interpreted as an interactive format command
 169 and is added to the list of commands to be executed on the specified
 170 host(s).
 171
 172 @node ntpdc listpeers
 173 @subsection listpeers option (-l)
 174 @cindex ntpdc-listpeers
 175
 176 This is the ``print a list of the peers'' option.
 177
 178 This option has some usage constraints.  It:
 179 @itemize @bullet
 180 @item
 181 must not appear in combination with any of the following options:
 182 command.
 183 @end itemize
 184
 185 Print a list of the peers known to the server as well as a summary of
 186 their state. This is equivalent to the 'listpeers' interactive command.
 187
 188 @node ntpdc peers
 189 @subsection peers option (-p)
 190 @cindex ntpdc-peers
 191
 192 This is the ``print a list of the peers'' option.
 193
 194 This option has some usage constraints.  It:
 195 @itemize @bullet
 196 @item
 197 must not appear in combination with any of the following options:
 198 command.
 199 @end itemize
 200
 201 Print a list of the peers known to the server as well as a summary
 202 of their state. This is equivalent to the 'peers' interactive command.
 203
 204 @node ntpdc showpeers
 205 @subsection showpeers option (-s)
 206 @cindex ntpdc-showpeers
 207
 208 This is the ``show a list of the peers'' option.
 209
 210 This option has some usage constraints.  It:
 211 @itemize @bullet
 212 @item
 213 must not appear in combination with any of the following options:
 214 command.
 215 @end itemize
 216
 217 Print a list of the peers known to the server as well as a summary
 218 of their state. This is equivalent to the 'dmpeers' interactive command.
 219
 220 @node ntpdc interactive
 221 @subsection interactive option (-i)
 222 @cindex ntpdc-interactive
 223
 224 This is the ``force ntpq to operate in interactive mode'' option.
 225
 226 This option has some usage constraints.  It:
 227 @itemize @bullet
 228 @item
 229 must not appear in combination with any of the following options:
 230 command, listpeers, peers, showpeers.
 231 @end itemize
 232
 233 Force ntpq to operate in interactive mode.  Prompts will be written
 234 to the standard output and commands read from the standard input.
 235
 236 @node ntpdc debug-level
 237 @subsection debug-level option (-d)
 238 @cindex ntpdc-debug-level
 239
 240 This is the ``increase output debug message level'' option.
 241
 242 This option has some usage constraints.  It:
 243 @itemize @bullet
 244 @item
 245 may appear an unlimited number of times.
 246 @item
 247 must be compiled in by defining @code{DEBUG} during the compilation.
 248 @end itemize
 249
 250 Increase the debugging message output level.
 251
 252 @node ntpdc set-debug-level
 253 @subsection set-debug-level option (-D)
 254 @cindex ntpdc-set-debug-level
 255
 256 This is the ``set the output debug message level'' option.
 257
 258 This option has some usage constraints.  It:
 259 @itemize @bullet
 260 @item
 261 may appear an unlimited number of times.
 262 @item
 263 must be compiled in by defining @code{DEBUG} during the compilation.
 264 @end itemize
 265
 266 Set the output debugging level.  Can be supplied multiple times,
 267 but each overrides the previous value(s).
 268
 269 @node ntpdc numeric
 270 @subsection numeric option (-n)
 271 @cindex ntpdc-numeric
 272
 273 This is the ``numeric host addresses'' option.
 274 Output all host addresses in dotted-quad numeric format rather than
 275 converting to the canonical host names.