Invoking ntpq
=============

This program has no explanation.

The [= prog-name =] utility program is used to query NTP servers which implement the standard NTP mode 6 control message formats defined in Appendix B of the NTPv3 specification RFC1305, requesting information about current state and/or changes in that state. The same formats are used in NTPv4, although some of the variables have changed and new ones added.

This section was generated by AutoGen, the aginfo template and the option descriptions for the ntpq program.  It documents the ntpq usage text and option meanings.

This software is released under a specialized copyright license.

ntpq usage help (-?)
--------------------

This is the automatically generated usage text for ntpq:

     ntpq - standard NTP query program - Ver. 4.2.5p247-RC
     USAGE:  ntpq [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]
       Flg Arg Option-Name    Description
        -4 no  ipv4           Force IPv4 DNS name resolution
                                     - prohibits these options:
                                     ipv6
        -6 no  ipv6           Force IPv6 DNS name resolution
                                     - prohibits these options:
                                     ipv4
        -c Str command        run a command and exit
                                     - may appear multiple times
        -d no  debug-level    Increase output debug message level
                                     - may appear multiple times
        -D Str set-debug-level Set the output debug message level
                                     - may appear multiple times
        -p no  peers          Print a list of the peers
                                     - prohibits these options:
                                     interactive
        -i no  interactive    Force ntpq to operate in interactive mode
                                     - prohibits these options:
                                     command
                                     peers
        -n no  numeric        numeric host addresses
           no  old-rv         Always output status line with readvar
           opt version        Output version information and exit
        -? no  help           Display extended usage information and exit
        -! no  more-help      Extended usage information passed thru pager
        -> opt save-opts      Save the option state to a config file
        -< Str load-opts      Load options from a config file
                                     - disabled as --no-load-opts
                                     - may appear multiple times

     Options are specified by doubled hyphens and their name
     or by a single hyphen and the flag character.

     The following option preset mechanisms are supported:
      - reading file /users/stenn/.ntprc
      - reading file /deacon/backroom/snaps/ntp-stable/ntpq/.ntprc
      - examining environment variables named NTPQ_*

     The
     [= prog-name =]
     utility program is used to query NTP servers which
     implement the standard NTP mode 6 control message formats defined
     in Appendix B of the NTPv3 specification RFC1305, requesting
     information about current state and/or changes in that state.
     The same formats are used in NTPv4, although some of the
     variables have changed and new ones added.

     please send bug reports to:  http://bugs.ntp.org, bugs@ntp.org

ipv4 option (-4)
----------------

This is the ``force ipv4 dns name resolution'' option.

This option has some usage constraints.  It:

  * is a member of the ipv4 class of options.

Force DNS resolution of following host names on the command line to the IPv4 namespace.

ipv6 option (-6)
----------------

This is the ``force ipv6 dns name resolution'' option.

This option has some usage constraints.  It:

  * is a member of the ipv4 class of options.

Force DNS resolution of following host names on the command line to the IPv6 namespace.

command option (-c)
-------------------

This is the ``run a command and exit'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

The following argument is interpreted as an interactive format command and is added to the list of commands to be executed on the specified host(s).

debug-level option (-d)
-----------------------

This is the ``increase output debug message level'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

  * must be compiled in by defining DEBUG during the compilation.

Increase the debugging message output level.

set-debug-level option (-D)
---------------------------

This is the ``set the output debug message level'' option.

This option has some usage constraints.  It:

  * may appear an unlimited number of times.

  * must be compiled in by defining DEBUG during the compilation.

Set the output debugging level.  Can be supplied multiple times, but each overrides the previous value(s).

peers option (-p)
-----------------

This is the ``print a list of the peers'' option.

This option has some usage constraints.  It:

  * must not appear in combination with any of the following options: interactive.

Print a list of the peers known to the server as well as a summary of their state. This is equivalent to the 'peers' interactive command.

interactive option (-i)
-----------------------

This is the ``force ntpq to operate in interactive mode'' option.

This option has some usage constraints.  It:

  * must not appear in combination with any of the following options: command, peers.

Force ntpq to operate in interactive mode.  Prompts will be written to the standard output and commands read from the standard input.

numeric option (-n)
-------------------

This is the ``numeric host addresses'' option. Output all host addresses in dotted-quad numeric format rather than converting to the canonical host names.