1: @node ntpdc Invocation
2: @section Invoking ntpdc
3: @pindex ntpdc
4: @cindex vendor-specific NTP query program
5: @ignore
6: #
7: # EDIT THIS FILE WITH CAUTION (ntpdc-opts.texi)
8: #
9: # It has been AutoGen-ed December 24, 2011 at 06:34:25 PM by AutoGen 5.12
10: # From the definitions ntpdc-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 an NTP daemon about its
18: current state and to request changes in that state.
19: It uses NTP mode 7 control message formats described in the source code.
20: The program may
21: be run either in interactive mode or controlled using command line
22: arguments.
23: Extensive state and statistics information is available
24: through the
25: [= prog-name =]
26: interface.
27: In addition, nearly all the
28: configuration options which can be specified at startup using
29: ntpd's configuration file may also be specified at run time using
30: [= prog-name =] .
31:
32:
33:
34: This section was generated by @strong{AutoGen},
35: the aginfo template and the option descriptions for the @command{ntpdc} program. It documents the @command{ntpdc} usage text and option meanings.
36:
37: This software is released under a specialized copyright license.
38:
39: @menu
40: * ntpdc usage:: ntpdc usage help (-?)
41: * ntpdc command:: command option (-c)
42: * ntpdc debug-level:: debug-level option (-d)
43: * ntpdc interactive:: interactive option (-i)
44: * ntpdc ipv4:: ipv4 option (-4)
45: * ntpdc ipv6:: ipv6 option (-6)
46: * ntpdc listpeers:: listpeers option (-l)
47: * ntpdc numeric:: numeric option (-n)
48: * ntpdc peers:: peers option (-p)
49: * ntpdc set-debug-level:: set-debug-level option (-D)
50: * ntpdc showpeers:: showpeers option (-s)
51: @end menu
52:
53: @node ntpdc usage
54: @subsection ntpdc usage help (-?)
55: @cindex ntpdc usage
56:
57: This is the automatically generated usage text for ntpdc:
58:
59: @exampleindent 0
60: @example
61: ntpdc - vendor-specific NTP query program - Ver. 4.2.6p5
62: USAGE: ntpdc [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]... [ host ...]
63: Flg Arg Option-Name Description
64: -4 no ipv4 Force IPv4 DNS name resolution
65: - prohibits these options:
66: ipv6
67: -6 no ipv6 Force IPv6 DNS name resolution
68: - prohibits these options:
69: ipv4
70: -c Str command run a command and exit
71: - may appear multiple times
72: -l no listpeers Print a list of the peers
73: - prohibits these options:
74: command
75: -p no peers Print a list of the peers
76: - prohibits these options:
77: command
78: -s no showpeers Show a list of the peers
79: - prohibits these options:
80: command
81: -i no interactive Force ntpq to operate in interactive mode
82: - prohibits these options:
83: command
84: listpeers
85: peers
86: showpeers
87: -d no debug-level Increase output debug message level
88: - may appear multiple times
89: -D Str set-debug-level Set the output debug message level
90: - may appear multiple times
91: -n no numeric numeric host addresses
92: opt version Output version information and exit
93: -? no help Display extended usage information and exit
94: -! no more-help Extended usage information passed thru pager
95: -> opt save-opts Save the option state to a config file
96: -< Str load-opts Load options from a config file
97: - disabled as --no-load-opts
98: - may appear multiple times
99:
100: Options are specified by doubled hyphens and their name or by a single
101: hyphen and the flag character.
102:
103: The following option preset mechanisms are supported:
104: - reading file $HOME/.ntprc
105: - reading file ./.ntprc
106: - examining environment variables named NTPDC_*
107:
108: The [= prog-name =] utility program is used to query an NTP daemon about
109: its current state and to request changes in that state. It uses NTP mode
110: 7 control message formats described in the source code. The program may
111: be run either in interactive mode or controlled using command line
112: arguments. Extensive state and statistics information is available
113: through the [= prog-name =] interface. In addition, nearly all the
114: configuration options which can be specified at startup using ntpd's
115: configuration file may also be specified at run time using [= prog-name =]
116: .
117:
118: please send bug reports to: http://bugs.ntp.org, bugs@@ntp.org
119: @end example
120: @exampleindent 4
121:
122: @node ntpdc command
123: @subsection command option (-c)
124: @cindex ntpdc-command
125:
126: This is the ``run a command and exit'' option.
127:
128: This option has some usage constraints. It:
129: @itemize @bullet
130: @item
131: may appear an unlimited number of times.
132: @end itemize
133:
134: The following argument is interpreted as an interactive format command
135: and is added to the list of commands to be executed on the specified
136: host(s).
137:
138: @node ntpdc debug-level
139: @subsection debug-level option (-d)
140: @cindex ntpdc-debug-level
141:
142: This is the ``increase output debug message level'' option.
143:
144: This option has some usage constraints. It:
145: @itemize @bullet
146: @item
147: may appear an unlimited number of times.
148: @end itemize
149:
150: Increase the debugging message output level.
151:
152: @node ntpdc interactive
153: @subsection interactive option (-i)
154: @cindex ntpdc-interactive
155:
156: This is the ``force ntpq to operate in interactive mode'' option.
157:
158: This option has some usage constraints. It:
159: @itemize @bullet
160: @item
161: must not appear in combination with any of the following options:
162: command, listpeers, peers, showpeers.
163: @end itemize
164:
165: Force ntpq to operate in interactive mode. Prompts will be written
166: to the standard output and commands read from the standard input.
167:
168: @node ntpdc ipv4
169: @subsection ipv4 option (-4)
170: @cindex ntpdc-ipv4
171:
172: This is the ``force ipv4 dns name resolution'' option.
173:
174: This option has some usage constraints. It:
175: @itemize @bullet
176: @item
177: must not appear in combination with any of the following options:
178: ipv6.
179: @end itemize
180:
181: Force DNS resolution of following host names on the command line
182: to the IPv4 namespace.
183:
184: @node ntpdc ipv6
185: @subsection ipv6 option (-6)
186: @cindex ntpdc-ipv6
187:
188: This is the ``force ipv6 dns name resolution'' option.
189:
190: This option has some usage constraints. It:
191: @itemize @bullet
192: @item
193: must not appear in combination with any of the following options:
194: ipv4.
195: @end itemize
196:
197: Force DNS resolution of following host names on the command line
198: to the IPv6 namespace.
199:
200: @node ntpdc listpeers
201: @subsection listpeers option (-l)
202: @cindex ntpdc-listpeers
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: command.
211: @end itemize
212:
213: Print a list of the peers known to the server as well as a summary of
214: their state. This is equivalent to the 'listpeers' interactive command.
215:
216: @node ntpdc numeric
217: @subsection numeric option (-n)
218: @cindex ntpdc-numeric
219:
220: This is the ``numeric host addresses'' option.
221: Output all host addresses in dotted-quad numeric format rather than
222: converting to the canonical host names.
223:
224: @node ntpdc peers
225: @subsection peers option (-p)
226: @cindex ntpdc-peers
227:
228: This is the ``print a list of the peers'' option.
229:
230: This option has some usage constraints. It:
231: @itemize @bullet
232: @item
233: must not appear in combination with any of the following options:
234: command.
235: @end itemize
236:
237: Print a list of the peers known to the server as well as a summary
238: of their state. This is equivalent to the 'peers' interactive command.
239:
240: @node ntpdc set-debug-level
241: @subsection set-debug-level option (-D)
242: @cindex ntpdc-set-debug-level
243:
244: This is the ``set the output debug message level'' option.
245:
246: This option has some usage constraints. It:
247: @itemize @bullet
248: @item
249: may appear an unlimited number of times.
250: @end itemize
251:
252: Set the output debugging level. Can be supplied multiple times,
253: but each overrides the previous value(s).
254:
255: @node ntpdc showpeers
256: @subsection showpeers option (-s)
257: @cindex ntpdc-showpeers
258:
259: This is the ``show a list of the peers'' option.
260:
261: This option has some usage constraints. It:
262: @itemize @bullet
263: @item
264: must not appear in combination with any of the following options:
265: command.
266: @end itemize
267:
268: Print a list of the peers known to the server as well as a summary
269: of their state. This is equivalent to the 'dmpeers' interactive command.
FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>
![[BACK]](/icons/cvsweb/back.gif){kind=icon}
Return to ntpdc-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 / ntpdc