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 24, 2011 at 06:34:35 PM by AutoGen 5.12
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 @command{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 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:
46: This is the automatically generated usage text for ntpq:
47:
48: @exampleindent 0
49: @example
50: ntpq - standard NTP query program - Ver. 4.2.6p5
51: USAGE: 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:
82: Options are specified by doubled hyphens and their name or by a single
83: hyphen and the flag character.
84:
85: The following option preset mechanisms are supported:
86: - reading file $HOME/.ntprc
87: - reading file ./.ntprc
88: - examining environment variables named NTPQ_*
89:
90: The [= prog-name =] utility program is used to query NTP servers which
91: implement the standard NTP mode 6 control message formats defined in
92: Appendix B of the NTPv3 specification RFC1305, requesting information
93: about current state and/or changes in that state. The same formats are
94: used in NTPv4, although some of the variables have changed and new ones
95: added.
96:
97: please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org
98: @end example
99: @exampleindent 4
100:
101: @node ntpq command
102: @subsection command option (-c)
103: @cindex ntpq-command
104:
105: This is the ``run a command and exit'' option.
106:
107: This option has some usage constraints. It:
108: @itemize @bullet
109: @item
110: may appear an unlimited number of times.
111: @end itemize
112:
113: The following argument is interpreted as an interactive format command
114: and is added to the list of commands to be executed on the specified
115: host(s).
116:
117: @node ntpq debug-level
118: @subsection debug-level option (-d)
119: @cindex ntpq-debug-level
120:
121: This is the ``increase output debug message level'' option.
122:
123: This option has some usage constraints. It:
124: @itemize @bullet
125: @item
126: may appear an unlimited number of times.
127: @end itemize
128:
129: Increase the debugging message output level.
130:
131: @node ntpq interactive
132: @subsection interactive option (-i)
133: @cindex ntpq-interactive
134:
135: This is the ``force ntpq to operate in interactive mode'' option.
136:
137: This option has some usage constraints. It:
138: @itemize @bullet
139: @item
140: must not appear in combination with any of the following options:
141: command, peers.
142: @end itemize
143:
144: Force ntpq to operate in interactive mode. Prompts will be written
145: to the standard output and commands read from the standard input.
146:
147: @node ntpq ipv4
148: @subsection ipv4 option (-4)
149: @cindex ntpq-ipv4
150:
151: This is the ``force ipv4 dns name resolution'' option.
152:
153: This option has some usage constraints. It:
154: @itemize @bullet
155: @item
156: must not appear in combination with any of the following options:
157: ipv6.
158: @end itemize
159:
160: Force DNS resolution of following host names on the command line
161: to the IPv4 namespace.
162:
163: @node ntpq ipv6
164: @subsection ipv6 option (-6)
165: @cindex ntpq-ipv6
166:
167: This is the ``force ipv6 dns name resolution'' option.
168:
169: This option has some usage constraints. It:
170: @itemize @bullet
171: @item
172: must not appear in combination with any of the following options:
173: ipv4.
174: @end itemize
175:
176: Force DNS resolution of following host names on the command line
177: to the IPv6 namespace.
178:
179: @node ntpq numeric
180: @subsection numeric option (-n)
181: @cindex ntpq-numeric
182:
183: This is the ``numeric host addresses'' option.
184: Output all host addresses in dotted-quad numeric format rather than
185: converting to the canonical host names.
186:
187: @node ntpq old-rv
188: @subsection old-rv option
189: @cindex ntpq-old-rv
190:
191: This is the ``always output status line with readvar'' option.
192: By default, ntpq now suppresses the associd=... line that
193: precedes the output of "readvar" (alias "rv") when a single
194: variable is requested, such as ntpq -c "rv 0 offset". This
195: option causes ntpq to include both lines of output for a
196: single-variable readvar. Using an environment variable to
197: preset this option in a script will enable both older and
198: newer ntpq to behave identically in this regard.
199:
200: @node ntpq peers
201: @subsection peers option (-p)
202: @cindex ntpq-peers
203:
204: This is the ``print a list of the peers'' option.
205:
206: This option has some usage constraints. It:
207: @itemize @bullet
208: @item
209: must not appear in combination with any of the following options:
210: interactive.
211: @end itemize
212:
213: Print a list of the peers known to the server as well as a summary
214: of their state. This is equivalent to the 'peers' interactive command.
215:
216: @node ntpq set-debug-level
217: @subsection set-debug-level option (-D)
218: @cindex ntpq-set-debug-level
219:
220: This is the ``set the output debug message level'' option.
221:
222: This option has some usage constraints. It:
223: @itemize @bullet
224: @item
225: may appear an unlimited number of times.
226: @end itemize
227:
228: Set the output debugging level. Can be supplied multiple times,
229: but each overrides the previous value(s).
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to ntpq-opts.texi CVS log ![[TXT]](/icons/cvsweb/text.gif){kind=icon}
![[DIR]](/icons/cvsweb/dir.gif){kind=icon}
Up to [ELWIX - Embedded LightWeight unIX -] / embedaddon / ntp / ntpq