Lines Matching +full:manual +full:- +full:span +full:- +full:operation +full:- +full:config
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
3 <!-- Created by GNU Texinfo 6.6, http://www.gnu.org/software/texinfo/ -->
5 <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
6 <title>ntpq: Network Time Protocol Query User’s Manual</title>
8 <meta name="description" content="ntpq: Network Time Protocol Query User’s Manual">
9 <meta name="keywords" content="ntpq: Network Time Protocol Query User’s Manual">
10 <meta name="resource-type" content="document">
16 <!--
17 a.summary-letter {text-decoration: none}
18 blockquote.indentedblock {margin-right: 0em}
19 div.display {margin-left: 3.2em}
20 div.example {margin-left: 3.2em}
21 div.lisp {margin-left: 3.2em}
22 kbd {font-style: oblique}
23 pre.display {font-family: inherit}
24 pre.format {font-family: inherit}
25 pre.menu-comment {font-family: serif}
26 pre.menu-preformatted {font-family: serif}
27 span.nolinebreak {white-space: nowrap}
28 span.roman {font-family: initial; font-weight: normal}
29 span.sansserif {font-family: sans-serif; font-weight: normal}
30 ul.no-bullet {list-style: none}
31 -->
38 <h1 class="settitle" align="center">ntpq: Network Time Protocol Query User’s Manual</h1>
44 <span id="SEC_Overview"></span>
45 <h2 class="shortcontents-heading">Short Table of Contents</h2>
48 <ul class="no-bullet">
49 <li><a id="stoc-Description" href="#toc-Description">1 Description</a></li>
54 <span id="Top"></span><div class="header">
56 Next: <a href="#ntpq-Description" accesskey="n" rel="next">ntpq Description</a>, Previous: <a href="dir.html#Top" accesskey="p" rel="prev">(dir)</a>, Up: <a href="dir.html#Top" accesskey="u" rel="up">(dir)</a> </p>
58 <span id="ntpq_003a-Network-Time-Protocol-Query-User-Manual"></span><h1 class="top">ntpq: Network Time Protocol Query User Manual</h1>
68 <tr><td align="left" valign="top">• <a href="#ntpq-Description" accesskey="1">ntpq Description</a></td><td> </td><td align="left" valign="top">
70 <tr><td align="left" valign="top">• <a href="#ntpq-Invocation" accesskey="2">ntpq Invocation</a></td><td> </td><td align="left" valign="top">Invoking ntpq
74 <tr><td align="left" valign="top">• <a href="#Internal-Commands" accesskey="4">Internal Commands</a></td><td> </td><td align="left" valign="top">
76 <tr><td align="left" valign="top">• <a href="#Control-Message-Commands" accesskey="5">Control Message Commands</a></td><td> </td><td align="left" valign="top">
78 <tr><td align="left" valign="top">• <a href="#Status-Words-and-Kiss-Codes" accesskey="6">Status Words and Kiss Codes</a></td><td> </td><td align="left" valign="top">
80 <tr><td align="left" valign="top">• <a href="#System-Variables" accesskey="7">System Variables</a></td><td> </td><td align="left" valign="top">
82 <tr><td align="left" valign="top">• <a href="#Peer-Variables" accesskey="8">Peer Variables</a></td><td> </td><td align="left" valign="top">
84 <tr><td align="left" valign="top">• <a href="#Clock-Variables" accesskey="9">Clock Variables</a></td><td> </td><td align="left" valign="top">
89 <span id="ntpq-Description"></span><div class="header">
93 <span id="Description"></span><h2 class="chapter">1 Description</h2>
101 <p>The program can be run either in interactive mode or controlled using command line arguments. Requests to read and write arbitrary variables can be assembled, with raw and pretty-printed output options being available. The <code>ntpq</code> can also obtain and print a list of peers in a common format by sending multiple queries to the server.
107 <p>Note that in contexts where a host name is expected, a <code>-4</code> qualifier preceding the host name forces DNS resolution to the IPv4 namespace, while a <code>-6</code> qualifier forces DNS resolution to the IPv6 namespace.
112 <tr><td align="left" valign="top">• <a href="#ntpq-Invocation" accesskey="1">Invoking ntpq</a></td><td> </td><td align="left" valign="top">
116 <tr><td align="left" valign="top">• <a href="#Internal-Commands" accesskey="3">Internal Commands</a></td><td> </td><td align="left" valign="top">
118 <tr><td align="left" valign="top">• <a href="#Control-Message-Commands" accesskey="4">Control Message Commands</a></td><td> </td><td align="left" valign="top">
120 <tr><td align="left" valign="top">• <a href="#Status-Words-and-Kiss-Codes" accesskey="5">Status Words and Kiss Codes</a></td><td> </td><td align="left" valign="top">
122 <tr><td align="left" valign="top">• <a href="#System-Variables" accesskey="6">System Variables</a></td><td> </td><td align="left" valign="top">
124 <tr><td align="left" valign="top">• <a href="#Peer-Variables" accesskey="7">Peer Variables</a></td><td> </td><td align="left" valign="top">
126 <tr><td align="left" valign="top">• <a href="#Clock-Variables" accesskey="8">Clock Variables</a></td><td> </td><td align="left" valign="top">
131 <span id="ntpq-Invocation"></span><div class="header">
133 Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Previous: <a href="#ntpq-Description" accesskey="p" rel="prev">ntpq Description</a>, Up: <a href="#ntpq-Description" accesskey="u" rel="up">ntpq Description</a> </p>
135 <span id="Invoking-ntpq"></span><h3 class="section">1.1 Invoking ntpq</h3>
136 <span id="index-ntpq"></span>
137 <span id="index-standard-NTP-query-program"></span>
148 variables can be assembled, with raw and pretty-printed output
189 <code>-4</code>
192 <code>-6</code>
200 <code>-i</code>
202 <code>-n</code>
212 <tr><td align="left" valign="top">• <a href="#ntpq-usage" accesskey="1">ntpq help/usage (<samp>--help</samp>)</a></td><td> </td><td align="left" valign="top">
214 <tr><td align="left" valign="top">• <a href="#ntpq-ipv4" accesskey="2">ipv4 option (-4)</a></td><td> </td><td align="left" valign="top">
216 <tr><td align="left" valign="top">• <a href="#ntpq-ipv6" accesskey="3">ipv6 option (-6)</a></td><td> </td><td align="left" valign="top">
218 <tr><td align="left" valign="top">• <a href="#ntpq-command" accesskey="4">command option (-c)</a></td><td> </td><td align="left" valign="top">
220 <tr><td align="left" valign="top">• <a href="#ntpq-interactive" accesskey="5">interactive option (-i)</a></td><td> </td><td align="left" valign="top">
222 <tr><td align="left" valign="top">• <a href="#ntpq-numeric" accesskey="6">numeric option (-n)</a></td><td> </td><td align="left" valign="top">
224 <tr><td align="left" valign="top">• <a href="#ntpq-old_002drv" accesskey="7">old-rv option</a></td><td> </td><td align="left" valign="top">
226 <tr><td align="left" valign="top">• <a href="#ntpq-peers" accesskey="8">peers option (-p)</a></td><td> </td><td align="left" valign="top">
228 <tr><td align="left" valign="top">• <a href="#ntpq-refid" accesskey="9">refid option (-r)</a></td><td> </td><td align="left" valign="top">
230 <tr><td align="left" valign="top">• <a href="#ntpq-unconnected">unconnected option (-u)</a></td><td> </td><td align="left" valign="top">
232 <tr><td align="left" valign="top">• <a href="#ntpq-wide">wide option (-w)</a></td><td> </td><td align="left" valign="top">
234 <tr><td align="left" valign="top">• <a href="#ntpq-config">presetting/configuring ntpq</a></td><td> </td><td align="left" valign="top">
236 <tr><td align="left" valign="top">• <a href="#ntpq-exit-status">ntpq exit status</a></td><td> </td><td align="left" valign="top">
240 <span id="Internal-Commands-1"></span><h4 class="subsection">1.1.1 Internal Commands</h4>
291 be comma-separated and not contain white space.
379 <code>-n</code>
461 <span id="Control-Message-Commands-1"></span><h4 class="subsubsection">1.1.1.1 Control Message Commands</h4>
521 <dt><code>:config</code> <kbd>configuration command line</kbd></dt>
523 server as a run-time configuration command in the same format as a line
528 <dt><code>config-from-file</code> <kbd>filename</kbd></dt>
531 to the server as run-time configuration commands in the same format as
564 <dt><code>lopeers</code> <code>[<code>-4</code>|<code>-6</code>]</code></dt>
572 <dt><code>lpeers</code> <code>[<code>-4</code>|<code>-6</code>]</code></dt>
597 <dt><code>mrulist</code> <code>[<code>limited</code> | <code>kod</code> | <code>mincount</code>=<kbd>count</kbd> | <code>laddr</code>=<kbd>localaddr</kbd> | <code>sort</code>=<code>[-]</code><kbd>sortorder</kbd> | <code>resany</code>=<kbd>hexmask</kbd> | <code>resall</code>=<kbd>hexmask</kbd>]</code></dt>
601 <code>sort</code>=<code>[-]</code><kbd>sortorder</kbd>,
636 ‘-’
685 <dt><code>opeers</code> <code>[<code>-4</code> | <code>-6</code>]</code></dt>
686 <dd><p>Obtain and print the old-style list of all peers and clients showing
708 <dd><p>single-character code indicating current value of the
717 <code>-w</code>
751 ‘-’
792 <a href="#System-Variables">System Variables</a>
794 <a href="#Peer-Variables">Peer Variables</a>
807 and frequency values in parts-per-million (PPM).
828 <code>:config</code>
830 <code>config-from-file</code>,
844 <pre class="example"><code>saveconfig</code> <samp>ntp-%Y%m%d-%H%M%S.conf</samp>.
877 <a href="#System-Variables">System Variables</a>
879 <a href="#Peer-Variables">Peer Variables</a>
888 <span id="Status-Words-and-Kiss-Codes-1"></span><h4 class="subsubsection">1.1.1.2 Status Words and Kiss Codes</h4>
892 Status information is also available on a per-association basis.
907 The original purpose was for kiss-o’-death (KoD) packets
912 <span id="System-Variables-1"></span><h4 class="subsubsection">1.1.1.3 System Variables</h4>
935 <dd><p>leap warning indicator (0-3)
938 <dd><p>stratum (1-15)
963 <dd><p>time constant and poll exponent (log2 s) (3-17)
966 <dd><p>minimum time constant (log2 s) (3-10)
984 <dd><p>TAI-UTC offset (s)
993 <p>The jitter and wander statistics are exponentially-weighted RMS averages.
1030 <span id="Peer-Variables-1"></span><h4 class="subsubsection">1.1.1.4 Peer Variables</h4>
1059 <dd><p>leap indicator (0-3)
1062 <dd><p>stratum (0-15)
1090 <dd><p>host mode (1-6)
1093 <dd><p>peer mode (1-5)
1096 <dd><p>host poll exponent (log2 s) (3-17)
1099 <dd><p>peer poll exponent (log2 s) (3-17)
1103 .Lk rate.html "Rate Management and the Kiss-o’-Death Packet" )
1175 <span id="Clock-Variables-1"></span><h4 class="subsubsection">1.1.1.5 Clock Variables</h4>
1226 using the <code>agtexi-cmd</code> template and the option descriptions for the <code>ntpq</code> program.
1230 <tr><td align="left" valign="top">• <a href="#ntpq-usage" accesskey="1">ntpq usage</a></td><td> </td><td align="left" valign="top">ntpq help/usage (<samp>--help</samp>)
1232 <tr><td align="left" valign="top">• <a href="#ntpq-ipv4" accesskey="2">ntpq ipv4</a></td><td> </td><td align="left" valign="top">ipv4 option (-4)
1234 <tr><td align="left" valign="top">• <a href="#ntpq-ipv6" accesskey="3">ntpq ipv6</a></td><td> </td><td align="left" valign="top">ipv6 option (-6)
1236 <tr><td align="left" valign="top">• <a href="#ntpq-command" accesskey="4">ntpq command</a></td><td> </td><td align="left" valign="top">command option (-c)
1238 <tr><td align="left" valign="top">• <a href="#ntpq-interactive" accesskey="5">ntpq interactive</a></td><td> </td><td align="left" valign="top">interactive option (-i)
1240 <tr><td align="left" valign="top">• <a href="#ntpq-numeric" accesskey="6">ntpq numeric</a></td><td> </td><td align="left" valign="top">numeric option (-n)
1242 <tr><td align="left" valign="top">• <a href="#ntpq-old_002drv" accesskey="7">ntpq old-rv</a></td><td> </td><td align="left" valign="top">old-rv option
1244 <tr><td align="left" valign="top">• <a href="#ntpq-peers" accesskey="8">ntpq peers</a></td><td> </td><td align="left" valign="top">peers option (-p)
1246 <tr><td align="left" valign="top">• <a href="#ntpq-refid" accesskey="9">ntpq refid</a></td><td> </td><td align="left" valign="top">refid option (-r)
1248 <tr><td align="left" valign="top">• <a href="#ntpq-unconnected">ntpq unconnected</a></td><td> </td><td align="left" valign="top">unconnected option (-u)
1250 <tr><td align="left" valign="top">• <a href="#ntpq-wide">ntpq wide</a></td><td> </td><td align="left" valign="top">wide option (-w)
1252 <tr><td align="left" valign="top">• <a href="#ntpq-config">ntpq config</a></td><td> </td><td align="left" valign="top">presetting/configuring ntpq
1254 <tr><td align="left" valign="top">• <a href="#ntpq-exit-status">ntpq exit status</a></td><td> </td><td align="left" valign="top">exit status
1259 <span id="ntpq-usage"></span><div class="header">
1261 Next: <a href="#ntpq-ipv4" accesskey="n" rel="next">ntpq ipv4</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1263 <span id="ntpq-help_002fusage-_0028_002d_002dhelp_0029"></span><h4 class="subsection">1.1.2 ntpq help/usage (<samp>--help</samp>)</h4>
1264 <span id="index-ntpq-help"></span>
1269 (<samp>--help</samp>) or the <code>more-help</code> option (<samp>--more-help</samp>). <code>more-help</code> will print
1271 <code>more-help</code> is disabled on platforms without a working
1277 <pre class="example">ntpq - standard NTP query program - Ver. 4.2.8p18
1278 Usage: ntpq [ -<flag> [<val>] | --<name>[{=| }<val>] ]... [ host ...]
1279 Flg Arg Option-Name Description
1280 -4 no ipv4 Force IPv4 name resolution
1281 - prohibits the option 'ipv6'
1282 -6 no ipv6 Force IPv6 name resolution
1283 - prohibits the option 'ipv4'
1284 -c Str command run a command and exit
1285 - may appear multiple times
1286 -d no debug-level Increase debug verbosity level
1287 - may appear multiple times
1288 -D Num set-debug-level Set the debug verbosity level
1289 - may appear multiple times
1290 -i no interactive Force ntpq to operate in interactive mode
1291 - prohibits these options:
1294 -n no numeric numeric host addresses
1295 no old-rv Always output status line with readvar
1296 -p no peers Print a list of the peers
1297 - prohibits the option 'interactive'
1298 -r KWd refid Set default display type for S2+ refids
1299 -u no unconnected Use unconnected UDP to communicate with ntpd (default on Windows)
1300 -w no wide Display the full 'remote' value
1302 -? no help display extended usage information and exit
1303 -! no more-help extended usage information passed thru pager
1304 -> opt save-opts save the option state to a config file
1305 -< Str load-opts load options from a config file
1306 - disabled as '--no-load-opts'
1307 - may appear multiple times
1313 - reading file $HOME/.ntprc
1314 - reading file ./.ntprc
1315 - examining environment variables named NTPQ_*
1325 <span id="ntpq-ipv4"></span><div class="header">
1327 Next: <a href="#ntpq-ipv6" accesskey="n" rel="next">ntpq ipv6</a>, Previous: <a href="#ntpq-usage" accesskey="p" rel="prev">ntpq usage</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1329 <span id="ipv4-option-_0028_002d4_0029"></span><h4 class="subsection">1.1.3 ipv4 option (-4)</h4>
1330 <span id="index-ntpq_002dipv4"></span>
1343 <span id="ntpq-ipv6"></span><div class="header">
1345 Next: <a href="#ntpq-command" accesskey="n" rel="next">ntpq command</a>, Previous: <a href="#ntpq-ipv4" accesskey="p" rel="prev">ntpq ipv4</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1347 <span id="ipv6-option-_0028_002d6_0029"></span><h4 class="subsection">1.1.4 ipv6 option (-6)</h4>
1348 <span id="index-ntpq_002dipv6"></span>
1361 <span id="ntpq-command"></span><div class="header">
1363 Next: <a href="#ntpq-interactive" accesskey="n" rel="next">ntpq interactive</a>, Previous: <a href="#ntpq-ipv6" accesskey="p" rel="prev">ntpq ipv6</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1365 <span id="command-option-_0028_002dc_0029"></span><h4 class="subsection">1.1.5 command option (-c)</h4>
1366 <span id="index-ntpq_002dcommand"></span>
1380 <span id="ntpq-interactive"></span><div class="header">
1382 Next: <a href="#ntpq-numeric" accesskey="n" rel="next">ntpq numeric</a>, Previous: <a href="#ntpq-command" accesskey="p" rel="prev">ntpq command</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1384 <span id="interactive-option-_0028_002di_0029"></span><h4 class="subsection">1.1.6 interactive option (-i)</h4>
1385 <span id="index-ntpq_002dinteractive"></span>
1399 <span id="ntpq-numeric"></span><div class="header">
1401 Next: <a href="#ntpq-old_002drv" accesskey="n" rel="next">ntpq old-rv</a>, Previous: <a href="#ntpq-interactive" accesskey="p" rel="prev">ntpq interactive</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1403 <span id="numeric-option-_0028_002dn_0029"></span><h4 class="subsection">1.1.7 numeric option (-n)</h4>
1404 <span id="index-ntpq_002dnumeric"></span>
1407 Output all host addresses in dotted-quad numeric format rather than
1410 <span id="ntpq-old_002drv"></span><div class="header">
1412 Next: <a href="#ntpq-peers" accesskey="n" rel="next">ntpq peers</a>, Previous: <a href="#ntpq-numeric" accesskey="p" rel="prev">ntpq numeric</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1414 <span id="old_002drv-option"></span><h4 class="subsection">1.1.8 old-rv option</h4>
1415 <span id="index-ntpq_002dold_002drv"></span>
1421 <code>ntpq -c "rv 0 offset"</code>.
1423 for a single-variable <code>readvar</code>.
1428 <span id="ntpq-peers"></span><div class="header">
1430 Next: <a href="#ntpq-refid" accesskey="n" rel="next">ntpq refid</a>, Previous: <a href="#ntpq-old_002drv" accesskey="p" rel="prev">ntpq old-rv</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1432 <span id="peers-option-_0028_002dp_0029"></span><h4 class="subsection">1.1.9 peers option (-p)</h4>
1433 <span id="index-ntpq_002dpeers"></span>
1446 <span id="ntpq-refid"></span><div class="header">
1448 Next: <a href="#ntpq-unconnected" accesskey="n" rel="next">ntpq unconnected</a>, Previous: <a href="#ntpq-peers" accesskey="p" rel="prev">ntpq peers</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1450 <span id="refid-option-_0028_002dr_0029"></span><h4 class="subsection">1.1.10 refid option (-r)</h4>
1451 <span id="index-ntpq_002drefid"></span>
1470 <span id="ntpq-unconnected"></span><div class="header">
1472 Next: <a href="#ntpq-wide" accesskey="n" rel="next">ntpq wide</a>, Previous: <a href="#ntpq-refid" accesskey="p" rel="prev">ntpq refid</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1474 <span id="unconnected-option-_0028_002du_0029"></span><h4 class="subsection">1.1.11 unconnected option (-u)</h4>
1475 <span id="index-ntpq_002dunconnected"></span>
1481 <span id="ntpq-wide"></span><div class="header">
1483 Next: <a href="#ntpq-config" accesskey="n" rel="next">ntpq config</a>, Previous: <a href="#ntpq-unconnected" accesskey="p" rel="prev">ntpq unconnected</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1485 <span id="wide-option-_0028_002dw_0029"></span><h4 class="subsection">1.1.12 wide option (-w)</h4>
1486 <span id="index-ntpq_002dwide"></span>
1495 <span id="ntpq-config"></span><div class="header">
1497 Next: <a href="#ntpq-exit-status" accesskey="n" rel="next">ntpq exit status</a>, Previous: <a href="#ntpq-wide" accesskey="p" rel="prev">ntpq wide</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1499 <span id="presetting_002fconfiguring-ntpq"></span><h4 class="subsection">1.1.13 presetting/configuring ntpq</h4>
1541 <pre class="example"><option-name>
1542 <sub-opt>...&lt;...&gt;...</sub-opt>
1543 </option-name>
1545 <p>yielding an <code>option-name.sub-opt</code> string value of
1555 <span id="version-_0028_002d_0029"></span><h4 class="subsubheading">version (-)</h4>
1575 <span id="ntpq-exit-status"></span><div class="header">
1577 Previous: <a href="#ntpq-config" accesskey="p" rel="prev">ntpq config</a>, Up: <a href="#ntpq-Invocation" accesskey="u" rel="up">ntpq Invocation</a> </p>
1579 <span id="ntpq-exit-status-1"></span><h4 class="subsection">1.1.14 ntpq exit status</h4>
1587 <dd><p>The operation failed or the command syntax was not valid.
1594 it to autogen-users@lists.sourceforge.net. Thank you.
1599 <span id="Usage"></span><div class="header">
1601 Next: <a href="#Internal-Commands" accesskey="n" rel="next">Internal Commands</a>, Previous: <a href="#ntpq-Description" accesskey="p" rel="prev">ntpq Description</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
1603 <span id="Usage-1"></span><h3 class="section">1.2 Usage</h3>
1607 <tr><td width="23%">configuration file</td><td width="23%"><code>/etc/ntp.conf</code></td><td width="5%"><code>-c</code></td><td width="15%"><code>conffile</code></td></tr>
1608 <tr><td width="23%">frequency file</td><td width="23%">none</td><td width="5%"><code>-f</code></td><td width="15%"><code>driftfile</code></td></tr>
1610 <tr><td width="23%">process ID file</td><td width="23%">none</td><td width="5%"><code>-p</code></td><td width="15%"><code>pidfile</code></td></tr>
1611 <tr><td width="23%">log file</td><td width="23%">system log</td><td width="5%"><code>-l</code></td><td width="15%"><code>logfile</code></td></tr>
1613 <tr><td width="23%">statistics path</td><td width="23%"><code>/var/NTP</code></td><td width="5%"><code>-s</code></td><td width="15%"><code>statsdir</code></td></tr>
1614 <tr><td width="23%">keys path</td><td width="23%"><code>/usr/local/etc</code></td><td width="5%"><code>-k</code></td><td width="15%"><code>keysdir</code></td></tr>
1618 <span id="Internal-Commands"></span><div class="header">
1620 Next: <a href="#Control-Message-Commands" accesskey="n" rel="next">Control Message Commands</a>, Previous: <a href="#Usage" accesskey="p" rel="prev">Usage</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
1622 <span id="Internal-Commands-2"></span><h3 class="section">1.3 Internal Commands</h3>
1624 <p>Interactive format commands consist of a keyword followed by zero to four arguments. Only enough characters of the full keyword to uniquely identify the command need be typed. The output of a command is normally sent to the standard output, but optionally the output of individual commands may be sent to a file by appending a <code>></code>, followed by a file name, to the command line. A number of interactive format commands are executed entirely within the <code>ntpq</code> program itself and do not result in NTP mode-6 requests being sent to a server. These are described following.
1627 <dt><code><span id="help"></span><code>? [</code><kbd>command_keyword</kbd><code>]</code></code></dt>
1632 <dt><code><span id="addvars"></span>><code>addvars <kbd>name</kbd> [ = <kbd>value</kbd>] [...]</code></code></dt>
1644 the list should be comma-separated and not contain white space.
1650 <dt><code><span id="cooked"></span><code>cooked</code></code></dt>
1654 <dt><code><span id="debug"></span><code>debug more | less | off</code></code></dt>
1658 <dt><code><span id="delay"></span><code>delay <kbd>milliseconds</kbd></code></code></dt>
1662 <dt><code><span id="host"></span><code>host <kbd>name</kbd></code></code></dt>
1667 <dt><code><span id="hostnames"></span><code>hostnames [yes | no]</code></code></dt>
1671 unless modified using the command line <code>-n</code> switch.
1674 <dt><code><span id="keyid"></span><code>keyid <kbd>keyid</kbd></code></code></dt>
1680 <dt><code><span id="keytype"></span><code>keytype</code></code></dt>
1688 <dt><code><span id="ntpversion"></span><code>ntpversion 1 | 2 | 3 | 4</code></code></dt>
1691 Note that mode-6 control messages (and modes, for that matter)
1695 <dt><code><span id="passwd"></span><code>passwd</code></code></dt>
1700 <dt><code><span id="quit"></span><code>quit</code></code></dt>
1704 <dt><code><span id="raw"></span><code>raw</code></code></dt>
1708 <dt><code><span id="timeout"></span><code>timeout <kbd>milliseconds</kbd></code></code></dt>
1718 <span id="Control-Message-Commands"></span><div class="header">
1720 Next: <a href="#Status-Words-and-Kiss-Codes" accesskey="n" rel="next">Status Words and Kiss Codes</a>, Previous: <a href="#Internal-Commands" accesskey="p" rel="prev">Internal Commands</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
1722 <span id="Control-Message-Commands-2"></span><h3 class="section">1.4 Control Message Commands</h3>
1727 Most control commands send a single mode-6 message to the server
1734 <span id="as"></span><dl compact="compact">
1755 <dt><code><span id="cv"></span>clockvar <kbd>assocID</kbd> [<kbd>name</kbd> [ = <kbd>value</kbd> [...]] [...]]</code></dt>
1760 <dt><code><span id="g_t_003aconfig"></span>:config [...]</code></dt>
1762 as a run-time configuration command in the same format
1768 <dt><code><span id="config_002dfrom_002dfile"></span>config-from-file <kbd>filename</kbd></code></dt>
1770 run-time configuration commands in the same format as the configuration file.
1775 <dt><code><span id="ifstats"></span>ifstats</code></dt>
1780 <dt><code><span id="iostats"></span>iostats</code></dt>
1784 <dt><code><span id="kerninfo"></span>kerninfo</code></dt>
1791 <dt><code><span id="lassoc"></span>lassociations</code></dt>
1796 <dt><code><span id="monstats"></span>monstats</code></dt>
1800 <dt><code><span id="mrulist"></span>mrulist [limited | kod | mincount=<kbd>count</kbd> | laddr=<kbd>localaddr</kbd> | sort=<kbd>sortorder</kbd> | resany=<kbd>hexmask</kbd> | resall=<kbd>hexmask</kbd>]</code></dt>
1842 <dt><code><span id="mreadvar"></span><code>mreadvar <kbd>assocID</kbd> <kbd>assocID</kbd> [ <kbd>variable_name</kbd> [ = <kbd>value</kbd>[ ... ]</code></code></dt>
1843 <dt><code><span id="mrv"></span><code>mrv <kbd>assocID</kbd> <kbd>assocID</kbd> [ <kbd>variable_name</kbd> [ = <kbd>value</kbd>[ ... ]</code></code></dt>
1850 <dt><code><span id="passoc"></span><code>passociations</code></code></dt>
1855 <dt><code><span id="pe"></span><code>peers</code></code></dt>
1862 <tr><td width="10%"><code>[tally]</code></td><td width="20%">single-character code indicating current value of the <code>select</code> field
1883 <dt><code><span id="rv"></span>readvar <kbd>assocID</kbd> <kbd>name</kbd> [ = <kbd>value</kbd> ] [,...]</code></dt>
1895 frequency values in parts-per-million (PPM).
1901 <dt><code><span id="saveconfig"></span><code>saveconfig <kbd>filename</kbd></code></code></dt>
1903 given with <code>:config</code> or <code>config-from-file</code>,
1910 <code>saveconfig ntp-%Y%m%d-%H%M%S.conf</code>.
1915 <dt><code><span id="writevar"></span>writevar <kbd>assocID</kbd> <kbd>name</kbd> = <kbd>value</kbd> [,...]</code></dt>
1924 <dt><code><span id="sysinfo"></span><code>sysinfo</code></code></dt>
1928 <dt><code><span id="sysstats"></span><code>sysstats</code></code></dt>
1935 <span id="Status-Words-and-Kiss-Codes"></span><div class="header">
1937 Next: <a href="#System-Variables" accesskey="n" rel="next">System Variables</a>, Previous: <a href="#Control-Message-Commands" accesskey="p" rel="prev">Control Message Commands</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
1939 <span id="Status-Words-and-Kiss-Codes-2"></span><h3 class="section">1.5 Status Words and Kiss Codes</h3>
1954 The original purpose was for kiss-o’-death (KoD) packets sent
1960 <span id="System-Variables"></span><div class="header">
1962 Next: <a href="#Peer-Variables" accesskey="n" rel="next">Peer Variables</a>, Previous: <a href="#Status-Words-and-Kiss-Codes" accesskey="p" rel="prev">Status Words and Kiss Codes</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
1964 <span id="System-Variables-2"></span><h3 class="section">1.6 System Variables</h3>
1975 <tr><td width="10%"><code>leap</code></td><td width="20%">leap warning indicator (0-3)</td></tr>
1976 <tr><td width="10%"><code>stratum</code></td><td width="20%">stratum (1-15)</td></tr>
1982 time constant and poll exponent (log(2) s) (3-17)</td></tr>
1984 minimum time constant (log(2) s) (3-10)</td></tr>
1994 <tr><td width="10%"><code>tai</code></td><td width="20%">TAI-UTC offset (s)</td></tr>
1999 <p>The jitter and wander statistics are exponentially-weighted RMS averages.
2020 <span id="Peer-Variables"></span><div class="header">
2022 Next: <a href="#Clock-Variables" accesskey="n" rel="next">Clock Variables</a>, Previous: <a href="#System-Variables" accesskey="p" rel="prev">System Variables</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
2024 <span id="Peer-Variables-2"></span><h3 class="section">1.7 Peer Variables</h3>
2036 <tr><td width="10%"><code>leap</code></td><td width="20%">leap indicator (0-3)</td></tr>
2037 <tr><td width="10%"><code>stratum</code></td><td width="20%">stratum (0-15)</td></tr>
2045 <tr><td width="10%"><code>hmode</code></td><td width="20%">host mode (1-6)</td></tr>
2046 <tr><td width="10%"><code>pmode</code></td><td width="20%">peer mode (1-5)</td></tr>
2047 <tr><td width="10%"><code>hpoll</code></td><td width="20%">host poll exponent (log(2) s) (3-17)</td></tr>
2048 <tr><td width="10%"><code>ppoll</code></td><td width="20%">peer poll exponent (log(2) s) (3-17)</td></tr>
2049 <tr><td width="10%"><code>headway</code></td><td width="20%">headway (see <a href="rate.html">Rate Management and the Kiss-o’-Death Packet</a>)</td></tr>
2082 <span id="Clock-Variables"></span><div class="header">
2084 Previous: <a href="#Peer-Variables" accesskey="p" rel="prev">Peer Variables</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> </p>
2086 <span id="Clock-Variables-2"></span><h3 class="section">1.8 Clock Variables</h3>