contrib/ntp/ntpq/ntpq-opts.texi

   1 @node ntpq Invocation
   2 @section Invoking ntpq
   3 @pindex ntpq
   4 @cindex standard NTP query program
   5 @ignore
   6 #
   7 # EDIT THIS FILE WITH CAUTION  (ntpq-opts.texi)
   8 #
   9 # It has been AutoGen-ed  Tuesday December  8, 2009 at 08:14:28 AM EST
  10 # From the definitions    ntpq-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 NTP servers which
  18 implement the standard NTP mode 6 control message formats defined
  19 in Appendix B of the NTPv3 specification RFC1305, requesting
  20 information about current state and/or changes in that state.
  21 The same formats are used in NTPv4, although some of the
  22 variables have changed and new ones added.
  23
  24 This section was generated by @strong{AutoGen},
  25 the aginfo template and the option descriptions for the @command{ntpq} program.  It documents the ntpq usage text and option meanings.
  26
  27 This software is released under a specialized copyright license.
  28
  29 @menu
  30 * ntpq usage::                  ntpq usage help (-?)
  31 * ntpq command::                command option (-c)
  32 * ntpq debug-level::            debug-level option (-d)
  33 * ntpq interactive::            interactive option (-i)
  34 * ntpq ipv4::                   ipv4 option (-4)
  35 * ntpq ipv6::                   ipv6 option (-6)
  36 * ntpq numeric::                numeric option (-n)
  37 * ntpq peers::                  peers option (-p)
  38 * ntpq set-debug-level::        set-debug-level option (-D)
  39 @end menu
  40
  41 @node ntpq usage
  42 @subsection ntpq usage help (-?)
  43 @cindex ntpq usage
  44
  45 This is the automatically generated usage text for ntpq:
  46
  47 @exampleindent 0
  48 @example
  49 ntpq - standard NTP query program - Ver. 4.2.5p247-RC
  50 USAGE:  ntpq [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
  51   Flg Arg Option-Name    Description
  52    -4 no  ipv4           Force IPv4 DNS name resolution
  53                                 - prohibits these options:
  54                                 ipv6
  55    -6 no  ipv6           Force IPv6 DNS name resolution
  56                                 - prohibits these options:
  57                                 ipv4
  58    -c Str command        run a command and exit
  59                                 - may appear multiple times
  60    -d no  debug-level    Increase output debug message level
  61                                 - may appear multiple times
  62    -D Str set-debug-level Set the output debug message level
  63                                 - may appear multiple times
  64    -p no  peers          Print a list of the peers
  65                                 - prohibits these options:
  66                                 interactive
  67    -i no  interactive    Force ntpq to operate in interactive mode
  68                                 - prohibits these options:
  69                                 command
  70                                 peers
  71    -n no  numeric        numeric host addresses
  72       no  old-rv         Always output status line with readvar
  73       opt version        Output version information and exit
  74    -? no  help           Display extended usage information and exit
  75    -! no  more-help      Extended usage information passed thru pager
  76    -> opt save-opts      Save the option state to a config file
  77    -< Str load-opts      Load options from a config file
  78                                 - disabled as --no-load-opts
  79                                 - may appear multiple times
  80
  81 Options are specified by doubled hyphens and their name
  82 or by a single hyphen and the flag character.
  83
  84 The following option preset mechanisms are supported:
  85  - reading file /users/stenn/.ntprc
  86  - reading file /deacon/backroom/snaps/ntp-stable/ntpq/.ntprc
  87  - examining environment variables named NTPQ_*
  88
  89 The
  90 [= prog-name =]
  91 utility program is used to query NTP servers which
  92 implement the standard NTP mode 6 control message formats defined
  93 in Appendix B of the NTPv3 specification RFC1305, requesting
  94 information about current state and/or changes in that state.
  95 The same formats are used in NTPv4, although some of the
  96 variables have changed and new ones added.
  97
  98 please send bug reports to:  http://bugs.ntp.org, bugs@@ntp.org
  99 @end example
 100 @exampleindent 4
 101
 102 @node ntpq ipv4
 103 @subsection ipv4 option (-4)
 104 @cindex ntpq-ipv4
 105
 106 This is the ``force ipv4 dns name resolution'' option.
 107
 108 This option has some usage constraints.  It:
 109 @itemize @bullet
 110 @item
 111 is a member of the ipv4 class of options.
 112 @end itemize
 113
 114 Force DNS resolution of following host names on the command line
 115 to the IPv4 namespace.
 116
 117 @node ntpq ipv6
 118 @subsection ipv6 option (-6)
 119 @cindex ntpq-ipv6
 120
 121 This is the ``force ipv6 dns name resolution'' option.
 122
 123 This option has some usage constraints.  It:
 124 @itemize @bullet
 125 @item
 126 is a member of the ipv4 class of options.
 127 @end itemize
 128
 129 Force DNS resolution of following host names on the command line
 130 to the IPv6 namespace.
 131
 132 @node ntpq command
 133 @subsection command option (-c)
 134 @cindex ntpq-command
 135
 136 This is the ``run a command and exit'' option.
 137
 138 This option has some usage constraints.  It:
 139 @itemize @bullet
 140 @item
 141 may appear an unlimited number of times.
 142 @end itemize
 143
 144 The following argument is interpreted as an interactive format command
 145 and is added to the list of commands to be executed on the specified
 146 host(s).
 147
 148 @node ntpq debug-level
 149 @subsection debug-level option (-d)
 150 @cindex ntpq-debug-level
 151
 152 This is the ``increase output debug message level'' option.
 153
 154 This option has some usage constraints.  It:
 155 @itemize @bullet
 156 @item
 157 may appear an unlimited number of times.
 158 @item
 159 must be compiled in by defining @code{DEBUG} during the compilation.
 160 @end itemize
 161
 162 Increase the debugging message output level.
 163
 164 @node ntpq set-debug-level
 165 @subsection set-debug-level option (-D)
 166 @cindex ntpq-set-debug-level
 167
 168 This is the ``set the output debug message level'' option.
 169
 170 This option has some usage constraints.  It:
 171 @itemize @bullet
 172 @item
 173 may appear an unlimited number of times.
 174 @item
 175 must be compiled in by defining @code{DEBUG} during the compilation.
 176 @end itemize
 177
 178 Set the output debugging level.  Can be supplied multiple times,
 179 but each overrides the previous value(s).
 180
 181 @node ntpq peers
 182 @subsection peers option (-p)
 183 @cindex ntpq-peers
 184
 185 This is the ``print a list of the peers'' option.
 186
 187 This option has some usage constraints.  It:
 188 @itemize @bullet
 189 @item
 190 must not appear in combination with any of the following options:
 191 interactive.
 192 @end itemize
 193
 194 Print a list of the peers known to the server as well as a summary
 195 of their state. This is equivalent to the 'peers' interactive command.
 196
 197 @node ntpq interactive
 198 @subsection interactive option (-i)
 199 @cindex ntpq-interactive
 200
 201 This is the ``force ntpq to operate in interactive mode'' option.
 202
 203 This option has some usage constraints.  It:
 204 @itemize @bullet
 205 @item
 206 must not appear in combination with any of the following options:
 207 command, peers.
 208 @end itemize
 209
 210 Force ntpq to operate in interactive mode.  Prompts will be written
 211 to the standard output and commands read from the standard input.
 212
 213 @node ntpq numeric
 214 @subsection numeric option (-n)
 215 @cindex ntpq-numeric
 216
 217 This is the ``numeric host addresses'' option.
 218 Output all host addresses in dotted-quad numeric format rather than
 219 converting to the canonical host names.