4 @cindex standard NTP query program
7 # EDIT THIS FILE WITH CAUTION (ntpq-opts.texi)
9 # It has been AutoGen-ed Sunday August 17, 2008 at 05:26:58 AM EDT
10 # From the definitions ntpq-opts.def
11 # and the template file aginfo.tpl
13 This program has no explanation.
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.
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.
27 This software is released under a specialized copyright license.
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)
42 @subsection ntpq usage help (-?)
45 This is the automatically generated usage text for ntpq:
49 ntpq - standard NTP query program - Ver. 4.2.5p113
50 USAGE: ntpq [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
51 Flg Arg Option-Name Description
52 -4 no ipv4 Force IPv4 DNS name resolution
53 -6 no ipv6 Force IPv6 DNS name resolution
54 - an alternate for ipv4
55 -c Str command run a command and exit
56 - may appear multiple times
57 -d no debug-level Increase output debug message level
58 - may appear multiple times
59 -D Str set-debug-level Set the output debug message level
60 - may appear multiple times
61 -p no peers Print a list of the peers
62 - prohibits these options:
64 -i no interactive Force ntpq to operate in interactive mode
65 - prohibits these options:
68 -n no numeric numeric host addresses
69 opt version Output version information and exit
70 -? no help Display usage information and exit
71 -! no more-help Extended usage information passed thru pager
72 -> opt save-opts Save the option state to a config file
73 -< Str load-opts Load options from a config file
74 - disabled as --no-load-opts
75 - may appear multiple times
77 Options are specified by doubled hyphens and their name
78 or by a single hyphen and the flag character.
80 The following option preset mechanisms are supported:
81 - reading file /users/stenn/.ntprc
82 - reading file /deacon/backroom/snaps/ntp-stable/ntpq/.ntprc
83 - examining environment variables named NTPQ_*
87 utility program is used to query NTP servers which
88 implement the standard NTP mode 6 control message formats defined
89 in Appendix B of the NTPv3 specification RFC1305, requesting
90 information about current state and/or changes in that state.
91 The same formats are used in NTPv4, although some of the
92 variables have changed and new ones added.
94 please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org
99 @subsection ipv4 option (-4)
102 This is the ``force ipv4 dns name resolution'' option.
104 This option has some usage constraints. It:
107 is a member of the ipv4 class of options.
110 Force DNS resolution of following host names on the command line
111 to the IPv4 namespace.
114 @subsection ipv6 option (-6)
117 This is the ``force ipv6 dns name resolution'' option.
119 This option has some usage constraints. It:
122 is a member of the ipv4 class of options.
125 Force DNS resolution of following host names on the command line
126 to the IPv6 namespace.
129 @subsection command option (-c)
132 This is the ``run a command and exit'' option.
134 This option has some usage constraints. It:
137 may appear an unlimited number of times.
140 The following argument is interpreted as an interactive format command
141 and is added to the list of commands to be executed on the specified
144 @node ntpq debug-level
145 @subsection debug-level option (-d)
146 @cindex ntpq-debug-level
148 This is the ``increase output debug message level'' option.
150 This option has some usage constraints. It:
153 may appear an unlimited number of times.
155 must be compiled in by defining @code{DEBUG} during the compilation.
158 Increase the debugging message output level.
160 @node ntpq set-debug-level
161 @subsection set-debug-level option (-D)
162 @cindex ntpq-set-debug-level
164 This is the ``set the output debug message level'' option.
166 This option has some usage constraints. It:
169 may appear an unlimited number of times.
171 must be compiled in by defining @code{DEBUG} during the compilation.
174 Set the output debugging level. Can be supplied multiple times,
175 but each overrides the previous value(s).
178 @subsection peers option (-p)
181 This is the ``print a list of the peers'' option.
183 This option has some usage constraints. It:
186 must not appear in combination with any of the following options:
190 Print a list of the peers known to the server as well as a summary
191 of their state. This is equivalent to the 'peers' interactive command.
193 @node ntpq interactive
194 @subsection interactive option (-i)
195 @cindex ntpq-interactive
197 This is the ``force ntpq to operate in interactive mode'' option.
199 This option has some usage constraints. It:
202 must not appear in combination with any of the following options:
206 Force ntpq to operate in interactive mode. Prompts will be written
207 to the standard output and commands read from the standard input.
210 @subsection numeric option (-n)
213 This is the ``numeric host addresses'' option.
214 Output all host addresses in dotted-quad numeric format rather than
215 converting to the canonical host names.