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