2
@section Invoking ntpdc
4
@cindex vendor-specific NTP query program
6
# -*- buffer-read-only: t -*- vi: set ro:
8
# DO NOT EDIT THIS FILE (ntpdc-opts.texi)
10
# It has been AutoGen-ed Monday September 10, 2007 at 08:37:51 PM EDT
11
# From the definitions ntpdc-opts.def
12
# and the template file aginfo.tpl
14
This program has no explanation.
18
utility program is used to query an NTP daemon about its
19
current state and to request changes in that state.
20
It uses NTP mode 7 control message formats described in the source code.
22
be run either in interactive mode or controlled using command line
24
Extensive state and statistics information is available
28
In addition, nearly all the
29
configuration options which can be specified at startup using
30
ntpd's configuration file may also be specified at run time using
35
This section was generated by @strong{AutoGen},
36
the aginfo template and the option descriptions for the @command{ntpdc} program. It documents the ntpdc usage text and option meanings.
38
This software is released under a specialized copyright license.
41
* ntpdc usage:: ntpdc usage help (-?)
42
* ntpdc command:: command option (-c)
43
* ntpdc debug-level:: debug-level option (-d)
44
* ntpdc interactive:: interactive option (-i)
45
* ntpdc ipv4:: ipv4 option (-4)
46
* ntpdc ipv6:: ipv6 option (-6)
47
* ntpdc listpeers:: listpeers option (-l)
48
* ntpdc numeric:: numeric option (-n)
49
* ntpdc peers:: peers option (-p)
50
* ntpdc set-debug-level:: set-debug-level option (-D)
51
* ntpdc showpeers:: showpeers option (-s)
55
@subsection ntpdc usage help (-?)
58
This is the automatically generated usage text for ntpdc:
62
ntpdc - vendor-specific NTP query program - Ver. 4.2.5p71
63
USAGE: ntpdc [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
64
Flg Arg Option-Name Description
65
-4 no ipv4 Force IPv4 DNS name resolution
66
-6 no ipv6 Force IPv6 DNS name resolution
67
- an alternate for ipv4
68
-c Str command run a command and exit
69
- may appear multiple times
70
-l no listpeers Print a list of the peers
71
- prohibits these options:
73
-p no peers Print a list of the peers
74
- prohibits these options:
76
-s no showpeers Show a list of the peers
77
- prohibits these options:
79
-i no interactive Force ntpq to operate in interactive mode
80
- prohibits these options:
85
-d no debug-level Increase output debug message level
86
- may appear multiple times
87
-D Str set-debug-level Set the output debug message level
88
- may appear multiple times
89
-n no numeric numeric host addresses
90
-v opt version Output version information and exit
91
-? no help Display usage information and exit
92
-! no more-help Extended usage information passed thru pager
93
-> opt save-opts Save the option state to a config file
94
-< Str load-opts Load options from a config file
95
- disabled as --no-load-opts
96
- may appear multiple times
98
Options are specified by doubled hyphens and their name
99
or by a single hyphen and the flag character.
101
The following option preset mechanisms are supported:
102
- reading file /users/stenn/.ntprc
103
- reading file /deacon/backroom/snaps/ntp-stable/ntpdc/.ntprc
104
- examining environment variables named NTPDC_*
108
utility program is used to query an NTP daemon about its
109
current state and to request changes in that state.
110
It uses NTP mode 7 control message formats described in the source code.
112
be run either in interactive mode or controlled using command line
114
Extensive state and statistics information is available
118
In addition, nearly all the
119
configuration options which can be specified at startup using
120
ntpd's configuration file may also be specified at run time using
123
please send bug reports to: http://bugs.ntp.isc.org, bugs@@ntp.org
128
@subsection ipv4 option (-4)
131
This is the ``force ipv4 dns name resolution'' option.
133
This option has some usage constraints. It:
136
is a member of the ipv4 class of options.
139
Force DNS resolution of following host names on the command line
140
to the IPv4 namespace.
143
@subsection ipv6 option (-6)
146
This is the ``force ipv6 dns name resolution'' option.
148
This option has some usage constraints. It:
151
is a member of the ipv4 class of options.
154
Force DNS resolution of following host names on the command line
155
to the IPv6 namespace.
158
@subsection command option (-c)
159
@cindex ntpdc-command
161
This is the ``run a command and exit'' option.
163
This option has some usage constraints. It:
166
may appear an unlimited number of times.
169
The following argument is interpreted as an interactive format command
170
and is added to the list of commands to be executed on the specified
173
@node ntpdc listpeers
174
@subsection listpeers option (-l)
175
@cindex ntpdc-listpeers
177
This is the ``print a list of the peers'' option.
179
This option has some usage constraints. It:
182
must not appear in combination with any of the following options:
186
Print a list of the peers known to the server as well as a summary of
187
their state. This is equivalent to the 'listpeers' interactive command.
190
@subsection peers option (-p)
193
This is the ``print a list of the peers'' option.
195
This option has some usage constraints. It:
198
must not appear in combination with any of the following options:
202
Print a list of the peers known to the server as well as a summary
203
of their state. This is equivalent to the 'peers' interactive command.
205
@node ntpdc showpeers
206
@subsection showpeers option (-s)
207
@cindex ntpdc-showpeers
209
This is the ``show a list of the peers'' option.
211
This option has some usage constraints. It:
214
must not appear in combination with any of the following options:
218
Print a list of the peers known to the server as well as a summary
219
of their state. This is equivalent to the 'dmpeers' interactive command.
221
@node ntpdc interactive
222
@subsection interactive option (-i)
223
@cindex ntpdc-interactive
225
This is the ``force ntpq to operate in interactive mode'' option.
227
This option has some usage constraints. It:
230
must not appear in combination with any of the following options:
231
command, listpeers, peers, showpeers.
234
Force ntpq to operate in interactive mode. Prompts will be written
235
to the standard output and commands read from the standard input.
237
@node ntpdc debug-level
238
@subsection debug-level option (-d)
239
@cindex ntpdc-debug-level
241
This is the ``increase output debug message level'' option.
243
This option has some usage constraints. It:
246
may appear an unlimited number of times.
248
must be compiled in by defining @code{DEBUG} during the compilation.
251
Increase the debugging message output level.
253
@node ntpdc set-debug-level
254
@subsection set-debug-level option (-D)
255
@cindex ntpdc-set-debug-level
257
This is the ``set the output debug message level'' option.
259
This option has some usage constraints. It:
262
may appear an unlimited number of times.
264
must be compiled in by defining @code{DEBUG} during the compilation.
267
Set the output debugging level. Can be supplied multiple times,
268
but each overrides the previous value(s).
271
@subsection numeric option (-n)
272
@cindex ntpdc-numeric
274
This is the ``numeric host addresses'' option.
275
Output all host addresses in dotted-quad numeric format rather than
276
converting to the canonical host names.
added
removed
ntpdc/ntpdc-opts.texi
